diff --git a/.changeset/large-donkeys-play.md b/.changeset/large-donkeys-play.md new file mode 100644 index 0000000000..6f1e1696f1 --- /dev/null +++ b/.changeset/large-donkeys-play.md @@ -0,0 +1,6 @@ +--- +"@tevm/procedures": patch +"@tevm/state": patch +--- + +Fixed race condition in getTransactionCount diff --git a/.changeset/long-plums-march.md b/.changeset/long-plums-march.md new file mode 100644 index 0000000000..7685363b58 --- /dev/null +++ b/.changeset/long-plums-march.md @@ -0,0 +1,5 @@ +--- +"@tevm/contract": patch +--- + +Do a jsdoc overhaul of tevm/contract diff --git a/.changeset/poor-colts-learn.md b/.changeset/poor-colts-learn.md new file mode 100644 index 0000000000..4b6d6bf374 --- /dev/null +++ b/.changeset/poor-colts-learn.md @@ -0,0 +1,5 @@ +--- +"@tevm/contract": patch +--- + +Fixed bug where write methods were showing up as both write and read methods diff --git a/.changeset/swift-ducks-lie.md b/.changeset/swift-ducks-lie.md new file mode 100644 index 0000000000..e608ad69fb --- /dev/null +++ b/.changeset/swift-ducks-lie.md @@ -0,0 +1,5 @@ +--- +"@tevm/common": minor +--- + +Removed experimental script property from contract instance. This allows encodeDeployData to treeshake diff --git a/.changeset/twenty-apricots-divide.md b/.changeset/twenty-apricots-divide.md new file mode 100644 index 0000000000..8683020d12 --- /dev/null +++ b/.changeset/twenty-apricots-divide.md @@ -0,0 +1,5 @@ +--- +"@tevm/contract": minor +--- + +Added `withCode` method to contract to add code. This replaces the previous script property diff --git a/bundler-packages/base-bundler/package.json b/bundler-packages/base-bundler/package.json index 75dcf62365..117b5ed76e 100644 --- a/bundler-packages/base-bundler/package.json +++ b/bundler-packages/base-bundler/package.json @@ -21,6 +21,7 @@ "contributors": [ "Will Cory " ], + "sideEffects": false, "type": "module", "exports": { "./package.json": "./package.json", @@ -76,6 +77,5 @@ }, "publishConfig": { "access": "public" - }, - "sideEffects": false + } } \ No newline at end of file diff --git a/bundler-packages/bun/docs/README.md b/bundler-packages/bun/docs/README.md index 29a781a69c..9c6361672e 100644 --- a/bundler-packages/bun/docs/README.md +++ b/bundler-packages/bun/docs/README.md @@ -16,8 +16,8 @@ pnpm install -D bun-types @tevm/bun-plugin @tevm/ts-plugin @tevm/contract solc ### Usage -See [docs](./docs/functions/tevmBunPlugin.md) +See [docs]() ## License 📄 - + diff --git a/bundler-packages/bun/docs/_media/LICENSE b/bundler-packages/bun/docs/_media/LICENSE deleted file mode 100644 index b5a4fa7a69..0000000000 --- a/bundler-packages/bun/docs/_media/LICENSE +++ /dev/null @@ -1,22 +0,0 @@ -(The MIT License) - -Copyright 2020-2022 - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/bundler-packages/bun/docs/functions/bunPluginTevm.md b/bundler-packages/bun/docs/functions/bunPluginTevm.md index cf51ed1e3a..1d8c506b3f 100644 --- a/bundler-packages/bun/docs/functions/bunPluginTevm.md +++ b/bundler-packages/bun/docs/functions/bunPluginTevm.md @@ -8,9 +8,6 @@ > **bunPluginTevm**(`SolcVersions`): `BunPlugin` -Bun plugin for tevm. Enables Solidity imports in JavaScript. Once enabled the code -will transform solidity contract imports into Tevm `Contract` instances. - ## Parameters • **SolcVersions** @@ -27,78 +24,6 @@ Which solc version to use To configure add this plugin to your Bun config and add the ts-plugin to your tsconfig.json -## Examples - -```ts plugin.ts -// Configure plugin in a plugin.ts file -import { tevmPluginBun } from '@tevm/bun-plugin' -import { plugin } from 'bun' - -plugin(tevmPluginBun()) -``` - -// Add the plugin.ts to your bunfig.toml -```ts bunfig.toml -preload = ["./plugins.ts"] -``` - -For LSP so your editor recognizes the solidity imports correctly you must also configure tevm/ts-plugin in your tsconfig.json -The ts-plugin will provide type hints, code completion, and other features. - -```json -{ - "compilerOptions": { - "plugins": [{ "name": "tevm/ts-plugin" }] - } -} -``` - -Once the esbuild plugin and the ts-plugin are configured, you can import Solidity files in JavaScript. The compiler will -turn them into Tevm `Contract` instances. - -```typescript -// Solidity imports are automaticlaly turned into Tevm Contract objects -import { ERC20 } from '@openzeppelin/contracts/token/ERC20/ERC20.sol' -import { createTevm } from 'tevm' - -console.log(ERC20.abi) -console.log(ERC20.humanReadableAbi) -console.log(ERC20.bytecode) - -tevm.contract( - ERC20.withAddress(.read.balanceOf() -) -``` - -Under the hood the esbuild plugin is creating a virtual file for ERC20.sol called ERC20.sol.cjs that looks like this - -```typescript -import { createContract } from '@tevm/contract' - -export const ERC20 = createContract({ - name: 'ERC20', - humanReadableAbi: [ 'function balanceOf(address): uint256', ... ], - bytecode: '0x...', - deployedBytecode: '0x...', -}) -``` - -For custom configuration of the Tevm compiler add a [tevm.config.json](https://todo.todo.todo) file to your project root. - -```json -{ - foundryProject?: boolean | string | undefined, - libs: ['lib'], - remappings: {'foo': 'vendored/foo'}, - debug: true, - cacheDir: '.tevm' -} -``` - -## See - -[Tevm esbuild example](https://todo.todo.todo) - ## Defined in [bunPluginTevm.js:86](https://github.com/evmts/tevm-monorepo/blob/main/bundler-packages/bun/src/bunPluginTevm.js#L86) diff --git a/bundler-packages/bun/package.json b/bundler-packages/bun/package.json index aa9711467c..993f141966 100644 --- a/bundler-packages/bun/package.json +++ b/bundler-packages/bun/package.json @@ -19,6 +19,7 @@ "contributors": [ "Will Cory " ], + "sideEffects": false, "type": "module", "exports": { ".": { @@ -75,6 +76,5 @@ }, "publishConfig": { "access": "public" - }, - "sideEffects": false + } } \ No newline at end of file diff --git a/bundler-packages/bundler-cache/package.json b/bundler-packages/bundler-cache/package.json index d0e0760d40..a9a0bf2222 100644 --- a/bundler-packages/bundler-cache/package.json +++ b/bundler-packages/bundler-cache/package.json @@ -21,6 +21,7 @@ "contributors": [ "Will Cory " ], + "sideEffects": false, "type": "module", "exports": { "./package.json": "./package.json", @@ -74,6 +75,5 @@ }, "publishConfig": { "access": "public" - }, - "sideEffects": false + } } \ No newline at end of file diff --git a/bundler-packages/compiler/package.json b/bundler-packages/compiler/package.json index ccaad08b27..b6a6b17695 100644 --- a/bundler-packages/compiler/package.json +++ b/bundler-packages/compiler/package.json @@ -21,6 +21,7 @@ "contributors": [ "Will Cory " ], + "sideEffects": false, "type": "module", "exports": { "./package.json": "./package.json", @@ -79,6 +80,5 @@ }, "publishConfig": { "access": "public" - }, - "sideEffects": false + } } \ No newline at end of file diff --git a/bundler-packages/config/package.json b/bundler-packages/config/package.json index 3f66cb6eba..2ab06794f2 100644 --- a/bundler-packages/config/package.json +++ b/bundler-packages/config/package.json @@ -21,6 +21,7 @@ "contributors": [ "Will Cory " ], + "sideEffects": false, "type": "module", "exports": { "./package.json": "./package.json", @@ -77,6 +78,5 @@ }, "publishConfig": { "access": "public" - }, - "sideEffects": false + } } \ No newline at end of file diff --git a/bundler-packages/esbuild/package.json b/bundler-packages/esbuild/package.json index 0f7a7827be..f441e65ade 100644 --- a/bundler-packages/esbuild/package.json +++ b/bundler-packages/esbuild/package.json @@ -19,6 +19,7 @@ "contributors": [ "Will Cory " ], + "sideEffects": false, "type": "module", "exports": { "./package.json": "./package.json", @@ -67,6 +68,5 @@ }, "publishConfig": { "access": "public" - }, - "sideEffects": false + } } \ No newline at end of file diff --git a/bundler-packages/resolutions/package.json b/bundler-packages/resolutions/package.json index 85b35c9dbc..92b27397a0 100644 --- a/bundler-packages/resolutions/package.json +++ b/bundler-packages/resolutions/package.json @@ -21,6 +21,7 @@ "contributors": [ "Will Cory " ], + "sideEffects": false, "type": "module", "exports": { "./package.json": "./package.json", @@ -74,6 +75,5 @@ }, "publishConfig": { "access": "public" - }, - "sideEffects": false + } } \ No newline at end of file diff --git a/bundler-packages/rollup/docs/README.md b/bundler-packages/rollup/docs/README.md index 057f5b3664..e0ca1acfa2 100644 --- a/bundler-packages/rollup/docs/README.md +++ b/bundler-packages/rollup/docs/README.md @@ -16,8 +16,8 @@ pnpm i @tevm/rollup-plugin ## Usage -See [docs](_media/rollupPluginTevm.md) +See [docs]() ## License 📄 - + diff --git a/bundler-packages/rollup/docs/_media/LICENSE b/bundler-packages/rollup/docs/_media/LICENSE deleted file mode 100644 index b5a4fa7a69..0000000000 --- a/bundler-packages/rollup/docs/_media/LICENSE +++ /dev/null @@ -1,22 +0,0 @@ -(The MIT License) - -Copyright 2020-2022 - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/bundler-packages/rollup/docs/_media/rollupPluginTevm.md b/bundler-packages/rollup/docs/_media/rollupPluginTevm.md deleted file mode 100644 index dfc63135c6..0000000000 --- a/bundler-packages/rollup/docs/_media/rollupPluginTevm.md +++ /dev/null @@ -1,98 +0,0 @@ -[**@tevm/rollup-plugin**](../README.md) • **Docs** - -*** - -[@tevm/rollup-plugin](../globals.md) / rollupPluginTevm - -# Function: rollupPluginTevm() - -> **rollupPluginTevm**(`options`?): `Plugin`\<`any`\> - -Rollup plugin for tevm. Enables Solidity imports in JavaScript. Once enabled the code -will transform solidity contract imports into Tevm `Contract` instances. - -To configure add this plugin to your rollup config and add the ts-plugin to your tsconfig.json - -## Parameters - -• **options?** - -• **options.solc?**: `SolcVersions` - -## Returns - -`Plugin`\<`any`\> - -## Examples - -```typescript -import { defineConfig } from 'rollup'; -import { rollupPluginTevm } from '@tevm/rollup'; - -export default defineConfig({ - plugins: [ - rollupPluginTevm() - ], -}); -``` - -For LSP so your editor recognizes the solidity imports correctly you must also configure tevm/ts-plugin in your tsconfig.json -The ts-plugin will provide type hints, code completion, and other features. - -```json -{ - "compilerOptions": { - "plugins": [{ "name": "tevm/ts-plugin" }] - } -} -``` - -Once the rollup plugin and the ts-plugin are configured, you can import Solidity files in JavaScript. The compiler will -turn them into Tevm `Contract` instances. - -```typescript -// Solidity imports are automaticlaly turned into Tevm Contract objects -import { ERC20 } from '@openzeppelin/contracts/token/ERC20/ERC20.sol' -import { createTevm } from 'tevm' - -console.log(ERC20.abi) -console.log(ERC20.humanReadableAbi) -console.log(ERC20.bytecode) - -tevm.contract( - ERC20.withAddress(.read.balanceOf() -) -``` - -Under the hood the rollup plugin is creating a virtual file for ERC20.sol called ERC20.sol.cjs that looks like this - -```typescript -import { createContract } from '@tevm/contract' - -export const ERC20 = createContract({ - name: 'ERC20', - humanReadableAbi: [ 'function balanceOf(address): uint256', ... ], - bytecode: '0x...', - deployedBytecode: '0x...', -}) -``` - -For custom configuration of the Tevm compiler add a [tevm.config.json](https://todo.todo.todo) file to your project root. - -```json -{ - foundryProject?: boolean | string | undefined, - libs: ['lib'], - remappings: {'foo': 'vendored/foo'}, - debug: true, - cacheDir: '.tevm' -} -``` - -## See - -[Tevm rollup example](https://todo.todo.todo) - -## Defined in - -[bundler-packages/rollup/src/rollupPluginTevm.js:75](https://github.com/evmts/tevm-monorepo/blob/main/bundler-packages/rollup/src/rollupPluginTevm.js#L75) diff --git a/bundler-packages/rollup/docs/functions/rollupPluginTevm.md b/bundler-packages/rollup/docs/functions/rollupPluginTevm.md index dfc63135c6..1ebb587a76 100644 --- a/bundler-packages/rollup/docs/functions/rollupPluginTevm.md +++ b/bundler-packages/rollup/docs/functions/rollupPluginTevm.md @@ -23,76 +23,6 @@ To configure add this plugin to your rollup config and add the ts-plugin to your `Plugin`\<`any`\> -## Examples - -```typescript -import { defineConfig } from 'rollup'; -import { rollupPluginTevm } from '@tevm/rollup'; - -export default defineConfig({ - plugins: [ - rollupPluginTevm() - ], -}); -``` - -For LSP so your editor recognizes the solidity imports correctly you must also configure tevm/ts-plugin in your tsconfig.json -The ts-plugin will provide type hints, code completion, and other features. - -```json -{ - "compilerOptions": { - "plugins": [{ "name": "tevm/ts-plugin" }] - } -} -``` - -Once the rollup plugin and the ts-plugin are configured, you can import Solidity files in JavaScript. The compiler will -turn them into Tevm `Contract` instances. - -```typescript -// Solidity imports are automaticlaly turned into Tevm Contract objects -import { ERC20 } from '@openzeppelin/contracts/token/ERC20/ERC20.sol' -import { createTevm } from 'tevm' - -console.log(ERC20.abi) -console.log(ERC20.humanReadableAbi) -console.log(ERC20.bytecode) - -tevm.contract( - ERC20.withAddress(.read.balanceOf() -) -``` - -Under the hood the rollup plugin is creating a virtual file for ERC20.sol called ERC20.sol.cjs that looks like this - -```typescript -import { createContract } from '@tevm/contract' - -export const ERC20 = createContract({ - name: 'ERC20', - humanReadableAbi: [ 'function balanceOf(address): uint256', ... ], - bytecode: '0x...', - deployedBytecode: '0x...', -}) -``` - -For custom configuration of the Tevm compiler add a [tevm.config.json](https://todo.todo.todo) file to your project root. - -```json -{ - foundryProject?: boolean | string | undefined, - libs: ['lib'], - remappings: {'foo': 'vendored/foo'}, - debug: true, - cacheDir: '.tevm' -} -``` - -## See - -[Tevm rollup example](https://todo.todo.todo) - ## Defined in [bundler-packages/rollup/src/rollupPluginTevm.js:75](https://github.com/evmts/tevm-monorepo/blob/main/bundler-packages/rollup/src/rollupPluginTevm.js#L75) diff --git a/bundler-packages/rollup/package.json b/bundler-packages/rollup/package.json index 59c3701917..6eb3b3f032 100644 --- a/bundler-packages/rollup/package.json +++ b/bundler-packages/rollup/package.json @@ -19,6 +19,7 @@ "contributors": [ "Will Cory " ], + "sideEffects": false, "type": "module", "exports": { "./package.json": "./package.json", @@ -66,6 +67,5 @@ }, "publishConfig": { "access": "public" - }, - "sideEffects": false + } } \ No newline at end of file diff --git a/bundler-packages/rspack/docs/README.md b/bundler-packages/rspack/docs/README.md index 98464388bb..800f8e9551 100644 --- a/bundler-packages/rspack/docs/README.md +++ b/bundler-packages/rspack/docs/README.md @@ -14,8 +14,8 @@ pnpm i @tevm/rspack-plugin ## Usage -See [docs](./docs/functions/tevmPluginRspack.md) +See [docs]() ## License 📄 - + diff --git a/bundler-packages/rspack/docs/_media/LICENSE b/bundler-packages/rspack/docs/_media/LICENSE deleted file mode 100644 index b5a4fa7a69..0000000000 --- a/bundler-packages/rspack/docs/_media/LICENSE +++ /dev/null @@ -1,22 +0,0 @@ -(The MIT License) - -Copyright 2020-2022 - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/bundler-packages/rspack/docs/functions/rspackPluginTevm.md b/bundler-packages/rspack/docs/functions/rspackPluginTevm.md index 20eaeb19ab..d8163cfec7 100644 --- a/bundler-packages/rspack/docs/functions/rspackPluginTevm.md +++ b/bundler-packages/rspack/docs/functions/rspackPluginTevm.md @@ -23,76 +23,6 @@ To configure add this plugin to your rspack config and add the ts-plugin to your `RspackPluginInstance` -## Examples - -```typescript -import { defineConfig } from '@rsbuild/core'; -import { rspackPluginTevm } from '@tevm/rspack'; - -export default defineConfig({ - plugins: [ - rspackPluginTevm() - ], -}); -``` - -For LSP so your editor recognizes the solidity imports correctly you must also configure tevm/ts-plugin in your tsconfig.json -The ts-plugin will provide type hints, code completion, and other features. - -```json -{ - "compilerOptions": { - "plugins": [{ "name": "tevm/ts-plugin" }] - } -} -``` - -Once the rspack plugin and the ts-plugin are configured, you can import Solidity files in JavaScript. The compiler will -turn them into Tevm `Contract` instances. - -```typescript -// Solidity imports are automaticlaly turned into Tevm Contract objects -import { ERC20 } from '@openzeppelin/contracts/token/ERC20/ERC20.sol' -import { createTevm } from 'tevm' - -console.log(ERC20.abi) -console.log(ERC20.humanReadableAbi) -console.log(ERC20.bytecode) - -tevm.contract( - ERC20.withAddress(.read.balanceOf() -) -``` - -Under the hood the rspack plugin is creating a virtual file for ERC20.sol called ERC20.sol.cjs that looks like this - -```typescript -import { createContract } from '@tevm/contract' - -export const ERC20 = createContract({ - name: 'ERC20', - humanReadableAbi: [ 'function balanceOf(address): uint256', ... ], - bytecode: '0x...', - deployedBytecode: '0x...', -}) -``` - -For custom configuration of the Tevm compiler add a [tevm.config.json](https://todo.todo.todo) file to your project root. - -```json -{ - foundryProject?: boolean | string | undefined, - libs: ['lib'], - remappings: {'foo': 'vendored/foo'}, - debug: true, - cacheDir: '.tevm' -} -``` - -## See - -[Tevm rspack solid.js example](https://todo.todo.todo) - ## Defined in [bundler-packages/rspack/src/rspackPluginTevm.js:75](https://github.com/evmts/tevm-monorepo/blob/main/bundler-packages/rspack/src/rspackPluginTevm.js#L75) diff --git a/bundler-packages/rspack/package.json b/bundler-packages/rspack/package.json index 96f57cfd3b..65ef4df20e 100644 --- a/bundler-packages/rspack/package.json +++ b/bundler-packages/rspack/package.json @@ -19,6 +19,7 @@ "contributors": [ "Will Cory " ], + "sideEffects": false, "type": "module", "exports": { "./package.json": "./package.json", @@ -66,6 +67,5 @@ }, "publishConfig": { "access": "public" - }, - "sideEffects": false + } } \ No newline at end of file diff --git a/bundler-packages/runtime/package.json b/bundler-packages/runtime/package.json index 4df7e33d01..f5f6be447d 100644 --- a/bundler-packages/runtime/package.json +++ b/bundler-packages/runtime/package.json @@ -21,6 +21,7 @@ "contributors": [ "Will Cory " ], + "sideEffects": false, "type": "module", "exports": { "./package.json": "./package.json", @@ -72,6 +73,5 @@ }, "publishConfig": { "access": "public" - }, - "sideEffects": false + } } \ No newline at end of file diff --git a/bundler-packages/solc/package.json b/bundler-packages/solc/package.json index b343298335..ecf940302f 100644 --- a/bundler-packages/solc/package.json +++ b/bundler-packages/solc/package.json @@ -19,6 +19,7 @@ "contributors": [ "Will Cory " ], + "sideEffects": false, "type": "module", "exports": { "./package.json": "./package.json", @@ -69,6 +70,5 @@ }, "publishConfig": { "access": "public" - }, - "sideEffects": false + } } \ No newline at end of file diff --git a/bundler-packages/unplugin/package.json b/bundler-packages/unplugin/package.json index f25188b0f1..7f8d7fdd58 100644 --- a/bundler-packages/unplugin/package.json +++ b/bundler-packages/unplugin/package.json @@ -21,6 +21,7 @@ "contributors": [ "Will Cory " ], + "sideEffects": false, "type": "module", "exports": { "./package.json": "./package.json", @@ -77,6 +78,5 @@ }, "publishConfig": { "access": "public" - }, - "sideEffects": false + } } \ No newline at end of file diff --git a/bundler-packages/vite/docs/README.md b/bundler-packages/vite/docs/README.md index 410191b0cf..cc0db1b81f 100644 --- a/bundler-packages/vite/docs/README.md +++ b/bundler-packages/vite/docs/README.md @@ -16,8 +16,8 @@ pnpm i @tevm/vite-plugin ## Usage -See [docs](_media/vitePluginTevm.md) +See [docs]() ## License 📄 - + diff --git a/bundler-packages/vite/docs/_media/LICENSE b/bundler-packages/vite/docs/_media/LICENSE deleted file mode 100644 index b5a4fa7a69..0000000000 --- a/bundler-packages/vite/docs/_media/LICENSE +++ /dev/null @@ -1,22 +0,0 @@ -(The MIT License) - -Copyright 2020-2022 - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/bundler-packages/vite/docs/_media/vitePluginTevm.md b/bundler-packages/vite/docs/_media/vitePluginTevm.md deleted file mode 100644 index b5b3ce9a44..0000000000 --- a/bundler-packages/vite/docs/_media/vitePluginTevm.md +++ /dev/null @@ -1,94 +0,0 @@ -[**@tevm/vite-plugin**](../README.md) • **Docs** - -*** - -[@tevm/vite-plugin](../globals.md) / vitePluginTevm - -# Function: vitePluginTevm() - -> **vitePluginTevm**(`options`?): `Plugin`\<`any`\> - -Vite plugin for tevm. Enables Solidity imports in JavaScript. Once enabled the code -will transform solidity contract imports into Tevm `Contract` instances. - -To configure add this plugin to your vite config and add the ts-plugin to your tsconfig.json - -## Parameters - -• **options?** - -• **options.solc?**: `SolcVersions` - -## Returns - -`Plugin`\<`any`\> - -## Examples - -```typescript -import { vitePluginTevm } from '@tevm/vite' -import { defineConfig } from 'vite' - -export default defineConfig({ - plugins: [ - vitePluginTevm() - ] -}) -``` - -For LSP so your editor recognizes the solidity imports correctly you must also configure tevm/ts-plugin in your tsconfig.json -The ts-plugin will provide type hints, code completion, and other features. - -```json -{ - "compilerOptions": { - "plugins": [{ "name": "tevm/ts-plugin" }] - } -} -``` - -Once the vite plugin and the ts-plugin are configured, you can import Solidity files in JavaScript. The compiler will -turn them into Tevm `Contract` instances. - -```typescript -// Solidity imports are automaticlaly turned into Tevm Contract objects -import { ERC20 } from '@openzeppelin/contracts/token/ERC20/ERC20.sol' -import { createTevm } from 'tevm' - -console.log(ERC20.abi) -console.log(ERC20.humanReadableAbi) -console.log(ERC20.bytecode) - -tevm.contract( - ERC20.withAddress(.read.balanceOf() -) -``` - -Under the hood the vite plugin is creating a virtual file for ERC20.sol called ERC20.sol.cjs that looks like this - -```typescript -import { createContract } from '@tevm/contract' - -export const ERC20 = createContract({ - name: 'ERC20', - humanReadableAbi: [ 'function balanceOf(address): uint256', ... ], - bytecode: '0x...', - deployedBytecode: '0x...', -}) -``` - -For custom configuration of the Tevm compiler add a [tevm.config.json](https://todo.todo.todo) file to your project root. - -```json -{ - foundryProject?: boolean | string | undefined, - libs: ['lib'], - remappings: {'foo': 'vendored/foo'}, - debug: true, - cacheDir: '.tevm' -} -``` - -## Defined in - -[bundler-packages/vite/src/vitePluginTevm.js:73](https://github.com/evmts/tevm-monorepo/blob/main/bundler-packages/vite/src/vitePluginTevm.js#L73) diff --git a/bundler-packages/vite/docs/functions/vitePluginTevm.md b/bundler-packages/vite/docs/functions/vitePluginTevm.md index b5b3ce9a44..3dc774438a 100644 --- a/bundler-packages/vite/docs/functions/vitePluginTevm.md +++ b/bundler-packages/vite/docs/functions/vitePluginTevm.md @@ -23,72 +23,6 @@ To configure add this plugin to your vite config and add the ts-plugin to your t `Plugin`\<`any`\> -## Examples - -```typescript -import { vitePluginTevm } from '@tevm/vite' -import { defineConfig } from 'vite' - -export default defineConfig({ - plugins: [ - vitePluginTevm() - ] -}) -``` - -For LSP so your editor recognizes the solidity imports correctly you must also configure tevm/ts-plugin in your tsconfig.json -The ts-plugin will provide type hints, code completion, and other features. - -```json -{ - "compilerOptions": { - "plugins": [{ "name": "tevm/ts-plugin" }] - } -} -``` - -Once the vite plugin and the ts-plugin are configured, you can import Solidity files in JavaScript. The compiler will -turn them into Tevm `Contract` instances. - -```typescript -// Solidity imports are automaticlaly turned into Tevm Contract objects -import { ERC20 } from '@openzeppelin/contracts/token/ERC20/ERC20.sol' -import { createTevm } from 'tevm' - -console.log(ERC20.abi) -console.log(ERC20.humanReadableAbi) -console.log(ERC20.bytecode) - -tevm.contract( - ERC20.withAddress(.read.balanceOf() -) -``` - -Under the hood the vite plugin is creating a virtual file for ERC20.sol called ERC20.sol.cjs that looks like this - -```typescript -import { createContract } from '@tevm/contract' - -export const ERC20 = createContract({ - name: 'ERC20', - humanReadableAbi: [ 'function balanceOf(address): uint256', ... ], - bytecode: '0x...', - deployedBytecode: '0x...', -}) -``` - -For custom configuration of the Tevm compiler add a [tevm.config.json](https://todo.todo.todo) file to your project root. - -```json -{ - foundryProject?: boolean | string | undefined, - libs: ['lib'], - remappings: {'foo': 'vendored/foo'}, - debug: true, - cacheDir: '.tevm' -} -``` - ## Defined in [bundler-packages/vite/src/vitePluginTevm.js:73](https://github.com/evmts/tevm-monorepo/blob/main/bundler-packages/vite/src/vitePluginTevm.js#L73) diff --git a/bundler-packages/vite/package.json b/bundler-packages/vite/package.json index f534ca4b29..55ce94836e 100644 --- a/bundler-packages/vite/package.json +++ b/bundler-packages/vite/package.json @@ -19,6 +19,7 @@ "contributors": [ "Will Cory " ], + "sideEffects": false, "type": "module", "exports": { "./package.json": "./package.json", @@ -66,6 +67,5 @@ }, "publishConfig": { "access": "public" - }, - "sideEffects": false + } } \ No newline at end of file diff --git a/bundler-packages/webpack/docs/README.md b/bundler-packages/webpack/docs/README.md index 54cb10bc87..2695f26781 100644 --- a/bundler-packages/webpack/docs/README.md +++ b/bundler-packages/webpack/docs/README.md @@ -14,8 +14,8 @@ pnpm i @tevm/webpack-plugin ## Usage -See [docs](./docs/) +See [docs]() ## License 📄 - + diff --git a/bundler-packages/webpack/docs/_media/LICENSE b/bundler-packages/webpack/docs/_media/LICENSE deleted file mode 100644 index b5a4fa7a69..0000000000 --- a/bundler-packages/webpack/docs/_media/LICENSE +++ /dev/null @@ -1,22 +0,0 @@ -(The MIT License) - -Copyright 2020-2022 - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/bundler-packages/webpack/package.json b/bundler-packages/webpack/package.json index e7c623da2e..375a992437 100644 --- a/bundler-packages/webpack/package.json +++ b/bundler-packages/webpack/package.json @@ -19,6 +19,7 @@ "contributors": [ "Will Cory " ], + "sideEffects": false, "type": "module", "exports": { "./package.json": "./package.json", @@ -70,6 +71,5 @@ }, "publishConfig": { "access": "public" - }, - "sideEffects": false + } } \ No newline at end of file diff --git a/bundler-packages/whatsabi/docs/classes/UnknownChainError.md b/bundler-packages/whatsabi/docs/classes/UnknownChainError.md index 1b1b6b5ad7..b4577103a5 100644 --- a/bundler-packages/whatsabi/docs/classes/UnknownChainError.md +++ b/bundler-packages/whatsabi/docs/classes/UnknownChainError.md @@ -106,6 +106,10 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -116,10 +120,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from `Error.prepareStackTrace` diff --git a/bundler-packages/whatsabi/docs/functions/loadAbi.md b/bundler-packages/whatsabi/docs/functions/loadAbi.md new file mode 100644 index 0000000000..a61ee9918a --- /dev/null +++ b/bundler-packages/whatsabi/docs/functions/loadAbi.md @@ -0,0 +1,31 @@ +[**@tevm/whatsabi**](../README.md) • **Docs** + +*** + +[@tevm/whatsabi](../globals.md) / loadAbi + +# Function: loadAbi() + +> **loadAbi**(`options`): `Promise`\<`AutoloadResult`\> + +## Parameters + +• **options** + +• **options.address**: \`0x$\{string\}\` + +• **options.client**: `Client`\<`Transport`, `undefined` \| `Chain`, `undefined` \| `Account`, `undefined`, `undefined` \| `object`\> + +• **options.etherscanApiKey**: `undefined` \| `string` + +• **options.explorerUrl**: `undefined` \| `string` + +• **options.followProxies**: `boolean` + +## Returns + +`Promise`\<`AutoloadResult`\> + +## Defined in + +[bundler-packages/whatsabi/src/loadAbi.js:12](https://github.com/evmts/tevm-monorepo/blob/main/bundler-packages/whatsabi/src/loadAbi.js#L12) diff --git a/bundler-packages/whatsabi/docs/functions/resolveContractUri.md b/bundler-packages/whatsabi/docs/functions/resolveContractUri.md index 3d732c1976..87e9496d5f 100644 --- a/bundler-packages/whatsabi/docs/functions/resolveContractUri.md +++ b/bundler-packages/whatsabi/docs/functions/resolveContractUri.md @@ -18,10 +18,6 @@ `Promise`\<`undefined` \| `object`\> -## Throws - -if the chainId is not known and no rpcUrl is provided - ## Defined in [bundler-packages/whatsabi/src/resolveContractUri.js:34](https://github.com/evmts/tevm-monorepo/blob/main/bundler-packages/whatsabi/src/resolveContractUri.js#L34) diff --git a/bundler-packages/whatsabi/docs/globals.md b/bundler-packages/whatsabi/docs/globals.md index 9c67a89cfb..5450ad9435 100644 --- a/bundler-packages/whatsabi/docs/globals.md +++ b/bundler-packages/whatsabi/docs/globals.md @@ -22,5 +22,6 @@ ## Functions +- [loadAbi](functions/loadAbi.md) - [parseUri](functions/parseUri.md) - [resolveContractUri](functions/resolveContractUri.md) diff --git a/bundler-packages/whatsabi/docs/variables/knownChains.md b/bundler-packages/whatsabi/docs/variables/knownChains.md index c19e14f414..f3f419da86 100644 --- a/bundler-packages/whatsabi/docs/variables/knownChains.md +++ b/bundler-packages/whatsabi/docs/variables/knownChains.md @@ -740,10 +740,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 100009.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -844,10 +840,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 1004.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -944,10 +936,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 1039.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -1044,10 +1032,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 105105.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -1364,10 +1348,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 1111.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -2366,10 +2346,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 11235.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -3152,10 +3128,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 114.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -3256,10 +3228,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 11501.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -3460,10 +3428,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 123.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -3560,10 +3524,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 12306.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -3664,10 +3624,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 12324.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -3772,10 +3728,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 12325.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -4346,10 +4298,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 1281.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -4654,10 +4602,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 1328.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -4982,10 +4926,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 1337.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -5082,10 +5022,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 1337803.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -5486,10 +5422,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 14.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -5590,10 +5522,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 148.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -5898,10 +5826,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 1559.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -6172,7 +6096,7 @@ ### 167000.blockExplorers.default.apiUrl -> `readonly` **apiUrl**: `"https://taikoscan.network/api"` +> `readonly` **apiUrl**: `"https://api.taikoscan.io/api"` ### 167000.blockExplorers.default.name @@ -6180,7 +6104,7 @@ ### 167000.blockExplorers.default.url -> `readonly` **url**: `"https://taikoscan.network"` +> `readonly` **url**: `"https://taikoscan.io"` ### 167000.contracts @@ -6378,10 +6302,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 167008.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -6490,10 +6410,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 167009.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -6782,6 +6698,10 @@ > `readonly` **default**: `object` +### 17000.blockExplorers.default.apiUrl + +> `readonly` **apiUrl**: `"https://api-holesky.etherscan.io/api"` + ### 17000.blockExplorers.default.name > `readonly` **name**: `"Etherscan"` @@ -6914,10 +6834,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 1729.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -7684,10 +7600,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 19.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -8092,10 +8004,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 1994.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -8292,10 +8200,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 200810.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -8396,10 +8300,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 200901.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -8696,10 +8596,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 2026.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -8996,10 +8892,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 205205.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -9396,10 +9288,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 22222.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -10470,10 +10358,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 248.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -11336,10 +11220,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 255.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -11846,10 +11726,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 2730.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -12130,10 +12006,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 28882.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -12230,10 +12102,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 295.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -12438,10 +12306,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 3109.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -12546,10 +12410,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 31337.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -13276,10 +13136,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 32769.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -14344,10 +14200,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 35441.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -14448,10 +14300,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 35443.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -14760,10 +14608,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 37714555429.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -15272,10 +15116,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 4200.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -17662,10 +17502,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 463.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -17966,10 +17802,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 4777.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -18070,10 +17902,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 4999.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -18498,10 +18326,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 50005.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -18698,10 +18522,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 5112.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -18806,10 +18626,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 5165.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -19122,25 +18938,21 @@ > `readonly` **url**: `"https://testnet.flowdiver.io"` -### 545.contracts? - -> `optional` **contracts**: `object` - -#### Index Signature +### 545.contracts - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` +> **contracts**: `object` -### 545.contracts.ensRegistry? +### 545.contracts.multicall3 -> `optional` **ensRegistry**: `ChainContract` +> `readonly` **multicall3**: `object` -### 545.contracts.ensUniversalResolver? +### 545.contracts.multicall3.address -> `optional` **ensUniversalResolver**: `ChainContract` +> `readonly` **address**: `"0xca11bde05977b3631167028862be2a173976ca11"` -### 545.contracts.multicall3? +### 545.contracts.multicall3.blockCreated -> `optional` **multicall3**: `ChainContract` +> `readonly` **blockCreated**: `137518` ### 545.custom? @@ -20170,9 +19982,33 @@ > `optional` **custom**: `Record`\<`string`, `unknown`\> -### 59144.fees? +### 59144.fees -> `optional` **fees**: `ChainFees`\<`undefined`\> +> **fees**: `object` + +### 59144.fees.estimateFeesPerGas() + +> `readonly` **estimateFeesPerGas**: (`__namedParameters`) => `Promise`\<`null` \| `EstimateFeesPerGasReturnType`\> + +#### Parameters + +• **\_\_namedParameters**: `ChainEstimateFeesPerGasFnParameters`\<`undefined` \| `ChainFormatters`\> + +#### Returns + +`Promise`\<`null` \| `EstimateFeesPerGasReturnType`\> + +### 59144.fees.maxPriorityFeePerGas() + +> `readonly` **maxPriorityFeePerGas**: (`__namedParameters`) => `Promise`\<`null` \| `bigint`\> + +#### Parameters + +• **\_\_namedParameters**: `ChainFeesFnParameters`\<`undefined` \| `ChainFormatters`\> + +#### Returns + +`Promise`\<`null` \| `bigint`\> ### 59144.formatters? @@ -20358,10 +20194,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 595.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -21132,10 +20964,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 61.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -21428,10 +21256,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 666666666.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -21536,10 +21360,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 686.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -21656,10 +21476,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 690.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -22056,10 +21872,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 713715.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -22156,10 +21968,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 721.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -22344,10 +22152,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 747.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -23402,10 +23206,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 787.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -23622,10 +23422,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 810181.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -23822,10 +23618,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 82.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -24018,10 +23810,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 841.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -25624,10 +25412,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 88882.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -25736,10 +25520,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 88888.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -26506,10 +26286,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 9000.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -26606,10 +26382,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 9001.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` @@ -27280,10 +27052,6 @@ > `optional` **contracts**: `object` -#### Index Signature - - \[`x`: `string`\]: `ChainContract` \| `object` \| `undefined` - ### 96.contracts.ensRegistry? > `optional` **ensRegistry**: `ChainContract` diff --git a/bundler-packages/whatsabi/package.json b/bundler-packages/whatsabi/package.json index 02d1c98c0a..3b259e4eae 100644 --- a/bundler-packages/whatsabi/package.json +++ b/bundler-packages/whatsabi/package.json @@ -19,6 +19,7 @@ "contributors": [ "Will Cory " ], + "sideEffects": false, "type": "module", "exports": { "./package.json": "./package.json", @@ -73,6 +74,5 @@ }, "publishConfig": { "access": "public" - }, - "sideEffects": false + } } \ No newline at end of file diff --git a/configs/tsconfig/package.json b/configs/tsconfig/package.json index 723edcc78a..3578776e8f 100644 --- a/configs/tsconfig/package.json +++ b/configs/tsconfig/package.json @@ -2,8 +2,8 @@ "name": "@tevm/tsconfig", "version": "0.0.0-next.96", "private": false, + "sideEffects": false, "files": [ "base.json" - ], - "sideEffects": false + ] } \ No newline at end of file diff --git a/configs/tsupconfig/package.json b/configs/tsupconfig/package.json index df67752844..e41de79cf0 100644 --- a/configs/tsupconfig/package.json +++ b/configs/tsupconfig/package.json @@ -2,6 +2,7 @@ "name": "@tevm/tsupconfig", "version": "1.0.0-next.109", "private": false, + "sideEffects": false, "type": "module", "exports": { ".": { @@ -41,6 +42,5 @@ "dependencies": { "@tevm/tsconfig": "workspace:^", "@types/node": "^22.5.1" - }, - "sideEffects": false + } } \ No newline at end of file diff --git a/docs/src/content/docs/reference/@tevm/actions/functions/ethGetLogsHandler.md b/docs/src/content/docs/reference/@tevm/actions/functions/ethGetLogsHandler.md index e364e8bebe..2336741681 100644 --- a/docs/src/content/docs/reference/@tevm/actions/functions/ethGetLogsHandler.md +++ b/docs/src/content/docs/reference/@tevm/actions/functions/ethGetLogsHandler.md @@ -17,4 +17,4 @@ title: "ethGetLogsHandler" ## Defined in -[packages/actions/src/eth/ethGetLogsHandler.js:62](https://github.com/evmts/tevm-monorepo/blob/main/packages/actions/src/eth/ethGetLogsHandler.js#L62) +[packages/actions/src/eth/ethGetLogsHandler.js:14](https://github.com/evmts/tevm-monorepo/blob/main/packages/actions/src/eth/ethGetLogsHandler.js#L14) diff --git a/docs/src/content/docs/reference/@tevm/address/classes/Address.md b/docs/src/content/docs/reference/@tevm/address/classes/Address.md index 6d45b28270..22699ef61f 100644 --- a/docs/src/content/docs/reference/@tevm/address/classes/Address.md +++ b/docs/src/content/docs/reference/@tevm/address/classes/Address.md @@ -5,9 +5,9 @@ prev: false title: "Address" --- -Utility class for ethereum addresses. +Utility class for Ethereum addresses. Wraps [EthjsAddress](../../../../../../../reference/tevm/utils/classes/ethjsaddress) with a tevm style API. -toString returns a checksummed address rather than lowercase +toString returns a checksummed address rather than lowercase. ## Example @@ -19,7 +19,7 @@ let address = createAddress(`0x${'00'.repeat(20)}`); // takes number and bigint address = createAddress(0); // takes bytes -address = createAddress(new Uint8Array()); +address = createAddress(new Uint8Array(20)); // non hex string address = createAddress('55'.repeat(20)); ``` @@ -161,7 +161,7 @@ Returns the checksummed address. \`0x$\{string\}\` -The checksummed address. +The checksummed Ethereum address as a string. #### Overrides @@ -169,7 +169,7 @@ The checksummed address. #### Defined in -[packages/address/src/Address.js:27](https://github.com/evmts/tevm-monorepo/blob/main/packages/address/src/Address.js#L27) +[packages/address/src/Address.js:28](https://github.com/evmts/tevm-monorepo/blob/main/packages/address/src/Address.js#L28) *** diff --git a/docs/src/content/docs/reference/@tevm/address/functions/create2ContractAddress.md b/docs/src/content/docs/reference/@tevm/address/functions/create2ContractAddress.md index 41e86cd298..f084549d89 100644 --- a/docs/src/content/docs/reference/@tevm/address/functions/create2ContractAddress.md +++ b/docs/src/content/docs/reference/@tevm/address/functions/create2ContractAddress.md @@ -19,12 +19,14 @@ A 32-byte salt value as a hex string • **code**: \`0x$\{string\}\` -THe creation code of the contract +The creation code of the contract ## Returns [`Address`](/reference/tevm/address/classes/address/) +The generated contract address + ## Defined in -[packages/address/src/create2ContractAddress.js:18](https://github.com/evmts/tevm-monorepo/blob/main/packages/address/src/create2ContractAddress.js#L18) +[packages/address/src/create2ContractAddress.js:19](https://github.com/evmts/tevm-monorepo/blob/main/packages/address/src/create2ContractAddress.js#L19) diff --git a/docs/src/content/docs/reference/@tevm/address/functions/createAddress.md b/docs/src/content/docs/reference/@tevm/address/functions/createAddress.md index fe985584ec..368ac72d14 100644 --- a/docs/src/content/docs/reference/@tevm/address/functions/createAddress.md +++ b/docs/src/content/docs/reference/@tevm/address/functions/createAddress.md @@ -11,10 +11,14 @@ title: "createAddress" • **address**: `string` \| `number` \| `bigint` \| [`EthjsAddress`](/reference/tevm/utils/classes/ethjsaddress/) \| `Uint8Array` +The input to create an address from. + ## Returns [`Address`](/reference/tevm/address/classes/address/) +An Address instance. + ## Defined in -[packages/address/src/createAddress.js:27](https://github.com/evmts/tevm-monorepo/blob/main/packages/address/src/createAddress.js#L27) +[packages/address/src/createAddress.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/address/src/createAddress.js#L26) diff --git a/docs/src/content/docs/reference/@tevm/address/functions/createContractAddress.md b/docs/src/content/docs/reference/@tevm/address/functions/createContractAddress.md index 93249dbdfa..5a6ac88458 100644 --- a/docs/src/content/docs/reference/@tevm/address/functions/createContractAddress.md +++ b/docs/src/content/docs/reference/@tevm/address/functions/createContractAddress.md @@ -11,12 +11,18 @@ title: "createContractAddress" • **from**: [`EthjsAddress`](/reference/tevm/utils/classes/ethjsaddress/) +The address of the account creating the contract. + • **nonce**: `bigint` +The nonce of the account creating the contract. + ## Returns [`Address`](/reference/tevm/address/classes/address/) +The generated contract address. + ## Defined in -[packages/address/src/createContractAddress.js:19](https://github.com/evmts/tevm-monorepo/blob/main/packages/address/src/createContractAddress.js#L19) +[packages/address/src/createContractAddress.js:15](https://github.com/evmts/tevm-monorepo/blob/main/packages/address/src/createContractAddress.js#L15) diff --git a/docs/src/content/docs/reference/@tevm/address/globals.md b/docs/src/content/docs/reference/@tevm/address/globals.md index 06fc20ab9f..07e792795b 100644 --- a/docs/src/content/docs/reference/@tevm/address/globals.md +++ b/docs/src/content/docs/reference/@tevm/address/globals.md @@ -12,7 +12,6 @@ title: "@tevm/address" ## Type Aliases - [Create2ContractAddressError](/reference/tevm/address/type-aliases/create2contractaddresserror/) -- [CreateContractAddressError](/reference/tevm/address/type-aliases/createcontractaddresserror/) ## Functions diff --git a/docs/src/content/docs/reference/@tevm/address/type-aliases/Create2ContractAddressError.md b/docs/src/content/docs/reference/@tevm/address/type-aliases/Create2ContractAddressError.md index b6dcad9b3e..ba3c197b6c 100644 --- a/docs/src/content/docs/reference/@tevm/address/type-aliases/Create2ContractAddressError.md +++ b/docs/src/content/docs/reference/@tevm/address/type-aliases/Create2ContractAddressError.md @@ -5,7 +5,7 @@ prev: false title: "Create2ContractAddressError" --- -> **Create2ContractAddressError**: [`InvalidSaltError`](/reference/tevm/errors/classes/invalidsalterror/) \| [`@tevm/errors`](/reference/tevm/errors/globals/) +> **Create2ContractAddressError**: [`@tevm/errors`](/reference/tevm/errors/globals/) \| [`@tevm/errors`](/reference/tevm/errors/globals/) ## Defined in diff --git a/docs/src/content/docs/reference/@tevm/address/type-aliases/CreateContractAddressError.md b/docs/src/content/docs/reference/@tevm/address/type-aliases/CreateContractAddressError.md deleted file mode 100644 index ebb33e7f01..0000000000 --- a/docs/src/content/docs/reference/@tevm/address/type-aliases/CreateContractAddressError.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -editUrl: false -next: false -prev: false -title: "CreateContractAddressError" ---- - -> **CreateContractAddressError**: [`@tevm/errors`](/reference/tevm/errors/globals/) - -## Defined in - -[packages/address/src/createContractAddress.js:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/address/src/createContractAddress.js#L8) diff --git a/docs/src/content/docs/reference/@tevm/block/classes/Block.md b/docs/src/content/docs/reference/@tevm/block/classes/Block.md index 15f96f780c..27ad93a438 100644 --- a/docs/src/content/docs/reference/@tevm/block/classes/Block.md +++ b/docs/src/content/docs/reference/@tevm/block/classes/Block.md @@ -38,7 +38,7 @@ Use the static factory methods to assist in creating a Block object from varying #### Defined in -[block.ts:334](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L334) +[packages/block/src/block.ts:334](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L334) ## Properties @@ -60,17 +60,129 @@ Use the static factory methods to assist in creating a Block object from varying #### Defined in -[block.ts:55](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L55) +[packages/block/src/block.ts:55](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L55) *** ### common -> `readonly` **common**: [`Common`](/reference/tevm/common/type-aliases/common/) +> `readonly` **common**: `object` + +#### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +##### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +#### blockExplorers.default + +> **blockExplorers.default**: `ChainBlockExplorer` + +#### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +#### contracts.ensRegistry? + +> `optional` **contracts.ensRegistry**: `ChainContract` + +#### contracts.ensUniversalResolver? + +> `optional` **contracts.ensUniversalResolver**: `ChainContract` + +#### contracts.multicall3? + +> `optional` **contracts.multicall3**: `ChainContract` + +#### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +##### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +#### ethjsCommon + +> **ethjsCommon**: `Common` + +#### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +#### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +#### id + +> **id**: `number` + +ID in number form + +#### name + +> **name**: `string` + +Human-readable name + +#### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +#### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +##### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +#### rpcUrls.default + +> **rpcUrls.default**: `ChainRpcUrls` + +#### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +#### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +#### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks #### Defined in -[block.ts:45](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L45) +[packages/block/src/block.ts:45](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L45) *** @@ -84,7 +196,7 @@ and will not lead to execution of the block via vm with verkle stateless manager #### Defined in -[block.ts:53](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L53) +[packages/block/src/block.ts:53](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L53) *** @@ -94,7 +206,7 @@ and will not lead to execution of the block via vm with verkle stateless manager #### Defined in -[block.ts:40](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L40) +[packages/block/src/block.ts:40](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L40) *** @@ -112,7 +224,7 @@ and will not lead to execution of the block via vm with verkle stateless manager #### Defined in -[block.ts:46](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L46) +[packages/block/src/block.ts:46](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L46) *** @@ -122,7 +234,7 @@ and will not lead to execution of the block via vm with verkle stateless manager #### Defined in -[block.ts:44](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L44) +[packages/block/src/block.ts:44](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L44) *** @@ -132,7 +244,7 @@ and will not lead to execution of the block via vm with verkle stateless manager #### Defined in -[block.ts:41](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L41) +[packages/block/src/block.ts:41](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L41) *** @@ -142,7 +254,7 @@ and will not lead to execution of the block via vm with verkle stateless manager #### Defined in -[block.ts:42](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L42) +[packages/block/src/block.ts:42](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L42) *** @@ -152,7 +264,7 @@ and will not lead to execution of the block via vm with verkle stateless manager #### Defined in -[block.ts:43](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L43) +[packages/block/src/block.ts:43](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L43) ## Methods @@ -168,7 +280,7 @@ Return a compact error string representation of the object #### Defined in -[block.ts:801](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L801) +[packages/block/src/block.ts:801](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L801) *** @@ -190,7 +302,7 @@ the parent of this `Block` #### Defined in -[block.ts:735](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L735) +[packages/block/src/block.ts:735](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L735) *** @@ -206,7 +318,7 @@ Generates transaction trie for validation. #### Defined in -[block.ts:455](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L455) +[packages/block/src/block.ts:455](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L455) *** @@ -224,7 +336,7 @@ an array of error strings #### Defined in -[block.ts:501](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L501) +[packages/block/src/block.ts:501](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L501) *** @@ -240,7 +352,7 @@ Returns the hash of the block. #### Defined in -[block.ts:434](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L434) +[packages/block/src/block.ts:434](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L434) *** @@ -256,7 +368,7 @@ Determines if this block is the genesis block. #### Defined in -[block.ts:441](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L441) +[packages/block/src/block.ts:441](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L441) *** @@ -272,7 +384,7 @@ Returns a Array of the raw Bytes Arrays of this block, in order. #### Defined in -[block.ts:412](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L412) +[packages/block/src/block.ts:412](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L412) *** @@ -286,7 +398,7 @@ Returns a Array of the raw Bytes Arrays of this block, in order. #### Defined in -[block.ts:478](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L478) +[packages/block/src/block.ts:478](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L478) *** @@ -302,7 +414,7 @@ Returns the rlp encoding of the block. #### Defined in -[block.ts:448](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L448) +[packages/block/src/block.ts:448](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L448) *** @@ -316,7 +428,7 @@ Returns the rlp encoding of the block. #### Defined in -[block.ts:767](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L767) +[packages/block/src/block.ts:767](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L767) *** @@ -332,7 +444,7 @@ Returns the block in JSON format. #### Defined in -[block.ts:752](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L752) +[packages/block/src/block.ts:752](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L752) *** @@ -350,7 +462,7 @@ True if all transactions are valid, false otherwise #### Defined in -[block.ts:551](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L551) +[packages/block/src/block.ts:551](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L551) *** @@ -369,7 +481,7 @@ True if the transaction trie is valid, false otherwise #### Defined in -[block.ts:464](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L464) +[packages/block/src/block.ts:464](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L464) *** @@ -387,7 +499,7 @@ true if the uncle's hash is valid, false otherwise. #### Defined in -[block.ts:668](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L668) +[packages/block/src/block.ts:668](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L668) *** @@ -411,7 +523,7 @@ header of parent block #### Defined in -[block.ts:622](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L622) +[packages/block/src/block.ts:622](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L622) *** @@ -442,7 +554,7 @@ if set to `false`, will not check for transaction validation errors (default: tr #### Defined in -[block.ts:567](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L567) +[packages/block/src/block.ts:567](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L567) *** @@ -465,7 +577,7 @@ the parent of this `Block` #### Defined in -[block.ts:745](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L745) +[packages/block/src/block.ts:745](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L745) *** @@ -487,7 +599,7 @@ Header does not count an uncle twice. #### Defined in -[block.ts:711](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L711) +[packages/block/src/block.ts:711](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L711) *** @@ -505,7 +617,7 @@ true if the withdrawals trie root is valid, false otherwise #### Defined in -[block.ts:681](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L681) +[packages/block/src/block.ts:681](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L681) *** @@ -533,7 +645,7 @@ the block constructed block #### Defined in -[block.ts:325](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L325) +[packages/block/src/block.ts:325](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L325) *** @@ -555,7 +667,7 @@ Static constructor to create a block from a block data dictionary #### Defined in -[block.ts:109](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L109) +[packages/block/src/block.ts:109](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L109) *** @@ -581,7 +693,7 @@ the block constructed block #### Defined in -[block.ts:260](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L260) +[packages/block/src/block.ts:260](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L260) *** @@ -603,7 +715,7 @@ Static constructor to create a block from a RLP-serialized block #### Defined in -[block.ts:161](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L161) +[packages/block/src/block.ts:161](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L161) *** @@ -625,7 +737,7 @@ Static constructor to create a block from an array of Bytes values #### Defined in -[block.ts:177](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L177) +[packages/block/src/block.ts:177](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L177) *** @@ -653,7 +765,7 @@ a 32 byte Uint8Array representing the requests trie root #### Defined in -[block.ts:93](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L93) +[packages/block/src/block.ts:93](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L93) *** @@ -677,7 +789,7 @@ array of TypedTransaction to compute the root of #### Defined in -[block.ts:79](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L79) +[packages/block/src/block.ts:79](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L79) *** @@ -701,4 +813,4 @@ array of Withdrawal to compute the root of #### Defined in -[block.ts:66](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L66) +[packages/block/src/block.ts:66](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L66) diff --git a/docs/src/content/docs/reference/@tevm/block/classes/BlockHeader.md b/docs/src/content/docs/reference/@tevm/block/classes/BlockHeader.md index 68e7b46454..cc7184b71e 100644 --- a/docs/src/content/docs/reference/@tevm/block/classes/BlockHeader.md +++ b/docs/src/content/docs/reference/@tevm/block/classes/BlockHeader.md @@ -32,7 +32,7 @@ varying data types. For a default empty header, use [BlockHeader.fromHeaderData] #### Defined in -[header.ts:148](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L148) +[packages/block/src/header.ts:148](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L148) ## Properties @@ -42,7 +42,7 @@ varying data types. For a default empty header, use [BlockHeader.fromHeaderData] #### Defined in -[header.ts:58](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L58) +[packages/block/src/header.ts:58](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L58) *** @@ -52,7 +52,7 @@ varying data types. For a default empty header, use [BlockHeader.fromHeaderData] #### Defined in -[header.ts:60](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L60) +[packages/block/src/header.ts:60](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L60) *** @@ -62,7 +62,7 @@ varying data types. For a default empty header, use [BlockHeader.fromHeaderData] #### Defined in -[header.ts:69](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L69) +[packages/block/src/header.ts:69](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L69) *** @@ -72,17 +72,129 @@ varying data types. For a default empty header, use [BlockHeader.fromHeaderData] #### Defined in -[header.ts:45](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L45) +[packages/block/src/header.ts:45](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L45) *** ### common -> `readonly` **common**: [`Common`](/reference/tevm/common/type-aliases/common/) +> `readonly` **common**: `object` + +#### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +##### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +#### blockExplorers.default + +> **blockExplorers.default**: `ChainBlockExplorer` + +#### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +#### contracts.ensRegistry? + +> `optional` **contracts.ensRegistry**: `ChainContract` + +#### contracts.ensUniversalResolver? + +> `optional` **contracts.ensUniversalResolver**: `ChainContract` + +#### contracts.multicall3? + +> `optional` **contracts.multicall3**: `ChainContract` + +#### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +##### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +#### ethjsCommon + +> **ethjsCommon**: `Common` + +#### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +#### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +#### id + +> **id**: `number` + +ID in number form + +#### name + +> **name**: `string` + +Human-readable name + +#### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +#### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +##### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +#### rpcUrls.default + +> **rpcUrls.default**: `ChainRpcUrls` + +#### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +#### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +#### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks #### Defined in -[header.ts:65](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L65) +[packages/block/src/header.ts:65](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L65) *** @@ -92,7 +204,7 @@ varying data types. For a default empty header, use [BlockHeader.fromHeaderData] #### Defined in -[header.ts:50](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L50) +[packages/block/src/header.ts:50](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L50) *** @@ -102,7 +214,7 @@ varying data types. For a default empty header, use [BlockHeader.fromHeaderData] #### Defined in -[header.ts:61](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L61) +[packages/block/src/header.ts:61](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L61) *** @@ -112,7 +224,7 @@ varying data types. For a default empty header, use [BlockHeader.fromHeaderData] #### Defined in -[header.ts:55](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L55) +[packages/block/src/header.ts:55](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L55) *** @@ -122,7 +234,7 @@ varying data types. For a default empty header, use [BlockHeader.fromHeaderData] #### Defined in -[header.ts:52](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L52) +[packages/block/src/header.ts:52](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L52) *** @@ -132,7 +244,7 @@ varying data types. For a default empty header, use [BlockHeader.fromHeaderData] #### Defined in -[header.ts:53](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L53) +[packages/block/src/header.ts:53](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L53) *** @@ -150,7 +262,7 @@ varying data types. For a default empty header, use [BlockHeader.fromHeaderData] #### Defined in -[header.ts:67](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L67) +[packages/block/src/header.ts:67](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L67) *** @@ -160,7 +272,7 @@ varying data types. For a default empty header, use [BlockHeader.fromHeaderData] #### Defined in -[header.ts:49](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L49) +[packages/block/src/header.ts:49](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L49) *** @@ -170,7 +282,7 @@ varying data types. For a default empty header, use [BlockHeader.fromHeaderData] #### Defined in -[header.ts:56](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L56) +[packages/block/src/header.ts:56](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L56) *** @@ -180,7 +292,7 @@ varying data types. For a default empty header, use [BlockHeader.fromHeaderData] #### Defined in -[header.ts:57](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L57) +[packages/block/src/header.ts:57](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L57) *** @@ -190,7 +302,7 @@ varying data types. For a default empty header, use [BlockHeader.fromHeaderData] #### Defined in -[header.ts:51](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L51) +[packages/block/src/header.ts:51](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L51) *** @@ -200,7 +312,7 @@ varying data types. For a default empty header, use [BlockHeader.fromHeaderData] #### Defined in -[header.ts:62](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L62) +[packages/block/src/header.ts:62](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L62) *** @@ -210,7 +322,7 @@ varying data types. For a default empty header, use [BlockHeader.fromHeaderData] #### Defined in -[header.ts:43](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L43) +[packages/block/src/header.ts:43](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L43) *** @@ -220,7 +332,7 @@ varying data types. For a default empty header, use [BlockHeader.fromHeaderData] #### Defined in -[header.ts:48](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L48) +[packages/block/src/header.ts:48](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L48) *** @@ -230,7 +342,7 @@ varying data types. For a default empty header, use [BlockHeader.fromHeaderData] #### Defined in -[header.ts:63](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L63) +[packages/block/src/header.ts:63](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L63) *** @@ -240,7 +352,7 @@ varying data types. For a default empty header, use [BlockHeader.fromHeaderData] #### Defined in -[header.ts:46](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L46) +[packages/block/src/header.ts:46](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L46) *** @@ -250,7 +362,7 @@ varying data types. For a default empty header, use [BlockHeader.fromHeaderData] #### Defined in -[header.ts:54](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L54) +[packages/block/src/header.ts:54](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L54) *** @@ -260,7 +372,7 @@ varying data types. For a default empty header, use [BlockHeader.fromHeaderData] #### Defined in -[header.ts:47](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L47) +[packages/block/src/header.ts:47](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L47) *** @@ -270,7 +382,7 @@ varying data types. For a default empty header, use [BlockHeader.fromHeaderData] #### Defined in -[header.ts:44](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L44) +[packages/block/src/header.ts:44](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L44) *** @@ -280,7 +392,7 @@ varying data types. For a default empty header, use [BlockHeader.fromHeaderData] #### Defined in -[header.ts:59](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L59) +[packages/block/src/header.ts:59](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L59) ## Accessors @@ -296,7 +408,7 @@ EIP-4399: After merge to PoS, `mixHash` supplanted as `prevRandao` #### Defined in -[header.ts:76](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L76) +[packages/block/src/header.ts:76](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L76) ## Methods @@ -316,7 +428,7 @@ if any check fails #### Defined in -[header.ts:397](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L397) +[packages/block/src/header.ts:397](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L397) *** @@ -332,7 +444,7 @@ Validates correct buffer lengths, throws if invalid. #### Defined in -[header.ts:310](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L310) +[packages/block/src/header.ts:310](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L310) *** @@ -350,7 +462,7 @@ Validates correct buffer lengths, throws if invalid. #### Defined in -[header.ts:680](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L680) +[packages/block/src/header.ts:680](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L680) *** @@ -367,7 +479,7 @@ activation block (see: https://blog.slock.it/hard-fork-specification-24b889e7070 #### Defined in -[header.ts:924](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L924) +[packages/block/src/header.ts:924](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L924) *** @@ -391,7 +503,7 @@ the total blob gas fee for numBlobs blobs #### Defined in -[header.ts:579](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L579) +[packages/block/src/header.ts:579](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L579) *** @@ -407,7 +519,7 @@ Calculates the base fee for a potential next block #### Defined in -[header.ts:520](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L520) +[packages/block/src/header.ts:520](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L520) *** @@ -425,7 +537,7 @@ The blob gas price #### Defined in -[header.ts:605](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L605) +[packages/block/src/header.ts:605](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L605) *** @@ -441,7 +553,7 @@ Calculates the excess blob gas for next (hopefully) post EIP 4844 block. #### Defined in -[header.ts:590](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L590) +[packages/block/src/header.ts:590](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L590) *** @@ -462,7 +574,7 @@ in conjunction with [BlockHeader.cliqueIsEpochTransition](../../../../../../../r #### Defined in -[header.ts:823](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L823) +[packages/block/src/header.ts:823](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L823) *** @@ -479,7 +591,7 @@ Returns extra seal data #### Defined in -[header.ts:793](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L793) +[packages/block/src/header.ts:793](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L793) *** @@ -496,7 +608,7 @@ Returns extra vanity data #### Defined in -[header.ts:784](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L784) +[packages/block/src/header.ts:784](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L784) *** @@ -513,7 +625,7 @@ header (only clique PoA, throws otherwise) #### Defined in -[header.ts:772](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L772) +[packages/block/src/header.ts:772](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L772) *** @@ -529,7 +641,7 @@ PoA clique signature hash without the seal. #### Defined in -[header.ts:761](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L761) +[packages/block/src/header.ts:761](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L761) *** @@ -545,7 +657,7 @@ Returns the signer address #### Defined in -[header.ts:860](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L860) +[packages/block/src/header.ts:860](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L860) *** @@ -568,7 +680,7 @@ Verifies the signature of the block (last 65 bytes of extraData field) #### Defined in -[header.ts:848](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L848) +[packages/block/src/header.ts:848](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L848) *** @@ -584,7 +696,7 @@ Return a compact error string representation of the object #### Defined in -[header.ts:946](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L946) +[packages/block/src/header.ts:946](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L946) *** @@ -606,7 +718,7 @@ the header from the parent `Block` of this header #### Defined in -[header.ts:692](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L692) +[packages/block/src/header.ts:692](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L692) *** @@ -624,7 +736,7 @@ the price in gwei per unit of blob gas spent #### Defined in -[header.ts:554](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L554) +[packages/block/src/header.ts:554](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L554) *** @@ -640,7 +752,7 @@ Returns the hash of the block header. #### Defined in -[header.ts:663](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L663) +[packages/block/src/header.ts:663](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L663) *** @@ -656,7 +768,7 @@ Checks if the block header is a genesis header. #### Defined in -[header.ts:676](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L676) +[packages/block/src/header.ts:676](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L676) *** @@ -672,7 +784,7 @@ Returns a Uint8Array Array of the raw Bytes in this header, in order. #### Defined in -[header.ts:612](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L612) +[packages/block/src/header.ts:612](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L612) *** @@ -688,7 +800,7 @@ Returns the rlp encoding of the block header. #### Defined in -[header.ts:877](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L877) +[packages/block/src/header.ts:877](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L877) *** @@ -704,7 +816,7 @@ Returns the block header in JSON format. #### Defined in -[header.ts:884](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L884) +[packages/block/src/header.ts:884](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L884) *** @@ -727,7 +839,7 @@ the header from the parent `Block` of this header #### Defined in -[header.ts:481](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L481) +[packages/block/src/header.ts:481](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L481) *** @@ -749,7 +861,7 @@ Static constructor to create a block header from a header data dictionary #### Defined in -[header.ts:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L90) +[packages/block/src/header.ts:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L90) *** @@ -771,7 +883,7 @@ Static constructor to create a block header from a RLP-serialized header #### Defined in -[header.ts:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L100) +[packages/block/src/header.ts:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L100) *** @@ -793,4 +905,4 @@ Static constructor to create a block header from an array of Bytes values #### Defined in -[header.ts:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L114) +[packages/block/src/header.ts:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L114) diff --git a/docs/src/content/docs/reference/@tevm/block/classes/ClRequest.md b/docs/src/content/docs/reference/@tevm/block/classes/ClRequest.md index bfa5c03960..9f1289f5a2 100644 --- a/docs/src/content/docs/reference/@tevm/block/classes/ClRequest.md +++ b/docs/src/content/docs/reference/@tevm/block/classes/ClRequest.md @@ -27,7 +27,7 @@ title: "ClRequest" #### Defined in -[ClRequest.ts:21](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/ClRequest.ts#L21) +[packages/block/src/ClRequest.ts:21](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/ClRequest.ts#L21) ## Properties @@ -41,7 +41,7 @@ title: "ClRequest" #### Defined in -[ClRequest.ts:20](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/ClRequest.ts#L20) +[packages/block/src/ClRequest.ts:20](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/ClRequest.ts#L20) *** @@ -55,7 +55,7 @@ title: "ClRequest" #### Defined in -[ClRequest.ts:19](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/ClRequest.ts#L19) +[packages/block/src/ClRequest.ts:19](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/ClRequest.ts#L19) ## Methods @@ -73,4 +73,4 @@ title: "ClRequest" #### Defined in -[ClRequest.ts:27](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/ClRequest.ts#L27) +[packages/block/src/ClRequest.ts:27](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/ClRequest.ts#L27) diff --git a/docs/src/content/docs/reference/@tevm/block/functions/blockFromRpc.md b/docs/src/content/docs/reference/@tevm/block/functions/blockFromRpc.md index ddc6219044..3600cf3975 100644 --- a/docs/src/content/docs/reference/@tevm/block/functions/blockFromRpc.md +++ b/docs/src/content/docs/reference/@tevm/block/functions/blockFromRpc.md @@ -33,4 +33,4 @@ Optional list of Ethereum JSON RPC of uncles (eth_getUncleByBlockHashAndIndex) ## Defined in -[from-rpc.ts:39](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/from-rpc.ts#L39) +[packages/block/src/from-rpc.ts:39](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/from-rpc.ts#L39) diff --git a/docs/src/content/docs/reference/@tevm/block/functions/executionPayloadFromBeaconPayload.md b/docs/src/content/docs/reference/@tevm/block/functions/executionPayloadFromBeaconPayload.md index 09d429a755..c94067e870 100644 --- a/docs/src/content/docs/reference/@tevm/block/functions/executionPayloadFromBeaconPayload.md +++ b/docs/src/content/docs/reference/@tevm/block/functions/executionPayloadFromBeaconPayload.md @@ -20,4 +20,4 @@ The JSON data can be retrieved from a consensus layer (CL) client on this Beacon ## Defined in -[from-beacon-payload.ts:93](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/from-beacon-payload.ts#L93) +[packages/block/src/from-beacon-payload.ts:93](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/from-beacon-payload.ts#L93) diff --git a/docs/src/content/docs/reference/@tevm/block/functions/getDifficulty.md b/docs/src/content/docs/reference/@tevm/block/functions/getDifficulty.md index 038801e46b..4edf26c21d 100644 --- a/docs/src/content/docs/reference/@tevm/block/functions/getDifficulty.md +++ b/docs/src/content/docs/reference/@tevm/block/functions/getDifficulty.md @@ -17,4 +17,4 @@ title: "getDifficulty" ## Defined in -[helpers.ts:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/helpers.ts#L81) +[packages/block/src/helpers.ts:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/helpers.ts#L81) diff --git a/docs/src/content/docs/reference/@tevm/block/functions/valuesArrayToHeaderData.md b/docs/src/content/docs/reference/@tevm/block/functions/valuesArrayToHeaderData.md index 0385cd8228..1712927c40 100644 --- a/docs/src/content/docs/reference/@tevm/block/functions/valuesArrayToHeaderData.md +++ b/docs/src/content/docs/reference/@tevm/block/functions/valuesArrayToHeaderData.md @@ -17,4 +17,4 @@ title: "valuesArrayToHeaderData" ## Defined in -[helpers.ts:24](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/helpers.ts#L24) +[packages/block/src/helpers.ts:24](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/helpers.ts#L24) diff --git a/docs/src/content/docs/reference/@tevm/block/interfaces/BlockData.md b/docs/src/content/docs/reference/@tevm/block/interfaces/BlockData.md index 7c5761494a..b85c75e9cb 100644 --- a/docs/src/content/docs/reference/@tevm/block/interfaces/BlockData.md +++ b/docs/src/content/docs/reference/@tevm/block/interfaces/BlockData.md @@ -17,7 +17,7 @@ EIP-6800: Verkle Proof Data (experimental) #### Defined in -[types.ts:151](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L151) +[packages/block/src/types.ts:151](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L151) *** @@ -29,7 +29,7 @@ Header data for the block #### Defined in -[types.ts:143](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L143) +[packages/block/src/types.ts:143](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L143) *** @@ -39,7 +39,7 @@ Header data for the block #### Defined in -[types.ts:147](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L147) +[packages/block/src/types.ts:147](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L147) *** @@ -49,7 +49,7 @@ Header data for the block #### Defined in -[types.ts:144](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L144) +[packages/block/src/types.ts:144](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L144) *** @@ -59,7 +59,7 @@ Header data for the block #### Defined in -[types.ts:145](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L145) +[packages/block/src/types.ts:145](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L145) *** @@ -69,4 +69,4 @@ Header data for the block #### Defined in -[types.ts:146](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L146) +[packages/block/src/types.ts:146](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L146) diff --git a/docs/src/content/docs/reference/@tevm/block/interfaces/BlockOptions.md b/docs/src/content/docs/reference/@tevm/block/interfaces/BlockOptions.md index a365ba28aa..74f68eeb39 100644 --- a/docs/src/content/docs/reference/@tevm/block/interfaces/BlockOptions.md +++ b/docs/src/content/docs/reference/@tevm/block/interfaces/BlockOptions.md @@ -26,7 +26,7 @@ Note that this option has no effect on networks other than PoW/Ethash networks #### Defined in -[types.ts:43](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L43) +[packages/block/src/types.ts:43](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L43) *** @@ -39,13 +39,13 @@ Will throw if provided on a non-PoA chain. #### Defined in -[types.ts:60](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L60) +[packages/block/src/types.ts:60](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L60) *** ### common -> **common**: [`Common`](/reference/tevm/common/type-aliases/common/) +> **common**: `object` A [Common](../../../../../../../reference/tevm/common/type-aliases/common) object defining the chain and the hardfork a block/block header belongs to. @@ -57,9 +57,121 @@ hardfork in the [Common](../../../../../../../reference/tevm/common/type-aliases Current default hardfork: `merge` +#### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +##### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +#### blockExplorers.default + +> **blockExplorers.default**: `ChainBlockExplorer` + +#### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +#### contracts.ensRegistry? + +> `optional` **contracts.ensRegistry**: `ChainContract` + +#### contracts.ensUniversalResolver? + +> `optional` **contracts.ensUniversalResolver**: `ChainContract` + +#### contracts.multicall3? + +> `optional` **contracts.multicall3**: `ChainContract` + +#### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +##### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +#### ethjsCommon + +> **ethjsCommon**: `Common` + +#### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +#### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +#### id + +> **id**: `number` + +ID in number form + +#### name + +> **name**: `string` + +Human-readable name + +#### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +#### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +##### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +#### rpcUrls.default + +> **rpcUrls.default**: `ChainRpcUrls` + +#### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +#### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +#### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + #### Defined in -[types.ts:24](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L24) +[packages/block/src/types.ts:24](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L24) *** @@ -69,7 +181,7 @@ Current default hardfork: `merge` #### Defined in -[types.ts:66](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L66) +[packages/block/src/types.ts:66](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L66) *** @@ -89,7 +201,7 @@ Default: true #### Defined in -[types.ts:55](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L55) +[packages/block/src/types.ts:55](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L55) *** @@ -107,7 +219,7 @@ Default: `false` (HF is set to whatever default HF is set by the [Common](../../ #### Defined in -[types.ts:34](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L34) +[packages/block/src/types.ts:34](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L34) *** @@ -119,4 +231,4 @@ Skip consensus format validation checks on header if set. Defaults to false. #### Defined in -[types.ts:64](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L64) +[packages/block/src/types.ts:64](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L64) diff --git a/docs/src/content/docs/reference/@tevm/block/interfaces/HeaderData.md b/docs/src/content/docs/reference/@tevm/block/interfaces/HeaderData.md index 630e5be0ca..8cb8a6e851 100644 --- a/docs/src/content/docs/reference/@tevm/block/interfaces/HeaderData.md +++ b/docs/src/content/docs/reference/@tevm/block/interfaces/HeaderData.md @@ -15,7 +15,7 @@ A block header's data. #### Defined in -[types.ts:128](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L128) +[packages/block/src/types.ts:128](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L128) *** @@ -25,7 +25,7 @@ A block header's data. #### Defined in -[types.ts:130](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L130) +[packages/block/src/types.ts:130](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L130) *** @@ -35,7 +35,7 @@ A block header's data. #### Defined in -[types.ts:115](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L115) +[packages/block/src/types.ts:115](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L115) *** @@ -45,7 +45,7 @@ A block header's data. #### Defined in -[types.ts:120](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L120) +[packages/block/src/types.ts:120](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L120) *** @@ -55,7 +55,7 @@ A block header's data. #### Defined in -[types.ts:131](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L131) +[packages/block/src/types.ts:131](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L131) *** @@ -65,7 +65,7 @@ A block header's data. #### Defined in -[types.ts:125](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L125) +[packages/block/src/types.ts:125](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L125) *** @@ -75,7 +75,7 @@ A block header's data. #### Defined in -[types.ts:122](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L122) +[packages/block/src/types.ts:122](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L122) *** @@ -85,7 +85,7 @@ A block header's data. #### Defined in -[types.ts:123](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L123) +[packages/block/src/types.ts:123](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L123) *** @@ -95,7 +95,7 @@ A block header's data. #### Defined in -[types.ts:119](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L119) +[packages/block/src/types.ts:119](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L119) *** @@ -105,7 +105,7 @@ A block header's data. #### Defined in -[types.ts:126](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L126) +[packages/block/src/types.ts:126](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L126) *** @@ -115,7 +115,7 @@ A block header's data. #### Defined in -[types.ts:127](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L127) +[packages/block/src/types.ts:127](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L127) *** @@ -125,7 +125,7 @@ A block header's data. #### Defined in -[types.ts:121](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L121) +[packages/block/src/types.ts:121](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L121) *** @@ -135,7 +135,7 @@ A block header's data. #### Defined in -[types.ts:132](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L132) +[packages/block/src/types.ts:132](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L132) *** @@ -145,7 +145,7 @@ A block header's data. #### Defined in -[types.ts:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L113) +[packages/block/src/types.ts:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L113) *** @@ -155,7 +155,7 @@ A block header's data. #### Defined in -[types.ts:118](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L118) +[packages/block/src/types.ts:118](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L118) *** @@ -165,7 +165,7 @@ A block header's data. #### Defined in -[types.ts:133](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L133) +[packages/block/src/types.ts:133](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L133) *** @@ -175,7 +175,7 @@ A block header's data. #### Defined in -[types.ts:116](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L116) +[packages/block/src/types.ts:116](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L116) *** @@ -185,7 +185,7 @@ A block header's data. #### Defined in -[types.ts:124](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L124) +[packages/block/src/types.ts:124](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L124) *** @@ -195,7 +195,7 @@ A block header's data. #### Defined in -[types.ts:117](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L117) +[packages/block/src/types.ts:117](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L117) *** @@ -205,7 +205,7 @@ A block header's data. #### Defined in -[types.ts:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L114) +[packages/block/src/types.ts:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L114) *** @@ -215,4 +215,4 @@ A block header's data. #### Defined in -[types.ts:129](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L129) +[packages/block/src/types.ts:129](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L129) diff --git a/docs/src/content/docs/reference/@tevm/block/interfaces/JsonBlock.md b/docs/src/content/docs/reference/@tevm/block/interfaces/JsonBlock.md index 84a4e5da17..b1bee5f3c5 100644 --- a/docs/src/content/docs/reference/@tevm/block/interfaces/JsonBlock.md +++ b/docs/src/content/docs/reference/@tevm/block/interfaces/JsonBlock.md @@ -15,7 +15,7 @@ An object with the block's data represented as strings. #### Defined in -[types.ts:187](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L187) +[packages/block/src/types.ts:187](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L187) *** @@ -27,7 +27,7 @@ Header data for the block #### Defined in -[types.ts:182](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L182) +[packages/block/src/types.ts:182](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L182) *** @@ -37,7 +37,7 @@ Header data for the block #### Defined in -[types.ts:186](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L186) +[packages/block/src/types.ts:186](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L186) *** @@ -47,7 +47,7 @@ Header data for the block #### Defined in -[types.ts:183](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L183) +[packages/block/src/types.ts:183](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L183) *** @@ -57,7 +57,7 @@ Header data for the block #### Defined in -[types.ts:184](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L184) +[packages/block/src/types.ts:184](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L184) *** @@ -67,4 +67,4 @@ Header data for the block #### Defined in -[types.ts:185](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L185) +[packages/block/src/types.ts:185](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L185) diff --git a/docs/src/content/docs/reference/@tevm/block/interfaces/JsonHeader.md b/docs/src/content/docs/reference/@tevm/block/interfaces/JsonHeader.md index e29b5f3802..7466cf76af 100644 --- a/docs/src/content/docs/reference/@tevm/block/interfaces/JsonHeader.md +++ b/docs/src/content/docs/reference/@tevm/block/interfaces/JsonHeader.md @@ -15,7 +15,7 @@ An object with the block header's data represented as 0x-prefixed hex strings. #### Defined in -[types.ts:210](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L210) +[packages/block/src/types.ts:210](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L210) *** @@ -25,7 +25,7 @@ An object with the block header's data represented as 0x-prefixed hex strings. #### Defined in -[types.ts:212](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L212) +[packages/block/src/types.ts:212](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L212) *** @@ -35,7 +35,7 @@ An object with the block header's data represented as 0x-prefixed hex strings. #### Defined in -[types.ts:197](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L197) +[packages/block/src/types.ts:197](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L197) *** @@ -45,7 +45,7 @@ An object with the block header's data represented as 0x-prefixed hex strings. #### Defined in -[types.ts:202](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L202) +[packages/block/src/types.ts:202](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L202) *** @@ -55,7 +55,7 @@ An object with the block header's data represented as 0x-prefixed hex strings. #### Defined in -[types.ts:213](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L213) +[packages/block/src/types.ts:213](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L213) *** @@ -65,7 +65,7 @@ An object with the block header's data represented as 0x-prefixed hex strings. #### Defined in -[types.ts:207](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L207) +[packages/block/src/types.ts:207](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L207) *** @@ -75,7 +75,7 @@ An object with the block header's data represented as 0x-prefixed hex strings. #### Defined in -[types.ts:204](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L204) +[packages/block/src/types.ts:204](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L204) *** @@ -85,7 +85,7 @@ An object with the block header's data represented as 0x-prefixed hex strings. #### Defined in -[types.ts:205](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L205) +[packages/block/src/types.ts:205](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L205) *** @@ -95,7 +95,7 @@ An object with the block header's data represented as 0x-prefixed hex strings. #### Defined in -[types.ts:201](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L201) +[packages/block/src/types.ts:201](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L201) *** @@ -105,7 +105,7 @@ An object with the block header's data represented as 0x-prefixed hex strings. #### Defined in -[types.ts:208](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L208) +[packages/block/src/types.ts:208](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L208) *** @@ -115,7 +115,7 @@ An object with the block header's data represented as 0x-prefixed hex strings. #### Defined in -[types.ts:209](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L209) +[packages/block/src/types.ts:209](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L209) *** @@ -125,7 +125,7 @@ An object with the block header's data represented as 0x-prefixed hex strings. #### Defined in -[types.ts:203](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L203) +[packages/block/src/types.ts:203](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L203) *** @@ -135,7 +135,7 @@ An object with the block header's data represented as 0x-prefixed hex strings. #### Defined in -[types.ts:214](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L214) +[packages/block/src/types.ts:214](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L214) *** @@ -145,7 +145,7 @@ An object with the block header's data represented as 0x-prefixed hex strings. #### Defined in -[types.ts:195](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L195) +[packages/block/src/types.ts:195](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L195) *** @@ -155,7 +155,7 @@ An object with the block header's data represented as 0x-prefixed hex strings. #### Defined in -[types.ts:200](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L200) +[packages/block/src/types.ts:200](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L200) *** @@ -165,7 +165,7 @@ An object with the block header's data represented as 0x-prefixed hex strings. #### Defined in -[types.ts:215](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L215) +[packages/block/src/types.ts:215](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L215) *** @@ -175,7 +175,7 @@ An object with the block header's data represented as 0x-prefixed hex strings. #### Defined in -[types.ts:198](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L198) +[packages/block/src/types.ts:198](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L198) *** @@ -185,7 +185,7 @@ An object with the block header's data represented as 0x-prefixed hex strings. #### Defined in -[types.ts:206](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L206) +[packages/block/src/types.ts:206](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L206) *** @@ -195,7 +195,7 @@ An object with the block header's data represented as 0x-prefixed hex strings. #### Defined in -[types.ts:199](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L199) +[packages/block/src/types.ts:199](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L199) *** @@ -205,7 +205,7 @@ An object with the block header's data represented as 0x-prefixed hex strings. #### Defined in -[types.ts:196](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L196) +[packages/block/src/types.ts:196](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L196) *** @@ -215,4 +215,4 @@ An object with the block header's data represented as 0x-prefixed hex strings. #### Defined in -[types.ts:211](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L211) +[packages/block/src/types.ts:211](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L211) diff --git a/docs/src/content/docs/reference/@tevm/block/interfaces/JsonRpcBlock.md b/docs/src/content/docs/reference/@tevm/block/interfaces/JsonRpcBlock.md index f3e60f1b22..9a008b058a 100644 --- a/docs/src/content/docs/reference/@tevm/block/interfaces/JsonRpcBlock.md +++ b/docs/src/content/docs/reference/@tevm/block/interfaces/JsonRpcBlock.md @@ -13,7 +13,7 @@ title: "JsonRpcBlock" #### Defined in -[types.ts:243](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L243) +[packages/block/src/types.ts:243](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L243) *** @@ -23,7 +23,7 @@ title: "JsonRpcBlock" #### Defined in -[types.ts:246](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L246) +[packages/block/src/types.ts:246](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L246) *** @@ -33,7 +33,7 @@ title: "JsonRpcBlock" #### Defined in -[types.ts:234](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L234) +[packages/block/src/types.ts:234](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L234) *** @@ -43,7 +43,7 @@ title: "JsonRpcBlock" #### Defined in -[types.ts:247](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L247) +[packages/block/src/types.ts:247](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L247) *** @@ -53,7 +53,7 @@ title: "JsonRpcBlock" #### Defined in -[types.ts:249](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L249) +[packages/block/src/types.ts:249](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L249) *** @@ -63,7 +63,7 @@ title: "JsonRpcBlock" #### Defined in -[types.ts:236](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L236) +[packages/block/src/types.ts:236](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L236) *** @@ -73,7 +73,7 @@ title: "JsonRpcBlock" #### Defined in -[types.ts:238](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L238) +[packages/block/src/types.ts:238](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L238) *** @@ -83,7 +83,7 @@ title: "JsonRpcBlock" #### Defined in -[types.ts:239](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L239) +[packages/block/src/types.ts:239](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L239) *** @@ -93,7 +93,7 @@ title: "JsonRpcBlock" #### Defined in -[types.ts:224](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L224) +[packages/block/src/types.ts:224](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L224) *** @@ -103,7 +103,7 @@ title: "JsonRpcBlock" #### Defined in -[types.ts:229](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L229) +[packages/block/src/types.ts:229](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L229) *** @@ -113,7 +113,7 @@ title: "JsonRpcBlock" #### Defined in -[types.ts:233](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L233) +[packages/block/src/types.ts:233](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L233) *** @@ -123,7 +123,7 @@ title: "JsonRpcBlock" #### Defined in -[types.ts:226](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L226) +[packages/block/src/types.ts:226](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L226) *** @@ -133,7 +133,7 @@ title: "JsonRpcBlock" #### Defined in -[types.ts:227](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L227) +[packages/block/src/types.ts:227](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L227) *** @@ -143,7 +143,7 @@ title: "JsonRpcBlock" #### Defined in -[types.ts:223](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L223) +[packages/block/src/types.ts:223](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L223) *** @@ -153,7 +153,7 @@ title: "JsonRpcBlock" #### Defined in -[types.ts:248](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L248) +[packages/block/src/types.ts:248](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L248) *** @@ -163,7 +163,7 @@ title: "JsonRpcBlock" #### Defined in -[types.ts:225](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L225) +[packages/block/src/types.ts:225](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L225) *** @@ -173,7 +173,7 @@ title: "JsonRpcBlock" #### Defined in -[types.ts:232](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L232) +[packages/block/src/types.ts:232](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L232) *** @@ -183,7 +183,7 @@ title: "JsonRpcBlock" #### Defined in -[types.ts:251](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L251) +[packages/block/src/types.ts:251](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L251) *** @@ -193,7 +193,7 @@ title: "JsonRpcBlock" #### Defined in -[types.ts:250](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L250) +[packages/block/src/types.ts:250](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L250) *** @@ -203,7 +203,7 @@ title: "JsonRpcBlock" #### Defined in -[types.ts:228](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L228) +[packages/block/src/types.ts:228](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L228) *** @@ -213,7 +213,7 @@ title: "JsonRpcBlock" #### Defined in -[types.ts:237](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L237) +[packages/block/src/types.ts:237](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L237) *** @@ -223,7 +223,7 @@ title: "JsonRpcBlock" #### Defined in -[types.ts:231](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L231) +[packages/block/src/types.ts:231](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L231) *** @@ -233,7 +233,7 @@ title: "JsonRpcBlock" #### Defined in -[types.ts:240](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L240) +[packages/block/src/types.ts:240](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L240) *** @@ -243,7 +243,7 @@ title: "JsonRpcBlock" #### Defined in -[types.ts:235](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L235) +[packages/block/src/types.ts:235](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L235) *** @@ -253,7 +253,7 @@ title: "JsonRpcBlock" #### Defined in -[types.ts:241](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L241) +[packages/block/src/types.ts:241](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L241) *** @@ -263,7 +263,7 @@ title: "JsonRpcBlock" #### Defined in -[types.ts:230](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L230) +[packages/block/src/types.ts:230](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L230) *** @@ -273,7 +273,7 @@ title: "JsonRpcBlock" #### Defined in -[types.ts:242](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L242) +[packages/block/src/types.ts:242](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L242) *** @@ -283,7 +283,7 @@ title: "JsonRpcBlock" #### Defined in -[types.ts:244](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L244) +[packages/block/src/types.ts:244](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L244) *** @@ -293,4 +293,4 @@ title: "JsonRpcBlock" #### Defined in -[types.ts:245](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L245) +[packages/block/src/types.ts:245](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L245) diff --git a/docs/src/content/docs/reference/@tevm/block/interfaces/VerkleExecutionWitness.md b/docs/src/content/docs/reference/@tevm/block/interfaces/VerkleExecutionWitness.md index d1a8b7161b..ddb137e107 100644 --- a/docs/src/content/docs/reference/@tevm/block/interfaces/VerkleExecutionWitness.md +++ b/docs/src/content/docs/reference/@tevm/block/interfaces/VerkleExecutionWitness.md @@ -20,7 +20,7 @@ In the current design, it also contains the resulting state of the block executi #### Defined in -[types.ts:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L100) +[packages/block/src/types.ts:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L100) *** @@ -33,4 +33,4 @@ Proves that the provided stateDiff belongs to the canonical verkle tree. #### Defined in -[types.ts:105](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L105) +[packages/block/src/types.ts:105](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L105) diff --git a/docs/src/content/docs/reference/@tevm/block/interfaces/VerkleProof.md b/docs/src/content/docs/reference/@tevm/block/interfaces/VerkleProof.md index 2a8c05302d..9d5e5ae115 100644 --- a/docs/src/content/docs/reference/@tevm/block/interfaces/VerkleProof.md +++ b/docs/src/content/docs/reference/@tevm/block/interfaces/VerkleProof.md @@ -13,7 +13,7 @@ title: "VerkleProof" #### Defined in -[types.ts:70](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L70) +[packages/block/src/types.ts:70](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L70) *** @@ -23,7 +23,7 @@ title: "VerkleProof" #### Defined in -[types.ts:71](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L71) +[packages/block/src/types.ts:71](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L71) *** @@ -33,7 +33,7 @@ title: "VerkleProof" #### Defined in -[types.ts:72](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L72) +[packages/block/src/types.ts:72](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L72) *** @@ -55,7 +55,7 @@ title: "VerkleProof" #### Defined in -[types.ts:73](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L73) +[packages/block/src/types.ts:73](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L73) *** @@ -65,4 +65,4 @@ title: "VerkleProof" #### Defined in -[types.ts:78](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L78) +[packages/block/src/types.ts:78](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L78) diff --git a/docs/src/content/docs/reference/@tevm/block/interfaces/VerkleStateDiff.md b/docs/src/content/docs/reference/@tevm/block/interfaces/VerkleStateDiff.md index 2db612120b..04f18b5d85 100644 --- a/docs/src/content/docs/reference/@tevm/block/interfaces/VerkleStateDiff.md +++ b/docs/src/content/docs/reference/@tevm/block/interfaces/VerkleStateDiff.md @@ -13,7 +13,7 @@ title: "VerkleStateDiff" #### Defined in -[types.ts:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L82) +[packages/block/src/types.ts:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L82) *** @@ -23,4 +23,4 @@ title: "VerkleStateDiff" #### Defined in -[types.ts:83](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L83) +[packages/block/src/types.ts:83](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L83) diff --git a/docs/src/content/docs/reference/@tevm/block/type-aliases/BeaconPayloadJson.md b/docs/src/content/docs/reference/@tevm/block/type-aliases/BeaconPayloadJson.md index edcf770af1..28c91717b3 100644 --- a/docs/src/content/docs/reference/@tevm/block/type-aliases/BeaconPayloadJson.md +++ b/docs/src/content/docs/reference/@tevm/block/type-aliases/BeaconPayloadJson.md @@ -87,4 +87,4 @@ title: "BeaconPayloadJson" ## Defined in -[from-beacon-payload.ts:13](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/from-beacon-payload.ts#L13) +[packages/block/src/from-beacon-payload.ts:13](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/from-beacon-payload.ts#L13) diff --git a/docs/src/content/docs/reference/@tevm/block/type-aliases/BlockBodyBytes.md b/docs/src/content/docs/reference/@tevm/block/type-aliases/BlockBodyBytes.md index 92078fe2c5..cf2a994664 100644 --- a/docs/src/content/docs/reference/@tevm/block/type-aliases/BlockBodyBytes.md +++ b/docs/src/content/docs/reference/@tevm/block/type-aliases/BlockBodyBytes.md @@ -9,4 +9,4 @@ title: "BlockBodyBytes" ## Defined in -[types.ts:168](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L168) +[packages/block/src/types.ts:168](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L168) diff --git a/docs/src/content/docs/reference/@tevm/block/type-aliases/BlockBytes.md b/docs/src/content/docs/reference/@tevm/block/type-aliases/BlockBytes.md index 559b7b4d0b..31d4f3820f 100644 --- a/docs/src/content/docs/reference/@tevm/block/type-aliases/BlockBytes.md +++ b/docs/src/content/docs/reference/@tevm/block/type-aliases/BlockBytes.md @@ -9,4 +9,4 @@ title: "BlockBytes" ## Defined in -[types.ts:158](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L158) +[packages/block/src/types.ts:158](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L158) diff --git a/docs/src/content/docs/reference/@tevm/block/type-aliases/BlockHeaderBytes.md b/docs/src/content/docs/reference/@tevm/block/type-aliases/BlockHeaderBytes.md index 357c37997b..66516e98e3 100644 --- a/docs/src/content/docs/reference/@tevm/block/type-aliases/BlockHeaderBytes.md +++ b/docs/src/content/docs/reference/@tevm/block/type-aliases/BlockHeaderBytes.md @@ -11,4 +11,4 @@ BlockHeaderBuffer is a Buffer array, except for the Verkle PreState which is an ## Defined in -[types.ts:167](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L167) +[packages/block/src/types.ts:167](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L167) diff --git a/docs/src/content/docs/reference/@tevm/block/type-aliases/ExecutionPayload.md b/docs/src/content/docs/reference/@tevm/block/type-aliases/ExecutionPayload.md index 105be0ef0b..d38b995c2a 100644 --- a/docs/src/content/docs/reference/@tevm/block/type-aliases/ExecutionPayload.md +++ b/docs/src/content/docs/reference/@tevm/block/type-aliases/ExecutionPayload.md @@ -91,4 +91,4 @@ title: "ExecutionPayload" ## Defined in -[types.ts:263](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L263) +[packages/block/src/types.ts:263](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L263) diff --git a/docs/src/content/docs/reference/@tevm/block/type-aliases/ExecutionWitnessBytes.md b/docs/src/content/docs/reference/@tevm/block/type-aliases/ExecutionWitnessBytes.md index 8ab6e0db45..d66432667b 100644 --- a/docs/src/content/docs/reference/@tevm/block/type-aliases/ExecutionWitnessBytes.md +++ b/docs/src/content/docs/reference/@tevm/block/type-aliases/ExecutionWitnessBytes.md @@ -9,4 +9,4 @@ title: "ExecutionWitnessBytes" ## Defined in -[types.ts:156](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L156) +[packages/block/src/types.ts:156](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L156) diff --git a/docs/src/content/docs/reference/@tevm/block/type-aliases/RequestsBytes.md b/docs/src/content/docs/reference/@tevm/block/type-aliases/RequestsBytes.md index ef371a1a6e..d161b437f3 100644 --- a/docs/src/content/docs/reference/@tevm/block/type-aliases/RequestsBytes.md +++ b/docs/src/content/docs/reference/@tevm/block/type-aliases/RequestsBytes.md @@ -9,4 +9,4 @@ title: "RequestsBytes" ## Defined in -[types.ts:155](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L155) +[packages/block/src/types.ts:155](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L155) diff --git a/docs/src/content/docs/reference/@tevm/block/type-aliases/TransactionsBytes.md b/docs/src/content/docs/reference/@tevm/block/type-aliases/TransactionsBytes.md index db0b4bdf9e..756a154d38 100644 --- a/docs/src/content/docs/reference/@tevm/block/type-aliases/TransactionsBytes.md +++ b/docs/src/content/docs/reference/@tevm/block/type-aliases/TransactionsBytes.md @@ -11,4 +11,4 @@ TransactionsBytes can be an array of serialized txs for Typed Transactions or an ## Defined in -[types.ts:172](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L172) +[packages/block/src/types.ts:172](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L172) diff --git a/docs/src/content/docs/reference/@tevm/block/type-aliases/UncleHeadersBytes.md b/docs/src/content/docs/reference/@tevm/block/type-aliases/UncleHeadersBytes.md index a817509c7a..6b5f5bb5e1 100644 --- a/docs/src/content/docs/reference/@tevm/block/type-aliases/UncleHeadersBytes.md +++ b/docs/src/content/docs/reference/@tevm/block/type-aliases/UncleHeadersBytes.md @@ -9,4 +9,4 @@ title: "UncleHeadersBytes" ## Defined in -[types.ts:173](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L173) +[packages/block/src/types.ts:173](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L173) diff --git a/docs/src/content/docs/reference/@tevm/block/type-aliases/WithdrawalV1.md b/docs/src/content/docs/reference/@tevm/block/type-aliases/WithdrawalV1.md index 74b7456cec..be447a7601 100644 --- a/docs/src/content/docs/reference/@tevm/block/type-aliases/WithdrawalV1.md +++ b/docs/src/content/docs/reference/@tevm/block/type-aliases/WithdrawalV1.md @@ -27,4 +27,4 @@ title: "WithdrawalV1" ## Defined in -[types.ts:254](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L254) +[packages/block/src/types.ts:254](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L254) diff --git a/docs/src/content/docs/reference/@tevm/block/type-aliases/WithdrawalsBytes.md b/docs/src/content/docs/reference/@tevm/block/type-aliases/WithdrawalsBytes.md index a96ee6811d..5da13db2fb 100644 --- a/docs/src/content/docs/reference/@tevm/block/type-aliases/WithdrawalsBytes.md +++ b/docs/src/content/docs/reference/@tevm/block/type-aliases/WithdrawalsBytes.md @@ -9,4 +9,4 @@ title: "WithdrawalsBytes" ## Defined in -[types.ts:154](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L154) +[packages/block/src/types.ts:154](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L154) diff --git a/docs/src/content/docs/reference/@tevm/blockchain/functions/createBaseChain.md b/docs/src/content/docs/reference/@tevm/blockchain/functions/createBaseChain.md index 9436a864b6..f65af9fa21 100644 --- a/docs/src/content/docs/reference/@tevm/blockchain/functions/createBaseChain.md +++ b/docs/src/content/docs/reference/@tevm/blockchain/functions/createBaseChain.md @@ -19,4 +19,4 @@ Base chain object ## Defined in -[createBaseChain.js:50](https://github.com/evmts/tevm-monorepo/blob/main/packages/blockchain/src/createBaseChain.js#L50) +[packages/blockchain/src/createBaseChain.js:50](https://github.com/evmts/tevm-monorepo/blob/main/packages/blockchain/src/createBaseChain.js#L50) diff --git a/docs/src/content/docs/reference/@tevm/blockchain/functions/createChain.md b/docs/src/content/docs/reference/@tevm/blockchain/functions/createChain.md index f3d7d6d393..54c57b6e12 100644 --- a/docs/src/content/docs/reference/@tevm/blockchain/functions/createChain.md +++ b/docs/src/content/docs/reference/@tevm/blockchain/functions/createChain.md @@ -17,4 +17,4 @@ title: "createChain" ## Defined in -[createChain.js:16](https://github.com/evmts/tevm-monorepo/blob/main/packages/blockchain/src/createChain.js#L16) +[packages/blockchain/src/createChain.js:16](https://github.com/evmts/tevm-monorepo/blob/main/packages/blockchain/src/createChain.js#L16) diff --git a/docs/src/content/docs/reference/@tevm/blockchain/functions/deepCopy.md b/docs/src/content/docs/reference/@tevm/blockchain/functions/deepCopy.md index 220d945e4d..c74fe85803 100644 --- a/docs/src/content/docs/reference/@tevm/blockchain/functions/deepCopy.md +++ b/docs/src/content/docs/reference/@tevm/blockchain/functions/deepCopy.md @@ -21,4 +21,4 @@ title: "deepCopy" ## Defined in -[actions/deepCopy.js:7](https://github.com/evmts/tevm-monorepo/blob/main/packages/blockchain/src/actions/deepCopy.js#L7) +[packages/blockchain/src/actions/deepCopy.js:7](https://github.com/evmts/tevm-monorepo/blob/main/packages/blockchain/src/actions/deepCopy.js#L7) diff --git a/docs/src/content/docs/reference/@tevm/blockchain/functions/delBlock.md b/docs/src/content/docs/reference/@tevm/blockchain/functions/delBlock.md index e0f59afc19..2714ad6c66 100644 --- a/docs/src/content/docs/reference/@tevm/blockchain/functions/delBlock.md +++ b/docs/src/content/docs/reference/@tevm/blockchain/functions/delBlock.md @@ -30,4 +30,4 @@ The hash of the block to be deleted ## Defined in -[actions/delBlock.js:12](https://github.com/evmts/tevm-monorepo/blob/main/packages/blockchain/src/actions/delBlock.js#L12) +[packages/blockchain/src/actions/delBlock.js:12](https://github.com/evmts/tevm-monorepo/blob/main/packages/blockchain/src/actions/delBlock.js#L12) diff --git a/docs/src/content/docs/reference/@tevm/blockchain/functions/getBlock.md b/docs/src/content/docs/reference/@tevm/blockchain/functions/getBlock.md index d012ddc626..a34872aaba 100644 --- a/docs/src/content/docs/reference/@tevm/blockchain/functions/getBlock.md +++ b/docs/src/content/docs/reference/@tevm/blockchain/functions/getBlock.md @@ -27,4 +27,4 @@ Returns a block by its hash or number. ## Defined in -[actions/getBlock.js:13](https://github.com/evmts/tevm-monorepo/blob/main/packages/blockchain/src/actions/getBlock.js#L13) +[packages/blockchain/src/actions/getBlock.js:13](https://github.com/evmts/tevm-monorepo/blob/main/packages/blockchain/src/actions/getBlock.js#L13) diff --git a/docs/src/content/docs/reference/@tevm/blockchain/functions/getBlockFromRpc.md b/docs/src/content/docs/reference/@tevm/blockchain/functions/getBlockFromRpc.md index 0aa09ccb40..494dccb5dc 100644 --- a/docs/src/content/docs/reference/@tevm/blockchain/functions/getBlockFromRpc.md +++ b/docs/src/content/docs/reference/@tevm/blockchain/functions/getBlockFromRpc.md @@ -19,7 +19,69 @@ title: "getBlockFromRpc" • **params.transport.request**: `EIP1193RequestFn`\<`undefined`\> -• **common**: [`Common`](/reference/tevm/common/type-aliases/common/) +• **common** + +• **common.blockExplorers?** + +Collection of block explorers + +• **common.blockExplorers.default**: `ChainBlockExplorer` + +• **common.contracts?** + +Collection of contracts + +• **common.contracts.ensRegistry?**: `ChainContract` + +• **common.contracts.ensUniversalResolver?**: `ChainContract` + +• **common.contracts.multicall3?**: `ChainContract` + +• **common.copy** + +• **common.custom?**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +• **common.ethjsCommon**: `Common` + +• **common.fees?**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +• **common.formatters?**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +• **common.id**: `number` + +ID in number form + +• **common.name**: `string` + +Human-readable name + +• **common.nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +• **common.rpcUrls** + +Collection of RPC endpoints + +• **common.rpcUrls.default**: `ChainRpcUrls` + +• **common.serializers?**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +• **common.sourceId?**: `number` + +Source Chain ID (ie. the L1 chain) + +• **common.testnet?**: `boolean` + +Flag for test networks ## Returns @@ -27,4 +89,4 @@ title: "getBlockFromRpc" ## Defined in -[utils/getBlockFromRpc.js:16](https://github.com/evmts/tevm-monorepo/blob/main/packages/blockchain/src/utils/getBlockFromRpc.js#L16) +[packages/blockchain/src/utils/getBlockFromRpc.js:16](https://github.com/evmts/tevm-monorepo/blob/main/packages/blockchain/src/utils/getBlockFromRpc.js#L16) diff --git a/docs/src/content/docs/reference/@tevm/blockchain/functions/getCanonicalHeadBlock.md b/docs/src/content/docs/reference/@tevm/blockchain/functions/getCanonicalHeadBlock.md index e337484793..cd152e4243 100644 --- a/docs/src/content/docs/reference/@tevm/blockchain/functions/getCanonicalHeadBlock.md +++ b/docs/src/content/docs/reference/@tevm/blockchain/functions/getCanonicalHeadBlock.md @@ -23,4 +23,4 @@ Returns the latest full block in the canonical chain. ## Defined in -[actions/getCanonicalHeadBlock.js:7](https://github.com/evmts/tevm-monorepo/blob/main/packages/blockchain/src/actions/getCanonicalHeadBlock.js#L7) +[packages/blockchain/src/actions/getCanonicalHeadBlock.js:7](https://github.com/evmts/tevm-monorepo/blob/main/packages/blockchain/src/actions/getCanonicalHeadBlock.js#L7) diff --git a/docs/src/content/docs/reference/@tevm/blockchain/functions/getIteratorHead.md b/docs/src/content/docs/reference/@tevm/blockchain/functions/getIteratorHead.md index 81eb484d04..9a813aeb2c 100644 --- a/docs/src/content/docs/reference/@tevm/blockchain/functions/getIteratorHead.md +++ b/docs/src/content/docs/reference/@tevm/blockchain/functions/getIteratorHead.md @@ -29,4 +29,4 @@ Optional name of the iterator head (default: 'vm') ## Defined in -[actions/getIteratorHead.js:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/blockchain/src/actions/getIteratorHead.js#L8) +[packages/blockchain/src/actions/getIteratorHead.js:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/blockchain/src/actions/getIteratorHead.js#L8) diff --git a/docs/src/content/docs/reference/@tevm/blockchain/functions/isTevmBlockTag.md b/docs/src/content/docs/reference/@tevm/blockchain/functions/isTevmBlockTag.md index 6c8ef1b78a..72f76fb337 100644 --- a/docs/src/content/docs/reference/@tevm/blockchain/functions/isTevmBlockTag.md +++ b/docs/src/content/docs/reference/@tevm/blockchain/functions/isTevmBlockTag.md @@ -21,4 +21,4 @@ true if valid block tag ## Defined in -[utils/isTevmBlockTag.js:17](https://github.com/evmts/tevm-monorepo/blob/main/packages/blockchain/src/utils/isTevmBlockTag.js#L17) +[packages/blockchain/src/utils/isTevmBlockTag.js:17](https://github.com/evmts/tevm-monorepo/blob/main/packages/blockchain/src/utils/isTevmBlockTag.js#L17) diff --git a/docs/src/content/docs/reference/@tevm/blockchain/functions/putBlock.md b/docs/src/content/docs/reference/@tevm/blockchain/functions/putBlock.md index 11efe064cc..bb5a832e51 100644 --- a/docs/src/content/docs/reference/@tevm/blockchain/functions/putBlock.md +++ b/docs/src/content/docs/reference/@tevm/blockchain/functions/putBlock.md @@ -29,4 +29,4 @@ The block to be added to the blockchain. ## Defined in -[actions/putBlock.js:7](https://github.com/evmts/tevm-monorepo/blob/main/packages/blockchain/src/actions/putBlock.js#L7) +[packages/blockchain/src/actions/putBlock.js:7](https://github.com/evmts/tevm-monorepo/blob/main/packages/blockchain/src/actions/putBlock.js#L7) diff --git a/docs/src/content/docs/reference/@tevm/blockchain/functions/setIteratorHead.md b/docs/src/content/docs/reference/@tevm/blockchain/functions/setIteratorHead.md index 4d823856b1..53ad0c746b 100644 --- a/docs/src/content/docs/reference/@tevm/blockchain/functions/setIteratorHead.md +++ b/docs/src/content/docs/reference/@tevm/blockchain/functions/setIteratorHead.md @@ -34,4 +34,4 @@ The head hash to save ## Defined in -[actions/setIteratorHead.js:7](https://github.com/evmts/tevm-monorepo/blob/main/packages/blockchain/src/actions/setIteratorHead.js#L7) +[packages/blockchain/src/actions/setIteratorHead.js:7](https://github.com/evmts/tevm-monorepo/blob/main/packages/blockchain/src/actions/setIteratorHead.js#L7) diff --git a/docs/src/content/docs/reference/@tevm/blockchain/functions/shallowCopy.md b/docs/src/content/docs/reference/@tevm/blockchain/functions/shallowCopy.md index 58940f6dbf..57c3e06175 100644 --- a/docs/src/content/docs/reference/@tevm/blockchain/functions/shallowCopy.md +++ b/docs/src/content/docs/reference/@tevm/blockchain/functions/shallowCopy.md @@ -21,4 +21,4 @@ title: "shallowCopy" ## Defined in -[actions/shallowCopy.js:7](https://github.com/evmts/tevm-monorepo/blob/main/packages/blockchain/src/actions/shallowCopy.js#L7) +[packages/blockchain/src/actions/shallowCopy.js:7](https://github.com/evmts/tevm-monorepo/blob/main/packages/blockchain/src/actions/shallowCopy.js#L7) diff --git a/docs/src/content/docs/reference/@tevm/blockchain/functions/validateHeader.md b/docs/src/content/docs/reference/@tevm/blockchain/functions/validateHeader.md index 3c1f4f5adb..ddf62ba487 100644 --- a/docs/src/content/docs/reference/@tevm/blockchain/functions/validateHeader.md +++ b/docs/src/content/docs/reference/@tevm/blockchain/functions/validateHeader.md @@ -33,4 +33,4 @@ If this is an uncle header, this is the height of the block that is including it ## Defined in -[actions/validateHeader.js:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/blockchain/src/actions/validateHeader.js#L8) +[packages/blockchain/src/actions/validateHeader.js:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/blockchain/src/actions/validateHeader.js#L8) diff --git a/docs/src/content/docs/reference/@tevm/blockchain/type-aliases/Chain.md b/docs/src/content/docs/reference/@tevm/blockchain/type-aliases/Chain.md index e2442512bc..24b839d5eb 100644 --- a/docs/src/content/docs/reference/@tevm/blockchain/type-aliases/Chain.md +++ b/docs/src/content/docs/reference/@tevm/blockchain/type-aliases/Chain.md @@ -208,4 +208,4 @@ If this is an uncle header, this is the height of the block that is including it ## Defined in -[Chain.ts:16](https://github.com/evmts/tevm-monorepo/blob/main/packages/blockchain/src/Chain.ts#L16) +[packages/blockchain/src/Chain.ts:16](https://github.com/evmts/tevm-monorepo/blob/main/packages/blockchain/src/Chain.ts#L16) diff --git a/docs/src/content/docs/reference/@tevm/blockchain/type-aliases/ChainOptions.md b/docs/src/content/docs/reference/@tevm/blockchain/type-aliases/ChainOptions.md index 9358086e33..77b3fb6c6c 100644 --- a/docs/src/content/docs/reference/@tevm/blockchain/type-aliases/ChainOptions.md +++ b/docs/src/content/docs/reference/@tevm/blockchain/type-aliases/ChainOptions.md @@ -58,4 +58,4 @@ Logging level of blockchain package. Defaults to `warn` ## Defined in -[ChainOptions.ts:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/blockchain/src/ChainOptions.ts#L9) +[packages/blockchain/src/ChainOptions.ts:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/blockchain/src/ChainOptions.ts#L9) diff --git a/docs/src/content/docs/reference/@tevm/common/functions/createCommon.md b/docs/src/content/docs/reference/@tevm/common/functions/createCommon.md index dec52252e1..092c3a817d 100644 --- a/docs/src/content/docs/reference/@tevm/common/functions/createCommon.md +++ b/docs/src/content/docs/reference/@tevm/common/functions/createCommon.md @@ -5,7 +5,7 @@ prev: false title: "createCommon" --- -> **createCommon**(`options`): [`Common`](/reference/tevm/common/type-aliases/common/) +> **createCommon**(`options`): `object` ## Parameters @@ -13,7 +13,119 @@ title: "createCommon" ## Returns -[`Common`](/reference/tevm/common/type-aliases/common/) +`object` + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **blockExplorers.default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **contracts.ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **contracts.ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **contracts.multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **rpcUrls.default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks ## Defined in diff --git a/docs/src/content/docs/reference/@tevm/common/globals.md b/docs/src/content/docs/reference/@tevm/common/globals.md index 31f0937bd4..ef6c4fc9cd 100644 --- a/docs/src/content/docs/reference/@tevm/common/globals.md +++ b/docs/src/content/docs/reference/@tevm/common/globals.md @@ -28,23 +28,340 @@ title: "@tevm/common" ## Variables +- [abstractTestnet](/reference/tevm/common/variables/abstracttestnet/) +- [acala](/reference/tevm/common/variables/acala/) +- [ancient8](/reference/tevm/common/variables/ancient8/) +- [ancient8Sepolia](/reference/tevm/common/variables/ancient8sepolia/) +- [anvil](/reference/tevm/common/variables/anvil/) +- [apexTestnet](/reference/tevm/common/variables/apextestnet/) - [arbitrum](/reference/tevm/common/variables/arbitrum/) +- [arbitrumGoerli](/reference/tevm/common/variables/arbitrumgoerli/) +- [arbitrumNova](/reference/tevm/common/variables/arbitrumnova/) +- [arbitrumSepolia](/reference/tevm/common/variables/arbitrumsepolia/) +- [areonNetwork](/reference/tevm/common/variables/areonnetwork/) +- [areonNetworkTestnet](/reference/tevm/common/variables/areonnetworktestnet/) +- [artelaTestnet](/reference/tevm/common/variables/artelatestnet/) +- [assetChainTestnet](/reference/tevm/common/variables/assetchaintestnet/) +- [astar](/reference/tevm/common/variables/astar/) +- [astarZkEVM](/reference/tevm/common/variables/astarzkevm/) +- [astarZkyoto](/reference/tevm/common/variables/astarzkyoto/) +- [atletaOlympia](/reference/tevm/common/variables/atletaolympia/) +- [aurora](/reference/tevm/common/variables/aurora/) +- [auroraTestnet](/reference/tevm/common/variables/auroratestnet/) +- [auroria](/reference/tevm/common/variables/auroria/) - [avalanche](/reference/tevm/common/variables/avalanche/) +- [avalancheFuji](/reference/tevm/common/variables/avalanchefuji/) +- [b3](/reference/tevm/common/variables/b3/) +- [b3Sepolia](/reference/tevm/common/variables/b3sepolia/) +- [bahamut](/reference/tevm/common/variables/bahamut/) - [base](/reference/tevm/common/variables/base/) +- [baseGoerli](/reference/tevm/common/variables/basegoerli/) - [baseSepolia](/reference/tevm/common/variables/basesepolia/) +- [beam](/reference/tevm/common/variables/beam/) +- [beamTestnet](/reference/tevm/common/variables/beamtestnet/) +- [bearNetworkChainMainnet](/reference/tevm/common/variables/bearnetworkchainmainnet/) +- [bearNetworkChainTestnet](/reference/tevm/common/variables/bearnetworkchaintestnet/) +- [berachainTestnet](/reference/tevm/common/variables/berachaintestnet/) +- [berachainTestnetbArtio](/reference/tevm/common/variables/berachaintestnetbartio/) +- [bevmMainnet](/reference/tevm/common/variables/bevmmainnet/) +- [bitTorrent](/reference/tevm/common/variables/bittorrent/) +- [bitTorrentTestnet](/reference/tevm/common/variables/bittorrenttestnet/) +- [bitkub](/reference/tevm/common/variables/bitkub/) +- [bitkubTestnet](/reference/tevm/common/variables/bitkubtestnet/) - [blast](/reference/tevm/common/variables/blast/) +- [blastSepolia](/reference/tevm/common/variables/blastsepolia/) +- [bob](/reference/tevm/common/variables/bob/) +- [bobSepolia](/reference/tevm/common/variables/bobsepolia/) +- [boba](/reference/tevm/common/variables/boba/) +- [bobaSepolia](/reference/tevm/common/variables/bobasepolia/) +- [botanixTestnet](/reference/tevm/common/variables/botanixtestnet/) +- [bronos](/reference/tevm/common/variables/bronos/) +- [bronosTestnet](/reference/tevm/common/variables/bronostestnet/) +- [bsc](/reference/tevm/common/variables/bsc/) +- [bscGreenfield](/reference/tevm/common/variables/bscgreenfield/) +- [bscTestnet](/reference/tevm/common/variables/bsctestnet/) +- [btr](/reference/tevm/common/variables/btr/) +- [btrTestnet](/reference/tevm/common/variables/btrtestnet/) +- [bxn](/reference/tevm/common/variables/bxn/) +- [bxnTestnet](/reference/tevm/common/variables/bxntestnet/) +- [canto](/reference/tevm/common/variables/canto/) +- [celo](/reference/tevm/common/variables/celo/) +- [celoAlfajores](/reference/tevm/common/variables/celoalfajores/) +- [chiliz](/reference/tevm/common/variables/chiliz/) +- [chips](/reference/tevm/common/variables/chips/) +- [classic](/reference/tevm/common/variables/classic/) +- [confluxESpace](/reference/tevm/common/variables/confluxespace/) +- [confluxESpaceTestnet](/reference/tevm/common/variables/confluxespacetestnet/) +- [coreDao](/reference/tevm/common/variables/coredao/) +- [crab](/reference/tevm/common/variables/crab/) +- [cronos](/reference/tevm/common/variables/cronos/) +- [cronosTestnet](/reference/tevm/common/variables/cronostestnet/) +- [cronoszkEVM](/reference/tevm/common/variables/cronoszkevm/) +- [cronoszkEVMTestnet](/reference/tevm/common/variables/cronoszkevmtestnet/) +- [crossbell](/reference/tevm/common/variables/crossbell/) +- [curtis](/reference/tevm/common/variables/curtis/) +- [cyber](/reference/tevm/common/variables/cyber/) +- [cyberTestnet](/reference/tevm/common/variables/cybertestnet/) +- [darwinia](/reference/tevm/common/variables/darwinia/) +- [dchain](/reference/tevm/common/variables/dchain/) +- [dchainTestnet](/reference/tevm/common/variables/dchaintestnet/) +- [defichainEvm](/reference/tevm/common/variables/defichainevm/) +- [defichainEvmTestnet](/reference/tevm/common/variables/defichainevmtestnet/) +- [degen](/reference/tevm/common/variables/degen/) +- [dfk](/reference/tevm/common/variables/dfk/) +- [dodochainTestnet](/reference/tevm/common/variables/dodochaintestnet/) +- [dogechain](/reference/tevm/common/variables/dogechain/) +- [dreyerxMainnet](/reference/tevm/common/variables/dreyerxmainnet/) +- [dreyerxTestnet](/reference/tevm/common/variables/dreyerxtestnet/) +- [edgeless](/reference/tevm/common/variables/edgeless/) +- [edgelessTestnet](/reference/tevm/common/variables/edgelesstestnet/) +- [edgeware](/reference/tevm/common/variables/edgeware/) +- [edgewareTestnet](/reference/tevm/common/variables/edgewaretestnet/) +- [ekta](/reference/tevm/common/variables/ekta/) +- [ektaTestnet](/reference/tevm/common/variables/ektatestnet/) +- [eon](/reference/tevm/common/variables/eon/) +- [eos](/reference/tevm/common/variables/eos/) +- [eosTestnet](/reference/tevm/common/variables/eostestnet/) +- [etherlink](/reference/tevm/common/variables/etherlink/) +- [etherlinkTestnet](/reference/tevm/common/variables/etherlinktestnet/) +- [evmos](/reference/tevm/common/variables/evmos/) +- [evmosTestnet](/reference/tevm/common/variables/evmostestnet/) +- [fantom](/reference/tevm/common/variables/fantom/) +- [fantomSonicTestnet](/reference/tevm/common/variables/fantomsonictestnet/) +- [fantomTestnet](/reference/tevm/common/variables/fantomtestnet/) +- [fibo](/reference/tevm/common/variables/fibo/) +- [filecoin](/reference/tevm/common/variables/filecoin/) +- [filecoinCalibration](/reference/tevm/common/variables/filecoincalibration/) +- [filecoinHyperspace](/reference/tevm/common/variables/filecoinhyperspace/) +- [flare](/reference/tevm/common/variables/flare/) +- [flareTestnet](/reference/tevm/common/variables/flaretestnet/) +- [flowMainnet](/reference/tevm/common/variables/flowmainnet/) +- [flowPreviewnet](/reference/tevm/common/variables/flowpreviewnet/) +- [flowTestnet](/reference/tevm/common/variables/flowtestnet/) +- [fluence](/reference/tevm/common/variables/fluence/) +- [fluenceStage](/reference/tevm/common/variables/fluencestage/) +- [fluenceTestnet](/reference/tevm/common/variables/fluencetestnet/) +- [forma](/reference/tevm/common/variables/forma/) +- [foundry](/reference/tevm/common/variables/foundry/) +- [fraxtal](/reference/tevm/common/variables/fraxtal/) +- [fraxtalTestnet](/reference/tevm/common/variables/fraxtaltestnet/) +- [funkiMainnet](/reference/tevm/common/variables/funkimainnet/) +- [funkiSepolia](/reference/tevm/common/variables/funkisepolia/) +- [fuse](/reference/tevm/common/variables/fuse/) +- [fuseSparknet](/reference/tevm/common/variables/fusesparknet/) +- [gnosis](/reference/tevm/common/variables/gnosis/) +- [gnosisChiado](/reference/tevm/common/variables/gnosischiado/) +- [gobi](/reference/tevm/common/variables/gobi/) +- [goerli](/reference/tevm/common/variables/goerli/) +- [gravity](/reference/tevm/common/variables/gravity/) +- [ham](/reference/tevm/common/variables/ham/) +- [haqqMainnet](/reference/tevm/common/variables/haqqmainnet/) +- [haqqTestedge2](/reference/tevm/common/variables/haqqtestedge2/) +- [hardhat](/reference/tevm/common/variables/hardhat/) +- [harmonyOne](/reference/tevm/common/variables/harmonyone/) +- [hashkeyTestnet](/reference/tevm/common/variables/hashkeytestnet/) +- [hedera](/reference/tevm/common/variables/hedera/) +- [hederaPreviewnet](/reference/tevm/common/variables/hederapreviewnet/) +- [hederaTestnet](/reference/tevm/common/variables/hederatestnet/) +- [holesky](/reference/tevm/common/variables/holesky/) +- [immutableZkEvm](/reference/tevm/common/variables/immutablezkevm/) +- [immutableZkEvmTestnet](/reference/tevm/common/variables/immutablezkevmtestnet/) +- [inEVM](/reference/tevm/common/variables/inevm/) +- [iota](/reference/tevm/common/variables/iota/) +- [iotaTestnet](/reference/tevm/common/variables/iotatestnet/) +- [iotex](/reference/tevm/common/variables/iotex/) +- [iotexTestnet](/reference/tevm/common/variables/iotextestnet/) +- [jbc](/reference/tevm/common/variables/jbc/) +- [jbcTestnet](/reference/tevm/common/variables/jbctestnet/) +- [kaia](/reference/tevm/common/variables/kaia/) +- [kairos](/reference/tevm/common/variables/kairos/) +- [kakarotSepolia](/reference/tevm/common/variables/kakarotsepolia/) +- [karura](/reference/tevm/common/variables/karura/) +- [kava](/reference/tevm/common/variables/kava/) +- [kavaTestnet](/reference/tevm/common/variables/kavatestnet/) +- [kcc](/reference/tevm/common/variables/kcc/) +- [klaytn](/reference/tevm/common/variables/klaytn/) +- [klaytnBaobab](/reference/tevm/common/variables/klaytnbaobab/) +- [koi](/reference/tevm/common/variables/koi/) +- [kroma](/reference/tevm/common/variables/kroma/) +- [kromaSepolia](/reference/tevm/common/variables/kromasepolia/) +- [l3x](/reference/tevm/common/variables/l3x/) +- [l3xTestnet](/reference/tevm/common/variables/l3xtestnet/) +- [lightlinkPegasus](/reference/tevm/common/variables/lightlinkpegasus/) +- [lightlinkPhoenix](/reference/tevm/common/variables/lightlinkphoenix/) +- [linea](/reference/tevm/common/variables/linea/) +- [lineaGoerli](/reference/tevm/common/variables/lineagoerli/) +- [lineaSepolia](/reference/tevm/common/variables/lineasepolia/) +- [lineaTestnet](/reference/tevm/common/variables/lineatestnet/) +- [lisk](/reference/tevm/common/variables/lisk/) +- [liskSepolia](/reference/tevm/common/variables/lisksepolia/) +- [localhost](/reference/tevm/common/variables/localhost/) +- [lukso](/reference/tevm/common/variables/lukso/) +- [luksoTestnet](/reference/tevm/common/variables/luksotestnet/) +- [lycan](/reference/tevm/common/variables/lycan/) +- [lyra](/reference/tevm/common/variables/lyra/) - [mainnet](/reference/tevm/common/variables/mainnet/) +- [mandala](/reference/tevm/common/variables/mandala/) - [manta](/reference/tevm/common/variables/manta/) +- [mantaSepoliaTestnet](/reference/tevm/common/variables/mantasepoliatestnet/) +- [mantaTestnet](/reference/tevm/common/variables/mantatestnet/) - [mantle](/reference/tevm/common/variables/mantle/) +- [mantleSepoliaTestnet](/reference/tevm/common/variables/mantlesepoliatestnet/) +- [mantleTestnet](/reference/tevm/common/variables/mantletestnet/) +- [merlin](/reference/tevm/common/variables/merlin/) +- [metachain](/reference/tevm/common/variables/metachain/) +- [metachainIstanbul](/reference/tevm/common/variables/metachainistanbul/) +- [metalL2](/reference/tevm/common/variables/metall2/) +- [meter](/reference/tevm/common/variables/meter/) +- [meterTestnet](/reference/tevm/common/variables/metertestnet/) +- [metis](/reference/tevm/common/variables/metis/) +- [metisGoerli](/reference/tevm/common/variables/metisgoerli/) +- [mev](/reference/tevm/common/variables/mev/) +- [mevTestnet](/reference/tevm/common/variables/mevtestnet/) +- [mintSepoliaTestnet](/reference/tevm/common/variables/mintsepoliatestnet/) +- [mode](/reference/tevm/common/variables/mode/) +- [modeTestnet](/reference/tevm/common/variables/modetestnet/) +- [moonbaseAlpha](/reference/tevm/common/variables/moonbasealpha/) +- [moonbeam](/reference/tevm/common/variables/moonbeam/) +- [moonbeamDev](/reference/tevm/common/variables/moonbeamdev/) +- [moonriver](/reference/tevm/common/variables/moonriver/) +- [morphHolesky](/reference/tevm/common/variables/morphholesky/) +- [morphSepolia](/reference/tevm/common/variables/morphsepolia/) +- [nautilus](/reference/tevm/common/variables/nautilus/) +- [neonDevnet](/reference/tevm/common/variables/neondevnet/) +- [neonMainnet](/reference/tevm/common/variables/neonmainnet/) +- [nexi](/reference/tevm/common/variables/nexi/) +- [nexilix](/reference/tevm/common/variables/nexilix/) +- [oasisTestnet](/reference/tevm/common/variables/oasistestnet/) +- [oasys](/reference/tevm/common/variables/oasys/) +- [okc](/reference/tevm/common/variables/okc/) +- [oortMainnetDev](/reference/tevm/common/variables/oortmainnetdev/) +- [opBNB](/reference/tevm/common/variables/opbnb/) +- [opBNBTestnet](/reference/tevm/common/variables/opbnbtestnet/) - [optimism](/reference/tevm/common/variables/optimism/) +- [optimismGoerli](/reference/tevm/common/variables/optimismgoerli/) - [optimismSepolia](/reference/tevm/common/variables/optimismsepolia/) +- [otimDevnet](/reference/tevm/common/variables/otimdevnet/) +- [palm](/reference/tevm/common/variables/palm/) +- [palmTestnet](/reference/tevm/common/variables/palmtestnet/) +- [pgn](/reference/tevm/common/variables/pgn/) +- [pgnTestnet](/reference/tevm/common/variables/pgntestnet/) +- [phoenix](/reference/tevm/common/variables/phoenix/) +- [playfiAlbireo](/reference/tevm/common/variables/playfialbireo/) +- [plinga](/reference/tevm/common/variables/plinga/) +- [plumeTestnet](/reference/tevm/common/variables/plumetestnet/) - [polygon](/reference/tevm/common/variables/polygon/) +- [polygonAmoy](/reference/tevm/common/variables/polygonamoy/) +- [polygonMumbai](/reference/tevm/common/variables/polygonmumbai/) +- [polygonZkEvm](/reference/tevm/common/variables/polygonzkevm/) +- [polygonZkEvmCardona](/reference/tevm/common/variables/polygonzkevmcardona/) +- [polygonZkEvmTestnet](/reference/tevm/common/variables/polygonzkevmtestnet/) +- [pulsechain](/reference/tevm/common/variables/pulsechain/) +- [pulsechainV4](/reference/tevm/common/variables/pulsechainv4/) +- [qMainnet](/reference/tevm/common/variables/qmainnet/) +- [qTestnet](/reference/tevm/common/variables/qtestnet/) +- [real](/reference/tevm/common/variables/real/) +- [redbellyTestnet](/reference/tevm/common/variables/redbellytestnet/) - [redstone](/reference/tevm/common/variables/redstone/) +- [reyaNetwork](/reference/tevm/common/variables/reyanetwork/) +- [rollux](/reference/tevm/common/variables/rollux/) +- [rolluxTestnet](/reference/tevm/common/variables/rolluxtestnet/) +- [ronin](/reference/tevm/common/variables/ronin/) +- [root](/reference/tevm/common/variables/root/) +- [rootPorcini](/reference/tevm/common/variables/rootporcini/) +- [rootstock](/reference/tevm/common/variables/rootstock/) +- [rootstockTestnet](/reference/tevm/common/variables/rootstocktestnet/) +- [rss3](/reference/tevm/common/variables/rss3/) +- [rss3Sepolia](/reference/tevm/common/variables/rss3sepolia/) +- [saigon](/reference/tevm/common/variables/saigon/) +- [sapphire](/reference/tevm/common/variables/sapphire/) +- [sapphireTestnet](/reference/tevm/common/variables/sapphiretestnet/) +- [satoshiVM](/reference/tevm/common/variables/satoshivm/) +- [satoshiVMTestnet](/reference/tevm/common/variables/satoshivmtestnet/) - [scroll](/reference/tevm/common/variables/scroll/) +- [scrollSepolia](/reference/tevm/common/variables/scrollsepolia/) +- [sei](/reference/tevm/common/variables/sei/) +- [seiDevnet](/reference/tevm/common/variables/seidevnet/) +- [seiTestnet](/reference/tevm/common/variables/seitestnet/) - [sepolia](/reference/tevm/common/variables/sepolia/) +- [shapeSepolia](/reference/tevm/common/variables/shapesepolia/) +- [shardeumSphinx](/reference/tevm/common/variables/shardeumsphinx/) +- [shibarium](/reference/tevm/common/variables/shibarium/) +- [shibariumTestnet](/reference/tevm/common/variables/shibariumtestnet/) +- [shimmer](/reference/tevm/common/variables/shimmer/) +- [shimmerTestnet](/reference/tevm/common/variables/shimmertestnet/) +- [skaleBlockBrawlers](/reference/tevm/common/variables/skaleblockbrawlers/) +- [skaleCalypso](/reference/tevm/common/variables/skalecalypso/) +- [skaleCalypsoTestnet](/reference/tevm/common/variables/skalecalypsotestnet/) +- [skaleCryptoBlades](/reference/tevm/common/variables/skalecryptoblades/) +- [skaleCryptoColosseum](/reference/tevm/common/variables/skalecryptocolosseum/) +- [skaleEuropa](/reference/tevm/common/variables/skaleeuropa/) +- [skaleEuropaTestnet](/reference/tevm/common/variables/skaleeuropatestnet/) +- [skaleExorde](/reference/tevm/common/variables/skaleexorde/) +- [skaleHumanProtocol](/reference/tevm/common/variables/skalehumanprotocol/) +- [skaleNebula](/reference/tevm/common/variables/skalenebula/) +- [skaleNebulaTestnet](/reference/tevm/common/variables/skalenebulatestnet/) +- [skaleRazor](/reference/tevm/common/variables/skalerazor/) +- [skaleTitan](/reference/tevm/common/variables/skaletitan/) +- [skaleTitanTestnet](/reference/tevm/common/variables/skaletitantestnet/) +- [sketchpad](/reference/tevm/common/variables/sketchpad/) +- [soneiumMinato](/reference/tevm/common/variables/soneiumminato/) +- [songbird](/reference/tevm/common/variables/songbird/) +- [songbirdTestnet](/reference/tevm/common/variables/songbirdtestnet/) +- [sophonTestnet](/reference/tevm/common/variables/sophontestnet/) +- [spicy](/reference/tevm/common/variables/spicy/) +- [storyTestnet](/reference/tevm/common/variables/storytestnet/) +- [stratis](/reference/tevm/common/variables/stratis/) +- [syscoin](/reference/tevm/common/variables/syscoin/) +- [syscoinTestnet](/reference/tevm/common/variables/syscointestnet/) +- [taiko](/reference/tevm/common/variables/taiko/) +- [taikoHekla](/reference/tevm/common/variables/taikohekla/) +- [taikoJolnir](/reference/tevm/common/variables/taikojolnir/) +- [taikoKatla](/reference/tevm/common/variables/taikokatla/) +- [taikoTestnetSepolia](/reference/tevm/common/variables/taikotestnetsepolia/) +- [taraxa](/reference/tevm/common/variables/taraxa/) +- [taraxaTestnet](/reference/tevm/common/variables/taraxatestnet/) +- [telcoinTestnet](/reference/tevm/common/variables/telcointestnet/) +- [telos](/reference/tevm/common/variables/telos/) +- [telosTestnet](/reference/tevm/common/variables/telostestnet/) +- [tenet](/reference/tevm/common/variables/tenet/) - [tevmDefault](/reference/tevm/common/variables/tevmdefault/) +- [thaiChain](/reference/tevm/common/variables/thaichain/) +- [thunderTestnet](/reference/tevm/common/variables/thundertestnet/) +- [tron](/reference/tevm/common/variables/tron/) +- [unreal](/reference/tevm/common/variables/unreal/) +- [vechain](/reference/tevm/common/variables/vechain/) +- [wanchain](/reference/tevm/common/variables/wanchain/) +- [wanchainTestnet](/reference/tevm/common/variables/wanchaintestnet/) +- [wemix](/reference/tevm/common/variables/wemix/) +- [wemixTestnet](/reference/tevm/common/variables/wemixtestnet/) +- [x1Testnet](/reference/tevm/common/variables/x1testnet/) +- [xLayer](/reference/tevm/common/variables/xlayer/) +- [xLayerTestnet](/reference/tevm/common/variables/xlayertestnet/) +- [xai](/reference/tevm/common/variables/xai/) +- [xaiTestnet](/reference/tevm/common/variables/xaitestnet/) +- [xdc](/reference/tevm/common/variables/xdc/) +- [xdcTestnet](/reference/tevm/common/variables/xdctestnet/) +- [xrSepolia](/reference/tevm/common/variables/xrsepolia/) +- [yooldoVerse](/reference/tevm/common/variables/yooldoverse/) +- [yooldoVerseTestnet](/reference/tevm/common/variables/yooldoversetestnet/) +- [zetachain](/reference/tevm/common/variables/zetachain/) +- [zetachainAthensTestnet](/reference/tevm/common/variables/zetachainathenstestnet/) +- [zhejiang](/reference/tevm/common/variables/zhejiang/) +- [zilliqa](/reference/tevm/common/variables/zilliqa/) +- [zilliqaTestnet](/reference/tevm/common/variables/zilliqatestnet/) +- [zircuitTestnet](/reference/tevm/common/variables/zircuittestnet/) +- [zkFair](/reference/tevm/common/variables/zkfair/) +- [zkFairTestnet](/reference/tevm/common/variables/zkfairtestnet/) +- [zkLinkNova](/reference/tevm/common/variables/zklinknova/) +- [zkLinkNovaSepoliaTestnet](/reference/tevm/common/variables/zklinknovasepoliatestnet/) +- [zksync](/reference/tevm/common/variables/zksync/) +- [zksyncInMemoryNode](/reference/tevm/common/variables/zksyncinmemorynode/) +- [zksyncLocalNode](/reference/tevm/common/variables/zksynclocalnode/) +- [zksyncSepoliaTestnet](/reference/tevm/common/variables/zksyncsepoliatestnet/) - [zora](/reference/tevm/common/variables/zora/) - [zoraSepolia](/reference/tevm/common/variables/zorasepolia/) +- [zoraTestnet](/reference/tevm/common/variables/zoratestnet/) ## Functions diff --git a/docs/src/content/docs/reference/@tevm/common/type-aliases/Common.md b/docs/src/content/docs/reference/@tevm/common/type-aliases/Common.md index 37c92dd05a..8084d645ce 100644 --- a/docs/src/content/docs/reference/@tevm/common/type-aliases/Common.md +++ b/docs/src/content/docs/reference/@tevm/common/type-aliases/Common.md @@ -5,7 +5,7 @@ prev: false title: "Common" --- -> **Common**: `ViemChain` & `object` +> **Common**: `Prettify`\<`ViemChain` & `object`\> Common is the main representation of chain specific configuration for tevm clients. @@ -34,20 +34,6 @@ const client = createClient(optimism) - [createCommon](https://tevm.sh/reference/tevm/common/functions/createcommon/) - [Tevm client docs](https://tevm.sh/learn/clients/) -## Type declaration - -### copy() - -> **copy**: () => [`Common`](/reference/tevm/common/type-aliases/common/) - -#### Returns - -[`Common`](/reference/tevm/common/type-aliases/common/) - -### ethjsCommon - -> **ethjsCommon**: `EthjsCommon` - ## Defined in [packages/common/src/Common.ts:27](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/Common.ts#L27) diff --git a/docs/src/content/docs/reference/@tevm/common/type-aliases/CommonOptions.md b/docs/src/content/docs/reference/@tevm/common/type-aliases/CommonOptions.md index a897615441..c3a8c7b668 100644 --- a/docs/src/content/docs/reference/@tevm/common/type-aliases/CommonOptions.md +++ b/docs/src/content/docs/reference/@tevm/common/type-aliases/CommonOptions.md @@ -5,11 +5,9 @@ prev: false title: "CommonOptions" --- -> **CommonOptions**: `object` & `ViemChain` +> **CommonOptions**: `ViemChain` & `object` -Options for creating an Tevm MemoryClient instance - -## Example +## Examples ```typescript import { mainnet, createCommon, type CommonOptions } from 'tevm/common' @@ -20,8 +18,23 @@ const opts: CommonOptions = { } const common = createCommon(opts) -```` -@see [createCommon](https://tevm.sh/reference/tevm/common/functions/createcommon/) +``` + +You can also create a Common instance from viem chains: + +```typescript +import { mainnet } from 'viem/chains' +import { createCommon } from 'tevm/common' + +const common = createCommon({ + ...mainnet, + hardfork: 'cancun', +}) +``` + +## See + +[createCommon](https://tevm.sh/reference/tevm/common/functions/createcommon/) ## Type declaration @@ -59,18 +72,36 @@ const common = createCommon({ Eips to enable. Defaults to `[1559, 4895]` -### hardfork +#### Default + +```ts +[1559, 4895] +``` -> **hardfork**: [`Hardfork`](/reference/tevm/common/type-aliases/hardfork/) +### hardfork? + +> `optional` **hardfork**: [`Hardfork`](/reference/tevm/common/type-aliases/hardfork/) Hardfork to use. Defaults to `shanghai` -### loggingLevel +#### Default + +```ts +'cancun' +``` + +### loggingLevel? + +> `optional` **loggingLevel**: `LogOptions`\[`"level"`\] -> **loggingLevel**: `LogOptions`\[`"level"`\] +Logging level of the Tevm logger instance -Tevm logger instance +#### Default + +```ts +'warn' +``` ## Defined in -[packages/common/src/CommonOptions.ts:21](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/CommonOptions.ts#L21) +[packages/common/src/CommonOptions.ts:38](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/CommonOptions.ts#L38) diff --git a/docs/src/content/docs/reference/@tevm/common/type-aliases/Hardfork.md b/docs/src/content/docs/reference/@tevm/common/type-aliases/Hardfork.md index b8da236ad6..50740c1232 100644 --- a/docs/src/content/docs/reference/@tevm/common/type-aliases/Hardfork.md +++ b/docs/src/content/docs/reference/@tevm/common/type-aliases/Hardfork.md @@ -5,14 +5,14 @@ prev: false title: "Hardfork" --- -> **Hardfork**: `"chainstart"` \| `"homestead"` \| `"dao"` \| `"tangerineWhistle"` \| `"spuriousDragon"` \| `"byzantium"` \| `"constantinople"` \| `"petersburg"` \| `"istanbul"` \| `"muirGlacier"` \| `"berlin"` \| `"london"` \| `"arrowGlacier"` \| `"grayGlacier"` \| `"mergeForkIdTransition"` \| `"paris"` \| `"shanghai"` \| `"cancun"` +> **Hardfork**: `"chainstart"` \| `"homestead"` \| `"dao"` \| `"tangerineWhistle"` \| `"spuriousDragon"` \| `"byzantium"` \| `"constantinople"` \| `"petersburg"` \| `"istanbul"` \| `"muirGlacier"` \| `"berlin"` \| `"london"` \| `"arrowGlacier"` \| `"grayGlacier"` \| `"mergeForkIdTransition"` \| `"paris"` \| `"shanghai"` \| `"cancun"` \| `"prague"` \| `"osaka"` Ethereum hardfork options. Default option is currently cancun. If you use older hardforks you might run into issues with EIPs not being supported. ## Example -```typesxcript +```typescript import { createCommon, mainnet } from 'tevm/common'` const hardfork: Hardfork = 'shanghai' diff --git a/docs/src/content/docs/reference/@tevm/common/type-aliases/MockKzg.md b/docs/src/content/docs/reference/@tevm/common/type-aliases/MockKzg.md index 1c68a47a6c..5e27f119d9 100644 --- a/docs/src/content/docs/reference/@tevm/common/type-aliases/MockKzg.md +++ b/docs/src/content/docs/reference/@tevm/common/type-aliases/MockKzg.md @@ -131,4 +131,4 @@ const common = createCommon({ ## Defined in -[packages/common/src/MockKzg.ts:21](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/MockKzg.ts#L21) +[packages/common/src/MockKzg.ts:24](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/MockKzg.ts#L24) diff --git a/docs/src/content/docs/reference/@tevm/common/variables/arbitrum.md b/docs/src/content/docs/reference/@tevm/common/variables/arbitrum.md index d570bcb974..0f3a72ba73 100644 --- a/docs/src/content/docs/reference/@tevm/common/variables/arbitrum.md +++ b/docs/src/content/docs/reference/@tevm/common/variables/arbitrum.md @@ -5,8 +5,146 @@ prev: false title: "arbitrum" --- -> `const` **arbitrum**: [`Common`](/reference/tevm/common/type-aliases/common/) +> `const` **arbitrum**: `object` + +Creates a common configuration for the arbitrum chain. + +## Description + +Chain ID: 42161 +Chain Name: Arbitrum One +Default Block Explorer: https://arbiscan.io +Default RPC URL: https://arb1.arbitrum.io/rpc + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { arbitrum } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: arbitrum, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **blockExplorers.default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **contracts.ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **contracts.ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **contracts.multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **rpcUrls.default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks ## Defined in -[packages/common/src/presets/arbitrum.js:4](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/arbitrum.js#L4) +[packages/common/src/presets/arbitrum.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/arbitrum.js#L26) diff --git a/docs/src/content/docs/reference/@tevm/common/variables/avalanche.md b/docs/src/content/docs/reference/@tevm/common/variables/avalanche.md index 1ba8617e30..a6e36f935f 100644 --- a/docs/src/content/docs/reference/@tevm/common/variables/avalanche.md +++ b/docs/src/content/docs/reference/@tevm/common/variables/avalanche.md @@ -5,8 +5,146 @@ prev: false title: "avalanche" --- -> `const` **avalanche**: [`Common`](/reference/tevm/common/type-aliases/common/) +> `const` **avalanche**: `object` + +Creates a common configuration for the avalanche chain. + +## Description + +Chain ID: 43114 +Chain Name: Avalanche +Default Block Explorer: https://snowtrace.io +Default RPC URL: https://api.avax.network/ext/bc/C/rpc + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { avalanche } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: avalanche, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **blockExplorers.default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **contracts.ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **contracts.ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **contracts.multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **rpcUrls.default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks ## Defined in -[packages/common/src/presets/avalanche.js:4](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/avalanche.js#L4) +[packages/common/src/presets/avalanche.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/avalanche.js#L26) diff --git a/docs/src/content/docs/reference/@tevm/common/variables/base.md b/docs/src/content/docs/reference/@tevm/common/variables/base.md index ee9a43570d..369d72315a 100644 --- a/docs/src/content/docs/reference/@tevm/common/variables/base.md +++ b/docs/src/content/docs/reference/@tevm/common/variables/base.md @@ -5,8 +5,146 @@ prev: false title: "base" --- -> `const` **base**: [`Common`](/reference/tevm/common/type-aliases/common/) +> `const` **base**: `object` + +Creates a common configuration for the base chain. + +## Description + +Chain ID: 8453 +Chain Name: Base +Default Block Explorer: https://basescan.org +Default RPC URL: https://mainnet.base.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { base } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: base, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **blockExplorers.default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **contracts.ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **contracts.ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **contracts.multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **rpcUrls.default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks ## Defined in -[packages/common/src/presets/base.js:4](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/base.js#L4) +[packages/common/src/presets/base.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/base.js#L26) diff --git a/docs/src/content/docs/reference/@tevm/common/variables/baseSepolia.md b/docs/src/content/docs/reference/@tevm/common/variables/baseSepolia.md index ddaa508a7f..1be42cc96a 100644 --- a/docs/src/content/docs/reference/@tevm/common/variables/baseSepolia.md +++ b/docs/src/content/docs/reference/@tevm/common/variables/baseSepolia.md @@ -5,8 +5,146 @@ prev: false title: "baseSepolia" --- -> `const` **baseSepolia**: [`Common`](/reference/tevm/common/type-aliases/common/) +> `const` **baseSepolia**: `object` + +Creates a common configuration for the baseSepolia chain. + +## Description + +Chain ID: 84532 +Chain Name: Base Sepolia +Default Block Explorer: https://sepolia.basescan.org +Default RPC URL: https://sepolia.base.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { baseSepolia } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: baseSepolia, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **blockExplorers.default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **contracts.ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **contracts.ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **contracts.multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **rpcUrls.default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks ## Defined in -[packages/common/src/presets/baseSepolia.js:4](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/baseSepolia.js#L4) +[packages/common/src/presets/baseSepolia.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/baseSepolia.js#L26) diff --git a/docs/src/content/docs/reference/@tevm/common/variables/blast.md b/docs/src/content/docs/reference/@tevm/common/variables/blast.md index dfd65551bf..17a04ccc9e 100644 --- a/docs/src/content/docs/reference/@tevm/common/variables/blast.md +++ b/docs/src/content/docs/reference/@tevm/common/variables/blast.md @@ -5,8 +5,146 @@ prev: false title: "blast" --- -> `const` **blast**: [`Common`](/reference/tevm/common/type-aliases/common/) +> `const` **blast**: `object` + +Creates a common configuration for the blast chain. + +## Description + +Chain ID: 81457 +Chain Name: Blast +Default Block Explorer: https://blastscan.io +Default RPC URL: https://rpc.blast.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { blast } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: blast, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **blockExplorers.default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **contracts.ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **contracts.ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **contracts.multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **rpcUrls.default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks ## Defined in -[packages/common/src/presets/blast.js:4](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/blast.js#L4) +[packages/common/src/presets/blast.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/blast.js#L26) diff --git a/docs/src/content/docs/reference/@tevm/common/variables/mainnet.md b/docs/src/content/docs/reference/@tevm/common/variables/mainnet.md index b5c356b78d..e33eeb5c7b 100644 --- a/docs/src/content/docs/reference/@tevm/common/variables/mainnet.md +++ b/docs/src/content/docs/reference/@tevm/common/variables/mainnet.md @@ -5,8 +5,146 @@ prev: false title: "mainnet" --- -> `const` **mainnet**: [`Common`](/reference/tevm/common/type-aliases/common/) +> `const` **mainnet**: `object` + +Creates a common configuration for the mainnet chain. + +## Description + +Chain ID: 1 +Chain Name: Ethereum +Default Block Explorer: https://etherscan.io +Default RPC URL: https://cloudflare-eth.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { mainnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: mainnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **blockExplorers.default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **contracts.ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **contracts.ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **contracts.multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **rpcUrls.default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks ## Defined in -[packages/common/src/presets/mainnet.js:4](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/mainnet.js#L4) +[packages/common/src/presets/mainnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/mainnet.js#L26) diff --git a/docs/src/content/docs/reference/@tevm/common/variables/manta.md b/docs/src/content/docs/reference/@tevm/common/variables/manta.md index dd7dcd255a..69bc63d8c8 100644 --- a/docs/src/content/docs/reference/@tevm/common/variables/manta.md +++ b/docs/src/content/docs/reference/@tevm/common/variables/manta.md @@ -5,8 +5,146 @@ prev: false title: "manta" --- -> `const` **manta**: [`Common`](/reference/tevm/common/type-aliases/common/) +> `const` **manta**: `object` + +Creates a common configuration for the manta chain. + +## Description + +Chain ID: 169 +Chain Name: Manta Pacific Mainnet +Default Block Explorer: https://pacific-explorer.manta.network +Default RPC URL: https://pacific-rpc.manta.network/http + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { manta } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: manta, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **blockExplorers.default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **contracts.ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **contracts.ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **contracts.multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **rpcUrls.default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks ## Defined in -[packages/common/src/presets/manta.js:4](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/manta.js#L4) +[packages/common/src/presets/manta.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/manta.js#L26) diff --git a/docs/src/content/docs/reference/@tevm/common/variables/mantle.md b/docs/src/content/docs/reference/@tevm/common/variables/mantle.md index 8849386f18..e379338b74 100644 --- a/docs/src/content/docs/reference/@tevm/common/variables/mantle.md +++ b/docs/src/content/docs/reference/@tevm/common/variables/mantle.md @@ -5,8 +5,146 @@ prev: false title: "mantle" --- -> `const` **mantle**: [`Common`](/reference/tevm/common/type-aliases/common/) +> `const` **mantle**: `object` + +Creates a common configuration for the mantle chain. + +## Description + +Chain ID: 5000 +Chain Name: Mantle +Default Block Explorer: https://mantlescan.xyz/ +Default RPC URL: https://rpc.mantle.xyz + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { mantle } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: mantle, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **blockExplorers.default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **contracts.ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **contracts.ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **contracts.multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **rpcUrls.default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks ## Defined in -[packages/common/src/presets/mantle.js:4](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/mantle.js#L4) +[packages/common/src/presets/mantle.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/mantle.js#L26) diff --git a/docs/src/content/docs/reference/@tevm/common/variables/optimism.md b/docs/src/content/docs/reference/@tevm/common/variables/optimism.md index 8d4d551df4..b458dea299 100644 --- a/docs/src/content/docs/reference/@tevm/common/variables/optimism.md +++ b/docs/src/content/docs/reference/@tevm/common/variables/optimism.md @@ -5,8 +5,146 @@ prev: false title: "optimism" --- -> `const` **optimism**: [`Common`](/reference/tevm/common/type-aliases/common/) +> `const` **optimism**: `object` + +Creates a common configuration for the optimism chain. + +## Description + +Chain ID: 10 +Chain Name: OP Mainnet +Default Block Explorer: https://optimistic.etherscan.io +Default RPC URL: https://mainnet.optimism.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { optimism } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: optimism, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **blockExplorers.default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **contracts.ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **contracts.ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **contracts.multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **rpcUrls.default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks ## Defined in -[packages/common/src/presets/optimism.js:4](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/optimism.js#L4) +[packages/common/src/presets/optimism.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/optimism.js#L26) diff --git a/docs/src/content/docs/reference/@tevm/common/variables/optimismSepolia.md b/docs/src/content/docs/reference/@tevm/common/variables/optimismSepolia.md index 9d7e15f19c..46945d2141 100644 --- a/docs/src/content/docs/reference/@tevm/common/variables/optimismSepolia.md +++ b/docs/src/content/docs/reference/@tevm/common/variables/optimismSepolia.md @@ -5,8 +5,146 @@ prev: false title: "optimismSepolia" --- -> `const` **optimismSepolia**: [`Common`](/reference/tevm/common/type-aliases/common/) +> `const` **optimismSepolia**: `object` + +Creates a common configuration for the optimismSepolia chain. + +## Description + +Chain ID: 11155420 +Chain Name: OP Sepolia +Default Block Explorer: https://optimism-sepolia.blockscout.com +Default RPC URL: https://sepolia.optimism.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { optimismSepolia } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: optimismSepolia, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **blockExplorers.default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **contracts.ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **contracts.ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **contracts.multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **rpcUrls.default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks ## Defined in -[packages/common/src/presets/optimismSepolia.js:3](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/optimismSepolia.js#L3) +[packages/common/src/presets/optimismSepolia.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/optimismSepolia.js#L26) diff --git a/docs/src/content/docs/reference/@tevm/common/variables/polygon.md b/docs/src/content/docs/reference/@tevm/common/variables/polygon.md index 306297a5b0..ff1e18bcca 100644 --- a/docs/src/content/docs/reference/@tevm/common/variables/polygon.md +++ b/docs/src/content/docs/reference/@tevm/common/variables/polygon.md @@ -5,8 +5,146 @@ prev: false title: "polygon" --- -> `const` **polygon**: [`Common`](/reference/tevm/common/type-aliases/common/) +> `const` **polygon**: `object` + +Creates a common configuration for the polygon chain. + +## Description + +Chain ID: 137 +Chain Name: Polygon +Default Block Explorer: https://polygonscan.com +Default RPC URL: https://polygon-rpc.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { polygon } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: polygon, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **blockExplorers.default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **contracts.ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **contracts.ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **contracts.multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **rpcUrls.default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks ## Defined in -[packages/common/src/presets/polygon.js:4](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/polygon.js#L4) +[packages/common/src/presets/polygon.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/polygon.js#L26) diff --git a/docs/src/content/docs/reference/@tevm/common/variables/redstone.md b/docs/src/content/docs/reference/@tevm/common/variables/redstone.md index a11eccde9f..de54ac715e 100644 --- a/docs/src/content/docs/reference/@tevm/common/variables/redstone.md +++ b/docs/src/content/docs/reference/@tevm/common/variables/redstone.md @@ -5,8 +5,146 @@ prev: false title: "redstone" --- -> `const` **redstone**: [`Common`](/reference/tevm/common/type-aliases/common/) +> `const` **redstone**: `object` + +Creates a common configuration for the redstone chain. + +## Description + +Chain ID: 690 +Chain Name: Redstone +Default Block Explorer: https://explorer.redstone.xyz +Default RPC URL: https://rpc.redstonechain.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { redstone } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: redstone, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **blockExplorers.default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **contracts.ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **contracts.ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **contracts.multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **rpcUrls.default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks ## Defined in -[packages/common/src/presets/redstone.js:4](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/redstone.js#L4) +[packages/common/src/presets/redstone.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/redstone.js#L26) diff --git a/docs/src/content/docs/reference/@tevm/common/variables/scroll.md b/docs/src/content/docs/reference/@tevm/common/variables/scroll.md index 15e2b988a9..efeccfe734 100644 --- a/docs/src/content/docs/reference/@tevm/common/variables/scroll.md +++ b/docs/src/content/docs/reference/@tevm/common/variables/scroll.md @@ -5,8 +5,146 @@ prev: false title: "scroll" --- -> `const` **scroll**: [`Common`](/reference/tevm/common/type-aliases/common/) +> `const` **scroll**: `object` + +Creates a common configuration for the scroll chain. + +## Description + +Chain ID: 534352 +Chain Name: Scroll +Default Block Explorer: https://scrollscan.com +Default RPC URL: https://rpc.scroll.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { scroll } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: scroll, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **blockExplorers.default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **contracts.ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **contracts.ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **contracts.multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **rpcUrls.default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks ## Defined in -[packages/common/src/presets/scroll.js:4](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/scroll.js#L4) +[packages/common/src/presets/scroll.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/scroll.js#L26) diff --git a/docs/src/content/docs/reference/@tevm/common/variables/sepolia.md b/docs/src/content/docs/reference/@tevm/common/variables/sepolia.md index b9ac58c750..d6df30beeb 100644 --- a/docs/src/content/docs/reference/@tevm/common/variables/sepolia.md +++ b/docs/src/content/docs/reference/@tevm/common/variables/sepolia.md @@ -5,8 +5,146 @@ prev: false title: "sepolia" --- -> `const` **sepolia**: [`Common`](/reference/tevm/common/type-aliases/common/) +> `const` **sepolia**: `object` + +Creates a common configuration for the sepolia chain. + +## Description + +Chain ID: 11155111 +Chain Name: Sepolia +Default Block Explorer: https://sepolia.etherscan.io +Default RPC URL: https://rpc.sepolia.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { sepolia } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: sepolia, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **blockExplorers.default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **contracts.ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **contracts.ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **contracts.multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **rpcUrls.default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks ## Defined in -[packages/common/src/presets/sepolia.js:4](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/sepolia.js#L4) +[packages/common/src/presets/sepolia.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/sepolia.js#L26) diff --git a/docs/src/content/docs/reference/@tevm/common/variables/tevmDefault.md b/docs/src/content/docs/reference/@tevm/common/variables/tevmDefault.md index 0b767894c7..81f335e990 100644 --- a/docs/src/content/docs/reference/@tevm/common/variables/tevmDefault.md +++ b/docs/src/content/docs/reference/@tevm/common/variables/tevmDefault.md @@ -5,10 +5,124 @@ prev: false title: "tevmDefault" --- -> `const` **tevmDefault**: [`Common`](/reference/tevm/common/type-aliases/common/) +> `const` **tevmDefault**: `object` The default chain if no fork url is passed +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **blockExplorers.default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **contracts.ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **contracts.ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **contracts.multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **rpcUrls.default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + ## Defined in [packages/common/src/presets/tevmDefault.js:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/tevmDefault.js#L8) diff --git a/docs/src/content/docs/reference/@tevm/common/variables/zora.md b/docs/src/content/docs/reference/@tevm/common/variables/zora.md index cf8707620f..9c3b60f6ce 100644 --- a/docs/src/content/docs/reference/@tevm/common/variables/zora.md +++ b/docs/src/content/docs/reference/@tevm/common/variables/zora.md @@ -5,8 +5,146 @@ prev: false title: "zora" --- -> `const` **zora**: [`Common`](/reference/tevm/common/type-aliases/common/) +> `const` **zora**: `object` + +Creates a common configuration for the zora chain. + +## Description + +Chain ID: 7777777 +Chain Name: Zora +Default Block Explorer: https://explorer.zora.energy +Default RPC URL: https://rpc.zora.energy + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { zora } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: zora, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **blockExplorers.default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **contracts.ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **contracts.ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **contracts.multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **rpcUrls.default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks ## Defined in -[packages/common/src/presets/zora.js:4](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/zora.js#L4) +[packages/common/src/presets/zora.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/zora.js#L26) diff --git a/docs/src/content/docs/reference/@tevm/common/variables/zoraSepolia.md b/docs/src/content/docs/reference/@tevm/common/variables/zoraSepolia.md index fb73d320e7..be6893842c 100644 --- a/docs/src/content/docs/reference/@tevm/common/variables/zoraSepolia.md +++ b/docs/src/content/docs/reference/@tevm/common/variables/zoraSepolia.md @@ -5,8 +5,146 @@ prev: false title: "zoraSepolia" --- -> `const` **zoraSepolia**: [`Common`](/reference/tevm/common/type-aliases/common/) +> `const` **zoraSepolia**: `object` + +Creates a common configuration for the zoraSepolia chain. + +## Description + +Chain ID: 999999999 +Chain Name: Zora Sepolia +Default Block Explorer: https://sepolia.explorer.zora.energy/ +Default RPC URL: https://sepolia.rpc.zora.energy + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { zoraSepolia } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: zoraSepolia, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **blockExplorers.default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **contracts.ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **contracts.ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **contracts.multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **rpcUrls.default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks ## Defined in -[packages/common/src/presets/zoraSepolia.js:4](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/zoraSepolia.js#L4) +[packages/common/src/presets/zoraSepolia.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/zoraSepolia.js#L26) diff --git a/docs/src/content/docs/reference/@tevm/contract/functions/createContract.md b/docs/src/content/docs/reference/@tevm/contract/functions/createContract.md index 4b8932c19e..ff92953b82 100644 --- a/docs/src/content/docs/reference/@tevm/contract/functions/createContract.md +++ b/docs/src/content/docs/reference/@tevm/contract/functions/createContract.md @@ -7,13 +7,15 @@ title: "createContract" > **createContract**\<`TName`, `TAbi`, `TAddress`, `TBytecode`, `TDeployedBytecode`, `TCode`, `THumanReadableAbi`\>(`__namedParameters`): [`Contract`](/reference/tevm/contract/type-aliases/contract/)\<`TName`, `THumanReadableAbi`, `TAddress`, `TBytecode`, `TDeployedBytecode`, `TCode`\> -Creates a tevm Contract instance from human readable abi +Creates a Tevm Contract instance from a human-readable ABI or JSON ABI. +This function is the core of Tevm's contract interaction capabilities, +allowing for type-safe and easy-to-use contract interfaces. ## Type Parameters • **TName** *extends* `string` -• **TAbi** *extends* readonly `string`[] \| [`Abi`](/reference/tevm/utils/type-aliases/abi/) +• **TAbi** *extends* [`Abi`](/reference/tevm/utils/type-aliases/abi/) \| readonly `string`[] • **TAddress** *extends* `undefined` \| \`0x$\{string\}\` = `undefined` @@ -35,4 +37,4 @@ Creates a tevm Contract instance from human readable abi ## Defined in -[createContract.js:35](https://github.com/evmts/tevm-monorepo/blob/main/packages/contract/src/createContract.js#L35) +[createContract.js:73](https://github.com/evmts/tevm-monorepo/blob/main/packages/contract/src/createContract.js#L73) diff --git a/docs/src/content/docs/reference/@tevm/contract/globals.md b/docs/src/content/docs/reference/@tevm/contract/globals.md index 31c4e8c95b..c1361b4e88 100644 --- a/docs/src/content/docs/reference/@tevm/contract/globals.md +++ b/docs/src/content/docs/reference/@tevm/contract/globals.md @@ -10,8 +10,6 @@ title: "@tevm/contract" - [Contract](/reference/tevm/contract/type-aliases/contract/) - [CreateContractFn](/reference/tevm/contract/type-aliases/createcontractfn/) - [CreateContractParams](/reference/tevm/contract/type-aliases/createcontractparams/) -- [CreateScript](/reference/tevm/contract/type-aliases/createscript/) -- [DeployArgs](/reference/tevm/contract/type-aliases/deployargs/) - [EventActionCreator](/reference/tevm/contract/type-aliases/eventactioncreator/) - [MaybeExtractEventArgsFromAbi](/reference/tevm/contract/type-aliases/maybeextracteventargsfromabi/) - [ReadActionCreator](/reference/tevm/contract/type-aliases/readactioncreator/) diff --git a/docs/src/content/docs/reference/@tevm/contract/type-aliases/Contract.md b/docs/src/content/docs/reference/@tevm/contract/type-aliases/Contract.md index 6ae1ac7f53..741bc3665b 100644 --- a/docs/src/content/docs/reference/@tevm/contract/type-aliases/Contract.md +++ b/docs/src/content/docs/reference/@tevm/contract/type-aliases/Contract.md @@ -7,115 +7,126 @@ title: "Contract" > **Contract**\<`TName`, `THumanReadableAbi`, `TAddress`, `TBytecode`, `TDeployedBytecode`, `TCode`\>: `object` -Represents a specific contract abi and optional bytecode. +Represents a specific contract with its ABI and optional bytecode. +Contracts provide type-safe interfaces for interacting with smart contracts, +including read and write methods, event filtering, and deployment. ## Examples +Creating and using a Contract instance: ```typescript -import {createContract} from 'tevm/contract' - -const contract = createContract({ - address, - bytecode, - deployedBytecode, - humanReadableAbi, +import { createContract } from 'tevm/contract' + +const MyContract = createContract({ + name: 'MyToken', + humanReadableAbi: [ + 'function balanceOf(address account) view returns (uint256)', + 'function transfer(address to, uint256 amount) returns (bool)', + 'event Transfer(address indexed from, address indexed to, uint256 value)' + ], + address: '0x1234567890123456789012345678901234567890' }) -``` - -Contracts have actions creators for read methods, write methods, deploying, and events -```typescript -tevm.contract( -- { abi: [...], args: ['0x1234...'], functionName: 'balanceOf' }, -+ MyContract.read.balanceOf('0x1234...'), -) -``` - -These contracts can be automatically generated by using [@tevm/bundler](https://todo.todo) -and then importing it. The Tevm bundler will automatically resolve your solidity imports into -tevm contract instances - -```typescript -import { MyContract } from './MyContract.sol' - -console.log(MyContract.humanReadableAbi) -``` -Address can be added to a contract using the `withAddress` method +// Read contract state +const balanceAction = MyContract.read.balanceOf('0xabcdef...') +const balance = await tevm.contract(balanceAction) -```typescript -import { MyContract } from './MyContract.sol' +// Write to contract +const transferAction = MyContract.write.transfer('0xfedcba...', 1000n) +const result = await tevm.contract(transferAction) -const MyContractOptimism = MyContract.withAddress('0x420...') +// Create event filter +const transferFilter = MyContract.events.Transfer({ fromBlock: 'latest' }) +const logs = await tevm.eth.getLogs(transferFilter) ``` -Contracts can also be used with other libraries such as Viem and ethers. +Using with other libraries: ```typescript -import { MyContract } from './MyContract.sol' -import { createPublicClient } from 'viem' +import { createPublicClient, http } from 'viem' +import { mainnet } from 'viem/chains' -// see viem docs -const client = createPublicClient({...}) +const client = createPublicClient({ + chain: mainnet, + transport: http() +}) -const result = await client.readContract( - MyContract.withAddress('0x420...').read.balanceOf('0x1234...'), +const balance = await client.readContract( + MyContract.read.balanceOf('0xabcdef...') ) +``` ## Type Parameters • **TName** *extends* `string` +The name of the contract + • **THumanReadableAbi** *extends* `ReadonlyArray`\<`string`\> +The human-readable ABI of the contract + • **TAddress** *extends* `undefined` \| [`Address`](/reference/tevm/utils/type-aliases/address/) = `undefined` +The address of the contract (optional) + • **TBytecode** *extends* `undefined` \| [`Hex`](/reference/tevm/utils/type-aliases/hex/) = `undefined` +The creation bytecode of the contract (optional) + • **TDeployedBytecode** *extends* `undefined` \| [`Hex`](/reference/tevm/utils/type-aliases/hex/) = `undefined` +The deployed bytecode of the contract (optional) + • **TCode** *extends* `undefined` \| [`Hex`](/reference/tevm/utils/type-aliases/hex/) = `undefined` +The runtime bytecode of the contract (optional) + ## Type declaration ### abi > **abi**: [`ParseAbi`](/reference/tevm/utils/type-aliases/parseabi/)\<`THumanReadableAbi`\> -The json abi of the contract +The JSON ABI of the contract. #### Example ```typescript -import { MyContract } from './MyContract.sol' -console.log(MyContract.abi) // [{name: 'balanceOf', inputs: [...], outputs: [...], ...}] +console.log(MyContract.abi) +// [{name: 'balanceOf', inputs: [...], outputs: [...], ...}] ``` ### address > **address**: `TAddress` -Configured address of the contract. If not set it will be undefined -To set use the `withAddress` method +The configured address of the contract. If not set, it will be undefined. +Use the `withAddress` method to set or change the address. ### bytecode > **bytecode**: `TBytecode` -The contract bytecode is not defined on Contract objects are expected -to be deployed to the chain. See `Script` type which is a contract with bytecode -It's provided here to allow easier access of the property when using a -`Contract | Script` union type +The creation bytecode of the contract. ### code > **code**: `TCode` -Code i +The runtime bytecode of the contract, encoded with constructor arguments. ### deploy() > **deploy**: (...`args`) => [`EncodeDeployDataParameters`](/reference/tevm/utils/type-aliases/encodedeploydataparameters/)\<[`ParseAbi`](/reference/tevm/utils/type-aliases/parseabi/)\<`THumanReadableAbi`\>\> -Action creator for deploying the contract +Action creator for deploying the contract. + +#### Example + +```typescript +const deployAction = MyContract.deploy('Constructor', 'Args') +const deployedContract = await tevm.contract(deployAction) +``` #### Parameters @@ -129,35 +140,30 @@ Action creator for deploying the contract > **deployedBytecode**: `TDeployedBytecode` -The contract deployedBytecode is not defined on Contract objects are expected -to be deployed to the chain. See `Script` type which is a contract with deployedBytecode -It's provided here to allow easier access of the property when using a -`Contract | Script` union type +The deployed bytecode of the contract. ### events > **events**: [`EventActionCreator`](/reference/tevm/contract/type-aliases/eventactioncreator/)\<`THumanReadableAbi`, `TAddress`, `TBytecode`, `TDeployedBytecode`\> -Action creators for events. Can be used to create event filters in a typesafe way +Action creators for events. Used to create event filters in a type-safe way. #### Example ```typescript -tevm.eth.getLog( - MyContract.withAddress('0x420...').events.Transfer({ from: '0x1234...' }), -) -=== +const transferFilter = MyContract.events.Transfer({ from: '0x1234...' }) +const logs = await tevm.eth.getLogs(transferFilter) +``` ### humanReadableAbi > **humanReadableAbi**: `THumanReadableAbi` -The human readable abi of the contract +The human-readable ABI of the contract. #### Example ```typescript -import { MyContract } from './MyContract.sol' console.log(MyContract.humanReadableAbi) // ['function balanceOf(address): uint256', ...] ``` @@ -166,70 +172,76 @@ console.log(MyContract.humanReadableAbi) > `optional` **name**: `TName` -The name of the contract. If imported this will match the name of the contract import +The name of the contract. If imported, this will match the name of the contract import. ### read > **read**: [`ReadActionCreator`](/reference/tevm/contract/type-aliases/readactioncreator/)\<`THumanReadableAbi`, `TAddress`, `TCode`\> -Action creators for contract view and pure functions +Action creators for contract view and pure functions. #### Example ```typescript -tevm.contract( - MyContract.withAddress('0x420...').read.balanceOf('0x1234...'), -) +const balanceAction = MyContract.read.balanceOf('0x1234...') +const balance = await tevm.contract(balanceAction) ``` -### script - -> **script**: [`CreateScript`](/reference/tevm/contract/type-aliases/createscript/)\<`TName`, `THumanReadableAbi`, `TAddress`, `TBytecode`\> - -Creates a deployless instance of the contract that can be used with -tevm and viem as [deployless contracts](https://viem.sh/docs/contract/readContract#deployless-reads) - ### withAddress() -> **withAddress**: \<`TAddress`\>(`address`) => [`Contract`](/reference/tevm/contract/type-aliases/contract/)\<`TName`, `THumanReadableAbi`, `TAddress`, `TBytecode`, `TDeployedBytecode`, `TCode`\> +> **withAddress**: \<`TNewAddress`\>(`address`) => [`Contract`](/reference/tevm/contract/type-aliases/contract/)\<`TName`, `THumanReadableAbi`, `TNewAddress`, `TBytecode`, `TDeployedBytecode`, `TCode`\> -Adds an address to the contract. All action creators will return -the address property if added. THis method returns a new contract +Adds an address to the contract. All action creators will include +the address property if added. This method returns a new contract; it does not modify the existing contract. #### Example ```typescript -import { MyContract } from './MyContract.sol' -const MyContractOptimism = MyContract.withAddress('0x420...') +const MyContractWithAddress = MyContract.withAddress('0x1234...') ``` #### Type Parameters -• **TAddress** *extends* [`Address`](/reference/tevm/utils/type-aliases/address/) +• **TNewAddress** *extends* [`Address`](/reference/tevm/utils/type-aliases/address/) #### Parameters -• **address**: `TAddress` +• **address**: `TNewAddress` #### Returns -[`Contract`](/reference/tevm/contract/type-aliases/contract/)\<`TName`, `THumanReadableAbi`, `TAddress`, `TBytecode`, `TDeployedBytecode`, `TCode`\> +[`Contract`](/reference/tevm/contract/type-aliases/contract/)\<`TName`, `THumanReadableAbi`, `TNewAddress`, `TBytecode`, `TDeployedBytecode`, `TCode`\> + +### withCode() + +> **withCode**: (`encodedBytecode`) => [`Contract`](/reference/tevm/contract/type-aliases/contract/)\<`TName`, `THumanReadableAbi`, `TAddress`, `TBytecode`, `TDeployedBytecode`, [`Hex`](/reference/tevm/utils/type-aliases/hex/)\> + +#### Parameters + +• **encodedBytecode**: [`Hex`](/reference/tevm/utils/type-aliases/hex/) + +The encoded bytecode of the contract + +#### Returns + +[`Contract`](/reference/tevm/contract/type-aliases/contract/)\<`TName`, `THumanReadableAbi`, `TAddress`, `TBytecode`, `TDeployedBytecode`, [`Hex`](/reference/tevm/utils/type-aliases/hex/)\> + +A new contract instance with updated code ### write > **write**: [`WriteActionCreator`](/reference/tevm/contract/type-aliases/writeactioncreator/)\<`THumanReadableAbi`, `TAddress`, `TCode`\> -Action creators for contract payable and nonpayable functions +Action creators for contract payable and nonpayable functions. #### Example ```typescript -tevm.contract( - MyContract.withAddress('0x420...').read.balanceOf('0x1234...'), -) +const transferAction = MyContract.write.transfer('0x5678...', 1000n) +const result = await tevm.contract(transferAction) ``` ## Defined in -[Contract.ts:59](https://github.com/evmts/tevm-monorepo/blob/main/packages/contract/src/Contract.ts#L59) +[Contract.ts:62](https://github.com/evmts/tevm-monorepo/blob/main/packages/contract/src/Contract.ts#L62) diff --git a/docs/src/content/docs/reference/@tevm/contract/type-aliases/CreateContractFn.md b/docs/src/content/docs/reference/@tevm/contract/type-aliases/CreateContractFn.md index 54a154a214..5b270e64cf 100644 --- a/docs/src/content/docs/reference/@tevm/contract/type-aliases/CreateContractFn.md +++ b/docs/src/content/docs/reference/@tevm/contract/type-aliases/CreateContractFn.md @@ -13,32 +13,67 @@ title: "CreateContractFn" code, }`) => [`Contract`](/reference/tevm/contract/type-aliases/contract/)\<`TName`, `THumanReadableAbi`, `TAddress`, `TBytecode`, `TDeployedBytecode`, `TCode`\> -Type of `createContract` factory function -Creates a tevm Contract instance from human readable abi +Type of `createContract` factory function. +Creates a tevm Contract instance from a human readable ABI or JSON ABI. ## Examples +Using a human readable ABI: ```typescript -import { type Contract, createContract} from 'tevm/contract' +import { type Contract, createContract } from 'tevm/contract' const contract: Contract = createContract({ - name: 'MyContract', - abi: [ - ... - ], + name: 'ERC20', + humanReadableAbi: [ + 'function balanceOf(address owner) view returns (uint256)', + 'function transfer(address to, uint256 amount) returns (bool)', + 'event Transfer(address indexed from, address indexed to, uint256 value)', + ], }) ``` -To use a json abi first pass it into `formatAbi` to turn it into human readable - +Using a JSON ABI (needs to be formatted): ```typescript -import { type Contract, createContract} from 'tevm/contract' +import { type Contract, createContract } from 'tevm/contract' +import { formatAbi } from '@tevm/utils' + +const jsonAbi = [ + { + "inputs": [{"name": "owner", "type": "address"}], + "name": "balanceOf", + "outputs": [{"type": "uint256"}], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [ + {"name": "to", "type": "address"}, + {"name": "amount", "type": "uint256"} + ], + "name": "transfer", + "outputs": [{"type": "bool"}], + "stateMutability": "nonpayable", + "type": "function" + }, + { + "anonymous": false, + "inputs": [ + {"indexed": true, "name": "from", "type": "address"}, + {"indexed": true, "name": "to", "type": "address"}, + {"indexed": false, "name": "value", "type": "uint256"} + ], + "name": "Transfer", + "type": "event" + } +] const contract = createContract({ - name: 'MyContract', - abi: [ - ... - ], + name: 'ERC20', + abi: formatAbi(jsonAbi), + address: '0x6B175474E89094C44Da98b954EedeAC495271d0F', // DAI token address on Ethereum mainnet + bytecode: '0x60806040526000805534801561001457600080fd5b50610771806100246000396000f3fe', // Example bytecode (truncated) + deployedBytecode: '0x608060405234801561001057600080fd5b50600436106100885760003560e01c806370a082311161005b57806370a08231146101bc', // Example deployed bytecode (truncated) + code: '0x608060405234801561001057600080fd5b50600436106100885760003560e01c806370a082311161005b57806370a08231146101bc', // Example runtime code (truncated) }) ``` @@ -46,16 +81,28 @@ const contract = createContract({ • **TName** *extends* `string` +The name of the contract + • **TAbi** *extends* readonly `string`[] \| [`Abi`](/reference/tevm/utils/type-aliases/abi/) +The ABI type (either string[] for human readable or Abi for JSON) + • **TAddress** *extends* `undefined` \| [`Address`](/reference/tevm/utils/type-aliases/address/) = `undefined` +The contract address type (optional) + • **TBytecode** *extends* `undefined` \| [`Hex`](/reference/tevm/utils/type-aliases/hex/) = `undefined` +The contract bytecode type (optional) + • **TDeployedBytecode** *extends* `undefined` \| [`Hex`](/reference/tevm/utils/type-aliases/hex/) = `undefined` +The deployed bytecode type (optional) + • **TCode** *extends* `undefined` \| [`Hex`](/reference/tevm/utils/type-aliases/hex/) = `undefined` +The runtime bytecode type (optional) + • **THumanReadableAbi** *extends* readonly `string`[] = `TAbi` *extends* readonly `string`[] ? `TAbi` : `TAbi` *extends* [`Abi`](/reference/tevm/utils/type-aliases/abi/) ? [`FormatAbi`](/reference/tevm/utils/type-aliases/formatabi/)\<`TAbi`\> : `never` ## Parameters @@ -74,4 +121,4 @@ const contract = createContract({ ## Defined in -[CreateContractFn.ts:33](https://github.com/evmts/tevm-monorepo/blob/main/packages/contract/src/CreateContractFn.ts#L33) +[CreateContractFn.ts:77](https://github.com/evmts/tevm-monorepo/blob/main/packages/contract/src/CreateContractFn.ts#L77) diff --git a/docs/src/content/docs/reference/@tevm/contract/type-aliases/CreateContractParams.md b/docs/src/content/docs/reference/@tevm/contract/type-aliases/CreateContractParams.md index 7159741c7d..8c80467833 100644 --- a/docs/src/content/docs/reference/@tevm/contract/type-aliases/CreateContractParams.md +++ b/docs/src/content/docs/reference/@tevm/contract/type-aliases/CreateContractParams.md @@ -7,26 +7,71 @@ title: "CreateContractParams" > **CreateContractParams**\<`TName`, `TAbi`, `TAddress`, `TBytecode`, `TDeployedBytecode`, `TCode`\>: `object` \| `object` -Params for creating a [Contract](../../../../../../../reference/tevm/contract/type-aliases/contract) instance +Parameters for creating a [Contract](../../../../../../../reference/tevm/contract/type-aliases/contract) instance. +This type allows for two mutually exclusive ways of specifying the ABI: +either as a human-readable ABI or as a JSON ABI. ## See CreateContract +## Examples + +Using human-readable ABI: +```typescript +const params: CreateContractParams = { + name: 'ERC20', + humanReadableAbi: [ + 'function balanceOf(address owner) view returns (uint256)', + 'function transfer(address to, uint256 amount) returns (bool)', + ], + address: '0x6B175474E89094C44Da98b954EedeAC495271d0F', +} +``` + +Using JSON ABI: +```typescript +const params: CreateContractParams = { + name: 'ERC20', + abi: [ + { + "inputs": [{"name": "owner", "type": "address"}], + "name": "balanceOf", + "outputs": [{"type": "uint256"}], + "stateMutability": "view", + "type": "function" + }, + ], + address: '0x6B175474E89094C44Da98b954EedeAC495271d0F', +} +``` + ## Type Parameters • **TName** *extends* `string` \| `undefined` \| `never` +The name of the contract (optional) + • **TAbi** *extends* readonly `string`[] \| [`Abi`](/reference/tevm/utils/type-aliases/abi/) +The ABI type (either string[] for human readable or Abi for JSON) + • **TAddress** *extends* `undefined` \| [`Address`](/reference/tevm/utils/type-aliases/address/) \| `never` +The contract address type (optional) + • **TBytecode** *extends* `undefined` \| [`Hex`](/reference/tevm/utils/type-aliases/hex/) \| `never` +The contract creation bytecode type (optional) + • **TDeployedBytecode** *extends* `undefined` \| [`Hex`](/reference/tevm/utils/type-aliases/hex/) \| `never` +The deployed bytecode type (optional) + • **TCode** *extends* `undefined` \| [`Hex`](/reference/tevm/utils/type-aliases/hex/) \| `never` +The runtime bytecode type (optional) + ## Defined in -[CreateContractParams.ts:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/contract/src/CreateContractParams.ts#L8) +[CreateContractParams.ts:49](https://github.com/evmts/tevm-monorepo/blob/main/packages/contract/src/CreateContractParams.ts#L49) diff --git a/docs/src/content/docs/reference/@tevm/contract/type-aliases/CreateScript.md b/docs/src/content/docs/reference/@tevm/contract/type-aliases/CreateScript.md deleted file mode 100644 index 111a032a93..0000000000 --- a/docs/src/content/docs/reference/@tevm/contract/type-aliases/CreateScript.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -editUrl: false -next: false -prev: false -title: "CreateScript" ---- - -> **CreateScript**\<`TName`, `THumanReadableAbi`, `TAddress`, `TBytecode`\>: (...`args`) => [`Contract`](/reference/tevm/contract/type-aliases/contract/)\<`TName`, `THumanReadableAbi`, `TAddress`, [`Hex`](/reference/tevm/utils/type-aliases/hex/), [`Hex`](/reference/tevm/utils/type-aliases/hex/), [`Hex`](/reference/tevm/utils/type-aliases/hex/)\> - -Creates a deployless instance of a contract -Can be used to execute code that isn't deployed in tevm -or [viem](https://viem.sh/docs/actions/public/call#deployless-calls) - -## Type Parameters - -• **TName** *extends* `string` - -• **THumanReadableAbi** *extends* `string`[] \| readonly `string`[] - -• **TAddress** *extends* [`Address`](/reference/tevm/utils/type-aliases/address/) \| `undefined` = `undefined` - -• **TBytecode** *extends* [`Hex`](/reference/tevm/utils/type-aliases/hex/) \| `undefined` = `undefined` - -## Parameters - -• ...**args**: [`DeployArgs`](/reference/tevm/contract/type-aliases/deployargs/)\<`THumanReadableAbi`, `TBytecode`\> - -## Returns - -[`Contract`](/reference/tevm/contract/type-aliases/contract/)\<`TName`, `THumanReadableAbi`, `TAddress`, [`Hex`](/reference/tevm/utils/type-aliases/hex/), [`Hex`](/reference/tevm/utils/type-aliases/hex/), [`Hex`](/reference/tevm/utils/type-aliases/hex/)\> - -## Defined in - -[CreateScript.ts:10](https://github.com/evmts/tevm-monorepo/blob/main/packages/contract/src/CreateScript.ts#L10) diff --git a/docs/src/content/docs/reference/@tevm/contract/type-aliases/DeployArgs.md b/docs/src/content/docs/reference/@tevm/contract/type-aliases/DeployArgs.md deleted file mode 100644 index 4db84ecb4f..0000000000 --- a/docs/src/content/docs/reference/@tevm/contract/type-aliases/DeployArgs.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -editUrl: false -next: false -prev: false -title: "DeployArgs" ---- - -> **DeployArgs**\<`THumanReadableAbi`, `TBytecode`, `TAbi`, `THasConstructor`\>: `THasConstructor` *extends* `false` ? `TBytecode` *extends* [`Hex`](/reference/tevm/utils/type-aliases/hex/) ? [] \| [`object`] : [`object`] : `TBytecode` *extends* [`Hex`](/reference/tevm/utils/type-aliases/hex/) ? [`object`] : [`object`] - -Inferred arguments for a contract deployment - -## Type Parameters - -• **THumanReadableAbi** *extends* `string`[] \| readonly `string`[] - -• **TBytecode** *extends* [`Hex`](/reference/tevm/utils/type-aliases/hex/) \| `undefined` = `undefined` - -• **TAbi** *extends* [`ParseAbi`](/reference/tevm/utils/type-aliases/parseabi/)\<`THumanReadableAbi`\> = [`ParseAbi`](/reference/tevm/utils/type-aliases/parseabi/)\<`THumanReadableAbi`\> - -• **THasConstructor** = `TAbi` *extends* [`Abi`](/reference/tevm/utils/type-aliases/abi/) ? [`Abi`](/reference/tevm/utils/type-aliases/abi/) *extends* `TAbi` ? `true` : [`Extract`\<`TAbi`\[`number`\], `object`\>] *extends* [`never`] ? `false` : `true` : `true` - -## Defined in - -[DeployArgs.ts:6](https://github.com/evmts/tevm-monorepo/blob/main/packages/contract/src/DeployArgs.ts#L6) diff --git a/docs/src/content/docs/reference/@tevm/contract/type-aliases/EventActionCreator.md b/docs/src/content/docs/reference/@tevm/contract/type-aliases/EventActionCreator.md index 798ebd9f4d..2649f7fd80 100644 --- a/docs/src/content/docs/reference/@tevm/contract/type-aliases/EventActionCreator.md +++ b/docs/src/content/docs/reference/@tevm/contract/type-aliases/EventActionCreator.md @@ -7,28 +7,44 @@ title: "EventActionCreator" > **EventActionCreator**\<`THumanReadableAbi`, `TBytecode`, `TDeployedBytecode`, `TAddress`, `TAddressArgs`\>: `{ [TEventName in ExtractAbiEventNames>]: Function & Object & TAddressArgs }` -A mapping of event names to action creators for events. Can be used to create event filters in a typesafe way +A mapping of event names to action creators for events. Can be used to create event filters in a typesafe way. ## Example ```typescript -tevm.eth.getLog( - MyScript.withAddress('0x420...').events.Transfer({ from: '0x1234...' }), -) -=== +// Creating an event filter for a Transfer event +const filter = MyContract.events.Transfer({ + fromBlock: 'latest', + toBlock: 'latest', + args: { from: '0x1234...', to: '0x5678...' } +}) + +// Using the filter with tevm +const logs = await tevm.eth.getLogs(filter) +``` ## Type Parameters • **THumanReadableAbi** *extends* readonly `string`[] +The human-readable ABI of the contract. + • **TBytecode** *extends* [`Hex`](/reference/tevm/utils/type-aliases/hex/) \| `undefined` +The bytecode of the contract. + • **TDeployedBytecode** *extends* [`Hex`](/reference/tevm/utils/type-aliases/hex/) \| `undefined` +The deployed bytecode of the contract. + • **TAddress** *extends* [`Address`](/reference/tevm/utils/type-aliases/address/) \| `undefined` +The address of the contract. + • **TAddressArgs** = `TAddress` *extends* `undefined` ? `object` : `object` +Additional arguments for the address. + ## Defined in -[event/EventActionCreator.ts:41](https://github.com/evmts/tevm-monorepo/blob/main/packages/contract/src/event/EventActionCreator.ts#L41) +[event/EventActionCreator.ts:59](https://github.com/evmts/tevm-monorepo/blob/main/packages/contract/src/event/EventActionCreator.ts#L59) diff --git a/docs/src/content/docs/reference/@tevm/contract/type-aliases/MaybeExtractEventArgsFromAbi.md b/docs/src/content/docs/reference/@tevm/contract/type-aliases/MaybeExtractEventArgsFromAbi.md index 6d5bdd5b65..89decde2d1 100644 --- a/docs/src/content/docs/reference/@tevm/contract/type-aliases/MaybeExtractEventArgsFromAbi.md +++ b/docs/src/content/docs/reference/@tevm/contract/type-aliases/MaybeExtractEventArgsFromAbi.md @@ -7,14 +7,18 @@ title: "MaybeExtractEventArgsFromAbi" > **MaybeExtractEventArgsFromAbi**\<`TAbi`, `TEventName`\>: `Exclude`\<`TAbi` *extends* [`Abi`](/reference/tevm/utils/type-aliases/abi/) \| readonly `unknown`[] ? `TEventName` *extends* `string` ? [`GetEventArgs`](/reference/tevm/utils/type-aliases/geteventargs/)\<`TAbi`, `TEventName`\> : `undefined` : `undefined`, readonly `unknown`[] \| `Record`\<`string`, `unknown`\>\> -Adapted from viem. This is a helper type to extract the event args from an abi +Extracts event arguments from an ABI. ## Type Parameters • **TAbi** *extends* [`Abi`](/reference/tevm/utils/type-aliases/abi/) \| readonly `unknown`[] \| `undefined` +The ABI type, can be an Abi, readonly unknown[], or undefined. + • **TEventName** *extends* `string` \| `undefined` +The name of the event, can be a string or undefined. + ## Defined in -[event/EventActionCreator.ts:18](https://github.com/evmts/tevm-monorepo/blob/main/packages/contract/src/event/EventActionCreator.ts#L18) +[event/EventActionCreator.ts:20](https://github.com/evmts/tevm-monorepo/blob/main/packages/contract/src/event/EventActionCreator.ts#L20) diff --git a/docs/src/content/docs/reference/@tevm/contract/type-aliases/ReadActionCreator.md b/docs/src/content/docs/reference/@tevm/contract/type-aliases/ReadActionCreator.md index 760360224a..a338fbe0cc 100644 --- a/docs/src/content/docs/reference/@tevm/contract/type-aliases/ReadActionCreator.md +++ b/docs/src/content/docs/reference/@tevm/contract/type-aliases/ReadActionCreator.md @@ -7,26 +7,38 @@ title: "ReadActionCreator" > **ReadActionCreator**\<`THumanReadableAbi`, `TAddress`, `TCode`, `TAddressArgs`\>: \{ \[TFunctionName in ExtractAbiFunctionNames\, "pure" \| "view"\>\]: Function & Object & (TCode extends undefined ? Object : Object) & TAddressArgs \} -A mapping of view and pure contract methods to action creators +A mapping of view and pure contract methods to action creators. +This type provides a way to create type-safe read actions for contract methods. ## Example ```typescript -tevm.contract( - MyScript.withAddress('0x420...').read.balanceOf('0x1234...'), -) +// Assuming we have a contract with a 'balanceOf' method +const balanceAction = MyContract.read.balanceOf('0x1234...') + +// Use the action with tevm +const balance = await tevm.contract(balanceAction) +console.log('Balance:', balance) ``` ## Type Parameters • **THumanReadableAbi** *extends* readonly `string`[] +The human-readable ABI of the contract. + • **TAddress** *extends* [`Address`](/reference/tevm/utils/type-aliases/address/) \| `undefined` +The address of the contract (optional). + • **TCode** *extends* [`Hex`](/reference/tevm/utils/type-aliases/hex/) \| `undefined` +The runtime bytecode of the contract (optional). + • **TAddressArgs** = `TAddress` *extends* `undefined` ? `object` : `object` +Additional arguments for the address (derived from TAddress). + ## Defined in -[read/ReadActionCreator.ts:23](https://github.com/evmts/tevm-monorepo/blob/main/packages/contract/src/read/ReadActionCreator.ts#L23) +[read/ReadActionCreator.ts:36](https://github.com/evmts/tevm-monorepo/blob/main/packages/contract/src/read/ReadActionCreator.ts#L36) diff --git a/docs/src/content/docs/reference/@tevm/contract/type-aliases/ValueOf.md b/docs/src/content/docs/reference/@tevm/contract/type-aliases/ValueOf.md index 11a85da4da..3b734e1a54 100644 --- a/docs/src/content/docs/reference/@tevm/contract/type-aliases/ValueOf.md +++ b/docs/src/content/docs/reference/@tevm/contract/type-aliases/ValueOf.md @@ -7,10 +7,14 @@ title: "ValueOf" > **ValueOf**\<`T`\>: `T`\[keyof `T`\] +Utility type to get the value type of an object. + ## Type Parameters • **T** +The object type. + ## Defined in -[event/EventActionCreator.ts:30](https://github.com/evmts/tevm-monorepo/blob/main/packages/contract/src/event/EventActionCreator.ts#L30) +[event/EventActionCreator.ts:36](https://github.com/evmts/tevm-monorepo/blob/main/packages/contract/src/event/EventActionCreator.ts#L36) diff --git a/docs/src/content/docs/reference/@tevm/contract/type-aliases/WriteActionCreator.md b/docs/src/content/docs/reference/@tevm/contract/type-aliases/WriteActionCreator.md index 13a7c7c42c..61d15569bf 100644 --- a/docs/src/content/docs/reference/@tevm/contract/type-aliases/WriteActionCreator.md +++ b/docs/src/content/docs/reference/@tevm/contract/type-aliases/WriteActionCreator.md @@ -7,26 +7,38 @@ title: "WriteActionCreator" > **WriteActionCreator**\<`THumanReadableAbi`, `TAddress`, `TCode`, `TAddressArgs`\>: \{ \[TFunctionName in ExtractAbiFunctionNames\, "payable" \| "nonpayable"\>\]: Function & Object & (TCode extends undefined ? Object : Object) & TAddressArgs \} -A mapping of payable and nonpayable contract methods to action creators +A mapping of payable and nonpayable contract methods to action creators. +This type provides a way to create type-safe write actions for contract methods. ## Example ```typescript -tevm.contract( - MyContract.withAddress('0x420...').read.balanceOf('0x1234...'), -) +// Assuming we have a contract with a 'transfer' method +const transferAction = MyContract.write.transfer('0x1234...', 1000n) + +// Use the action with tevm +const result = await tevm.contract(transferAction) +console.log('Transaction hash:', result.transactionHash) ``` ## Type Parameters • **THumanReadableAbi** *extends* readonly `string`[] +The human-readable ABI of the contract. + • **TAddress** *extends* [`Address`](/reference/tevm/utils/type-aliases/address/) \| `undefined` +The address of the contract (optional). + • **TCode** *extends* [`Hex`](/reference/tevm/utils/type-aliases/hex/) \| `undefined` +The runtime bytecode of the contract (optional). + • **TAddressArgs** = `TAddress` *extends* `undefined` ? `object` : `object` +Additional arguments for the address (derived from TAddress). + ## Defined in -[write/WriteActionCreator.ts:23](https://github.com/evmts/tevm-monorepo/blob/main/packages/contract/src/write/WriteActionCreator.ts#L23) +[write/WriteActionCreator.ts:36](https://github.com/evmts/tevm-monorepo/blob/main/packages/contract/src/write/WriteActionCreator.ts#L36) diff --git a/docs/src/content/docs/reference/@tevm/contract/variables/ERC20.md b/docs/src/content/docs/reference/@tevm/contract/variables/ERC20.md index f0856f3980..b821851724 100644 --- a/docs/src/content/docs/reference/@tevm/contract/variables/ERC20.md +++ b/docs/src/content/docs/reference/@tevm/contract/variables/ERC20.md @@ -7,8 +7,38 @@ title: "ERC20" > `const` **ERC20**: [`Contract`](/reference/tevm/contract/type-aliases/contract/)\<`"OzERC20"`, readonly [`"constructor(string name, string symbol)"`, `"error ERC20InsufficientAllowance(address spender, uint256 allowance, uint256 needed)"`, `"error ERC20InsufficientBalance(address sender, uint256 balance, uint256 needed)"`, `"error ERC20InvalidApprover(address approver)"`, `"error ERC20InvalidReceiver(address receiver)"`, `"error ERC20InvalidSender(address sender)"`, `"error ERC20InvalidSpender(address spender)"`, `"event Approval(address indexed owner, address indexed spender, uint256 value)"`, `"event Transfer(address indexed from, address indexed to, uint256 value)"`, `"function allowance(address owner, address spender) view returns (uint256)"`, `"function approve(address spender, uint256 value) returns (bool)"`, `"function balanceOf(address account) view returns (uint256)"`, `"function decimals() view returns (uint8)"`, `"function name() view returns (string)"`, `"function symbol() view returns (string)"`, `"function totalSupply() view returns (uint256)"`, `"function transfer(address to, uint256 value) returns (bool)"`, `"function transferFrom(address from, address to, uint256 value) returns (bool)"`], `undefined`, `"0x608060405234801562000010575f80fd5b5060405162001392380380620013928339818101604052810190620000369190620001eb565b81818160039081620000499190620004a5565b5080600490816200005b9190620004a5565b505050505062000589565b5f604051905090565b5f80fd5b5f80fd5b5f80fd5b5f80fd5b5f601f19601f8301169050919050565b7f4e487b71000000000000000000000000000000000000000000000000000000005f52604160045260245ffd5b620000c7826200007f565b810181811067ffffffffffffffff82111715620000e957620000e86200008f565b5b80604052505050565b5f620000fd62000066565b90506200010b8282620000bc565b919050565b5f67ffffffffffffffff8211156200012d576200012c6200008f565b5b62000138826200007f565b9050602081019050919050565b5f5b838110156200016457808201518184015260208101905062000147565b5f8484015250505050565b5f620001856200017f8462000110565b620000f2565b905082815260208101848484011115620001a457620001a36200007b565b5b620001b184828562000145565b509392505050565b5f82601f830112620001d057620001cf62000077565b5b8151620001e28482602086016200016f565b91505092915050565b5f80604083850312156200020457620002036200006f565b5b5f83015167ffffffffffffffff81111562000224576200022362000073565b5b6200023285828601620001b9565b925050602083015167ffffffffffffffff81111562000256576200025562000073565b5b6200026485828601620001b9565b9150509250929050565b5f81519050919050565b7f4e487b71000000000000000000000000000000000000000000000000000000005f52602260045260245ffd5b5f6002820490506001821680620002bd57607f821691505b602082108103620002d357620002d262000278565b5b50919050565b5f819050815f5260205f209050919050565b5f6020601f8301049050919050565b5f82821b905092915050565b5f60088302620003377fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff82620002fa565b620003438683620002fa565b95508019841693508086168417925050509392505050565b5f819050919050565b5f819050919050565b5f6200038d6200038762000381846200035b565b62000364565b6200035b565b9050919050565b5f819050919050565b620003a8836200036d565b620003c0620003b78262000394565b84845462000306565b825550505050565b5f90565b620003d6620003c8565b620003e38184846200039d565b505050565b5b818110156200040a57620003fe5f82620003cc565b600181019050620003e9565b5050565b601f82111562000459576200042381620002d9565b6200042e84620002eb565b810160208510156200043e578190505b620004566200044d85620002eb565b830182620003e8565b50505b505050565b5f82821c905092915050565b5f6200047b5f19846008026200045e565b1980831691505092915050565b5f6200049583836200046a565b9150826002028217905092915050565b620004b0826200026e565b67ffffffffffffffff811115620004cc57620004cb6200008f565b5b620004d88254620002a5565b620004e58282856200040e565b5f60209050601f8311600181146200051b575f841562000506578287015190505b62000512858262000488565b86555062000581565b601f1984166200052b86620002d9565b5f5b8281101562000554578489015182556001820191506020850194506020810190506200052d565b8683101562000574578489015162000570601f8916826200046a565b8355505b6001600288020188555050505b505050505050565b610dfb80620005975f395ff3fe608060405234801561000f575f80fd5b5060043610610091575f3560e01c8063313ce56711610064578063313ce5671461013157806370a082311461014f57806395d89b411461017f578063a9059cbb1461019d578063dd62ed3e146101cd57610091565b806306fdde0314610095578063095ea7b3146100b357806318160ddd146100e357806323b872dd14610101575b5f80fd5b61009d6101fd565b6040516100aa9190610a74565b60405180910390f35b6100cd60048036038101906100c89190610b25565b61028d565b6040516100da9190610b7d565b60405180910390f35b6100eb6102af565b6040516100f89190610ba5565b60405180910390f35b61011b60048036038101906101169190610bbe565b6102b8565b6040516101289190610b7d565b60405180910390f35b6101396102e6565b6040516101469190610c29565b60405180910390f35b61016960048036038101906101649190610c42565b6102ee565b6040516101769190610ba5565b60405180910390f35b610187610333565b6040516101949190610a74565b60405180910390f35b6101b760048036038101906101b29190610b25565b6103c3565b6040516101c49190610b7d565b60405180910390f35b6101e760048036038101906101e29190610c6d565b6103e5565b6040516101f49190610ba5565b60405180910390f35b60606003805461020c90610cd8565b80601f016020809104026020016040519081016040528092919081815260200182805461023890610cd8565b80156102835780601f1061025a57610100808354040283529160200191610283565b820191905f5260205f20905b81548152906001019060200180831161026657829003601f168201915b5050505050905090565b5f80610297610467565b90506102a481858561046e565b600191505092915050565b5f600254905090565b5f806102c2610467565b90506102cf858285610480565b6102da858585610512565b60019150509392505050565b5f6012905090565b5f805f8373ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f20549050919050565b60606004805461034290610cd8565b80601f016020809104026020016040519081016040528092919081815260200182805461036e90610cd8565b80156103b95780601f10610390576101008083540402835291602001916103b9565b820191905f5260205f20905b81548152906001019060200180831161039c57829003601f168201915b5050505050905090565b5f806103cd610467565b90506103da818585610512565b600191505092915050565b5f60015f8473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f8373ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f2054905092915050565b5f33905090565b61047b8383836001610602565b505050565b5f61048b84846103e5565b90507fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff811461050c57818110156104fd578281836040517ffb8f41b20000000000000000000000000000000000000000000000000000000081526004016104f493929190610d17565b60405180910390fd5b61050b84848484035f610602565b5b50505050565b5f73ffffffffffffffffffffffffffffffffffffffff168373ffffffffffffffffffffffffffffffffffffffff1603610582575f6040517f96c6fd1e0000000000000000000000000000000000000000000000000000000081526004016105799190610d4c565b60405180910390fd5b5f73ffffffffffffffffffffffffffffffffffffffff168273ffffffffffffffffffffffffffffffffffffffff16036105f2575f6040517fec442f050000000000000000000000000000000000000000000000000000000081526004016105e99190610d4c565b60405180910390fd5b6105fd8383836107d1565b505050565b5f73ffffffffffffffffffffffffffffffffffffffff168473ffffffffffffffffffffffffffffffffffffffff1603610672575f6040517fe602df050000000000000000000000000000000000000000000000000000000081526004016106699190610d4c565b60405180910390fd5b5f73ffffffffffffffffffffffffffffffffffffffff168373ffffffffffffffffffffffffffffffffffffffff16036106e2575f6040517f94280d620000000000000000000000000000000000000000000000000000000081526004016106d99190610d4c565b60405180910390fd5b8160015f8673ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f8573ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f208190555080156107cb578273ffffffffffffffffffffffffffffffffffffffff168473ffffffffffffffffffffffffffffffffffffffff167f8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925846040516107c29190610ba5565b60405180910390a35b50505050565b5f73ffffffffffffffffffffffffffffffffffffffff168373ffffffffffffffffffffffffffffffffffffffff1603610821578060025f8282546108159190610d92565b925050819055506108ef565b5f805f8573ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f20549050818110156108aa578381836040517fe450d38c0000000000000000000000000000000000000000000000000000000081526004016108a193929190610d17565b60405180910390fd5b8181035f808673ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f2081905550505b5f73ffffffffffffffffffffffffffffffffffffffff168273ffffffffffffffffffffffffffffffffffffffff1603610936578060025f8282540392505081905550610980565b805f808473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f82825401925050819055505b8173ffffffffffffffffffffffffffffffffffffffff168373ffffffffffffffffffffffffffffffffffffffff167fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef836040516109dd9190610ba5565b60405180910390a3505050565b5f81519050919050565b5f82825260208201905092915050565b5f5b83811015610a21578082015181840152602081019050610a06565b5f8484015250505050565b5f601f19601f8301169050919050565b5f610a46826109ea565b610a5081856109f4565b9350610a60818560208601610a04565b610a6981610a2c565b840191505092915050565b5f6020820190508181035f830152610a8c8184610a3c565b905092915050565b5f80fd5b5f73ffffffffffffffffffffffffffffffffffffffff82169050919050565b5f610ac182610a98565b9050919050565b610ad181610ab7565b8114610adb575f80fd5b50565b5f81359050610aec81610ac8565b92915050565b5f819050919050565b610b0481610af2565b8114610b0e575f80fd5b50565b5f81359050610b1f81610afb565b92915050565b5f8060408385031215610b3b57610b3a610a94565b5b5f610b4885828601610ade565b9250506020610b5985828601610b11565b9150509250929050565b5f8115159050919050565b610b7781610b63565b82525050565b5f602082019050610b905f830184610b6e565b92915050565b610b9f81610af2565b82525050565b5f602082019050610bb85f830184610b96565b92915050565b5f805f60608486031215610bd557610bd4610a94565b5b5f610be286828701610ade565b9350506020610bf386828701610ade565b9250506040610c0486828701610b11565b9150509250925092565b5f60ff82169050919050565b610c2381610c0e565b82525050565b5f602082019050610c3c5f830184610c1a565b92915050565b5f60208284031215610c5757610c56610a94565b5b5f610c6484828501610ade565b91505092915050565b5f8060408385031215610c8357610c82610a94565b5b5f610c9085828601610ade565b9250506020610ca185828601610ade565b9150509250929050565b7f4e487b71000000000000000000000000000000000000000000000000000000005f52602260045260245ffd5b5f6002820490506001821680610cef57607f821691505b602082108103610d0257610d01610cab565b5b50919050565b610d1181610ab7565b82525050565b5f606082019050610d2a5f830186610d08565b610d376020830185610b96565b610d446040830184610b96565b949350505050565b5f602082019050610d5f5f830184610d08565b92915050565b7f4e487b71000000000000000000000000000000000000000000000000000000005f52601160045260245ffd5b5f610d9c82610af2565b9150610da783610af2565b9250828201905080821115610dbf57610dbe610d65565b5b9291505056fea264697066735822122055b5ce6d6026c56b28a641568d3e9a6c81fb1079127f85ede16ed31d67d3eff464736f6c63430008160033"`, `"0x608060405234801561000f575f80fd5b5060043610610091575f3560e01c8063313ce56711610064578063313ce5671461013157806370a082311461014f57806395d89b411461017f578063a9059cbb1461019d578063dd62ed3e146101cd57610091565b806306fdde0314610095578063095ea7b3146100b357806318160ddd146100e357806323b872dd14610101575b5f80fd5b61009d6101fd565b6040516100aa9190610a74565b60405180910390f35b6100cd60048036038101906100c89190610b25565b61028d565b6040516100da9190610b7d565b60405180910390f35b6100eb6102af565b6040516100f89190610ba5565b60405180910390f35b61011b60048036038101906101169190610bbe565b6102b8565b6040516101289190610b7d565b60405180910390f35b6101396102e6565b6040516101469190610c29565b60405180910390f35b61016960048036038101906101649190610c42565b6102ee565b6040516101769190610ba5565b60405180910390f35b610187610333565b6040516101949190610a74565b60405180910390f35b6101b760048036038101906101b29190610b25565b6103c3565b6040516101c49190610b7d565b60405180910390f35b6101e760048036038101906101e29190610c6d565b6103e5565b6040516101f49190610ba5565b60405180910390f35b60606003805461020c90610cd8565b80601f016020809104026020016040519081016040528092919081815260200182805461023890610cd8565b80156102835780601f1061025a57610100808354040283529160200191610283565b820191905f5260205f20905b81548152906001019060200180831161026657829003601f168201915b5050505050905090565b5f80610297610467565b90506102a481858561046e565b600191505092915050565b5f600254905090565b5f806102c2610467565b90506102cf858285610480565b6102da858585610512565b60019150509392505050565b5f6012905090565b5f805f8373ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f20549050919050565b60606004805461034290610cd8565b80601f016020809104026020016040519081016040528092919081815260200182805461036e90610cd8565b80156103b95780601f10610390576101008083540402835291602001916103b9565b820191905f5260205f20905b81548152906001019060200180831161039c57829003601f168201915b5050505050905090565b5f806103cd610467565b90506103da818585610512565b600191505092915050565b5f60015f8473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f8373ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f2054905092915050565b5f33905090565b61047b8383836001610602565b505050565b5f61048b84846103e5565b90507fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff811461050c57818110156104fd578281836040517ffb8f41b20000000000000000000000000000000000000000000000000000000081526004016104f493929190610d17565b60405180910390fd5b61050b84848484035f610602565b5b50505050565b5f73ffffffffffffffffffffffffffffffffffffffff168373ffffffffffffffffffffffffffffffffffffffff1603610582575f6040517f96c6fd1e0000000000000000000000000000000000000000000000000000000081526004016105799190610d4c565b60405180910390fd5b5f73ffffffffffffffffffffffffffffffffffffffff168273ffffffffffffffffffffffffffffffffffffffff16036105f2575f6040517fec442f050000000000000000000000000000000000000000000000000000000081526004016105e99190610d4c565b60405180910390fd5b6105fd8383836107d1565b505050565b5f73ffffffffffffffffffffffffffffffffffffffff168473ffffffffffffffffffffffffffffffffffffffff1603610672575f6040517fe602df050000000000000000000000000000000000000000000000000000000081526004016106699190610d4c565b60405180910390fd5b5f73ffffffffffffffffffffffffffffffffffffffff168373ffffffffffffffffffffffffffffffffffffffff16036106e2575f6040517f94280d620000000000000000000000000000000000000000000000000000000081526004016106d99190610d4c565b60405180910390fd5b8160015f8673ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f8573ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f208190555080156107cb578273ffffffffffffffffffffffffffffffffffffffff168473ffffffffffffffffffffffffffffffffffffffff167f8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925846040516107c29190610ba5565b60405180910390a35b50505050565b5f73ffffffffffffffffffffffffffffffffffffffff168373ffffffffffffffffffffffffffffffffffffffff1603610821578060025f8282546108159190610d92565b925050819055506108ef565b5f805f8573ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f20549050818110156108aa578381836040517fe450d38c0000000000000000000000000000000000000000000000000000000081526004016108a193929190610d17565b60405180910390fd5b8181035f808673ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f2081905550505b5f73ffffffffffffffffffffffffffffffffffffffff168273ffffffffffffffffffffffffffffffffffffffff1603610936578060025f8282540392505081905550610980565b805f808473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f82825401925050819055505b8173ffffffffffffffffffffffffffffffffffffffff168373ffffffffffffffffffffffffffffffffffffffff167fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef836040516109dd9190610ba5565b60405180910390a3505050565b5f81519050919050565b5f82825260208201905092915050565b5f5b83811015610a21578082015181840152602081019050610a06565b5f8484015250505050565b5f601f19601f8301169050919050565b5f610a46826109ea565b610a5081856109f4565b9350610a60818560208601610a04565b610a6981610a2c565b840191505092915050565b5f6020820190508181035f830152610a8c8184610a3c565b905092915050565b5f80fd5b5f73ffffffffffffffffffffffffffffffffffffffff82169050919050565b5f610ac182610a98565b9050919050565b610ad181610ab7565b8114610adb575f80fd5b50565b5f81359050610aec81610ac8565b92915050565b5f819050919050565b610b0481610af2565b8114610b0e575f80fd5b50565b5f81359050610b1f81610afb565b92915050565b5f8060408385031215610b3b57610b3a610a94565b5b5f610b4885828601610ade565b9250506020610b5985828601610b11565b9150509250929050565b5f8115159050919050565b610b7781610b63565b82525050565b5f602082019050610b905f830184610b6e565b92915050565b610b9f81610af2565b82525050565b5f602082019050610bb85f830184610b96565b92915050565b5f805f60608486031215610bd557610bd4610a94565b5b5f610be286828701610ade565b9350506020610bf386828701610ade565b9250506040610c0486828701610b11565b9150509250925092565b5f60ff82169050919050565b610c2381610c0e565b82525050565b5f602082019050610c3c5f830184610c1a565b92915050565b5f60208284031215610c5757610c56610a94565b5b5f610c6484828501610ade565b91505092915050565b5f8060408385031215610c8357610c82610a94565b5b5f610c9085828601610ade565b9250506020610ca185828601610ade565b9150509250929050565b7f4e487b71000000000000000000000000000000000000000000000000000000005f52602260045260245ffd5b5f6002820490506001821680610cef57607f821691505b602082108103610d0257610d01610cab565b5b50919050565b610d1181610ab7565b82525050565b5f606082019050610d2a5f830186610d08565b610d376020830185610b96565b610d446040830184610b96565b949350505050565b5f602082019050610d5f5f830184610d08565b92915050565b7f4e487b71000000000000000000000000000000000000000000000000000000005f52601160045260245ffd5b5f610d9c82610af2565b9150610da783610af2565b9250828201905080821115610dbf57610dbe610d65565b5b9291505056fea264697066735822122055b5ce6d6026c56b28a641568d3e9a6c81fb1079127f85ede16ed31d67d3eff464736f6c63430008160033"`, `undefined`\> -Bytecode and ABI for the ERC20 contract from open zeppelin. +Bytecode and ABI for the ERC20 contract from OpenZeppelin. +This constant represents a standard ERC20 token implementation. + +## Examples + +Using the ERC20 contract in a deployment script: +```typescript +import { ERC20 } from 'tevm/contract' + +// Deploy the ERC20 contract +const deployedERC20 = await tevm.deployContract(ERC20.deploy('MyToken', 'MTK')) +console.log('ERC20 deployed at:', deployedERC20.address) + +// Interact with the deployed contract +const balance = await tevm.contract(ERC20.read.balanceOf(deployedERC20.address, '0x1234...')) +console.log('Balance:', balance) +``` + +Using the ERC20 contract with an existing deployment: +```typescript +import { ERC20 } from 'tevm/contract' + +const existingERC20 = ERC20.withAddress('0x1234...') + +// Read token name +const name = await tevm.contract(existingERC20.read.name()) +console.log('Token name:', name) + +// Transfer tokens +await tevm.contract(existingERC20.write.transfer('0x5678...', 1000n)) +``` ## Defined in -[contract-lib/ERC20.ts:32](https://github.com/evmts/tevm-monorepo/blob/main/packages/contract/src/contract-lib/ERC20.ts#L32) +[contract-lib/ERC20.ts:62](https://github.com/evmts/tevm-monorepo/blob/main/packages/contract/src/contract-lib/ERC20.ts#L62) diff --git a/docs/src/content/docs/reference/@tevm/contract/variables/ERC721.md b/docs/src/content/docs/reference/@tevm/contract/variables/ERC721.md index c7238115e6..fb0401ea50 100644 --- a/docs/src/content/docs/reference/@tevm/contract/variables/ERC721.md +++ b/docs/src/content/docs/reference/@tevm/contract/variables/ERC721.md @@ -7,8 +7,39 @@ title: "ERC721" > `const` **ERC721**: [`Contract`](/reference/tevm/contract/type-aliases/contract/)\<`"OzERC721"`, readonly [`"constructor(string name, string symbol)"`, `"error ERC721IncorrectOwner(address sender, uint256 tokenId, address owner)"`, `"error ERC721InsufficientApproval(address operator, uint256 tokenId)"`, `"error ERC721InvalidApprover(address approver)"`, `"error ERC721InvalidOperator(address operator)"`, `"error ERC721InvalidOwner(address owner)"`, `"error ERC721InvalidReceiver(address receiver)"`, `"error ERC721InvalidSender(address sender)"`, `"error ERC721NonexistentToken(uint256 tokenId)"`, `"event Approval(address indexed owner, address indexed approved, uint256 indexed tokenId)"`, `"event ApprovalForAll(address indexed owner, address indexed operator, bool approved)"`, `"event Transfer(address indexed from, address indexed to, uint256 indexed tokenId)"`, `"function approve(address to, uint256 tokenId)"`, `"function balanceOf(address owner) view returns (uint256)"`, `"function getApproved(uint256 tokenId) view returns (address)"`, `"function isApprovedForAll(address owner, address operator) view returns (bool)"`, `"function name() view returns (string)"`, `"function ownerOf(uint256 tokenId) view returns (address)"`, `"function safeTransferFrom(address from, address to, uint256 tokenId)"`, `"function safeTransferFrom(address from, address to, uint256 tokenId, bytes data)"`, `"function setApprovalForAll(address operator, bool approved)"`, `"function supportsInterface(bytes4 interfaceId) view returns (bool)"`, `"function symbol() view returns (string)"`, `"function tokenURI(uint256 tokenId) view returns (string)"`, `"function transferFrom(address from, address to, uint256 tokenId)"`], `undefined`, `"0x608060405234801562000010575f80fd5b5060405162002174380380620021748339818101604052810190620000369190620001ea565b8181815f9081620000489190620004a4565b5080600190816200005a9190620004a4565b505050505062000588565b5f604051905090565b5f80fd5b5f80fd5b5f80fd5b5f80fd5b5f601f19601f8301169050919050565b7f4e487b71000000000000000000000000000000000000000000000000000000005f52604160045260245ffd5b620000c6826200007e565b810181811067ffffffffffffffff82111715620000e857620000e76200008e565b5b80604052505050565b5f620000fc62000065565b90506200010a8282620000bb565b919050565b5f67ffffffffffffffff8211156200012c576200012b6200008e565b5b62000137826200007e565b9050602081019050919050565b5f5b838110156200016357808201518184015260208101905062000146565b5f8484015250505050565b5f620001846200017e846200010f565b620000f1565b905082815260208101848484011115620001a357620001a26200007a565b5b620001b084828562000144565b509392505050565b5f82601f830112620001cf57620001ce62000076565b5b8151620001e18482602086016200016e565b91505092915050565b5f80604083850312156200020357620002026200006e565b5b5f83015167ffffffffffffffff81111562000223576200022262000072565b5b6200023185828601620001b8565b925050602083015167ffffffffffffffff81111562000255576200025462000072565b5b6200026385828601620001b8565b9150509250929050565b5f81519050919050565b7f4e487b71000000000000000000000000000000000000000000000000000000005f52602260045260245ffd5b5f6002820490506001821680620002bc57607f821691505b602082108103620002d257620002d162000277565b5b50919050565b5f819050815f5260205f209050919050565b5f6020601f8301049050919050565b5f82821b905092915050565b5f60088302620003367fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff82620002f9565b620003428683620002f9565b95508019841693508086168417925050509392505050565b5f819050919050565b5f819050919050565b5f6200038c6200038662000380846200035a565b62000363565b6200035a565b9050919050565b5f819050919050565b620003a7836200036c565b620003bf620003b68262000393565b84845462000305565b825550505050565b5f90565b620003d5620003c7565b620003e28184846200039c565b505050565b5b818110156200040957620003fd5f82620003cb565b600181019050620003e8565b5050565b601f82111562000458576200042281620002d8565b6200042d84620002ea565b810160208510156200043d578190505b620004556200044c85620002ea565b830182620003e7565b50505b505050565b5f82821c905092915050565b5f6200047a5f19846008026200045d565b1980831691505092915050565b5f62000494838362000469565b9150826002028217905092915050565b620004af826200026d565b67ffffffffffffffff811115620004cb57620004ca6200008e565b5b620004d78254620002a4565b620004e48282856200040d565b5f60209050601f8311600181146200051a575f841562000505578287015190505b62000511858262000487565b86555062000580565b601f1984166200052a86620002d8565b5f5b8281101562000553578489015182556001820191506020850194506020810190506200052c565b868310156200057357848901516200056f601f89168262000469565b8355505b6001600288020188555050505b505050505050565b611bde80620005965f395ff3fe608060405234801561000f575f80fd5b50600436106100cd575f3560e01c80636352211e1161008a578063a22cb46511610064578063a22cb46514610221578063b88d4fde1461023d578063c87b56dd14610259578063e985e9c514610289576100cd565b80636352211e146101a357806370a08231146101d357806395d89b4114610203576100cd565b806301ffc9a7146100d157806306fdde0314610101578063081812fc1461011f578063095ea7b31461014f57806323b872dd1461016b57806342842e0e14610187575b5f80fd5b6100eb60048036038101906100e6919061146f565b6102b9565b6040516100f891906114b4565b60405180910390f35b61010961039a565b6040516101169190611557565b60405180910390f35b610139600480360381019061013491906115aa565b610429565b6040516101469190611614565b60405180910390f35b61016960048036038101906101649190611657565b610444565b005b61018560048036038101906101809190611695565b61045a565b005b6101a1600480360381019061019c9190611695565b610559565b005b6101bd60048036038101906101b891906115aa565b610578565b6040516101ca9190611614565b60405180910390f35b6101ed60048036038101906101e891906116e5565b610589565b6040516101fa919061171f565b60405180910390f35b61020b61063f565b6040516102189190611557565b60405180910390f35b61023b60048036038101906102369190611762565b6106cf565b005b610257600480360381019061025291906118cc565b6106e5565b005b610273600480360381019061026e91906115aa565b610702565b6040516102809190611557565b60405180910390f35b6102a3600480360381019061029e919061194c565b610768565b6040516102b091906114b4565b60405180910390f35b5f7f80ac58cd000000000000000000000000000000000000000000000000000000007bffffffffffffffffffffffffffffffffffffffffffffffffffffffff1916827bffffffffffffffffffffffffffffffffffffffffffffffffffffffff1916148061038357507f5b5e139f000000000000000000000000000000000000000000000000000000007bffffffffffffffffffffffffffffffffffffffffffffffffffffffff1916827bffffffffffffffffffffffffffffffffffffffffffffffffffffffff1916145b806103935750610392826107f6565b5b9050919050565b60605f80546103a8906119b7565b80601f01602080910402602001604051908101604052809291908181526020018280546103d4906119b7565b801561041f5780601f106103f65761010080835404028352916020019161041f565b820191905f5260205f20905b81548152906001019060200180831161040257829003601f168201915b5050505050905090565b5f6104338261085f565b5061043d826108e5565b9050919050565b610456828261045161091e565b610925565b5050565b5f73ffffffffffffffffffffffffffffffffffffffff168273ffffffffffffffffffffffffffffffffffffffff16036104ca575f6040517f64a0ae920000000000000000000000000000000000000000000000000000000081526004016104c19190611614565b60405180910390fd5b5f6104dd83836104d861091e565b610937565b90508373ffffffffffffffffffffffffffffffffffffffff168173ffffffffffffffffffffffffffffffffffffffff1614610553578382826040517f64283d7b00000000000000000000000000000000000000000000000000000000815260040161054a939291906119e7565b60405180910390fd5b50505050565b61057383838360405180602001604052805f8152506106e5565b505050565b5f6105828261085f565b9050919050565b5f8073ffffffffffffffffffffffffffffffffffffffff168273ffffffffffffffffffffffffffffffffffffffff16036105fa575f6040517f89c62b640000000000000000000000000000000000000000000000000000000081526004016105f19190611614565b60405180910390fd5b60035f8373ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f20549050919050565b60606001805461064e906119b7565b80601f016020809104026020016040519081016040528092919081815260200182805461067a906119b7565b80156106c55780601f1061069c576101008083540402835291602001916106c5565b820191905f5260205f20905b8154815290600101906020018083116106a857829003601f168201915b5050505050905090565b6106e16106da61091e565b8383610b42565b5050565b6106f084848461045a565b6106fc84848484610cab565b50505050565b606061070d8261085f565b505f610717610e5d565b90505f8151116107355760405180602001604052805f815250610760565b8061073f84610e73565b604051602001610750929190611a56565b6040516020818303038152906040525b915050919050565b5f60055f8473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f8373ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f9054906101000a900460ff16905092915050565b5f7f01ffc9a7000000000000000000000000000000000000000000000000000000007bffffffffffffffffffffffffffffffffffffffffffffffffffffffff1916827bffffffffffffffffffffffffffffffffffffffffffffffffffffffff1916149050919050565b5f8061086a83610f3d565b90505f73ffffffffffffffffffffffffffffffffffffffff168173ffffffffffffffffffffffffffffffffffffffff16036108dc57826040517f7e2732890000000000000000000000000000000000000000000000000000000081526004016108d3919061171f565b60405180910390fd5b80915050919050565b5f60045f8381526020019081526020015f205f9054906101000a900473ffffffffffffffffffffffffffffffffffffffff169050919050565b5f33905090565b6109328383836001610f76565b505050565b5f8061094284610f3d565b90505f73ffffffffffffffffffffffffffffffffffffffff168373ffffffffffffffffffffffffffffffffffffffff161461098357610982818486611135565b5b5f73ffffffffffffffffffffffffffffffffffffffff168173ffffffffffffffffffffffffffffffffffffffff1614610a0e576109c25f855f80610f76565b600160035f8373ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f82825403925050819055505b5f73ffffffffffffffffffffffffffffffffffffffff168573ffffffffffffffffffffffffffffffffffffffff1614610a8d57600160035f8773ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f82825401925050819055505b8460025f8681526020019081526020015f205f6101000a81548173ffffffffffffffffffffffffffffffffffffffff021916908373ffffffffffffffffffffffffffffffffffffffff160217905550838573ffffffffffffffffffffffffffffffffffffffff168273ffffffffffffffffffffffffffffffffffffffff167fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef60405160405180910390a4809150509392505050565b5f73ffffffffffffffffffffffffffffffffffffffff168273ffffffffffffffffffffffffffffffffffffffff1603610bb257816040517f5b08ba18000000000000000000000000000000000000000000000000000000008152600401610ba99190611614565b60405180910390fd5b8060055f8573ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f8473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f6101000a81548160ff0219169083151502179055508173ffffffffffffffffffffffffffffffffffffffff168373ffffffffffffffffffffffffffffffffffffffff167f17307eab39ab6107e8899845ad3d59bd9653f200f220920489ca2b5937696c3183604051610c9e91906114b4565b60405180910390a3505050565b5f8373ffffffffffffffffffffffffffffffffffffffff163b1115610e57578273ffffffffffffffffffffffffffffffffffffffff1663150b7a02610cee61091e565b8685856040518563ffffffff1660e01b8152600401610d109493929190611acb565b6020604051808303815f875af1925050508015610d4b57506040513d601f19601f82011682018060405250810190610d489190611b29565b60015b610dcc573d805f8114610d79576040519150601f19603f3d011682016040523d82523d5f602084013e610d7e565b606091505b505f815103610dc457836040517f64a0ae92000000000000000000000000000000000000000000000000000000008152600401610dbb9190611614565b60405180910390fd5b805181602001fd5b63150b7a0260e01b7bffffffffffffffffffffffffffffffffffffffffffffffffffffffff1916817bffffffffffffffffffffffffffffffffffffffffffffffffffffffff191614610e5557836040517f64a0ae92000000000000000000000000000000000000000000000000000000008152600401610e4c9190611614565b60405180910390fd5b505b50505050565b606060405180602001604052805f815250905090565b60605f6001610e81846111f8565b0190505f8167ffffffffffffffff811115610e9f57610e9e6117a8565b5b6040519080825280601f01601f191660200182016040528015610ed15781602001600182028036833780820191505090505b5090505f82602001820190505b600115610f32578080600190039150507f3031323334353637383961626364656600000000000000000000000000000000600a86061a8153600a8581610f2757610f26611b54565b5b0494505f8503610ede575b819350505050919050565b5f60025f8381526020019081526020015f205f9054906101000a900473ffffffffffffffffffffffffffffffffffffffff169050919050565b8080610fae57505f73ffffffffffffffffffffffffffffffffffffffff168273ffffffffffffffffffffffffffffffffffffffff1614155b156110e0575f610fbd8461085f565b90505f73ffffffffffffffffffffffffffffffffffffffff168373ffffffffffffffffffffffffffffffffffffffff161415801561102757508273ffffffffffffffffffffffffffffffffffffffff168173ffffffffffffffffffffffffffffffffffffffff1614155b801561103a57506110388184610768565b155b1561107c57826040517fa9fbf51f0000000000000000000000000000000000000000000000000000000081526004016110739190611614565b60405180910390fd5b81156110de57838573ffffffffffffffffffffffffffffffffffffffff168273ffffffffffffffffffffffffffffffffffffffff167f8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b92560405160405180910390a45b505b8360045f8581526020019081526020015f205f6101000a81548173ffffffffffffffffffffffffffffffffffffffff021916908373ffffffffffffffffffffffffffffffffffffffff16021790555050505050565b611140838383611349565b6111f3575f73ffffffffffffffffffffffffffffffffffffffff168373ffffffffffffffffffffffffffffffffffffffff16036111b457806040517f7e2732890000000000000000000000000000000000000000000000000000000081526004016111ab919061171f565b60405180910390fd5b81816040517f177e802f0000000000000000000000000000000000000000000000000000000081526004016111ea929190611b81565b60405180910390fd5b505050565b5f805f90507a184f03e93ff9f4daa797ed6e38ed64bf6a1f0100000000000000008310611254577a184f03e93ff9f4daa797ed6e38ed64bf6a1f010000000000000000838161124a57611249611b54565b5b0492506040810190505b6d04ee2d6d415b85acef81000000008310611291576d04ee2d6d415b85acef8100000000838161128757611286611b54565b5b0492506020810190505b662386f26fc1000083106112c057662386f26fc1000083816112b6576112b5611b54565b5b0492506010810190505b6305f5e10083106112e9576305f5e10083816112df576112de611b54565b5b0492506008810190505b612710831061130e57612710838161130457611303611b54565b5b0492506004810190505b60648310611331576064838161132757611326611b54565b5b0492506002810190505b600a8310611340576001810190505b80915050919050565b5f8073ffffffffffffffffffffffffffffffffffffffff168373ffffffffffffffffffffffffffffffffffffffff161415801561140057508273ffffffffffffffffffffffffffffffffffffffff168473ffffffffffffffffffffffffffffffffffffffff1614806113c157506113c08484610768565b5b806113ff57508273ffffffffffffffffffffffffffffffffffffffff166113e7836108e5565b73ffffffffffffffffffffffffffffffffffffffff16145b5b90509392505050565b5f604051905090565b5f80fd5b5f80fd5b5f7fffffffff0000000000000000000000000000000000000000000000000000000082169050919050565b61144e8161141a565b8114611458575f80fd5b50565b5f8135905061146981611445565b92915050565b5f6020828403121561148457611483611412565b5b5f6114918482850161145b565b91505092915050565b5f8115159050919050565b6114ae8161149a565b82525050565b5f6020820190506114c75f8301846114a5565b92915050565b5f81519050919050565b5f82825260208201905092915050565b5f5b838110156115045780820151818401526020810190506114e9565b5f8484015250505050565b5f601f19601f8301169050919050565b5f611529826114cd565b61153381856114d7565b93506115438185602086016114e7565b61154c8161150f565b840191505092915050565b5f6020820190508181035f83015261156f818461151f565b905092915050565b5f819050919050565b61158981611577565b8114611593575f80fd5b50565b5f813590506115a481611580565b92915050565b5f602082840312156115bf576115be611412565b5b5f6115cc84828501611596565b91505092915050565b5f73ffffffffffffffffffffffffffffffffffffffff82169050919050565b5f6115fe826115d5565b9050919050565b61160e816115f4565b82525050565b5f6020820190506116275f830184611605565b92915050565b611636816115f4565b8114611640575f80fd5b50565b5f813590506116518161162d565b92915050565b5f806040838503121561166d5761166c611412565b5b5f61167a85828601611643565b925050602061168b85828601611596565b9150509250929050565b5f805f606084860312156116ac576116ab611412565b5b5f6116b986828701611643565b93505060206116ca86828701611643565b92505060406116db86828701611596565b9150509250925092565b5f602082840312156116fa576116f9611412565b5b5f61170784828501611643565b91505092915050565b61171981611577565b82525050565b5f6020820190506117325f830184611710565b92915050565b6117418161149a565b811461174b575f80fd5b50565b5f8135905061175c81611738565b92915050565b5f806040838503121561177857611777611412565b5b5f61178585828601611643565b92505060206117968582860161174e565b9150509250929050565b5f80fd5b5f80fd5b7f4e487b71000000000000000000000000000000000000000000000000000000005f52604160045260245ffd5b6117de8261150f565b810181811067ffffffffffffffff821117156117fd576117fc6117a8565b5b80604052505050565b5f61180f611409565b905061181b82826117d5565b919050565b5f67ffffffffffffffff82111561183a576118396117a8565b5b6118438261150f565b9050602081019050919050565b828183375f83830152505050565b5f61187061186b84611820565b611806565b90508281526020810184848401111561188c5761188b6117a4565b5b611897848285611850565b509392505050565b5f82601f8301126118b3576118b26117a0565b5b81356118c384826020860161185e565b91505092915050565b5f805f80608085870312156118e4576118e3611412565b5b5f6118f187828801611643565b945050602061190287828801611643565b935050604061191387828801611596565b925050606085013567ffffffffffffffff81111561193457611933611416565b5b6119408782880161189f565b91505092959194509250565b5f806040838503121561196257611961611412565b5b5f61196f85828601611643565b925050602061198085828601611643565b9150509250929050565b7f4e487b71000000000000000000000000000000000000000000000000000000005f52602260045260245ffd5b5f60028204905060018216806119ce57607f821691505b6020821081036119e1576119e061198a565b5b50919050565b5f6060820190506119fa5f830186611605565b611a076020830185611710565b611a146040830184611605565b949350505050565b5f81905092915050565b5f611a30826114cd565b611a3a8185611a1c565b9350611a4a8185602086016114e7565b80840191505092915050565b5f611a618285611a26565b9150611a6d8284611a26565b91508190509392505050565b5f81519050919050565b5f82825260208201905092915050565b5f611a9d82611a79565b611aa78185611a83565b9350611ab78185602086016114e7565b611ac08161150f565b840191505092915050565b5f608082019050611ade5f830187611605565b611aeb6020830186611605565b611af86040830185611710565b8181036060830152611b0a8184611a93565b905095945050505050565b5f81519050611b2381611445565b92915050565b5f60208284031215611b3e57611b3d611412565b5b5f611b4b84828501611b15565b91505092915050565b7f4e487b71000000000000000000000000000000000000000000000000000000005f52601260045260245ffd5b5f604082019050611b945f830185611605565b611ba16020830184611710565b939250505056fea2646970667358221220660c47cef4875784ced30d2987fb0203ddda8f97b11c21c4a3205a82e611b4d064736f6c63430008160033"`, `"0x608060405234801561000f575f80fd5b50600436106100cd575f3560e01c80636352211e1161008a578063a22cb46511610064578063a22cb46514610221578063b88d4fde1461023d578063c87b56dd14610259578063e985e9c514610289576100cd565b80636352211e146101a357806370a08231146101d357806395d89b4114610203576100cd565b806301ffc9a7146100d157806306fdde0314610101578063081812fc1461011f578063095ea7b31461014f57806323b872dd1461016b57806342842e0e14610187575b5f80fd5b6100eb60048036038101906100e6919061146f565b6102b9565b6040516100f891906114b4565b60405180910390f35b61010961039a565b6040516101169190611557565b60405180910390f35b610139600480360381019061013491906115aa565b610429565b6040516101469190611614565b60405180910390f35b61016960048036038101906101649190611657565b610444565b005b61018560048036038101906101809190611695565b61045a565b005b6101a1600480360381019061019c9190611695565b610559565b005b6101bd60048036038101906101b891906115aa565b610578565b6040516101ca9190611614565b60405180910390f35b6101ed60048036038101906101e891906116e5565b610589565b6040516101fa919061171f565b60405180910390f35b61020b61063f565b6040516102189190611557565b60405180910390f35b61023b60048036038101906102369190611762565b6106cf565b005b610257600480360381019061025291906118cc565b6106e5565b005b610273600480360381019061026e91906115aa565b610702565b6040516102809190611557565b60405180910390f35b6102a3600480360381019061029e919061194c565b610768565b6040516102b091906114b4565b60405180910390f35b5f7f80ac58cd000000000000000000000000000000000000000000000000000000007bffffffffffffffffffffffffffffffffffffffffffffffffffffffff1916827bffffffffffffffffffffffffffffffffffffffffffffffffffffffff1916148061038357507f5b5e139f000000000000000000000000000000000000000000000000000000007bffffffffffffffffffffffffffffffffffffffffffffffffffffffff1916827bffffffffffffffffffffffffffffffffffffffffffffffffffffffff1916145b806103935750610392826107f6565b5b9050919050565b60605f80546103a8906119b7565b80601f01602080910402602001604051908101604052809291908181526020018280546103d4906119b7565b801561041f5780601f106103f65761010080835404028352916020019161041f565b820191905f5260205f20905b81548152906001019060200180831161040257829003601f168201915b5050505050905090565b5f6104338261085f565b5061043d826108e5565b9050919050565b610456828261045161091e565b610925565b5050565b5f73ffffffffffffffffffffffffffffffffffffffff168273ffffffffffffffffffffffffffffffffffffffff16036104ca575f6040517f64a0ae920000000000000000000000000000000000000000000000000000000081526004016104c19190611614565b60405180910390fd5b5f6104dd83836104d861091e565b610937565b90508373ffffffffffffffffffffffffffffffffffffffff168173ffffffffffffffffffffffffffffffffffffffff1614610553578382826040517f64283d7b00000000000000000000000000000000000000000000000000000000815260040161054a939291906119e7565b60405180910390fd5b50505050565b61057383838360405180602001604052805f8152506106e5565b505050565b5f6105828261085f565b9050919050565b5f8073ffffffffffffffffffffffffffffffffffffffff168273ffffffffffffffffffffffffffffffffffffffff16036105fa575f6040517f89c62b640000000000000000000000000000000000000000000000000000000081526004016105f19190611614565b60405180910390fd5b60035f8373ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f20549050919050565b60606001805461064e906119b7565b80601f016020809104026020016040519081016040528092919081815260200182805461067a906119b7565b80156106c55780601f1061069c576101008083540402835291602001916106c5565b820191905f5260205f20905b8154815290600101906020018083116106a857829003601f168201915b5050505050905090565b6106e16106da61091e565b8383610b42565b5050565b6106f084848461045a565b6106fc84848484610cab565b50505050565b606061070d8261085f565b505f610717610e5d565b90505f8151116107355760405180602001604052805f815250610760565b8061073f84610e73565b604051602001610750929190611a56565b6040516020818303038152906040525b915050919050565b5f60055f8473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f8373ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f9054906101000a900460ff16905092915050565b5f7f01ffc9a7000000000000000000000000000000000000000000000000000000007bffffffffffffffffffffffffffffffffffffffffffffffffffffffff1916827bffffffffffffffffffffffffffffffffffffffffffffffffffffffff1916149050919050565b5f8061086a83610f3d565b90505f73ffffffffffffffffffffffffffffffffffffffff168173ffffffffffffffffffffffffffffffffffffffff16036108dc57826040517f7e2732890000000000000000000000000000000000000000000000000000000081526004016108d3919061171f565b60405180910390fd5b80915050919050565b5f60045f8381526020019081526020015f205f9054906101000a900473ffffffffffffffffffffffffffffffffffffffff169050919050565b5f33905090565b6109328383836001610f76565b505050565b5f8061094284610f3d565b90505f73ffffffffffffffffffffffffffffffffffffffff168373ffffffffffffffffffffffffffffffffffffffff161461098357610982818486611135565b5b5f73ffffffffffffffffffffffffffffffffffffffff168173ffffffffffffffffffffffffffffffffffffffff1614610a0e576109c25f855f80610f76565b600160035f8373ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f82825403925050819055505b5f73ffffffffffffffffffffffffffffffffffffffff168573ffffffffffffffffffffffffffffffffffffffff1614610a8d57600160035f8773ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f82825401925050819055505b8460025f8681526020019081526020015f205f6101000a81548173ffffffffffffffffffffffffffffffffffffffff021916908373ffffffffffffffffffffffffffffffffffffffff160217905550838573ffffffffffffffffffffffffffffffffffffffff168273ffffffffffffffffffffffffffffffffffffffff167fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef60405160405180910390a4809150509392505050565b5f73ffffffffffffffffffffffffffffffffffffffff168273ffffffffffffffffffffffffffffffffffffffff1603610bb257816040517f5b08ba18000000000000000000000000000000000000000000000000000000008152600401610ba99190611614565b60405180910390fd5b8060055f8573ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f8473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f6101000a81548160ff0219169083151502179055508173ffffffffffffffffffffffffffffffffffffffff168373ffffffffffffffffffffffffffffffffffffffff167f17307eab39ab6107e8899845ad3d59bd9653f200f220920489ca2b5937696c3183604051610c9e91906114b4565b60405180910390a3505050565b5f8373ffffffffffffffffffffffffffffffffffffffff163b1115610e57578273ffffffffffffffffffffffffffffffffffffffff1663150b7a02610cee61091e565b8685856040518563ffffffff1660e01b8152600401610d109493929190611acb565b6020604051808303815f875af1925050508015610d4b57506040513d601f19601f82011682018060405250810190610d489190611b29565b60015b610dcc573d805f8114610d79576040519150601f19603f3d011682016040523d82523d5f602084013e610d7e565b606091505b505f815103610dc457836040517f64a0ae92000000000000000000000000000000000000000000000000000000008152600401610dbb9190611614565b60405180910390fd5b805181602001fd5b63150b7a0260e01b7bffffffffffffffffffffffffffffffffffffffffffffffffffffffff1916817bffffffffffffffffffffffffffffffffffffffffffffffffffffffff191614610e5557836040517f64a0ae92000000000000000000000000000000000000000000000000000000008152600401610e4c9190611614565b60405180910390fd5b505b50505050565b606060405180602001604052805f815250905090565b60605f6001610e81846111f8565b0190505f8167ffffffffffffffff811115610e9f57610e9e6117a8565b5b6040519080825280601f01601f191660200182016040528015610ed15781602001600182028036833780820191505090505b5090505f82602001820190505b600115610f32578080600190039150507f3031323334353637383961626364656600000000000000000000000000000000600a86061a8153600a8581610f2757610f26611b54565b5b0494505f8503610ede575b819350505050919050565b5f60025f8381526020019081526020015f205f9054906101000a900473ffffffffffffffffffffffffffffffffffffffff169050919050565b8080610fae57505f73ffffffffffffffffffffffffffffffffffffffff168273ffffffffffffffffffffffffffffffffffffffff1614155b156110e0575f610fbd8461085f565b90505f73ffffffffffffffffffffffffffffffffffffffff168373ffffffffffffffffffffffffffffffffffffffff161415801561102757508273ffffffffffffffffffffffffffffffffffffffff168173ffffffffffffffffffffffffffffffffffffffff1614155b801561103a57506110388184610768565b155b1561107c57826040517fa9fbf51f0000000000000000000000000000000000000000000000000000000081526004016110739190611614565b60405180910390fd5b81156110de57838573ffffffffffffffffffffffffffffffffffffffff168273ffffffffffffffffffffffffffffffffffffffff167f8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b92560405160405180910390a45b505b8360045f8581526020019081526020015f205f6101000a81548173ffffffffffffffffffffffffffffffffffffffff021916908373ffffffffffffffffffffffffffffffffffffffff16021790555050505050565b611140838383611349565b6111f3575f73ffffffffffffffffffffffffffffffffffffffff168373ffffffffffffffffffffffffffffffffffffffff16036111b457806040517f7e2732890000000000000000000000000000000000000000000000000000000081526004016111ab919061171f565b60405180910390fd5b81816040517f177e802f0000000000000000000000000000000000000000000000000000000081526004016111ea929190611b81565b60405180910390fd5b505050565b5f805f90507a184f03e93ff9f4daa797ed6e38ed64bf6a1f0100000000000000008310611254577a184f03e93ff9f4daa797ed6e38ed64bf6a1f010000000000000000838161124a57611249611b54565b5b0492506040810190505b6d04ee2d6d415b85acef81000000008310611291576d04ee2d6d415b85acef8100000000838161128757611286611b54565b5b0492506020810190505b662386f26fc1000083106112c057662386f26fc1000083816112b6576112b5611b54565b5b0492506010810190505b6305f5e10083106112e9576305f5e10083816112df576112de611b54565b5b0492506008810190505b612710831061130e57612710838161130457611303611b54565b5b0492506004810190505b60648310611331576064838161132757611326611b54565b5b0492506002810190505b600a8310611340576001810190505b80915050919050565b5f8073ffffffffffffffffffffffffffffffffffffffff168373ffffffffffffffffffffffffffffffffffffffff161415801561140057508273ffffffffffffffffffffffffffffffffffffffff168473ffffffffffffffffffffffffffffffffffffffff1614806113c157506113c08484610768565b5b806113ff57508273ffffffffffffffffffffffffffffffffffffffff166113e7836108e5565b73ffffffffffffffffffffffffffffffffffffffff16145b5b90509392505050565b5f604051905090565b5f80fd5b5f80fd5b5f7fffffffff0000000000000000000000000000000000000000000000000000000082169050919050565b61144e8161141a565b8114611458575f80fd5b50565b5f8135905061146981611445565b92915050565b5f6020828403121561148457611483611412565b5b5f6114918482850161145b565b91505092915050565b5f8115159050919050565b6114ae8161149a565b82525050565b5f6020820190506114c75f8301846114a5565b92915050565b5f81519050919050565b5f82825260208201905092915050565b5f5b838110156115045780820151818401526020810190506114e9565b5f8484015250505050565b5f601f19601f8301169050919050565b5f611529826114cd565b61153381856114d7565b93506115438185602086016114e7565b61154c8161150f565b840191505092915050565b5f6020820190508181035f83015261156f818461151f565b905092915050565b5f819050919050565b61158981611577565b8114611593575f80fd5b50565b5f813590506115a481611580565b92915050565b5f602082840312156115bf576115be611412565b5b5f6115cc84828501611596565b91505092915050565b5f73ffffffffffffffffffffffffffffffffffffffff82169050919050565b5f6115fe826115d5565b9050919050565b61160e816115f4565b82525050565b5f6020820190506116275f830184611605565b92915050565b611636816115f4565b8114611640575f80fd5b50565b5f813590506116518161162d565b92915050565b5f806040838503121561166d5761166c611412565b5b5f61167a85828601611643565b925050602061168b85828601611596565b9150509250929050565b5f805f606084860312156116ac576116ab611412565b5b5f6116b986828701611643565b93505060206116ca86828701611643565b92505060406116db86828701611596565b9150509250925092565b5f602082840312156116fa576116f9611412565b5b5f61170784828501611643565b91505092915050565b61171981611577565b82525050565b5f6020820190506117325f830184611710565b92915050565b6117418161149a565b811461174b575f80fd5b50565b5f8135905061175c81611738565b92915050565b5f806040838503121561177857611777611412565b5b5f61178585828601611643565b92505060206117968582860161174e565b9150509250929050565b5f80fd5b5f80fd5b7f4e487b71000000000000000000000000000000000000000000000000000000005f52604160045260245ffd5b6117de8261150f565b810181811067ffffffffffffffff821117156117fd576117fc6117a8565b5b80604052505050565b5f61180f611409565b905061181b82826117d5565b919050565b5f67ffffffffffffffff82111561183a576118396117a8565b5b6118438261150f565b9050602081019050919050565b828183375f83830152505050565b5f61187061186b84611820565b611806565b90508281526020810184848401111561188c5761188b6117a4565b5b611897848285611850565b509392505050565b5f82601f8301126118b3576118b26117a0565b5b81356118c384826020860161185e565b91505092915050565b5f805f80608085870312156118e4576118e3611412565b5b5f6118f187828801611643565b945050602061190287828801611643565b935050604061191387828801611596565b925050606085013567ffffffffffffffff81111561193457611933611416565b5b6119408782880161189f565b91505092959194509250565b5f806040838503121561196257611961611412565b5b5f61196f85828601611643565b925050602061198085828601611643565b9150509250929050565b7f4e487b71000000000000000000000000000000000000000000000000000000005f52602260045260245ffd5b5f60028204905060018216806119ce57607f821691505b6020821081036119e1576119e061198a565b5b50919050565b5f6060820190506119fa5f830186611605565b611a076020830185611710565b611a146040830184611605565b949350505050565b5f81905092915050565b5f611a30826114cd565b611a3a8185611a1c565b9350611a4a8185602086016114e7565b80840191505092915050565b5f611a618285611a26565b9150611a6d8284611a26565b91508190509392505050565b5f81519050919050565b5f82825260208201905092915050565b5f611a9d82611a79565b611aa78185611a83565b9350611ab78185602086016114e7565b611ac08161150f565b840191505092915050565b5f608082019050611ade5f830187611605565b611aeb6020830186611605565b611af86040830185611710565b8181036060830152611b0a8184611a93565b905095945050505050565b5f81519050611b2381611445565b92915050565b5f60208284031215611b3e57611b3d611412565b5b5f611b4b84828501611b15565b91505092915050565b7f4e487b71000000000000000000000000000000000000000000000000000000005f52601260045260245ffd5b5f604082019050611b945f830185611605565b611ba16020830184611710565b939250505056fea2646970667358221220660c47cef4875784ced30d2987fb0203ddda8f97b11c21c4a3205a82e611b4d064736f6c63430008160033"`, `undefined`\> -Bytecode and ABI for the ERC721 contract from open zeppelin. +Bytecode and ABI for the ERC721 contract from OpenZeppelin. +This constant represents a standard ERC721 token implementation for non-fungible tokens (NFTs). +For more details, see the [OpenZeppelin ERC721 documentation](https://docs.openzeppelin.com/contracts/4.x/erc721). + +## Examples + +Using the ERC721 contract in a deployment script: +```typescript +import { ERC721 } from 'tevm/contract' + +// Deploy the ERC721 contract +const deployedERC721 = await tevm.deployContract(ERC721.deploy('MyNFT', 'MNFT')) +console.log('ERC721 deployed at:', deployedERC721.address) + +// Interact with the deployed contract +const owner = await tevm.contract(ERC721.read.ownerOf(deployedERC721.address, 1n)) +console.log('Owner of token 1:', owner) +``` + +Using the ERC721 contract with an existing deployment: +```typescript +import { ERC721 } from 'tevm/contract' + +const existingERC721 = ERC721.withAddress('0x1234...') + +// Read token name +const name = await tevm.contract(existingERC721.read.name()) +console.log('Token name:', name) + +// Transfer token +await tevm.contract(existingERC721.write.transferFrom('0xabcd...', '0x5678...', 1n)) +``` ## Defined in -[contract-lib/ERC721.ts:39](https://github.com/evmts/tevm-monorepo/blob/main/packages/contract/src/contract-lib/ERC721.ts#L39) +[contract-lib/ERC721.ts:71](https://github.com/evmts/tevm-monorepo/blob/main/packages/contract/src/contract-lib/ERC721.ts#L71) diff --git a/docs/src/content/docs/reference/@tevm/contract/variables/SimpleContract.md b/docs/src/content/docs/reference/@tevm/contract/variables/SimpleContract.md index cb3af99a8c..2214379f06 100644 --- a/docs/src/content/docs/reference/@tevm/contract/variables/SimpleContract.md +++ b/docs/src/content/docs/reference/@tevm/contract/variables/SimpleContract.md @@ -7,6 +7,39 @@ title: "SimpleContract" > `const` **SimpleContract**: [`Contract`](/reference/tevm/contract/type-aliases/contract/)\<`"SimpleContract"`, readonly [`"constructor(uint256 initialValue)"`, `"event ValueSet(uint256 newValue)"`, `"function get() view returns (uint256)"`, `"function set(uint256 newValue)"`], `undefined`, `"0x608060405234801561000f575f80fd5b5060405161022638038061022683398181016040528101906100319190610074565b805f819055505061009f565b5f80fd5b5f819050919050565b61005381610041565b811461005d575f80fd5b50565b5f8151905061006e8161004a565b92915050565b5f602082840312156100895761008861003d565b5b5f61009684828501610060565b91505092915050565b61017a806100ac5f395ff3fe608060405234801561000f575f80fd5b5060043610610034575f3560e01c806360fe47b1146100385780636d4ce63c14610054575b5f80fd5b610052600480360381019061004d91906100f1565b610072565b005b61005c6100b2565b604051610069919061012b565b60405180910390f35b805f819055507f012c78e2b84325878b1bd9d250d772cfe5bda7722d795f45036fa5e1e6e303fc816040516100a7919061012b565b60405180910390a150565b5f8054905090565b5f80fd5b5f819050919050565b6100d0816100be565b81146100da575f80fd5b50565b5f813590506100eb816100c7565b92915050565b5f60208284031215610106576101056100ba565b5b5f610113848285016100dd565b91505092915050565b610125816100be565b82525050565b5f60208201905061013e5f83018461011c565b9291505056fea2646970667358221220792d4ee4a770b6a319a0ec659b77ea24497824649e20dcdea1dd7acf6118a5fe64736f6c63430008160033"`, `"0x608060405234801561000f575f80fd5b5060043610610034575f3560e01c806360fe47b1146100385780636d4ce63c14610054575b5f80fd5b610052600480360381019061004d91906100f1565b610072565b005b61005c6100b2565b604051610069919061012b565b60405180910390f35b805f819055507f012c78e2b84325878b1bd9d250d772cfe5bda7722d795f45036fa5e1e6e303fc816040516100a7919061012b565b60405180910390a150565b5f8054905090565b5f80fd5b5f819050919050565b6100d0816100be565b81146100da575f80fd5b50565b5f813590506100eb816100c7565b92915050565b5f60208284031215610106576101056100ba565b5b5f610113848285016100dd565b91505092915050565b610125816100be565b82525050565b5f60208201905061013e5f83018461011c565b9291505056fea2646970667358221220792d4ee4a770b6a319a0ec659b77ea24497824649e20dcdea1dd7acf6118a5fe64736f6c63430008160033"`, `undefined`\> +Bytecode and ABI for a simple contract with a single state variable. +This constant represents a basic contract that can get and set a uint256 value. + +## Examples + +Using the SimpleContract in a deployment script: +```typescript +import { SimpleContract } from 'tevm/contract' + +// Deploy the SimpleContract with an initial value +const deployedSimpleContract = await tevm.deployContract(SimpleContract.deploy(42n)) +console.log('SimpleContract deployed at:', deployedSimpleContract.address) + +// Interact with the deployed contract +const value = await tevm.contract(SimpleContract.read.get()) +console.log('Current value:', value) +``` + +Using the SimpleContract with an existing deployment: +```typescript +import { SimpleContract } from 'tevm/contract' + +const existingSimpleContract = SimpleContract.withAddress('0x1234...') + +// Read current value +const currentValue = await tevm.contract(existingSimpleContract.read.get()) +console.log('Current value:', currentValue) + +// Set a new value +await tevm.contract(existingSimpleContract.write.set(100n)) +console.log('New value set') +``` + ## Defined in -[contract-lib/SimpleContract.s.sol.ts:15](https://github.com/evmts/tevm-monorepo/blob/main/packages/contract/src/contract-lib/SimpleContract.s.sol.ts#L15) +[contract-lib/SimpleContract.s.sol.ts:50](https://github.com/evmts/tevm-monorepo/blob/main/packages/contract/src/contract-lib/SimpleContract.s.sol.ts#L50) diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/AccountLockedError.md b/docs/src/content/docs/reference/@tevm/errors/classes/AccountLockedError.md index ddea3de9d1..34b780cf6b 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/AccountLockedError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/AccountLockedError.md @@ -9,17 +9,25 @@ Represents an error that occurs when an account is locked. This error is typically encountered when an operation is attempted on an account that has been locked for security reasons. This might happen if the account has -been temporarily disabled or if additional authentication is required. +been temporarily disabled, if additional authentication is required, or if the +account's private key is not available to the node. + +The error code -32005 is a non-standard extension used by some Ethereum clients to +indicate this specific condition. ## Example ```ts try { - // Some operation that can throw an AccountLockedError + await client.sendTransaction({ + from: '0x1234567890123456789012345678901234567890', + to: '0x0987654321098765432109876543210987654321', + value: '0x1' + }) } catch (error) { if (error instanceof AccountLockedError) { - console.error(error.message); - // Handle the account locked error + console.error('Account locked:', error.message); + console.log('Unlock the account or use a different account for this transaction'); } } ``` @@ -68,7 +76,7 @@ The tag for the error. #### Defined in -[packages/errors/src/ethereum/AccountLockedError.js:51](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/AccountLockedError.js#L51) +[packages/errors/src/ethereum/AccountLockedError.js:58](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/AccountLockedError.js#L58) ## Properties @@ -84,7 +92,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/AccountLockedError.js:71](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/AccountLockedError.js#L71) *** @@ -98,7 +106,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -106,7 +114,7 @@ Same as name, used internally. > **code**: `number` -Error code, analogous to the code in JSON RPC error. +Error code (-32005), a non-standard extension for this specific error. #### Inherited from @@ -114,7 +122,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -128,7 +136,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -144,7 +152,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -176,7 +184,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -192,7 +200,7 @@ The name of the error, used to discriminate errors. #### Defined in -node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1076 +[packages/errors/src/ethereum/AccountLockedError.js:70](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/AccountLockedError.js#L70) *** @@ -206,7 +214,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -234,7 +242,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -306,7 +314,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/AccountNotFoundError.md b/docs/src/content/docs/reference/@tevm/errors/classes/AccountNotFoundError.md index 0464a5f496..0b10e2b9a8 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/AccountNotFoundError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/AccountNotFoundError.md @@ -82,7 +82,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -96,7 +96,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -112,7 +112,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -126,7 +126,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -142,7 +142,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -174,7 +174,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -204,7 +204,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -232,7 +232,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -304,7 +304,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/AuthCallUnsetError.md b/docs/src/content/docs/reference/@tevm/errors/classes/AuthCallUnsetError.md index f265f4d79f..88966f34af 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/AuthCallUnsetError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/AuthCallUnsetError.md @@ -96,7 +96,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -110,7 +110,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -126,7 +126,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -140,7 +140,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -156,7 +156,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -200,7 +200,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -230,7 +230,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -258,7 +258,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -340,7 +340,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/BLS12381FpNotInFieldError.md b/docs/src/content/docs/reference/@tevm/errors/classes/BLS12381FpNotInFieldError.md index 75ab4b63b2..b56960b9bc 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/BLS12381FpNotInFieldError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/BLS12381FpNotInFieldError.md @@ -88,7 +88,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -102,7 +102,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -118,7 +118,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -132,7 +132,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -148,7 +148,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -192,7 +192,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -222,7 +222,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -250,7 +250,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -332,7 +332,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/BLS12381InputEmptyError.md b/docs/src/content/docs/reference/@tevm/errors/classes/BLS12381InputEmptyError.md index b28b934e76..e4d9a535d3 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/BLS12381InputEmptyError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/BLS12381InputEmptyError.md @@ -88,7 +88,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -102,7 +102,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -118,7 +118,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -132,7 +132,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -148,7 +148,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -180,7 +180,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -210,7 +210,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -238,7 +238,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -320,7 +320,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/BLS12381InvalidInputLengthError.md b/docs/src/content/docs/reference/@tevm/errors/classes/BLS12381InvalidInputLengthError.md index 8ea0e488c7..24748e1051 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/BLS12381InvalidInputLengthError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/BLS12381InvalidInputLengthError.md @@ -88,7 +88,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -102,7 +102,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -118,7 +118,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -132,7 +132,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -148,7 +148,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -180,7 +180,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -210,7 +210,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -238,7 +238,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -320,7 +320,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/BLS12381PointNotOnCurveError.md b/docs/src/content/docs/reference/@tevm/errors/classes/BLS12381PointNotOnCurveError.md index 61d080cb00..63938628dc 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/BLS12381PointNotOnCurveError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/BLS12381PointNotOnCurveError.md @@ -88,7 +88,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -102,7 +102,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -118,7 +118,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -132,7 +132,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -148,7 +148,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -180,7 +180,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -210,7 +210,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -238,7 +238,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -320,7 +320,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/BaseError.md b/docs/src/content/docs/reference/@tevm/errors/classes/BaseError.md index e240f60fc0..810e7279c1 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/BaseError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/BaseError.md @@ -8,10 +8,10 @@ title: "BaseError" Base class for custom errors in TEVM. This class is abstract and should be extended by other error classes. -## Implements - ## Abstract +## Implements + ## Extends - `Error` @@ -86,7 +86,7 @@ Error code analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:44](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L44) +[packages/errors/src/ethereum/BaseError.js:45](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L45) ## Properties @@ -96,7 +96,7 @@ Error code analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -110,7 +110,7 @@ Error code analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -120,7 +120,7 @@ Error code analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -130,7 +130,7 @@ Error code analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -140,7 +140,7 @@ Error code analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -164,7 +164,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -188,7 +188,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -212,7 +212,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -280,7 +280,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/BlockGasLimitExceededError.md b/docs/src/content/docs/reference/@tevm/errors/classes/BlockGasLimitExceededError.md index a29615827f..36cde16cf8 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/BlockGasLimitExceededError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/BlockGasLimitExceededError.md @@ -7,17 +7,24 @@ title: "BlockGasLimitExceededError" Represents an error that occurs when the block gas limit has been exceeded. -This error is typically encountered when a transaction or set of transactions exceed the gas limit for a block. +This error is typically encountered when a transaction or set of transactions in a block +consume more gas than the block's gas limit allows. Each block in Ethereum has a maximum +amount of gas that can be used by all transactions within it. + +The error code -32006 is a non-standard extension used by some Ethereum clients to +indicate this specific condition. ## Example ```ts try { - // Some operation that can throw a BlockGasLimitExceededError + const result = await client.sendTransaction({ + // ... transaction details + }) } catch (error) { if (error instanceof BlockGasLimitExceededError) { - console.error(error.message); - // Handle the block gas limit exceeded error + console.error('Block gas limit exceeded:', error.message); + console.log('Consider splitting the transaction or waiting for a block with more available gas'); } } ``` @@ -66,7 +73,7 @@ The tag for the error. #### Defined in -[packages/errors/src/ethereum/BlockGasLimitExceededError.js:49](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BlockGasLimitExceededError.js#L49) +[packages/errors/src/ethereum/BlockGasLimitExceededError.js:55](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BlockGasLimitExceededError.js#L55) ## Properties @@ -82,7 +89,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BlockGasLimitExceededError.js:71](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BlockGasLimitExceededError.js#L71) +[packages/errors/src/ethereum/BlockGasLimitExceededError.js:77](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BlockGasLimitExceededError.js#L77) *** @@ -96,7 +103,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -104,7 +111,7 @@ Same as name, used internally. > **code**: `number` -Error code, analogous to the code in JSON RPC error. +Error code (-32006), a non-standard extension for this specific error. #### Inherited from @@ -112,7 +119,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -126,7 +133,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -142,7 +149,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -170,7 +177,7 @@ Optional object containing additional information about the error. #### Defined in -[packages/errors/src/ethereum/BlockGasLimitExceededError.js:64](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BlockGasLimitExceededError.js#L64) +[packages/errors/src/ethereum/BlockGasLimitExceededError.js:70](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BlockGasLimitExceededError.js#L70) *** @@ -186,7 +193,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -202,7 +209,7 @@ The name of the error, used to discriminate errors. #### Defined in -[packages/errors/src/ethereum/BlockGasLimitExceededError.js:77](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BlockGasLimitExceededError.js#L77) +[packages/errors/src/ethereum/BlockGasLimitExceededError.js:83](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BlockGasLimitExceededError.js#L83) *** @@ -216,7 +223,7 @@ The name of the error, used to discriminate errors. #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -244,7 +251,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -316,7 +323,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/ChainIdMismatchError.md b/docs/src/content/docs/reference/@tevm/errors/classes/ChainIdMismatchError.md index 8c6dd42ca3..224e9403fe 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/ChainIdMismatchError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/ChainIdMismatchError.md @@ -82,7 +82,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -96,7 +96,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -112,7 +112,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -126,7 +126,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -142,7 +142,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -174,7 +174,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -204,7 +204,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -232,7 +232,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -304,7 +304,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/CodeSizeExceedsMaximumError.md b/docs/src/content/docs/reference/@tevm/errors/classes/CodeSizeExceedsMaximumError.md index a58897e04d..e79d6e2303 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/CodeSizeExceedsMaximumError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/CodeSizeExceedsMaximumError.md @@ -118,7 +118,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -132,7 +132,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -148,7 +148,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -162,7 +162,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -178,7 +178,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -210,7 +210,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -240,7 +240,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -268,7 +268,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -350,7 +350,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/CodeStoreOutOfGasError.md b/docs/src/content/docs/reference/@tevm/errors/classes/CodeStoreOutOfGasError.md index d63c753d31..d8e76a3ffa 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/CodeStoreOutOfGasError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/CodeStoreOutOfGasError.md @@ -107,7 +107,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -121,7 +121,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -137,7 +137,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -151,7 +151,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -167,7 +167,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -199,7 +199,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -229,7 +229,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -257,7 +257,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -339,7 +339,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/CommonMismatchError.md b/docs/src/content/docs/reference/@tevm/errors/classes/CommonMismatchError.md index 169c0c2625..4a9d7d8320 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/CommonMismatchError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/CommonMismatchError.md @@ -9,29 +9,29 @@ Represents an error that occurs when the Common for a given block does not match Common mismatch errors can occur due to: - Discrepancies between the Common configurations for a block and the VM. +- Attempting to use features from a different hardfork than what's configured. ## Example ```typescript import { CommonMismatchError } from '@tevm/errors' +import { createMemoryClient } from '@tevm/memory-client' +import { Hardfork } from '@tevm/common' + +const client = createMemoryClient({ hardfork: Hardfork.Shanghai }) + try { - // Some operation that can throw a CommonMismatchError + await client.setChain({ hardfork: Hardfork.London }) + // This might throw a CommonMismatchError if the operation is incompatible } catch (error) { if (error instanceof CommonMismatchError) { - console.error(error.message); - // Handle the common mismatch error + console.error('Common mismatch:', error.message) + console.log('Documentation:', error.docsLink) + // Handle the common mismatch error, possibly by updating the client configuration } } ``` -## Param - -A human-readable error message. - -## Param - -Additional parameters for the BaseError. - ## Extends - [`ExecutionError`](/reference/tevm/errors/classes/executionerror/) @@ -40,7 +40,7 @@ Additional parameters for the BaseError. ### new CommonMismatchError() -> **new CommonMismatchError**(`message`?, `args`?, `tag`?): [`CommonMismatchError`](/reference/tevm/errors/classes/commonmismatcherror/) +> **new CommonMismatchError**(`message`?, `args`?): [`CommonMismatchError`](/reference/tevm/errors/classes/commonmismatcherror/) Constructs a CommonMismatchError. @@ -52,11 +52,7 @@ Human-readable error message. • **args?**: [`CommonMismatchErrorParameters`](/reference/tevm/errors/interfaces/commonmismatcherrorparameters/) = `{}` -Additional parameters for the BaseError. - -• **tag?**: `string` = `'CommonMismatchError'` - -The tag for the error. +Additional parameters for the error. #### Returns @@ -68,7 +64,7 @@ The tag for the error. #### Defined in -[packages/errors/src/common/CommonMismatchError.js:52](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/common/CommonMismatchError.js#L52) +[packages/errors/src/common/CommonMismatchError.js:51](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/common/CommonMismatchError.js#L51) ## Properties @@ -76,7 +72,7 @@ The tag for the error. > **\_tag**: `string` -Same as name, used internally. +More discriminated version of name. Can be used to discriminate between errors with the same name. #### Inherited from @@ -84,7 +80,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -98,7 +94,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -114,7 +110,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -128,7 +124,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -144,7 +140,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -176,7 +172,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -206,7 +202,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -234,7 +230,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -306,7 +302,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/ContractExecutionFailedError.md b/docs/src/content/docs/reference/@tevm/errors/classes/ContractExecutionFailedError.md index a4754721af..3990fc29f4 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/ContractExecutionFailedError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/ContractExecutionFailedError.md @@ -5,19 +5,27 @@ prev: false title: "ContractExecutionFailedError" --- -Represents an error that occurs when the execution of a contract fails. +Represents an error that occurs when the execution of a smart contract fails. -This error is typically encountered when a smart contract fails to execute properly. +This error is typically encountered when a smart contract's execution reverts or +encounters an exception during its operation. It can be due to various reasons such as +failing assertions, out-of-gas errors, or other contract-specific logic failures. + +The error code -32004 is a non-standard extension used by some Ethereum clients to +indicate a contract execution failure. ## Example ```ts try { - // Some operation that can throw a ContractExecutionFailedError + const result = await client.call({ + to: '0x742d35Cc6634C0532925a3b844Bc454e4438f44e', + data: '0x...' // encoded function call + }) } catch (error) { if (error instanceof ContractExecutionFailedError) { - console.error(error.message); - // Handle the contract execution failed error + console.error('Contract execution failed:', error.message); + console.log('Check the contract logic or input parameters'); } } ``` @@ -54,7 +62,7 @@ Additional parameters for the BaseError. • **tag?**: `string` = `'ContractExecutionFailed'` -The tag for the error.} +The tag for the error. #### Returns @@ -66,7 +74,7 @@ The tag for the error.} #### Defined in -[packages/errors/src/ethereum/ContractExecutionFailedError.js:49](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/ContractExecutionFailedError.js#L49) +[packages/errors/src/ethereum/ContractExecutionFailedError.js:56](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/ContractExecutionFailedError.js#L56) ## Properties @@ -82,7 +90,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/ContractExecutionFailedError.js:69](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/ContractExecutionFailedError.js#L69) *** @@ -96,7 +104,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -104,7 +112,7 @@ Same as name, used internally. > **code**: `number` -Error code, analogous to the code in JSON RPC error. +Error code (-32004), a non-standard extension for this specific error. #### Inherited from @@ -112,7 +120,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -126,7 +134,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -142,7 +150,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -174,7 +182,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -190,7 +198,7 @@ The name of the error, used to discriminate errors. #### Defined in -node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1076 +[packages/errors/src/ethereum/ContractExecutionFailedError.js:68](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/ContractExecutionFailedError.js#L68) *** @@ -204,7 +212,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -232,7 +240,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -304,7 +312,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/CreateCollisionError.md b/docs/src/content/docs/reference/@tevm/errors/classes/CreateCollisionError.md index 4efd377b3a..074cbff373 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/CreateCollisionError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/CreateCollisionError.md @@ -98,7 +98,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -112,7 +112,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -128,7 +128,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -142,7 +142,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -158,7 +158,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -190,7 +190,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -220,7 +220,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -248,7 +248,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -330,7 +330,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/DecodeFunctionDataError.md b/docs/src/content/docs/reference/@tevm/errors/classes/DecodeFunctionDataError.md index 5e1d11aa86..5fca7a5087 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/DecodeFunctionDataError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/DecodeFunctionDataError.md @@ -10,23 +10,25 @@ Not expected to be thrown unless ABI is incorrect. ## Example -```ts -const {errors} = await tevm.call({address: '0x1234'}) -errors.forEach(error => { - if (error.name === 'DecodeFunctionDataError') { - console.log(error.message) +```javascript +import { DecodeFunctionDataError } from '@tevm/errors' +import { createMemoryClient } from '@tevm/memory-client' + +const client = createMemoryClient() + +try { + const result = await client.call({ + to: '0x1234567890123456789012345678901234567890', + data: '0x...' // Invalid or mismatched function data + }) +} catch (error) { + if (error instanceof DecodeFunctionDataError) { + console.error('Decode function data error:', error.message) + console.log('Documentation:', error.docsLink) } -}) +} ``` -## Param - -A human-readable error message. - -## Param - -Optional object containing additional information about the error. - ## Extends - [`InvalidParamsError`](/reference/tevm/errors/classes/invalidparamserror/) @@ -35,7 +37,7 @@ Optional object containing additional information about the error. ### new DecodeFunctionDataError() -> **new DecodeFunctionDataError**(`message`, `meta`?, `tag`?): [`DecodeFunctionDataError`](/reference/tevm/errors/classes/decodefunctiondataerror/) +> **new DecodeFunctionDataError**(`message`, `args`?): [`DecodeFunctionDataError`](/reference/tevm/errors/classes/decodefunctiondataerror/) Constructs a DecodeFunctionDataError. @@ -45,13 +47,9 @@ Constructs a DecodeFunctionDataError. Human-readable error message. -• **meta?**: `object` - -Optional object containing additional information about the error. - -• **tag?**: `string` = `'DecodeFunctionDataError'` +• **args?**: `DecodeFunctionDataErrorParameters` = `{}` -The tag for the error. +Additional parameters for the DecodeFunctionDataError. #### Returns @@ -63,7 +61,7 @@ The tag for the error. #### Defined in -[packages/errors/src/utils/DecodeFunctionDataError.js:33](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/utils/DecodeFunctionDataError.js#L33) +[packages/errors/src/utils/DecodeFunctionDataError.js:48](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/utils/DecodeFunctionDataError.js#L48) ## Properties @@ -79,7 +77,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/utils/DecodeFunctionDataError.js:60](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/utils/DecodeFunctionDataError.js#L60) *** @@ -93,7 +91,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -109,7 +107,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -123,7 +121,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -139,7 +137,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -171,7 +169,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -187,7 +185,7 @@ The name of the error, used to discriminate errors. #### Defined in -node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1076 +[packages/errors/src/utils/DecodeFunctionDataError.js:59](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/utils/DecodeFunctionDataError.js#L59) *** @@ -201,7 +199,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -229,7 +227,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -301,7 +299,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/DefensiveNullCheckError.md b/docs/src/content/docs/reference/@tevm/errors/classes/DefensiveNullCheckError.md index 167049ff73..8b01cce7f9 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/DefensiveNullCheckError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/DefensiveNullCheckError.md @@ -6,36 +6,31 @@ title: "DefensiveNullCheckError" --- Represents an error that occurs when a defensive null check is tripped. -This error should never be thrown and indicates a bug in the Tevm VM if it is Thrown - -Defensive null check errors can occur due to: -- Checking what should be an impossible null value, indicating a bug in TEVM. - -To handle this error take the following steps: -- ensure you did not modify the tevm VM in any unsupported way. -- Open an issue with a minimal reproducable example +This error should never be thrown and indicates a bug in the Tevm VM if it is thrown. ## Example -```typescript +```javascript import { DefensiveNullCheckError } from '@tevm/errors' -function assertNotNull(value: T | null): T { - const name = 'bob' - const firstLetter = name[0] - if (firstLetter === undefined) { - throw new DefensiveNullCheckError('Null value encountered in assertNotNull') + +function assertNotNull(value, message) { + if (value === null || value === undefined) { + throw new DefensiveNullCheckError(message) } return value } -``` - -## Param - -A human-readable error message. -## Param - -Additional parameters for the BaseError. +try { + const result = someFunction() + assertNotNull(result, 'Result should not be null') +} catch (error) { + if (error instanceof DefensiveNullCheckError) { + console.error('Unexpected null value:', error.message) + // This indicates a bug in the Tevm VM + reportBugToTevmRepository(error) + } +} +``` ## Extends @@ -45,23 +40,19 @@ Additional parameters for the BaseError. ### new DefensiveNullCheckError() -> **new DefensiveNullCheckError**(`message`?, `args`?, `tag`?): [`DefensiveNullCheckError`](/reference/tevm/errors/classes/defensivenullcheckerror/) +> **new DefensiveNullCheckError**(`message`?, `args`?): [`DefensiveNullCheckError`](/reference/tevm/errors/classes/defensivenullcheckerror/) Constructs a DefensiveNullCheckError. #### Parameters -• **message?**: `string` = `'Defensive null check error occurred.'` +• **message?**: `string` Human-readable error message. • **args?**: [`DefensiveNullCheckErrorParameters`](/reference/tevm/errors/interfaces/defensivenullcheckerrorparameters/) = `{}` -Additional parameters for the BaseError. - -• **tag?**: `string` = `'DefensiveNullCheckError'` - -The tag for the error. +Additional parameters for the error. #### Returns @@ -73,7 +64,7 @@ The tag for the error. #### Defined in -[packages/errors/src/defensive/DefensiveNullCheckError.js:57](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/defensive/DefensiveNullCheckError.js#L57) +[packages/errors/src/defensive/DefensiveNullCheckError.js:51](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/defensive/DefensiveNullCheckError.js#L51) ## Properties @@ -89,7 +80,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/defensive/DefensiveNullCheckError.js:63](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/defensive/DefensiveNullCheckError.js#L63) *** @@ -103,7 +94,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -111,7 +102,7 @@ Same as name, used internally. > **code**: `number` -Error code, analogous to the code in JSON RPC error. +Error code (-32603), standard JSON-RPC error code for internal errors. #### Inherited from @@ -119,7 +110,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -133,7 +124,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -149,7 +140,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -181,7 +172,7 @@ Optional object containing additional information about the error. #### Defined in -[packages/errors/src/ethereum/InternalErrorError.js:64](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/InternalErrorError.js#L64) +[packages/errors/src/ethereum/InternalErrorError.js:69](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/InternalErrorError.js#L69) *** @@ -197,7 +188,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -213,7 +204,7 @@ The name of the error, used to discriminate errors. #### Defined in -node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1076 +[packages/errors/src/defensive/DefensiveNullCheckError.js:62](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/defensive/DefensiveNullCheckError.js#L62) *** @@ -227,7 +218,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -255,7 +246,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -327,7 +318,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/EipNotEnabledError.md b/docs/src/content/docs/reference/@tevm/errors/classes/EipNotEnabledError.md index dddc46eab9..81017fd228 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/EipNotEnabledError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/EipNotEnabledError.md @@ -10,30 +10,31 @@ Represents an error that occurs when an EIP (Ethereum Improvement Proposal) is n EIP not enabled errors can occur due to: - Attempting to use features or operations that require a specific EIP which is not enabled in the VM. -EIPs can be set on common and passed into createMemoryClient - ## Example ```typescript import { EipNotEnabledError } from '@tevm/errors' +import { createMemoryClient } from '@tevm/memory-client' +import { Hardfork } from '@tevm/common' + +const client = createMemoryClient({ hardfork: Hardfork.London }) + try { - // Some operation that can throw an EipNotEnabledError + // Attempt an operation that requires an EIP not enabled in London + await client.call({ + to: '0x...', + data: '0x...', + // Assuming this operation requires a post-London EIP + }) } catch (error) { if (error instanceof EipNotEnabledError) { - console.error(error.message); - // Handle the EIP not enabled error + console.error('EIP not enabled:', error.message) + console.log('Documentation:', error.docsLink) + // Handle the error, possibly by updating the client to a newer hardfork } } ``` -## Param - -A human-readable error message. - -## Param - -Additional parameters for the BaseError. - ## Extends - [`ExecutionError`](/reference/tevm/errors/classes/executionerror/) @@ -42,7 +43,7 @@ Additional parameters for the BaseError. ### new EipNotEnabledError() -> **new EipNotEnabledError**(`message`?, `args`?, `tag`?): [`EipNotEnabledError`](/reference/tevm/errors/classes/eipnotenablederror/) +> **new EipNotEnabledError**(`message`?, `args`?): [`EipNotEnabledError`](/reference/tevm/errors/classes/eipnotenablederror/) Constructs an EipNotEnabledError. @@ -54,11 +55,7 @@ Human-readable error message. • **args?**: [`EipNotEnabledErrorParameters`](/reference/tevm/errors/interfaces/eipnotenablederrorparameters/) = `{}` -Additional parameters for the BaseError. - -• **tag?**: `string` = `'EipNotEnabledError'` - -The tag for the error. +Additional parameters for the error. #### Returns @@ -78,7 +75,7 @@ The tag for the error. > **\_tag**: `string` -Same as name, used internally. +More discriminated version of name. Can be used to discriminate between errors with the same name. #### Inherited from @@ -86,7 +83,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/common/EipNotEnabledError.js:66](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/common/EipNotEnabledError.js#L66) *** @@ -100,7 +97,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -116,7 +113,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -130,7 +127,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -146,7 +143,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -178,7 +175,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -194,7 +191,7 @@ The name of the error, used to discriminate errors. #### Defined in -node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1076 +[packages/errors/src/common/EipNotEnabledError.js:65](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/common/EipNotEnabledError.js#L65) *** @@ -208,7 +205,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -236,7 +233,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -308,7 +305,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/EncodeFunctionReturnDataError.md b/docs/src/content/docs/reference/@tevm/errors/classes/EncodeFunctionReturnDataError.md index 00bd863af1..de5ceec033 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/EncodeFunctionReturnDataError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/EncodeFunctionReturnDataError.md @@ -5,31 +5,33 @@ prev: false title: "EncodeFunctionReturnDataError" --- -Represents an error that occurs when encoding function data fails. +Represents an error that occurs when encoding function return data fails. Not expected to be thrown because the initial validation should have caught any errors and thrown more specific errors. ## Example -```ts +```javascript +import { EncodeFunctionReturnDataError } from '@tevm/errors' +import { createMemoryClient } from '@tevm/memory-client' + +const client = createMemoryClient() + try { - // Some operation that can throw an EncodeFunctionReturnDataError + const result = await client.contract({ + address: '0x1234567890123456789012345678901234567890', + abi: [...], + functionName: 'someFunction', + }) + // Assume some internal error occurs during encoding of the return data } catch (error) { if (error instanceof EncodeFunctionReturnDataError) { - console.error(error.message); - // Handle the encode function return data error + console.error('Encode function return data error:', error.message) + console.log('Documentation:', error.docsLink) } } ``` -## Param - -A human-readable error message. - -## Param - -Optional object containing additional information about the error. - ## Extends - [`InvalidParamsError`](/reference/tevm/errors/classes/invalidparamserror/) @@ -38,7 +40,7 @@ Optional object containing additional information about the error. ### new EncodeFunctionReturnDataError() -> **new EncodeFunctionReturnDataError**(`message`, `meta`?, `tag`?): [`EncodeFunctionReturnDataError`](/reference/tevm/errors/classes/encodefunctionreturndataerror/) +> **new EncodeFunctionReturnDataError**(`message`, `args`?): [`EncodeFunctionReturnDataError`](/reference/tevm/errors/classes/encodefunctionreturndataerror/) Constructs an EncodeFunctionReturnDataError. @@ -48,13 +50,9 @@ Constructs an EncodeFunctionReturnDataError. Human-readable error message. -• **meta?**: `object` - -Optional object containing additional information about the error. - -• **tag?**: `string` = `'EncodeFunctionReturnDataError'` +• **args?**: `EncodeFunctionReturnDataErrorParameters` = `{}` -The tag for the error. +Additional parameters for the EncodeFunctionReturnDataError. #### Returns @@ -66,7 +64,7 @@ The tag for the error. #### Defined in -[packages/errors/src/utils/EncodeFunctionReturnDataError.js:36](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/utils/EncodeFunctionReturnDataError.js#L36) +[packages/errors/src/utils/EncodeFunctionReturnDataError.js:51](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/utils/EncodeFunctionReturnDataError.js#L51) ## Properties @@ -82,7 +80,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/utils/EncodeFunctionReturnDataError.js:63](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/utils/EncodeFunctionReturnDataError.js#L63) *** @@ -96,7 +94,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -112,7 +110,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -126,7 +124,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -142,7 +140,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -174,7 +172,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -190,7 +188,7 @@ The name of the error, used to discriminate errors. #### Defined in -node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1076 +[packages/errors/src/utils/EncodeFunctionReturnDataError.js:62](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/utils/EncodeFunctionReturnDataError.js#L62) *** @@ -204,7 +202,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -232,7 +230,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -304,7 +302,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/EvmRevertError.md b/docs/src/content/docs/reference/@tevm/errors/classes/EvmRevertError.md index 017440cad2..35cb8521f6 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/EvmRevertError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/EvmRevertError.md @@ -108,7 +108,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/RevertError.js:70](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/RevertError.js#L70) *** @@ -122,7 +122,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -138,7 +138,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -152,7 +152,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -168,7 +168,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -200,7 +200,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -216,7 +216,7 @@ The name of the error, used to discriminate errors. #### Defined in -node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1076 +[packages/errors/src/ethereum/RevertError.js:69](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/RevertError.js#L69) *** @@ -230,7 +230,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -258,7 +258,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -340,7 +340,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/ExecutionError.md b/docs/src/content/docs/reference/@tevm/errors/classes/ExecutionError.md index 8b3dfbe6be..d376f2e6b4 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/ExecutionError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/ExecutionError.md @@ -113,7 +113,7 @@ More discriminated version of name. Can be used to discriminate between errors w #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -127,7 +127,7 @@ More discriminated version of name. Can be used to discriminate between errors w #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -143,7 +143,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -157,7 +157,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -173,7 +173,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -205,7 +205,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -235,7 +235,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -263,7 +263,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -335,7 +335,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/ForkError.md b/docs/src/content/docs/reference/@tevm/errors/classes/ForkError.md index fdb4927c5e..7b0bf4ee1f 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/ForkError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/ForkError.md @@ -7,45 +7,32 @@ title: "ForkError" Represents an error thrown when attempting to fetch a resource from a Forked transport. If the underlying JSON-RPC call has an error code, the error code will be proxied to the ForkError. -Most tevm methods return these errors as values if `throwOnFail` is set to `false` and a forkUrl is provided ## Example +```javascript +import { ForkError } from '@tevm/errors' +import { createMemoryClient } from '@tevm/memory-client' +import { http } from '@tevm/jsonrpc' + +const client = createMemoryClient({ + fork: { + url: 'https://mainnet.example.com' + } +}) + try { - // Some operation that can throw an ForkError + await client.getBalance('0x...') } catch (error) { if (error instanceof ForkError) { - console.error(error.message); - // Handle the account locked error + console.error('Fork error:', error.message) + console.log('Error code:', error.code) + console.log('Documentation:', error.docsLink) + // Handle the fork error, e.g., by retrying or using a different RPC endpoint } } - -To debug this error check to see if there might be a misconfiguration or rate limit of the -fork transport. - -If the issue is a rate limit consider using the `rateLimit` transport options to limit how many -requests tevm are made. -```typescript -import { rateLimit, http } from "@tevm/jsonrpc" -import { createMemoryClient } from "@tevm/memory-client" - -const client = createMemoryClient({ - fork: { - transport: rateLimit( - http('https://mainnet.optimism.io'), { browser: false, requestsPerSecond: 25 } - ) - ) -}} ``` -## Param - -A human-readable error message. - -## Param - -Additional parameters for the BaseError. - ## Extends - [`BaseError`](/reference/tevm/errors/classes/baseerror/) @@ -54,9 +41,9 @@ Additional parameters for the BaseError. ### new ForkError() -> **new ForkError**(`message`, `args`, `tag`): [`ForkError`](/reference/tevm/errors/classes/forkerror/) +> **new ForkError**(`message`, `args`): [`ForkError`](/reference/tevm/errors/classes/forkerror/) -Constructs an ForkError. +Constructs a ForkError. #### Parameters @@ -66,9 +53,7 @@ Human-readable error message. • **args**: [`ForkErrorParameters`](/reference/tevm/errors/interfaces/forkerrorparameters/) -Additional parameters for the BaseError. - -• **tag**: `string` = `'ForkError'` +Additional parameters for the error. #### Returns @@ -80,7 +65,7 @@ Additional parameters for the BaseError. #### Defined in -[packages/errors/src/fork/ForkError.js:67](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/fork/ForkError.js#L67) +[packages/errors/src/fork/ForkError.js:54](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/fork/ForkError.js#L54) ## Properties @@ -88,15 +73,13 @@ Additional parameters for the BaseError. > **\_tag**: `string` -Same as name, used internally. - #### Inherited from [`BaseError`](/reference/tevm/errors/classes/baseerror/).[`_tag`](/reference/tevm/errors/classes/baseerror/#_tag) #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/fork/ForkError.js:73](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/fork/ForkError.js#L73) *** @@ -110,7 +93,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -118,15 +101,13 @@ Same as name, used internally. > **code**: `number` -Error code, analogous to the code in JSON RPC error. - #### Inherited from [`BaseError`](/reference/tevm/errors/classes/baseerror/).[`code`](/reference/tevm/errors/classes/baseerror/#code) #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -140,7 +121,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -148,15 +129,13 @@ Error code, analogous to the code in JSON RPC error. > **docsPath**: `undefined` \| `string` -Path to the documentation for this error. - #### Inherited from [`BaseError`](/reference/tevm/errors/classes/baseerror/).[`docsPath`](/reference/tevm/errors/classes/baseerror/#docspath) #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -164,8 +143,6 @@ Path to the documentation for this error. > **message**: `string` -Human-readable error message. - #### Inherited from [`BaseError`](/reference/tevm/errors/classes/baseerror/).[`message`](/reference/tevm/errors/classes/baseerror/#message) @@ -180,15 +157,13 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 > **metaMessages**: `undefined` \| `string`[] -Additional meta messages for more context. - #### Inherited from [`BaseError`](/reference/tevm/errors/classes/baseerror/).[`metaMessages`](/reference/tevm/errors/classes/baseerror/#metamessages) #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -196,15 +171,13 @@ Additional meta messages for more context. > **name**: `string` -The name of the error, used to discriminate errors. - #### Inherited from [`BaseError`](/reference/tevm/errors/classes/baseerror/).[`name`](/reference/tevm/errors/classes/baseerror/#name) #### Defined in -node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1076 +[packages/errors/src/fork/ForkError.js:72](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/fork/ForkError.js#L72) *** @@ -218,7 +191,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -246,7 +219,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -318,7 +291,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/GasLimitExceededError.md b/docs/src/content/docs/reference/@tevm/errors/classes/GasLimitExceededError.md index effb381e29..a53765d090 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/GasLimitExceededError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/GasLimitExceededError.md @@ -86,7 +86,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -100,7 +100,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -116,7 +116,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -130,7 +130,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -146,7 +146,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -178,7 +178,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -208,7 +208,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -236,7 +236,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -308,7 +308,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/InitcodeSizeViolationError.md b/docs/src/content/docs/reference/@tevm/errors/classes/InitcodeSizeViolationError.md index 515ce4bee8..81611baf6f 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/InitcodeSizeViolationError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/InitcodeSizeViolationError.md @@ -98,7 +98,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -112,7 +112,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -128,7 +128,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -142,7 +142,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -158,7 +158,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -190,7 +190,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -220,7 +220,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -248,7 +248,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -330,7 +330,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/InsufficientBalanceError.md b/docs/src/content/docs/reference/@tevm/errors/classes/InsufficientBalanceError.md index 207635b6b7..b104f55447 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/InsufficientBalanceError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/InsufficientBalanceError.md @@ -100,7 +100,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -114,7 +114,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -130,7 +130,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -144,7 +144,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -160,7 +160,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -192,7 +192,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -222,7 +222,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -250,7 +250,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -332,7 +332,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/InsufficientFundsError.md b/docs/src/content/docs/reference/@tevm/errors/classes/InsufficientFundsError.md index 6c254cfcae..c5d0b69bf6 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/InsufficientFundsError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/InsufficientFundsError.md @@ -82,7 +82,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -96,7 +96,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -112,7 +112,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -126,7 +126,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -142,7 +142,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -174,7 +174,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -204,7 +204,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -232,7 +232,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -304,7 +304,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/InsufficientPermissionsError.md b/docs/src/content/docs/reference/@tevm/errors/classes/InsufficientPermissionsError.md index c388aee915..204039fef1 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/InsufficientPermissionsError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/InsufficientPermissionsError.md @@ -82,7 +82,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -96,7 +96,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -112,7 +112,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -126,7 +126,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -142,7 +142,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -174,7 +174,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -204,7 +204,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -232,7 +232,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -304,7 +304,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/InternalError.md b/docs/src/content/docs/reference/@tevm/errors/classes/InternalError.md index c333d90d85..5ae3488d0d 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/InternalError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/InternalError.md @@ -7,17 +7,24 @@ title: "InternalError" Represents an internal JSON-RPC error. -This error is typically encountered when there is an internal error on the server. +This error is typically encountered when there is an unexpected internal error on the server. +It's a catch-all for errors that don't fall into more specific categories and usually indicates +a problem with the Ethereum node or the JSON-RPC server itself, rather than with the request. + +The error code -32603 is a standard JSON-RPC error code for internal errors. ## Example ```ts try { - // Some operation that can throw an InternalError + await client.call({ + to: '0x742d35Cc6634C0532925a3b844Bc454e4438f44e', + data: '0x...' // some method call + }) } catch (error) { if (error instanceof InternalError) { - console.error(error.message); - // Handle the internal error + console.error('Internal error:', error.message); + console.log('This is likely a problem with the Ethereum node. Try again later or contact the node operator.'); } } ``` @@ -73,7 +80,7 @@ The tag for the error. #### Defined in -[packages/errors/src/ethereum/InternalErrorError.js:49](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/InternalErrorError.js#L49) +[packages/errors/src/ethereum/InternalErrorError.js:55](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/InternalErrorError.js#L55) ## Properties @@ -89,7 +96,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/InternalErrorError.js:68](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/InternalErrorError.js#L68) *** @@ -103,7 +110,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -111,7 +118,7 @@ Same as name, used internally. > **code**: `number` -Error code, analogous to the code in JSON RPC error. +Error code (-32603), standard JSON-RPC error code for internal errors. #### Inherited from @@ -119,7 +126,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -133,7 +140,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -149,7 +156,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -177,7 +184,7 @@ Optional object containing additional information about the error. #### Defined in -[packages/errors/src/ethereum/InternalErrorError.js:64](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/InternalErrorError.js#L64) +[packages/errors/src/ethereum/InternalErrorError.js:69](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/InternalErrorError.js#L69) *** @@ -193,7 +200,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -209,7 +216,7 @@ The name of the error, used to discriminate errors. #### Defined in -node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1076 +[packages/errors/src/ethereum/InternalErrorError.js:67](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/InternalErrorError.js#L67) *** @@ -223,7 +230,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -251,7 +258,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -323,7 +330,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/InternalEvmError.md b/docs/src/content/docs/reference/@tevm/errors/classes/InternalEvmError.md index 930355ca1c..4840af395d 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/InternalEvmError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/InternalEvmError.md @@ -96,7 +96,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -110,7 +110,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -126,7 +126,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -140,7 +140,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -156,7 +156,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -188,7 +188,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -218,7 +218,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -246,7 +246,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -328,7 +328,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidAbiError.md b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidAbiError.md index 4a39a7f9b1..eb720a936b 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidAbiError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidAbiError.md @@ -5,31 +5,32 @@ prev: false title: "InvalidAbiError" --- -Represents an error that occurs when the ABI shape is invalid. +Represents an error that occurs when the ABI is invalid. -This error is typically encountered when the ABI provided for a contract is malformed or does not conform to the expected structure. +This error is typically encountered when a contract interaction or ABI-related operation receives an invalid or malformed ABI. ## Example -```ts +```javascript +import { InvalidAbiError } from '@tevm/errors' +import { createMemoryClient } from '@tevm/memory-client' + +const client = createMemoryClient() + try { - // Some operation that can throw an InvalidAbiError + await client.contract({ + abi: 'invalid_abi', // This should be a valid ABI array + address: '0x...', + functionName: 'someFunction', + }) } catch (error) { if (error instanceof InvalidAbiError) { - console.error(error.message); - // Handle the invalid ABI error + console.error('Invalid ABI:', error.message) + console.log('Documentation:', error.docsLink) } } ``` -## Param - -A human-readable error message. - -## Param - -Additional parameters for the InvalidParamsError. - ## Extends - [`InvalidParamsError`](/reference/tevm/errors/classes/invalidparamserror/) @@ -38,7 +39,7 @@ Additional parameters for the InvalidParamsError. ### new InvalidAbiError() -> **new InvalidAbiError**(`message`, `args`?, `tag`?): [`InvalidAbiError`](/reference/tevm/errors/classes/invalidabierror/) +> **new InvalidAbiError**(`message`, `args`?): [`InvalidAbiError`](/reference/tevm/errors/classes/invalidabierror/) Constructs an InvalidAbiError. @@ -50,11 +51,7 @@ Human-readable error message. • **args?**: [`InvalidAbiErrorParameters`](/reference/tevm/errors/interfaces/invalidabierrorparameters/) = `{}` -Additional parameters for the InvalidParamsError. - -• **tag?**: `string` = `'InvalidAbiError'` - -The tag for the error. +Additional parameters for the InvalidAbiError. #### Returns @@ -66,7 +63,7 @@ The tag for the error. #### Defined in -[packages/errors/src/input/InvalidAbiError.js:48](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/input/InvalidAbiError.js#L48) +[packages/errors/src/input/InvalidAbiError.js:50](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/input/InvalidAbiError.js#L50) ## Properties @@ -82,7 +79,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/input/InvalidAbiError.js:62](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/input/InvalidAbiError.js#L62) *** @@ -96,7 +93,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -112,7 +109,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -126,7 +123,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -142,7 +139,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -174,7 +171,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -190,7 +187,7 @@ The name of the error, used to discriminate errors. #### Defined in -node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1076 +[packages/errors/src/input/InvalidAbiError.js:61](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/input/InvalidAbiError.js#L61) *** @@ -204,7 +201,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -232,7 +229,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -304,7 +301,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidAddressError.md b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidAddressError.md index 8ff4c09b45..d09784ce92 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidAddressError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidAddressError.md @@ -82,7 +82,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -96,7 +96,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -112,7 +112,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -126,7 +126,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -142,7 +142,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -174,7 +174,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -204,7 +204,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -232,7 +232,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -304,7 +304,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidArgsError.md b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidArgsError.md index f6f833f045..c50dc62e05 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidArgsError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidArgsError.md @@ -5,31 +5,33 @@ prev: false title: "InvalidArgsError" --- -Represents an error that occurs when arguments provided to a contract or script call are invalid. +Represents an error that occurs when the arguments provided to a function or method are invalid. -This error is typically encountered when the arguments provided do not match the expected types or structure required by the contract or script. +This error is typically encountered when a function receives arguments that don't match the expected types or format. ## Example -```ts +```javascript +import { InvalidArgsError } from '@tevm/errors' +import { createMemoryClient } from '@tevm/memory-client' + +const client = createMemoryClient() + try { - // Some operation that can throw an InvalidArgsError + await client.contract({ + address: '0x...', + functionName: 'transfer', + args: ['not_an_address', 'not_a_number'], // Invalid args + abi: [...], + }) } catch (error) { if (error instanceof InvalidArgsError) { - console.error(error.message); - // Handle the invalid arguments error + console.error('Invalid arguments:', error.message) + console.log('Documentation:', error.docsLink) } } ``` -## Param - -A human-readable error message. - -## Param - -Additional parameters for the InvalidParamsError. - ## Extends - [`InvalidParamsError`](/reference/tevm/errors/classes/invalidparamserror/) @@ -38,7 +40,7 @@ Additional parameters for the InvalidParamsError. ### new InvalidArgsError() -> **new InvalidArgsError**(`message`, `args`?, `tag`?): [`InvalidArgsError`](/reference/tevm/errors/classes/invalidargserror/) +> **new InvalidArgsError**(`message`, `args`?): [`InvalidArgsError`](/reference/tevm/errors/classes/invalidargserror/) Constructs an InvalidArgsError. @@ -48,13 +50,9 @@ Constructs an InvalidArgsError. Human-readable error message. -• **args?**: [`InvalidArgsErrorParameters`](/reference/tevm/errors/interfaces/invalidargserrorparameters/) - -Additional parameters for the InvalidParamsError. - -• **tag?**: `string` +• **args?**: [`InvalidArgsErrorParameters`](/reference/tevm/errors/interfaces/invalidargserrorparameters/) = `{}` -The tag for the error. +Additional parameters for the InvalidArgsError. #### Returns @@ -66,7 +64,7 @@ The tag for the error. #### Defined in -[packages/errors/src/input/InvalidArgsError.js:48](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/input/InvalidArgsError.js#L48) +[packages/errors/src/input/InvalidArgsError.js:51](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/input/InvalidArgsError.js#L51) ## Properties @@ -82,7 +80,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/input/InvalidArgsError.js:63](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/input/InvalidArgsError.js#L63) *** @@ -96,7 +94,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -112,7 +110,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -126,7 +124,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -142,7 +140,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -174,7 +172,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -190,7 +188,7 @@ The name of the error, used to discriminate errors. #### Defined in -node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1076 +[packages/errors/src/input/InvalidArgsError.js:62](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/input/InvalidArgsError.js#L62) *** @@ -204,7 +202,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -232,7 +230,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -304,7 +302,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidBalanceError.md b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidBalanceError.md index 3cdc19e693..39dd2eb7ad 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidBalanceError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidBalanceError.md @@ -5,31 +5,31 @@ prev: false title: "InvalidBalanceError" --- -Represents an error that occurs when the balance parameter is invalid. +Represents an error that occurs when an account balance is invalid. -This error is typically encountered when a transaction or operation references a balance that is malformed or does not conform to the expected structure. +This error is typically encountered when setting or manipulating account balances with invalid values. ## Example -```ts +```javascript +import { InvalidBalanceError } from '@tevm/errors' +import { createMemoryClient } from '@tevm/memory-client' + +const client = createMemoryClient() + try { - // Some operation that can throw an InvalidBalanceError + await client.setAccount({ + address: '0x...', + balance: -1000n, // Invalid negative balance + }) } catch (error) { if (error instanceof InvalidBalanceError) { - console.error(error.message); - // Handle the invalid balance error + console.error('Invalid balance:', error.message) + console.log('Documentation:', error.docsLink) } } ``` -## Param - -A human-readable error message. - -## Param - -Additional parameters for the InvalidParamsError. - ## Extends - [`InvalidParamsError`](/reference/tevm/errors/classes/invalidparamserror/) @@ -38,7 +38,7 @@ Additional parameters for the InvalidParamsError. ### new InvalidBalanceError() -> **new InvalidBalanceError**(`message`, `args`?, `tag`?): [`InvalidBalanceError`](/reference/tevm/errors/classes/invalidbalanceerror/) +> **new InvalidBalanceError**(`message`, `args`?): [`InvalidBalanceError`](/reference/tevm/errors/classes/invalidbalanceerror/) Constructs an InvalidBalanceError. @@ -48,13 +48,9 @@ Constructs an InvalidBalanceError. Human-readable error message. -• **args?**: [`InvalidBalanceErrorParameters`](/reference/tevm/errors/interfaces/invalidbalanceerrorparameters/) - -Additional parameters for the InvalidParamsError. - -• **tag?**: `string` +• **args?**: [`InvalidBalanceErrorParameters`](/reference/tevm/errors/interfaces/invalidbalanceerrorparameters/) = `{}` -The tag for the error.} +Additional parameters for the InvalidBalanceError. #### Returns @@ -66,7 +62,7 @@ The tag for the error.} #### Defined in -[packages/errors/src/input/InvalidBalanceError.js:48](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/input/InvalidBalanceError.js#L48) +[packages/errors/src/input/InvalidBalanceError.js:49](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/input/InvalidBalanceError.js#L49) ## Properties @@ -82,7 +78,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/input/InvalidBalanceError.js:61](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/input/InvalidBalanceError.js#L61) *** @@ -96,7 +92,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -112,7 +108,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -126,7 +122,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -142,7 +138,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -174,7 +170,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -190,7 +186,7 @@ The name of the error, used to discriminate errors. #### Defined in -node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1076 +[packages/errors/src/input/InvalidBalanceError.js:60](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/input/InvalidBalanceError.js#L60) *** @@ -204,7 +200,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -232,7 +228,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -304,7 +300,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidBeginSubError.md b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidBeginSubError.md index c8337e5b66..894acf19b4 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidBeginSubError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidBeginSubError.md @@ -98,7 +98,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -112,7 +112,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -128,7 +128,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -142,7 +142,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -158,7 +158,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -190,7 +190,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -220,7 +220,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -248,7 +248,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -330,7 +330,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidBlobVersionedHashesError.md b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidBlobVersionedHashesError.md index f7e5562a56..e8435dbeaa 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidBlobVersionedHashesError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidBlobVersionedHashesError.md @@ -11,25 +11,25 @@ This error is typically encountered when a transaction or operation references a ## Example -```ts +```javascript +import { InvalidBlobVersionedHashesError } from '@tevm/errors' +import { createMemoryClient } from '@tevm/memory-client' + +const client = createMemoryClient() + try { - // Some operation that can throw an InvalidBlobVersionedHashesError + await client.sendTransaction({ + // ... other transaction parameters + blobVersionedHashes: ['invalid_hash'], // This should be a valid versioned hash + }) } catch (error) { if (error instanceof InvalidBlobVersionedHashesError) { - console.error(error.message); - // Handle the invalid blobVersionedHashes error + console.error('Invalid blob versioned hashes:', error.message) + console.log('Documentation:', error.docsLink) } } ``` -## Param - -A human-readable error message. - -## Param - -Additional parameters for the InvalidParamsError. - ## Extends - [`InvalidParamsError`](/reference/tevm/errors/classes/invalidparamserror/) @@ -38,7 +38,7 @@ Additional parameters for the InvalidParamsError. ### new InvalidBlobVersionedHashesError() -> **new InvalidBlobVersionedHashesError**(`message`, `args`?, `tag`?): [`InvalidBlobVersionedHashesError`](/reference/tevm/errors/classes/invalidblobversionedhasheserror/) +> **new InvalidBlobVersionedHashesError**(`message`, `args`?): [`InvalidBlobVersionedHashesError`](/reference/tevm/errors/classes/invalidblobversionedhasheserror/) Constructs an InvalidBlobVersionedHashesError. @@ -50,11 +50,7 @@ Human-readable error message. • **args?**: [`InvalidBlobVersionedHashesErrorParameters`](/reference/tevm/errors/interfaces/invalidblobversionedhasheserrorparameters/) = `{}` -Additional parameters for the InvalidParamsError. - -• **tag?**: `string` = `'InvalidBlobVersionedHashesError'` - -The tag for the error. +Additional parameters for the InvalidBlobVersionedHashesError. #### Returns @@ -66,7 +62,7 @@ The tag for the error. #### Defined in -[packages/errors/src/input/InvalidBlobVersionedHashesError.js:48](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/input/InvalidBlobVersionedHashesError.js#L48) +[packages/errors/src/input/InvalidBlobVersionedHashesError.js:49](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/input/InvalidBlobVersionedHashesError.js#L49) ## Properties @@ -82,7 +78,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/input/InvalidBlobVersionedHashesError.js:61](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/input/InvalidBlobVersionedHashesError.js#L61) *** @@ -96,7 +92,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -112,7 +108,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -126,7 +122,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -142,7 +138,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -174,7 +170,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -190,7 +186,7 @@ The name of the error, used to discriminate errors. #### Defined in -node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1076 +[packages/errors/src/input/InvalidBlobVersionedHashesError.js:60](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/input/InvalidBlobVersionedHashesError.js#L60) *** @@ -204,7 +200,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -232,7 +228,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -304,7 +300,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidBlockError.md b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidBlockError.md index 9806f4b5fe..d135cab4f2 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidBlockError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidBlockError.md @@ -84,7 +84,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -98,7 +98,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -114,7 +114,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -128,7 +128,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -144,7 +144,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -176,7 +176,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -206,7 +206,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -234,7 +234,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -306,7 +306,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidBytecodeError.md b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidBytecodeError.md index ed3452a1d0..042ac0ddd3 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidBytecodeError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidBytecodeError.md @@ -82,7 +82,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -96,7 +96,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -112,7 +112,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -126,7 +126,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -142,7 +142,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -174,7 +174,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -204,7 +204,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -232,7 +232,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -304,7 +304,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidBytecodeResultError.md b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidBytecodeResultError.md index 71aab242d6..709b35d441 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidBytecodeResultError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidBytecodeResultError.md @@ -98,7 +98,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -112,7 +112,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -128,7 +128,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -142,7 +142,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -158,7 +158,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -190,7 +190,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -220,7 +220,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -248,7 +248,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -330,7 +330,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidBytesSizeError.md b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidBytesSizeError.md index 6739e56bea..d6a46a9c5b 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidBytesSizeError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidBytesSizeError.md @@ -9,34 +9,28 @@ Represents an error that occurs when the size of the bytes does not match the ex ## Example -```typescript +```javascript import { InvalidBytesSizeError } from '@tevm/errors' +import { hexToBytes } from '@tevm/utils' + +function requireBytes32(value) { + const bytes = hexToBytes(value) + if (bytes.length !== 32) { + throw new InvalidBytesSizeError(bytes.length, 32) + } + return bytes +} + try { - // Some operation that can throw an InvalidBytesSizeError + requireBytes32('0x1234') // This will throw an InvalidBytesSizeError } catch (error) { if (error instanceof InvalidBytesSizeError) { - console.error(error.message); - // Handle the invalid bytes size error + console.error(`Invalid bytes size: ${error.message}`) + console.log(`Actual size: ${error.size}, Expected size: ${error.expectedSize}`) } } ``` -## Param - -The actual size of the bytes. - -## Param - -The expected size of the bytes. - -## Param - -A human-readable error message. - -## Param - -Additional parameters for the BaseError. - ## Extends - [`InternalError`](/reference/tevm/errors/classes/internalerror/) @@ -45,7 +39,7 @@ Additional parameters for the BaseError. ### new InvalidBytesSizeError() -> **new InvalidBytesSizeError**(`size`, `expectedSize`, `message`?, `args`?, `tag`?): [`InvalidBytesSizeError`](/reference/tevm/errors/classes/invalidbytessizeerror/) +> **new InvalidBytesSizeError**(`size`, `expectedSize`, `message`?, `args`?): [`InvalidBytesSizeError`](/reference/tevm/errors/classes/invalidbytessizeerror/) Constructs an InvalidBytesSizeError. @@ -59,17 +53,13 @@ The actual size of the bytes. The expected size of the bytes. -• **message?**: `string` = `...` +• **message?**: `string` Human-readable error message. • **args?**: [`InvalidBytesSizeErrorParameters`](/reference/tevm/errors/interfaces/invalidbytessizeerrorparameters/) = `{}` -Additional parameters for the BaseError. - -• **tag?**: `string` = `'InvalidBytesSizeError'` - -The tag for the error.} +Additional parameters for the error. #### Returns @@ -81,7 +71,7 @@ The tag for the error.} #### Defined in -[packages/errors/src/data/InvalidByteSizeError.js:55](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/data/InvalidByteSizeError.js#L55) +[packages/errors/src/data/InvalidByteSizeError.js:64](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/data/InvalidByteSizeError.js#L64) ## Properties @@ -97,7 +87,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/data/InvalidByteSizeError.js:78](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/data/InvalidByteSizeError.js#L78) *** @@ -111,7 +101,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -119,7 +109,7 @@ Same as name, used internally. > **code**: `number` -Error code, analogous to the code in JSON RPC error. +Error code (-32603), standard JSON-RPC error code for internal errors. #### Inherited from @@ -127,7 +117,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -141,7 +131,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -157,7 +147,19 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) + +*** + +### expectedSize + +> **expectedSize**: `number` + +The expected size of the bytes. + +#### Defined in + +[packages/errors/src/data/InvalidByteSizeError.js:54](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/data/InvalidByteSizeError.js#L54) *** @@ -189,7 +191,7 @@ Optional object containing additional information about the error. #### Defined in -[packages/errors/src/ethereum/InternalErrorError.js:64](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/InternalErrorError.js#L64) +[packages/errors/src/ethereum/InternalErrorError.js:69](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/InternalErrorError.js#L69) *** @@ -205,7 +207,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -221,7 +223,7 @@ The name of the error, used to discriminate errors. #### Defined in -node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1076 +[packages/errors/src/data/InvalidByteSizeError.js:77](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/data/InvalidByteSizeError.js#L77) *** @@ -235,7 +237,19 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) + +*** + +### size + +> **size**: `number` + +The actual size of the bytes. + +#### Defined in + +[packages/errors/src/data/InvalidByteSizeError.js:48](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/data/InvalidByteSizeError.js#L48) *** @@ -263,7 +277,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -335,7 +349,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidCallerError.md b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidCallerError.md index f2a91a6bb2..cf7caa5e95 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidCallerError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidCallerError.md @@ -82,7 +82,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -96,7 +96,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -112,7 +112,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -126,7 +126,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -142,7 +142,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -174,7 +174,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -204,7 +204,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -232,7 +232,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -304,7 +304,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidCommitmentError.md b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidCommitmentError.md index 2543bbf8fa..3b1f9ab368 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidCommitmentError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidCommitmentError.md @@ -102,7 +102,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -116,7 +116,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -132,7 +132,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -146,7 +146,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -162,7 +162,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -194,7 +194,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -224,7 +224,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -252,7 +252,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -334,7 +334,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidDataError.md b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidDataError.md index 89340f2888..2becaf90a8 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidDataError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidDataError.md @@ -5,31 +5,32 @@ prev: false title: "InvalidDataError" --- -Represents an error that occurs when the data parameter is invalid. +Represents an error that occurs when the data provided is invalid. -This error is typically encountered when a transaction or operation references a data parameter that is invalid or does not conform to the expected structure. +This error is typically encountered when an operation receives invalid or malformed data. ## Example -```ts +```javascript +import { InvalidDataError } from '@tevm/errors' +import { createMemoryClient } from '@tevm/memory-client' + +const client = createMemoryClient() + try { - // Some operation that can throw an InvalidDataError + await client.sendTransaction({ + from: '0x1234567890123456789012345678901234567890', + to: '0x0987654321098765432109876543210987654321', + data: 'not_valid_hex_data', // Should be a valid hex string + }) } catch (error) { if (error instanceof InvalidDataError) { - console.error(error.message); - // Handle the invalid data error + console.error('Invalid data:', error.message) + console.log('Documentation:', error.docsLink) } } ``` -## Param - -A human-readable error message. - -## Param - -Additional parameters for the InvalidDataError. - ## Extends - [`InvalidParamsError`](/reference/tevm/errors/classes/invalidparamserror/) @@ -38,7 +39,7 @@ Additional parameters for the InvalidDataError. ### new InvalidDataError() -> **new InvalidDataError**(`message`, `args`?, `tag`?): [`InvalidDataError`](/reference/tevm/errors/classes/invaliddataerror/) +> **new InvalidDataError**(`message`, `args`?): [`InvalidDataError`](/reference/tevm/errors/classes/invaliddataerror/) Constructs an InvalidDataError. @@ -52,10 +53,6 @@ Human-readable error message. Additional parameters for the InvalidDataError. -• **tag?**: `string` = `'InvalidDataError'` - -The tag for the error. - #### Returns [`InvalidDataError`](/reference/tevm/errors/classes/invaliddataerror/) @@ -66,7 +63,7 @@ The tag for the error. #### Defined in -[packages/errors/src/input/InvalidDataError.js:48](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/input/InvalidDataError.js#L48) +[packages/errors/src/input/InvalidDataError.js:50](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/input/InvalidDataError.js#L50) ## Properties @@ -82,7 +79,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/input/InvalidDataError.js:62](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/input/InvalidDataError.js#L62) *** @@ -96,7 +93,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -112,7 +109,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -126,7 +123,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -142,7 +139,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -174,7 +171,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -190,7 +187,7 @@ The name of the error, used to discriminate errors. #### Defined in -node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1076 +[packages/errors/src/input/InvalidDataError.js:61](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/input/InvalidDataError.js#L61) *** @@ -204,7 +201,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -232,7 +229,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -304,7 +301,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidDeployedBytecodeError.md b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidDeployedBytecodeError.md index 8b0e0bf046..f8dfac2fdd 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidDeployedBytecodeError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidDeployedBytecodeError.md @@ -11,25 +11,25 @@ This error is typically encountered when a transaction or operation references a ## Example -```ts +```javascript +import { InvalidDeployedBytecodeError } from '@tevm/errors' +import { createMemoryClient } from '@tevm/memory-client' + +const client = createMemoryClient() + try { - // Some operation that can throw an InvalidDeployedBytecodeError + await client.setAccount({ + address: '0x...', + deployedBytecode: 'invalid', // This should be valid bytecode + }) } catch (error) { if (error instanceof InvalidDeployedBytecodeError) { - console.error(error.message); - // Handle the invalid deployedBytecode error + console.error('Invalid deployed bytecode:', error.message) + console.log('Documentation:', error.docsLink) } } ``` -## Param - -A human-readable error message. - -## Param - -Additional parameters for the InvalidDeployedBytecodeError. - ## Extends - [`InvalidParamsError`](/reference/tevm/errors/classes/invalidparamserror/) @@ -38,7 +38,7 @@ Additional parameters for the InvalidDeployedBytecodeError. ### new InvalidDeployedBytecodeError() -> **new InvalidDeployedBytecodeError**(`message`, `args`?, `tag`?): [`InvalidDeployedBytecodeError`](/reference/tevm/errors/classes/invaliddeployedbytecodeerror/) +> **new InvalidDeployedBytecodeError**(`message`, `args`?): [`InvalidDeployedBytecodeError`](/reference/tevm/errors/classes/invaliddeployedbytecodeerror/) Constructs an InvalidDeployedBytecodeError. @@ -52,10 +52,6 @@ Human-readable error message. Additional parameters for the InvalidDeployedBytecodeError. -• **tag?**: `string` = `'InvalidDeployedBytecodeError'` - -The tag for the error. - #### Returns [`InvalidDeployedBytecodeError`](/reference/tevm/errors/classes/invaliddeployedbytecodeerror/) @@ -66,7 +62,7 @@ The tag for the error. #### Defined in -[packages/errors/src/input/InvalidDeployedBytecodeError.js:48](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/input/InvalidDeployedBytecodeError.js#L48) +[packages/errors/src/input/InvalidDeployedBytecodeError.js:49](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/input/InvalidDeployedBytecodeError.js#L49) ## Properties @@ -82,7 +78,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/input/InvalidDeployedBytecodeError.js:61](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/input/InvalidDeployedBytecodeError.js#L61) *** @@ -96,7 +92,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -112,7 +108,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -126,7 +122,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -142,7 +138,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -174,7 +170,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -190,7 +186,7 @@ The name of the error, used to discriminate errors. #### Defined in -node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1076 +[packages/errors/src/input/InvalidDeployedBytecodeError.js:60](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/input/InvalidDeployedBytecodeError.js#L60) *** @@ -204,7 +200,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -232,7 +228,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -304,7 +300,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidDepthError.md b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidDepthError.md index 52ac1a6fff..c4501df556 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidDepthError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidDepthError.md @@ -82,7 +82,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -96,7 +96,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -112,7 +112,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -126,7 +126,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -142,7 +142,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -174,7 +174,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -204,7 +204,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -232,7 +232,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -304,7 +304,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidEofFormatError.md b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidEofFormatError.md index 2230a7edd4..7ad04288ab 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidEofFormatError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidEofFormatError.md @@ -102,7 +102,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -116,7 +116,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -132,7 +132,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -146,7 +146,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -162,7 +162,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -194,7 +194,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -224,7 +224,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -252,7 +252,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -334,7 +334,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidFunctionNameError.md b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidFunctionNameError.md index 81fa695d01..e8bb01c8e5 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidFunctionNameError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidFunctionNameError.md @@ -7,29 +7,30 @@ title: "InvalidFunctionNameError" Represents an error that occurs when the function name is invalid. -This error is typically encountered when a transaction or operation references a function name that is invalid or does not conform to the expected structure. +This error is typically encountered when trying to call a contract function with an invalid or non-existent function name. ## Example -```ts +```javascript +import { InvalidFunctionNameError } from '@tevm/errors' +import { createMemoryClient } from '@tevm/memory-client' + +const client = createMemoryClient() + try { - // Some operation that can throw an InvalidFunctionNameError + await client.contract({ + address: '0x1234567890123456789012345678901234567890', + abi: [...], + functionName: 'nonExistentFunction', + }) } catch (error) { if (error instanceof InvalidFunctionNameError) { - console.error(error.message); - // Handle the invalid function name error + console.error('Invalid function name:', error.message) + console.log('Documentation:', error.docsLink) } } ``` -## Param - -A human-readable error message. - -## Param - -Additional parameters for the InvalidFunctionNameError. - ## Extends - [`InvalidParamsError`](/reference/tevm/errors/classes/invalidparamserror/) @@ -38,7 +39,7 @@ Additional parameters for the InvalidFunctionNameError. ### new InvalidFunctionNameError() -> **new InvalidFunctionNameError**(`message`, `args`?, `tag`?): [`InvalidFunctionNameError`](/reference/tevm/errors/classes/invalidfunctionnameerror/) +> **new InvalidFunctionNameError**(`message`, `args`?): [`InvalidFunctionNameError`](/reference/tevm/errors/classes/invalidfunctionnameerror/) Constructs an InvalidFunctionNameError. @@ -52,10 +53,6 @@ Human-readable error message. Additional parameters for the InvalidFunctionNameError. -• **tag?**: `string` = `'InvalidFunctionNameError'` - -The tag for the error. - #### Returns [`InvalidFunctionNameError`](/reference/tevm/errors/classes/invalidfunctionnameerror/) @@ -66,7 +63,7 @@ The tag for the error. #### Defined in -[packages/errors/src/input/InvalidFunctionNameError.js:48](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/input/InvalidFunctionNameError.js#L48) +[packages/errors/src/input/InvalidFunctionNameError.js:50](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/input/InvalidFunctionNameError.js#L50) ## Properties @@ -82,7 +79,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/input/InvalidFunctionNameError.js:62](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/input/InvalidFunctionNameError.js#L62) *** @@ -96,7 +93,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -112,7 +109,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -126,7 +123,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -142,7 +139,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -174,7 +171,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -190,7 +187,7 @@ The name of the error, used to discriminate errors. #### Defined in -node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1076 +[packages/errors/src/input/InvalidFunctionNameError.js:61](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/input/InvalidFunctionNameError.js#L61) *** @@ -204,7 +201,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -232,7 +229,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -304,7 +301,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidGasLimitError.md b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidGasLimitError.md index 31277b814b..aad9fdd399 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidGasLimitError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidGasLimitError.md @@ -7,29 +7,30 @@ title: "InvalidGasLimitError" Represents an error that occurs when the gas limit is invalid. -This error is typically encountered when a transaction or operation references a gas limit that is invalid or does not conform to the expected structure. +This error is typically encountered when a transaction or operation specifies an invalid gas limit. ## Example -```ts +```javascript +import { InvalidGasLimitError } from '@tevm/errors' +import { createMemoryClient } from '@tevm/memory-client' + +const client = createMemoryClient() + try { - // Some operation that can throw an InvalidGasLimitError + await client.sendTransaction({ + from: '0x1234567890123456789012345678901234567890', + to: '0x0987654321098765432109876543210987654321', + gasLimit: -1n, // Invalid negative gas limit + }) } catch (error) { if (error instanceof InvalidGasLimitError) { - console.error(error.message); - // Handle the invalid gas limit error + console.error('Invalid gas limit:', error.message) + console.log('Documentation:', error.docsLink) } } ``` -## Param - -A human-readable error message. - -## Param - -Additional parameters for the InvalidGasLimitError. - ## Extends - [`InvalidParamsError`](/reference/tevm/errors/classes/invalidparamserror/) @@ -38,7 +39,7 @@ Additional parameters for the InvalidGasLimitError. ### new InvalidGasLimitError() -> **new InvalidGasLimitError**(`message`, `args`?, `tag`?): [`InvalidGasLimitError`](/reference/tevm/errors/classes/invalidgaslimiterror/) +> **new InvalidGasLimitError**(`message`, `args`?): [`InvalidGasLimitError`](/reference/tevm/errors/classes/invalidgaslimiterror/) Constructs an InvalidGasLimitError. @@ -52,10 +53,6 @@ Human-readable error message. Additional parameters for the InvalidGasLimitError. -• **tag?**: `string` = `'InvalidGasLimitError'` - -The tag for the error. - #### Returns [`InvalidGasLimitError`](/reference/tevm/errors/classes/invalidgaslimiterror/) @@ -66,7 +63,7 @@ The tag for the error. #### Defined in -[packages/errors/src/input/InvalidGasLimitError.js:48](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/input/InvalidGasLimitError.js#L48) +[packages/errors/src/input/InvalidGasLimitError.js:50](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/input/InvalidGasLimitError.js#L50) ## Properties @@ -82,7 +79,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/input/InvalidGasLimitError.js:62](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/input/InvalidGasLimitError.js#L62) *** @@ -96,7 +93,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -112,7 +109,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -126,7 +123,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -142,7 +139,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -174,7 +171,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -190,7 +187,7 @@ The name of the error, used to discriminate errors. #### Defined in -node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1076 +[packages/errors/src/input/InvalidGasLimitError.js:61](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/input/InvalidGasLimitError.js#L61) *** @@ -204,7 +201,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -232,7 +229,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -304,7 +301,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidGasPriceError.md b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidGasPriceError.md index 470a7520ad..7571704af5 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidGasPriceError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidGasPriceError.md @@ -82,7 +82,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -96,7 +96,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -112,7 +112,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -126,7 +126,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -142,7 +142,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -174,7 +174,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -204,7 +204,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -232,7 +232,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -304,7 +304,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidGasRefundError.md b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidGasRefundError.md index 8eeb7629a0..e4a6774b9d 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidGasRefundError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidGasRefundError.md @@ -7,29 +7,29 @@ title: "InvalidGasRefundError" Represents an error that occurs when the gas refund is invalid. -This error is typically encountered when a transaction or operation references a gas refund that is invalid or does not conform to the expected structure. +This error is typically encountered when a transaction or operation specifies an invalid gas refund value. ## Example -```ts +```javascript +import { InvalidGasRefundError } from '@tevm/errors' +import { createMemoryClient } from '@tevm/memory-client' + +const client = createMemoryClient() + try { - // Some operation that can throw an InvalidGasRefundError + await client.setAccount({ + address: '0x1234567890123456789012345678901234567890', + gasRefund: -1n, // Invalid negative gas refund + }) } catch (error) { if (error instanceof InvalidGasRefundError) { - console.error(error.message); - // Handle the invalid gas refund error + console.error('Invalid gas refund:', error.message) + console.log('Documentation:', error.docsLink) } } ``` -## Param - -A human-readable error message. - -## Param - -Additional parameters for the InvalidGasRefundError. - ## Extends - [`InvalidParamsError`](/reference/tevm/errors/classes/invalidparamserror/) @@ -38,7 +38,7 @@ Additional parameters for the InvalidGasRefundError. ### new InvalidGasRefundError() -> **new InvalidGasRefundError**(`message`, `args`?, `tag`?): [`InvalidGasRefundError`](/reference/tevm/errors/classes/invalidgasrefunderror/) +> **new InvalidGasRefundError**(`message`, `args`?): [`InvalidGasRefundError`](/reference/tevm/errors/classes/invalidgasrefunderror/) Constructs an InvalidGasRefundError. @@ -52,10 +52,6 @@ Human-readable error message. Additional parameters for the InvalidGasRefundError. -• **tag?**: `string` = `'InvalidGasRefundError'` - -The tag for the error. - #### Returns [`InvalidGasRefundError`](/reference/tevm/errors/classes/invalidgasrefunderror/) @@ -66,7 +62,7 @@ The tag for the error. #### Defined in -[packages/errors/src/input/InvalidGasRefundError.js:48](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/input/InvalidGasRefundError.js#L48) +[packages/errors/src/input/InvalidGasRefundError.js:49](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/input/InvalidGasRefundError.js#L49) ## Properties @@ -82,7 +78,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/input/InvalidGasRefundError.js:61](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/input/InvalidGasRefundError.js#L61) *** @@ -96,7 +92,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -112,7 +108,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -126,7 +122,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -142,7 +138,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -174,7 +170,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -190,7 +186,7 @@ The name of the error, used to discriminate errors. #### Defined in -node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1076 +[packages/errors/src/input/InvalidGasRefundError.js:60](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/input/InvalidGasRefundError.js#L60) *** @@ -204,7 +200,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -232,7 +228,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -304,7 +300,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidInputLengthError.md b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidInputLengthError.md index dceeb9fbf3..f978705093 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidInputLengthError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidInputLengthError.md @@ -96,7 +96,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -110,7 +110,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -126,7 +126,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -140,7 +140,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -156,7 +156,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -188,7 +188,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -218,7 +218,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -246,7 +246,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -328,7 +328,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidJumpError.md b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidJumpError.md index 5cfe762758..75844dc18a 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidJumpError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidJumpError.md @@ -104,7 +104,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -118,7 +118,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -134,7 +134,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -148,7 +148,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -164,7 +164,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -196,7 +196,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -226,7 +226,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -254,7 +254,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -336,7 +336,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidJumpSubError.md b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidJumpSubError.md index 47049e6b5b..60e2800659 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidJumpSubError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidJumpSubError.md @@ -112,7 +112,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -126,7 +126,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -142,7 +142,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -156,7 +156,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -172,7 +172,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -204,7 +204,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -234,7 +234,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -262,7 +262,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -344,7 +344,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidKzgInputsError.md b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidKzgInputsError.md index 5ba1d6271b..2568903a2a 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidKzgInputsError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidKzgInputsError.md @@ -88,7 +88,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -102,7 +102,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -118,7 +118,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -132,7 +132,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -148,7 +148,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -180,7 +180,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -210,7 +210,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -238,7 +238,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -320,7 +320,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidMaxFeePerGasError.md b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidMaxFeePerGasError.md index 8c44df23f1..bdc7cf67a5 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidMaxFeePerGasError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidMaxFeePerGasError.md @@ -7,29 +7,30 @@ title: "InvalidMaxFeePerGasError" Represents an error that occurs when the max fee per gas is invalid. -This error is typically encountered when a transaction or operation references a max fee per gas that is invalid or does not conform to the expected structure. +This error is typically encountered when a transaction specifies an invalid max fee per gas value. ## Example -```ts +```javascript +import { InvalidMaxFeePerGasError } from '@tevm/errors' +import { createMemoryClient } from '@tevm/memory-client' + +const client = createMemoryClient() + try { - // Some operation that can throw an InvalidMaxFeePerGasError + await client.sendTransaction({ + from: '0x1234567890123456789012345678901234567890', + to: '0x0987654321098765432109876543210987654321', + maxFeePerGas: -1n, // Invalid negative max fee per gas + }) } catch (error) { if (error instanceof InvalidMaxFeePerGasError) { - console.error(error.message); - // Handle the invalid max fee per gas error + console.error('Invalid max fee per gas:', error.message) + console.log('Documentation:', error.docsLink) } } ``` -## Param - -A human-readable error message. - -## Param - -Additional parameters for the InvalidMaxFeePerGasError. - ## Extends - [`InvalidParamsError`](/reference/tevm/errors/classes/invalidparamserror/) @@ -38,7 +39,7 @@ Additional parameters for the InvalidMaxFeePerGasError. ### new InvalidMaxFeePerGasError() -> **new InvalidMaxFeePerGasError**(`message`, `args`?, `tag`?): [`InvalidMaxFeePerGasError`](/reference/tevm/errors/classes/invalidmaxfeepergaserror/) +> **new InvalidMaxFeePerGasError**(`message`, `args`?): [`InvalidMaxFeePerGasError`](/reference/tevm/errors/classes/invalidmaxfeepergaserror/) Constructs an InvalidMaxFeePerGasError. @@ -52,10 +53,6 @@ Human-readable error message. Additional parameters for the InvalidMaxFeePerGasError. -• **tag?**: `string` = `'InvalidMaxFeePerGasError'` - -The tag for the error.} - #### Returns [`InvalidMaxFeePerGasError`](/reference/tevm/errors/classes/invalidmaxfeepergaserror/) @@ -66,7 +63,7 @@ The tag for the error.} #### Defined in -[packages/errors/src/input/InvalidMaxFeePerGaserror.js:48](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/input/InvalidMaxFeePerGaserror.js#L48) +[packages/errors/src/input/InvalidMaxFeePerGaserror.js:50](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/input/InvalidMaxFeePerGaserror.js#L50) ## Properties @@ -82,7 +79,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/input/InvalidMaxFeePerGaserror.js:62](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/input/InvalidMaxFeePerGaserror.js#L62) *** @@ -96,7 +93,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -112,7 +109,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -126,7 +123,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -142,7 +139,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -174,7 +171,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -190,7 +187,7 @@ The name of the error, used to discriminate errors. #### Defined in -node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1076 +[packages/errors/src/input/InvalidMaxFeePerGaserror.js:61](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/input/InvalidMaxFeePerGaserror.js#L61) *** @@ -204,7 +201,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -232,7 +229,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -304,7 +301,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidMaxPriorityFeePerGasError.md b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidMaxPriorityFeePerGasError.md index 23535d568e..95d19a2c38 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidMaxPriorityFeePerGasError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidMaxPriorityFeePerGasError.md @@ -7,29 +7,30 @@ title: "InvalidMaxPriorityFeePerGasError" Represents an error that occurs when the max priority fee per gas is invalid. -This error is typically encountered when a transaction or operation references a max priority fee per gas that is invalid or does not conform to the expected structure. +This error is typically encountered when a transaction specifies an invalid max priority fee per gas value. ## Example -```ts +```javascript +import { InvalidMaxPriorityFeePerGasError } from '@tevm/errors' +import { createMemoryClient } from '@tevm/memory-client' + +const client = createMemoryClient() + try { - // Some operation that can throw an InvalidMaxPriorityFeePerGasError + await client.sendTransaction({ + from: '0x1234567890123456789012345678901234567890', + to: '0x0987654321098765432109876543210987654321', + maxPriorityFeePerGas: -1n, // Invalid negative max priority fee per gas + }) } catch (error) { if (error instanceof InvalidMaxPriorityFeePerGasError) { - console.error(error.message); - // Handle the invalid max priority fee per gas error + console.error('Invalid max priority fee per gas:', error.message) + console.log('Documentation:', error.docsLink) } } ``` -## Param - -A human-readable error message. - -## Param - -Additional parameters for the InvalidMaxPriorityFeePerGasError. - ## Extends - [`InvalidParamsError`](/reference/tevm/errors/classes/invalidparamserror/) @@ -38,7 +39,7 @@ Additional parameters for the InvalidMaxPriorityFeePerGasError. ### new InvalidMaxPriorityFeePerGasError() -> **new InvalidMaxPriorityFeePerGasError**(`message`, `args`?, `tag`?): [`InvalidMaxPriorityFeePerGasError`](/reference/tevm/errors/classes/invalidmaxpriorityfeepergaserror/) +> **new InvalidMaxPriorityFeePerGasError**(`message`, `args`?): [`InvalidMaxPriorityFeePerGasError`](/reference/tevm/errors/classes/invalidmaxpriorityfeepergaserror/) Constructs an InvalidMaxPriorityFeePerGasError. @@ -52,10 +53,6 @@ Human-readable error message. Additional parameters for the InvalidMaxPriorityFeePerGasError. -• **tag?**: `string` = `'InvalidMaxPriorityFeePerGasError'` - -The tag for the error.} - #### Returns [`InvalidMaxPriorityFeePerGasError`](/reference/tevm/errors/classes/invalidmaxpriorityfeepergaserror/) @@ -66,7 +63,7 @@ The tag for the error.} #### Defined in -[packages/errors/src/input/InvalidMaxPriorityFeePerGas.js:48](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/input/InvalidMaxPriorityFeePerGas.js#L48) +[packages/errors/src/input/InvalidMaxPriorityFeePerGas.js:50](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/input/InvalidMaxPriorityFeePerGas.js#L50) ## Properties @@ -82,7 +79,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/input/InvalidMaxPriorityFeePerGas.js:62](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/input/InvalidMaxPriorityFeePerGas.js#L62) *** @@ -96,7 +93,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -112,7 +109,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -126,7 +123,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -142,7 +139,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -174,7 +171,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -190,7 +187,7 @@ The name of the error, used to discriminate errors. #### Defined in -node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1076 +[packages/errors/src/input/InvalidMaxPriorityFeePerGas.js:61](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/input/InvalidMaxPriorityFeePerGas.js#L61) *** @@ -204,7 +201,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -232,7 +229,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -304,7 +301,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidNonceError.md b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidNonceError.md index 5b6b38fc76..269152e4a4 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidNonceError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidNonceError.md @@ -82,7 +82,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -96,7 +96,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -112,7 +112,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -126,7 +126,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -142,7 +142,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -174,7 +174,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -204,7 +204,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -232,7 +232,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -304,7 +304,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidOpcodeError.md b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidOpcodeError.md index 0a5dc321ef..e8da7febc7 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidOpcodeError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidOpcodeError.md @@ -104,7 +104,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -118,7 +118,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -134,7 +134,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -148,7 +148,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -164,7 +164,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -196,7 +196,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -226,7 +226,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -254,7 +254,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -336,7 +336,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidOriginError.md b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidOriginError.md index 61bfa5f720..27a45c88ee 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidOriginError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidOriginError.md @@ -82,7 +82,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -96,7 +96,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -112,7 +112,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -126,7 +126,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -142,7 +142,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -174,7 +174,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -204,7 +204,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -232,7 +232,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -304,7 +304,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidParamsError.md b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidParamsError.md index 20ed26550a..461a110ed2 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidParamsError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidParamsError.md @@ -111,7 +111,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -125,7 +125,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -141,7 +141,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -155,7 +155,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -171,7 +171,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -203,7 +203,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -233,7 +233,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -261,7 +261,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -333,7 +333,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidProofError.md b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidProofError.md index 9be3150e46..7fd7cf9719 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidProofError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidProofError.md @@ -88,7 +88,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -102,7 +102,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -118,7 +118,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -132,7 +132,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -148,7 +148,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -180,7 +180,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -210,7 +210,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -238,7 +238,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -320,7 +320,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidRequestError.md b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidRequestError.md index f92c092163..be8d67e130 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidRequestError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidRequestError.md @@ -82,7 +82,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -96,7 +96,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -112,7 +112,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -126,7 +126,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -142,7 +142,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -174,7 +174,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -204,7 +204,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -232,7 +232,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -304,7 +304,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidReturnSubError.md b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidReturnSubError.md index 7061acff3e..140643c29e 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidReturnSubError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidReturnSubError.md @@ -98,7 +98,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -112,7 +112,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -128,7 +128,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -142,7 +142,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -158,7 +158,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -190,7 +190,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -220,7 +220,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -248,7 +248,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -330,7 +330,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidSaltError.md b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidSaltError.md index d837411fe7..7c0f9b41a3 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidSaltError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidSaltError.md @@ -82,7 +82,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -96,7 +96,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -112,7 +112,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -126,7 +126,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -142,7 +142,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -174,7 +174,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -204,7 +204,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -232,7 +232,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -304,7 +304,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidSelfdestructError.md b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidSelfdestructError.md index 67c82644eb..a08b520aa6 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidSelfdestructError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidSelfdestructError.md @@ -7,29 +7,29 @@ title: "InvalidSelfdestructError" Represents an error that occurs when the selfdestruct parameter is invalid. -This error is typically encountered when a transaction or operation references a selfdestruct parameter that is invalid or does not conform to the expected structure. +This error is typically encountered when setting an account's selfdestruct status with an invalid value. ## Example -```ts +```javascript +import { InvalidSelfdestructError } from '@tevm/errors' +import { createMemoryClient } from '@tevm/memory-client' + +const client = createMemoryClient() + try { - // Some operation that can throw an InvalidSelfdestructError + await client.setAccount({ + address: '0x1234567890123456789012345678901234567890', + selfdestruct: 'not_a_boolean', // Should be a boolean + }) } catch (error) { if (error instanceof InvalidSelfdestructError) { - console.error(error.message); - // Handle the invalid selfdestruct error + console.error('Invalid selfdestruct value:', error.message) + console.log('Documentation:', error.docsLink) } } ``` -## Param - -A human-readable error message. - -## Param - -Additional parameters for the InvalidSelfdestructError. - ## Extends - [`InvalidParamsError`](/reference/tevm/errors/classes/invalidparamserror/) @@ -38,7 +38,7 @@ Additional parameters for the InvalidSelfdestructError. ### new InvalidSelfdestructError() -> **new InvalidSelfdestructError**(`message`, `args`?, `tag`?): [`InvalidSelfdestructError`](/reference/tevm/errors/classes/invalidselfdestructerror/) +> **new InvalidSelfdestructError**(`message`, `args`?): [`InvalidSelfdestructError`](/reference/tevm/errors/classes/invalidselfdestructerror/) Constructs an InvalidSelfdestructError. @@ -52,10 +52,6 @@ Human-readable error message. Additional parameters for the InvalidSelfdestructError. -• **tag?**: `string` = `'InvalidSelfdestructError'` - -The tag for the error. - #### Returns [`InvalidSelfdestructError`](/reference/tevm/errors/classes/invalidselfdestructerror/) @@ -66,7 +62,7 @@ The tag for the error. #### Defined in -[packages/errors/src/input/InvalidSelfdestructError.js:48](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/input/InvalidSelfdestructError.js#L48) +[packages/errors/src/input/InvalidSelfdestructError.js:49](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/input/InvalidSelfdestructError.js#L49) ## Properties @@ -82,7 +78,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/input/InvalidSelfdestructError.js:61](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/input/InvalidSelfdestructError.js#L61) *** @@ -96,7 +92,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -112,7 +108,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -126,7 +122,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -142,7 +138,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -174,7 +170,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -190,7 +186,7 @@ The name of the error, used to discriminate errors. #### Defined in -node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1076 +[packages/errors/src/input/InvalidSelfdestructError.js:60](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/input/InvalidSelfdestructError.js#L60) *** @@ -204,7 +200,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -232,7 +228,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -304,7 +300,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidSignatureError.md b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidSignatureError.md index 89e13a680a..cbe8e372b0 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidSignatureError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidSignatureError.md @@ -82,7 +82,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -96,7 +96,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -112,7 +112,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -126,7 +126,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -142,7 +142,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -174,7 +174,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -204,7 +204,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -232,7 +232,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -304,7 +304,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidSkipBalanceError.md b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidSkipBalanceError.md index 1285ee758e..a5263f10c9 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidSkipBalanceError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidSkipBalanceError.md @@ -7,29 +7,29 @@ title: "InvalidSkipBalanceError" Represents an error that occurs when the skipBalance parameter is invalid. -This error is typically encountered when a transaction or operation references a skipBalance parameter that is invalid or does not conform to the expected structure. +This error is typically encountered when a transaction or operation uses an invalid skipBalance value. ## Example -```ts +```javascript +import { InvalidSkipBalanceError } from '@tevm/errors' +import { createMemoryClient } from '@tevm/memory-client' + +const client = createMemoryClient() + try { - // Some operation that can throw an InvalidSkipBalanceError + await client.setAccount({ + address: '0x...', + skipBalance: 'invalid', // This should be a boolean + }) } catch (error) { if (error instanceof InvalidSkipBalanceError) { - console.error(error.message); - // Handle the invalid skip balance error + console.error('Invalid skipBalance:', error.message) + console.log('Documentation:', error.docsLink) } } ``` -## Param - -A human-readable error message. - -## Param - -Additional parameters for the InvalidSkipBalanceError. - ## Extends - [`InvalidParamsError`](/reference/tevm/errors/classes/invalidparamserror/) @@ -38,7 +38,7 @@ Additional parameters for the InvalidSkipBalanceError. ### new InvalidSkipBalanceError() -> **new InvalidSkipBalanceError**(`message`, `args`?, `tag`?): [`InvalidSkipBalanceError`](/reference/tevm/errors/classes/invalidskipbalanceerror/) +> **new InvalidSkipBalanceError**(`message`, `args`?): [`InvalidSkipBalanceError`](/reference/tevm/errors/classes/invalidskipbalanceerror/) Constructs an InvalidSkipBalanceError. @@ -52,10 +52,6 @@ Human-readable error message. Additional parameters for the InvalidSkipBalanceError. -• **tag?**: `string` = `'InvalidSkipBalanceError'` - -The tag for the error.} - #### Returns [`InvalidSkipBalanceError`](/reference/tevm/errors/classes/invalidskipbalanceerror/) @@ -66,7 +62,7 @@ The tag for the error.} #### Defined in -[packages/errors/src/input/InvalidSkipBalanceError.js:48](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/input/InvalidSkipBalanceError.js#L48) +[packages/errors/src/input/InvalidSkipBalanceError.js:49](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/input/InvalidSkipBalanceError.js#L49) ## Properties @@ -82,7 +78,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/input/InvalidSkipBalanceError.js:61](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/input/InvalidSkipBalanceError.js#L61) *** @@ -96,7 +92,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -112,7 +108,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -126,7 +122,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -142,7 +138,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -174,7 +170,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -190,7 +186,7 @@ The name of the error, used to discriminate errors. #### Defined in -node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1076 +[packages/errors/src/input/InvalidSkipBalanceError.js:60](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/input/InvalidSkipBalanceError.js#L60) *** @@ -204,7 +200,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -232,7 +228,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -304,7 +300,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidStorageRootError.md b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidStorageRootError.md index a7082c3c4e..b03a044e8c 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidStorageRootError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidStorageRootError.md @@ -11,25 +11,25 @@ This error is typically encountered when a transaction or operation references a ## Example -```ts +```javascript +import { InvalidStorageRootError } from '@tevm/errors' +import { createMemoryClient } from '@tevm/memory-client' + +const client = createMemoryClient() + try { - // Some operation that can throw an InvalidStorageRootError + await client.setAccount({ + address: '0x...', + storageRoot: 'invalid', // This should be a valid storage root + }) } catch (error) { if (error instanceof InvalidStorageRootError) { - console.error(error.message); - // Handle the invalid storage root error + console.error('Invalid storage root:', error.message) + console.log('Documentation:', error.docsLink) } } ``` -## Param - -A human-readable error message. - -## Param - -Additional parameters for the InvalidStorageRootError. - ## Extends - [`InvalidParamsError`](/reference/tevm/errors/classes/invalidparamserror/) @@ -38,7 +38,7 @@ Additional parameters for the InvalidStorageRootError. ### new InvalidStorageRootError() -> **new InvalidStorageRootError**(`message`, `args`?, `tag`?): [`InvalidStorageRootError`](/reference/tevm/errors/classes/invalidstoragerooterror/) +> **new InvalidStorageRootError**(`message`, `args`?): [`InvalidStorageRootError`](/reference/tevm/errors/classes/invalidstoragerooterror/) Constructs an InvalidStorageRootError. @@ -52,10 +52,6 @@ Human-readable error message. Additional parameters for the InvalidStorageRootError. -• **tag?**: `string` = `'InvalidStorageRootError'` - -The tag for the error. - #### Returns [`InvalidStorageRootError`](/reference/tevm/errors/classes/invalidstoragerooterror/) @@ -66,7 +62,7 @@ The tag for the error. #### Defined in -[packages/errors/src/input/InvalidStorageRootError.js:48](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/input/InvalidStorageRootError.js#L48) +[packages/errors/src/input/InvalidStorageRootError.js:49](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/input/InvalidStorageRootError.js#L49) ## Properties @@ -82,7 +78,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/input/InvalidStorageRootError.js:61](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/input/InvalidStorageRootError.js#L61) *** @@ -96,7 +92,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -112,7 +108,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -126,7 +122,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -142,7 +138,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -174,7 +170,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -190,7 +186,7 @@ The name of the error, used to discriminate errors. #### Defined in -node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1076 +[packages/errors/src/input/InvalidStorageRootError.js:60](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/input/InvalidStorageRootError.js#L60) *** @@ -204,7 +200,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -232,7 +228,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -304,7 +300,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidToError.md b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidToError.md index 63d8d9573a..707757969f 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidToError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidToError.md @@ -5,31 +5,32 @@ prev: false title: "InvalidToError" --- -Represents an error that occurs when the 'to' parameter is invalid. +Represents an error that occurs when the 'to' address in a transaction or operation is invalid. -This error is typically encountered when a transaction or operation references a 'to' parameter that is invalid or does not conform to the expected structure. +This error is typically encountered when a transaction or contract interaction specifies an invalid recipient address. ## Example -```ts +```javascript +import { InvalidToError } from '@tevm/errors' +import { createMemoryClient } from '@tevm/memory-client' + +const client = createMemoryClient() + try { - // Some operation that can throw an InvalidToError + await client.sendTransaction({ + from: '0x1234567890123456789012345678901234567890', + to: 'invalid_address', // Invalid 'to' address + value: 1000n, + }) } catch (error) { if (error instanceof InvalidToError) { - console.error(error.message); - // Handle the invalid 'to' error + console.error('Invalid to address:', error.message) + console.log('Documentation:', error.docsLink) } } ``` -## Param - -A human-readable error message. - -## Param - -Additional parameters for the InvalidToError. - ## Extends - [`InvalidParamsError`](/reference/tevm/errors/classes/invalidparamserror/) @@ -38,7 +39,7 @@ Additional parameters for the InvalidToError. ### new InvalidToError() -> **new InvalidToError**(`message`, `args`?, `tag`?): [`InvalidToError`](/reference/tevm/errors/classes/invalidtoerror/) +> **new InvalidToError**(`message`, `args`?): [`InvalidToError`](/reference/tevm/errors/classes/invalidtoerror/) Constructs an InvalidToError. @@ -52,10 +53,6 @@ Human-readable error message. Additional parameters for the InvalidToError. -• **tag?**: `string` = `'InvalidToError'` - -The tag for the error. - #### Returns [`InvalidToError`](/reference/tevm/errors/classes/invalidtoerror/) @@ -66,7 +63,7 @@ The tag for the error. #### Defined in -[packages/errors/src/input/InvalidToError.js:48](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/input/InvalidToError.js#L48) +[packages/errors/src/input/InvalidToError.js:50](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/input/InvalidToError.js#L50) ## Properties @@ -82,7 +79,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/input/InvalidToError.js:62](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/input/InvalidToError.js#L62) *** @@ -96,7 +93,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -112,7 +109,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -126,7 +123,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -142,7 +139,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -174,7 +171,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -190,7 +187,7 @@ The name of the error, used to discriminate errors. #### Defined in -node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1076 +[packages/errors/src/input/InvalidToError.js:61](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/input/InvalidToError.js#L61) *** @@ -204,7 +201,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -232,7 +229,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -304,7 +301,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidTransactionError.md b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidTransactionError.md index 8e05eeaa8e..a4458cd150 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidTransactionError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidTransactionError.md @@ -82,7 +82,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -96,7 +96,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -112,7 +112,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -126,7 +126,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -142,7 +142,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -174,7 +174,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -204,7 +204,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -232,7 +232,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -304,7 +304,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidUrlError.md b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidUrlError.md index 313e8bc4c7..598204b677 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidUrlError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidUrlError.md @@ -5,31 +5,30 @@ prev: false title: "InvalidUrlError" --- -Represents an error that occurs when the 'url' parameter is invalid. +Represents an error that occurs when a URL is invalid. -This error is typically encountered when a transaction or operation references a 'url' parameter that is invalid or does not conform to the expected structure. +This error is typically encountered when an operation requires a valid URL, but receives an invalid one. ## Example -```ts +```javascript +import { InvalidUrlError } from '@tevm/errors' +import { createMemoryClient } from '@tevm/memory-client' + try { - // Some operation that can throw an InvalidUrlError + const client = createMemoryClient({ + fork: { + url: 'not_a_valid_url' + } + }) } catch (error) { if (error instanceof InvalidUrlError) { - console.error(error.message); - // Handle the invalid 'url' error + console.error('Invalid URL:', error.message) + console.log('Documentation:', error.docsLink) } } ``` -## Param - -A human-readable error message. - -## Param - -Additional parameters for the InvalidUrlError. - ## Extends - [`InvalidParamsError`](/reference/tevm/errors/classes/invalidparamserror/) @@ -38,7 +37,7 @@ Additional parameters for the InvalidUrlError. ### new InvalidUrlError() -> **new InvalidUrlError**(`message`, `args`?, `tag`?): [`InvalidUrlError`](/reference/tevm/errors/classes/invalidurlerror/) +> **new InvalidUrlError**(`message`, `args`?): [`InvalidUrlError`](/reference/tevm/errors/classes/invalidurlerror/) Constructs an InvalidUrlError. @@ -52,10 +51,6 @@ Human-readable error message. Additional parameters for the InvalidUrlError. -• **tag?**: `string` = `'InvalidUrlError'` - -The tag for the error.} - #### Returns [`InvalidUrlError`](/reference/tevm/errors/classes/invalidurlerror/) @@ -82,7 +77,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/input/InvalidUrlError.js:60](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/input/InvalidUrlError.js#L60) *** @@ -96,7 +91,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -112,7 +107,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -126,7 +121,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -142,7 +137,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -174,7 +169,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -190,7 +185,7 @@ The name of the error, used to discriminate errors. #### Defined in -node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1076 +[packages/errors/src/input/InvalidUrlError.js:59](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/input/InvalidUrlError.js#L59) *** @@ -204,7 +199,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -232,7 +227,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -304,7 +299,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidValueError.md b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidValueError.md index 12eb21c56f..7198314143 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/InvalidValueError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/InvalidValueError.md @@ -82,7 +82,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -96,7 +96,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -112,7 +112,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -126,7 +126,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -142,7 +142,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -174,7 +174,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -204,7 +204,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -232,7 +232,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -304,7 +304,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/LimitExceededError.md b/docs/src/content/docs/reference/@tevm/errors/classes/LimitExceededError.md index 5396168978..d0d31aa93c 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/LimitExceededError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/LimitExceededError.md @@ -82,7 +82,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -96,7 +96,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -112,7 +112,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -126,7 +126,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -142,7 +142,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -174,7 +174,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -204,7 +204,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -232,7 +232,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -304,7 +304,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/MethodNotFoundError.md b/docs/src/content/docs/reference/@tevm/errors/classes/MethodNotFoundError.md index 450e4b6e5d..076afb2614 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/MethodNotFoundError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/MethodNotFoundError.md @@ -82,7 +82,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -96,7 +96,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -112,7 +112,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -126,7 +126,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -142,7 +142,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -174,7 +174,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -204,7 +204,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -232,7 +232,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -304,7 +304,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/MethodNotSupportedError.md b/docs/src/content/docs/reference/@tevm/errors/classes/MethodNotSupportedError.md index d8049c3fcb..6cc4eb8506 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/MethodNotSupportedError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/MethodNotSupportedError.md @@ -82,7 +82,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -96,7 +96,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -112,7 +112,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -126,7 +126,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -142,7 +142,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -174,7 +174,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -204,7 +204,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -232,7 +232,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -304,7 +304,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/MisconfiguredClientError.md b/docs/src/content/docs/reference/@tevm/errors/classes/MisconfiguredClientError.md index a9c2e9151d..a3ecb05249 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/MisconfiguredClientError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/MisconfiguredClientError.md @@ -7,31 +7,35 @@ title: "MisconfiguredClientError" Represents an error that occurs when the Client is misconfigured. -Misconfigured memory client errors can occur due to: -- Incorrect configuration parameters provided when creating a Client. +This error can be thrown when: +- Incorrect configuration parameters are provided when creating a Client. +- The Client is used in a way that's incompatible with its configuration. ## Example ```typescript +import { createMemoryClient } from '@tevm/memory-client' import { MisconfiguredClientError } from '@tevm/errors' + +const memoryClient = createMemoryClient({ + // Assume we've misconfigured something here +}) + try { - // Some operation that can throw a MisconfiguredClientError + await memoryClient.tevmCall({ + to: '0x...', + data: '0x...', + }) } catch (error) { if (error instanceof MisconfiguredClientError) { - console.error(error.message); - // Handle the misconfigured memory client error + console.error('Client misconfiguration:', error.message) + console.log('Documentation:', error.docsLink) + // Attempt to recreate the client with correct configuration + // or notify the user to check their client setup } } ``` -## Param - -A human-readable error message. - -## Param - -Additional parameters for the BaseError. - ## Extends - [`InternalError`](/reference/tevm/errors/classes/internalerror/) @@ -40,23 +44,19 @@ Additional parameters for the BaseError. ### new MisconfiguredClientError() -> **new MisconfiguredClientError**(`message`?, `args`?, `tag`?): [`MisconfiguredClientError`](/reference/tevm/errors/classes/misconfiguredclienterror/) +> **new MisconfiguredClientError**(`message`?, `args`?): [`MisconfiguredClientError`](/reference/tevm/errors/classes/misconfiguredclienterror/) Constructs a MisconfiguredClientError. #### Parameters -• **message?**: `string` = `'Misconfigured memory client error occurred.'` +• **message?**: `string` = `'Misconfigured client error occurred.'` Human-readable error message. • **args?**: [`MisconfiguredClientErrorParameters`](/reference/tevm/errors/interfaces/misconfiguredclienterrorparameters/) = `{}` -Additional parameters for the BaseError. - -• **tag?**: `string` = `'MisconfiguredClientError'` - -The tag for the error. +Additional parameters for the error. #### Returns @@ -68,7 +68,7 @@ The tag for the error. #### Defined in -[packages/errors/src/client/MisconfiguredClient.js:52](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/client/MisconfiguredClient.js#L52) +[packages/errors/src/client/MisconfiguredClient.js:55](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/client/MisconfiguredClient.js#L55) ## Properties @@ -84,7 +84,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/InternalErrorError.js:68](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/InternalErrorError.js#L68) *** @@ -98,7 +98,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -106,7 +106,7 @@ Same as name, used internally. > **code**: `number` -Error code, analogous to the code in JSON RPC error. +Error code (-32603), standard JSON-RPC error code for internal errors. #### Inherited from @@ -114,7 +114,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -128,7 +128,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -144,7 +144,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -176,7 +176,7 @@ Optional object containing additional information about the error. #### Defined in -[packages/errors/src/ethereum/InternalErrorError.js:64](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/InternalErrorError.js#L64) +[packages/errors/src/ethereum/InternalErrorError.js:69](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/InternalErrorError.js#L69) *** @@ -192,7 +192,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -208,7 +208,7 @@ The name of the error, used to discriminate errors. #### Defined in -node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1076 +[packages/errors/src/ethereum/InternalErrorError.js:67](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/InternalErrorError.js#L67) *** @@ -222,7 +222,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -250,7 +250,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -322,7 +322,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/NoForkTransportSetError.md b/docs/src/content/docs/reference/@tevm/errors/classes/NoForkTransportSetError.md index 57c7229fa2..115f43e108 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/NoForkTransportSetError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/NoForkTransportSetError.md @@ -6,15 +6,25 @@ title: "NoForkTransportSetError" --- Error represents the tevm client attempted to fetch a resource from a Forked transport but no transport was set. -To set a transport use the `fork.transport` option for [`createMemoryClient`](https://tevm.sh/reference/tevm/memory-client/functions/creatememoryclient/) -## Param +## Example -A human-readable error message. +```javascript +import { NoForkTransportSetError } from '@tevm/errors' +import { createMemoryClient } from '@tevm/memory-client' -## Param +const client = createMemoryClient() // No fork configuration -Additional parameters for the InvalidParamsError. +try { + await client.getBalance('0x...') // This might throw if it needs to access forked state +} catch (error) { + if (error instanceof NoForkTransportSetError) { + console.error('No fork transport set:', error.message) + console.log('Documentation:', error.docsLink) + // Handle the error, e.g., by setting up a fork configuration + } +} +``` ## Extends @@ -24,9 +34,9 @@ Additional parameters for the InvalidParamsError. ### new NoForkTransportSetError() -> **new NoForkTransportSetError**(`message`, `args`?, `tag`?): [`NoForkTransportSetError`](/reference/tevm/errors/classes/noforktransportseterror/) +> **new NoForkTransportSetError**(`message`, `args`?): [`NoForkTransportSetError`](/reference/tevm/errors/classes/noforktransportseterror/) -Constructs an NoForkTransportSetError. +Constructs a NoForkTransportSetError. #### Parameters @@ -36,9 +46,7 @@ Human-readable error message. • **args?**: [`NoForkTransportSetErrorParameters`](/reference/tevm/errors/interfaces/noforktransportseterrorparameters/) = `{}` -Additional parameters to pass to BaseError. - -• **tag?**: `string` = `'NoForkTransportSetError'` +Additional parameters for the error. #### Returns @@ -50,7 +58,7 @@ Additional parameters to pass to BaseError. #### Defined in -[packages/errors/src/fork/NoForkUriSetError.js:36](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/fork/NoForkUriSetError.js#L36) +[packages/errors/src/fork/NoForkUriSetError.js:45](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/fork/NoForkUriSetError.js#L45) ## Properties @@ -58,15 +66,13 @@ Additional parameters to pass to BaseError. > **\_tag**: `string` -Same as name, used internally. - #### Inherited from [`BaseError`](/reference/tevm/errors/classes/baseerror/).[`_tag`](/reference/tevm/errors/classes/baseerror/#_tag) #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/fork/NoForkUriSetError.js:57](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/fork/NoForkUriSetError.js#L57) *** @@ -80,7 +86,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -88,15 +94,13 @@ Same as name, used internally. > **code**: `number` -Error code, analogous to the code in JSON RPC error. - #### Inherited from [`BaseError`](/reference/tevm/errors/classes/baseerror/).[`code`](/reference/tevm/errors/classes/baseerror/#code) #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -110,7 +114,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -118,15 +122,13 @@ Error code, analogous to the code in JSON RPC error. > **docsPath**: `undefined` \| `string` -Path to the documentation for this error. - #### Inherited from [`BaseError`](/reference/tevm/errors/classes/baseerror/).[`docsPath`](/reference/tevm/errors/classes/baseerror/#docspath) #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -134,8 +136,6 @@ Path to the documentation for this error. > **message**: `string` -Human-readable error message. - #### Inherited from [`BaseError`](/reference/tevm/errors/classes/baseerror/).[`message`](/reference/tevm/errors/classes/baseerror/#message) @@ -150,15 +150,13 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 > **metaMessages**: `undefined` \| `string`[] -Additional meta messages for more context. - #### Inherited from [`BaseError`](/reference/tevm/errors/classes/baseerror/).[`metaMessages`](/reference/tevm/errors/classes/baseerror/#metamessages) #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -166,15 +164,13 @@ Additional meta messages for more context. > **name**: `string` -The name of the error, used to discriminate errors. - #### Inherited from [`BaseError`](/reference/tevm/errors/classes/baseerror/).[`name`](/reference/tevm/errors/classes/baseerror/#name) #### Defined in -node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1076 +[packages/errors/src/fork/NoForkUriSetError.js:56](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/fork/NoForkUriSetError.js#L56) *** @@ -188,7 +184,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -216,7 +212,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -288,7 +284,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/NonceAlreadyUsedError.md b/docs/src/content/docs/reference/@tevm/errors/classes/NonceAlreadyUsedError.md index d1a6246830..2451628b67 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/NonceAlreadyUsedError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/NonceAlreadyUsedError.md @@ -82,7 +82,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -96,7 +96,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -112,7 +112,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -126,7 +126,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -142,7 +142,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -174,7 +174,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -204,7 +204,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -232,7 +232,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -304,7 +304,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/NonceTooHighError.md b/docs/src/content/docs/reference/@tevm/errors/classes/NonceTooHighError.md index b03c8b7818..93773e840f 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/NonceTooHighError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/NonceTooHighError.md @@ -5,19 +5,29 @@ prev: false title: "NonceTooHighError" --- -Represents an error that occurs when the nonce value is too high. +Represents an error that occurs when the nonce value is too high for a transaction. -This error is typically encountered when a transaction is attempted with a nonce that is higher than the next expected nonce. +This error is typically encountered when a transaction is submitted with a nonce that is higher +than the expected next nonce for the sender's account. In Ethereum, nonces must be used in strict +sequential order to ensure transactions are processed correctly. + +The error code -32000 is a standard Ethereum JSON-RPC error code indicating a generic server error, +which is often used for various transaction-related errors including nonce issues. ## Example ```ts try { - // Some operation that can throw a NonceTooHighError + await client.sendTransaction({ + from: '0x1234567890123456789012345678901234567890', + to: '0x0987654321098765432109876543210987654321', + value: '0x1', + nonce: 100 // Assuming this nonce is too high + }) } catch (error) { if (error instanceof NonceTooHighError) { - console.error(error.message); - // Handle the nonce too high error + console.error('Nonce too high:', error.message); + console.log('Try decreasing the nonce or use `await client.getTransactionCount(address)` to get the correct nonce'); } } ``` @@ -66,7 +76,7 @@ The tag for the error. #### Defined in -[packages/errors/src/ethereum/NonceTooHighError.js:49](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/NonceTooHighError.js#L49) +[packages/errors/src/ethereum/NonceTooHighError.js:59](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/NonceTooHighError.js#L59) ## Properties @@ -82,7 +92,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/NonceTooHighError.js:72](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/NonceTooHighError.js#L72) *** @@ -96,7 +106,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -104,7 +114,7 @@ Same as name, used internally. > **code**: `number` -Error code, analogous to the code in JSON RPC error. +Error code (-32000), standard Ethereum JSON-RPC error code for server errors. #### Inherited from @@ -112,7 +122,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -126,7 +136,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -142,7 +152,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -174,7 +184,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -190,7 +200,7 @@ The name of the error, used to discriminate errors. #### Defined in -node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1076 +[packages/errors/src/ethereum/NonceTooHighError.js:71](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/NonceTooHighError.js#L71) *** @@ -204,7 +214,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -232,7 +242,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -304,7 +314,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/NonceTooLowError.md b/docs/src/content/docs/reference/@tevm/errors/classes/NonceTooLowError.md index e4cd747aac..ae06a8a5ea 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/NonceTooLowError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/NonceTooLowError.md @@ -5,19 +5,29 @@ prev: false title: "NonceTooLowError" --- -Represents an error that occurs when the nonce value is too low. +Represents an error that occurs when the nonce value is too low for a transaction. -This error is typically encountered when a transaction is attempted with a nonce that is lower than the next expected nonce. +This error is typically encountered when a transaction is submitted with a nonce that is lower +than the current nonce for the sender's account. In Ethereum, nonces are used to ensure +transactions are processed in the correct order and to prevent double-spending. + +The error code -32000 is a standard Ethereum JSON-RPC error code indicating a generic server error, +which is often used for various transaction-related errors including nonce issues. ## Example ```ts try { - // Some operation that can throw a NonceTooLowError + await client.sendTransaction({ + from: '0x1234567890123456789012345678901234567890', + to: '0x0987654321098765432109876543210987654321', + value: '0x1', + nonce: 5 // Assuming this nonce is too low + }) } catch (error) { if (error instanceof NonceTooLowError) { - console.error(error.message); - // Handle the nonce too low error + console.error('Nonce too low:', error.message); + console.log('Try increasing the nonce or use `await client.getTransactionCount(address)` to get the correct nonce'); } } ``` @@ -66,7 +76,7 @@ The tag for the error. #### Defined in -[packages/errors/src/ethereum/NonceTooLowError.js:49](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/NonceTooLowError.js#L49) +[packages/errors/src/ethereum/NonceTooLowError.js:58](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/NonceTooLowError.js#L58) ## Properties @@ -82,7 +92,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/NonceTooLowError.js:71](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/NonceTooLowError.js#L71) *** @@ -96,7 +106,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -104,7 +114,7 @@ Same as name, used internally. > **code**: `number` -Error code, analogous to the code in JSON RPC error. +Error code (-32000), standard Ethereum JSON-RPC error code for server errors. #### Inherited from @@ -112,7 +122,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -126,7 +136,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -142,7 +152,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -174,7 +184,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -190,7 +200,7 @@ The name of the error, used to discriminate errors. #### Defined in -node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1076 +[packages/errors/src/ethereum/NonceTooLowError.js:70](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/NonceTooLowError.js#L70) *** @@ -204,7 +214,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -232,7 +242,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -304,7 +314,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/OutOfGasError.md b/docs/src/content/docs/reference/@tevm/errors/classes/OutOfGasError.md index a3cbed6313..e74ea26c83 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/OutOfGasError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/OutOfGasError.md @@ -111,7 +111,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -125,7 +125,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -141,7 +141,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -155,7 +155,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -171,7 +171,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -203,7 +203,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -233,7 +233,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -261,7 +261,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -343,7 +343,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/OutOfRangeError.md b/docs/src/content/docs/reference/@tevm/errors/classes/OutOfRangeError.md index 2f9369f074..f00407e9a9 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/OutOfRangeError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/OutOfRangeError.md @@ -106,7 +106,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -120,7 +120,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -136,7 +136,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -150,7 +150,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -166,7 +166,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -198,7 +198,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -228,7 +228,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -256,7 +256,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -338,7 +338,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/ParseError.md b/docs/src/content/docs/reference/@tevm/errors/classes/ParseError.md index 670eaae61f..e22f42ea5a 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/ParseError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/ParseError.md @@ -8,16 +8,22 @@ title: "ParseError" Represents an error that occurs when invalid JSON is received by the server, resulting in a parsing error. This error is typically encountered when a JSON-RPC request is malformed or the JSON syntax is incorrect. +It's a standard JSON-RPC error with code -32700, indicating issues at the protocol level rather than +the application level. ## Example ```ts try { - // Some operation that can throw a ParseError + await client.request({ + method: 'eth_getBalance', + params: ['0x1234567890123456789012345678901234567890', 'latest'], + // Imagine this request is somehow malformed JSON + }) } catch (error) { if (error instanceof ParseError) { - console.error(error.message); - // Handle the parse error + console.error('JSON-RPC parse error:', error.message); + console.log('Check the request format and try again'); } } ``` @@ -66,7 +72,7 @@ The tag for the error. #### Defined in -[packages/errors/src/ethereum/ParseErrorError.js:49](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/ParseErrorError.js#L49) +[packages/errors/src/ethereum/ParseErrorError.js:54](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/ParseErrorError.js#L54) ## Properties @@ -82,7 +88,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/ParseErrorError.js:67](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/ParseErrorError.js#L67) *** @@ -96,7 +102,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -104,7 +110,7 @@ Same as name, used internally. > **code**: `number` -Error code, analogous to the code in JSON RPC error. +Error code (-32700), standard JSON-RPC error code for parse errors. #### Inherited from @@ -112,7 +118,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -126,7 +132,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -142,7 +148,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -174,7 +180,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -190,7 +196,7 @@ The name of the error, used to discriminate errors. #### Defined in -node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1076 +[packages/errors/src/ethereum/ParseErrorError.js:66](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/ParseErrorError.js#L66) *** @@ -204,7 +210,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -232,7 +238,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -304,7 +310,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/PendingTransactionTimeoutError.md b/docs/src/content/docs/reference/@tevm/errors/classes/PendingTransactionTimeoutError.md index a167749878..dc465d3219 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/PendingTransactionTimeoutError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/PendingTransactionTimeoutError.md @@ -82,7 +82,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -96,7 +96,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -112,7 +112,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -126,7 +126,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -142,7 +142,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -174,7 +174,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -204,7 +204,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -232,7 +232,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -304,7 +304,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/RateLimitExceededError.md b/docs/src/content/docs/reference/@tevm/errors/classes/RateLimitExceededError.md index 10e02438ee..a564d77200 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/RateLimitExceededError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/RateLimitExceededError.md @@ -82,7 +82,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -96,7 +96,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -112,7 +112,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -126,7 +126,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -142,7 +142,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -174,7 +174,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -204,7 +204,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -232,7 +232,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -304,7 +304,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/RefundExhaustedError.md b/docs/src/content/docs/reference/@tevm/errors/classes/RefundExhaustedError.md index 0c01f3157c..5d40fa9e56 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/RefundExhaustedError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/RefundExhaustedError.md @@ -98,7 +98,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -112,7 +112,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -128,7 +128,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -142,7 +142,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -158,7 +158,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -190,7 +190,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -220,7 +220,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -248,7 +248,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -330,7 +330,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/ResourceNotFoundError.md b/docs/src/content/docs/reference/@tevm/errors/classes/ResourceNotFoundError.md index 3f8aaebee7..3ecbb57aab 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/ResourceNotFoundError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/ResourceNotFoundError.md @@ -86,7 +86,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -100,7 +100,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -116,7 +116,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -130,7 +130,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -146,7 +146,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -178,7 +178,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -208,7 +208,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -236,7 +236,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -308,7 +308,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/ResourceUnavailableError.md b/docs/src/content/docs/reference/@tevm/errors/classes/ResourceUnavailableError.md index dd89cdc1c0..acfd1dcfb4 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/ResourceUnavailableError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/ResourceUnavailableError.md @@ -82,7 +82,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -96,7 +96,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -112,7 +112,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -126,7 +126,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -142,7 +142,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -174,7 +174,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -204,7 +204,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -232,7 +232,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -304,7 +304,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/RevertError.md b/docs/src/content/docs/reference/@tevm/errors/classes/RevertError.md index bf60a5849f..b6c66f49b3 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/RevertError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/RevertError.md @@ -5,25 +5,32 @@ prev: false title: "RevertError" --- -Represents an error that occurs when a transaction execution is reverted. +Represents an error that occurs when a transaction or message call is reverted. -This error is typically encountered when a transaction or contract execution is reverted by the EVM. +This error is typically encountered when a contract explicitly calls the `revert` +operation or when a condition in a `require` statement is not met. It's a way for +smart contracts to signal that an operation should be rolled back due to a failure +condition. + +The error code -32000 is a standard Ethereum JSON-RPC error code indicating a +generic server error, which is often used for revert errors. ## Example ```ts try { - // Some operation that can throw a RevertError + const result = await client.call({ + to: '0x742d35Cc6634C0532925a3b844Bc454e4438f44e', + data: '0x...' // encoded function call that might revert + }) } catch (error) { if (error instanceof RevertError) { - console.error(error.message); - // Handle the revert error + console.error('Transaction reverted:', error.message); + console.log('Revert reason:', error.data); // If available } } ``` -## Abstract - ## Param A human-readable error message. @@ -60,6 +67,8 @@ Additional parameters for the BaseError. • **tag?**: `string` = `'RevertError'` +The tag for the error. + #### Returns [`RevertError`](/reference/tevm/errors/classes/reverterror/) @@ -70,7 +79,7 @@ Additional parameters for the BaseError. #### Defined in -[packages/errors/src/ethereum/RevertError.js:48](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/RevertError.js#L48) +[packages/errors/src/ethereum/RevertError.js:57](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/RevertError.js#L57) ## Properties @@ -86,7 +95,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/RevertError.js:70](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/RevertError.js#L70) *** @@ -100,7 +109,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -108,7 +117,7 @@ Same as name, used internally. > **code**: `number` -Error code, analogous to the code in JSON RPC error. +Error code (-32000), standard Ethereum JSON-RPC error code for server errors. #### Inherited from @@ -116,7 +125,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -130,7 +139,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -146,7 +155,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -178,7 +187,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -194,7 +203,7 @@ The name of the error, used to discriminate errors. #### Defined in -node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1076 +[packages/errors/src/ethereum/RevertError.js:69](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/RevertError.js#L69) *** @@ -208,7 +217,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -236,7 +245,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -308,7 +317,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/StackOverflowError.md b/docs/src/content/docs/reference/@tevm/errors/classes/StackOverflowError.md index 75f5b96c0f..9c3f5ac63b 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/StackOverflowError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/StackOverflowError.md @@ -107,7 +107,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -121,7 +121,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -137,7 +137,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -151,7 +151,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -167,7 +167,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -199,7 +199,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -229,7 +229,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -257,7 +257,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -339,7 +339,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/StackUnderflowError.md b/docs/src/content/docs/reference/@tevm/errors/classes/StackUnderflowError.md index c2675da7da..8702202815 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/StackUnderflowError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/StackUnderflowError.md @@ -104,7 +104,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -118,7 +118,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -134,7 +134,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -148,7 +148,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -164,7 +164,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -196,7 +196,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -226,7 +226,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -254,7 +254,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -336,7 +336,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/StaticStateChangeError.md b/docs/src/content/docs/reference/@tevm/errors/classes/StaticStateChangeError.md index e60f01bd56..eda371e54c 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/StaticStateChangeError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/StaticStateChangeError.md @@ -106,7 +106,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -120,7 +120,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -136,7 +136,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -150,7 +150,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -166,7 +166,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -198,7 +198,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -228,7 +228,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -256,7 +256,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -338,7 +338,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/StopError.md b/docs/src/content/docs/reference/@tevm/errors/classes/StopError.md index 062af989e3..3b50164a66 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/StopError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/StopError.md @@ -96,7 +96,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -110,7 +110,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -126,7 +126,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -140,7 +140,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -156,7 +156,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -188,7 +188,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -218,7 +218,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -246,7 +246,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -328,7 +328,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/TransactionRejectedError.md b/docs/src/content/docs/reference/@tevm/errors/classes/TransactionRejectedError.md index b847a9bc6e..59ca0c9cd9 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/TransactionRejectedError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/TransactionRejectedError.md @@ -96,7 +96,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -112,7 +112,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -126,7 +126,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -142,7 +142,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -186,7 +186,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -216,7 +216,7 @@ The name of the error, used to discriminate errors. #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -244,7 +244,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -316,7 +316,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/TransactionTooLargeError.md b/docs/src/content/docs/reference/@tevm/errors/classes/TransactionTooLargeError.md index 087eb8c793..60465f4b68 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/TransactionTooLargeError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/TransactionTooLargeError.md @@ -82,7 +82,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -96,7 +96,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -112,7 +112,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -126,7 +126,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -142,7 +142,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -174,7 +174,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -204,7 +204,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -232,7 +232,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -304,7 +304,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/TransactionUnderpricedError.md b/docs/src/content/docs/reference/@tevm/errors/classes/TransactionUnderpricedError.md index 1ff16ce3f3..799757c3a2 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/TransactionUnderpricedError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/TransactionUnderpricedError.md @@ -82,7 +82,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -96,7 +96,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -112,7 +112,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -126,7 +126,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -142,7 +142,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -174,7 +174,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -204,7 +204,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -232,7 +232,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -304,7 +304,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/UnknownBlockError.md b/docs/src/content/docs/reference/@tevm/errors/classes/UnknownBlockError.md index 627627a249..bf8dcb6559 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/UnknownBlockError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/UnknownBlockError.md @@ -7,17 +7,24 @@ title: "UnknownBlockError" Represents an error that occurs when the specified block could not be found. -This error is typically encountered when a block hash or number is provided that does not correspond to any block known to the node. +This error is typically encountered when a block hash or number is provided that does not correspond +to any block known to the node. This can happen if the block hasn't been mined yet, if it's on a +different chain, or if the node is not fully synced. + +The error code -32001 is a non-standard extension used by some Ethereum clients to +indicate this specific condition. ## Example ```ts try { - // Some operation that can throw an UnknownBlockError + const block = await client.getBlock({ + blockHash: '0x1234567890123456789012345678901234567890123456789012345678901234' + }) } catch (error) { if (error instanceof UnknownBlockError) { - console.error(error.message); - // Handle the unknown block error + console.error('Unknown block:', error.message); + console.log('The specified block does not exist or is not available to this node'); } } ``` @@ -66,7 +73,7 @@ The tag for the error. #### Defined in -[packages/errors/src/ethereum/UnknownBlockError.js:49](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/UnknownBlockError.js#L49) +[packages/errors/src/ethereum/UnknownBlockError.js:55](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/UnknownBlockError.js#L55) ## Properties @@ -82,7 +89,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/UnknownBlockError.js:68](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/UnknownBlockError.js#L68) *** @@ -96,7 +103,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -104,7 +111,7 @@ Same as name, used internally. > **code**: `number` -Error code, analogous to the code in JSON RPC error. +Error code (-32001), a non-standard extension for this specific error. #### Inherited from @@ -112,7 +119,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -126,7 +133,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -142,7 +149,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -174,7 +181,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -190,7 +197,7 @@ The name of the error, used to discriminate errors. #### Defined in -node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1076 +[packages/errors/src/ethereum/UnknownBlockError.js:67](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/UnknownBlockError.js#L67) *** @@ -204,7 +211,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -232,7 +239,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -304,7 +311,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/UnreachableCodeError.md b/docs/src/content/docs/reference/@tevm/errors/classes/UnreachableCodeError.md index c91ef38bd1..0a3ed737bc 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/UnreachableCodeError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/UnreachableCodeError.md @@ -5,42 +5,40 @@ prev: false title: "UnreachableCodeError" --- -Represents an error that occurs when unreachable code is executed. This error always indicates a bug in the Tevm VM. - -Unreachable code errors can occur due to: -- Defensive programming checks to ensure all cases in a switch or if statement are covered. - -To handle this error take the following steps: -- ensure you did not modify the tevm VM in any unsupported way. -- Open an issue with a minimal reproducable example +Represents an error that occurs when unreachable code is executed. +This error always indicates a bug in the Tevm VM. ## Example -```typescript +```javascript import { UnreachableCodeError } from '@tevm/errors' -const x: 'a' | 'b' = 'a' - -if (x === 'a') { - console.log('A') -} else if (x === 'b') { - console.log('B') -} else { - throw new UnreachableCodeError(x, 'Unreachable code executed.') +function assertUnreachable(x) { + throw new UnreachableCodeError(x, 'Unreachable code executed') } -``` - -## Param - -The value that should be of type never. -## Param - -A human-readable error message. - -## Param +function getArea(shape) { + switch (shape) { + case 'circle': + return Math.PI * Math.pow(radius, 2) + case 'square': + return side * side + default: + return assertUnreachable(shape) + } +} -Additional parameters for the BaseError. +try { + getArea('triangle') // This should be unreachable +} catch (error) { + if (error instanceof UnreachableCodeError) { + console.error('Unreachable code executed:', error.message) + console.log('Unreachable value:', error.value) + // This indicates a bug in the Tevm VM + reportBugToTevmRepository(error) + } +} +``` ## Extends @@ -50,27 +48,23 @@ Additional parameters for the BaseError. ### new UnreachableCodeError() -> **new UnreachableCodeError**(`value`, `message`?, `args`?, `tag`?): [`UnreachableCodeError`](/reference/tevm/errors/classes/unreachablecodeerror/) +> **new UnreachableCodeError**(`value`, `message`?, `args`?): [`UnreachableCodeError`](/reference/tevm/errors/classes/unreachablecodeerror/) Constructs an UnreachableCodeError. #### Parameters -• **value**: `never` +• **value**: `any` -The value that should be of type never. +The value that should be unreachable. -• **message?**: `string` = `...` +• **message?**: `string` Human-readable error message. • **args?**: [`UnreachableCodeErrorParameters`](/reference/tevm/errors/interfaces/unreachablecodeerrorparameters/) = `{}` -Additional parameters for the BaseError. - -• **tag?**: `string` = `'UnreachableCodeError'` - -The tag for the error. +Additional parameters for the error. #### Returns @@ -82,7 +76,7 @@ The tag for the error. #### Defined in -[packages/errors/src/defensive/UnreachableCodeError.js:60](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/defensive/UnreachableCodeError.js#L60) +[packages/errors/src/defensive/UnreachableCodeError.js:66](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/defensive/UnreachableCodeError.js#L66) ## Properties @@ -98,7 +92,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/defensive/UnreachableCodeError.js:80](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/defensive/UnreachableCodeError.js#L80) *** @@ -112,7 +106,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -120,7 +114,7 @@ Same as name, used internally. > **code**: `number` -Error code, analogous to the code in JSON RPC error. +Error code (-32603), standard JSON-RPC error code for internal errors. #### Inherited from @@ -128,7 +122,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -142,7 +136,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -158,7 +152,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -190,7 +184,7 @@ Optional object containing additional information about the error. #### Defined in -[packages/errors/src/ethereum/InternalErrorError.js:64](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/InternalErrorError.js#L64) +[packages/errors/src/ethereum/InternalErrorError.js:69](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/InternalErrorError.js#L69) *** @@ -206,7 +200,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -222,7 +216,7 @@ The name of the error, used to discriminate errors. #### Defined in -node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1076 +[packages/errors/src/defensive/UnreachableCodeError.js:79](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/defensive/UnreachableCodeError.js#L79) *** @@ -236,7 +230,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -254,6 +248,18 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 *** +### value + +> **value**: `any` + +The value that should be unreachable. + +#### Defined in + +[packages/errors/src/defensive/UnreachableCodeError.js:57](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/defensive/UnreachableCodeError.js#L57) + +*** + ### version > **version**: `string` @@ -264,7 +270,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -336,7 +342,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/UnsupportedChainError.md b/docs/src/content/docs/reference/@tevm/errors/classes/UnsupportedChainError.md index 13ebed960b..7153385dcc 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/UnsupportedChainError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/UnsupportedChainError.md @@ -82,7 +82,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -96,7 +96,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -112,7 +112,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -126,7 +126,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -142,7 +142,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -174,7 +174,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -204,7 +204,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -232,7 +232,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -304,7 +304,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/classes/ValueOverflowError.md b/docs/src/content/docs/reference/@tevm/errors/classes/ValueOverflowError.md index 04e627766a..28c4fc795e 100644 --- a/docs/src/content/docs/reference/@tevm/errors/classes/ValueOverflowError.md +++ b/docs/src/content/docs/reference/@tevm/errors/classes/ValueOverflowError.md @@ -96,7 +96,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L81) +[packages/errors/src/ethereum/BaseError.js:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L82) *** @@ -110,7 +110,7 @@ Same as name, used internally. #### Defined in -[packages/errors/src/ethereum/BaseError.js:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L113) +[packages/errors/src/ethereum/BaseError.js:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L114) *** @@ -126,7 +126,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L111) +[packages/errors/src/ethereum/BaseError.js:112](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L112) *** @@ -140,7 +140,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L90) +[packages/errors/src/ethereum/BaseError.js:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L91) *** @@ -156,7 +156,7 @@ Path to the documentation for this error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L95) +[packages/errors/src/ethereum/BaseError.js:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L96) *** @@ -188,7 +188,7 @@ Additional meta messages for more context. #### Defined in -[packages/errors/src/ethereum/BaseError.js:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L99) +[packages/errors/src/ethereum/BaseError.js:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L100) *** @@ -218,7 +218,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L103) +[packages/errors/src/ethereum/BaseError.js:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L104) *** @@ -246,7 +246,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/ethereum/BaseError.js:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L107) +[packages/errors/src/ethereum/BaseError.js:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L108) *** @@ -328,7 +328,7 @@ The first error that matches the function, or the original error. #### Defined in -[packages/errors/src/ethereum/BaseError.js:136](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L136) +[packages/errors/src/ethereum/BaseError.js:137](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BaseError.js#L137) *** diff --git a/docs/src/content/docs/reference/@tevm/errors/interfaces/AccountLockedErrorParameters.md b/docs/src/content/docs/reference/@tevm/errors/interfaces/AccountLockedErrorParameters.md index 6b09e5ab84..1ba482da66 100644 --- a/docs/src/content/docs/reference/@tevm/errors/interfaces/AccountLockedErrorParameters.md +++ b/docs/src/content/docs/reference/@tevm/errors/interfaces/AccountLockedErrorParameters.md @@ -15,7 +15,7 @@ The cause of the error. #### Defined in -[packages/errors/src/ethereum/AccountLockedError.js:11](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/AccountLockedError.js#L11) +[packages/errors/src/ethereum/AccountLockedError.js:10](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/AccountLockedError.js#L10) *** @@ -27,7 +27,7 @@ Details of the error. #### Defined in -[packages/errors/src/ethereum/AccountLockedError.js:12](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/AccountLockedError.js#L12) +[packages/errors/src/ethereum/AccountLockedError.js:11](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/AccountLockedError.js#L11) *** @@ -39,7 +39,7 @@ Base URL for the documentation. #### Defined in -[packages/errors/src/ethereum/AccountLockedError.js:7](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/AccountLockedError.js#L7) +[packages/errors/src/ethereum/AccountLockedError.js:6](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/AccountLockedError.js#L6) *** @@ -51,7 +51,7 @@ Path to the documentation. #### Defined in -[packages/errors/src/ethereum/AccountLockedError.js:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/AccountLockedError.js#L8) +[packages/errors/src/ethereum/AccountLockedError.js:7](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/AccountLockedError.js#L7) *** @@ -63,7 +63,7 @@ Slug for the documentation. #### Defined in -[packages/errors/src/ethereum/AccountLockedError.js:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/AccountLockedError.js#L9) +[packages/errors/src/ethereum/AccountLockedError.js:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/AccountLockedError.js#L8) *** @@ -75,7 +75,7 @@ Optional object containing additional information about the error. #### Defined in -[packages/errors/src/ethereum/AccountLockedError.js:13](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/AccountLockedError.js#L13) +[packages/errors/src/ethereum/AccountLockedError.js:12](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/AccountLockedError.js#L12) *** @@ -87,4 +87,4 @@ Additional meta messages. #### Defined in -[packages/errors/src/ethereum/AccountLockedError.js:10](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/AccountLockedError.js#L10) +[packages/errors/src/ethereum/AccountLockedError.js:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/AccountLockedError.js#L9) diff --git a/docs/src/content/docs/reference/@tevm/errors/interfaces/BlockGasLimitExceededErrorParameters.md b/docs/src/content/docs/reference/@tevm/errors/interfaces/BlockGasLimitExceededErrorParameters.md index 5e6aade123..ec25d06069 100644 --- a/docs/src/content/docs/reference/@tevm/errors/interfaces/BlockGasLimitExceededErrorParameters.md +++ b/docs/src/content/docs/reference/@tevm/errors/interfaces/BlockGasLimitExceededErrorParameters.md @@ -15,7 +15,7 @@ The cause of the error. #### Defined in -[packages/errors/src/ethereum/BlockGasLimitExceededError.js:11](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BlockGasLimitExceededError.js#L11) +[packages/errors/src/ethereum/BlockGasLimitExceededError.js:10](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BlockGasLimitExceededError.js#L10) *** @@ -27,7 +27,7 @@ Details of the error. #### Defined in -[packages/errors/src/ethereum/BlockGasLimitExceededError.js:12](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BlockGasLimitExceededError.js#L12) +[packages/errors/src/ethereum/BlockGasLimitExceededError.js:11](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BlockGasLimitExceededError.js#L11) *** @@ -39,7 +39,7 @@ Base URL for the documentation. #### Defined in -[packages/errors/src/ethereum/BlockGasLimitExceededError.js:7](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BlockGasLimitExceededError.js#L7) +[packages/errors/src/ethereum/BlockGasLimitExceededError.js:6](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BlockGasLimitExceededError.js#L6) *** @@ -51,7 +51,7 @@ Path to the documentation. #### Defined in -[packages/errors/src/ethereum/BlockGasLimitExceededError.js:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BlockGasLimitExceededError.js#L8) +[packages/errors/src/ethereum/BlockGasLimitExceededError.js:7](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BlockGasLimitExceededError.js#L7) *** @@ -63,7 +63,7 @@ Slug for the documentation. #### Defined in -[packages/errors/src/ethereum/BlockGasLimitExceededError.js:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BlockGasLimitExceededError.js#L9) +[packages/errors/src/ethereum/BlockGasLimitExceededError.js:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BlockGasLimitExceededError.js#L8) *** @@ -75,7 +75,7 @@ Optional object containing additional information about the error. #### Defined in -[packages/errors/src/ethereum/BlockGasLimitExceededError.js:13](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BlockGasLimitExceededError.js#L13) +[packages/errors/src/ethereum/BlockGasLimitExceededError.js:12](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BlockGasLimitExceededError.js#L12) *** @@ -87,4 +87,4 @@ Additional meta messages. #### Defined in -[packages/errors/src/ethereum/BlockGasLimitExceededError.js:10](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BlockGasLimitExceededError.js#L10) +[packages/errors/src/ethereum/BlockGasLimitExceededError.js:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/BlockGasLimitExceededError.js#L9) diff --git a/docs/src/content/docs/reference/@tevm/errors/interfaces/ContractExecutionFailedErrorParameters.md b/docs/src/content/docs/reference/@tevm/errors/interfaces/ContractExecutionFailedErrorParameters.md index 2fe3b7eac7..0b0aeb5709 100644 --- a/docs/src/content/docs/reference/@tevm/errors/interfaces/ContractExecutionFailedErrorParameters.md +++ b/docs/src/content/docs/reference/@tevm/errors/interfaces/ContractExecutionFailedErrorParameters.md @@ -15,7 +15,7 @@ The cause of the error. #### Defined in -[packages/errors/src/ethereum/ContractExecutionFailedError.js:11](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/ContractExecutionFailedError.js#L11) +[packages/errors/src/ethereum/ContractExecutionFailedError.js:10](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/ContractExecutionFailedError.js#L10) *** @@ -27,7 +27,7 @@ Details of the error. #### Defined in -[packages/errors/src/ethereum/ContractExecutionFailedError.js:12](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/ContractExecutionFailedError.js#L12) +[packages/errors/src/ethereum/ContractExecutionFailedError.js:11](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/ContractExecutionFailedError.js#L11) *** @@ -39,7 +39,7 @@ Base URL for the documentation. #### Defined in -[packages/errors/src/ethereum/ContractExecutionFailedError.js:7](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/ContractExecutionFailedError.js#L7) +[packages/errors/src/ethereum/ContractExecutionFailedError.js:6](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/ContractExecutionFailedError.js#L6) *** @@ -51,7 +51,7 @@ Path to the documentation. #### Defined in -[packages/errors/src/ethereum/ContractExecutionFailedError.js:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/ContractExecutionFailedError.js#L8) +[packages/errors/src/ethereum/ContractExecutionFailedError.js:7](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/ContractExecutionFailedError.js#L7) *** @@ -63,7 +63,7 @@ Slug for the documentation. #### Defined in -[packages/errors/src/ethereum/ContractExecutionFailedError.js:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/ContractExecutionFailedError.js#L9) +[packages/errors/src/ethereum/ContractExecutionFailedError.js:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/ContractExecutionFailedError.js#L8) *** @@ -75,7 +75,7 @@ Optional object containing additional information about the error. #### Defined in -[packages/errors/src/ethereum/ContractExecutionFailedError.js:13](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/ContractExecutionFailedError.js#L13) +[packages/errors/src/ethereum/ContractExecutionFailedError.js:12](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/ContractExecutionFailedError.js#L12) *** @@ -87,4 +87,4 @@ Additional meta messages. #### Defined in -[packages/errors/src/ethereum/ContractExecutionFailedError.js:10](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/ContractExecutionFailedError.js#L10) +[packages/errors/src/ethereum/ContractExecutionFailedError.js:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/ContractExecutionFailedError.js#L9) diff --git a/docs/src/content/docs/reference/@tevm/errors/interfaces/InternalErrorParameters.md b/docs/src/content/docs/reference/@tevm/errors/interfaces/InternalErrorParameters.md index 27f61b7b09..4c77947458 100644 --- a/docs/src/content/docs/reference/@tevm/errors/interfaces/InternalErrorParameters.md +++ b/docs/src/content/docs/reference/@tevm/errors/interfaces/InternalErrorParameters.md @@ -15,7 +15,7 @@ The cause of the error. #### Defined in -[packages/errors/src/ethereum/InternalErrorError.js:11](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/InternalErrorError.js#L11) +[packages/errors/src/ethereum/InternalErrorError.js:10](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/InternalErrorError.js#L10) *** @@ -27,7 +27,7 @@ Details of the error. #### Defined in -[packages/errors/src/ethereum/InternalErrorError.js:12](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/InternalErrorError.js#L12) +[packages/errors/src/ethereum/InternalErrorError.js:11](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/InternalErrorError.js#L11) *** @@ -39,7 +39,7 @@ Base URL for the documentation. #### Defined in -[packages/errors/src/ethereum/InternalErrorError.js:7](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/InternalErrorError.js#L7) +[packages/errors/src/ethereum/InternalErrorError.js:6](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/InternalErrorError.js#L6) *** @@ -51,7 +51,7 @@ Path to the documentation. #### Defined in -[packages/errors/src/ethereum/InternalErrorError.js:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/InternalErrorError.js#L8) +[packages/errors/src/ethereum/InternalErrorError.js:7](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/InternalErrorError.js#L7) *** @@ -63,7 +63,7 @@ Slug for the documentation. #### Defined in -[packages/errors/src/ethereum/InternalErrorError.js:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/InternalErrorError.js#L9) +[packages/errors/src/ethereum/InternalErrorError.js:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/InternalErrorError.js#L8) *** @@ -75,7 +75,7 @@ Optional object containing additional information about the error. #### Defined in -[packages/errors/src/ethereum/InternalErrorError.js:13](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/InternalErrorError.js#L13) +[packages/errors/src/ethereum/InternalErrorError.js:12](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/InternalErrorError.js#L12) *** @@ -87,4 +87,4 @@ Additional meta messages. #### Defined in -[packages/errors/src/ethereum/InternalErrorError.js:10](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/InternalErrorError.js#L10) +[packages/errors/src/ethereum/InternalErrorError.js:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/InternalErrorError.js#L9) diff --git a/docs/src/content/docs/reference/@tevm/errors/interfaces/NonceTooLowErrorParameters.md b/docs/src/content/docs/reference/@tevm/errors/interfaces/NonceTooLowErrorParameters.md index 6e7c485e5e..26283a3575 100644 --- a/docs/src/content/docs/reference/@tevm/errors/interfaces/NonceTooLowErrorParameters.md +++ b/docs/src/content/docs/reference/@tevm/errors/interfaces/NonceTooLowErrorParameters.md @@ -15,7 +15,7 @@ The cause of the error. #### Defined in -[packages/errors/src/ethereum/NonceTooLowError.js:11](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/NonceTooLowError.js#L11) +[packages/errors/src/ethereum/NonceTooLowError.js:10](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/NonceTooLowError.js#L10) *** @@ -27,7 +27,7 @@ Details of the error. #### Defined in -[packages/errors/src/ethereum/NonceTooLowError.js:12](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/NonceTooLowError.js#L12) +[packages/errors/src/ethereum/NonceTooLowError.js:11](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/NonceTooLowError.js#L11) *** @@ -39,7 +39,7 @@ Base URL for the documentation. #### Defined in -[packages/errors/src/ethereum/NonceTooLowError.js:7](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/NonceTooLowError.js#L7) +[packages/errors/src/ethereum/NonceTooLowError.js:6](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/NonceTooLowError.js#L6) *** @@ -51,7 +51,7 @@ Path to the documentation. #### Defined in -[packages/errors/src/ethereum/NonceTooLowError.js:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/NonceTooLowError.js#L8) +[packages/errors/src/ethereum/NonceTooLowError.js:7](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/NonceTooLowError.js#L7) *** @@ -63,7 +63,7 @@ Slug for the documentation. #### Defined in -[packages/errors/src/ethereum/NonceTooLowError.js:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/NonceTooLowError.js#L9) +[packages/errors/src/ethereum/NonceTooLowError.js:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/NonceTooLowError.js#L8) *** @@ -75,7 +75,7 @@ Optional object containing additional information about the error. #### Defined in -[packages/errors/src/ethereum/NonceTooLowError.js:13](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/NonceTooLowError.js#L13) +[packages/errors/src/ethereum/NonceTooLowError.js:12](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/NonceTooLowError.js#L12) *** @@ -87,4 +87,4 @@ Additional meta messages. #### Defined in -[packages/errors/src/ethereum/NonceTooLowError.js:10](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/NonceTooLowError.js#L10) +[packages/errors/src/ethereum/NonceTooLowError.js:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/NonceTooLowError.js#L9) diff --git a/docs/src/content/docs/reference/@tevm/errors/interfaces/ParseErrorParameters.md b/docs/src/content/docs/reference/@tevm/errors/interfaces/ParseErrorParameters.md index 5e7186c67c..0d901b97b8 100644 --- a/docs/src/content/docs/reference/@tevm/errors/interfaces/ParseErrorParameters.md +++ b/docs/src/content/docs/reference/@tevm/errors/interfaces/ParseErrorParameters.md @@ -15,7 +15,7 @@ The cause of the error. #### Defined in -[packages/errors/src/ethereum/ParseErrorError.js:11](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/ParseErrorError.js#L11) +[packages/errors/src/ethereum/ParseErrorError.js:10](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/ParseErrorError.js#L10) *** @@ -27,7 +27,7 @@ Details of the error. #### Defined in -[packages/errors/src/ethereum/ParseErrorError.js:12](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/ParseErrorError.js#L12) +[packages/errors/src/ethereum/ParseErrorError.js:11](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/ParseErrorError.js#L11) *** @@ -39,7 +39,7 @@ Base URL for the documentation. #### Defined in -[packages/errors/src/ethereum/ParseErrorError.js:7](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/ParseErrorError.js#L7) +[packages/errors/src/ethereum/ParseErrorError.js:6](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/ParseErrorError.js#L6) *** @@ -51,7 +51,7 @@ Path to the documentation. #### Defined in -[packages/errors/src/ethereum/ParseErrorError.js:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/ParseErrorError.js#L8) +[packages/errors/src/ethereum/ParseErrorError.js:7](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/ParseErrorError.js#L7) *** @@ -63,7 +63,7 @@ Slug for the documentation. #### Defined in -[packages/errors/src/ethereum/ParseErrorError.js:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/ParseErrorError.js#L9) +[packages/errors/src/ethereum/ParseErrorError.js:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/ParseErrorError.js#L8) *** @@ -75,7 +75,7 @@ Optional object containing additional information about the error. #### Defined in -[packages/errors/src/ethereum/ParseErrorError.js:13](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/ParseErrorError.js#L13) +[packages/errors/src/ethereum/ParseErrorError.js:12](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/ParseErrorError.js#L12) *** @@ -87,4 +87,4 @@ Additional meta messages. #### Defined in -[packages/errors/src/ethereum/ParseErrorError.js:10](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/ParseErrorError.js#L10) +[packages/errors/src/ethereum/ParseErrorError.js:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/ParseErrorError.js#L9) diff --git a/docs/src/content/docs/reference/@tevm/errors/interfaces/UnknownBlockErrorParameters.md b/docs/src/content/docs/reference/@tevm/errors/interfaces/UnknownBlockErrorParameters.md index 7334bceecf..f69581cd2a 100644 --- a/docs/src/content/docs/reference/@tevm/errors/interfaces/UnknownBlockErrorParameters.md +++ b/docs/src/content/docs/reference/@tevm/errors/interfaces/UnknownBlockErrorParameters.md @@ -15,7 +15,7 @@ The cause of the error. #### Defined in -[packages/errors/src/ethereum/UnknownBlockError.js:11](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/UnknownBlockError.js#L11) +[packages/errors/src/ethereum/UnknownBlockError.js:10](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/UnknownBlockError.js#L10) *** @@ -27,7 +27,7 @@ Details of the error. #### Defined in -[packages/errors/src/ethereum/UnknownBlockError.js:12](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/UnknownBlockError.js#L12) +[packages/errors/src/ethereum/UnknownBlockError.js:11](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/UnknownBlockError.js#L11) *** @@ -39,7 +39,7 @@ Base URL for the documentation. #### Defined in -[packages/errors/src/ethereum/UnknownBlockError.js:7](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/UnknownBlockError.js#L7) +[packages/errors/src/ethereum/UnknownBlockError.js:6](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/UnknownBlockError.js#L6) *** @@ -51,7 +51,7 @@ Path to the documentation. #### Defined in -[packages/errors/src/ethereum/UnknownBlockError.js:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/UnknownBlockError.js#L8) +[packages/errors/src/ethereum/UnknownBlockError.js:7](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/UnknownBlockError.js#L7) *** @@ -63,7 +63,7 @@ Slug for the documentation. #### Defined in -[packages/errors/src/ethereum/UnknownBlockError.js:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/UnknownBlockError.js#L9) +[packages/errors/src/ethereum/UnknownBlockError.js:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/UnknownBlockError.js#L8) *** @@ -75,7 +75,7 @@ Optional object containing additional information about the error. #### Defined in -[packages/errors/src/ethereum/UnknownBlockError.js:13](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/UnknownBlockError.js#L13) +[packages/errors/src/ethereum/UnknownBlockError.js:12](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/UnknownBlockError.js#L12) *** @@ -87,4 +87,4 @@ Additional meta messages. #### Defined in -[packages/errors/src/ethereum/UnknownBlockError.js:10](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/UnknownBlockError.js#L10) +[packages/errors/src/ethereum/UnknownBlockError.js:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/ethereum/UnknownBlockError.js#L9) diff --git a/docs/src/content/docs/reference/@tevm/errors/type-aliases/RpcErrorCode.md b/docs/src/content/docs/reference/@tevm/errors/type-aliases/RpcErrorCode.md index 015e022a4f..c20dfd5942 100644 --- a/docs/src/content/docs/reference/@tevm/errors/type-aliases/RpcErrorCode.md +++ b/docs/src/content/docs/reference/@tevm/errors/type-aliases/RpcErrorCode.md @@ -7,6 +7,8 @@ title: "RpcErrorCode" > **RpcErrorCode**: `-1` \| `-32700` \| `-32600` \| `-32601` \| `-32602` \| `-32603` \| `-32000` \| `-32001` \| `-32002` \| `-32003` \| `-32004` \| `-32005` \| `-32006` \| `-32042` +Represents the possible error codes for RPC errors. + ## Defined in -[packages/errors/src/requestErrors.ts:20](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/requestErrors.ts#L20) +[packages/errors/src/requestErrors.ts:28](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/requestErrors.ts#L28) diff --git a/docs/src/content/docs/reference/@tevm/ethers/classes/TevmProvider.md b/docs/src/content/docs/reference/@tevm/ethers/classes/TevmProvider.md index f659884a84..c8fb8b83ef 100644 --- a/docs/src/content/docs/reference/@tevm/ethers/classes/TevmProvider.md +++ b/docs/src/content/docs/reference/@tevm/ethers/classes/TevmProvider.md @@ -2009,7 +2009,7 @@ Creates a new TevmProvider instance with a TevmMemoryClient. #### Parameters -• **options**: `TevmNodeOptions`\<[`Common`](/reference/tevm/common/type-aliases/common/)\> +• **options**: `TevmNodeOptions`\<`object`\> Options to create a new TevmProvider. diff --git a/docs/src/content/docs/reference/@tevm/memory-client/functions/createMemoryClient.md b/docs/src/content/docs/reference/@tevm/memory-client/functions/createMemoryClient.md index eb8ce3aec5..889afb9f55 100644 --- a/docs/src/content/docs/reference/@tevm/memory-client/functions/createMemoryClient.md +++ b/docs/src/content/docs/reference/@tevm/memory-client/functions/createMemoryClient.md @@ -12,7 +12,7 @@ It comes batteries included with all wallet, test, public, and tevm actions. ## Type Parameters -• **TCommon** *extends* `object` & `ChainConfig`\<`undefined` \| `ChainFormatters`, `undefined` \| `Record`\<`string`, `unknown`\>\> & `object` = `object` & `ChainConfig`\<`undefined` \| `ChainFormatters`, `undefined` \| `Record`\<`string`, `unknown`\>\> & `object` +• **TCommon** *extends* `object` & `object` & `ChainConfig`\<`undefined` \| `ChainFormatters`, `undefined` \| `Record`\<`string`, `unknown`\>\> = `object` & `object` & `ChainConfig`\<`undefined` \| `ChainFormatters`, `undefined` \| `Record`\<`string`, `unknown`\>\> • **TAccountOrAddress** *extends* `undefined` \| \`0x$\{string\}\` \| [`Account`](/reference/tevm/utils/type-aliases/account/) = `undefined` diff --git a/docs/src/content/docs/reference/@tevm/memory-client/functions/createTevmTransport.md b/docs/src/content/docs/reference/@tevm/memory-client/functions/createTevmTransport.md index 92feede1d0..a194a44537 100644 --- a/docs/src/content/docs/reference/@tevm/memory-client/functions/createTevmTransport.md +++ b/docs/src/content/docs/reference/@tevm/memory-client/functions/createTevmTransport.md @@ -9,7 +9,7 @@ title: "createTevmTransport" ## Parameters -• **options**: `TevmNodeOptions`\<[`Common`](/reference/tevm/common/type-aliases/common/)\> = `{}` +• **options**: `TevmNodeOptions`\<`object`\> = `{}` Configuration options for the base client, similar to those used in `memoryClient` or a low-level `baseClient`. diff --git a/docs/src/content/docs/reference/@tevm/node/functions/createTevmNode.md b/docs/src/content/docs/reference/@tevm/node/functions/createTevmNode.md index d9dfc616ae..8a83adfa23 100644 --- a/docs/src/content/docs/reference/@tevm/node/functions/createTevmNode.md +++ b/docs/src/content/docs/reference/@tevm/node/functions/createTevmNode.md @@ -9,7 +9,7 @@ title: "createTevmNode" ## Parameters -• **options?**: [`TevmNodeOptions`](/reference/tevm/node/type-aliases/tevmnodeoptions/)\<[`Common`](/reference/tevm/common/type-aliases/common/)\> = `{}` +• **options?**: [`TevmNodeOptions`](/reference/tevm/node/type-aliases/tevmnodeoptions/)\<`object`\> = `{}` ## Returns diff --git a/docs/src/content/docs/reference/@tevm/procedures/functions/ethGetTransactionCountProcedure.md b/docs/src/content/docs/reference/@tevm/procedures/functions/ethGetTransactionCountProcedure.md index 24291f8c50..42260573b6 100644 --- a/docs/src/content/docs/reference/@tevm/procedures/functions/ethGetTransactionCountProcedure.md +++ b/docs/src/content/docs/reference/@tevm/procedures/functions/ethGetTransactionCountProcedure.md @@ -5,11 +5,11 @@ prev: false title: "ethGetTransactionCountProcedure" --- -> **ethGetTransactionCountProcedure**(`client`): [`EthGetTransactionCountJsonRpcProcedure`](/reference/tevm/procedures/type-aliases/ethgettransactioncountjsonrpcprocedure/) +> **ethGetTransactionCountProcedure**(`node`): [`EthGetTransactionCountJsonRpcProcedure`](/reference/tevm/procedures/type-aliases/ethgettransactioncountjsonrpcprocedure/) ## Parameters -• **client**: `TevmNode`\<`"fork"` \| `"normal"`, `object`\> +• **node**: `TevmNode`\<`"fork"` \| `"normal"`, `object`\> ## Returns @@ -17,4 +17,4 @@ title: "ethGetTransactionCountProcedure" ## Defined in -[packages/procedures/src/eth/ethGetTransactionCountProcedure.js:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/ethGetTransactionCountProcedure.js#L9) +[packages/procedures/src/eth/ethGetTransactionCountProcedure.js:10](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/ethGetTransactionCountProcedure.js#L10) diff --git a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthEstimateGasJsonRpcRequest.md b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthEstimateGasJsonRpcRequest.md index 689e04aa1e..4f80fc7420 100644 --- a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthEstimateGasJsonRpcRequest.md +++ b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthEstimateGasJsonRpcRequest.md @@ -5,7 +5,7 @@ prev: false title: "EthEstimateGasJsonRpcRequest" --- -> **EthEstimateGasJsonRpcRequest**: [`JsonRpcRequest`](/reference/tevm/jsonrpc/type-aliases/jsonrpcrequest/)\<`"eth_estimateGas"`, readonly [[`JsonRpcTransaction`](/reference/tevm/procedures/type-aliases/jsonrpctransaction/)]\> +> **EthEstimateGasJsonRpcRequest**: [`JsonRpcRequest`](/reference/tevm/jsonrpc/type-aliases/jsonrpcrequest/)\<`"eth_estimateGas"`, readonly [[`JsonRpcTransaction`](/reference/tevm/procedures/type-aliases/jsonrpctransaction/), [`BlockTag`](/reference/tevm/utils/type-aliases/blocktag/) \| [`Hex`](/reference/tevm/utils/type-aliases/hex/), [`SerializeToJson`](/reference/tevm/procedures/type-aliases/serializetojson/)\<[`BaseCallParams`](/reference/tevm/actions/type-aliases/basecallparams/)\[`"stateOverrideSet"`\]\>, [`SerializeToJson`](/reference/tevm/procedures/type-aliases/serializetojson/)\<[`BaseCallParams`](/reference/tevm/actions/type-aliases/basecallparams/)\[`"blockOverrideSet"`\]\>]\> JSON-RPC request for `eth_estimateGas` procedure diff --git a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGasPriceJsonRpcRequest.md b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGasPriceJsonRpcRequest.md index 32c867405d..938b15bb3d 100644 --- a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGasPriceJsonRpcRequest.md +++ b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGasPriceJsonRpcRequest.md @@ -11,4 +11,4 @@ JSON-RPC request for `eth_gasPrice` procedure ## Defined in -[packages/procedures/src/eth/EthJsonRpcRequest.ts:83](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L83) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L91) diff --git a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetBalanceJsonRpcRequest.md b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetBalanceJsonRpcRequest.md index 77f62a7afa..af3a6cbc8b 100644 --- a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetBalanceJsonRpcRequest.md +++ b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetBalanceJsonRpcRequest.md @@ -11,4 +11,4 @@ JSON-RPC request for `eth_getBalance` procedure ## Defined in -[packages/procedures/src/eth/EthJsonRpcRequest.ts:88](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L88) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L96) diff --git a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetBlockByHashJsonRpcRequest.md b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetBlockByHashJsonRpcRequest.md index 6977d14a36..599de2afc3 100644 --- a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetBlockByHashJsonRpcRequest.md +++ b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetBlockByHashJsonRpcRequest.md @@ -11,4 +11,4 @@ JSON-RPC request for `eth_getBlockByHash` procedure ## Defined in -[packages/procedures/src/eth/EthJsonRpcRequest.ts:93](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L93) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:101](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L101) diff --git a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetBlockByNumberJsonRpcRequest.md b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetBlockByNumberJsonRpcRequest.md index 3dc6a82eb3..69db866f69 100644 --- a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetBlockByNumberJsonRpcRequest.md +++ b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetBlockByNumberJsonRpcRequest.md @@ -11,4 +11,4 @@ JSON-RPC request for `eth_getBlockByNumber` procedure ## Defined in -[packages/procedures/src/eth/EthJsonRpcRequest.ts:101](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L101) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:109](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L109) diff --git a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetBlockTransactionCountByHashJsonRpcRequest.md b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetBlockTransactionCountByHashJsonRpcRequest.md index d05660ae29..f45ca85729 100644 --- a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetBlockTransactionCountByHashJsonRpcRequest.md +++ b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetBlockTransactionCountByHashJsonRpcRequest.md @@ -11,4 +11,4 @@ JSON-RPC request for `eth_getBlockTransactionCountByHash` procedure ## Defined in -[packages/procedures/src/eth/EthJsonRpcRequest.ts:109](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L109) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:117](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L117) diff --git a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetBlockTransactionCountByNumberJsonRpcRequest.md b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetBlockTransactionCountByNumberJsonRpcRequest.md index 528d848da2..fe2ee59e43 100644 --- a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetBlockTransactionCountByNumberJsonRpcRequest.md +++ b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetBlockTransactionCountByNumberJsonRpcRequest.md @@ -11,4 +11,4 @@ JSON-RPC request for `eth_getBlockTransactionCountByNumber` procedure ## Defined in -[packages/procedures/src/eth/EthJsonRpcRequest.ts:117](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L117) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:125](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L125) diff --git a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetCodeJsonRpcRequest.md b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetCodeJsonRpcRequest.md index 6002f9393e..7de18c4754 100644 --- a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetCodeJsonRpcRequest.md +++ b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetCodeJsonRpcRequest.md @@ -11,4 +11,4 @@ JSON-RPC request for `eth_getCode` procedure ## Defined in -[packages/procedures/src/eth/EthJsonRpcRequest.ts:125](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L125) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:133](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L133) diff --git a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetFilterChangesJsonRpcRequest.md b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetFilterChangesJsonRpcRequest.md index 4c9c384b98..8f7445bfee 100644 --- a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetFilterChangesJsonRpcRequest.md +++ b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetFilterChangesJsonRpcRequest.md @@ -11,4 +11,4 @@ JSON-RPC request for `eth_getFilterChanges` procedure ## Defined in -[packages/procedures/src/eth/EthJsonRpcRequest.ts:130](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L130) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:138](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L138) diff --git a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetFilterLogsJsonRpcRequest.md b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetFilterLogsJsonRpcRequest.md index e2f44c65af..4ad7b6d3ed 100644 --- a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetFilterLogsJsonRpcRequest.md +++ b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetFilterLogsJsonRpcRequest.md @@ -11,4 +11,4 @@ JSON-RPC request for `eth_getFilterLogs` procedure ## Defined in -[packages/procedures/src/eth/EthJsonRpcRequest.ts:135](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L135) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:143](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L143) diff --git a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetLogsJsonRpcRequest.md b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetLogsJsonRpcRequest.md index c6df07482b..09a70eccaf 100644 --- a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetLogsJsonRpcRequest.md +++ b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetLogsJsonRpcRequest.md @@ -11,4 +11,4 @@ JSON-RPC request for `eth_getLogs` procedure ## Defined in -[packages/procedures/src/eth/EthJsonRpcRequest.ts:140](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L140) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:148](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L148) diff --git a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetStorageAtJsonRpcRequest.md b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetStorageAtJsonRpcRequest.md index 36e86416a4..d3cdd1ffdf 100644 --- a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetStorageAtJsonRpcRequest.md +++ b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetStorageAtJsonRpcRequest.md @@ -11,4 +11,4 @@ JSON-RPC request for `eth_getStorageAt` procedure ## Defined in -[packages/procedures/src/eth/EthJsonRpcRequest.ts:145](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L145) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:153](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L153) diff --git a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetTransactionByBlockHashAndIndexJsonRpcRequest.md b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetTransactionByBlockHashAndIndexJsonRpcRequest.md index 1615d660f5..11049a4393 100644 --- a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetTransactionByBlockHashAndIndexJsonRpcRequest.md +++ b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetTransactionByBlockHashAndIndexJsonRpcRequest.md @@ -11,4 +11,4 @@ JSON-RPC request for `eth_getTransactionByBlockHashAndIndex` procedure ## Defined in -[packages/procedures/src/eth/EthJsonRpcRequest.ts:182](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L182) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:190](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L190) diff --git a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetTransactionByBlockNumberAndIndexJsonRpcRequest.md b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetTransactionByBlockNumberAndIndexJsonRpcRequest.md index 3fa1431d92..7e0cfc3fe8 100644 --- a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetTransactionByBlockNumberAndIndexJsonRpcRequest.md +++ b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetTransactionByBlockNumberAndIndexJsonRpcRequest.md @@ -11,4 +11,4 @@ JSON-RPC request for `eth_getTransactionByBlockNumberAndIndex` procedure ## Defined in -[packages/procedures/src/eth/EthJsonRpcRequest.ts:190](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L190) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:198](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L198) diff --git a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetTransactionByHashJsonRpcRequest.md b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetTransactionByHashJsonRpcRequest.md index 5af4232461..e91accaba8 100644 --- a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetTransactionByHashJsonRpcRequest.md +++ b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetTransactionByHashJsonRpcRequest.md @@ -11,4 +11,4 @@ JSON-RPC request for `eth_getTransactionByHash` procedure ## Defined in -[packages/procedures/src/eth/EthJsonRpcRequest.ts:177](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L177) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:185](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L185) diff --git a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetTransactionCountJsonRpcRequest.md b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetTransactionCountJsonRpcRequest.md index 41d6fe7364..d86fa05b86 100644 --- a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetTransactionCountJsonRpcRequest.md +++ b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetTransactionCountJsonRpcRequest.md @@ -11,4 +11,4 @@ JSON-RPC request for `eth_getTransactionCount` procedure ## Defined in -[packages/procedures/src/eth/EthJsonRpcRequest.ts:153](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L153) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:161](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L161) diff --git a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetTransactionReceiptJsonRpcRequest.md b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetTransactionReceiptJsonRpcRequest.md index 2acf219170..724592f4d5 100644 --- a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetTransactionReceiptJsonRpcRequest.md +++ b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetTransactionReceiptJsonRpcRequest.md @@ -11,4 +11,4 @@ JSON-RPC request for `eth_getTransactionReceipt` procedure ## Defined in -[packages/procedures/src/eth/EthJsonRpcRequest.ts:198](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L198) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:206](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L206) diff --git a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetUncleByBlockHashAndIndexJsonRpcRequest.md b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetUncleByBlockHashAndIndexJsonRpcRequest.md index 90b1bd01b1..bd5c13efb1 100644 --- a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetUncleByBlockHashAndIndexJsonRpcRequest.md +++ b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetUncleByBlockHashAndIndexJsonRpcRequest.md @@ -11,4 +11,4 @@ JSON-RPC request for `eth_getUncleByBlockHashAndIndex` procedure ## Defined in -[packages/procedures/src/eth/EthJsonRpcRequest.ts:203](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L203) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:211](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L211) diff --git a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetUncleByBlockNumberAndIndexJsonRpcRequest.md b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetUncleByBlockNumberAndIndexJsonRpcRequest.md index b4387e6345..84383e44a3 100644 --- a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetUncleByBlockNumberAndIndexJsonRpcRequest.md +++ b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetUncleByBlockNumberAndIndexJsonRpcRequest.md @@ -11,4 +11,4 @@ JSON-RPC request for `eth_getUncleByBlockNumberAndIndex` procedure ## Defined in -[packages/procedures/src/eth/EthJsonRpcRequest.ts:211](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L211) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:219](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L219) diff --git a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetUncleCountByBlockHashJsonRpcRequest.md b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetUncleCountByBlockHashJsonRpcRequest.md index b6ad9bcf2d..a8375e2112 100644 --- a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetUncleCountByBlockHashJsonRpcRequest.md +++ b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetUncleCountByBlockHashJsonRpcRequest.md @@ -11,4 +11,4 @@ JSON-RPC request for `eth_getUncleCountByBlockHash` procedure ## Defined in -[packages/procedures/src/eth/EthJsonRpcRequest.ts:161](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L161) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:169](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L169) diff --git a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetUncleCountByBlockNumberJsonRpcRequest.md b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetUncleCountByBlockNumberJsonRpcRequest.md index a4b753710e..8343c39671 100644 --- a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetUncleCountByBlockNumberJsonRpcRequest.md +++ b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthGetUncleCountByBlockNumberJsonRpcRequest.md @@ -11,4 +11,4 @@ JSON-RPC request for `eth_getUncleCountByBlockNumber` procedure ## Defined in -[packages/procedures/src/eth/EthJsonRpcRequest.ts:169](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L169) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:177](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L177) diff --git a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthHashrateJsonRpcRequest.md b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthHashrateJsonRpcRequest.md index 7e878ec305..f7fd37ef0a 100644 --- a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthHashrateJsonRpcRequest.md +++ b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthHashrateJsonRpcRequest.md @@ -11,4 +11,4 @@ JSON-RPC request for `eth_hashrate` procedure ## Defined in -[packages/procedures/src/eth/EthJsonRpcRequest.ts:78](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L78) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:86](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L86) diff --git a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthJsonRpcRequest.md b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthJsonRpcRequest.md index d77799681c..36b663f5c2 100644 --- a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthJsonRpcRequest.md +++ b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthJsonRpcRequest.md @@ -9,4 +9,4 @@ title: "EthJsonRpcRequest" ## Defined in -[packages/procedures/src/eth/EthJsonRpcRequest.ts:288](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L288) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:296](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L296) diff --git a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthMiningJsonRpcRequest.md b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthMiningJsonRpcRequest.md index e7f815ee58..10206ad9a3 100644 --- a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthMiningJsonRpcRequest.md +++ b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthMiningJsonRpcRequest.md @@ -11,4 +11,4 @@ JSON-RPC request for `eth_mining` procedure ## Defined in -[packages/procedures/src/eth/EthJsonRpcRequest.ts:219](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L219) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:227](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L227) diff --git a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthNewBlockFilterJsonRpcRequest.md b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthNewBlockFilterJsonRpcRequest.md index 0b4364a3ca..d158d29655 100644 --- a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthNewBlockFilterJsonRpcRequest.md +++ b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthNewBlockFilterJsonRpcRequest.md @@ -11,4 +11,4 @@ JSON-RPC request for `eth_newBlockFilter` procedure ## Defined in -[packages/procedures/src/eth/EthJsonRpcRequest.ts:273](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L273) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:281](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L281) diff --git a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthNewFilterJsonRpcRequest.md b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthNewFilterJsonRpcRequest.md index 732255ab34..349b4a1a26 100644 --- a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthNewFilterJsonRpcRequest.md +++ b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthNewFilterJsonRpcRequest.md @@ -11,4 +11,4 @@ JSON-RPC request for `eth_newFilter` procedure ## Defined in -[packages/procedures/src/eth/EthJsonRpcRequest.ts:268](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L268) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:276](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L276) diff --git a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthNewPendingTransactionFilterJsonRpcRequest.md b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthNewPendingTransactionFilterJsonRpcRequest.md index 08d1794512..08e1b219da 100644 --- a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthNewPendingTransactionFilterJsonRpcRequest.md +++ b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthNewPendingTransactionFilterJsonRpcRequest.md @@ -11,4 +11,4 @@ JSON-RPC request for `eth_newPendingTransactionFilter` procedure ## Defined in -[packages/procedures/src/eth/EthJsonRpcRequest.ts:278](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L278) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:286](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L286) diff --git a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthProtocolVersionJsonRpcRequest.md b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthProtocolVersionJsonRpcRequest.md index 80b0eaed23..9a7a2c7cd0 100644 --- a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthProtocolVersionJsonRpcRequest.md +++ b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthProtocolVersionJsonRpcRequest.md @@ -11,4 +11,4 @@ JSON-RPC request for `eth_protocolVersion` procedure ## Defined in -[packages/procedures/src/eth/EthJsonRpcRequest.ts:224](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L224) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:232](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L232) diff --git a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthSendRawTransactionJsonRpcRequest.md b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthSendRawTransactionJsonRpcRequest.md index fbc60d402f..89fb7b0efc 100644 --- a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthSendRawTransactionJsonRpcRequest.md +++ b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthSendRawTransactionJsonRpcRequest.md @@ -11,4 +11,4 @@ JSON-RPC request for `eth_sendRawTransaction` procedure ## Defined in -[packages/procedures/src/eth/EthJsonRpcRequest.ts:229](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L229) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:237](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L237) diff --git a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthSendTransactionJsonRpcRequest.md b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthSendTransactionJsonRpcRequest.md index 6738f2bd5e..347354af95 100644 --- a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthSendTransactionJsonRpcRequest.md +++ b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthSendTransactionJsonRpcRequest.md @@ -11,4 +11,4 @@ JSON-RPC request for `eth_sendTransaction` procedure ## Defined in -[packages/procedures/src/eth/EthJsonRpcRequest.ts:234](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L234) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:242](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L242) diff --git a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthSignJsonRpcRequest.md b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthSignJsonRpcRequest.md index c1b3046232..a42f0ad21b 100644 --- a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthSignJsonRpcRequest.md +++ b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthSignJsonRpcRequest.md @@ -11,4 +11,4 @@ JSON-RPC request for `eth_sign` procedure ## Defined in -[packages/procedures/src/eth/EthJsonRpcRequest.ts:239](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L239) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:247](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L247) diff --git a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthSignTransactionJsonRpcRequest.md b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthSignTransactionJsonRpcRequest.md index 35778c4c94..825597de96 100644 --- a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthSignTransactionJsonRpcRequest.md +++ b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthSignTransactionJsonRpcRequest.md @@ -11,4 +11,4 @@ JSON-RPC request for `eth_signTransaction` procedure ## Defined in -[packages/procedures/src/eth/EthJsonRpcRequest.ts:244](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L244) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:252](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L252) diff --git a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthSyncingJsonRpcRequest.md b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthSyncingJsonRpcRequest.md index 1850b3f83e..6bd25c6e40 100644 --- a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthSyncingJsonRpcRequest.md +++ b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthSyncingJsonRpcRequest.md @@ -11,4 +11,4 @@ JSON-RPC request for `eth_syncing` procedure ## Defined in -[packages/procedures/src/eth/EthJsonRpcRequest.ts:263](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L263) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:271](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L271) diff --git a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthUninstallFilterJsonRpcRequest.md b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthUninstallFilterJsonRpcRequest.md index 0710a4c53e..8eac4e8bac 100644 --- a/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthUninstallFilterJsonRpcRequest.md +++ b/docs/src/content/docs/reference/@tevm/procedures/type-aliases/EthUninstallFilterJsonRpcRequest.md @@ -11,4 +11,4 @@ JSON-RPC request for `eth_uninstallFilter` procedure ## Defined in -[packages/procedures/src/eth/EthJsonRpcRequest.ts:286](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L286) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:294](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L294) diff --git a/docs/src/content/docs/reference/@tevm/server/classes/InvalidJsonError.md b/docs/src/content/docs/reference/@tevm/server/classes/InvalidJsonError.md index 5722b83156..1601cb67e9 100644 --- a/docs/src/content/docs/reference/@tevm/server/classes/InvalidJsonError.md +++ b/docs/src/content/docs/reference/@tevm/server/classes/InvalidJsonError.md @@ -78,7 +78,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -92,7 +92,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -108,7 +108,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -122,7 +122,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -138,7 +138,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -170,7 +170,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -200,7 +200,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -228,7 +228,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -300,7 +300,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** diff --git a/docs/src/content/docs/reference/@tevm/server/classes/ReadRequestBodyError.md b/docs/src/content/docs/reference/@tevm/server/classes/ReadRequestBodyError.md index e32aa069cd..b404557bb6 100644 --- a/docs/src/content/docs/reference/@tevm/server/classes/ReadRequestBodyError.md +++ b/docs/src/content/docs/reference/@tevm/server/classes/ReadRequestBodyError.md @@ -65,7 +65,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -79,7 +79,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -95,7 +95,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -109,7 +109,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -125,7 +125,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -157,7 +157,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -187,7 +187,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -215,7 +215,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -287,7 +287,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** diff --git a/docs/src/content/docs/reference/@tevm/vm/functions/txLogsBloom.md b/docs/src/content/docs/reference/@tevm/vm/functions/txLogsBloom.md index e1853c6353..f3a81a9ac3 100644 --- a/docs/src/content/docs/reference/@tevm/vm/functions/txLogsBloom.md +++ b/docs/src/content/docs/reference/@tevm/vm/functions/txLogsBloom.md @@ -17,10 +17,72 @@ Creates a bloom filter from the logs. The logs to create the bloom filter from. -• **common**: [`Common`](/reference/tevm/common/type-aliases/common/) +• **common** The common object.')} +• **common.blockExplorers?** + +Collection of block explorers + +• **common.blockExplorers.default**: `ChainBlockExplorer` + +• **common.contracts?** + +Collection of contracts + +• **common.contracts.ensRegistry?**: `ChainContract` + +• **common.contracts.ensUniversalResolver?**: `ChainContract` + +• **common.contracts.multicall3?**: `ChainContract` + +• **common.copy** + +• **common.custom?**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +• **common.ethjsCommon**: `Common` + +• **common.fees?**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +• **common.formatters?**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +• **common.id**: `number` + +ID in number form + +• **common.name**: `string` + +Human-readable name + +• **common.nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +• **common.rpcUrls** + +Collection of RPC endpoints + +• **common.rpcUrls.default**: `ChainRpcUrls` + +• **common.serializers?**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +• **common.sourceId?**: `number` + +Source Chain ID (ie. the L1 chain) + +• **common.testnet?**: `boolean` + +Flag for test networks + ## Returns `Bloom` diff --git a/docs/src/content/docs/reference/@tevm/vm/interfaces/BuilderOpts.md b/docs/src/content/docs/reference/@tevm/vm/interfaces/BuilderOpts.md index b0346c0bf3..bbbedfe0ba 100644 --- a/docs/src/content/docs/reference/@tevm/vm/interfaces/BuilderOpts.md +++ b/docs/src/content/docs/reference/@tevm/vm/interfaces/BuilderOpts.md @@ -53,7 +53,7 @@ packages/block/types/types.d.ts:59 ### common -> **common**: [`Common`](/reference/tevm/common/type-aliases/common/) +> **common**: `object` A [Common](../../../../../../../reference/tevm/common/type-aliases/common) object defining the chain and the hardfork a block/block header belongs to. @@ -65,6 +65,118 @@ hardfork in the [Common](../../../../../../../reference/tevm/common/type-aliases Current default hardfork: `merge` +#### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +##### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +#### blockExplorers.default + +> **blockExplorers.default**: `ChainBlockExplorer` + +#### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +#### contracts.ensRegistry? + +> `optional` **contracts.ensRegistry**: `ChainContract` + +#### contracts.ensUniversalResolver? + +> `optional` **contracts.ensUniversalResolver**: `ChainContract` + +#### contracts.multicall3? + +> `optional` **contracts.multicall3**: `ChainContract` + +#### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +##### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +#### ethjsCommon + +> **ethjsCommon**: `Common` + +#### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +#### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +#### id + +> **id**: `number` + +ID in number form + +#### name + +> **name**: `string` + +Human-readable name + +#### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +#### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +##### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +#### rpcUrls.default + +> **rpcUrls.default**: `ChainRpcUrls` + +#### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +#### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +#### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + #### Inherited from [`BlockOptions`](/reference/tevm/block/interfaces/blockoptions/).[`common`](/reference/tevm/block/interfaces/blockoptions/#common) diff --git a/docs/src/content/docs/reference/@tevm/vm/interfaces/VMOpts.md b/docs/src/content/docs/reference/@tevm/vm/interfaces/VMOpts.md index 2c4798e599..5f12070ba1 100644 --- a/docs/src/content/docs/reference/@tevm/vm/interfaces/VMOpts.md +++ b/docs/src/content/docs/reference/@tevm/vm/interfaces/VMOpts.md @@ -45,7 +45,7 @@ A Blockchain object for storing/retrieving blocks ### common? -> `optional` **common**: [`Common`](/reference/tevm/common/type-aliases/common/) +> `optional` **common**: `object` Use a [Common](../../../../../../../reference/tevm/common/type-aliases/common) instance if you want to change the chain setup. @@ -67,6 +67,118 @@ Default setup if no `Common` instance is provided: - `hardfork`: `paris` - `eips`: `[]` +#### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +##### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +#### blockExplorers.default + +> **blockExplorers.default**: `ChainBlockExplorer` + +#### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +#### contracts.ensRegistry? + +> `optional` **contracts.ensRegistry**: `ChainContract` + +#### contracts.ensUniversalResolver? + +> `optional` **contracts.ensUniversalResolver**: `ChainContract` + +#### contracts.multicall3? + +> `optional` **contracts.multicall3**: `ChainContract` + +#### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +##### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +#### ethjsCommon + +> **ethjsCommon**: `Common` + +#### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +#### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +#### id + +> **id**: `number` + +ID in number form + +#### name + +> **name**: `string` + +Human-readable name + +#### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +#### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +##### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +#### rpcUrls.default + +> **rpcUrls.default**: `ChainRpcUrls` + +#### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +#### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +#### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + #### Defined in [packages/vm/src/utils/VMOpts.ts:33](https://github.com/evmts/tevm-monorepo/blob/main/packages/vm/src/utils/VMOpts.ts#L33) diff --git a/experimental/schemas/docs/README.md b/experimental/schemas/docs/README.md index 1d6c736a37..90660c3648 100644 --- a/experimental/schemas/docs/README.md +++ b/experimental/schemas/docs/README.md @@ -26,4 +26,4 @@ Effect Schemas for Tevm. ## License 📄 - + diff --git a/experimental/schemas/docs/_media/LICENSE b/experimental/schemas/docs/_media/LICENSE deleted file mode 100644 index 3ee5a4410a..0000000000 --- a/experimental/schemas/docs/_media/LICENSE +++ /dev/null @@ -1,22 +0,0 @@ -(The MIT License) - -Copyright 2023 - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/experimental/schemas/docs/common/classes/InvalidBlockNumberError.md b/experimental/schemas/docs/common/classes/InvalidBlockNumberError.md index 6b3607e5a5..8b57f92d79 100644 --- a/experimental/schemas/docs/common/classes/InvalidBlockNumberError.md +++ b/experimental/schemas/docs/common/classes/InvalidBlockNumberError.md @@ -117,6 +117,10 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -127,10 +131,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from `TypeError.prepareStackTrace` @@ -203,4 +203,4 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/experimental/schemas/docs/common/classes/InvalidUrlError.md b/experimental/schemas/docs/common/classes/InvalidUrlError.md index 260b31550b..411cd7bb62 100644 --- a/experimental/schemas/docs/common/classes/InvalidUrlError.md +++ b/experimental/schemas/docs/common/classes/InvalidUrlError.md @@ -116,6 +116,10 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -126,10 +130,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from `TypeError.prepareStackTrace` @@ -202,4 +202,4 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/experimental/schemas/docs/common/functions/isBlockNumber.md b/experimental/schemas/docs/common/functions/isBlockNumber.md index 3a22bbc637..fcca01b5cc 100644 --- a/experimental/schemas/docs/common/functions/isBlockNumber.md +++ b/experimental/schemas/docs/common/functions/isBlockNumber.md @@ -8,8 +8,6 @@ > **isBlockNumber**(`blockNumber`): `boolean` -Type guard that returns true if the provided number is a valid Ethereum block number. - ## Parameters • **blockNumber**: `unknown` @@ -18,14 +16,6 @@ Type guard that returns true if the provided number is a valid Ethereum block nu `boolean` -## Example - -```ts -import { isBlockNumber } from '@tevm/schemas'; -isBlockNumber('0x1234567890abcdef1234567890abcdef12345678'); // true -isBlockNumber('not a blockNumber'); // false -```` - ## Defined in [experimental/schemas/src/common/SBlockNumber.js:46](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/common/SBlockNumber.js#L46) diff --git a/experimental/schemas/docs/common/functions/isUrl.md b/experimental/schemas/docs/common/functions/isUrl.md index 76762dba32..0e218de76c 100644 --- a/experimental/schemas/docs/common/functions/isUrl.md +++ b/experimental/schemas/docs/common/functions/isUrl.md @@ -8,8 +8,6 @@ > **isUrl**(`value`): `boolean` -Type guard that returns true if the provided string is a valid URL. - ## Parameters • **value**: `string` @@ -18,14 +16,6 @@ Type guard that returns true if the provided string is a valid URL. `boolean` -## Example - -```javascript -import { isUrl } from '@tevm/schemas'; -isUrl('https://tevm.sh'); // true -isUrl('not a url'); // false -```` - ## Defined in [experimental/schemas/src/common/SUrl.js:33](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/common/SUrl.js#L33) diff --git a/experimental/schemas/docs/common/functions/parseBlockNumber.md b/experimental/schemas/docs/common/functions/parseBlockNumber.md index b5d00f8b52..b6ce63ed79 100644 --- a/experimental/schemas/docs/common/functions/parseBlockNumber.md +++ b/experimental/schemas/docs/common/functions/parseBlockNumber.md @@ -8,8 +8,6 @@ > **parseBlockNumber**\<`TBlockNumber`\>(`blockNumber`): `TBlockNumber` -Parses a BlockNumber and returns the value if no errors. - ## Type Parameters • **TBlockNumber** *extends* `number` @@ -22,13 +20,6 @@ Parses a BlockNumber and returns the value if no errors. `TBlockNumber` -## Example - -```ts -import { parseBlockNumber } from '@tevm/schemas'; -const parsedBlockNumber = parseBlockNumber('0x1234567890abcdef1234567890abcdef12345678'); -``` - ## Defined in [experimental/schemas/src/common/SBlockNumber.js:106](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/common/SBlockNumber.js#L106) diff --git a/experimental/schemas/docs/common/functions/parseBlockNumberSafe.md b/experimental/schemas/docs/common/functions/parseBlockNumberSafe.md index 47758e7b6c..fa0f07cf17 100644 --- a/experimental/schemas/docs/common/functions/parseBlockNumberSafe.md +++ b/experimental/schemas/docs/common/functions/parseBlockNumberSafe.md @@ -8,8 +8,6 @@ > **parseBlockNumberSafe**\<`TBlockNumber`\>(`blockNumber`): `Effect`\<`never`, [`InvalidBlockNumberError`](../classes/InvalidBlockNumberError.md), `TBlockNumber`\> -Safely parses a BlockNumber into an [Effect](https://www.effect.website/docs/essentials/effect-type). - ## Type Parameters • **TBlockNumber** *extends* `number` @@ -22,13 +20,6 @@ Safely parses a BlockNumber into an [Effect](https://www.effect.website/docs/ess `Effect`\<`never`, [`InvalidBlockNumberError`](../classes/InvalidBlockNumberError.md), `TBlockNumber`\> -## Example - -```ts -import { parseBlockNumberSafe } from '@tevm/schemas'; -const parsedBlockNumberEffect = parseBlockNumberSafe('0x1234567890abcdef1234567890abcdef12345678'); -``` - ## Defined in [experimental/schemas/src/common/SBlockNumber.js:84](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/common/SBlockNumber.js#L84) diff --git a/experimental/schemas/docs/common/functions/parseUrl.md b/experimental/schemas/docs/common/functions/parseUrl.md index 5d10dda3f7..73b6dc5b25 100644 --- a/experimental/schemas/docs/common/functions/parseUrl.md +++ b/experimental/schemas/docs/common/functions/parseUrl.md @@ -8,8 +8,6 @@ > **parseUrl**\<`TUrl`\>(`url`): `TUrl` -Parses a Url and returns the value if no errors. - ## Type Parameters • **TUrl** *extends* `string` @@ -22,13 +20,6 @@ Parses a Url and returns the value if no errors. `TUrl` -## Example - -```javascript -import { parseUrl } from '@tevm/schemas'; -const parsedUrl = parseUrl('https://tevm.sh'); -``` - ## Defined in [experimental/schemas/src/common/SUrl.js:109](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/common/SUrl.js#L109) diff --git a/experimental/schemas/docs/common/functions/parseUrlSafe.md b/experimental/schemas/docs/common/functions/parseUrlSafe.md index bcf0513949..84c453fd73 100644 --- a/experimental/schemas/docs/common/functions/parseUrlSafe.md +++ b/experimental/schemas/docs/common/functions/parseUrlSafe.md @@ -8,8 +8,6 @@ > **parseUrlSafe**\<`TUrl`\>(`url`): `Effect`\<`never`, [`InvalidUrlError`](../classes/InvalidUrlError.md), `TUrl`\> -Safely parses a Url into an [Effect](https://www.effect.website/docs/essentials/effect-type). - ## Type Parameters • **TUrl** *extends* `string` @@ -22,13 +20,6 @@ Safely parses a Url into an [Effect](https://www.effect.website/docs/essentials/ `Effect`\<`never`, [`InvalidUrlError`](../classes/InvalidUrlError.md), `TUrl`\> -## Example - -```javascript -import { parseUrlSafe } from '@tevm/schemas'; -const parsedUrlEffect = parseUrlSafe('https://tevm.sh'); -``` - ## Defined in [experimental/schemas/src/common/SUrl.js:91](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/common/SUrl.js#L91) diff --git a/experimental/schemas/docs/ethereum/classes/InvalidAddressError.md b/experimental/schemas/docs/ethereum/classes/InvalidAddressError.md index 5a6faf44bf..1e31c75f4d 100644 --- a/experimental/schemas/docs/ethereum/classes/InvalidAddressError.md +++ b/experimental/schemas/docs/ethereum/classes/InvalidAddressError.md @@ -123,6 +123,10 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -133,10 +137,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from `TypeError.prepareStackTrace` @@ -209,4 +209,4 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/experimental/schemas/docs/ethereum/classes/InvalidBytesError.md b/experimental/schemas/docs/ethereum/classes/InvalidBytesError.md index 493f340bc3..95941d43b6 100644 --- a/experimental/schemas/docs/ethereum/classes/InvalidBytesError.md +++ b/experimental/schemas/docs/ethereum/classes/InvalidBytesError.md @@ -116,6 +116,10 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -126,10 +130,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from `TypeError.prepareStackTrace` @@ -202,4 +202,4 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/experimental/schemas/docs/ethereum/classes/InvalidBytesFixedError.md b/experimental/schemas/docs/ethereum/classes/InvalidBytesFixedError.md index 68fcb8e6a2..5718ec2d51 100644 --- a/experimental/schemas/docs/ethereum/classes/InvalidBytesFixedError.md +++ b/experimental/schemas/docs/ethereum/classes/InvalidBytesFixedError.md @@ -121,6 +121,10 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -131,10 +135,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from `TypeError.prepareStackTrace` @@ -207,4 +207,4 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/experimental/schemas/docs/ethereum/classes/InvalidINTError.md b/experimental/schemas/docs/ethereum/classes/InvalidINTError.md index 42a351833f..27e226a26f 100644 --- a/experimental/schemas/docs/ethereum/classes/InvalidINTError.md +++ b/experimental/schemas/docs/ethereum/classes/InvalidINTError.md @@ -121,6 +121,10 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -131,10 +135,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from `TypeError.prepareStackTrace` @@ -207,4 +207,4 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/experimental/schemas/docs/ethereum/classes/InvalidUINTError.md b/experimental/schemas/docs/ethereum/classes/InvalidUINTError.md index 38ba765159..45bf19bff6 100644 --- a/experimental/schemas/docs/ethereum/classes/InvalidUINTError.md +++ b/experimental/schemas/docs/ethereum/classes/InvalidUINTError.md @@ -121,6 +121,10 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -131,10 +135,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from `TypeError.prepareStackTrace` @@ -207,4 +207,4 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/experimental/schemas/docs/ethereum/functions/isAddress.md b/experimental/schemas/docs/ethereum/functions/isAddress.md index 2f1e5015ce..a4ea6cb7eb 100644 --- a/experimental/schemas/docs/ethereum/functions/isAddress.md +++ b/experimental/schemas/docs/ethereum/functions/isAddress.md @@ -8,8 +8,6 @@ > **isAddress**(`address`): `boolean` -Checks if a string is a valid Ethereum address. - ## Parameters • **address**: `string` @@ -23,13 +21,6 @@ The address to check. - True if the address is valid. [Solidity docs](https://docs.soliditylang.org/en/latest/types.html#address) -## Example - -```ts -isAddress('0x1234'); // false -isAddress('0x1234567890123456789012345678901234567890'); // true -``` - ## Defined in [experimental/schemas/src/ethereum/SAddress/isAddress.js:23](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SAddress/isAddress.js#L23) diff --git a/experimental/schemas/docs/ethereum/functions/isBytes.md b/experimental/schemas/docs/ethereum/functions/isBytes.md index 3696cd46ba..18f03e41de 100644 --- a/experimental/schemas/docs/ethereum/functions/isBytes.md +++ b/experimental/schemas/docs/ethereum/functions/isBytes.md @@ -8,8 +8,6 @@ > **isBytes**(`value`): `boolean` -Type guard that returns true if a string is a valid hex string. - ## Parameters • **value**: `string` @@ -22,14 +20,6 @@ The string to check. - True if the string is a valid hex string. -## Example - -```javascript -import { isBytes } from '@tevm/schemas'; -const hex = '0x1234567890abcdef1234567890abcdef12345678'; -const isHex = isBytes(hex); -``` - ## Defined in [experimental/schemas/src/ethereum/SBytes/isBytes.js:22](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytes/isBytes.js#L22) diff --git a/experimental/schemas/docs/ethereum/functions/isBytes1.md b/experimental/schemas/docs/ethereum/functions/isBytes1.md index d236febfec..c5d53c6793 100644 --- a/experimental/schemas/docs/ethereum/functions/isBytes1.md +++ b/experimental/schemas/docs/ethereum/functions/isBytes1.md @@ -8,8 +8,6 @@ > **isBytes1**(`bytes1`): `boolean` -Type guard that returns true if the provided string is a valid Ethereum Bytes1. - ## Parameters • **bytes1**: `unknown` @@ -18,14 +16,6 @@ Type guard that returns true if the provided string is a valid Ethereum Bytes1. `boolean` -## Example - -```ts -import { isBytes1 } from '@tevm/schemas'; -isBytes1("0xff"); // true -isBytes1("0xfff"); // false -```` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js:56](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js#L56) diff --git a/experimental/schemas/docs/ethereum/functions/isBytes10.md b/experimental/schemas/docs/ethereum/functions/isBytes10.md index ccd264b455..0e20b9d757 100644 --- a/experimental/schemas/docs/ethereum/functions/isBytes10.md +++ b/experimental/schemas/docs/ethereum/functions/isBytes10.md @@ -8,8 +8,6 @@ > **isBytes10**(`bytes10`): `boolean` -Type guard that returns true if the provided string is a valid Ethereum Bytes10. - ## Parameters • **bytes10**: `unknown` @@ -18,14 +16,6 @@ Type guard that returns true if the provided string is a valid Ethereum Bytes10. `boolean` -## Example - -```ts -import { isBytes10 } from '@tevm/schemas'; -isBytes10("0xff"); // true -isBytes10("0xfff"); // false -```` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js:191](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js#L191) diff --git a/experimental/schemas/docs/ethereum/functions/isBytes11.md b/experimental/schemas/docs/ethereum/functions/isBytes11.md index fbe81aea03..ba548a8186 100644 --- a/experimental/schemas/docs/ethereum/functions/isBytes11.md +++ b/experimental/schemas/docs/ethereum/functions/isBytes11.md @@ -8,8 +8,6 @@ > **isBytes11**(`bytes11`): `boolean` -Type guard that returns true if the provided string is a valid Ethereum Bytes11. - ## Parameters • **bytes11**: `unknown` @@ -18,14 +16,6 @@ Type guard that returns true if the provided string is a valid Ethereum Bytes11. `boolean` -## Example - -```ts -import { isBytes11 } from '@tevm/schemas'; -isBytes11("0xff"); // true -isBytes11("0xfff"); // false -```` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js:206](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js#L206) diff --git a/experimental/schemas/docs/ethereum/functions/isBytes12.md b/experimental/schemas/docs/ethereum/functions/isBytes12.md index 13c76c6dec..f55849bb34 100644 --- a/experimental/schemas/docs/ethereum/functions/isBytes12.md +++ b/experimental/schemas/docs/ethereum/functions/isBytes12.md @@ -8,8 +8,6 @@ > **isBytes12**(`bytes12`): `boolean` -Type guard that returns true if the provided string is a valid Ethereum Bytes12. - ## Parameters • **bytes12**: `unknown` @@ -18,14 +16,6 @@ Type guard that returns true if the provided string is a valid Ethereum Bytes12. `boolean` -## Example - -```ts -import { isBytes12 } from '@tevm/schemas'; -isBytes12("0xff"); // true -isBytes12("0xfff"); // false -```` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js:221](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js#L221) diff --git a/experimental/schemas/docs/ethereum/functions/isBytes13.md b/experimental/schemas/docs/ethereum/functions/isBytes13.md index 99cc53b54f..bcdbf1be1d 100644 --- a/experimental/schemas/docs/ethereum/functions/isBytes13.md +++ b/experimental/schemas/docs/ethereum/functions/isBytes13.md @@ -8,8 +8,6 @@ > **isBytes13**(`bytes13`): `boolean` -Type guard that returns true if the provided string is a valid Ethereum Bytes13. - ## Parameters • **bytes13**: `unknown` @@ -18,14 +16,6 @@ Type guard that returns true if the provided string is a valid Ethereum Bytes13. `boolean` -## Example - -```ts -import { isBytes13 } from '@tevm/schemas'; -isBytes13("0xff"); // true -isBytes13("0xfff"); // false -```` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js:236](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js#L236) diff --git a/experimental/schemas/docs/ethereum/functions/isBytes14.md b/experimental/schemas/docs/ethereum/functions/isBytes14.md index 16a25e6a58..4cd34361b7 100644 --- a/experimental/schemas/docs/ethereum/functions/isBytes14.md +++ b/experimental/schemas/docs/ethereum/functions/isBytes14.md @@ -8,8 +8,6 @@ > **isBytes14**(`bytes14`): `boolean` -Type guard that returns true if the provided string is a valid Ethereum Bytes14. - ## Parameters • **bytes14**: `unknown` @@ -18,14 +16,6 @@ Type guard that returns true if the provided string is a valid Ethereum Bytes14. `boolean` -## Example - -```ts -import { isBytes14 } from '@tevm/schemas'; -isBytes14("0xff"); // true -isBytes14("0xfff"); // false -```` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js:251](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js#L251) diff --git a/experimental/schemas/docs/ethereum/functions/isBytes15.md b/experimental/schemas/docs/ethereum/functions/isBytes15.md index 64ecb17c4a..da2c06360f 100644 --- a/experimental/schemas/docs/ethereum/functions/isBytes15.md +++ b/experimental/schemas/docs/ethereum/functions/isBytes15.md @@ -8,8 +8,6 @@ > **isBytes15**(`bytes15`): `boolean` -Type guard that returns true if the provided string is a valid Ethereum Bytes15. - ## Parameters • **bytes15**: `unknown` @@ -18,14 +16,6 @@ Type guard that returns true if the provided string is a valid Ethereum Bytes15. `boolean` -## Example - -```ts -import { isBytes15 } from '@tevm/schemas'; -isBytes15("0xff"); // true -isBytes15("0xfff"); // false -```` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js:266](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js#L266) diff --git a/experimental/schemas/docs/ethereum/functions/isBytes16.md b/experimental/schemas/docs/ethereum/functions/isBytes16.md index 3c5c4628aa..666f20a5f5 100644 --- a/experimental/schemas/docs/ethereum/functions/isBytes16.md +++ b/experimental/schemas/docs/ethereum/functions/isBytes16.md @@ -8,8 +8,6 @@ > **isBytes16**(`bytes16`): `boolean` -Type guard that returns true if the provided string is a valid Ethereum Bytes16. - ## Parameters • **bytes16**: `unknown` @@ -18,14 +16,6 @@ Type guard that returns true if the provided string is a valid Ethereum Bytes16. `boolean` -## Example - -```ts -import { isBytes16 } from '@tevm/schemas'; -isBytes16("0xff"); // true -isBytes16("0xfff"); // false -```` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js:281](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js#L281) diff --git a/experimental/schemas/docs/ethereum/functions/isBytes17.md b/experimental/schemas/docs/ethereum/functions/isBytes17.md index 4bb0058d1e..98be1f8d25 100644 --- a/experimental/schemas/docs/ethereum/functions/isBytes17.md +++ b/experimental/schemas/docs/ethereum/functions/isBytes17.md @@ -8,8 +8,6 @@ > **isBytes17**(`bytes17`): `boolean` -Type guard that returns true if the provided string is a valid Ethereum Bytes17. - ## Parameters • **bytes17**: `unknown` @@ -18,14 +16,6 @@ Type guard that returns true if the provided string is a valid Ethereum Bytes17. `boolean` -## Example - -```ts -import { isBytes17 } from '@tevm/schemas'; -isBytes17("0xff"); // true -isBytes17("0xfff"); // false -```` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js:296](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js#L296) diff --git a/experimental/schemas/docs/ethereum/functions/isBytes18.md b/experimental/schemas/docs/ethereum/functions/isBytes18.md index 11668ea998..45cc2581bc 100644 --- a/experimental/schemas/docs/ethereum/functions/isBytes18.md +++ b/experimental/schemas/docs/ethereum/functions/isBytes18.md @@ -8,8 +8,6 @@ > **isBytes18**(`bytes18`): `boolean` -Type guard that returns true if the provided string is a valid Ethereum Bytes18. - ## Parameters • **bytes18**: `unknown` @@ -18,14 +16,6 @@ Type guard that returns true if the provided string is a valid Ethereum Bytes18. `boolean` -## Example - -```ts -import { isBytes18 } from '@tevm/schemas'; -isBytes18("0xff"); // true -isBytes18("0xfff"); // false -```` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js:311](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js#L311) diff --git a/experimental/schemas/docs/ethereum/functions/isBytes19.md b/experimental/schemas/docs/ethereum/functions/isBytes19.md index c72226503c..b93f09098b 100644 --- a/experimental/schemas/docs/ethereum/functions/isBytes19.md +++ b/experimental/schemas/docs/ethereum/functions/isBytes19.md @@ -8,8 +8,6 @@ > **isBytes19**(`bytes19`): `boolean` -Type guard that returns true if the provided string is a valid Ethereum Bytes19. - ## Parameters • **bytes19**: `unknown` @@ -18,14 +16,6 @@ Type guard that returns true if the provided string is a valid Ethereum Bytes19. `boolean` -## Example - -```ts -import { isBytes19 } from '@tevm/schemas'; -isBytes19("0xff"); // true -isBytes19("0xfff"); // false -```` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js:326](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js#L326) diff --git a/experimental/schemas/docs/ethereum/functions/isBytes2.md b/experimental/schemas/docs/ethereum/functions/isBytes2.md index 969d1ad6f0..c577e6b4e0 100644 --- a/experimental/schemas/docs/ethereum/functions/isBytes2.md +++ b/experimental/schemas/docs/ethereum/functions/isBytes2.md @@ -8,8 +8,6 @@ > **isBytes2**(`bytes2`): `boolean` -Type guard that returns true if the provided string is a valid Ethereum Bytes2. - ## Parameters • **bytes2**: `unknown` @@ -18,14 +16,6 @@ Type guard that returns true if the provided string is a valid Ethereum Bytes2. `boolean` -## Example - -```ts -import { isBytes2 } from '@tevm/schemas'; -isBytes2("0xff"); // true -isBytes2("0xfff"); // false -```` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js:71](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js#L71) diff --git a/experimental/schemas/docs/ethereum/functions/isBytes20.md b/experimental/schemas/docs/ethereum/functions/isBytes20.md index b0e5f088b5..23d5bee9a8 100644 --- a/experimental/schemas/docs/ethereum/functions/isBytes20.md +++ b/experimental/schemas/docs/ethereum/functions/isBytes20.md @@ -8,8 +8,6 @@ > **isBytes20**(`bytes20`): `boolean` -Type guard that returns true if the provided string is a valid Ethereum Bytes20. - ## Parameters • **bytes20**: `unknown` @@ -18,14 +16,6 @@ Type guard that returns true if the provided string is a valid Ethereum Bytes20. `boolean` -## Example - -```ts -import { isBytes20 } from '@tevm/schemas'; -isBytes20("0xff"); // true -isBytes20("0xfff"); // false -```` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js:341](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js#L341) diff --git a/experimental/schemas/docs/ethereum/functions/isBytes21.md b/experimental/schemas/docs/ethereum/functions/isBytes21.md index 263f95245e..bbf52f6d90 100644 --- a/experimental/schemas/docs/ethereum/functions/isBytes21.md +++ b/experimental/schemas/docs/ethereum/functions/isBytes21.md @@ -8,8 +8,6 @@ > **isBytes21**(`bytes21`): `boolean` -Type guard that returns true if the provided string is a valid Ethereum Bytes21. - ## Parameters • **bytes21**: `unknown` @@ -18,14 +16,6 @@ Type guard that returns true if the provided string is a valid Ethereum Bytes21. `boolean` -## Example - -```ts -import { isBytes21 } from '@tevm/schemas'; -isBytes21("0xff"); // true -isBytes21("0xfff"); // false -```` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js:356](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js#L356) diff --git a/experimental/schemas/docs/ethereum/functions/isBytes22.md b/experimental/schemas/docs/ethereum/functions/isBytes22.md index 2a900d1995..8689ff671a 100644 --- a/experimental/schemas/docs/ethereum/functions/isBytes22.md +++ b/experimental/schemas/docs/ethereum/functions/isBytes22.md @@ -8,8 +8,6 @@ > **isBytes22**(`bytes22`): `boolean` -Type guard that returns true if the provided string is a valid Ethereum Bytes22. - ## Parameters • **bytes22**: `unknown` @@ -18,14 +16,6 @@ Type guard that returns true if the provided string is a valid Ethereum Bytes22. `boolean` -## Example - -```ts -import { isBytes22 } from '@tevm/schemas'; -isBytes22("0xff"); // true -isBytes22("0xfff"); // false -```` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js:371](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js#L371) diff --git a/experimental/schemas/docs/ethereum/functions/isBytes23.md b/experimental/schemas/docs/ethereum/functions/isBytes23.md index 76cd6f3a20..4aea6af7f9 100644 --- a/experimental/schemas/docs/ethereum/functions/isBytes23.md +++ b/experimental/schemas/docs/ethereum/functions/isBytes23.md @@ -8,8 +8,6 @@ > **isBytes23**(`bytes23`): `boolean` -Type guard that returns true if the provided string is a valid Ethereum Bytes23. - ## Parameters • **bytes23**: `unknown` @@ -18,14 +16,6 @@ Type guard that returns true if the provided string is a valid Ethereum Bytes23. `boolean` -## Example - -```ts -import { isBytes23 } from '@tevm/schemas'; -isBytes23("0xff"); // true -isBytes23("0xfff"); // false -```` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js:386](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js#L386) diff --git a/experimental/schemas/docs/ethereum/functions/isBytes24.md b/experimental/schemas/docs/ethereum/functions/isBytes24.md index 9818e7965f..055781d90c 100644 --- a/experimental/schemas/docs/ethereum/functions/isBytes24.md +++ b/experimental/schemas/docs/ethereum/functions/isBytes24.md @@ -8,8 +8,6 @@ > **isBytes24**(`bytes24`): `boolean` -Type guard that returns true if the provided string is a valid Ethereum Bytes24. - ## Parameters • **bytes24**: `unknown` @@ -18,14 +16,6 @@ Type guard that returns true if the provided string is a valid Ethereum Bytes24. `boolean` -## Example - -```ts -import { isBytes24 } from '@tevm/schemas'; -isBytes24("0xff"); // true -isBytes24("0xfff"); // false -```` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js:401](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js#L401) diff --git a/experimental/schemas/docs/ethereum/functions/isBytes25.md b/experimental/schemas/docs/ethereum/functions/isBytes25.md index 5a0d9556b3..1b9ec2dfe3 100644 --- a/experimental/schemas/docs/ethereum/functions/isBytes25.md +++ b/experimental/schemas/docs/ethereum/functions/isBytes25.md @@ -8,8 +8,6 @@ > **isBytes25**(`bytes25`): `boolean` -Type guard that returns true if the provided string is a valid Ethereum Bytes25. - ## Parameters • **bytes25**: `unknown` @@ -18,14 +16,6 @@ Type guard that returns true if the provided string is a valid Ethereum Bytes25. `boolean` -## Example - -```ts -import { isBytes25 } from '@tevm/schemas'; -isBytes25("0xff"); // true -isBytes25("0xfff"); // false -```` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js:416](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js#L416) diff --git a/experimental/schemas/docs/ethereum/functions/isBytes26.md b/experimental/schemas/docs/ethereum/functions/isBytes26.md index 03913317dd..5c4b8fe49e 100644 --- a/experimental/schemas/docs/ethereum/functions/isBytes26.md +++ b/experimental/schemas/docs/ethereum/functions/isBytes26.md @@ -8,8 +8,6 @@ > **isBytes26**(`bytes26`): `boolean` -Type guard that returns true if the provided string is a valid Ethereum Bytes26. - ## Parameters • **bytes26**: `unknown` @@ -18,14 +16,6 @@ Type guard that returns true if the provided string is a valid Ethereum Bytes26. `boolean` -## Example - -```ts -import { isBytes26 } from '@tevm/schemas'; -isBytes26("0xff"); // true -isBytes26("0xfff"); // false -```` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js:431](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js#L431) diff --git a/experimental/schemas/docs/ethereum/functions/isBytes27.md b/experimental/schemas/docs/ethereum/functions/isBytes27.md index 175ee807c5..775fc6b964 100644 --- a/experimental/schemas/docs/ethereum/functions/isBytes27.md +++ b/experimental/schemas/docs/ethereum/functions/isBytes27.md @@ -8,8 +8,6 @@ > **isBytes27**(`bytes27`): `boolean` -Type guard that returns true if the provided string is a valid Ethereum Bytes27. - ## Parameters • **bytes27**: `unknown` @@ -18,14 +16,6 @@ Type guard that returns true if the provided string is a valid Ethereum Bytes27. `boolean` -## Example - -```ts -import { isBytes27 } from '@tevm/schemas'; -isBytes27("0xff"); // true -isBytes27("0xfff"); // false -```` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js:446](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js#L446) diff --git a/experimental/schemas/docs/ethereum/functions/isBytes28.md b/experimental/schemas/docs/ethereum/functions/isBytes28.md index 2af6d5c3c8..350e8f87a6 100644 --- a/experimental/schemas/docs/ethereum/functions/isBytes28.md +++ b/experimental/schemas/docs/ethereum/functions/isBytes28.md @@ -8,8 +8,6 @@ > **isBytes28**(`bytes28`): `boolean` -Type guard that returns true if the provided string is a valid Ethereum Bytes28. - ## Parameters • **bytes28**: `unknown` @@ -18,14 +16,6 @@ Type guard that returns true if the provided string is a valid Ethereum Bytes28. `boolean` -## Example - -```ts -import { isBytes28 } from '@tevm/schemas'; -isBytes28("0xff"); // true -isBytesBytes2fff"); // false -```` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js:461](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js#L461) diff --git a/experimental/schemas/docs/ethereum/functions/isBytes29.md b/experimental/schemas/docs/ethereum/functions/isBytes29.md index e43cd3d89d..b5237f7d6a 100644 --- a/experimental/schemas/docs/ethereum/functions/isBytes29.md +++ b/experimental/schemas/docs/ethereum/functions/isBytes29.md @@ -8,8 +8,6 @@ > **isBytes29**(`bytes29`): `boolean` -Type guard that returns true if the provided string is a valid Ethereum Bytes29. - ## Parameters • **bytes29**: `unknown` @@ -18,14 +16,6 @@ Type guard that returns true if the provided string is a valid Ethereum Bytes29. `boolean` -## Example - -```ts -import { isBytes29 } from '@tevm/schemas'; -isBytes29("0xff"); // true -isBytes29("0xfff"); // false -```` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js:476](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js#L476) diff --git a/experimental/schemas/docs/ethereum/functions/isBytes3.md b/experimental/schemas/docs/ethereum/functions/isBytes3.md index e981666ce6..232b26dfc1 100644 --- a/experimental/schemas/docs/ethereum/functions/isBytes3.md +++ b/experimental/schemas/docs/ethereum/functions/isBytes3.md @@ -8,8 +8,6 @@ > **isBytes3**(`bytes3`): `boolean` -Type guard that returns true if the provided string is a valid Ethereum Bytes3. - ## Parameters • **bytes3**: `unknown` @@ -18,14 +16,6 @@ Type guard that returns true if the provided string is a valid Ethereum Bytes3. `boolean` -## Example - -```ts -import { isBytes3 } from '@tevm/schemas'; -isBytes3("0xff"); // true -isBytes3("0xfff"); // false -```` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js:86](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js#L86) diff --git a/experimental/schemas/docs/ethereum/functions/isBytes30.md b/experimental/schemas/docs/ethereum/functions/isBytes30.md index 241ea1d1d3..d6e4bea987 100644 --- a/experimental/schemas/docs/ethereum/functions/isBytes30.md +++ b/experimental/schemas/docs/ethereum/functions/isBytes30.md @@ -8,8 +8,6 @@ > **isBytes30**(`bytes30`): `boolean` -Type guard that returns true if the provided string is a valid Ethereum Bytes30. - ## Parameters • **bytes30**: `unknown` @@ -18,14 +16,6 @@ Type guard that returns true if the provided string is a valid Ethereum Bytes30. `boolean` -## Example - -```ts -import { isBytes30 } from '@tevm/schemas'; -isBytes30("0xff"); // true -isBytes30("0xfff"); // false -```` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js:491](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js#L491) diff --git a/experimental/schemas/docs/ethereum/functions/isBytes31.md b/experimental/schemas/docs/ethereum/functions/isBytes31.md index 327440d779..396a46bf8b 100644 --- a/experimental/schemas/docs/ethereum/functions/isBytes31.md +++ b/experimental/schemas/docs/ethereum/functions/isBytes31.md @@ -8,8 +8,6 @@ > **isBytes31**(`bytes31`): `boolean` -Type guard that returns true if the provided string is a valid Ethereum Bytes31. - ## Parameters • **bytes31**: `unknown` @@ -18,14 +16,6 @@ Type guard that returns true if the provided string is a valid Ethereum Bytes31. `boolean` -## Example - -```ts -import { isBytes31 } from '@tevm/schemas'; -isBytes31("0xff"); // true -isBytes31("0xfff"); // false -```` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js:506](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js#L506) diff --git a/experimental/schemas/docs/ethereum/functions/isBytes32.md b/experimental/schemas/docs/ethereum/functions/isBytes32.md index d1e28e2bd8..13332d4064 100644 --- a/experimental/schemas/docs/ethereum/functions/isBytes32.md +++ b/experimental/schemas/docs/ethereum/functions/isBytes32.md @@ -8,8 +8,6 @@ > **isBytes32**(`bytes32`): `boolean` -Type guard that returns true if the provided string is a valid Ethereum Bytes22. - ## Parameters • **bytes32**: `unknown` @@ -18,14 +16,6 @@ Type guard that returns true if the provided string is a valid Ethereum Bytes22. `boolean` -## Example - -```ts -import { isBytes22 } from '@tevm/schemas'; -isBytes22("0xff"); // true -isBytes22("0xfff"); // false -```` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js:521](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js#L521) diff --git a/experimental/schemas/docs/ethereum/functions/isBytes4.md b/experimental/schemas/docs/ethereum/functions/isBytes4.md index 97cf680c67..78f73b64b0 100644 --- a/experimental/schemas/docs/ethereum/functions/isBytes4.md +++ b/experimental/schemas/docs/ethereum/functions/isBytes4.md @@ -8,8 +8,6 @@ > **isBytes4**(`bytes4`): `boolean` -Type guard that returns true if the provided string is a valid Ethereum Bytes4. - ## Parameters • **bytes4**: `unknown` @@ -18,14 +16,6 @@ Type guard that returns true if the provided string is a valid Ethereum Bytes4. `boolean` -## Example - -```ts -import { isBytes4 } from '@tevm/schemas'; -isBytes4("0xff"); // true -isBytes4("0xfff"); // false -```` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js:101](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js#L101) diff --git a/experimental/schemas/docs/ethereum/functions/isBytes5.md b/experimental/schemas/docs/ethereum/functions/isBytes5.md index ae61192282..61ee0cef2b 100644 --- a/experimental/schemas/docs/ethereum/functions/isBytes5.md +++ b/experimental/schemas/docs/ethereum/functions/isBytes5.md @@ -8,8 +8,6 @@ > **isBytes5**(`bytes5`): `boolean` -Type guard that returns true if the provided string is a valid Ethereum Bytes5. - ## Parameters • **bytes5**: `unknown` @@ -18,14 +16,6 @@ Type guard that returns true if the provided string is a valid Ethereum Bytes5. `boolean` -## Example - -```ts -import { isBytes5 } from '@tevm/schemas'; -isBytes5("0xff"); // true -isBytes5("0xfff"); // false -```` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js:116](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js#L116) diff --git a/experimental/schemas/docs/ethereum/functions/isBytes6.md b/experimental/schemas/docs/ethereum/functions/isBytes6.md index 6f56ccc8a9..ad003e506d 100644 --- a/experimental/schemas/docs/ethereum/functions/isBytes6.md +++ b/experimental/schemas/docs/ethereum/functions/isBytes6.md @@ -8,8 +8,6 @@ > **isBytes6**(`bytes6`): `boolean` -Type guard that returns true if the provided string is a valid Ethereum Bytes6. - ## Parameters • **bytes6**: `unknown` @@ -18,14 +16,6 @@ Type guard that returns true if the provided string is a valid Ethereum Bytes6. `boolean` -## Example - -```ts -import { isBytes6 } from '@tevm/schemas'; -isBytes6("0xff"); // true -isBytes6("0xfff"); // false -```` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js:131](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js#L131) diff --git a/experimental/schemas/docs/ethereum/functions/isBytes7.md b/experimental/schemas/docs/ethereum/functions/isBytes7.md index b1a6c312c2..cd9971dae9 100644 --- a/experimental/schemas/docs/ethereum/functions/isBytes7.md +++ b/experimental/schemas/docs/ethereum/functions/isBytes7.md @@ -8,8 +8,6 @@ > **isBytes7**(`bytes7`): `boolean` -Type guard that returns true if the provided string is a valid Ethereum Bytes7. - ## Parameters • **bytes7**: `unknown` @@ -18,14 +16,6 @@ Type guard that returns true if the provided string is a valid Ethereum Bytes7. `boolean` -## Example - -```ts -import { isBytes7 } from '@tevm/schemas'; -isBytes7("0xff"); // true -isBytes7("0xfff"); // false -```` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js:146](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js#L146) diff --git a/experimental/schemas/docs/ethereum/functions/isBytes8.md b/experimental/schemas/docs/ethereum/functions/isBytes8.md index 5e990a48cf..90dc7db22c 100644 --- a/experimental/schemas/docs/ethereum/functions/isBytes8.md +++ b/experimental/schemas/docs/ethereum/functions/isBytes8.md @@ -8,8 +8,6 @@ > **isBytes8**(`bytes8`): `boolean` -Type guard that returns true if the provided string is a valid Ethereum Bytes8. - ## Parameters • **bytes8**: `unknown` @@ -18,14 +16,6 @@ Type guard that returns true if the provided string is a valid Ethereum Bytes8. `boolean` -## Example - -```ts -import { isBytes8 } from '@tevm/schemas'; -isBytes8("0xff"); // true -isBytes8("0xfff"); // false -```` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js:161](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js#L161) diff --git a/experimental/schemas/docs/ethereum/functions/isBytes9.md b/experimental/schemas/docs/ethereum/functions/isBytes9.md index 321a540357..9007cb8493 100644 --- a/experimental/schemas/docs/ethereum/functions/isBytes9.md +++ b/experimental/schemas/docs/ethereum/functions/isBytes9.md @@ -8,8 +8,6 @@ > **isBytes9**(`bytes9`): `boolean` -Type guard that returns true if the provided string is a valid Ethereum Bytes9. - ## Parameters • **bytes9**: `unknown` @@ -18,14 +16,6 @@ Type guard that returns true if the provided string is a valid Ethereum Bytes9. `boolean` -## Example - -```ts -import { isBytes9 } from '@tevm/schemas'; -isBytes9("0xff"); // true -isBytes9("0xfff"); // false -```` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js:176](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/isBytesFixed.js#L176) diff --git a/experimental/schemas/docs/ethereum/functions/isINT128.md b/experimental/schemas/docs/ethereum/functions/isINT128.md index d99a55412b..dc6462b263 100644 --- a/experimental/schemas/docs/ethereum/functions/isINT128.md +++ b/experimental/schemas/docs/ethereum/functions/isINT128.md @@ -8,8 +8,6 @@ > **isINT128**(`int128`): `boolean` -Type guard that returns true if the provided bigint is a valid Ethereum INT128. - ## Parameters • **int128**: `unknown` @@ -18,16 +16,6 @@ Type guard that returns true if the provided bigint is a valid Ethereum INT128. `boolean` -## Example - -```ts -import { isINT128 } from '@tevm/schemas'; -isINT128(BigInt("-170141183460469231731687303715884105728")); // true -isINT128(BigInt("170141183460469231731687303715884105727")); // true -isINT128(BigInt("170141183460469231731687303715884105728")); // false -isINT128(BigInt("-170141183460469231731687303715884105729")); // false -```` - ## Defined in [experimental/schemas/src/ethereum/SINT/isINT.js:92](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SINT/isINT.js#L92) diff --git a/experimental/schemas/docs/ethereum/functions/isINT16.md b/experimental/schemas/docs/ethereum/functions/isINT16.md index 06a70c2860..0db9f60214 100644 --- a/experimental/schemas/docs/ethereum/functions/isINT16.md +++ b/experimental/schemas/docs/ethereum/functions/isINT16.md @@ -8,8 +8,6 @@ > **isINT16**(`int16`): `boolean` -Type guard that returns true if the provided bigint is a valid Ethereum INT16. - ## Parameters • **int16**: `unknown` @@ -18,16 +16,6 @@ Type guard that returns true if the provided bigint is a valid Ethereum INT16. `boolean` -## Example - -```ts -import { isINT16 } from '@tevm/schemas'; -isINT16(BigInt(-32768)); // true -isINT16(BigInt(32767)); // true -isINT16(BigInt(32768)); // false -isINT16(BigInt(-32769)); // false -```` - ## Defined in [experimental/schemas/src/ethereum/SINT/isINT.js:41](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SINT/isINT.js#L41) diff --git a/experimental/schemas/docs/ethereum/functions/isINT256.md b/experimental/schemas/docs/ethereum/functions/isINT256.md index b43badc398..722138f051 100644 --- a/experimental/schemas/docs/ethereum/functions/isINT256.md +++ b/experimental/schemas/docs/ethereum/functions/isINT256.md @@ -8,8 +8,6 @@ > **isINT256**(`int256`): `boolean` -Type guard that returns true if the provided bigint is a valid Ethereum INT256. - ## Parameters • **int256**: `unknown` @@ -18,16 +16,6 @@ Type guard that returns true if the provided bigint is a valid Ethereum INT256. `boolean` -## Example - -```ts -import { isINT256 } from '@tevm/schemas'; -isINT256(BigInt("-115792089237316195423570985008687907853269984665640564039457584007913129639936")); // true -isINT256(BigInt("115792089237316195423570985008687907853269984665640564039457584007913129639935")); // true -isINT256(BigInt("115792089237316195423570985008687907853269984665640564039457584007913129639936")); // false -isINT256(BigInt("-115792089237316195423570985008687907853269984665640564039457584007913129639937")); // false -```` - ## Defined in [experimental/schemas/src/ethereum/SINT/isINT.js:109](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SINT/isINT.js#L109) diff --git a/experimental/schemas/docs/ethereum/functions/isINT32.md b/experimental/schemas/docs/ethereum/functions/isINT32.md index dcd1345927..174fc8286a 100644 --- a/experimental/schemas/docs/ethereum/functions/isINT32.md +++ b/experimental/schemas/docs/ethereum/functions/isINT32.md @@ -8,8 +8,6 @@ > **isINT32**(`int32`): `boolean` -Type guard that returns true if the provided bigint is a valid Ethereum INT32. - ## Parameters • **int32**: `unknown` @@ -18,16 +16,6 @@ Type guard that returns true if the provided bigint is a valid Ethereum INT32. `boolean` -## Example - -```ts -import { isINT32 } from '@tevm/schemas'; -isINT32(BigInt(-2147483648)); // true -isINT32(BigInt(2147483647)); // true -isINT32(BigInt(2147483648)); // false -isINT32(BigInt(-2147483649)); // false -```` - ## Defined in [experimental/schemas/src/ethereum/SINT/isINT.js:58](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SINT/isINT.js#L58) diff --git a/experimental/schemas/docs/ethereum/functions/isINT64.md b/experimental/schemas/docs/ethereum/functions/isINT64.md index 28b13afd60..46bc27284c 100644 --- a/experimental/schemas/docs/ethereum/functions/isINT64.md +++ b/experimental/schemas/docs/ethereum/functions/isINT64.md @@ -8,8 +8,6 @@ > **isINT64**(`int64`): `boolean` -Type guard that returns true if the provided bigint is a valid Ethereum INT64. - ## Parameters • **int64**: `unknown` @@ -18,16 +16,6 @@ Type guard that returns true if the provided bigint is a valid Ethereum INT64. `boolean` -## Example - -```ts -import { isINT64 } from '@tevm/schemas'; -isINT64(BigInt("-9223372036854775808")); // true -isINT64(BigInt("9223372036854775807")); // true -isINT64(BigInt("9223372036854775808")); // false -isINT64(BigInt("-9223372036854775809")); // false -```` - ## Defined in [experimental/schemas/src/ethereum/SINT/isINT.js:75](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SINT/isINT.js#L75) diff --git a/experimental/schemas/docs/ethereum/functions/isINT8.md b/experimental/schemas/docs/ethereum/functions/isINT8.md index e4e46edcb1..3f12ac7ba9 100644 --- a/experimental/schemas/docs/ethereum/functions/isINT8.md +++ b/experimental/schemas/docs/ethereum/functions/isINT8.md @@ -8,8 +8,6 @@ > **isINT8**(`int8`): `boolean` -Type guard that returns true if the provided bigint is a valid Ethereum INT8. - ## Parameters • **int8**: `unknown` @@ -18,16 +16,6 @@ Type guard that returns true if the provided bigint is a valid Ethereum INT8. `boolean` -## Example - -```ts -import { isINT8 } from '@tevm/schemas'; -isINT8(BigInt(-128)); // true -isINT8(BigInt(127)); // true -isINT8(BigInt(128)); // false -isINT8(BigInt(-129)); // false -```` - ## Defined in [experimental/schemas/src/ethereum/SINT/isINT.js:24](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SINT/isINT.js#L24) diff --git a/experimental/schemas/docs/ethereum/functions/isUINT128.md b/experimental/schemas/docs/ethereum/functions/isUINT128.md index 2d294a5d71..81f61db039 100644 --- a/experimental/schemas/docs/ethereum/functions/isUINT128.md +++ b/experimental/schemas/docs/ethereum/functions/isUINT128.md @@ -8,8 +8,6 @@ > **isUINT128**(`uint128`): `boolean` -Type guard that returns true if the provided bigint is a valid Ethereum UINT128. - ## Parameters • **uint128**: `unknown` @@ -18,14 +16,6 @@ Type guard that returns true if the provided bigint is a valid Ethereum UINT128. `boolean` -## Example - -```ts -import { isUINT128 } from '@tevm/schemas'; -isUINT128(BigInt("170141183460469231731687303715884105727")); // true -isUINT128(BigInt("340282366920938463463374607431768211456")); // false -```` - ## Defined in [experimental/schemas/src/ethereum/SUINT/isUINT.js:78](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SUINT/isUINT.js#L78) diff --git a/experimental/schemas/docs/ethereum/functions/isUINT16.md b/experimental/schemas/docs/ethereum/functions/isUINT16.md index 0256778fbf..b64d8b4740 100644 --- a/experimental/schemas/docs/ethereum/functions/isUINT16.md +++ b/experimental/schemas/docs/ethereum/functions/isUINT16.md @@ -8,8 +8,6 @@ > **isUINT16**(`uint16`): `boolean` -Type guard that returns true if the provided bigint is a valid Ethereum UINT16. - ## Parameters • **uint16**: `unknown` @@ -18,14 +16,6 @@ Type guard that returns true if the provided bigint is a valid Ethereum UINT16. `boolean` -## Example - -```ts -import { isUINT16 } from '@tevm/schemas'; -isUINT16(BigInt(32767)); // true -isUINT16(BigInt(65536)); // false -```` - ## Defined in [experimental/schemas/src/ethereum/SUINT/isUINT.js:36](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SUINT/isUINT.js#L36) diff --git a/experimental/schemas/docs/ethereum/functions/isUINT256.md b/experimental/schemas/docs/ethereum/functions/isUINT256.md index 163f935727..fdb954444d 100644 --- a/experimental/schemas/docs/ethereum/functions/isUINT256.md +++ b/experimental/schemas/docs/ethereum/functions/isUINT256.md @@ -8,8 +8,6 @@ > **isUINT256**(`uint256`): `boolean` -Type guard that returns true if the provided bigint is a valid Ethereum UINT256. - ## Parameters • **uint256**: `unknown` @@ -18,14 +16,6 @@ Type guard that returns true if the provided bigint is a valid Ethereum UINT256. `boolean` -## Example - -```ts -import { isUINT256 } from '@tevm/schemas'; -isUINT256(BigInt("115792089237316195423570985008687907853269984665640564039457584007913129639935")); // true -isUINT256(BigInt("231584178474632390847141970017375815706539969331281128078915168015826259279872")); // false -```` - ## Defined in [experimental/schemas/src/ethereum/SUINT/isUINT.js:92](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SUINT/isUINT.js#L92) diff --git a/experimental/schemas/docs/ethereum/functions/isUINT32.md b/experimental/schemas/docs/ethereum/functions/isUINT32.md index e88a0e0aa7..d7af75351c 100644 --- a/experimental/schemas/docs/ethereum/functions/isUINT32.md +++ b/experimental/schemas/docs/ethereum/functions/isUINT32.md @@ -8,8 +8,6 @@ > **isUINT32**(`uint32`): `boolean` -Type guard that returns true if the provided bigint is a valid Ethereum UINT32. - ## Parameters • **uint32**: `unknown` @@ -18,14 +16,6 @@ Type guard that returns true if the provided bigint is a valid Ethereum UINT32. `boolean` -## Example - -```ts -import { isUINT32 } from '@tevm/schemas'; -isUINT32(BigInt(2147483647)); // true -isUINT32(BigInt(4294967296)); // false -```` - ## Defined in [experimental/schemas/src/ethereum/SUINT/isUINT.js:50](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SUINT/isUINT.js#L50) diff --git a/experimental/schemas/docs/ethereum/functions/isUINT64.md b/experimental/schemas/docs/ethereum/functions/isUINT64.md index d5d271c870..3056c04bc9 100644 --- a/experimental/schemas/docs/ethereum/functions/isUINT64.md +++ b/experimental/schemas/docs/ethereum/functions/isUINT64.md @@ -8,8 +8,6 @@ > **isUINT64**(`uint64`): `boolean` -Type guard that returns true if the provided bigint is a valid Ethereum UINT64. - ## Parameters • **uint64**: `unknown` @@ -18,14 +16,6 @@ Type guard that returns true if the provided bigint is a valid Ethereum UINT64. `boolean` -## Example - -```ts -import { isUINT64 } from '@tevm/schemas'; -isUINT64(BigInt("9223372036854775807")); // true -isUINT64(BigInt("18446744073709551616")); // false -```` - ## Defined in [experimental/schemas/src/ethereum/SUINT/isUINT.js:64](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SUINT/isUINT.js#L64) diff --git a/experimental/schemas/docs/ethereum/functions/isUINT8.md b/experimental/schemas/docs/ethereum/functions/isUINT8.md index 2e75b13e83..24a3c61400 100644 --- a/experimental/schemas/docs/ethereum/functions/isUINT8.md +++ b/experimental/schemas/docs/ethereum/functions/isUINT8.md @@ -8,8 +8,6 @@ > **isUINT8**(`uint8`): `boolean` -Type guard that returns true if the provided bigint is a valid Ethereum UINT8. - ## Parameters • **uint8**: `unknown` @@ -18,14 +16,6 @@ Type guard that returns true if the provided bigint is a valid Ethereum UINT8. `boolean` -## Example - -```ts -import { isUINT8 } from '@tevm/schemas'; -isUINT8(BigInt(127)); // true -isUINT8(BigInt(256)); // false -```` - ## Defined in [experimental/schemas/src/ethereum/SUINT/isUINT.js:22](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SUINT/isUINT.js#L22) diff --git a/experimental/schemas/docs/ethereum/functions/parseAddress.md b/experimental/schemas/docs/ethereum/functions/parseAddress.md index ded52cabff..2932b00e26 100644 --- a/experimental/schemas/docs/ethereum/functions/parseAddress.md +++ b/experimental/schemas/docs/ethereum/functions/parseAddress.md @@ -8,8 +8,6 @@ > **parseAddress**\<`TAddress`\>(`address`): `TAddress` -Parses an Address returning the address or throwing an InvalidAddressError if invalid. - ## Type Parameters • **TAddress** *extends* \`0x$\{string\}\` @@ -26,10 +24,6 @@ The address to parse. - The parsed address. -## Throws - -- If the address is invalid. - ## Defined in [experimental/schemas/src/ethereum/SAddress/parseAddress.js:17](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SAddress/parseAddress.js#L17) diff --git a/experimental/schemas/docs/ethereum/functions/parseAddressSafe.md b/experimental/schemas/docs/ethereum/functions/parseAddressSafe.md index dfe351e855..152a2b1317 100644 --- a/experimental/schemas/docs/ethereum/functions/parseAddressSafe.md +++ b/experimental/schemas/docs/ethereum/functions/parseAddressSafe.md @@ -8,8 +8,6 @@ > **parseAddressSafe**\<`TAddress`\>(`address`): `Effect`\<`never`, [`InvalidAddressError`](../classes/InvalidAddressError.md), `TAddress`\> -Parses an Address safely into an effect. - ## Type Parameters • **TAddress** *extends* \`0x$\{string\}\` diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes.md b/experimental/schemas/docs/ethereum/functions/parseBytes.md index eaae9d824d..64a270ee07 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes.md @@ -8,8 +8,6 @@ > **parseBytes**\<`TBytes`\>(`hex`): `TBytes` -Parses a Bytes and returns the value if no errors. - ## Type Parameters • **TBytes** *extends* \`0x$\{string\}\` @@ -22,13 +20,6 @@ Parses a Bytes and returns the value if no errors. `TBytes` -## Example - -```javascript -import { parseBytes } from '@tevm/schemas'; -const parsedBytes = parseBytes('0x1234567890abcdef1234567890abcdef12345678'); -``` - ## Defined in [experimental/schemas/src/ethereum/SBytes/parseBytes.js:20](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytes/parseBytes.js#L20) diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes1.md b/experimental/schemas/docs/ethereum/functions/parseBytes1.md index e73658f7c8..bfb3933526 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes1.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes1.md @@ -8,8 +8,6 @@ > **parseBytes1**\<`TBytes1`\>(`bytes1`): `TBytes1` -Parses a Bytes1 and returns the value if no errors. - ## Type Parameters • **TBytes1** *extends* \`0x$\{string\}\` @@ -22,13 +20,6 @@ Parses a Bytes1 and returns the value if no errors. `TBytes1` -## Example - -```ts -import { parseBytes1 } from '@tevm/schemas'; -const parsedBytes1 = parseBytes1('0xff'); -``` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js:54](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js#L54) diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes10.md b/experimental/schemas/docs/ethereum/functions/parseBytes10.md index 5924d9bb05..a37c8417b7 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes10.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes10.md @@ -8,8 +8,6 @@ > **parseBytes10**\<`TBytes10`\>(`bytes10`): `TBytes10` -Parses a Bytes10 and returns the value if no errors. - ## Type Parameters • **TBytes10** *extends* \`0x$\{string\}\` @@ -22,12 +20,6 @@ Parses a Bytes10 and returns the value if no errors. `TBytes10` -## Example - -```ts -import { parseBytes10 } from '@tevm/schemas'; -const parsedBytes = parseBytes10('0xffaabbccddeeffaabbccdd'); - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js:187](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js#L187) diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes10Safe.md b/experimental/schemas/docs/ethereum/functions/parseBytes10Safe.md index eb01c692aa..74404b723d 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes10Safe.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes10Safe.md @@ -8,8 +8,6 @@ > **parseBytes10Safe**\<`TBytes10`\>(`bytes10`): `Effect`\<`never`, [`InvalidBytesFixedError`](../classes/InvalidBytesFixedError.md), `TBytes10`\> -Safely parses a Bytes10 into an [Effect](https://www.effect.website/docs/essentials/effect-type). - ## Type Parameters • **TBytes10** diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes11.md b/experimental/schemas/docs/ethereum/functions/parseBytes11.md index 1acf61d21b..9c3d9f03c5 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes11.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes11.md @@ -8,8 +8,6 @@ > **parseBytes11**\<`TBytes11`\>(`bytes11`): `TBytes11` -Parses a Bytes11 and returns the value if no errors. - ## Type Parameters • **TBytes11** *extends* \`0x$\{string\}\` @@ -22,13 +20,6 @@ Parses a Bytes11 and returns the value if no errors. `TBytes11` -## Example - -```ts -import { parseBytes11 } from '@tevm/schemas'; -const parsedBytes11 = parseBytes11('0xffaabbccddeeffaabbccddaa'); -``` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js:202](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js#L202) diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes11Safe.md b/experimental/schemas/docs/ethereum/functions/parseBytes11Safe.md index 25de58f7c2..55896962b7 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes11Safe.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes11Safe.md @@ -8,8 +8,6 @@ > **parseBytes11Safe**\<`TBytes11`\>(`bytes11`): `Effect`\<`never`, [`InvalidBytesFixedError`](../classes/InvalidBytesFixedError.md), `TBytes11`\> -Safely parses a Bytes11 into an [Effect](https://www.effect.website/docs/essentials/effect-type). - ## Type Parameters • **TBytes11** diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes12.md b/experimental/schemas/docs/ethereum/functions/parseBytes12.md index 9dbfcd60f2..fa7057ab9b 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes12.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes12.md @@ -8,8 +8,6 @@ > **parseBytes12**\<`TBytes12`\>(`bytes12`): `TBytes12` -Parses a Bytes12 and returns the value if no errors. - ## Type Parameters • **TBytes12** *extends* \`0x$\{string\}\` @@ -22,13 +20,6 @@ Parses a Bytes12 and returns the value if no errors. `TBytes12` -## Example - -```ts -import { parseBytes12 } from '@tevm/schemas'; -const parsedBytes12 = parseBytes12('0xffaabbccddeeffaabbccddaaee'); -``` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js:217](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js#L217) diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes12Safe.md b/experimental/schemas/docs/ethereum/functions/parseBytes12Safe.md index fdcd38602b..3c08f9312c 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes12Safe.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes12Safe.md @@ -8,8 +8,6 @@ > **parseBytes12Safe**\<`TBytes12`\>(`bytes12`): `Effect`\<`never`, [`InvalidBytesFixedError`](../classes/InvalidBytesFixedError.md), `TBytes12`\> -Safely parses a Bytes12 into an [Effect](https://www.effect.website/docs/essentials/effect-type). - ## Type Parameters • **TBytes12** diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes13.md b/experimental/schemas/docs/ethereum/functions/parseBytes13.md index b173de6374..7e7af09fcf 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes13.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes13.md @@ -8,8 +8,6 @@ > **parseBytes13**\<`TBytes13`\>(`bytes13`): `TBytes13` -Parses a Bytes13 and returns the value if no errors. - ## Type Parameters • **TBytes13** *extends* \`0x$\{string\}\` @@ -22,13 +20,6 @@ Parses a Bytes13 and returns the value if no errors. `TBytes13` -## Example - -```ts -import { parseBytes13 } from '@tevm/schemas'; -const parsedBytes13 = parseBytes13('0xffaabbccddeeffaabbccddaaeeff'); -``` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js:232](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js#L232) diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes13Safe.md b/experimental/schemas/docs/ethereum/functions/parseBytes13Safe.md index e1b9bd6e05..c3ae5c687c 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes13Safe.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes13Safe.md @@ -8,8 +8,6 @@ > **parseBytes13Safe**\<`TBytes13`\>(`bytes13`): `Effect`\<`never`, [`InvalidBytesFixedError`](../classes/InvalidBytesFixedError.md), `TBytes13`\> -Safely parses a Bytes13 into an [Effect](https://www.effect.website/docs/essentials/effect-type). - ## Type Parameters • **TBytes13** diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes14.md b/experimental/schemas/docs/ethereum/functions/parseBytes14.md index 223ff73f9a..d87b2fda8f 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes14.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes14.md @@ -8,8 +8,6 @@ > **parseBytes14**\<`TBytes14`\>(`bytes14`): `TBytes14` -Parses a Bytes14 and returns the value if no errors. - ## Type Parameters • **TBytes14** *extends* \`0x$\{string\}\` @@ -22,13 +20,6 @@ Parses a Bytes14 and returns the value if no errors. `TBytes14` -## Example - -```ts -import { parseBytes14 } from '@tevm/schemas'; -const parsedBytes14 = parseBytes14('0xffaabbccddeeffaabbccddaaeeffaa'); -``` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js:247](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js#L247) diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes14Safe.md b/experimental/schemas/docs/ethereum/functions/parseBytes14Safe.md index 10aeb49f27..af93d60ab2 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes14Safe.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes14Safe.md @@ -8,8 +8,6 @@ > **parseBytes14Safe**\<`TBytes14`\>(`bytes14`): `Effect`\<`never`, [`InvalidBytesFixedError`](../classes/InvalidBytesFixedError.md), `TBytes14`\> -Safely parses a Bytes14 into an [Effect](https://www.effect.website/docs/essentials/effect-type). - ## Type Parameters • **TBytes14** diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes15.md b/experimental/schemas/docs/ethereum/functions/parseBytes15.md index 7fc7785a7f..d66c99dee8 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes15.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes15.md @@ -8,8 +8,6 @@ > **parseBytes15**\<`TBytes15`\>(`bytes15`): `TBytes15` -Parses a Bytes15 and returns the value if no errors. - ## Type Parameters • **TBytes15** *extends* \`0x$\{string\}\` @@ -22,13 +20,6 @@ Parses a Bytes15 and returns the value if no errors. `TBytes15` -## Example - -```ts -import { parseBytes15 } from '@tevm/schemas'; -const parsedBytes15 = parseBytes15('0xffaabbccddeeffaabbccddaaeeffaaee'); -``` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js:262](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js#L262) diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes15Safe.md b/experimental/schemas/docs/ethereum/functions/parseBytes15Safe.md index 0e1f09a8b0..d228ae21a4 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes15Safe.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes15Safe.md @@ -8,8 +8,6 @@ > **parseBytes15Safe**\<`TBytes15`\>(`bytes15`): `Effect`\<`never`, [`InvalidBytesFixedError`](../classes/InvalidBytesFixedError.md), `TBytes15`\> -Safely parses a Bytes15 into an [Effect](https://www.effect.website/docs/essentials/effect-type). - ## Type Parameters • **TBytes15** diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes16.md b/experimental/schemas/docs/ethereum/functions/parseBytes16.md index 7c17145df0..0f4268af1b 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes16.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes16.md @@ -8,8 +8,6 @@ > **parseBytes16**\<`TBytes16`\>(`bytes16`): `TBytes16` -Parses a Bytes16 and returns the value if no errors. - ## Type Parameters • **TBytes16** *extends* \`0x$\{string\}\` @@ -22,13 +20,6 @@ Parses a Bytes16 and returns the value if no errors. `TBytes16` -## Example - -```ts -import { parseBytes16 } from '@tevm/schemas'; -const parsedBytes16 = parseBytes16('0xffaabbccddeeffaabbccddaaeeffaaeeff'); -``` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js:277](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js#L277) diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes16Safe.md b/experimental/schemas/docs/ethereum/functions/parseBytes16Safe.md index 11554d8e0f..2f2d3de318 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes16Safe.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes16Safe.md @@ -8,8 +8,6 @@ > **parseBytes16Safe**\<`TBytes16`\>(`bytes16`): `Effect`\<`never`, [`InvalidBytesFixedError`](../classes/InvalidBytesFixedError.md), `TBytes16`\> -Safely parses a Bytes16 into an [Effect](https://www.effect.website/docs/essentials/effect-type). - ## Type Parameters • **TBytes16** diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes17.md b/experimental/schemas/docs/ethereum/functions/parseBytes17.md index c69bdb7e11..1cfcc1b543 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes17.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes17.md @@ -8,8 +8,6 @@ > **parseBytes17**\<`TBytes17`\>(`bytes17`): `TBytes17` -Parses a Bytes17 and returns the value if no errors. - ## Type Parameters • **TBytes17** *extends* \`0x$\{string\}\` @@ -22,13 +20,6 @@ Parses a Bytes17 and returns the value if no errors. `TBytes17` -## Example - -```ts -import { parseBytes17 } from '@tevm/schemas'; -const parsedBytes17 = parseBytes17('0xffaabbccddeeffaabbccddaaeeffaaeeffaa'); -``` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js:292](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js#L292) diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes17Safe.md b/experimental/schemas/docs/ethereum/functions/parseBytes17Safe.md index 8adc6344a4..22ede9937a 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes17Safe.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes17Safe.md @@ -8,8 +8,6 @@ > **parseBytes17Safe**\<`TBytes17`\>(`bytes17`): `Effect`\<`never`, [`InvalidBytesFixedError`](../classes/InvalidBytesFixedError.md), `TBytes17`\> -Safely parses a Bytes17 into an [Effect](https://www.effect.website/docs/essentials/effect-type). - ## Type Parameters • **TBytes17** diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes18.md b/experimental/schemas/docs/ethereum/functions/parseBytes18.md index b42c7af4fd..16f9b2c374 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes18.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes18.md @@ -8,8 +8,6 @@ > **parseBytes18**\<`TBytes18`\>(`bytes18`): `TBytes18` -Parses a Bytes18 and returns the value if no errors. - ## Type Parameters • **TBytes18** *extends* \`0x$\{string\}\` @@ -22,13 +20,6 @@ Parses a Bytes18 and returns the value if no errors. `TBytes18` -## Example - -```ts -import { parseBytes18 } from '@tevm/schemas'; -const parsedBytes18 = parseBytes18('0xffaabbccddeeffaabbccddaaeeffaaeeffbb'); -``` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js:307](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js#L307) diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes18Safe.md b/experimental/schemas/docs/ethereum/functions/parseBytes18Safe.md index a57121279d..a851809f29 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes18Safe.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes18Safe.md @@ -8,8 +8,6 @@ > **parseBytes18Safe**\<`TBytes18`\>(`bytes18`): `Effect`\<`never`, [`InvalidBytesFixedError`](../classes/InvalidBytesFixedError.md), `TBytes18`\> -Safely parses a Bytes18 into an [Effect](https://www.effect.website/docs/essentials/effect-type). - ## Type Parameters • **TBytes18** diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes19.md b/experimental/schemas/docs/ethereum/functions/parseBytes19.md index 07009c0347..b631d1fa62 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes19.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes19.md @@ -8,8 +8,6 @@ > **parseBytes19**\<`TBytes19`\>(`bytes19`): `TBytes19` -Parses a Bytes19 and returns the value if no errors. - ## Type Parameters • **TBytes19** *extends* \`0x$\{string\}\` @@ -22,13 +20,6 @@ Parses a Bytes19 and returns the value if no errors. `TBytes19` -## Example - -```ts -import { parseBytes19 } from '@tevm/schemas'; -const parsedBytes19 = parseBytes19('0xffaabbccddeeffaabbccddaaeeffaaeeffbbcc'); -``` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js:322](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js#L322) diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes19Safe.md b/experimental/schemas/docs/ethereum/functions/parseBytes19Safe.md index e96c4a3a94..3e28d8d9a1 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes19Safe.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes19Safe.md @@ -8,8 +8,6 @@ > **parseBytes19Safe**\<`TBytes19`\>(`bytes19`): `Effect`\<`never`, [`InvalidBytesFixedError`](../classes/InvalidBytesFixedError.md), `TBytes19`\> -Safely parses a Bytes19 into an [Effect](https://www.effect.website/docs/essentials/effect-type). - ## Type Parameters • **TBytes19** diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes1Safe.md b/experimental/schemas/docs/ethereum/functions/parseBytes1Safe.md index 5143a80361..0a5c0355f8 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes1Safe.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes1Safe.md @@ -8,8 +8,6 @@ > **parseBytes1Safe**\<`TBytes1`\>(`bytes1`): `Effect`\<`never`, [`InvalidBytesFixedError`](../classes/InvalidBytesFixedError.md), `TBytes1`\> -Safely parses a Bytes1 into an [Effect](https://www.effect.website/docs/essentials/effect-type). - ## Type Parameters • **TBytes1** diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes2.md b/experimental/schemas/docs/ethereum/functions/parseBytes2.md index 3522a5cdd3..625794f17a 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes2.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes2.md @@ -8,8 +8,6 @@ > **parseBytes2**\<`TBytes2`\>(`bytes2`): `TBytes2` -Parses a Bytes2 and returns the value if no errors. - ## Type Parameters • **TBytes2** *extends* \`0x$\{string\}\` @@ -22,13 +20,6 @@ Parses a Bytes2 and returns the value if no errors. `TBytes2` -## Example - -```ts -import { parseBytes2 } from '@tevm/schemas'; -const parsedBytes2 = parseBytes2('0xffaa'); -``` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js:69](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js#L69) diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes20.md b/experimental/schemas/docs/ethereum/functions/parseBytes20.md index 11c4c97aaa..ac7b6a7e69 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes20.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes20.md @@ -8,8 +8,6 @@ > **parseBytes20**\<`TBytes20`\>(`bytes20`): `TBytes20` -Parses a Bytes20 and returns the value if no errors. - ## Type Parameters • **TBytes20** *extends* \`0x$\{string\}\` @@ -22,13 +20,6 @@ Parses a Bytes20 and returns the value if no errors. `TBytes20` -## Example - -```ts -import { parseBytes20 } from '@tevm/schemas'; -const parsedBytes20 = parseBytes20('0xffaabbccddeeffaabbccddaaeeffaaeeffbbccdd'); -``` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js:337](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js#L337) diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes20Safe.md b/experimental/schemas/docs/ethereum/functions/parseBytes20Safe.md index c071737160..cfb1d54a35 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes20Safe.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes20Safe.md @@ -8,8 +8,6 @@ > **parseBytes20Safe**\<`TBytes20`\>(`bytes20`): `Effect`\<`never`, [`InvalidBytesFixedError`](../classes/InvalidBytesFixedError.md), `TBytes20`\> -Safely parses a Bytes20 into an [Effect](https://www.effect.website/docs/essentials/effect-type). - ## Type Parameters • **TBytes20** diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes21.md b/experimental/schemas/docs/ethereum/functions/parseBytes21.md index e0195ccc5b..556565f6fd 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes21.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes21.md @@ -8,8 +8,6 @@ > **parseBytes21**\<`TBytes21`\>(`bytes21`): `TBytes21` -Parses a Bytes21 and returns the value if no errors. - ## Type Parameters • **TBytes21** *extends* \`0x$\{string\}\` @@ -22,13 +20,6 @@ Parses a Bytes21 and returns the value if no errors. `TBytes21` -## Example - -```ts -import { parseBytes21 } from '@tevm/schemas'; -const parsedBytes21 = parseBytes21('0xffaabbccddeeffaabbccddaaeeffaaeeffbbccddaa'); -``` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js:352](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js#L352) diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes21Safe.md b/experimental/schemas/docs/ethereum/functions/parseBytes21Safe.md index 33cf71ea2b..dbed4ab226 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes21Safe.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes21Safe.md @@ -8,8 +8,6 @@ > **parseBytes21Safe**\<`TBytes21`\>(`bytes21`): `Effect`\<`never`, [`InvalidBytesFixedError`](../classes/InvalidBytesFixedError.md), `TBytes21`\> -Safely parses a Bytes21 into an [Effect](https://www.effect.website/docs/essentials/effect-type). - ## Type Parameters • **TBytes21** diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes22.md b/experimental/schemas/docs/ethereum/functions/parseBytes22.md index c939669f24..2977dd6572 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes22.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes22.md @@ -8,8 +8,6 @@ > **parseBytes22**\<`TBytes22`\>(`bytes22`): `TBytes22` -Parses a Bytes22 and returns the value if no errors. - ## Type Parameters • **TBytes22** *extends* \`0x$\{string\}\` @@ -22,13 +20,6 @@ Parses a Bytes22 and returns the value if no errors. `TBytes22` -## Example - -```ts -import { parseBytes22 } from '@tevm/schemas'; -const parsedBytes22 = parseBytes22('0xffaabbccddeeffaabbccddaaeeffaaeeffbbccddbb'); -``` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js:367](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js#L367) diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes22Safe.md b/experimental/schemas/docs/ethereum/functions/parseBytes22Safe.md index cf2454a7f0..0eaaa25e35 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes22Safe.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes22Safe.md @@ -8,8 +8,6 @@ > **parseBytes22Safe**\<`TBytes22`\>(`bytes22`): `Effect`\<`never`, [`InvalidBytesFixedError`](../classes/InvalidBytesFixedError.md), `TBytes22`\> -Safely parses a Bytes22 into an [Effect](https://www.effect.website/docs/essentials/effect-type). - ## Type Parameters • **TBytes22** diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes23.md b/experimental/schemas/docs/ethereum/functions/parseBytes23.md index 4e678bcc89..441c5a53bd 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes23.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes23.md @@ -8,8 +8,6 @@ > **parseBytes23**\<`TBytes23`\>(`bytes23`): `TBytes23` -Parses a Bytes23 and returns the value if no errors. - ## Type Parameters • **TBytes23** *extends* \`0x$\{string\}\` @@ -22,13 +20,6 @@ Parses a Bytes23 and returns the value if no errors. `TBytes23` -## Example - -```ts -import { parseBytes23 } from '@tevm/schemas'; -const parsedBytes23 = parseBytes23('0xffaabbccddeeffaabbccddaaeeffaaeeffbbccddcc'); -``` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js:382](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js#L382) diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes23Safe.md b/experimental/schemas/docs/ethereum/functions/parseBytes23Safe.md index 1765d424a9..977762699d 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes23Safe.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes23Safe.md @@ -8,8 +8,6 @@ > **parseBytes23Safe**\<`TBytes23`\>(`bytes23`): `Effect`\<`never`, [`InvalidBytesFixedError`](../classes/InvalidBytesFixedError.md), `TBytes23`\> -Safely parses a Bytes23 into an [Effect](https://www.effect.website/docs/essentials/effect-type). - ## Type Parameters • **TBytes23** diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes24.md b/experimental/schemas/docs/ethereum/functions/parseBytes24.md index 431b51947f..dfde9a5e66 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes24.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes24.md @@ -8,8 +8,6 @@ > **parseBytes24**\<`TBytes24`\>(`bytes24`): `TBytes24` -Parses a Bytes24 and returns the value if no errors. - ## Type Parameters • **TBytes24** *extends* \`0x$\{string\}\` @@ -22,13 +20,6 @@ Parses a Bytes24 and returns the value if no errors. `TBytes24` -## Example - -```ts -import { parseBytes24 } from '@tevm/schemas'; -const parsedBytes24 = parseBytes24('0xffaabbccddeeffaabbccddaaeeffaaeeffbbccddccbb'); -``` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js:397](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js#L397) diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes24Safe.md b/experimental/schemas/docs/ethereum/functions/parseBytes24Safe.md index 9681f64de1..e72fa1e7ec 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes24Safe.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes24Safe.md @@ -8,8 +8,6 @@ > **parseBytes24Safe**\<`TBytes24`\>(`bytes24`): `Effect`\<`never`, [`InvalidBytesFixedError`](../classes/InvalidBytesFixedError.md), `TBytes24`\> -Safely parses a Bytes24 into an [Effect](https://www.effect.website/docs/essentials/effect-type). - ## Type Parameters • **TBytes24** diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes25.md b/experimental/schemas/docs/ethereum/functions/parseBytes25.md index 7f122ab546..5e36aef556 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes25.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes25.md @@ -8,8 +8,6 @@ > **parseBytes25**\<`TBytes25`\>(`bytes25`): `TBytes25` -Parses a Bytes25 and returns the value if no errors. - ## Type Parameters • **TBytes25** *extends* \`0x$\{string\}\` @@ -22,13 +20,6 @@ Parses a Bytes25 and returns the value if no errors. `TBytes25` -## Example - -```ts -import { parseBytes25 } from '@tevm/schemas'; -const parsedBytes25 = parseBytes25('0xffaabbccddeeffaabbccddaaeeffaaeeffbbccddccbbdd'); -``` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js:412](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js#L412) diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes25Safe.md b/experimental/schemas/docs/ethereum/functions/parseBytes25Safe.md index 419facc318..8d89d9d61a 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes25Safe.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes25Safe.md @@ -8,8 +8,6 @@ > **parseBytes25Safe**\<`TBytes25`\>(`bytes25`): `Effect`\<`never`, [`InvalidBytesFixedError`](../classes/InvalidBytesFixedError.md), `TBytes25`\> -Safely parses a Bytes25 into an [Effect](https://www.effect.website/docs/essentials/effect-type). - ## Type Parameters • **TBytes25** diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes26.md b/experimental/schemas/docs/ethereum/functions/parseBytes26.md index 9f8fca7435..886c071c3b 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes26.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes26.md @@ -8,8 +8,6 @@ > **parseBytes26**\<`TBytes26`\>(`bytes26`): `TBytes26` -Parses a Bytes26 and returns the value if no errors. - ## Type Parameters • **TBytes26** *extends* \`0x$\{string\}\` @@ -22,13 +20,6 @@ Parses a Bytes26 and returns the value if no errors. `TBytes26` -## Example - -```ts -import { parseBytes26 } from '@tevm/schemas'; -const parsedBytes26 = parseBytes26('0xffaabbccddeeffaabbccddaaeeffaaeeffbbccddccbbddaa'); -``` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js:427](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js#L427) diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes26Safe.md b/experimental/schemas/docs/ethereum/functions/parseBytes26Safe.md index 64ec534480..6a90db7d5b 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes26Safe.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes26Safe.md @@ -8,8 +8,6 @@ > **parseBytes26Safe**\<`TBytes26`\>(`bytes26`): `Effect`\<`never`, [`InvalidBytesFixedError`](../classes/InvalidBytesFixedError.md), `TBytes26`\> -Safely parses a Bytes26 into an [Effect](https://www.effect.website/docs/essentials/effect-type). - ## Type Parameters • **TBytes26** diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes27.md b/experimental/schemas/docs/ethereum/functions/parseBytes27.md index 09b287b307..6ed9d8e46c 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes27.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes27.md @@ -8,8 +8,6 @@ > **parseBytes27**\<`TBytes27`\>(`bytes27`): `TBytes27` -Parses a Bytes27 and returns the value if no errors. - ## Type Parameters • **TBytes27** *extends* \`0x$\{string\}\` @@ -22,13 +20,6 @@ Parses a Bytes27 and returns the value if no errors. `TBytes27` -## Example - -```ts -import { parseBytes27 } from '@tevm/schemas'; -const parsedBytes27 = parseBytes27('0xffaabbccddeeffaabbccddaaeeffaaeeffbbccddccbbddbb'); -``` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js:442](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js#L442) diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes27Safe.md b/experimental/schemas/docs/ethereum/functions/parseBytes27Safe.md index ed46a4b59c..1935334da1 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes27Safe.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes27Safe.md @@ -8,8 +8,6 @@ > **parseBytes27Safe**\<`TBytes27`\>(`bytes27`): `Effect`\<`never`, [`InvalidBytesFixedError`](../classes/InvalidBytesFixedError.md), `TBytes27`\> -Safely parses a Bytes27 into an [Effect](https://www.effect.website/docs/essentials/effect-type). - ## Type Parameters • **TBytes27** diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes28.md b/experimental/schemas/docs/ethereum/functions/parseBytes28.md index 21ffb1d459..e9b1799b01 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes28.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes28.md @@ -8,8 +8,6 @@ > **parseBytes28**\<`TBytes28`\>(`bytes28`): `TBytes28` -Parses a Bytes28 and returns the value if no errors. - ## Type Parameters • **TBytes28** *extends* \`0x$\{string\}\` @@ -22,13 +20,6 @@ Parses a Bytes28 and returns the value if no errors. `TBytes28` -## Example - -```ts -import { parseBytes28 } from '@tevm/schemas'; -const parsedBytes28 = parseBytes28('0xffaabbccddeeffaabbccddaaeeffaaeeffbbccddccbbddbbcc'); -``` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js:456](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js#L456) diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes28Safe.md b/experimental/schemas/docs/ethereum/functions/parseBytes28Safe.md index a7f622ea47..05595be9b1 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes28Safe.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes28Safe.md @@ -8,8 +8,6 @@ > **parseBytes28Safe**\<`TBytes28`\>(`bytes28`): `Effect`\<`never`, [`InvalidBytesFixedError`](../classes/InvalidBytesFixedError.md), `TBytes28`\> -Safely parses a Bytes28 into an [Effect](https://www.effect.website/docs/essentials/effect-type). - ## Type Parameters • **TBytes28** diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes29.md b/experimental/schemas/docs/ethereum/functions/parseBytes29.md index e668ce0662..f10887d0fe 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes29.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes29.md @@ -8,8 +8,6 @@ > **parseBytes29**\<`TBytes29`\>(`bytes29`): `TBytes29` -Parses a Bytes29 and returns the value if no errors. - ## Type Parameters • **TBytes29** *extends* \`0x$\{string\}\` @@ -22,13 +20,6 @@ Parses a Bytes29 and returns the value if no errors. `TBytes29` -## Example - -```ts -import { parseBytes29 } from '@tevm/schemas'; -const parsedBytes29 = parseBytes29('0xffaabbccddeeffaabbccddaaeeffaaeeffbbccddccbbddbbccaa'); -``` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js:471](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js#L471) diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes29Safe.md b/experimental/schemas/docs/ethereum/functions/parseBytes29Safe.md index cdb3975f04..915a26bcd4 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes29Safe.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes29Safe.md @@ -8,8 +8,6 @@ > **parseBytes29Safe**\<`TBytes29`\>(`bytes29`): `Effect`\<`never`, [`InvalidBytesFixedError`](../classes/InvalidBytesFixedError.md), `TBytes29`\> -Safely parses a Bytes29 into an [Effect](https://www.effect.website/docs/essentials/effect-type). - ## Type Parameters • **TBytes29** diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes2Safe.md b/experimental/schemas/docs/ethereum/functions/parseBytes2Safe.md index 2d6151b10f..75835b7114 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes2Safe.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes2Safe.md @@ -8,8 +8,6 @@ > **parseBytes2Safe**\<`TBytes2`\>(`bytes2`): `Effect`\<`never`, [`InvalidBytesFixedError`](../classes/InvalidBytesFixedError.md), `TBytes2`\> -Safely parses a Bytes2 into an [Effect](https://www.effect.website/docs/essentials/effect-type). - ## Type Parameters • **TBytes2** diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes3.md b/experimental/schemas/docs/ethereum/functions/parseBytes3.md index defc8f5fe4..f4ffcbb1c8 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes3.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes3.md @@ -8,8 +8,6 @@ > **parseBytes3**\<`TBytes3`\>(`bytes3`): `TBytes3` -Parses a Bytes3 and returns the value if no errors. - ## Type Parameters • **TBytes3** *extends* \`0x$\{string\}\` @@ -22,13 +20,6 @@ Parses a Bytes3 and returns the value if no errors. `TBytes3` -## Example - -```ts -import { parseBytes3 } from '@tevm/schemas'; -const parsedBytes3 = parseBytes3('0xffaabb'); -``` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js:84](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js#L84) diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes30.md b/experimental/schemas/docs/ethereum/functions/parseBytes30.md index 618a75f7d1..2c01bc3911 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes30.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes30.md @@ -8,8 +8,6 @@ > **parseBytes30**\<`TBytes30`\>(`bytes30`): `TBytes30` -Parses a Bytes30 and returns the value if no errors. - ## Type Parameters • **TBytes30** *extends* \`0x$\{string\}\` @@ -22,13 +20,6 @@ Parses a Bytes30 and returns the value if no errors. `TBytes30` -## Example - -```ts -import { parseBytes30 } from '@tevm/schemas'; -const parsedBytes30 = parseBytes30('0xffaabbccddeeffaabbccddaaeeffaaeeffbbccddccbbddbbccaaaa'); -``` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js:486](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js#L486) diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes30Safe.md b/experimental/schemas/docs/ethereum/functions/parseBytes30Safe.md index 91891fe988..6e9889a079 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes30Safe.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes30Safe.md @@ -8,8 +8,6 @@ > **parseBytes30Safe**\<`TBytes30`\>(`bytes30`): `Effect`\<`never`, [`InvalidBytesFixedError`](../classes/InvalidBytesFixedError.md), `TBytes30`\> -Safely parses a Bytes30 into an [Effect](https://www.effect.website/docs/essentials/effect-type). - ## Type Parameters • **TBytes30** diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes31.md b/experimental/schemas/docs/ethereum/functions/parseBytes31.md index e45799962a..eaf688c0e6 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes31.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes31.md @@ -8,8 +8,6 @@ > **parseBytes31**\<`TBytes31`\>(`bytes31`): `TBytes31` -Parses a Bytes31 and returns the value if no errors. - ## Type Parameters • **TBytes31** *extends* \`0x$\{string\}\` @@ -22,13 +20,6 @@ Parses a Bytes31 and returns the value if no errors. `TBytes31` -## Example - -```ts -import { parseBytes31 } from '@tevm/schemas'; -const parsedBytes31 = parseBytes31('0xffaabbccddeeffaabbccddaaeeffaaeeffbbccddccbbddbbccaaaaaa'); -``` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js:501](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js#L501) diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes31Safe.md b/experimental/schemas/docs/ethereum/functions/parseBytes31Safe.md index 24d5aa6c72..8520b9b724 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes31Safe.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes31Safe.md @@ -8,8 +8,6 @@ > **parseBytes31Safe**\<`TBytes31`\>(`bytes31`): `Effect`\<`never`, [`InvalidBytesFixedError`](../classes/InvalidBytesFixedError.md), `TBytes31`\> -Safely parses a Bytes31 into an [Effect](https://www.effect.website/docs/essentials/effect-type). - ## Type Parameters • **TBytes31** diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes32.md b/experimental/schemas/docs/ethereum/functions/parseBytes32.md index dddfd12134..1565d8ef84 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes32.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes32.md @@ -8,8 +8,6 @@ > **parseBytes32**\<`TBytes32`\>(`bytes32`): `TBytes32` -Parses a Bytes32 and returns the value if no errors. - ## Type Parameters • **TBytes32** *extends* \`0x$\{string\}\` @@ -22,13 +20,6 @@ Parses a Bytes32 and returns the value if no errors. `TBytes32` -## Example - -```ts -import { parseBytes32 } from '@tevm/schemas'; -const parsedBytes32 = parseBytes32('0xffaabbccddeeffaabbccddaaeeffaaeeffbbccddccbbddbbccaaaaaabb'); -``` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js:516](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js#L516) diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes32Safe.md b/experimental/schemas/docs/ethereum/functions/parseBytes32Safe.md index 0ed006c36e..3d39e9871d 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes32Safe.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes32Safe.md @@ -8,8 +8,6 @@ > **parseBytes32Safe**\<`TBytes32`\>(`bytes32`): `Effect`\<`never`, [`InvalidBytesFixedError`](../classes/InvalidBytesFixedError.md), `TBytes32`\> -Safely parses a Bytes32 into an [Effect](https://www.effect.website/docs/essentials/effect-type). - ## Type Parameters • **TBytes32** diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes3Safe.md b/experimental/schemas/docs/ethereum/functions/parseBytes3Safe.md index 2d23df4d4d..4fbff3e539 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes3Safe.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes3Safe.md @@ -8,8 +8,6 @@ > **parseBytes3Safe**\<`TBytes3`\>(`bytes3`): `Effect`\<`never`, [`InvalidBytesFixedError`](../classes/InvalidBytesFixedError.md), `TBytes3`\> -Safely parses a Bytes3 into an [Effect](https://www.effect.website/docs/essentials/effect-type). - ## Type Parameters • **TBytes3** diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes4.md b/experimental/schemas/docs/ethereum/functions/parseBytes4.md index a4383e851e..ca4845857d 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes4.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes4.md @@ -8,8 +8,6 @@ > **parseBytes4**\<`TBytes4`\>(`bytes4`): `TBytes4` -Parses a Bytes4 and returns the value if no errors. - ## Type Parameters • **TBytes4** *extends* \`0x$\{string\}\` @@ -22,13 +20,6 @@ Parses a Bytes4 and returns the value if no errors. `TBytes4` -## Example - -```ts -import { parseBytes4 } from '@tevm/schemas'; -const parsedBytes4 = parseBytes4('0xffaabbcc'); -``` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js:99](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js#L99) diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes4Safe.md b/experimental/schemas/docs/ethereum/functions/parseBytes4Safe.md index ab8d4bc25e..30e0dcceee 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes4Safe.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes4Safe.md @@ -8,8 +8,6 @@ > **parseBytes4Safe**\<`TBytes4`\>(`bytes4`): `Effect`\<`never`, [`InvalidBytesFixedError`](../classes/InvalidBytesFixedError.md), `TBytes4`\> -Safely parses a Bytes4 into an [Effect](https://www.effect.website/docs/essentials/effect-type). - ## Type Parameters • **TBytes4** diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes5.md b/experimental/schemas/docs/ethereum/functions/parseBytes5.md index d551a0b1af..93f6671769 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes5.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes5.md @@ -8,8 +8,6 @@ > **parseBytes5**\<`TBytes5`\>(`bytes5`): `TBytes5` -Parses a Bytes5 and returns the value if no errors. - ## Type Parameters • **TBytes5** *extends* \`0x$\{string\}\` @@ -22,13 +20,6 @@ Parses a Bytes5 and returns the value if no errors. `TBytes5` -## Example - -```ts -import { parseBytes5 } from '@tevm/schemas'; -const parsedBytes5 = parseBytes5('0xffaabbccdd'); -``` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js:114](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js#L114) diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes5Safe.md b/experimental/schemas/docs/ethereum/functions/parseBytes5Safe.md index 85a479cefb..441136ac1b 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes5Safe.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes5Safe.md @@ -8,8 +8,6 @@ > **parseBytes5Safe**\<`TBytes5`\>(`bytes5`): `Effect`\<`never`, [`InvalidBytesFixedError`](../classes/InvalidBytesFixedError.md), `TBytes5`\> -Safely parses a Bytes5 into an [Effect](https://www.effect.website/docs/essentials/effect-type). - ## Type Parameters • **TBytes5** diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes6.md b/experimental/schemas/docs/ethereum/functions/parseBytes6.md index 83cce3cfde..25344be72f 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes6.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes6.md @@ -8,8 +8,6 @@ > **parseBytes6**\<`TBytes6`\>(`bytes6`): `TBytes6` -Parses a Bytes6 and returns the value if no errors. - ## Type Parameters • **TBytes6** *extends* \`0x$\{string\}\` @@ -22,13 +20,6 @@ Parses a Bytes6 and returns the value if no errors. `TBytes6` -## Example - -```ts -import { parseBytes6 } from '@tevm/schemas'; -const parsedBytes6 = parseBytes6('0xffaabbccddeeff'); -``` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js:128](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js#L128) diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes6Safe.md b/experimental/schemas/docs/ethereum/functions/parseBytes6Safe.md index beb91295cf..ebd8beabe2 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes6Safe.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes6Safe.md @@ -8,8 +8,6 @@ > **parseBytes6Safe**\<`TBytes6`\>(`bytes6`): `Effect`\<`never`, [`InvalidBytesFixedError`](../classes/InvalidBytesFixedError.md), `TBytes6`\> -Safely parses a Bytes6 into an [Effect](https://www.effect.website/docs/essentials/effect-type). - ## Type Parameters • **TBytes6** diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes7.md b/experimental/schemas/docs/ethereum/functions/parseBytes7.md index 8186e9b516..1d33f443da 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes7.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes7.md @@ -8,8 +8,6 @@ > **parseBytes7**\<`TBytes7`\>(`bytes7`): `TBytes7` -Parses a Bytes7 and returns the value if no errors. - ## Type Parameters • **TBytes7** *extends* \`0x$\{string\}\` @@ -22,13 +20,6 @@ Parses a Bytes7 and returns the value if no errors. `TBytes7` -## Example - -```ts -import { parseBytes7 } from '@tevm/schemas'; -const parsedBytes7 = parseBytes7('0xffaabbccddeeffaa'); -``` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js:143](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js#L143) diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes7Safe.md b/experimental/schemas/docs/ethereum/functions/parseBytes7Safe.md index b86fec99a7..5dc3e92b17 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes7Safe.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes7Safe.md @@ -8,8 +8,6 @@ > **parseBytes7Safe**\<`TBytes7`\>(`bytes7`): `Effect`\<`never`, [`InvalidBytesFixedError`](../classes/InvalidBytesFixedError.md), `TBytes7`\> -Safely parses a Bytes7 into an [Effect](https://www.effect.website/docs/essentials/effect-type). - ## Type Parameters • **TBytes7** diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes8.md b/experimental/schemas/docs/ethereum/functions/parseBytes8.md index 67694478cf..ed1ca6c7a4 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes8.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes8.md @@ -8,8 +8,6 @@ > **parseBytes8**\<`TBytes8`\>(`bytes8`): `TBytes8` -Parses a Bytes8 and returns the value if no errors. - ## Type Parameters • **TBytes8** *extends* \`0x$\{string\}\` @@ -22,13 +20,6 @@ Parses a Bytes8 and returns the value if no errors. `TBytes8` -## Example - -```ts -import { parseBytes8 } from '@tevm/schemas'; -const parsedBytes8 = parseBytes8('0xffaabbccddeeffaabb'); -``` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js:158](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js#L158) diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes8Safe.md b/experimental/schemas/docs/ethereum/functions/parseBytes8Safe.md index 7850407935..616ad26cdc 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes8Safe.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes8Safe.md @@ -8,8 +8,6 @@ > **parseBytes8Safe**\<`TBytes8`\>(`bytes8`): `Effect`\<`never`, [`InvalidBytesFixedError`](../classes/InvalidBytesFixedError.md), `TBytes8`\> -Safely parses a Bytes8 into an [Effect](https://www.effect.website/docs/essentials/effect-type). - ## Type Parameters • **TBytes8** diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes9.md b/experimental/schemas/docs/ethereum/functions/parseBytes9.md index 36bfccb8ec..6d0e0997d3 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes9.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes9.md @@ -8,8 +8,6 @@ > **parseBytes9**\<`TBytes9`\>(`bytes9`): `TBytes9` -Parses a Bytes9 and returns the value if no errors. - ## Type Parameters • **TBytes9** *extends* \`0x$\{string\}\` @@ -22,13 +20,6 @@ Parses a Bytes9 and returns the value if no errors. `TBytes9` -## Example - -```ts -import { parseBytes9 } from '@tevm/schemas'; -const parsedBytes9 = parseBytes9('0xffaabbccddeeffaabbcc'); -``` - ## Defined in [experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js:173](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytesFixed/parseBytesFixed.js#L173) diff --git a/experimental/schemas/docs/ethereum/functions/parseBytes9Safe.md b/experimental/schemas/docs/ethereum/functions/parseBytes9Safe.md index 38c55170b9..0d54279345 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytes9Safe.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytes9Safe.md @@ -8,8 +8,6 @@ > **parseBytes9Safe**\<`TBytes9`\>(`bytes9`): `Effect`\<`never`, [`InvalidBytesFixedError`](../classes/InvalidBytesFixedError.md), `TBytes9`\> -Safely parses a Bytes9 into an [Effect](https://www.effect.website/docs/essentials/effect-type). - ## Type Parameters • **TBytes9** diff --git a/experimental/schemas/docs/ethereum/functions/parseBytesSafe.md b/experimental/schemas/docs/ethereum/functions/parseBytesSafe.md index 6188cbb32f..8b619d9871 100644 --- a/experimental/schemas/docs/ethereum/functions/parseBytesSafe.md +++ b/experimental/schemas/docs/ethereum/functions/parseBytesSafe.md @@ -8,8 +8,6 @@ > **parseBytesSafe**\<`TBytes`\>(`value`): `Effect`\<`never`, [`InvalidBytesError`](../classes/InvalidBytesError.md), `TBytes`\> -Safely parses a Bytes into an [Effect](https://www.effect.website/docs/essentials/effect-type). - ## Type Parameters • **TBytes** *extends* \`0x$\{string\}\` @@ -22,13 +20,6 @@ Safely parses a Bytes into an [Effect](https://www.effect.website/docs/essential `Effect`\<`never`, [`InvalidBytesError`](../classes/InvalidBytesError.md), `TBytes`\> -## Example - -```javascript -import { parseBytesSafe } from '@tevm/schemas'; -const parsedBytesEffect = parseBytesSafe('0x1234567890abcdef1234567890abcdef12345678'); -``` - ## Defined in [experimental/schemas/src/ethereum/SBytes/parseBytesSafe.js:23](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SBytes/parseBytesSafe.js#L23) diff --git a/experimental/schemas/docs/ethereum/functions/parseINT128Safe.md b/experimental/schemas/docs/ethereum/functions/parseINT128Safe.md index 2b0a2eea8b..3058553e29 100644 --- a/experimental/schemas/docs/ethereum/functions/parseINT128Safe.md +++ b/experimental/schemas/docs/ethereum/functions/parseINT128Safe.md @@ -8,8 +8,6 @@ > **parseINT128Safe**\<`TINT128`\>(`int128`): `Effect`\<`never`, [`InvalidINTError`](../classes/InvalidINTError.md), `TINT128`\> -Safely parses an INT128 into an [Effect](https://www.effect.website/docs/essentials/effect-type). - ## Type Parameters • **TINT128** diff --git a/experimental/schemas/docs/ethereum/functions/parseINT16Safe.md b/experimental/schemas/docs/ethereum/functions/parseINT16Safe.md index 2f4c00b8e1..50b499c2f6 100644 --- a/experimental/schemas/docs/ethereum/functions/parseINT16Safe.md +++ b/experimental/schemas/docs/ethereum/functions/parseINT16Safe.md @@ -8,8 +8,6 @@ > **parseINT16Safe**\<`TINT16`\>(`int16`): `Effect`\<`never`, [`InvalidINTError`](../classes/InvalidINTError.md), `TINT16`\> -Safely parses an INT16 into an [Effect](https://www.effect.website/docs/essentials/effect-type). - ## Type Parameters • **TINT16** diff --git a/experimental/schemas/docs/ethereum/functions/parseINT256Safe.md b/experimental/schemas/docs/ethereum/functions/parseINT256Safe.md index 6f75ec6304..3c484dc0ae 100644 --- a/experimental/schemas/docs/ethereum/functions/parseINT256Safe.md +++ b/experimental/schemas/docs/ethereum/functions/parseINT256Safe.md @@ -8,8 +8,6 @@ > **parseINT256Safe**\<`TINT256`\>(`int256`): `Effect`\<`never`, [`InvalidINTError`](../classes/InvalidINTError.md), `TINT256`\> -Safely parses an INT256 into an [Effect](https://www.effect.website/docs/essentials/effect-type). - ## Type Parameters • **TINT256** diff --git a/experimental/schemas/docs/ethereum/functions/parseINT32Safe.md b/experimental/schemas/docs/ethereum/functions/parseINT32Safe.md index 75c628b076..8e11a00775 100644 --- a/experimental/schemas/docs/ethereum/functions/parseINT32Safe.md +++ b/experimental/schemas/docs/ethereum/functions/parseINT32Safe.md @@ -8,8 +8,6 @@ > **parseINT32Safe**\<`TINT32`\>(`int32`): `Effect`\<`never`, [`InvalidINTError`](../classes/InvalidINTError.md), `TINT32`\> -Safely parses an INT32 into an [Effect](https://www.effect.website/docs/essentials/effect-type). - ## Type Parameters • **TINT32** diff --git a/experimental/schemas/docs/ethereum/functions/parseINT64Safe.md b/experimental/schemas/docs/ethereum/functions/parseINT64Safe.md index ef78b66b4d..a4a56c3f72 100644 --- a/experimental/schemas/docs/ethereum/functions/parseINT64Safe.md +++ b/experimental/schemas/docs/ethereum/functions/parseINT64Safe.md @@ -8,8 +8,6 @@ > **parseINT64Safe**\<`TINT64`\>(`int64`): `Effect`\<`never`, [`InvalidINTError`](../classes/InvalidINTError.md), `TINT64`\> -Safely parses an INT64 into an [Effect](https://www.effect.website/docs/essentials/effect-type). - ## Type Parameters • **TINT64** diff --git a/experimental/schemas/docs/ethereum/functions/parseINT8Safe.md b/experimental/schemas/docs/ethereum/functions/parseINT8Safe.md index 2d42b5f530..3913d325a3 100644 --- a/experimental/schemas/docs/ethereum/functions/parseINT8Safe.md +++ b/experimental/schemas/docs/ethereum/functions/parseINT8Safe.md @@ -8,8 +8,6 @@ > **parseINT8Safe**\<`TINT8`\>(`int8`): `Effect`\<`never`, [`InvalidINTError`](../classes/InvalidINTError.md), `TINT8`\> -Safely parses an INT8 into an [Effect](https://www.effect.website/docs/essentials/effect-type). - ## Type Parameters • **TINT8** diff --git a/experimental/schemas/docs/ethereum/functions/parseInt128.md b/experimental/schemas/docs/ethereum/functions/parseInt128.md index 3b41d094d7..27b3f18772 100644 --- a/experimental/schemas/docs/ethereum/functions/parseInt128.md +++ b/experimental/schemas/docs/ethereum/functions/parseInt128.md @@ -8,8 +8,6 @@ > **parseInt128**\<`TINT128`\>(`int128`): `TINT128` -Parses an INT128 and returns the value if no errors. - ## Type Parameters • **TINT128** *extends* `bigint` @@ -22,13 +20,6 @@ Parses an INT128 and returns the value if no errors. `TINT128` -## Example - -```ts -import { parseInt128 } from '@tevm/schemas'; -const parsedINT128 = parseInt128(BigInt("-170141183460469231731687303715884105728")); -``` - ## Defined in [experimental/schemas/src/ethereum/SINT/parseINT.js:88](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SINT/parseINT.js#L88) diff --git a/experimental/schemas/docs/ethereum/functions/parseInt16.md b/experimental/schemas/docs/ethereum/functions/parseInt16.md index 5828d30483..3febb793d4 100644 --- a/experimental/schemas/docs/ethereum/functions/parseInt16.md +++ b/experimental/schemas/docs/ethereum/functions/parseInt16.md @@ -8,8 +8,6 @@ > **parseInt16**\<`TINT16`\>(`int16`): `TINT16` -Parses an INT16 and returns the value if no errors. - ## Type Parameters • **TINT16** *extends* `bigint` @@ -22,13 +20,6 @@ Parses an INT16 and returns the value if no errors. `TINT16` -## Example - -```ts -import { parseInt16 } from '@tevm/schemas'; -const parsedINT16 = parseInt16(BigInt(-32768)); -``` - ## Defined in [experimental/schemas/src/ethereum/SINT/parseINT.js:43](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SINT/parseINT.js#L43) diff --git a/experimental/schemas/docs/ethereum/functions/parseInt256.md b/experimental/schemas/docs/ethereum/functions/parseInt256.md index 398b088db5..74a8f8de23 100644 --- a/experimental/schemas/docs/ethereum/functions/parseInt256.md +++ b/experimental/schemas/docs/ethereum/functions/parseInt256.md @@ -8,8 +8,6 @@ > **parseInt256**\<`TINT256`\>(`int256`): `TINT256` -Parses an INT256 and returns the value if no errors. - ## Type Parameters • **TINT256** *extends* `bigint` @@ -22,13 +20,6 @@ Parses an INT256 and returns the value if no errors. `TINT256` -## Example - -```ts -import { parseInt256 } from '@tevm/schemas'; -const parsedINT256 = parseInt256(420n); -``` - ## Defined in [experimental/schemas/src/ethereum/SINT/parseINT.js:103](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SINT/parseINT.js#L103) diff --git a/experimental/schemas/docs/ethereum/functions/parseInt32.md b/experimental/schemas/docs/ethereum/functions/parseInt32.md index 1063d0c6cc..723ef5500c 100644 --- a/experimental/schemas/docs/ethereum/functions/parseInt32.md +++ b/experimental/schemas/docs/ethereum/functions/parseInt32.md @@ -8,8 +8,6 @@ > **parseInt32**\<`TINT32`\>(`int32`): `TINT32` -Parses an INT32 and returns the value if no errors. - ## Type Parameters • **TINT32** *extends* `bigint` @@ -22,13 +20,6 @@ Parses an INT32 and returns the value if no errors. `TINT32` -## Example - -```ts -import { parseInt32 } from '@tevm/schemas'; -const parsedINT32 = parseInt32(BigInt(-2147483648)); -``` - ## Defined in [experimental/schemas/src/ethereum/SINT/parseINT.js:58](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SINT/parseINT.js#L58) diff --git a/experimental/schemas/docs/ethereum/functions/parseInt64.md b/experimental/schemas/docs/ethereum/functions/parseInt64.md index ff34661c37..c156b753a0 100644 --- a/experimental/schemas/docs/ethereum/functions/parseInt64.md +++ b/experimental/schemas/docs/ethereum/functions/parseInt64.md @@ -8,8 +8,6 @@ > **parseInt64**\<`TINT64`\>(`int64`): `TINT64` -Parses an INT64 and returns the value if no errors. - ## Type Parameters • **TINT64** *extends* `bigint` @@ -22,13 +20,6 @@ Parses an INT64 and returns the value if no errors. `TINT64` -## Example - -```ts -import { parseInt64 } from '@tevm/schemas'; -const parsedINT64 = parseInt64(BigInt("-9223372036854775808")); -``` - ## Defined in [experimental/schemas/src/ethereum/SINT/parseINT.js:73](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SINT/parseINT.js#L73) diff --git a/experimental/schemas/docs/ethereum/functions/parseInt8.md b/experimental/schemas/docs/ethereum/functions/parseInt8.md index e0f5cc75de..09e916ba5d 100644 --- a/experimental/schemas/docs/ethereum/functions/parseInt8.md +++ b/experimental/schemas/docs/ethereum/functions/parseInt8.md @@ -8,8 +8,6 @@ > **parseInt8**\<`TINT8`\>(`int8`): `TINT8` -Parses an INT8 and returns the value if no errors. - ## Type Parameters • **TINT8** *extends* `bigint` @@ -24,13 +22,6 @@ extends INT8 `TINT8` -## Example - -```ts -import { parseInt8 } from '@tevm/schemas'; -const parsedINT8 = parseInt8(BigInt(-128)); -``` - ## Defined in [experimental/schemas/src/ethereum/SINT/parseINT.js:28](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SINT/parseINT.js#L28) diff --git a/experimental/schemas/docs/ethereum/functions/parseUINT128.md b/experimental/schemas/docs/ethereum/functions/parseUINT128.md index 60046b1fa5..925e135a05 100644 --- a/experimental/schemas/docs/ethereum/functions/parseUINT128.md +++ b/experimental/schemas/docs/ethereum/functions/parseUINT128.md @@ -8,8 +8,6 @@ > **parseUINT128**\<`TUINT128`\>(`uint128`): `TUINT128` -Parses a UINT128 and returns the value if no errors. - ## Type Parameters • **TUINT128** *extends* `bigint` @@ -22,13 +20,6 @@ Parses a UINT128 and returns the value if no errors. `TUINT128` -## Example - -```ts -import { parseUINT128 } from '@tevm/schemas'; -const parsedUINT128 = parseUINT128(BigInt("170141183460469231731687303715884105727")); -``` - ## Defined in [experimental/schemas/src/ethereum/SUINT/parseUINT.js:84](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SUINT/parseUINT.js#L84) diff --git a/experimental/schemas/docs/ethereum/functions/parseUINT128Safe.md b/experimental/schemas/docs/ethereum/functions/parseUINT128Safe.md index 11151279fb..0ec5818db3 100644 --- a/experimental/schemas/docs/ethereum/functions/parseUINT128Safe.md +++ b/experimental/schemas/docs/ethereum/functions/parseUINT128Safe.md @@ -8,8 +8,6 @@ > **parseUINT128Safe**\<`TUINT128`\>(`uint128`): `Effect`\<`never`, [`InvalidUINTError`](../classes/InvalidUINTError.md), `TUINT128`\> -Safely parses a UINT128 into an [Effect](https://www.effect.website/docs/essentials/effect-type). - ## Type Parameters • **TUINT128** *extends* `bigint` diff --git a/experimental/schemas/docs/ethereum/functions/parseUINT16.md b/experimental/schemas/docs/ethereum/functions/parseUINT16.md index 96bc2401c8..8d1fb54752 100644 --- a/experimental/schemas/docs/ethereum/functions/parseUINT16.md +++ b/experimental/schemas/docs/ethereum/functions/parseUINT16.md @@ -8,8 +8,6 @@ > **parseUINT16**\<`TUINT16`\>(`uint16`): `TUINT16` -Parses a UINT16 and returns the value if no errors. - ## Type Parameters • **TUINT16** *extends* `bigint` @@ -22,13 +20,6 @@ Parses a UINT16 and returns the value if no errors. `TUINT16` -## Example - -```ts -import { parseUINT16 } from '@tevm/schemas'; -const parsedUINT16 = parseUINT16(BigInt(32767)); -``` - ## Defined in [experimental/schemas/src/ethereum/SUINT/parseUINT.js:42](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SUINT/parseUINT.js#L42) diff --git a/experimental/schemas/docs/ethereum/functions/parseUINT16Safe.md b/experimental/schemas/docs/ethereum/functions/parseUINT16Safe.md index c20d4167ee..aad88aa1be 100644 --- a/experimental/schemas/docs/ethereum/functions/parseUINT16Safe.md +++ b/experimental/schemas/docs/ethereum/functions/parseUINT16Safe.md @@ -8,8 +8,6 @@ > **parseUINT16Safe**\<`TUINT16`\>(`uint16`): `Effect`\<`never`, [`InvalidUINTError`](../classes/InvalidUINTError.md), `TUINT16`\> -Safely parses a UINT16 into an [Effect](https://www.effect.website/docs/essentials/effect-type). - ## Type Parameters • **TUINT16** *extends* `bigint` diff --git a/experimental/schemas/docs/ethereum/functions/parseUINT256.md b/experimental/schemas/docs/ethereum/functions/parseUINT256.md index e1ef85c38d..81b7e82179 100644 --- a/experimental/schemas/docs/ethereum/functions/parseUINT256.md +++ b/experimental/schemas/docs/ethereum/functions/parseUINT256.md @@ -8,8 +8,6 @@ > **parseUINT256**\<`TUINT256`\>(`uint256`): `TUINT256` -Parses a UINT256 and returns the value if no errors. - ## Type Parameters • **TUINT256** *extends* `bigint` @@ -22,13 +20,6 @@ Parses a UINT256 and returns the value if no errors. `TUINT256` -## Example - -```ts -import { parseUINT256 } from '@tevm/schemas'; -const parsedUINT256 = parseUINT256('0x1234567890abcdef1234567890abcdef12345678'); -``` - ## Defined in [experimental/schemas/src/ethereum/SUINT/parseUINT.js:98](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SUINT/parseUINT.js#L98) diff --git a/experimental/schemas/docs/ethereum/functions/parseUINT256Safe.md b/experimental/schemas/docs/ethereum/functions/parseUINT256Safe.md index 9827cadb71..cc8a8c1e14 100644 --- a/experimental/schemas/docs/ethereum/functions/parseUINT256Safe.md +++ b/experimental/schemas/docs/ethereum/functions/parseUINT256Safe.md @@ -8,8 +8,6 @@ > **parseUINT256Safe**\<`TUINT256`\>(`uint256`): `Effect`\<`never`, [`InvalidUINTError`](../classes/InvalidUINTError.md), `TUINT256`\> -Safely parses a UINT256 into an [Effect](https://www.effect.website/docs/essentials/effect-type). - ## Type Parameters • **TUINT256** *extends* `bigint` @@ -22,13 +20,6 @@ Safely parses a UINT256 into an [Effect](https://www.effect.website/docs/essenti `Effect`\<`never`, [`InvalidUINTError`](../classes/InvalidUINTError.md), `TUINT256`\> -## Example - -```ts -import { parseUINT256Safe } from '@tevm/schemas'; -const parsedUINT256Effect = parseUINT256Safe('0x1234567890abcdef1234567890abcdef12345678'); -``` - ## Defined in [experimental/schemas/src/ethereum/SUINT/parseUINTSafe.js:141](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SUINT/parseUINTSafe.js#L141) diff --git a/experimental/schemas/docs/ethereum/functions/parseUINT32.md b/experimental/schemas/docs/ethereum/functions/parseUINT32.md index 018fe7f287..fecc87cb7d 100644 --- a/experimental/schemas/docs/ethereum/functions/parseUINT32.md +++ b/experimental/schemas/docs/ethereum/functions/parseUINT32.md @@ -8,8 +8,6 @@ > **parseUINT32**\<`TUINT32`\>(`uint32`): `TUINT32` -Parses a UINT32 and returns the value if no errors. - ## Type Parameters • **TUINT32** *extends* `bigint` @@ -22,13 +20,6 @@ Parses a UINT32 and returns the value if no errors. `TUINT32` -## Example - -```ts -import { parseUINT32 } from '@tevm/schemas'; -const parsedUINT32 = parseUINT32(BigInt(2147483647)); -``` - ## Defined in [experimental/schemas/src/ethereum/SUINT/parseUINT.js:56](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SUINT/parseUINT.js#L56) diff --git a/experimental/schemas/docs/ethereum/functions/parseUINT32Safe.md b/experimental/schemas/docs/ethereum/functions/parseUINT32Safe.md index 1b1b32f77d..ccf7015574 100644 --- a/experimental/schemas/docs/ethereum/functions/parseUINT32Safe.md +++ b/experimental/schemas/docs/ethereum/functions/parseUINT32Safe.md @@ -8,8 +8,6 @@ > **parseUINT32Safe**\<`TUINT32`\>(`uint32`): `Effect`\<`never`, [`InvalidUINTError`](../classes/InvalidUINTError.md), `TUINT32`\> -Safely parses a UINT32 into an [Effect](https://www.effect.website/docs/essentials/effect-type). - ## Type Parameters • **TUINT32** *extends* `bigint` diff --git a/experimental/schemas/docs/ethereum/functions/parseUINT64.md b/experimental/schemas/docs/ethereum/functions/parseUINT64.md index add25f2575..57496a52c9 100644 --- a/experimental/schemas/docs/ethereum/functions/parseUINT64.md +++ b/experimental/schemas/docs/ethereum/functions/parseUINT64.md @@ -8,8 +8,6 @@ > **parseUINT64**\<`TUINT64`\>(`uint64`): `TUINT64` -Parses a UINT64 and returns the value if no errors. - ## Type Parameters • **TUINT64** *extends* `bigint` @@ -22,13 +20,6 @@ Parses a UINT64 and returns the value if no errors. `TUINT64` -## Example - -```ts -import { parseUINT64 } from '@tevm/schemas'; -const parsedUINT64 = parseUINT64(BigInt("9223372036854775807")); -``` - ## Defined in [experimental/schemas/src/ethereum/SUINT/parseUINT.js:70](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SUINT/parseUINT.js#L70) diff --git a/experimental/schemas/docs/ethereum/functions/parseUINT64Safe.md b/experimental/schemas/docs/ethereum/functions/parseUINT64Safe.md index 6efb2b536e..4d7d25e354 100644 --- a/experimental/schemas/docs/ethereum/functions/parseUINT64Safe.md +++ b/experimental/schemas/docs/ethereum/functions/parseUINT64Safe.md @@ -8,8 +8,6 @@ > **parseUINT64Safe**\<`TUINT64`\>(`uint64`): `Effect`\<`never`, [`InvalidUINTError`](../classes/InvalidUINTError.md), `TUINT64`\> -Safely parses a UINT64 into an [Effect](https://www.effect.website/docs/essentials/effect-type). - ## Type Parameters • **TUINT64** *extends* `bigint` diff --git a/experimental/schemas/docs/ethereum/functions/parseUINT8.md b/experimental/schemas/docs/ethereum/functions/parseUINT8.md index 537c923195..c8c31d9db4 100644 --- a/experimental/schemas/docs/ethereum/functions/parseUINT8.md +++ b/experimental/schemas/docs/ethereum/functions/parseUINT8.md @@ -8,8 +8,6 @@ > **parseUINT8**\<`TUINT8`\>(`uint8`): `TUINT8` -Parses a UINT8 and returns the value if no errors. - ## Type Parameters • **TUINT8** *extends* `bigint` @@ -22,13 +20,6 @@ Parses a UINT8 and returns the value if no errors. `TUINT8` -## Example - -```ts -import { parseUINT8 } from '@tevm/schemas'; -const parsedUINT8 = parseUINT8(BigInt(127)); -``` - ## Defined in [experimental/schemas/src/ethereum/SUINT/parseUINT.js:28](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/ethereum/SUINT/parseUINT.js#L28) diff --git a/experimental/schemas/docs/ethereum/functions/parseUINT8Safe.md b/experimental/schemas/docs/ethereum/functions/parseUINT8Safe.md index 8851740c96..44d6bbe34e 100644 --- a/experimental/schemas/docs/ethereum/functions/parseUINT8Safe.md +++ b/experimental/schemas/docs/ethereum/functions/parseUINT8Safe.md @@ -8,8 +8,6 @@ > **parseUINT8Safe**\<`TUINT8`\>(`uint8`): `Effect`\<`never`, [`InvalidUINTError`](../classes/InvalidUINTError.md), `TUINT8`\> -Safely parses a UINT8 into an [Effect](https://www.effect.website/docs/essentials/effect-type). - ## Type Parameters • **TUINT8** *extends* `bigint` diff --git a/experimental/schemas/docs/tevm/classes/InvalidAddressBookError.md b/experimental/schemas/docs/tevm/classes/InvalidAddressBookError.md index 88216b0d91..1c344e1fcf 100644 --- a/experimental/schemas/docs/tevm/classes/InvalidAddressBookError.md +++ b/experimental/schemas/docs/tevm/classes/InvalidAddressBookError.md @@ -112,6 +112,10 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -122,10 +126,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from `TypeError.prepareStackTrace` @@ -198,4 +198,4 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/experimental/schemas/docs/tevm/functions/parseAddressBook.md b/experimental/schemas/docs/tevm/functions/parseAddressBook.md index 4c25f6a68c..6352bc3c46 100644 --- a/experimental/schemas/docs/tevm/functions/parseAddressBook.md +++ b/experimental/schemas/docs/tevm/functions/parseAddressBook.md @@ -8,8 +8,6 @@ > **parseAddressBook**\<`TAddressBook`\>(`addressBook`): `TAddressBook` -Parses an address book and returns the value if no errors. - ## Type Parameters • **TAddressBook** *extends* [`types`](../../types/README.md) @@ -22,18 +20,6 @@ Parses an address book and returns the value if no errors. `TAddressBook` -## Example - -```typescript -import {parseAddressBook} from '@tevm/schemas' -const parsedAddressBook = parseAddressBook({ - MyContract: { - blockCreated: 0, - address: '0x1234567890abcdef1234567890abcdef12345678' - } -}) -``` - ## Defined in [experimental/schemas/src/tevm/SAddressBook.js:121](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/tevm/SAddressBook.js#L121) diff --git a/experimental/schemas/docs/tevm/functions/parseAddressBookSafe.md b/experimental/schemas/docs/tevm/functions/parseAddressBookSafe.md index 622edebeb7..c3cee8372f 100644 --- a/experimental/schemas/docs/tevm/functions/parseAddressBookSafe.md +++ b/experimental/schemas/docs/tevm/functions/parseAddressBookSafe.md @@ -8,8 +8,6 @@ > **parseAddressBookSafe**\<`TAddressBook`\>(`addressBook`): `Effect`\<`never`, [`InvalidAddressBookError`](../classes/InvalidAddressBookError.md), `TAddressBook`\> -Safely parses an address book into an [Effect](https://www.effect.website/docs/essentials/effect-type). - ## Type Parameters • **TAddressBook** *extends* [`types`](../../types/README.md) @@ -22,18 +20,6 @@ Safely parses an address book into an [Effect](https://www.effect.website/docs/e `Effect`\<`never`, [`InvalidAddressBookError`](../classes/InvalidAddressBookError.md), `TAddressBook`\> -## Example - -```typescript -import {parseAddressBookSafe} from '@tevm/schemas' -const parsedAddressBookEffect = parseAddressBookSafe({ - MyContract: { - blockCreated: 0, - address: '0x1234567890abcdef1234567890abcdef12345678' - } -}) -``` - ## Defined in [experimental/schemas/src/tevm/SAddressBook.js:90](https://github.com/evmts/tevm-monorepo/blob/main/experimental/schemas/src/tevm/SAddressBook.js#L90) diff --git a/experimental/viem-effect/docs/README.md b/experimental/viem-effect/docs/README.md index d19afd2372..ed3a5da35e 100644 --- a/experimental/viem-effect/docs/README.md +++ b/experimental/viem-effect/docs/README.md @@ -26,4 +26,4 @@ ## License 📄 - + diff --git a/experimental/viem-effect/docs/_media/LICENSE b/experimental/viem-effect/docs/_media/LICENSE deleted file mode 100644 index 3ee5a4410a..0000000000 --- a/experimental/viem-effect/docs/_media/LICENSE +++ /dev/null @@ -1,22 +0,0 @@ -(The MIT License) - -Copyright 2023 - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/extensions/ethers/docs/README.md b/extensions/ethers/docs/README.md index fff3080bae..968d56640a 100644 --- a/extensions/ethers/docs/README.md +++ b/extensions/ethers/docs/README.md @@ -116,4 +116,4 @@ const optionsWithAddress = { address: "0x1234...abcd", runner: provider }; // Us ## License 📄 - + diff --git a/extensions/ethers/docs/_media/LICENSE b/extensions/ethers/docs/_media/LICENSE deleted file mode 100644 index b5a4fa7a69..0000000000 --- a/extensions/ethers/docs/_media/LICENSE +++ /dev/null @@ -1,22 +0,0 @@ -(The MIT License) - -Copyright 2020-2022 - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/extensions/ethers/docs/classes/TevmProvider.md b/extensions/ethers/docs/classes/TevmProvider.md index 4821ab6744..b6d0a250c1 100644 --- a/extensions/ethers/docs/classes/TevmProvider.md +++ b/extensions/ethers/docs/classes/TevmProvider.md @@ -10,7 +10,7 @@ An [ethers JsonRpcApiProvider](https://docs.ethers.org/v6/api/providers/jsonrpc/ ## TevmProvider -The TevmProvider class is an instance of an ethers provider using Tevm as it's backend. The `createMemoryProvider` method can be used to create an in memory instance of tevm using a [memoryClient](../clients/) as it's backend. +The TevmProvider class is an instance of an ethers provider using Tevm as it's backend. The `createMemoryProvider` method can be used to create an in memory instance of tevm using a [memoryClient]() as it's backend. ## Examples @@ -51,7 +51,7 @@ console.log( ## Tevm actions support -The entire [tevm api](../clients/) exists on the `tevm` property. For example the `tevm.script` method can be used to run an arbitrary script. +The entire [tevm api]() exists on the `tevm` property. For example the `tevm.script` method can be used to run an arbitrary script. ```typescript import {TevmProvider} from '@tevm/ethers' @@ -86,7 +86,7 @@ console.log(result) ## Tevm JSON-RPC support -An ethers TevmProvider supports the tevm [JSON-RPC methods](../json-rpc). For example you can use `tevm_account` to set account +An ethers TevmProvider supports the tevm [JSON-RPC methods](). For example you can use `tevm_account` to set account ```typescript await provider.send('tevm_setAccount', { @@ -204,7 +204,7 @@ Gets the [[Network]] this provider has committed to. On each call, the network #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/provider-jsonrpc.d.ts:224 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/provider-jsonrpc.d.ts:224 *** @@ -228,7 +228,7 @@ If this provider has been destroyed using the [[destroy]] method. #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:419 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:419 *** @@ -255,7 +255,7 @@ Prevent any CCIP-read operation, regardless of whether requested #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:282 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:282 *** @@ -289,7 +289,7 @@ Whether the provider is currently paused. #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:438 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:438 *** @@ -309,7 +309,7 @@ Returns all the registered plug-ins. #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:269 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:269 *** @@ -327,7 +327,7 @@ node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_ #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:260 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:260 *** @@ -348,7 +348,7 @@ Returns ``this``, to allow an **AbstractProvider** to implement #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:265 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:265 *** @@ -368,7 +368,7 @@ Returns true only if the [[_start]] has been called. #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/provider-jsonrpc.d.ts:270 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/provider-jsonrpc.d.ts:270 ## Methods @@ -392,7 +392,7 @@ Clear a timer created using the [[_setTimeout]] method. #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:374 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:374 *** @@ -416,7 +416,7 @@ Sub-classes may override this; it detects the *actual* network that #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/provider-jsonrpc.d.ts:245 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/provider-jsonrpc.d.ts:245 *** @@ -440,7 +440,7 @@ Perform %%func%% on each subscriber. #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:387 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:387 *** @@ -466,7 +466,7 @@ Returns or resolves to the address for %%address%%, resolving ENS #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:332 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:332 *** @@ -491,7 +491,7 @@ Returns or resolves to a valid block tag for %%blockTag%%, resolving #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:337 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:337 *** @@ -517,7 +517,7 @@ Returns or resolves to a filter for %%filter%%, resolving any ENS #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:343 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:343 *** @@ -547,7 +547,7 @@ Returns the value associated with the option %%key%%. #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/provider-jsonrpc.d.ts:219 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/provider-jsonrpc.d.ts:219 *** @@ -569,7 +569,7 @@ node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_ #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:364 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:364 *** @@ -596,7 +596,7 @@ Return a Subscriber that will manage the %%sub%%. #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/provider-jsonrpc.d.ts:266 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/provider-jsonrpc.d.ts:266 *** @@ -622,7 +622,7 @@ Returns or resolves to a transaction for %%request%%, resolving #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:349 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:349 *** @@ -649,7 +649,7 @@ Resolves to the non-normalized value by performing %%req%%. #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/provider-jsonrpc.d.ts:237 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/provider-jsonrpc.d.ts:237 *** @@ -681,7 +681,7 @@ If a [[Subscriber]] fails and needs to replace itself, this #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:402 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:402 *** @@ -717,7 +717,7 @@ Create a timer that will execute %%func%% after at least %%timeout%% (in ms). If %%timeout%% is unspecified, then %%func%% will execute in the next event loop. - [Pausing](AbstractProvider-paused) the provider will pause any + [Pausing]() the provider will pause any associated timers. #### Parameters @@ -736,7 +736,7 @@ Create a timer that will execute %%func%% after at least %%timeout%% #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:383 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:383 *** @@ -760,7 +760,7 @@ Sub-classes **MUST** call this. Until [[_start]] has been called, no calls #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/provider-jsonrpc.d.ts:253 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/provider-jsonrpc.d.ts:253 *** @@ -782,7 +782,7 @@ Resolves once the [[_start]] has been called. This can be used in #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/provider-jsonrpc.d.ts:259 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/provider-jsonrpc.d.ts:259 *** @@ -810,7 +810,7 @@ Provides the opportunity for a sub-class to wrap a block before #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:293 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:293 *** @@ -838,7 +838,7 @@ Provides the opportunity for a sub-class to wrap a log before #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:299 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:299 *** @@ -866,7 +866,7 @@ Provides the opportunity for a sub-class to wrap a transaction #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:305 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:305 *** @@ -894,7 +894,7 @@ Provides the opportunity for a sub-class to wrap a transaction #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:311 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:311 *** @@ -920,7 +920,7 @@ Alias for [[on]]. #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:410 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:410 *** @@ -944,7 +944,7 @@ Attach a new plug-in. #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:273 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:273 *** @@ -970,7 +970,7 @@ Broadcasts the %%signedTx%% to the network, adding it to the #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:358 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:358 *** @@ -995,7 +995,7 @@ Simulate the execution of %%tx%%. If the call reverts, it will #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:353 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:353 *** @@ -1023,7 +1023,7 @@ Resolves to the data for executing the CCIP-read operations. #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:287 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:287 *** @@ -1046,7 +1046,7 @@ Sub-classes may use this to shutdown any sockets or release their #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/provider-jsonrpc.d.ts:320 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/provider-jsonrpc.d.ts:320 *** @@ -1072,7 +1072,7 @@ Triggers each listener for %%event%% with the %%args%%. #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:405 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:405 *** @@ -1096,7 +1096,7 @@ Estimates the amount of gas required to execute %%tx%%. #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:352 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:352 *** @@ -1118,7 +1118,7 @@ node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_ #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:366 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:366 *** @@ -1140,18 +1140,18 @@ Get the account balance (in wei) of %%address%%. If %%blockTag%% `Promise`\<`bigint`\> +#### Inherited from + +`JsonRpcApiProvider.getBalance` + #### Note On nodes without archive access enabled, the %%blockTag%% may be **silently ignored** by the node, which may cause issues if relied on. -#### Inherited from - -`JsonRpcApiProvider.getBalance` - #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:354 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:354 *** @@ -1182,7 +1182,7 @@ Resolves to the block for %%blockHashOrBlockTag%%. #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:359 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:359 *** @@ -1202,7 +1202,7 @@ Get the current block number. #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:326 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:326 *** @@ -1222,18 +1222,18 @@ Get the bytecode for %%address%%. `Promise`\<`string`\> +#### Inherited from + +`JsonRpcApiProvider.getCode` + #### Note On nodes without archive access enabled, the %%blockTag%% may be **silently ignored** by the node, which may cause issues if relied on. -#### Inherited from - -`JsonRpcApiProvider.getCode` - #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:356 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:356 *** @@ -1253,7 +1253,7 @@ Get the best guess at the recommended [[FeeData]]. #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:351 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:351 *** @@ -1277,7 +1277,7 @@ Resolves to the list of Logs that match %%filter%% #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:363 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:363 *** @@ -1297,7 +1297,7 @@ Get the connected [[Network]]. #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:350 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:350 *** @@ -1325,7 +1325,7 @@ Get a plugin by name. #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:277 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:277 *** @@ -1347,7 +1347,7 @@ node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_ #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:365 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:365 *** @@ -1376,7 +1376,7 @@ Returns an ethers-style Error for the given JSON-RPC error #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/provider-jsonrpc.d.ts:291 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/provider-jsonrpc.d.ts:291 *** @@ -1401,7 +1401,7 @@ Returns the request method and arguments required to perform #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/provider-jsonrpc.d.ts:281 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/provider-jsonrpc.d.ts:281 *** @@ -1427,7 +1427,7 @@ Returns %%tx%% as a normalized JSON-RPC transaction request, #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/provider-jsonrpc.d.ts:276 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/provider-jsonrpc.d.ts:276 *** @@ -1460,7 +1460,7 @@ Resolves to the [[Signer]] account for %%address%% managed by #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/provider-jsonrpc.d.ts:318 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/provider-jsonrpc.d.ts:318 *** @@ -1482,18 +1482,18 @@ Get the storage slot value for %%address%% at slot %%position%%. `Promise`\<`string`\> +#### Inherited from + +`JsonRpcApiProvider.getStorage` + #### Note On nodes without archive access enabled, the %%blockTag%% may be **silently ignored** by the node, which may cause issues if relied on. -#### Inherited from - -`JsonRpcApiProvider.getStorage` - #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:357 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:357 *** @@ -1520,7 +1520,7 @@ Resolves to the transaction for %%hash%%. #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:360 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:360 *** @@ -1544,18 +1544,18 @@ Get the number of transactions ever sent for %%address%%, which `Promise`\<`number`\> +#### Inherited from + +`JsonRpcApiProvider.getTransactionCount` + #### Note On nodes without archive access enabled, the %%blockTag%% may be **silently ignored** by the node, which may cause issues if relied on. -#### Inherited from - -`JsonRpcApiProvider.getTransactionCount` - #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:355 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:355 *** @@ -1583,7 +1583,7 @@ Resolves to the transaction receipt for %%hash%%, if mined. #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:361 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:361 *** @@ -1610,7 +1610,7 @@ Resolves to the result returned by the executions of %%hash%%. #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:362 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:362 *** @@ -1628,7 +1628,7 @@ node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_ #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/provider-jsonrpc.d.ts:319 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/provider-jsonrpc.d.ts:319 *** @@ -1652,7 +1652,7 @@ Resolves to the number of listeners for %%event%%. #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:406 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:406 *** @@ -1676,7 +1676,7 @@ Resolves to the listeners for %%event%%. #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:407 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:407 *** @@ -1704,7 +1704,7 @@ Resolves to the ENS name associated for the %%address%% or #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:368 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:368 *** @@ -1731,7 +1731,7 @@ Unregister the %%listener%% for %%event%%. If %%listener%% #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:408 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:408 *** @@ -1758,7 +1758,7 @@ Registers a %%listener%% that is called whenever the #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:403 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:403 *** @@ -1785,7 +1785,7 @@ Registers a %%listener%% that is called the next time #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:404 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:404 *** @@ -1811,7 +1811,7 @@ Pause the provider. If %%dropWhilePaused%%, any events that occur #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:445 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:445 *** @@ -1835,7 +1835,7 @@ Unregister all listeners for %%event%%. #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:409 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:409 *** @@ -1861,7 +1861,7 @@ Alias for [[off]]. #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:411 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:411 *** @@ -1886,7 +1886,7 @@ Resolves to the address configured for the %%ensName%% or #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:367 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:367 *** @@ -1906,7 +1906,7 @@ Resume the provider. #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:449 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:449 *** @@ -1942,7 +1942,7 @@ Requests the %%method%% with %%params%% via the JSON-RPC protocol #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/provider-jsonrpc.d.ts:305 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/provider-jsonrpc.d.ts:305 *** @@ -1969,7 +1969,7 @@ Resolves to the block at %%blockTag%% once it has been mined. #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:370 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:370 *** @@ -1998,7 +1998,7 @@ Waits until the transaction %%hash%% is mined and has %%confirms%% #### Defined in -node\_modules/.pnpm/ethers@6.13.1\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:369 +node\_modules/.pnpm/ethers@6.13.2\_bufferutil@4.0.8\_utf-8-validate@6.0.4/node\_modules/ethers/lib.esm/providers/abstract-provider.d.ts:369 *** @@ -2010,7 +2010,7 @@ Creates a new TevmProvider instance with a TevmMemoryClient. #### Parameters -• **options**: `TevmNodeOptions`\<`Common`\> +• **options**: `TevmNodeOptions`\<`object`\> Options to create a new TevmProvider. diff --git a/extensions/ethers/package.json b/extensions/ethers/package.json index 246d624d0c..143c85381d 100644 --- a/extensions/ethers/package.json +++ b/extensions/ethers/package.json @@ -22,6 +22,7 @@ "contributors": [ "Will Cory " ], + "sideEffects": false, "type": "module", "exports": { "./package.json": "./package.json", @@ -81,6 +82,5 @@ }, "publishConfig": { "access": "public" - }, - "sideEffects": false + } } \ No newline at end of file diff --git a/extensions/ethers/src/TevmProvider.spec.ts b/extensions/ethers/src/TevmProvider.spec.ts index 6d48bd0949..7329f13cb9 100644 --- a/extensions/ethers/src/TevmProvider.spec.ts +++ b/extensions/ethers/src/TevmProvider.spec.ts @@ -1,7 +1,7 @@ import { createContract } from '@tevm/contract' import { ERC20 } from '@tevm/contract' import { transports } from '@tevm/test-utils' -import { toHex } from '@tevm/utils' +import { encodeDeployData, toHex } from '@tevm/utils' import { beforeEach, describe, expect, it } from 'vitest' import { TevmProvider } from './TevmProvider.js' import { Interface } from './contract/index.js' @@ -60,7 +60,7 @@ describe(TevmProvider.name, () => { 'provider.tevm.script', async () => { const result = await provider.tevm.contract( - ERC20.script({ constructorArgs: ['name', 'SYMBOL'] }).read.balanceOf(`0x${'69'.repeat(20)}`), + ERC20.withCode(encodeDeployData(ERC20.deploy('name', 'SYMBOL'))).read.balanceOf(`0x${'69'.repeat(20)}`), ) expect(result).toEqual({ amountSpent: 1454773185243n, diff --git a/extensions/viem/docs/README.md b/extensions/viem/docs/README.md index 3e42e3153d..bb089a34be 100644 --- a/extensions/viem/docs/README.md +++ b/extensions/viem/docs/README.md @@ -6,7 +6,7 @@ # @tevm/viem -Viem client for tevm. For an ethers client see [@tevm/ethers](../ethers/) and for a lightweight fetch based client see [@tevm/client](../../vm/client/) +Viem client for tevm. For an ethers client see [@tevm/ethers]() and for a lightweight fetch based client see [@tevm/client]() ## Visit [Docs](https://tevm.sh/) for docs, guides, API and more! @@ -14,4 +14,4 @@ Viem client for tevm. For an ethers client see [@tevm/ethers](../ethers/) and fo ## License 📄 - + diff --git a/extensions/viem/docs/_media/LICENSE b/extensions/viem/docs/_media/LICENSE deleted file mode 100644 index b5a4fa7a69..0000000000 --- a/extensions/viem/docs/_media/LICENSE +++ /dev/null @@ -1,22 +0,0 @@ -(The MIT License) - -Copyright 2020-2022 - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/extensions/viem/docs/functions/tevmViemExtension.md b/extensions/viem/docs/functions/tevmViemExtension.md index e81bde042d..daf888e8dd 100644 --- a/extensions/viem/docs/functions/tevmViemExtension.md +++ b/extensions/viem/docs/functions/tevmViemExtension.md @@ -14,25 +14,6 @@ Decorates a viem [public client](https://viem.sh/) with the [tevm api](https://t [`ViemTevmClientDecorator`](../type-aliases/ViemTevmClientDecorator.md) -## Example - -```js -import { createClient, parseEth } from 'viem' -import { tevmViemExtension } from '@tevm/viem-extension' - -const client = createClient('https://mainnet.optimism.io') - .extend(tevmViemExtension()) - -await client.tevm.account({ - address: `0x${'12'.repeat(20)}`, - balance: parseEth('420'), -}) -``` - -## See - -[@tevm/server](https://tevm.sh/generated/tevm/server/functions/createserver) for documentation on creating a tevm backend - ## Defined in [extensions/viem/src/tevmViemExtension.js:36](https://github.com/evmts/tevm-monorepo/blob/main/extensions/viem/src/tevmViemExtension.js#L36) diff --git a/extensions/viem/docs/functions/tevmViemExtensionOptimistic.md b/extensions/viem/docs/functions/tevmViemExtensionOptimistic.md index c07fdd797c..072d805ed3 100644 --- a/extensions/viem/docs/functions/tevmViemExtensionOptimistic.md +++ b/extensions/viem/docs/functions/tevmViemExtensionOptimistic.md @@ -14,70 +14,6 @@ [`ViemTevmOptimisticClientDecorator`](../type-aliases/ViemTevmOptimisticClientDecorator.md) -## Deprecated - -Viem is built into the tevm memory client now without needing this - -This extension is highly experimental and should not be used in production. - -Creates a decorator to a viem wallet client that adds the `writeContractOptimistic` method to the `tevm` property. -It also decorates all the normal `tevm` methods from the [Tevm api](https://tevm.sh/generated/tevm/api/type-aliases/tevm/) -This enables viem to optimistically update the tevm state before the transaction is mined. - -## Example - -```ts -import { tevmViemExtensionOptimistic } from 'tevmViemExtensionOptimistic' -import { walletClient } from './walletClient.js' - -const client = walletClient.extend(tevmViemExtensionOptimistic()) - -for (const result of client.tevm.writeContractOptimistic({ - from: '0x...', - to: '0x...', - abi: [...], - functionName: 'transferFrom', - args: ['0x...', '0x...', '1000000000000000000'], -})) { - if (result.tag === 'OPTIMISTIC_RESULT') { - expect(result).toEqual({ - data: mockRequestResponse as any, - success: true, - tag: 'OPTIMISTIC_RESULT', - }) - expect((client.request as jest.Mock).mock.lastCall[0]).toEqual({ - method: 'tevm_contract', - params: params, - jsonrpc: '2.0', - }) - expect((client.writeContract as jest.Mock).mock.lastCall[0]).toEqual({ - abi: params.abi, - functionName: params.functionName, - args: params.args, - caller: params.caller, - address: params.address, - account: params.account, - chain: params.chain, - }) - } else if (result.tag === 'HASH') { - expect(result).toEqual({ - data: mockWriteContractResponse, - success: true, - tag: 'HASH', - }) - } else if (result.tag === 'RECEIPT') { - expect(result).toEqual({ - data: mockTxReciept, - success: true, - tag: 'RECEIPT', - }) - expect(mockWaitForTransactionReceipt.mock.lastCall[0]).toEqual(client) - expect(mockWaitForTransactionReceipt.mock.lastCall[1]).toEqual({ - hash: mockWriteContractResponse, - }) - } -} - ## Defined in [extensions/viem/src/tevmViemExtensionOptimistic.js:66](https://github.com/evmts/tevm-monorepo/blob/main/extensions/viem/src/tevmViemExtensionOptimistic.js#L66) diff --git a/extensions/viem/docs/type-aliases/ViemTevmClient.md b/extensions/viem/docs/type-aliases/ViemTevmClient.md index 9da1ed06e3..a633cfd957 100644 --- a/extensions/viem/docs/type-aliases/ViemTevmClient.md +++ b/extensions/viem/docs/type-aliases/ViemTevmClient.md @@ -8,17 +8,17 @@ > **ViemTevmClient**: `object` +## Deprecated + +in favor of the viem transport +The decorated properties added by the `tevmViemExtension` + ## Type declaration ### ~~tevm~~ > **tevm**: `TevmClient` -## Deprecated - -in favor of the viem transport -The decorated properties added by the `tevmViemExtension` - ## Defined in [extensions/viem/src/ViemTevmClient.ts:7](https://github.com/evmts/tevm-monorepo/blob/main/extensions/viem/src/ViemTevmClient.ts#L7) diff --git a/extensions/viem/docs/type-aliases/ViemTevmClientDecorator.md b/extensions/viem/docs/type-aliases/ViemTevmClientDecorator.md index df1c90396b..b1026204a3 100644 --- a/extensions/viem/docs/type-aliases/ViemTevmClientDecorator.md +++ b/extensions/viem/docs/type-aliases/ViemTevmClientDecorator.md @@ -8,6 +8,11 @@ > **ViemTevmClientDecorator**: (`client`) => [`ViemTevmClient`](ViemTevmClient.md) +## Deprecated + +in favor of the viem transport +A viem decorator for `tevmViemExtension` + ## Parameters • **client**: `any` @@ -16,11 +21,6 @@ [`ViemTevmClient`](ViemTevmClient.md) -## Deprecated - -in favor of the viem transport -A viem decorator for `tevmViemExtension` - ## Defined in [extensions/viem/src/ViemTevmClientDecorator.ts:7](https://github.com/evmts/tevm-monorepo/blob/main/extensions/viem/src/ViemTevmClientDecorator.ts#L7) diff --git a/extensions/viem/docs/type-aliases/ViemTevmExtension.md b/extensions/viem/docs/type-aliases/ViemTevmExtension.md index 67021df2df..041b1b85a6 100644 --- a/extensions/viem/docs/type-aliases/ViemTevmExtension.md +++ b/extensions/viem/docs/type-aliases/ViemTevmExtension.md @@ -8,10 +8,6 @@ > **ViemTevmExtension**: () => [`ViemTevmClientDecorator`](ViemTevmClientDecorator.md) -## Returns - -[`ViemTevmClientDecorator`](ViemTevmClientDecorator.md) - ## Deprecated in favor of the viem transport @@ -75,6 +71,10 @@ params: params, } } +## Returns + +[`ViemTevmClientDecorator`](ViemTevmClientDecorator.md) + ## Defined in [extensions/viem/src/ViemTevmExtension.ts:63](https://github.com/evmts/tevm-monorepo/blob/main/extensions/viem/src/ViemTevmExtension.ts#L63) diff --git a/extensions/viem/docs/type-aliases/ViemTevmOptimisticClient.md b/extensions/viem/docs/type-aliases/ViemTevmOptimisticClient.md index 6814ccf333..fab7a8071e 100644 --- a/extensions/viem/docs/type-aliases/ViemTevmOptimisticClient.md +++ b/extensions/viem/docs/type-aliases/ViemTevmOptimisticClient.md @@ -10,6 +10,12 @@ **`Experimental`** +## Deprecated + +in favor of the viem transport + +The decorated methods added to a viem wallet client by `tevmViemExtensionOptimistic` + ## Type Parameters • **TChain** *extends* `Chain` \| `undefined` = `Chain` @@ -46,12 +52,6 @@ `AsyncGenerator`\<[`OptimisticResult`](OptimisticResult.md)\<`TAbi`, `TFunctionName`, `TChain`\>, `any`, `unknown`\> -## Deprecated - -in favor of the viem transport - -The decorated methods added to a viem wallet client by `tevmViemExtensionOptimistic` - ## Defined in [extensions/viem/src/ViemTevmOptimisticClient.ts:11](https://github.com/evmts/tevm-monorepo/blob/main/extensions/viem/src/ViemTevmOptimisticClient.ts#L11) diff --git a/extensions/viem/docs/type-aliases/ViemTevmOptimisticClientDecorator.md b/extensions/viem/docs/type-aliases/ViemTevmOptimisticClientDecorator.md index ce7898f75a..8b7d1f810a 100644 --- a/extensions/viem/docs/type-aliases/ViemTevmOptimisticClientDecorator.md +++ b/extensions/viem/docs/type-aliases/ViemTevmOptimisticClientDecorator.md @@ -8,6 +8,12 @@ > **ViemTevmOptimisticClientDecorator**: \<`TTransport`, `TChain`, `TAccount`\>(`client`) => [`ViemTevmOptimisticClient`](ViemTevmOptimisticClient.md)\<`TChain`, `TAccount`\> +## Deprecated + +in favor of the viem transport + +A viem decorator for `tevmViemExtension` + ## Type Parameters • **TTransport** *extends* `Transport` = `Transport` @@ -24,12 +30,6 @@ [`ViemTevmOptimisticClient`](ViemTevmOptimisticClient.md)\<`TChain`, `TAccount`\> -## Deprecated - -in favor of the viem transport - -A viem decorator for `tevmViemExtension` - ## Defined in [extensions/viem/src/ViemTevmOptimisticClientDecorator.ts:9](https://github.com/evmts/tevm-monorepo/blob/main/extensions/viem/src/ViemTevmOptimisticClientDecorator.ts#L9) diff --git a/extensions/viem/docs/type-aliases/ViemTevmOptimisticExtension.md b/extensions/viem/docs/type-aliases/ViemTevmOptimisticExtension.md index 8ec4435fde..b1c6b01f4e 100644 --- a/extensions/viem/docs/type-aliases/ViemTevmOptimisticExtension.md +++ b/extensions/viem/docs/type-aliases/ViemTevmOptimisticExtension.md @@ -8,10 +8,6 @@ > **ViemTevmOptimisticExtension**: () => [`ViemTevmOptimisticClientDecorator`](ViemTevmOptimisticClientDecorator.md) -## Returns - -[`ViemTevmOptimisticClientDecorator`](ViemTevmOptimisticClientDecorator.md) - ## Deprecated in favor of the viem transport @@ -37,6 +33,10 @@ await client.tevm.account({ [@tevm/server](https://tevm.sh/generated/tevm/server/functions/createserver) for documentation on creating a tevm backend +## Returns + +[`ViemTevmOptimisticClientDecorator`](ViemTevmOptimisticClientDecorator.md) + ## Defined in [extensions/viem/src/ViemTevmOptimisticExtension.ts:22](https://github.com/evmts/tevm-monorepo/blob/main/extensions/viem/src/ViemTevmOptimisticExtension.ts#L22) diff --git a/extensions/viem/package.json b/extensions/viem/package.json index f8154ba2a8..048469bf97 100644 --- a/extensions/viem/package.json +++ b/extensions/viem/package.json @@ -21,6 +21,7 @@ "contributors": [ "Will Cory " ], + "sideEffects": false, "type": "module", "exports": { "./package.json": "./package.json", @@ -89,6 +90,5 @@ }, "publishConfig": { "access": "public" - }, - "sideEffects": false + } } \ No newline at end of file diff --git a/extensions/viem/src/tevmViemExtension.spec.ts b/extensions/viem/src/tevmViemExtension.spec.ts index 3e5ddcb3cf..ad44bdddf9 100644 --- a/extensions/viem/src/tevmViemExtension.spec.ts +++ b/extensions/viem/src/tevmViemExtension.spec.ts @@ -5,7 +5,7 @@ import { ERC20 } from '@tevm/contract' import { type MemoryClient, createMemoryClient } from '@tevm/memory-client' import { createHttpHandler } from '@tevm/server' import { transports } from '@tevm/test-utils' -import { http, type PublicClient, createPublicClient } from 'viem' +import { http, type PublicClient, createPublicClient, encodeDeployData } from 'viem' import { afterAll, beforeAll, describe, expect, it } from 'vitest' import { tevmViemExtension } from './tevmViemExtension.js' @@ -46,7 +46,7 @@ describe('tevmViemExtension', () => { async () => { const decorated = tevmViemExtension()(client) const params = { - ...ERC20.script({ constructorArgs: ['Name', 'SYMBOL'] }).read.balanceOf(`0x${'4'.repeat(40)}`), + ...ERC20.withCode(encodeDeployData(ERC20.deploy('Name', 'SYMBOL'))).read.balanceOf(`0x${'4'.repeat(40)}`), } as const const response = await decorated.tevm.contract(params) expect(response.executionGasUsed).toEqual(2851n) diff --git a/packages/actions/docs/README.md b/packages/actions/docs/README.md index 87adedee64..117aff6b4f 100644 --- a/packages/actions/docs/README.md +++ b/packages/actions/docs/README.md @@ -59,8 +59,8 @@ const callResult = await call({ ## Actions -See [generated actions docs](./docs/API.md) +See [generated actions docs]() ## License 📄 - + diff --git a/packages/actions/docs/_media/LICENSE b/packages/actions/docs/_media/LICENSE deleted file mode 100644 index b5a4fa7a69..0000000000 --- a/packages/actions/docs/_media/LICENSE +++ /dev/null @@ -1,22 +0,0 @@ -(The MIT License) - -Copyright 2020-2022 - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/packages/actions/docs/classes/BlobGasLimitExceededError.md b/packages/actions/docs/classes/BlobGasLimitExceededError.md index ef5b67ece8..c67d7a4715 100644 --- a/packages/actions/docs/classes/BlobGasLimitExceededError.md +++ b/packages/actions/docs/classes/BlobGasLimitExceededError.md @@ -104,6 +104,10 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -114,10 +118,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from `Error.prepareStackTrace` @@ -190,7 +190,7 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 #### captureStackTrace(targetObject, constructorOpt) @@ -214,7 +214,7 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@20.12.14/node\_modules/@types/node/globals.d.ts:21 +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 #### captureStackTrace(targetObject, constructorOpt) @@ -239,3 +239,27 @@ Create .stack property on a target object ##### Defined in node\_modules/.pnpm/bun-types@1.1.22/node\_modules/bun-types/globals.d.ts:1629 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +`Error.captureStackTrace` + +##### Defined in + +node\_modules/.pnpm/@types+node@20.12.14/node\_modules/@types/node/globals.d.ts:21 diff --git a/packages/actions/docs/classes/MissingAccountError.md b/packages/actions/docs/classes/MissingAccountError.md index 3b9b8a9d92..e6c8659a74 100644 --- a/packages/actions/docs/classes/MissingAccountError.md +++ b/packages/actions/docs/classes/MissingAccountError.md @@ -128,6 +128,10 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -138,10 +142,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from `Error.prepareStackTrace` @@ -214,7 +214,7 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 #### captureStackTrace(targetObject, constructorOpt) @@ -238,7 +238,7 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@20.12.14/node\_modules/@types/node/globals.d.ts:21 +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 #### captureStackTrace(targetObject, constructorOpt) @@ -263,3 +263,27 @@ Create .stack property on a target object ##### Defined in node\_modules/.pnpm/bun-types@1.1.22/node\_modules/bun-types/globals.d.ts:1629 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +`Error.captureStackTrace` + +##### Defined in + +node\_modules/.pnpm/@types+node@20.12.14/node\_modules/@types/node/globals.d.ts:21 diff --git a/packages/actions/docs/classes/NoForkUrlSetError.md b/packages/actions/docs/classes/NoForkUrlSetError.md index afc72844c3..2e537f1275 100644 --- a/packages/actions/docs/classes/NoForkUrlSetError.md +++ b/packages/actions/docs/classes/NoForkUrlSetError.md @@ -128,6 +128,10 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -138,10 +142,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from `Error.prepareStackTrace` @@ -214,7 +214,7 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 #### captureStackTrace(targetObject, constructorOpt) @@ -238,7 +238,7 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@20.12.14/node\_modules/@types/node/globals.d.ts:21 +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 #### captureStackTrace(targetObject, constructorOpt) @@ -263,3 +263,27 @@ Create .stack property on a target object ##### Defined in node\_modules/.pnpm/bun-types@1.1.22/node\_modules/bun-types/globals.d.ts:1629 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +`Error.captureStackTrace` + +##### Defined in + +node\_modules/.pnpm/@types+node@20.12.14/node\_modules/@types/node/globals.d.ts:21 diff --git a/packages/actions/docs/functions/blockNumberHandler.md b/packages/actions/docs/functions/blockNumberHandler.md index d9b1fea0e8..8a98f7b9bf 100644 --- a/packages/actions/docs/functions/blockNumberHandler.md +++ b/packages/actions/docs/functions/blockNumberHandler.md @@ -8,8 +8,6 @@ > **blockNumberHandler**(`client`): [`EthBlockNumberHandler`](../type-aliases/EthBlockNumberHandler.md) -Handler for the `eth_blockNumber` RPC call - ## Parameters • **client**: `TevmNode`\<`"fork"` \| `"normal"`, `object`\> diff --git a/packages/actions/docs/functions/callHandler.md b/packages/actions/docs/functions/callHandler.md index ca0f364a72..eb67f8d8bd 100644 --- a/packages/actions/docs/functions/callHandler.md +++ b/packages/actions/docs/functions/callHandler.md @@ -8,12 +8,6 @@ > **callHandler**(`client`, `options`?): [`CallHandler`](../type-aliases/CallHandler.md) -Creates a tree-shakable instance of [`client.tevmCall`](https://tevm.sh/reference/tevm/decorators/type-aliases/tevmactionsapi/#call) action. -This function is designed for use with TevmNode and the internal instance of TEVM, -and it is distinct from the viem API `tevmCall`. - -Note: This is the internal logic used by higher-level APIs such as `tevmCall`. - ## Parameters • **client**: `TevmNode`\<`"fork"` \| `"normal"`, `object`\> @@ -34,28 +28,6 @@ Whether to throw an error on failure. The call handler function. -## Throws - -If `throwOnFail` is true, returns `TevmCallError` as value. - -## Example - -```typescript -import { createTevmNode } from 'tevm/node' -import { callHandler } from 'tevm/actions' - -const client = createTevmNode() - -const call = callHandler(client) - -const res = await call({ - createTransaction: true, - to: `0x${'69'.repeat(20)}`, - value: 420n, - skipBalance: true, -}) -``` - ## Defined in [packages/actions/src/Call/callHandler.js:46](https://github.com/evmts/tevm-monorepo/blob/main/packages/actions/src/Call/callHandler.js#L46) diff --git a/packages/actions/docs/functions/callHandlerOpts.md b/packages/actions/docs/functions/callHandlerOpts.md index ab896e6f50..38bdbf87aa 100644 --- a/packages/actions/docs/functions/callHandlerOpts.md +++ b/packages/actions/docs/functions/callHandlerOpts.md @@ -8,8 +8,6 @@ > **callHandlerOpts**(`client`, `params`): `Promise`\<`object` \| `object`\> -Parses user provided params into ethereumjs options to pass into the EVM - ## Parameters • **client**: `TevmNode`\<`"fork"` \| `"normal"`, `object`\> @@ -20,10 +18,6 @@ Parses user provided params into ethereumjs options to pass into the EVM `Promise`\<`object` \| `object`\> -## Throws - -Returns all errors as values - ## Defined in [packages/actions/src/Call/callHandlerOpts.js:19](https://github.com/evmts/tevm-monorepo/blob/main/packages/actions/src/Call/callHandlerOpts.js#L19) diff --git a/packages/actions/docs/functions/callHandlerResult.md b/packages/actions/docs/functions/callHandlerResult.md index ce80cf8387..e055a6b213 100644 --- a/packages/actions/docs/functions/callHandlerResult.md +++ b/packages/actions/docs/functions/callHandlerResult.md @@ -8,8 +8,6 @@ > **callHandlerResult**(`evmResult`, `txHash`, `trace`, `accessList`): [`CallResult`](../type-aliases/CallResult.md)\<[`TevmCallError`](../type-aliases/TevmCallError.md)\> -Creates an CallHandler for handling call params with Ethereumjs EVM - ## Parameters • **evmResult**: `RunTxResult` @@ -26,10 +24,6 @@ returned by the evm [`CallResult`](../type-aliases/CallResult.md)\<[`TevmCallError`](../type-aliases/TevmCallError.md)\> -## Throws - -any error means the input and output types were invalid or some invariant was broken - ## Defined in [packages/actions/src/Call/callHandlerResult.js:14](https://github.com/evmts/tevm-monorepo/blob/main/packages/actions/src/Call/callHandlerResult.js#L14) diff --git a/packages/actions/docs/functions/chainIdHandler.md b/packages/actions/docs/functions/chainIdHandler.md index 6b22b18f98..d4f700599e 100644 --- a/packages/actions/docs/functions/chainIdHandler.md +++ b/packages/actions/docs/functions/chainIdHandler.md @@ -8,8 +8,6 @@ > **chainIdHandler**(`client`): [`EthChainIdHandler`](../type-aliases/EthChainIdHandler.md) -Handler for the `eth_chainId` RPC call. - ## Parameters • **client**: `TevmNode`\<`"fork"` \| `"normal"`, `object`\> diff --git a/packages/actions/docs/functions/contractHandler.md b/packages/actions/docs/functions/contractHandler.md index a07fadca67..cbc95f1b28 100644 --- a/packages/actions/docs/functions/contractHandler.md +++ b/packages/actions/docs/functions/contractHandler.md @@ -8,11 +8,6 @@ > **contractHandler**(`client`, `options`?): [`ContractHandler`](../type-aliases/ContractHandler.md) -Creates a tree-shakable instance of `contractHandler` for handling contract interactions with the Ethereumjs EVM. -This function uses `callHandler` under the hood to execute contract calls. - -Note: This is the internal logic used by higher-level APIs such as `tevmContract`. - ## Parameters • **client**: `TevmNode`\<`"fork"` \| `"normal"`, `object`\> @@ -33,28 +28,6 @@ Whether to throw an error on failure. The contract handler function. -## Throws - -If `throwOnFail` is true, returns `TevmCallError` as value. - -## Example - -```typescript -import { createTevmNode } from 'tevm/node' -import { contractHandler } from 'tevm/actions' - -const client = createTevmNode() - -const contract = contractHandler(client) - -const res = await contract({ - to: `0x${'69'.repeat(20)}`, - abi: [{...}], // ABI array - functionName: 'myFunction', - args: [1, 2, 3], -}) -``` - ## Defined in [packages/actions/src/Contract/contractHandler.js:38](https://github.com/evmts/tevm-monorepo/blob/main/packages/actions/src/Contract/contractHandler.js#L38) diff --git a/packages/actions/docs/functions/deployHandler.md b/packages/actions/docs/functions/deployHandler.md index 5e007661b1..9be1019d0d 100644 --- a/packages/actions/docs/functions/deployHandler.md +++ b/packages/actions/docs/functions/deployHandler.md @@ -8,11 +8,6 @@ > **deployHandler**(`client`, `options`?): [`DeployHandler`](../type-aliases/DeployHandler.md) -Creates a tree-shakable instance of `deployHandler` for handling the deployment of contracts to TEVM. -This function uses `callHandler` under the hood to execute the deployment. - -Note: This is the internal logic used by higher-level APIs such as `tevmDeploy`. - ## Parameters • **client**: `TevmNode`\<`"fork"` \| `"normal"`, `object`\> @@ -33,28 +28,6 @@ Whether to throw an error on failure. The deploy handler function. -## Throws - -If `throwOnFail` is true, returns `TevmCallError` as value. - -## Example - -```typescript -import { createTevmNode } from 'tevm/node' -import { deployHandler } from 'tevm/actions' - -const client = createTevmNode() - -const deploy = deployHandler(client) - -const res = await deploy({ - bytecode: '0x...', // Contract bytecode - abi: [{...}], // ABI array - args: [1, 2, 3], // Constructor arguments - createTransaction: true, -}) -``` - ## Defined in [packages/actions/src/Deploy/deployHandler.js:37](https://github.com/evmts/tevm-monorepo/blob/main/packages/actions/src/Deploy/deployHandler.js#L37) diff --git a/packages/actions/docs/functions/dumpStateHandler.md b/packages/actions/docs/functions/dumpStateHandler.md index 27b1562967..156ea724f6 100644 --- a/packages/actions/docs/functions/dumpStateHandler.md +++ b/packages/actions/docs/functions/dumpStateHandler.md @@ -8,8 +8,6 @@ > **dumpStateHandler**(`client`, `options`?): [`DumpStateHandler`](../type-aliases/DumpStateHandler.md) -Creates a handler for dumping the TEVM state. - ## Parameters • **client**: `TevmNode`\<`"fork"` \| `"normal"`, `object`\> @@ -30,24 +28,6 @@ Whether to throw an error if the state dump fails. - The state dump handler function. -## Example - -```typescript -import { createTevmNode } from 'tevm/node' -import { dumpStateHandler } from 'tevm/actions' - -const client = createTevmNode() - -const dumpState = dumpStateHandler(client) - -const { state, errors } = await dumpState() -if (errors) { - console.error(errors) -} else { - console.log(state) -} -``` - ## Defined in [packages/actions/src/DumpState/dumpStateHandler.js:32](https://github.com/evmts/tevm-monorepo/blob/main/packages/actions/src/DumpState/dumpStateHandler.js#L32) diff --git a/packages/actions/docs/functions/ethGetLogsHandler.md b/packages/actions/docs/functions/ethGetLogsHandler.md index e5ffa4c05c..3da166a588 100644 --- a/packages/actions/docs/functions/ethGetLogsHandler.md +++ b/packages/actions/docs/functions/ethGetLogsHandler.md @@ -18,4 +18,4 @@ ## Defined in -[packages/actions/src/eth/ethGetLogsHandler.js:62](https://github.com/evmts/tevm-monorepo/blob/main/packages/actions/src/eth/ethGetLogsHandler.js#L62) +[packages/actions/src/eth/ethGetLogsHandler.js:14](https://github.com/evmts/tevm-monorepo/blob/main/packages/actions/src/eth/ethGetLogsHandler.js#L14) diff --git a/packages/actions/docs/functions/ethNewFilterHandler.md b/packages/actions/docs/functions/ethNewFilterHandler.md new file mode 100644 index 0000000000..e21c595f70 --- /dev/null +++ b/packages/actions/docs/functions/ethNewFilterHandler.md @@ -0,0 +1,23 @@ +[**@tevm/actions**](../README.md) • **Docs** + +*** + +[@tevm/actions](../globals.md) / ethNewFilterHandler + +# Function: ethNewFilterHandler() + +> **ethNewFilterHandler**(`tevmNode`): [`EthNewFilterHandler`](../type-aliases/EthNewFilterHandler.md) + +## Parameters + +• **tevmNode**: `TevmNode`\<`"fork"` \| `"normal"`, `object`\> + +## Returns + +[`EthNewFilterHandler`](../type-aliases/EthNewFilterHandler.md) + +ethNewFilterHandler + +## Defined in + +[packages/actions/src/eth/ethNewFilterHandler.js:15](https://github.com/evmts/tevm-monorepo/blob/main/packages/actions/src/eth/ethNewFilterHandler.js#L15) diff --git a/packages/actions/docs/functions/ethSignHandler.md b/packages/actions/docs/functions/ethSignHandler.md index 661204b5ec..91f8528de1 100644 --- a/packages/actions/docs/functions/ethSignHandler.md +++ b/packages/actions/docs/functions/ethSignHandler.md @@ -12,7 +12,7 @@ • **params** -• **params.accounts**: readonly `HDAccount`[] +• **params.accounts**: readonly `object`[] ## Returns diff --git a/packages/actions/docs/functions/ethSignTransactionHandler.md b/packages/actions/docs/functions/ethSignTransactionHandler.md index a357201568..ac5e001fc6 100644 --- a/packages/actions/docs/functions/ethSignTransactionHandler.md +++ b/packages/actions/docs/functions/ethSignTransactionHandler.md @@ -12,7 +12,7 @@ • **options** -• **options.accounts**: readonly `HDAccount`[] +• **options.accounts**: readonly `object`[] • **options.getChainId** diff --git a/packages/actions/docs/functions/forkAndCacheBlock.md b/packages/actions/docs/functions/forkAndCacheBlock.md index b5ce5e46af..2c5bc483db 100644 --- a/packages/actions/docs/functions/forkAndCacheBlock.md +++ b/packages/actions/docs/functions/forkAndCacheBlock.md @@ -8,8 +8,6 @@ > **forkAndCacheBlock**(`client`, `block`, `executeBlock`?): `Promise`\<`Vm`\> -Will fork a given block number and save the state roots to state manager - ## Parameters • **client**: `TevmNode`\<`"fork"` \| `"normal"`, `object`\> diff --git a/packages/actions/docs/functions/getAccountHandler.md b/packages/actions/docs/functions/getAccountHandler.md index 3c004a9162..adf03c510a 100644 --- a/packages/actions/docs/functions/getAccountHandler.md +++ b/packages/actions/docs/functions/getAccountHandler.md @@ -8,8 +8,6 @@ > **getAccountHandler**(`client`, `options`?): [`GetAccountHandler`](../type-aliases/GetAccountHandler.md) -Creates an GetAccountHandler for handling account params with Ethereumjs VM - ## Parameters • **client**: `TevmNode`\<`"fork"` \| `"normal"`, `object`\> diff --git a/packages/actions/docs/functions/loadStateHandler.md b/packages/actions/docs/functions/loadStateHandler.md index 9e7da3c148..ab646542d1 100644 --- a/packages/actions/docs/functions/loadStateHandler.md +++ b/packages/actions/docs/functions/loadStateHandler.md @@ -8,8 +8,6 @@ > **loadStateHandler**(`client`, `options`?): [`LoadStateHandler`](../type-aliases/LoadStateHandler.md) -Creates a handler for loading a previously dumped state into the VM. - ## Parameters • **client**: `TevmNode`\<`"fork"` \| `"normal"`, `object`\> @@ -30,29 +28,6 @@ Whether to throw an error when a failure occurs. - The handler function. -## Example - -```typescript -import { createClient } from 'tevm' -import { loadStateHandler } from 'tevm/actions' -import fs from 'fs' - -const client = createClient() -const loadState = loadStateHandler(client) - -const state = JSON.parse(fs.readFileSync('state.json')) -const result = await loadState({ state }) -if (result.errors) { - console.error('Failed to load state:', result.errors) -} -``` - -## See - - - [LoadStateParams](../type-aliases/LoadStateParams.md) - - [LoadStateResult](../type-aliases/LoadStateResult.md) - - [TevmLoadStateError](../type-aliases/TevmLoadStateError.md) - ## Defined in [packages/actions/src/LoadState/loadStateHandler.js:35](https://github.com/evmts/tevm-monorepo/blob/main/packages/actions/src/LoadState/loadStateHandler.js#L35) diff --git a/packages/actions/docs/functions/scriptHandler.md b/packages/actions/docs/functions/scriptHandler.md index 42410d408b..64a710a4d1 100644 --- a/packages/actions/docs/functions/scriptHandler.md +++ b/packages/actions/docs/functions/scriptHandler.md @@ -22,11 +22,6 @@ whether to default to throwing or not when errors occur [`ScriptHandler`](../type-aliases/ScriptHandler.md) -## Deprecated - -can use `contractHandler` instead -Creates an ScriptHandler for handling script params with Ethereumjs EVM - ## Defined in [packages/actions/src/Script/scriptHandler.js:12](https://github.com/evmts/tevm-monorepo/blob/main/packages/actions/src/Script/scriptHandler.js#L12) diff --git a/packages/actions/docs/functions/setAccountHandler.md b/packages/actions/docs/functions/setAccountHandler.md index af3bf93f71..b5d549c403 100644 --- a/packages/actions/docs/functions/setAccountHandler.md +++ b/packages/actions/docs/functions/setAccountHandler.md @@ -8,8 +8,6 @@ > **setAccountHandler**(`client`, `options`?): [`SetAccountHandler`](../type-aliases/SetAccountHandler.md) -Creates an SetAccountHandler for handling account params with Ethereumjs EVM - ## Parameters • **client**: `TevmNode`\<`"fork"` \| `"normal"`, `object`\> diff --git a/packages/actions/docs/functions/traceCallHandler.md b/packages/actions/docs/functions/traceCallHandler.md index 402014b7d4..537c3fff38 100644 --- a/packages/actions/docs/functions/traceCallHandler.md +++ b/packages/actions/docs/functions/traceCallHandler.md @@ -8,8 +8,6 @@ > **traceCallHandler**(`client`): [`DebugTraceCallHandler`](../type-aliases/DebugTraceCallHandler.md) -Returns a trace of an eth_call within the context of the given block execution using the final state of the parent block - ## Parameters • **client**: `TevmNode`\<`"fork"` \| `"normal"`, `object`\> diff --git a/packages/actions/docs/functions/validateLoadStateParams.md b/packages/actions/docs/functions/validateLoadStateParams.md index 6d2729fa67..af43274ac1 100644 --- a/packages/actions/docs/functions/validateLoadStateParams.md +++ b/packages/actions/docs/functions/validateLoadStateParams.md @@ -8,8 +8,6 @@ > **validateLoadStateParams**(`action`): `InvalidRequestError`[] -Validates the parameters for loading the state into the VM. - ## Parameters • **action**: [`LoadStateParams`](../type-aliases/LoadStateParams.md)\<`boolean`\> @@ -22,18 +20,6 @@ The parameters for the load state action. - An array of errors, if any. -## Example - -```typescript -import { validateLoadStateParams } from 'tevm/actions' - -const params = { state: {...} } -const errors = validateLoadStateParams(params) -if (errors.length > 0) { - console.error('Validation errors:', errors) -} -``` - ## Defined in [packages/actions/src/LoadState/validateLoadStateParams.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/actions/src/LoadState/validateLoadStateParams.js#L26) diff --git a/packages/actions/docs/functions/validateScriptParams.md b/packages/actions/docs/functions/validateScriptParams.md index c609fb8f36..d2df024c45 100644 --- a/packages/actions/docs/functions/validateScriptParams.md +++ b/packages/actions/docs/functions/validateScriptParams.md @@ -16,8 +16,6 @@ [`ValidateScriptParamsError`](../type-aliases/ValidateScriptParamsError.md)[] -## Deprecated - ## Defined in [packages/actions/src/Script/validateScriptParams.js:14](https://github.com/evmts/tevm-monorepo/blob/main/packages/actions/src/Script/validateScriptParams.js#L14) diff --git a/packages/actions/docs/globals.md b/packages/actions/docs/globals.md index 4109ba81e6..2a3e7dc8e5 100644 --- a/packages/actions/docs/globals.md +++ b/packages/actions/docs/globals.md @@ -167,6 +167,7 @@ - [EthNewBlockFilterHandler](type-aliases/EthNewBlockFilterHandler.md) - [EthNewBlockFilterParams](type-aliases/EthNewBlockFilterParams.md) - [EthNewBlockFilterResult](type-aliases/EthNewBlockFilterResult.md) +- [EthNewFilterError](type-aliases/EthNewFilterError.md) - [EthNewFilterHandler](type-aliases/EthNewFilterHandler.md) - [EthNewFilterParams](type-aliases/EthNewFilterParams.md) - [EthNewFilterResult](type-aliases/EthNewFilterResult.md) @@ -280,6 +281,7 @@ - [ethCallHandler](functions/ethCallHandler.md) - [ethGetLogsHandler](functions/ethGetLogsHandler.md) - [ethGetTransactionReceiptHandler](functions/ethGetTransactionReceiptHandler.md) +- [ethNewFilterHandler](functions/ethNewFilterHandler.md) - [ethSendRawTransactionHandler](functions/ethSendRawTransactionHandler.md) - [ethSendTransactionHandler](functions/ethSendTransactionHandler.md) - [ethSignHandler](functions/ethSignHandler.md) diff --git a/packages/actions/docs/type-aliases/BaseCallParams.md b/packages/actions/docs/type-aliases/BaseCallParams.md index 6b42ae75d6..a472e8a532 100644 --- a/packages/actions/docs/type-aliases/BaseCallParams.md +++ b/packages/actions/docs/type-aliases/BaseCallParams.md @@ -15,6 +15,31 @@ This type is used as the base for various call-like parameter types: - [DeployParams](https://tevm.sh/reference/tevm/actions/type-aliases/deployparams-1/) - [ScriptParams](https://tevm.sh/reference/tevm/actions/type-aliases/scriptparams-1/) +## Example + +```typescript +import { BaseCallParams } from 'tevm' + +const params: BaseCallParams = { + createTrace: true, + createAccessList: true, + createTransaction: 'on-success', + blockTag: 'latest', + skipBalance: true, + gas: 1000000n, + gasPrice: 1n, + maxFeePerGas: 1n, + maxPriorityFeePerGas: 1n, + gasRefund: 0n, + from: '0x123...', + origin: '0x123...', + caller: '0x123...', + value: 0n, + depth: 0, + to: '0x123...', +} +``` + ## Type declaration ### blobVersionedHashes? @@ -226,31 +251,6 @@ The value in ether that is being sent to the `to` address. Defaults to `0`. • **TThrowOnFail** *extends* `boolean` = `boolean` -## Example - -```typescript -import { BaseCallParams } from 'tevm' - -const params: BaseCallParams = { - createTrace: true, - createAccessList: true, - createTransaction: 'on-success', - blockTag: 'latest', - skipBalance: true, - gas: 1000000n, - gasPrice: 1n, - maxFeePerGas: 1n, - maxPriorityFeePerGas: 1n, - gasRefund: 0n, - from: '0x123...', - origin: '0x123...', - caller: '0x123...', - value: 0n, - depth: 0, - to: '0x123...', -} -``` - ## Defined in [packages/actions/src/BaseCall/BaseCallParams.ts:37](https://github.com/evmts/tevm-monorepo/blob/main/packages/actions/src/BaseCall/BaseCallParams.ts#L37) diff --git a/packages/actions/docs/type-aliases/CallParams.md b/packages/actions/docs/type-aliases/CallParams.md index 75e698ebae..5aa8d797d1 100644 --- a/packages/actions/docs/type-aliases/CallParams.md +++ b/packages/actions/docs/type-aliases/CallParams.md @@ -11,6 +11,32 @@ TEVM parameters to execute a call on the VM. `Call` is the lowest level method to interact with the VM, and other methods such as `contract` and `script` use `call` under the hood. +## Example + +```typescript +import { createClient } from 'viem' +import { createTevmTransport, tevmCall } from 'tevm' +import { optimism } from 'tevm/common' + +const client = createClient({ + transport: createTevmTransport({}), + chain: optimism, +}) + +const callParams = { + data: '0x...', + bytecode: '0x...', + gasLimit: 420n, +} + +await tevmCall(client, callParams) +``` + +## See + + - [BaseCallParams](https://tevm.sh/reference/tevm/actions/type-aliases/basecallparams-1/) + - [tevmCall](https://tevm.sh/reference/tevm/memory-client/functions/tevmCall/) + ## Type declaration ### code? @@ -129,32 +155,6 @@ await tevmCall(client, callParams) • **TThrowOnFail** *extends* `boolean` = `boolean` -## Example - -```typescript -import { createClient } from 'viem' -import { createTevmTransport, tevmCall } from 'tevm' -import { optimism } from 'tevm/common' - -const client = createClient({ - transport: createTevmTransport({}), - chain: optimism, -}) - -const callParams = { - data: '0x...', - bytecode: '0x...', - gasLimit: 420n, -} - -await tevmCall(client, callParams) -``` - -## See - - - [BaseCallParams](https://tevm.sh/reference/tevm/actions/type-aliases/basecallparams-1/) - - [tevmCall](https://tevm.sh/reference/tevm/memory-client/functions/tevmCall/) - ## Defined in [packages/actions/src/Call/CallParams.ts:31](https://github.com/evmts/tevm-monorepo/blob/main/packages/actions/src/Call/CallParams.ts#L31) diff --git a/packages/actions/docs/type-aliases/CallResult.md b/packages/actions/docs/type-aliases/CallResult.md index 95e0d62953..4e1a1ebefa 100644 --- a/packages/actions/docs/type-aliases/CallResult.md +++ b/packages/actions/docs/type-aliases/CallResult.md @@ -10,6 +10,33 @@ Result of a TEVM VM Call method. +## Example + +```typescript +import { createClient } from 'viem' +import { createTevmTransport, tevmCall } from 'tevm' +import { optimism } from 'tevm/common' +import { CallResult } from 'tevm/actions' + +const client = createClient({ + transport: createTevmTransport({}), + chain: optimism, +}) + +const callParams = { + data: '0x...', + bytecode: '0x...', + gasLimit: 420n, +} + +const result: CallResult = await tevmCall(client, callParams) +console.log(result) +``` + +## See + +[tevmCall](https://tevm.sh/reference/tevm/memory-client/functions/tevmCall/) + ## Type Parameters • **ErrorType** = [`TevmCallError`](TevmCallError.md) @@ -218,33 +245,6 @@ if (txHash) { } ``` -## Example - -```typescript -import { createClient } from 'viem' -import { createTevmTransport, tevmCall } from 'tevm' -import { optimism } from 'tevm/common' -import { CallResult } from 'tevm/actions' - -const client = createClient({ - transport: createTevmTransport({}), - chain: optimism, -}) - -const callParams = { - data: '0x...', - bytecode: '0x...', - gasLimit: 420n, -} - -const result: CallResult = await tevmCall(client, callParams) -console.log(result) -``` - -## See - -[tevmCall](https://tevm.sh/reference/tevm/memory-client/functions/tevmCall/) - ## Defined in [packages/actions/src/Call/CallResult.ts:32](https://github.com/evmts/tevm-monorepo/blob/main/packages/actions/src/Call/CallResult.ts#L32) diff --git a/packages/actions/docs/type-aliases/ContractParams.md b/packages/actions/docs/type-aliases/ContractParams.md index 4ad2baf027..3cbc003572 100644 --- a/packages/actions/docs/type-aliases/ContractParams.md +++ b/packages/actions/docs/type-aliases/ContractParams.md @@ -12,20 +12,6 @@ Parameters to execute a call on a contract with TEVM. This type combines the parameters required for encoding function data with additional call parameters. -## Type Parameters - -• **TAbi** *extends* [`Abi`](Abi.md) \| readonly `unknown`[] = [`Abi`](Abi.md) - -The ABI type. - -• **TFunctionName** *extends* `ContractFunctionName`\<`TAbi`\> = `ContractFunctionName`\<`TAbi`\> - -The function name type from the ABI. - -• **TThrowOnFail** *extends* `boolean` = `boolean` - -The type indicating whether to throw on failure. - ## Example ```typescript @@ -57,6 +43,20 @@ console.log(res) - [BaseCallParams](BaseCallParams.md) - EncodeFunctionDataParameters +## Type Parameters + +• **TAbi** *extends* [`Abi`](Abi.md) \| readonly `unknown`[] = [`Abi`](Abi.md) + +The ABI type. + +• **TFunctionName** *extends* `ContractFunctionName`\<`TAbi`\> = `ContractFunctionName`\<`TAbi`\> + +The function name type from the ABI. + +• **TThrowOnFail** *extends* `boolean` = `boolean` + +The type indicating whether to throw on failure. + ## Defined in [packages/actions/src/Contract/ContractParams.ts:42](https://github.com/evmts/tevm-monorepo/blob/main/packages/actions/src/Contract/ContractParams.ts#L42) diff --git a/packages/actions/docs/type-aliases/ContractResult.md b/packages/actions/docs/type-aliases/ContractResult.md index 93b2c2ee90..ce788c7f36 100644 --- a/packages/actions/docs/type-aliases/ContractResult.md +++ b/packages/actions/docs/type-aliases/ContractResult.md @@ -12,20 +12,6 @@ The result type for a TEVM contract call. This type extends the `CallResult` type with additional contract-specific fields, and it supports both success and error states. -## Type Parameters - -• **TAbi** *extends* [`Abi`](Abi.md) \| readonly `unknown`[] = [`Abi`](Abi.md) - -The ABI type. - -• **TFunctionName** *extends* `ContractFunctionName`\<`TAbi`\> = `ContractFunctionName`\<`TAbi`\> - -The function name type from the ABI. - -• **ErrorType** = [`TevmContractError`](TevmContractError.md) - -The error type. - ## Example ```typescript @@ -60,6 +46,20 @@ if (result.errors) { [CallResult](CallResult.md) +## Type Parameters + +• **TAbi** *extends* [`Abi`](Abi.md) \| readonly `unknown`[] = [`Abi`](Abi.md) + +The ABI type. + +• **TFunctionName** *extends* `ContractFunctionName`\<`TAbi`\> = `ContractFunctionName`\<`TAbi`\> + +The function name type from the ABI. + +• **ErrorType** = [`TevmContractError`](TevmContractError.md) + +The error type. + ## Defined in [packages/actions/src/Contract/ContractResult.ts:46](https://github.com/evmts/tevm-monorepo/blob/main/packages/actions/src/Contract/ContractResult.ts#L46) diff --git a/packages/actions/docs/type-aliases/DeployParams.md b/packages/actions/docs/type-aliases/DeployParams.md index b3ea32b3b0..39409a546e 100644 --- a/packages/actions/docs/type-aliases/DeployParams.md +++ b/packages/actions/docs/type-aliases/DeployParams.md @@ -15,32 +15,6 @@ is set to true, because deployments result in state changes that need to be mine The `salt` parameter supports the use of CREATE2, allowing for deterministic address deployment. -## Type declaration - -### salt? - -> `readonly` `optional` **salt**: [`Hex`](Hex.md) - -An optional CREATE2 salt, if deploying with CREATE2 for a predictable contract address. - -## Type Parameters - -• **TThrowOnFail** *extends* `boolean` = `boolean` - -Indicates whether the function should throw on failure. - -• **TAbi** *extends* `Abi` \| readonly `unknown`[] = `Abi` - -The ABI type, typically including constructor definitions. - -• **THasConstructor** = `TAbi` *extends* `Abi` ? `Abi` *extends* `TAbi` ? `true` : [`Extract`\<`TAbi`\[`number`\], `object`\>] *extends* [`never`] ? `false` : `true` : `true` - -Determines whether the ABI includes a constructor. - -• **TAllArgs** = `ContractConstructorArgs`\<`TAbi`\> - -Types of the constructor arguments for the deployment. - ## Example ```typescript @@ -71,6 +45,32 @@ const result = await deployHandler(client)(deployParams) console.log('Deployed contract address:', result.createdAddress) ``` +## Type declaration + +### salt? + +> `readonly` `optional` **salt**: [`Hex`](Hex.md) + +An optional CREATE2 salt, if deploying with CREATE2 for a predictable contract address. + +## Type Parameters + +• **TThrowOnFail** *extends* `boolean` = `boolean` + +Indicates whether the function should throw on failure. + +• **TAbi** *extends* `Abi` \| readonly `unknown`[] = `Abi` + +The ABI type, typically including constructor definitions. + +• **THasConstructor** = `TAbi` *extends* `Abi` ? `Abi` *extends* `TAbi` ? `true` : [`Extract`\<`TAbi`\[`number`\], `object`\>] *extends* [`never`] ? `false` : `true` : `true` + +Determines whether the ABI includes a constructor. + +• **TAllArgs** = `ContractConstructorArgs`\<`TAbi`\> + +Types of the constructor arguments for the deployment. + ## Defined in [packages/actions/src/Deploy/DeployParams.ts:47](https://github.com/evmts/tevm-monorepo/blob/main/packages/actions/src/Deploy/DeployParams.ts#L47) diff --git a/packages/actions/docs/type-aliases/EthNewFilterError.md b/packages/actions/docs/type-aliases/EthNewFilterError.md new file mode 100644 index 0000000000..48967d6a53 --- /dev/null +++ b/packages/actions/docs/type-aliases/EthNewFilterError.md @@ -0,0 +1,15 @@ +[**@tevm/actions**](../README.md) • **Docs** + +*** + +[@tevm/actions](../globals.md) / EthNewFilterError + +# Type Alias: EthNewFilterError + +> **EthNewFilterError**\<\>: `UnknownBlockError` \| `InvalidBlockError` + +## Type Parameters + +## Defined in + +[packages/actions/src/eth/ethNewFilterHandler.js:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/actions/src/eth/ethNewFilterHandler.js#L8) diff --git a/packages/actions/docs/type-aliases/GetAccountHandler.md b/packages/actions/docs/type-aliases/GetAccountHandler.md index 291f793a88..e34b1d5382 100644 --- a/packages/actions/docs/type-aliases/GetAccountHandler.md +++ b/packages/actions/docs/type-aliases/GetAccountHandler.md @@ -11,14 +11,6 @@ Gets the state of a specific Ethereum address. This handler is for use with a low-level TEVM `TevmNode`, unlike `tevmGetAccount`. -## Parameters - -• **params**: [`GetAccountParams`](GetAccountParams.md) - -## Returns - -`Promise`\<[`GetAccountResult`](GetAccountResult.md)\> - ## Example ```typescript @@ -34,6 +26,14 @@ console.log(res.nonce) console.log(res.balance) ``` +## Parameters + +• **params**: [`GetAccountParams`](GetAccountParams.md) + +## Returns + +`Promise`\<[`GetAccountResult`](GetAccountResult.md)\> + ## Defined in [packages/actions/src/GetAccount/GetAccountHandlerType.ts:21](https://github.com/evmts/tevm-monorepo/blob/main/packages/actions/src/GetAccount/GetAccountHandlerType.ts#L21) diff --git a/packages/actions/docs/type-aliases/GetAccountParams.md b/packages/actions/docs/type-aliases/GetAccountParams.md index 6e8c4636a2..17f7be6fab 100644 --- a/packages/actions/docs/type-aliases/GetAccountParams.md +++ b/packages/actions/docs/type-aliases/GetAccountParams.md @@ -10,6 +10,14 @@ Tevm params to get an account +## Example + +```ts +const getAccountParams: import('@tevm/api').GetAccountParams = { + address: '0x...', +} +``` + ## Type declaration ### address @@ -41,14 +49,6 @@ Be aware that this can be very expensive if a contract has a lot of storage • **TThrowOnFail** *extends* `boolean` = `boolean` -## Example - -```ts -const getAccountParams: import('@tevm/api').GetAccountParams = { - address: '0x...', -} -``` - ## Defined in [packages/actions/src/GetAccount/GetAccountParams.ts:11](https://github.com/evmts/tevm-monorepo/blob/main/packages/actions/src/GetAccount/GetAccountParams.ts#L11) diff --git a/packages/actions/docs/type-aliases/LoadStateParams.md b/packages/actions/docs/type-aliases/LoadStateParams.md index eca5f20c30..b0e22eab2e 100644 --- a/packages/actions/docs/type-aliases/LoadStateParams.md +++ b/packages/actions/docs/type-aliases/LoadStateParams.md @@ -12,20 +12,6 @@ Parameters for the `tevmLoadState` method. This method takes a TevmState object and loads it into the VM state. -## Type declaration - -### state - -> `readonly` **state**: `TevmState` - -The TEVM state object to load. - -## Type Parameters - -• **TThrowOnFail** *extends* `boolean` = `boolean` - -Optional parameter to throw an error on failure. - ## Example ```typescript @@ -44,6 +30,20 @@ await loadState({ state }) The TEVM state object to load. +## Type declaration + +### state + +> `readonly` **state**: `TevmState` + +The TEVM state object to load. + +## Type Parameters + +• **TThrowOnFail** *extends* `boolean` = `boolean` + +Optional parameter to throw an error on failure. + ## Defined in [packages/actions/src/LoadState/LoadStateParams.ts:25](https://github.com/evmts/tevm-monorepo/blob/main/packages/actions/src/LoadState/LoadStateParams.ts#L25) diff --git a/packages/actions/docs/type-aliases/LoadStateResult.md b/packages/actions/docs/type-aliases/LoadStateResult.md index dc72bf3e2c..d2d1b48b46 100644 --- a/packages/actions/docs/type-aliases/LoadStateResult.md +++ b/packages/actions/docs/type-aliases/LoadStateResult.md @@ -12,18 +12,6 @@ Result of the `tevmLoadState` method. This type represents the result returned by the `tevmLoadState` method. It includes any errors that might have occurred during the state loading process. -## Type Parameters - -• **ErrorType** = [`TevmLoadStateError`](TevmLoadStateError.md) - -## Type declaration - -### errors? - -> `optional` **errors**: `ErrorType`[] - -Description of the exception, if any occurred. - ## Example ```typescript @@ -45,6 +33,18 @@ if (result.errors) { [TevmLoadStateError](TevmLoadStateError.md) +## Type Parameters + +• **ErrorType** = [`TevmLoadStateError`](TevmLoadStateError.md) + +## Type declaration + +### errors? + +> `optional` **errors**: `ErrorType`[] + +Description of the exception, if any occurred. + ## Defined in [packages/actions/src/LoadState/LoadStateResult.ts:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/actions/src/LoadState/LoadStateResult.ts#L26) diff --git a/packages/actions/docs/type-aliases/MineParams.md b/packages/actions/docs/type-aliases/MineParams.md index 3b20e38b21..2ecc1e98d8 100644 --- a/packages/actions/docs/type-aliases/MineParams.md +++ b/packages/actions/docs/type-aliases/MineParams.md @@ -10,6 +10,22 @@ Tevm params to mine one or more blocks. +## Example + +```typescript +const mineParams: import('@tevm/actions').MineParams = { + blockCount: 5, +} +``` + +## Param + +Number of blocks to mine. Defaults to 1. + +## Param + +Interval between block timestamps in seconds. Defaults to 1. + ## Type declaration ### blockCount? @@ -28,22 +44,6 @@ Interval between block timestamps. Defaults to 1. • **TThrowOnFail** *extends* `boolean` = `boolean` -## Example - -```typescript -const mineParams: import('@tevm/actions').MineParams = { - blockCount: 5, -} -``` - -## Param - -Number of blocks to mine. Defaults to 1. - -## Param - -Interval between block timestamps in seconds. Defaults to 1. - ## Defined in [packages/actions/src/Mine/MineParams.ts:15](https://github.com/evmts/tevm-monorepo/blob/main/packages/actions/src/Mine/MineParams.ts#L15) diff --git a/packages/actions/docs/type-aliases/ScriptHandler.md b/packages/actions/docs/type-aliases/ScriptHandler.md index 0edd89fb12..9322ab0ab4 100644 --- a/packages/actions/docs/type-aliases/ScriptHandler.md +++ b/packages/actions/docs/type-aliases/ScriptHandler.md @@ -8,20 +8,6 @@ > **ScriptHandler**: \<`TAbi`, `TFunctionName`\>(`params`) => `Promise`\<[`ScriptResult`](ScriptResult.md)\<`TAbi`, `TFunctionName`\>\> -## Type Parameters - -• **TAbi** *extends* `Abi` \| readonly `unknown`[] = `Abi` - -• **TFunctionName** *extends* `ContractFunctionName`\<`TAbi`\> = `ContractFunctionName`\<`TAbi`\> - -## Parameters - -• **params**: [`ScriptParams`](ScriptParams.md)\<`TAbi`, `TFunctionName`\> - -## Returns - -`Promise`\<[`ScriptResult`](ScriptResult.md)\<`TAbi`, `TFunctionName`\>\> - ## Deprecated Can use `ContractHandler` instead @@ -49,6 +35,20 @@ const res = tevm.script( ) ``` +## Type Parameters + +• **TAbi** *extends* `Abi` \| readonly `unknown`[] = `Abi` + +• **TFunctionName** *extends* `ContractFunctionName`\<`TAbi`\> = `ContractFunctionName`\<`TAbi`\> + +## Parameters + +• **params**: [`ScriptParams`](ScriptParams.md)\<`TAbi`, `TFunctionName`\> + +## Returns + +`Promise`\<[`ScriptResult`](ScriptResult.md)\<`TAbi`, `TFunctionName`\>\> + ## Defined in [packages/actions/src/Script/ScriptHandlerType.ts:32](https://github.com/evmts/tevm-monorepo/blob/main/packages/actions/src/Script/ScriptHandlerType.ts#L32) diff --git a/packages/actions/docs/type-aliases/ScriptParams.md b/packages/actions/docs/type-aliases/ScriptParams.md index 18010af54d..c9190dbfbf 100644 --- a/packages/actions/docs/type-aliases/ScriptParams.md +++ b/packages/actions/docs/type-aliases/ScriptParams.md @@ -8,6 +8,11 @@ > **ScriptParams**\<`TAbi`, `TFunctionName`, `TThrowOnFail`\>: `EncodeFunctionDataParameters`\<`TAbi`, `TFunctionName`\> & [`BaseCallParams`](BaseCallParams.md)\<`TThrowOnFail`\> & `object` +## Deprecated + +Can use `ContraactParams` instead +Tevm params for deploying and running a script + ## Type declaration ### ~~deployedBytecode~~ @@ -24,11 +29,6 @@ The EVM code to run. • **TThrowOnFail** *extends* `boolean` = `boolean` -## Deprecated - -Can use `ContraactParams` instead -Tevm params for deploying and running a script - ## Defined in [packages/actions/src/Script/ScriptParams.ts:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/actions/src/Script/ScriptParams.ts#L9) diff --git a/packages/actions/docs/type-aliases/ScriptResult.md b/packages/actions/docs/type-aliases/ScriptResult.md index 5b9b02a037..3bde7e8ecd 100644 --- a/packages/actions/docs/type-aliases/ScriptResult.md +++ b/packages/actions/docs/type-aliases/ScriptResult.md @@ -8,6 +8,10 @@ > **ScriptResult**\<`TAbi`, `TFunctionName`, `TErrorType`\>: [`ContractResult`](ContractResult.md)\<`TAbi`, `TFunctionName`, `TErrorType`\> +## Deprecated + +Can use `ContractResult` instead + ## Type Parameters • **TAbi** *extends* [`Abi`](Abi.md) \| readonly `unknown`[] = [`Abi`](Abi.md) @@ -16,10 +20,6 @@ • **TErrorType** = [`TevmScriptError`](TevmScriptError.md) -## Deprecated - -Can use `ContractResult` instead - ## Defined in [packages/actions/src/Script/ScriptResult.ts:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/actions/src/Script/ScriptResult.ts#L9) diff --git a/packages/actions/docs/type-aliases/SetAccountHandler.md b/packages/actions/docs/type-aliases/SetAccountHandler.md index 804aacee41..ef873e2906 100644 --- a/packages/actions/docs/type-aliases/SetAccountHandler.md +++ b/packages/actions/docs/type-aliases/SetAccountHandler.md @@ -10,14 +10,6 @@ Sets the state of a specific ethereum address -## Parameters - -• **params**: [`SetAccountParams`](SetAccountParams.md) - -## Returns - -`Promise`\<[`SetAccountResult`](SetAccountResult.md)\> - ## Example ```ts @@ -30,6 +22,14 @@ await tevm.setAccount({ }) ``` +## Parameters + +• **params**: [`SetAccountParams`](SetAccountParams.md) + +## Returns + +`Promise`\<[`SetAccountResult`](SetAccountResult.md)\> + ## Defined in [packages/actions/src/SetAccount/SetAccountHandlerType.ts:15](https://github.com/evmts/tevm-monorepo/blob/main/packages/actions/src/SetAccount/SetAccountHandlerType.ts#L15) diff --git a/packages/actions/docs/type-aliases/SetAccountParams.md b/packages/actions/docs/type-aliases/SetAccountParams.md index 1006ff3f3b..a34caa520a 100644 --- a/packages/actions/docs/type-aliases/SetAccountParams.md +++ b/packages/actions/docs/type-aliases/SetAccountParams.md @@ -11,6 +11,18 @@ Tevm params to set an account in the vm state all fields are optional except address +## Example + +```ts +const accountParams: import('tevm/api').SetAccountParams = { + account: '0x...', + nonce: 5n, + balance: 9000000000000n, + storageRoot: '0x....', + deployedBytecode: '0x....' +} +``` + ## Type declaration ### address @@ -59,18 +71,6 @@ Storage root to set account to • **TThrowOnFail** *extends* `boolean` = `boolean` -## Example - -```ts -const accountParams: import('tevm/api').SetAccountParams = { - account: '0x...', - nonce: 5n, - balance: 9000000000000n, - storageRoot: '0x....', - deployedBytecode: '0x....' -} -``` - ## Defined in [packages/actions/src/SetAccount/SetAccountParams.ts:17](https://github.com/evmts/tevm-monorepo/blob/main/packages/actions/src/SetAccount/SetAccountParams.ts#L17) diff --git a/packages/actions/docs/type-aliases/StateOverrideSet.md b/packages/actions/docs/type-aliases/StateOverrideSet.md index e65fb716c3..ba525769da 100644 --- a/packages/actions/docs/type-aliases/StateOverrideSet.md +++ b/packages/actions/docs/type-aliases/StateOverrideSet.md @@ -17,10 +17,6 @@ It can be used by DApps to reduce the amount of contract code needed to be deplo It can be used for smart contract analysis by extending the code deployed on chain with custom methods and invoking them. This avoids having to download and reconstruct the entire state in a sandbox to run custom code against. It can be used to debug smart contracts in an already deployed large suite of contracts by selectively overriding some code or state and seeing how execution changes. Specialized tooling will probably be necessary. -## Index Signature - - \[`address`: `Address`\]: `object` - ## Example ```ts @@ -37,6 +33,10 @@ It can be used to debug smart contracts in an already deployed large suite of co } ``` +## Index Signature + + \[`address`: `Address`\]: `object` + ## Defined in [packages/actions/src/common/StateOverrideSet.ts:29](https://github.com/evmts/tevm-monorepo/blob/main/packages/actions/src/common/StateOverrideSet.ts#L29) diff --git a/packages/actions/docs/variables/testAccounts.md b/packages/actions/docs/variables/testAccounts.md index 2af13eec75..c02f628d4d 100644 --- a/packages/actions/docs/variables/testAccounts.md +++ b/packages/actions/docs/variables/testAccounts.md @@ -6,7 +6,7 @@ # Variable: testAccounts -> `const` **testAccounts**: [`HDAccount`, `HDAccount`, `HDAccount`, `HDAccount`, `HDAccount`, `HDAccount`, `HDAccount`, `HDAccount`, `HDAccount`, `HDAccount`] +> `const` **testAccounts**: [`object`, `object`, `object`] ## Defined in diff --git a/packages/actions/package.json b/packages/actions/package.json index b9feca992b..7cc2a69f43 100644 --- a/packages/actions/package.json +++ b/packages/actions/package.json @@ -21,6 +21,7 @@ "contributors": [ "Will Cory " ], + "sideEffects": false, "type": "module", "exports": { "./package.json": "./package.json", @@ -90,6 +91,5 @@ }, "publishConfig": { "access": "public" - }, - "sideEffects": false + } } \ No newline at end of file diff --git a/packages/actions/src/Contract/createScript.spec.ts b/packages/actions/src/Contract/createScript.spec.ts index ba56bea19d..bfb9d6d03f 100644 --- a/packages/actions/src/Contract/createScript.spec.ts +++ b/packages/actions/src/Contract/createScript.spec.ts @@ -3,7 +3,7 @@ import { Block } from '@tevm/block' import { EvmError, EvmErrorMessage } from '@tevm/evm' import { createTevmNode } from '@tevm/node' import { TestERC20 } from '@tevm/test-utils' -import { PREFUNDED_ACCOUNTS, getAddress } from '@tevm/utils' +import { PREFUNDED_ACCOUNTS, encodeDeployData, getAddress } from '@tevm/utils' import { describe, expect, it } from 'vitest' import { getAccountHandler } from '../GetAccount/getAccountHandler.js' import { setAccountHandler } from '../SetAccount/setAccountHandler.js' @@ -11,7 +11,7 @@ import { createScript } from './createScript.js' describe('createScript', () => { const client = createTevmNode() - const validCode = TestERC20.script({ constructorArgs: ['Name', 'Symbol'] }).code + const validCode = encodeDeployData({ args: ['Name', 'Symbol'], ...TestERC20 }) const invalidCode = '0x6969696969' // invalid EVM bytecode const validDeployedBytecode = TestERC20.deployedBytecode diff --git a/packages/address/docs/functions/create2ContractAddress.md b/packages/address/docs/functions/create2ContractAddress.md index 8fa9ede28a..4221017499 100644 --- a/packages/address/docs/functions/create2ContractAddress.md +++ b/packages/address/docs/functions/create2ContractAddress.md @@ -20,12 +20,14 @@ A 32-byte salt value as a hex string • **code**: \`0x$\{string\}\` -THe creation code of the contract +The creation code of the contract ## Returns [`Address`](../classes/Address.md) +The generated contract address + ## Defined in -[packages/address/src/create2ContractAddress.js:18](https://github.com/evmts/tevm-monorepo/blob/main/packages/address/src/create2ContractAddress.js#L18) +[packages/address/src/create2ContractAddress.js:19](https://github.com/evmts/tevm-monorepo/blob/main/packages/address/src/create2ContractAddress.js#L19) diff --git a/packages/address/package.json b/packages/address/package.json index 463f22efe3..fccb824c48 100644 --- a/packages/address/package.json +++ b/packages/address/package.json @@ -19,6 +19,7 @@ "contributors": [ "Will Cory " ], + "sideEffects": false, "type": "module", "exports": { "./package.json": "./package.json", @@ -74,6 +75,5 @@ }, "publishConfig": { "access": "public" - }, - "sideEffects": false + } } \ No newline at end of file diff --git a/packages/block/docs/README.md b/packages/block/docs/README.md index 62d97e4516..ffc519b796 100644 --- a/packages/block/docs/README.md +++ b/packages/block/docs/README.md @@ -36,4 +36,4 @@ Some files are adapted from [ethereumjs](https://github.com/ethereumjs/ethereumj ## License 📄 - + diff --git a/packages/block/docs/_media/LICENSE b/packages/block/docs/_media/LICENSE deleted file mode 100644 index b5a4fa7a69..0000000000 --- a/packages/block/docs/_media/LICENSE +++ /dev/null @@ -1,22 +0,0 @@ -(The MIT License) - -Copyright 2020-2022 - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/packages/block/docs/classes/Block.md b/packages/block/docs/classes/Block.md index c953dd288c..e17140b541 100644 --- a/packages/block/docs/classes/Block.md +++ b/packages/block/docs/classes/Block.md @@ -39,7 +39,7 @@ Use the static factory methods to assist in creating a Block object from varying #### Defined in -[block.ts:334](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L334) +[packages/block/src/block.ts:334](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L334) ## Properties @@ -61,17 +61,129 @@ Use the static factory methods to assist in creating a Block object from varying #### Defined in -[block.ts:55](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L55) +[packages/block/src/block.ts:55](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L55) *** ### common -> `readonly` **common**: `Common` +> `readonly` **common**: `object` + +#### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +##### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +#### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +#### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +#### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +#### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +#### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +#### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +##### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +#### ethjsCommon + +> **ethjsCommon**: `Common` + +#### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +#### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +#### id + +> **id**: `number` + +ID in number form + +#### name + +> **name**: `string` + +Human-readable name + +#### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +#### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +##### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +#### rpcUrls.default + +> **default**: `ChainRpcUrls` + +#### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +#### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +#### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks #### Defined in -[block.ts:45](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L45) +[packages/block/src/block.ts:45](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L45) *** @@ -85,7 +197,7 @@ and will not lead to execution of the block via vm with verkle stateless manager #### Defined in -[block.ts:53](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L53) +[packages/block/src/block.ts:53](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L53) *** @@ -95,7 +207,7 @@ and will not lead to execution of the block via vm with verkle stateless manager #### Defined in -[block.ts:40](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L40) +[packages/block/src/block.ts:40](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L40) *** @@ -113,7 +225,7 @@ and will not lead to execution of the block via vm with verkle stateless manager #### Defined in -[block.ts:46](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L46) +[packages/block/src/block.ts:46](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L46) *** @@ -123,7 +235,7 @@ and will not lead to execution of the block via vm with verkle stateless manager #### Defined in -[block.ts:44](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L44) +[packages/block/src/block.ts:44](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L44) *** @@ -133,7 +245,7 @@ and will not lead to execution of the block via vm with verkle stateless manager #### Defined in -[block.ts:41](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L41) +[packages/block/src/block.ts:41](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L41) *** @@ -143,7 +255,7 @@ and will not lead to execution of the block via vm with verkle stateless manager #### Defined in -[block.ts:42](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L42) +[packages/block/src/block.ts:42](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L42) *** @@ -153,7 +265,7 @@ and will not lead to execution of the block via vm with verkle stateless manager #### Defined in -[block.ts:43](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L43) +[packages/block/src/block.ts:43](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L43) ## Methods @@ -169,7 +281,7 @@ Return a compact error string representation of the object #### Defined in -[block.ts:801](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L801) +[packages/block/src/block.ts:801](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L801) *** @@ -191,7 +303,7 @@ the parent of this `Block` #### Defined in -[block.ts:735](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L735) +[packages/block/src/block.ts:735](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L735) *** @@ -207,7 +319,7 @@ Generates transaction trie for validation. #### Defined in -[block.ts:455](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L455) +[packages/block/src/block.ts:455](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L455) *** @@ -225,7 +337,7 @@ an array of error strings #### Defined in -[block.ts:501](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L501) +[packages/block/src/block.ts:501](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L501) *** @@ -241,7 +353,7 @@ Returns the hash of the block. #### Defined in -[block.ts:434](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L434) +[packages/block/src/block.ts:434](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L434) *** @@ -257,7 +369,7 @@ Determines if this block is the genesis block. #### Defined in -[block.ts:441](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L441) +[packages/block/src/block.ts:441](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L441) *** @@ -273,7 +385,7 @@ Returns a Array of the raw Bytes Arrays of this block, in order. #### Defined in -[block.ts:412](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L412) +[packages/block/src/block.ts:412](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L412) *** @@ -287,7 +399,7 @@ Returns a Array of the raw Bytes Arrays of this block, in order. #### Defined in -[block.ts:478](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L478) +[packages/block/src/block.ts:478](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L478) *** @@ -303,7 +415,7 @@ Returns the rlp encoding of the block. #### Defined in -[block.ts:448](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L448) +[packages/block/src/block.ts:448](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L448) *** @@ -317,7 +429,7 @@ Returns the rlp encoding of the block. #### Defined in -[block.ts:767](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L767) +[packages/block/src/block.ts:767](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L767) *** @@ -333,7 +445,7 @@ Returns the block in JSON format. #### Defined in -[block.ts:752](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L752) +[packages/block/src/block.ts:752](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L752) *** @@ -351,7 +463,7 @@ True if all transactions are valid, false otherwise #### Defined in -[block.ts:551](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L551) +[packages/block/src/block.ts:551](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L551) *** @@ -370,7 +482,7 @@ True if the transaction trie is valid, false otherwise #### Defined in -[block.ts:464](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L464) +[packages/block/src/block.ts:464](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L464) *** @@ -388,7 +500,7 @@ true if the uncle's hash is valid, false otherwise. #### Defined in -[block.ts:668](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L668) +[packages/block/src/block.ts:668](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L668) *** @@ -412,7 +524,7 @@ header of parent block #### Defined in -[block.ts:622](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L622) +[packages/block/src/block.ts:622](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L622) *** @@ -443,7 +555,7 @@ if set to `false`, will not check for transaction validation errors (default: tr #### Defined in -[block.ts:567](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L567) +[packages/block/src/block.ts:567](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L567) *** @@ -466,7 +578,7 @@ the parent of this `Block` #### Defined in -[block.ts:745](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L745) +[packages/block/src/block.ts:745](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L745) *** @@ -488,7 +600,7 @@ Header does not count an uncle twice. #### Defined in -[block.ts:711](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L711) +[packages/block/src/block.ts:711](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L711) *** @@ -506,7 +618,7 @@ true if the withdrawals trie root is valid, false otherwise #### Defined in -[block.ts:681](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L681) +[packages/block/src/block.ts:681](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L681) *** @@ -534,7 +646,7 @@ the block constructed block #### Defined in -[block.ts:325](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L325) +[packages/block/src/block.ts:325](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L325) *** @@ -556,7 +668,7 @@ Static constructor to create a block from a block data dictionary #### Defined in -[block.ts:109](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L109) +[packages/block/src/block.ts:109](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L109) *** @@ -582,7 +694,7 @@ the block constructed block #### Defined in -[block.ts:260](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L260) +[packages/block/src/block.ts:260](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L260) *** @@ -604,7 +716,7 @@ Static constructor to create a block from a RLP-serialized block #### Defined in -[block.ts:161](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L161) +[packages/block/src/block.ts:161](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L161) *** @@ -626,7 +738,7 @@ Static constructor to create a block from an array of Bytes values #### Defined in -[block.ts:177](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L177) +[packages/block/src/block.ts:177](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L177) *** @@ -654,7 +766,7 @@ a 32 byte Uint8Array representing the requests trie root #### Defined in -[block.ts:93](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L93) +[packages/block/src/block.ts:93](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L93) *** @@ -678,7 +790,7 @@ array of TypedTransaction to compute the root of #### Defined in -[block.ts:79](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L79) +[packages/block/src/block.ts:79](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L79) *** @@ -702,4 +814,4 @@ array of Withdrawal to compute the root of #### Defined in -[block.ts:66](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L66) +[packages/block/src/block.ts:66](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/block.ts#L66) diff --git a/packages/block/docs/classes/BlockHeader.md b/packages/block/docs/classes/BlockHeader.md index d7d682ef3a..4c04e4c92f 100644 --- a/packages/block/docs/classes/BlockHeader.md +++ b/packages/block/docs/classes/BlockHeader.md @@ -33,7 +33,7 @@ varying data types. For a default empty header, use [BlockHeader.fromHeaderData] #### Defined in -[header.ts:148](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L148) +[packages/block/src/header.ts:148](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L148) ## Properties @@ -43,7 +43,7 @@ varying data types. For a default empty header, use [BlockHeader.fromHeaderData] #### Defined in -[header.ts:58](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L58) +[packages/block/src/header.ts:58](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L58) *** @@ -53,7 +53,7 @@ varying data types. For a default empty header, use [BlockHeader.fromHeaderData] #### Defined in -[header.ts:60](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L60) +[packages/block/src/header.ts:60](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L60) *** @@ -63,7 +63,7 @@ varying data types. For a default empty header, use [BlockHeader.fromHeaderData] #### Defined in -[header.ts:69](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L69) +[packages/block/src/header.ts:69](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L69) *** @@ -73,17 +73,129 @@ varying data types. For a default empty header, use [BlockHeader.fromHeaderData] #### Defined in -[header.ts:45](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L45) +[packages/block/src/header.ts:45](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L45) *** ### common -> `readonly` **common**: `Common` +> `readonly` **common**: `object` + +#### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +##### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +#### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +#### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +#### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +#### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +#### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +#### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +##### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +#### ethjsCommon + +> **ethjsCommon**: `Common` + +#### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +#### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +#### id + +> **id**: `number` + +ID in number form + +#### name + +> **name**: `string` + +Human-readable name + +#### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +#### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +##### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +#### rpcUrls.default + +> **default**: `ChainRpcUrls` + +#### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +#### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +#### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks #### Defined in -[header.ts:65](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L65) +[packages/block/src/header.ts:65](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L65) *** @@ -93,7 +205,7 @@ varying data types. For a default empty header, use [BlockHeader.fromHeaderData] #### Defined in -[header.ts:50](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L50) +[packages/block/src/header.ts:50](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L50) *** @@ -103,7 +215,7 @@ varying data types. For a default empty header, use [BlockHeader.fromHeaderData] #### Defined in -[header.ts:61](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L61) +[packages/block/src/header.ts:61](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L61) *** @@ -113,7 +225,7 @@ varying data types. For a default empty header, use [BlockHeader.fromHeaderData] #### Defined in -[header.ts:55](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L55) +[packages/block/src/header.ts:55](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L55) *** @@ -123,7 +235,7 @@ varying data types. For a default empty header, use [BlockHeader.fromHeaderData] #### Defined in -[header.ts:52](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L52) +[packages/block/src/header.ts:52](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L52) *** @@ -133,7 +245,7 @@ varying data types. For a default empty header, use [BlockHeader.fromHeaderData] #### Defined in -[header.ts:53](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L53) +[packages/block/src/header.ts:53](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L53) *** @@ -151,7 +263,7 @@ varying data types. For a default empty header, use [BlockHeader.fromHeaderData] #### Defined in -[header.ts:67](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L67) +[packages/block/src/header.ts:67](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L67) *** @@ -161,7 +273,7 @@ varying data types. For a default empty header, use [BlockHeader.fromHeaderData] #### Defined in -[header.ts:49](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L49) +[packages/block/src/header.ts:49](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L49) *** @@ -171,7 +283,7 @@ varying data types. For a default empty header, use [BlockHeader.fromHeaderData] #### Defined in -[header.ts:56](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L56) +[packages/block/src/header.ts:56](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L56) *** @@ -181,7 +293,7 @@ varying data types. For a default empty header, use [BlockHeader.fromHeaderData] #### Defined in -[header.ts:57](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L57) +[packages/block/src/header.ts:57](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L57) *** @@ -191,7 +303,7 @@ varying data types. For a default empty header, use [BlockHeader.fromHeaderData] #### Defined in -[header.ts:51](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L51) +[packages/block/src/header.ts:51](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L51) *** @@ -201,7 +313,7 @@ varying data types. For a default empty header, use [BlockHeader.fromHeaderData] #### Defined in -[header.ts:62](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L62) +[packages/block/src/header.ts:62](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L62) *** @@ -211,7 +323,7 @@ varying data types. For a default empty header, use [BlockHeader.fromHeaderData] #### Defined in -[header.ts:43](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L43) +[packages/block/src/header.ts:43](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L43) *** @@ -221,7 +333,7 @@ varying data types. For a default empty header, use [BlockHeader.fromHeaderData] #### Defined in -[header.ts:48](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L48) +[packages/block/src/header.ts:48](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L48) *** @@ -231,7 +343,7 @@ varying data types. For a default empty header, use [BlockHeader.fromHeaderData] #### Defined in -[header.ts:63](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L63) +[packages/block/src/header.ts:63](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L63) *** @@ -241,7 +353,7 @@ varying data types. For a default empty header, use [BlockHeader.fromHeaderData] #### Defined in -[header.ts:46](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L46) +[packages/block/src/header.ts:46](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L46) *** @@ -251,7 +363,7 @@ varying data types. For a default empty header, use [BlockHeader.fromHeaderData] #### Defined in -[header.ts:54](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L54) +[packages/block/src/header.ts:54](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L54) *** @@ -261,7 +373,7 @@ varying data types. For a default empty header, use [BlockHeader.fromHeaderData] #### Defined in -[header.ts:47](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L47) +[packages/block/src/header.ts:47](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L47) *** @@ -271,7 +383,7 @@ varying data types. For a default empty header, use [BlockHeader.fromHeaderData] #### Defined in -[header.ts:44](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L44) +[packages/block/src/header.ts:44](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L44) *** @@ -281,7 +393,7 @@ varying data types. For a default empty header, use [BlockHeader.fromHeaderData] #### Defined in -[header.ts:59](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L59) +[packages/block/src/header.ts:59](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L59) ## Accessors @@ -297,7 +409,7 @@ EIP-4399: After merge to PoS, `mixHash` supplanted as `prevRandao` #### Defined in -[header.ts:76](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L76) +[packages/block/src/header.ts:76](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L76) ## Methods @@ -317,7 +429,7 @@ if any check fails #### Defined in -[header.ts:397](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L397) +[packages/block/src/header.ts:397](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L397) *** @@ -333,7 +445,7 @@ Validates correct buffer lengths, throws if invalid. #### Defined in -[header.ts:310](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L310) +[packages/block/src/header.ts:310](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L310) *** @@ -351,7 +463,7 @@ Validates correct buffer lengths, throws if invalid. #### Defined in -[header.ts:680](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L680) +[packages/block/src/header.ts:680](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L680) *** @@ -368,7 +480,7 @@ activation block (see: https://blog.slock.it/hard-fork-specification-24b889e7070 #### Defined in -[header.ts:924](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L924) +[packages/block/src/header.ts:924](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L924) *** @@ -392,7 +504,7 @@ the total blob gas fee for numBlobs blobs #### Defined in -[header.ts:579](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L579) +[packages/block/src/header.ts:579](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L579) *** @@ -408,7 +520,7 @@ Calculates the base fee for a potential next block #### Defined in -[header.ts:520](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L520) +[packages/block/src/header.ts:520](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L520) *** @@ -426,7 +538,7 @@ The blob gas price #### Defined in -[header.ts:605](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L605) +[packages/block/src/header.ts:605](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L605) *** @@ -442,7 +554,7 @@ Calculates the excess blob gas for next (hopefully) post EIP 4844 block. #### Defined in -[header.ts:590](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L590) +[packages/block/src/header.ts:590](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L590) *** @@ -463,7 +575,7 @@ in conjunction with [BlockHeader.cliqueIsEpochTransition](BlockHeader.md#cliquei #### Defined in -[header.ts:823](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L823) +[packages/block/src/header.ts:823](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L823) *** @@ -480,7 +592,7 @@ Returns extra seal data #### Defined in -[header.ts:793](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L793) +[packages/block/src/header.ts:793](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L793) *** @@ -497,7 +609,7 @@ Returns extra vanity data #### Defined in -[header.ts:784](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L784) +[packages/block/src/header.ts:784](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L784) *** @@ -514,7 +626,7 @@ header (only clique PoA, throws otherwise) #### Defined in -[header.ts:772](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L772) +[packages/block/src/header.ts:772](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L772) *** @@ -530,7 +642,7 @@ PoA clique signature hash without the seal. #### Defined in -[header.ts:761](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L761) +[packages/block/src/header.ts:761](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L761) *** @@ -546,7 +658,7 @@ Returns the signer address #### Defined in -[header.ts:860](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L860) +[packages/block/src/header.ts:860](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L860) *** @@ -569,7 +681,7 @@ Verifies the signature of the block (last 65 bytes of extraData field) #### Defined in -[header.ts:848](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L848) +[packages/block/src/header.ts:848](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L848) *** @@ -585,7 +697,7 @@ Return a compact error string representation of the object #### Defined in -[header.ts:946](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L946) +[packages/block/src/header.ts:946](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L946) *** @@ -607,7 +719,7 @@ the header from the parent `Block` of this header #### Defined in -[header.ts:692](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L692) +[packages/block/src/header.ts:692](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L692) *** @@ -625,7 +737,7 @@ the price in gwei per unit of blob gas spent #### Defined in -[header.ts:554](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L554) +[packages/block/src/header.ts:554](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L554) *** @@ -641,7 +753,7 @@ Returns the hash of the block header. #### Defined in -[header.ts:663](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L663) +[packages/block/src/header.ts:663](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L663) *** @@ -657,7 +769,7 @@ Checks if the block header is a genesis header. #### Defined in -[header.ts:676](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L676) +[packages/block/src/header.ts:676](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L676) *** @@ -673,7 +785,7 @@ Returns a Uint8Array Array of the raw Bytes in this header, in order. #### Defined in -[header.ts:612](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L612) +[packages/block/src/header.ts:612](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L612) *** @@ -689,7 +801,7 @@ Returns the rlp encoding of the block header. #### Defined in -[header.ts:877](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L877) +[packages/block/src/header.ts:877](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L877) *** @@ -705,7 +817,7 @@ Returns the block header in JSON format. #### Defined in -[header.ts:884](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L884) +[packages/block/src/header.ts:884](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L884) *** @@ -728,7 +840,7 @@ the header from the parent `Block` of this header #### Defined in -[header.ts:481](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L481) +[packages/block/src/header.ts:481](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L481) *** @@ -750,7 +862,7 @@ Static constructor to create a block header from a header data dictionary #### Defined in -[header.ts:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L90) +[packages/block/src/header.ts:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L90) *** @@ -772,7 +884,7 @@ Static constructor to create a block header from a RLP-serialized header #### Defined in -[header.ts:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L100) +[packages/block/src/header.ts:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L100) *** @@ -794,4 +906,4 @@ Static constructor to create a block header from an array of Bytes values #### Defined in -[header.ts:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L114) +[packages/block/src/header.ts:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/header.ts#L114) diff --git a/packages/block/docs/classes/ClRequest.md b/packages/block/docs/classes/ClRequest.md index 39ad97756f..a3b3933619 100644 --- a/packages/block/docs/classes/ClRequest.md +++ b/packages/block/docs/classes/ClRequest.md @@ -28,7 +28,7 @@ #### Defined in -[ClRequest.ts:21](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/ClRequest.ts#L21) +[packages/block/src/ClRequest.ts:21](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/ClRequest.ts#L21) ## Properties @@ -42,7 +42,7 @@ #### Defined in -[ClRequest.ts:20](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/ClRequest.ts#L20) +[packages/block/src/ClRequest.ts:20](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/ClRequest.ts#L20) *** @@ -56,7 +56,7 @@ #### Defined in -[ClRequest.ts:19](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/ClRequest.ts#L19) +[packages/block/src/ClRequest.ts:19](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/ClRequest.ts#L19) ## Methods @@ -74,4 +74,4 @@ #### Defined in -[ClRequest.ts:27](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/ClRequest.ts#L27) +[packages/block/src/ClRequest.ts:27](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/ClRequest.ts#L27) diff --git a/packages/block/docs/functions/blockFromRpc.md b/packages/block/docs/functions/blockFromRpc.md index 6fff8f0838..9228b7de04 100644 --- a/packages/block/docs/functions/blockFromRpc.md +++ b/packages/block/docs/functions/blockFromRpc.md @@ -32,4 +32,4 @@ Optional list of Ethereum JSON RPC of uncles (eth_getUncleByBlockHashAndIndex) ## Defined in -[from-rpc.ts:39](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/from-rpc.ts#L39) +[packages/block/src/from-rpc.ts:39](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/from-rpc.ts#L39) diff --git a/packages/block/docs/functions/executionPayloadFromBeaconPayload.md b/packages/block/docs/functions/executionPayloadFromBeaconPayload.md index d4fce59f88..dd09c403df 100644 --- a/packages/block/docs/functions/executionPayloadFromBeaconPayload.md +++ b/packages/block/docs/functions/executionPayloadFromBeaconPayload.md @@ -21,4 +21,4 @@ The JSON data can be retrieved from a consensus layer (CL) client on this Beacon ## Defined in -[from-beacon-payload.ts:93](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/from-beacon-payload.ts#L93) +[packages/block/src/from-beacon-payload.ts:93](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/from-beacon-payload.ts#L93) diff --git a/packages/block/docs/functions/getDifficulty.md b/packages/block/docs/functions/getDifficulty.md index 8ca28577e9..17d0e4a196 100644 --- a/packages/block/docs/functions/getDifficulty.md +++ b/packages/block/docs/functions/getDifficulty.md @@ -18,4 +18,4 @@ ## Defined in -[helpers.ts:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/helpers.ts#L81) +[packages/block/src/helpers.ts:81](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/helpers.ts#L81) diff --git a/packages/block/docs/functions/valuesArrayToHeaderData.md b/packages/block/docs/functions/valuesArrayToHeaderData.md index cf08281eac..7b9fadf4f0 100644 --- a/packages/block/docs/functions/valuesArrayToHeaderData.md +++ b/packages/block/docs/functions/valuesArrayToHeaderData.md @@ -18,4 +18,4 @@ ## Defined in -[helpers.ts:24](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/helpers.ts#L24) +[packages/block/src/helpers.ts:24](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/helpers.ts#L24) diff --git a/packages/block/docs/interfaces/BlockData.md b/packages/block/docs/interfaces/BlockData.md index b6c50a855f..dc979deeb6 100644 --- a/packages/block/docs/interfaces/BlockData.md +++ b/packages/block/docs/interfaces/BlockData.md @@ -18,7 +18,7 @@ EIP-6800: Verkle Proof Data (experimental) #### Defined in -[types.ts:151](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L151) +[packages/block/src/types.ts:151](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L151) *** @@ -30,7 +30,7 @@ Header data for the block #### Defined in -[types.ts:143](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L143) +[packages/block/src/types.ts:143](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L143) *** @@ -40,17 +40,17 @@ Header data for the block #### Defined in -[types.ts:147](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L147) +[packages/block/src/types.ts:147](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L147) *** ### transactions? -> `optional` **transactions**: (`LegacyTxData` \| `AccessListEIP2930TxData` \| `FeeMarketEIP1559TxData` \| `BlobEIP4844TxData`)[] +> `optional` **transactions**: (`LegacyTxData` \| `AccessListEIP2930TxData` \| `FeeMarketEIP1559TxData` \| `BlobEIP4844TxData` \| `EOACodeEIP7702TxData`)[] #### Defined in -[types.ts:144](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L144) +[packages/block/src/types.ts:144](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L144) *** @@ -60,7 +60,7 @@ Header data for the block #### Defined in -[types.ts:145](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L145) +[packages/block/src/types.ts:145](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L145) *** @@ -70,4 +70,4 @@ Header data for the block #### Defined in -[types.ts:146](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L146) +[packages/block/src/types.ts:146](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L146) diff --git a/packages/block/docs/interfaces/BlockOptions.md b/packages/block/docs/interfaces/BlockOptions.md index e2c86ed683..801417a16b 100644 --- a/packages/block/docs/interfaces/BlockOptions.md +++ b/packages/block/docs/interfaces/BlockOptions.md @@ -25,7 +25,7 @@ Note that this option has no effect on networks other than PoW/Ethash networks #### Defined in -[types.ts:43](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L43) +[packages/block/src/types.ts:43](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L43) *** @@ -38,13 +38,13 @@ Will throw if provided on a non-PoA chain. #### Defined in -[types.ts:60](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L60) +[packages/block/src/types.ts:60](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L60) *** ### common -> **common**: `Common` +> **common**: `object` A Common object defining the chain and the hardfork a block/block header belongs to. @@ -56,9 +56,121 @@ hardfork in the Common class. Current default hardfork: `merge` +#### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +##### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +#### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +#### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +#### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +#### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +#### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +#### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +##### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +#### ethjsCommon + +> **ethjsCommon**: `Common` + +#### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +#### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +#### id + +> **id**: `number` + +ID in number form + +#### name + +> **name**: `string` + +Human-readable name + +#### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +#### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +##### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +#### rpcUrls.default + +> **default**: `ChainRpcUrls` + +#### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +#### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +#### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + #### Defined in -[types.ts:24](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L24) +[packages/block/src/types.ts:24](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L24) *** @@ -68,7 +180,7 @@ Current default hardfork: `merge` #### Defined in -[types.ts:66](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L66) +[packages/block/src/types.ts:66](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L66) *** @@ -88,7 +200,7 @@ Default: true #### Defined in -[types.ts:55](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L55) +[packages/block/src/types.ts:55](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L55) *** @@ -106,7 +218,7 @@ Default: `false` (HF is set to whatever default HF is set by the Common instance #### Defined in -[types.ts:34](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L34) +[packages/block/src/types.ts:34](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L34) *** @@ -118,4 +230,4 @@ Skip consensus format validation checks on header if set. Defaults to false. #### Defined in -[types.ts:64](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L64) +[packages/block/src/types.ts:64](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L64) diff --git a/packages/block/docs/interfaces/HeaderData.md b/packages/block/docs/interfaces/HeaderData.md index cd4bac9e1b..4712584d4e 100644 --- a/packages/block/docs/interfaces/HeaderData.md +++ b/packages/block/docs/interfaces/HeaderData.md @@ -12,208 +12,208 @@ A block header's data. ### baseFeePerGas? -> `optional` **baseFeePerGas**: `BigIntLike` +> `optional` **baseFeePerGas**: `string` \| `number` \| `bigint` \| `Uint8Array` #### Defined in -[types.ts:128](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L128) +[packages/block/src/types.ts:128](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L128) *** ### blobGasUsed? -> `optional` **blobGasUsed**: `BigIntLike` +> `optional` **blobGasUsed**: `string` \| `number` \| `bigint` \| `Uint8Array` #### Defined in -[types.ts:130](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L130) +[packages/block/src/types.ts:130](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L130) *** ### coinbase? -> `optional` **coinbase**: `AddressLike` +> `optional` **coinbase**: `string` \| `Uint8Array` \| `Address` #### Defined in -[types.ts:115](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L115) +[packages/block/src/types.ts:115](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L115) *** ### difficulty? -> `optional` **difficulty**: `BigIntLike` +> `optional` **difficulty**: `string` \| `number` \| `bigint` \| `Uint8Array` #### Defined in -[types.ts:120](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L120) +[packages/block/src/types.ts:120](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L120) *** ### excessBlobGas? -> `optional` **excessBlobGas**: `BigIntLike` +> `optional` **excessBlobGas**: `string` \| `number` \| `bigint` \| `Uint8Array` #### Defined in -[types.ts:131](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L131) +[packages/block/src/types.ts:131](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L131) *** ### extraData? -> `optional` **extraData**: `BytesLike` +> `optional` **extraData**: `string` \| `number` \| `bigint` \| `Uint8Array` \| `number`[] \| `TransformabletoBytes` #### Defined in -[types.ts:125](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L125) +[packages/block/src/types.ts:125](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L125) *** ### gasLimit? -> `optional` **gasLimit**: `BigIntLike` +> `optional` **gasLimit**: `string` \| `number` \| `bigint` \| `Uint8Array` #### Defined in -[types.ts:122](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L122) +[packages/block/src/types.ts:122](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L122) *** ### gasUsed? -> `optional` **gasUsed**: `BigIntLike` +> `optional` **gasUsed**: `string` \| `number` \| `bigint` \| `Uint8Array` #### Defined in -[types.ts:123](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L123) +[packages/block/src/types.ts:123](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L123) *** ### logsBloom? -> `optional` **logsBloom**: `BytesLike` +> `optional` **logsBloom**: `string` \| `number` \| `bigint` \| `Uint8Array` \| `number`[] \| `TransformabletoBytes` #### Defined in -[types.ts:119](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L119) +[packages/block/src/types.ts:119](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L119) *** ### mixHash? -> `optional` **mixHash**: `BytesLike` +> `optional` **mixHash**: `string` \| `number` \| `bigint` \| `Uint8Array` \| `number`[] \| `TransformabletoBytes` #### Defined in -[types.ts:126](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L126) +[packages/block/src/types.ts:126](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L126) *** ### nonce? -> `optional` **nonce**: `BytesLike` +> `optional` **nonce**: `string` \| `number` \| `bigint` \| `Uint8Array` \| `number`[] \| `TransformabletoBytes` #### Defined in -[types.ts:127](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L127) +[packages/block/src/types.ts:127](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L127) *** ### number? -> `optional` **number**: `BigIntLike` +> `optional` **number**: `string` \| `number` \| `bigint` \| `Uint8Array` #### Defined in -[types.ts:121](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L121) +[packages/block/src/types.ts:121](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L121) *** ### parentBeaconBlockRoot? -> `optional` **parentBeaconBlockRoot**: `BytesLike` +> `optional` **parentBeaconBlockRoot**: `string` \| `number` \| `bigint` \| `Uint8Array` \| `number`[] \| `TransformabletoBytes` #### Defined in -[types.ts:132](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L132) +[packages/block/src/types.ts:132](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L132) *** ### parentHash? -> `optional` **parentHash**: `BytesLike` +> `optional` **parentHash**: `string` \| `number` \| `bigint` \| `Uint8Array` \| `number`[] \| `TransformabletoBytes` #### Defined in -[types.ts:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L113) +[packages/block/src/types.ts:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L113) *** ### receiptTrie? -> `optional` **receiptTrie**: `BytesLike` +> `optional` **receiptTrie**: `string` \| `number` \| `bigint` \| `Uint8Array` \| `number`[] \| `TransformabletoBytes` #### Defined in -[types.ts:118](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L118) +[packages/block/src/types.ts:118](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L118) *** ### requestsRoot? -> `optional` **requestsRoot**: `BytesLike` +> `optional` **requestsRoot**: `string` \| `number` \| `bigint` \| `Uint8Array` \| `number`[] \| `TransformabletoBytes` #### Defined in -[types.ts:133](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L133) +[packages/block/src/types.ts:133](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L133) *** ### stateRoot? -> `optional` **stateRoot**: `BytesLike` +> `optional` **stateRoot**: `string` \| `number` \| `bigint` \| `Uint8Array` \| `number`[] \| `TransformabletoBytes` #### Defined in -[types.ts:116](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L116) +[packages/block/src/types.ts:116](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L116) *** ### timestamp? -> `optional` **timestamp**: `BigIntLike` +> `optional` **timestamp**: `string` \| `number` \| `bigint` \| `Uint8Array` #### Defined in -[types.ts:124](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L124) +[packages/block/src/types.ts:124](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L124) *** ### transactionsTrie? -> `optional` **transactionsTrie**: `BytesLike` +> `optional` **transactionsTrie**: `string` \| `number` \| `bigint` \| `Uint8Array` \| `number`[] \| `TransformabletoBytes` #### Defined in -[types.ts:117](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L117) +[packages/block/src/types.ts:117](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L117) *** ### uncleHash? -> `optional` **uncleHash**: `BytesLike` +> `optional` **uncleHash**: `string` \| `number` \| `bigint` \| `Uint8Array` \| `number`[] \| `TransformabletoBytes` #### Defined in -[types.ts:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L114) +[packages/block/src/types.ts:114](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L114) *** ### withdrawalsRoot? -> `optional` **withdrawalsRoot**: `BytesLike` +> `optional` **withdrawalsRoot**: `string` \| `number` \| `bigint` \| `Uint8Array` \| `number`[] \| `TransformabletoBytes` #### Defined in -[types.ts:129](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L129) +[packages/block/src/types.ts:129](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L129) diff --git a/packages/block/docs/interfaces/JsonBlock.md b/packages/block/docs/interfaces/JsonBlock.md index 8fae34adc5..9b56d3f219 100644 --- a/packages/block/docs/interfaces/JsonBlock.md +++ b/packages/block/docs/interfaces/JsonBlock.md @@ -16,7 +16,7 @@ An object with the block's data represented as strings. #### Defined in -[types.ts:187](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L187) +[packages/block/src/types.ts:187](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L187) *** @@ -28,7 +28,7 @@ Header data for the block #### Defined in -[types.ts:182](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L182) +[packages/block/src/types.ts:182](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L182) *** @@ -38,7 +38,7 @@ Header data for the block #### Defined in -[types.ts:186](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L186) +[packages/block/src/types.ts:186](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L186) *** @@ -48,7 +48,7 @@ Header data for the block #### Defined in -[types.ts:183](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L183) +[packages/block/src/types.ts:183](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L183) *** @@ -58,7 +58,7 @@ Header data for the block #### Defined in -[types.ts:184](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L184) +[packages/block/src/types.ts:184](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L184) *** @@ -68,4 +68,4 @@ Header data for the block #### Defined in -[types.ts:185](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L185) +[packages/block/src/types.ts:185](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L185) diff --git a/packages/block/docs/interfaces/JsonHeader.md b/packages/block/docs/interfaces/JsonHeader.md index 1e69e5faa9..e519e5e979 100644 --- a/packages/block/docs/interfaces/JsonHeader.md +++ b/packages/block/docs/interfaces/JsonHeader.md @@ -16,7 +16,7 @@ An object with the block header's data represented as 0x-prefixed hex strings. #### Defined in -[types.ts:210](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L210) +[packages/block/src/types.ts:210](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L210) *** @@ -26,7 +26,7 @@ An object with the block header's data represented as 0x-prefixed hex strings. #### Defined in -[types.ts:212](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L212) +[packages/block/src/types.ts:212](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L212) *** @@ -36,7 +36,7 @@ An object with the block header's data represented as 0x-prefixed hex strings. #### Defined in -[types.ts:197](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L197) +[packages/block/src/types.ts:197](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L197) *** @@ -46,7 +46,7 @@ An object with the block header's data represented as 0x-prefixed hex strings. #### Defined in -[types.ts:202](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L202) +[packages/block/src/types.ts:202](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L202) *** @@ -56,7 +56,7 @@ An object with the block header's data represented as 0x-prefixed hex strings. #### Defined in -[types.ts:213](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L213) +[packages/block/src/types.ts:213](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L213) *** @@ -66,7 +66,7 @@ An object with the block header's data represented as 0x-prefixed hex strings. #### Defined in -[types.ts:207](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L207) +[packages/block/src/types.ts:207](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L207) *** @@ -76,7 +76,7 @@ An object with the block header's data represented as 0x-prefixed hex strings. #### Defined in -[types.ts:204](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L204) +[packages/block/src/types.ts:204](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L204) *** @@ -86,7 +86,7 @@ An object with the block header's data represented as 0x-prefixed hex strings. #### Defined in -[types.ts:205](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L205) +[packages/block/src/types.ts:205](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L205) *** @@ -96,7 +96,7 @@ An object with the block header's data represented as 0x-prefixed hex strings. #### Defined in -[types.ts:201](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L201) +[packages/block/src/types.ts:201](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L201) *** @@ -106,7 +106,7 @@ An object with the block header's data represented as 0x-prefixed hex strings. #### Defined in -[types.ts:208](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L208) +[packages/block/src/types.ts:208](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L208) *** @@ -116,7 +116,7 @@ An object with the block header's data represented as 0x-prefixed hex strings. #### Defined in -[types.ts:209](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L209) +[packages/block/src/types.ts:209](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L209) *** @@ -126,7 +126,7 @@ An object with the block header's data represented as 0x-prefixed hex strings. #### Defined in -[types.ts:203](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L203) +[packages/block/src/types.ts:203](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L203) *** @@ -136,7 +136,7 @@ An object with the block header's data represented as 0x-prefixed hex strings. #### Defined in -[types.ts:214](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L214) +[packages/block/src/types.ts:214](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L214) *** @@ -146,7 +146,7 @@ An object with the block header's data represented as 0x-prefixed hex strings. #### Defined in -[types.ts:195](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L195) +[packages/block/src/types.ts:195](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L195) *** @@ -156,7 +156,7 @@ An object with the block header's data represented as 0x-prefixed hex strings. #### Defined in -[types.ts:200](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L200) +[packages/block/src/types.ts:200](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L200) *** @@ -166,7 +166,7 @@ An object with the block header's data represented as 0x-prefixed hex strings. #### Defined in -[types.ts:215](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L215) +[packages/block/src/types.ts:215](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L215) *** @@ -176,7 +176,7 @@ An object with the block header's data represented as 0x-prefixed hex strings. #### Defined in -[types.ts:198](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L198) +[packages/block/src/types.ts:198](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L198) *** @@ -186,7 +186,7 @@ An object with the block header's data represented as 0x-prefixed hex strings. #### Defined in -[types.ts:206](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L206) +[packages/block/src/types.ts:206](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L206) *** @@ -196,7 +196,7 @@ An object with the block header's data represented as 0x-prefixed hex strings. #### Defined in -[types.ts:199](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L199) +[packages/block/src/types.ts:199](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L199) *** @@ -206,7 +206,7 @@ An object with the block header's data represented as 0x-prefixed hex strings. #### Defined in -[types.ts:196](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L196) +[packages/block/src/types.ts:196](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L196) *** @@ -216,4 +216,4 @@ An object with the block header's data represented as 0x-prefixed hex strings. #### Defined in -[types.ts:211](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L211) +[packages/block/src/types.ts:211](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L211) diff --git a/packages/block/docs/interfaces/JsonRpcBlock.md b/packages/block/docs/interfaces/JsonRpcBlock.md index 83f7c2c6b6..143f756003 100644 --- a/packages/block/docs/interfaces/JsonRpcBlock.md +++ b/packages/block/docs/interfaces/JsonRpcBlock.md @@ -14,7 +14,7 @@ #### Defined in -[types.ts:243](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L243) +[packages/block/src/types.ts:243](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L243) *** @@ -24,7 +24,7 @@ #### Defined in -[types.ts:246](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L246) +[packages/block/src/types.ts:246](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L246) *** @@ -34,7 +34,7 @@ #### Defined in -[types.ts:234](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L234) +[packages/block/src/types.ts:234](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L234) *** @@ -44,7 +44,7 @@ #### Defined in -[types.ts:247](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L247) +[packages/block/src/types.ts:247](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L247) *** @@ -54,7 +54,7 @@ #### Defined in -[types.ts:249](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L249) +[packages/block/src/types.ts:249](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L249) *** @@ -64,7 +64,7 @@ #### Defined in -[types.ts:236](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L236) +[packages/block/src/types.ts:236](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L236) *** @@ -74,7 +74,7 @@ #### Defined in -[types.ts:238](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L238) +[packages/block/src/types.ts:238](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L238) *** @@ -84,7 +84,7 @@ #### Defined in -[types.ts:239](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L239) +[packages/block/src/types.ts:239](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L239) *** @@ -94,7 +94,7 @@ #### Defined in -[types.ts:224](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L224) +[packages/block/src/types.ts:224](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L224) *** @@ -104,7 +104,7 @@ #### Defined in -[types.ts:229](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L229) +[packages/block/src/types.ts:229](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L229) *** @@ -114,7 +114,7 @@ #### Defined in -[types.ts:233](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L233) +[packages/block/src/types.ts:233](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L233) *** @@ -124,7 +124,7 @@ #### Defined in -[types.ts:226](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L226) +[packages/block/src/types.ts:226](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L226) *** @@ -134,7 +134,7 @@ #### Defined in -[types.ts:227](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L227) +[packages/block/src/types.ts:227](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L227) *** @@ -144,7 +144,7 @@ #### Defined in -[types.ts:223](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L223) +[packages/block/src/types.ts:223](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L223) *** @@ -154,7 +154,7 @@ #### Defined in -[types.ts:248](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L248) +[packages/block/src/types.ts:248](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L248) *** @@ -164,7 +164,7 @@ #### Defined in -[types.ts:225](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L225) +[packages/block/src/types.ts:225](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L225) *** @@ -174,7 +174,7 @@ #### Defined in -[types.ts:232](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L232) +[packages/block/src/types.ts:232](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L232) *** @@ -184,7 +184,7 @@ #### Defined in -[types.ts:251](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L251) +[packages/block/src/types.ts:251](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L251) *** @@ -194,7 +194,7 @@ #### Defined in -[types.ts:250](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L250) +[packages/block/src/types.ts:250](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L250) *** @@ -204,7 +204,7 @@ #### Defined in -[types.ts:228](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L228) +[packages/block/src/types.ts:228](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L228) *** @@ -214,7 +214,7 @@ #### Defined in -[types.ts:237](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L237) +[packages/block/src/types.ts:237](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L237) *** @@ -224,7 +224,7 @@ #### Defined in -[types.ts:231](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L231) +[packages/block/src/types.ts:231](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L231) *** @@ -234,7 +234,7 @@ #### Defined in -[types.ts:240](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L240) +[packages/block/src/types.ts:240](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L240) *** @@ -244,7 +244,7 @@ #### Defined in -[types.ts:235](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L235) +[packages/block/src/types.ts:235](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L235) *** @@ -254,7 +254,7 @@ #### Defined in -[types.ts:241](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L241) +[packages/block/src/types.ts:241](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L241) *** @@ -264,7 +264,7 @@ #### Defined in -[types.ts:230](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L230) +[packages/block/src/types.ts:230](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L230) *** @@ -274,7 +274,7 @@ #### Defined in -[types.ts:242](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L242) +[packages/block/src/types.ts:242](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L242) *** @@ -284,7 +284,7 @@ #### Defined in -[types.ts:244](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L244) +[packages/block/src/types.ts:244](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L244) *** @@ -294,4 +294,4 @@ #### Defined in -[types.ts:245](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L245) +[packages/block/src/types.ts:245](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L245) diff --git a/packages/block/docs/interfaces/VerkleExecutionWitness.md b/packages/block/docs/interfaces/VerkleExecutionWitness.md index 62c412363d..5df83306d4 100644 --- a/packages/block/docs/interfaces/VerkleExecutionWitness.md +++ b/packages/block/docs/interfaces/VerkleExecutionWitness.md @@ -21,7 +21,7 @@ In the current design, it also contains the resulting state of the block executi #### Defined in -[types.ts:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L100) +[packages/block/src/types.ts:100](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L100) *** @@ -34,4 +34,4 @@ Proves that the provided stateDiff belongs to the canonical verkle tree. #### Defined in -[types.ts:105](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L105) +[packages/block/src/types.ts:105](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L105) diff --git a/packages/block/docs/interfaces/VerkleProof.md b/packages/block/docs/interfaces/VerkleProof.md index 138ca87298..d46f57802f 100644 --- a/packages/block/docs/interfaces/VerkleProof.md +++ b/packages/block/docs/interfaces/VerkleProof.md @@ -14,7 +14,7 @@ #### Defined in -[types.ts:70](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L70) +[packages/block/src/types.ts:70](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L70) *** @@ -24,7 +24,7 @@ #### Defined in -[types.ts:71](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L71) +[packages/block/src/types.ts:71](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L71) *** @@ -34,7 +34,7 @@ #### Defined in -[types.ts:72](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L72) +[packages/block/src/types.ts:72](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L72) *** @@ -56,7 +56,7 @@ #### Defined in -[types.ts:73](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L73) +[packages/block/src/types.ts:73](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L73) *** @@ -66,4 +66,4 @@ #### Defined in -[types.ts:78](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L78) +[packages/block/src/types.ts:78](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L78) diff --git a/packages/block/docs/interfaces/VerkleStateDiff.md b/packages/block/docs/interfaces/VerkleStateDiff.md index 05d420cb0d..a8afdcbe97 100644 --- a/packages/block/docs/interfaces/VerkleStateDiff.md +++ b/packages/block/docs/interfaces/VerkleStateDiff.md @@ -14,7 +14,7 @@ #### Defined in -[types.ts:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L82) +[packages/block/src/types.ts:82](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L82) *** @@ -24,4 +24,4 @@ #### Defined in -[types.ts:83](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L83) +[packages/block/src/types.ts:83](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L83) diff --git a/packages/block/docs/type-aliases/BeaconPayloadJson.md b/packages/block/docs/type-aliases/BeaconPayloadJson.md index 19175e603a..070137ec8b 100644 --- a/packages/block/docs/type-aliases/BeaconPayloadJson.md +++ b/packages/block/docs/type-aliases/BeaconPayloadJson.md @@ -88,4 +88,4 @@ ## Defined in -[from-beacon-payload.ts:13](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/from-beacon-payload.ts#L13) +[packages/block/src/from-beacon-payload.ts:13](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/from-beacon-payload.ts#L13) diff --git a/packages/block/docs/type-aliases/BlockBodyBytes.md b/packages/block/docs/type-aliases/BlockBodyBytes.md index 245fcf7909..103dd75ec0 100644 --- a/packages/block/docs/type-aliases/BlockBodyBytes.md +++ b/packages/block/docs/type-aliases/BlockBodyBytes.md @@ -10,4 +10,4 @@ ## Defined in -[types.ts:168](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L168) +[packages/block/src/types.ts:168](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L168) diff --git a/packages/block/docs/type-aliases/BlockBytes.md b/packages/block/docs/type-aliases/BlockBytes.md index 14269f3037..2ed98f7f36 100644 --- a/packages/block/docs/type-aliases/BlockBytes.md +++ b/packages/block/docs/type-aliases/BlockBytes.md @@ -10,4 +10,4 @@ ## Defined in -[types.ts:158](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L158) +[packages/block/src/types.ts:158](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L158) diff --git a/packages/block/docs/type-aliases/BlockHeaderBytes.md b/packages/block/docs/type-aliases/BlockHeaderBytes.md index 2b0cb5dcfe..9dc42d2f07 100644 --- a/packages/block/docs/type-aliases/BlockHeaderBytes.md +++ b/packages/block/docs/type-aliases/BlockHeaderBytes.md @@ -12,4 +12,4 @@ BlockHeaderBuffer is a Buffer array, except for the Verkle PreState which is an ## Defined in -[types.ts:167](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L167) +[packages/block/src/types.ts:167](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L167) diff --git a/packages/block/docs/type-aliases/ExecutionPayload.md b/packages/block/docs/type-aliases/ExecutionPayload.md index a9c104c14c..d28577626c 100644 --- a/packages/block/docs/type-aliases/ExecutionPayload.md +++ b/packages/block/docs/type-aliases/ExecutionPayload.md @@ -92,4 +92,4 @@ ## Defined in -[types.ts:263](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L263) +[packages/block/src/types.ts:263](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L263) diff --git a/packages/block/docs/type-aliases/ExecutionWitnessBytes.md b/packages/block/docs/type-aliases/ExecutionWitnessBytes.md index c7a2bbbc75..be4f2d154a 100644 --- a/packages/block/docs/type-aliases/ExecutionWitnessBytes.md +++ b/packages/block/docs/type-aliases/ExecutionWitnessBytes.md @@ -10,4 +10,4 @@ ## Defined in -[types.ts:156](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L156) +[packages/block/src/types.ts:156](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L156) diff --git a/packages/block/docs/type-aliases/RequestsBytes.md b/packages/block/docs/type-aliases/RequestsBytes.md index c130d1612e..30190ef187 100644 --- a/packages/block/docs/type-aliases/RequestsBytes.md +++ b/packages/block/docs/type-aliases/RequestsBytes.md @@ -10,4 +10,4 @@ ## Defined in -[types.ts:155](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L155) +[packages/block/src/types.ts:155](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L155) diff --git a/packages/block/docs/type-aliases/TransactionsBytes.md b/packages/block/docs/type-aliases/TransactionsBytes.md index 9307ec7ff4..9ecc58867a 100644 --- a/packages/block/docs/type-aliases/TransactionsBytes.md +++ b/packages/block/docs/type-aliases/TransactionsBytes.md @@ -12,4 +12,4 @@ TransactionsBytes can be an array of serialized txs for Typed Transactions or an ## Defined in -[types.ts:172](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L172) +[packages/block/src/types.ts:172](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L172) diff --git a/packages/block/docs/type-aliases/UncleHeadersBytes.md b/packages/block/docs/type-aliases/UncleHeadersBytes.md index c87bd815a8..e1b8959a61 100644 --- a/packages/block/docs/type-aliases/UncleHeadersBytes.md +++ b/packages/block/docs/type-aliases/UncleHeadersBytes.md @@ -10,4 +10,4 @@ ## Defined in -[types.ts:173](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L173) +[packages/block/src/types.ts:173](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L173) diff --git a/packages/block/docs/type-aliases/WithdrawalV1.md b/packages/block/docs/type-aliases/WithdrawalV1.md index 492aa4fffd..d053cd42b7 100644 --- a/packages/block/docs/type-aliases/WithdrawalV1.md +++ b/packages/block/docs/type-aliases/WithdrawalV1.md @@ -28,4 +28,4 @@ ## Defined in -[types.ts:254](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L254) +[packages/block/src/types.ts:254](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L254) diff --git a/packages/block/docs/type-aliases/WithdrawalsBytes.md b/packages/block/docs/type-aliases/WithdrawalsBytes.md index 2792d1c9d2..7e39988b0e 100644 --- a/packages/block/docs/type-aliases/WithdrawalsBytes.md +++ b/packages/block/docs/type-aliases/WithdrawalsBytes.md @@ -10,4 +10,4 @@ ## Defined in -[types.ts:154](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L154) +[packages/block/src/types.ts:154](https://github.com/evmts/tevm-monorepo/blob/main/packages/block/src/types.ts#L154) diff --git a/packages/block/package.json b/packages/block/package.json index 148a692f54..21d017ee2b 100644 --- a/packages/block/package.json +++ b/packages/block/package.json @@ -19,6 +19,7 @@ "contributors": [ "Will Cory " ], + "sideEffects": false, "type": "module", "exports": { "./package.json": "./package.json", @@ -75,6 +76,5 @@ }, "publishConfig": { "access": "public" - }, - "sideEffects": false + } } \ No newline at end of file diff --git a/packages/blockchain/docs/README.md b/packages/blockchain/docs/README.md index f38bb29572..dcb6e94a7c 100644 --- a/packages/blockchain/docs/README.md +++ b/packages/blockchain/docs/README.md @@ -36,4 +36,4 @@ Some files are adapted from [ethereumjs](https://github.com/ethereumjs/ethereumj ## License 📄 - + diff --git a/packages/blockchain/docs/_media/LICENSE b/packages/blockchain/docs/_media/LICENSE deleted file mode 100644 index b5a4fa7a69..0000000000 --- a/packages/blockchain/docs/_media/LICENSE +++ /dev/null @@ -1,22 +0,0 @@ -(The MIT License) - -Copyright 2020-2022 - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/packages/blockchain/docs/functions/createBaseChain.md b/packages/blockchain/docs/functions/createBaseChain.md index c4330b956d..6763dc4ace 100644 --- a/packages/blockchain/docs/functions/createBaseChain.md +++ b/packages/blockchain/docs/functions/createBaseChain.md @@ -20,4 +20,4 @@ Base chain object ## Defined in -[createBaseChain.js:50](https://github.com/evmts/tevm-monorepo/blob/main/packages/blockchain/src/createBaseChain.js#L50) +[packages/blockchain/src/createBaseChain.js:50](https://github.com/evmts/tevm-monorepo/blob/main/packages/blockchain/src/createBaseChain.js#L50) diff --git a/packages/blockchain/docs/functions/createChain.md b/packages/blockchain/docs/functions/createChain.md index 0100e2bd0d..71dac7b4ac 100644 --- a/packages/blockchain/docs/functions/createChain.md +++ b/packages/blockchain/docs/functions/createChain.md @@ -18,4 +18,4 @@ ## Defined in -[createChain.js:16](https://github.com/evmts/tevm-monorepo/blob/main/packages/blockchain/src/createChain.js#L16) +[packages/blockchain/src/createChain.js:16](https://github.com/evmts/tevm-monorepo/blob/main/packages/blockchain/src/createChain.js#L16) diff --git a/packages/blockchain/docs/functions/deepCopy.md b/packages/blockchain/docs/functions/deepCopy.md index 450d389aa0..2361de638f 100644 --- a/packages/blockchain/docs/functions/deepCopy.md +++ b/packages/blockchain/docs/functions/deepCopy.md @@ -22,4 +22,4 @@ ## Defined in -[actions/deepCopy.js:7](https://github.com/evmts/tevm-monorepo/blob/main/packages/blockchain/src/actions/deepCopy.js#L7) +[packages/blockchain/src/actions/deepCopy.js:7](https://github.com/evmts/tevm-monorepo/blob/main/packages/blockchain/src/actions/deepCopy.js#L7) diff --git a/packages/blockchain/docs/functions/delBlock.md b/packages/blockchain/docs/functions/delBlock.md index db4f399bf7..776832364c 100644 --- a/packages/blockchain/docs/functions/delBlock.md +++ b/packages/blockchain/docs/functions/delBlock.md @@ -8,8 +8,6 @@ > **delBlock**(`baseChain`): (`blockHash`) => `Promise`\<`void`\> -Deletes a block from the blockchain - ## Parameters • **baseChain**: `BaseChain` @@ -31,10 +29,6 @@ The hash of the block to be deleted `Promise`\<`void`\> -## Throws - -If the block is the `forked` block - ## Defined in -[actions/delBlock.js:12](https://github.com/evmts/tevm-monorepo/blob/main/packages/blockchain/src/actions/delBlock.js#L12) +[packages/blockchain/src/actions/delBlock.js:12](https://github.com/evmts/tevm-monorepo/blob/main/packages/blockchain/src/actions/delBlock.js#L12) diff --git a/packages/blockchain/docs/functions/getBlock.md b/packages/blockchain/docs/functions/getBlock.md index 4de190448f..bc53107e89 100644 --- a/packages/blockchain/docs/functions/getBlock.md +++ b/packages/blockchain/docs/functions/getBlock.md @@ -8,8 +8,6 @@ > **getBlock**(`baseChain`): (`blockId`) => `Promise`\<`Block`\> -An ethereumjs interface method that accepts a block id number or hash and returns the block - ## Parameters • **baseChain**: `BaseChain` @@ -30,4 +28,4 @@ Returns a block by its hash or number. ## Defined in -[actions/getBlock.js:13](https://github.com/evmts/tevm-monorepo/blob/main/packages/blockchain/src/actions/getBlock.js#L13) +[packages/blockchain/src/actions/getBlock.js:13](https://github.com/evmts/tevm-monorepo/blob/main/packages/blockchain/src/actions/getBlock.js#L13) diff --git a/packages/blockchain/docs/functions/getBlockFromRpc.md b/packages/blockchain/docs/functions/getBlockFromRpc.md index 9b18a40295..faf9382e88 100644 --- a/packages/blockchain/docs/functions/getBlockFromRpc.md +++ b/packages/blockchain/docs/functions/getBlockFromRpc.md @@ -20,7 +20,69 @@ • **params.transport.request**: `EIP1193RequestFn`\<`undefined`\> -• **common**: `Common` +• **common** + +• **common.blockExplorers?** + +Collection of block explorers + +• **common.blockExplorers.default**: `ChainBlockExplorer` + +• **common.contracts?** + +Collection of contracts + +• **common.contracts.ensRegistry?**: `ChainContract` + +• **common.contracts.ensUniversalResolver?**: `ChainContract` + +• **common.contracts.multicall3?**: `ChainContract` + +• **common.copy** + +• **common.custom?**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +• **common.ethjsCommon**: `Common` + +• **common.fees?**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +• **common.formatters?**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +• **common.id**: `number` + +ID in number form + +• **common.name**: `string` + +Human-readable name + +• **common.nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +• **common.rpcUrls** + +Collection of RPC endpoints + +• **common.rpcUrls.default**: `ChainRpcUrls` + +• **common.serializers?**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +• **common.sourceId?**: `number` + +Source Chain ID (ie. the L1 chain) + +• **common.testnet?**: `boolean` + +Flag for test networks ## Returns @@ -28,4 +90,4 @@ ## Defined in -[utils/getBlockFromRpc.js:16](https://github.com/evmts/tevm-monorepo/blob/main/packages/blockchain/src/utils/getBlockFromRpc.js#L16) +[packages/blockchain/src/utils/getBlockFromRpc.js:16](https://github.com/evmts/tevm-monorepo/blob/main/packages/blockchain/src/utils/getBlockFromRpc.js#L16) diff --git a/packages/blockchain/docs/functions/getCanonicalHeadBlock.md b/packages/blockchain/docs/functions/getCanonicalHeadBlock.md index 505304661b..5da0cff0f2 100644 --- a/packages/blockchain/docs/functions/getCanonicalHeadBlock.md +++ b/packages/blockchain/docs/functions/getCanonicalHeadBlock.md @@ -24,4 +24,4 @@ Returns the latest full block in the canonical chain. ## Defined in -[actions/getCanonicalHeadBlock.js:7](https://github.com/evmts/tevm-monorepo/blob/main/packages/blockchain/src/actions/getCanonicalHeadBlock.js#L7) +[packages/blockchain/src/actions/getCanonicalHeadBlock.js:7](https://github.com/evmts/tevm-monorepo/blob/main/packages/blockchain/src/actions/getCanonicalHeadBlock.js#L7) diff --git a/packages/blockchain/docs/functions/getIteratorHead.md b/packages/blockchain/docs/functions/getIteratorHead.md index 8bb2bfed32..53f5ebca9f 100644 --- a/packages/blockchain/docs/functions/getIteratorHead.md +++ b/packages/blockchain/docs/functions/getIteratorHead.md @@ -30,4 +30,4 @@ Optional name of the iterator head (default: 'vm') ## Defined in -[actions/getIteratorHead.js:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/blockchain/src/actions/getIteratorHead.js#L8) +[packages/blockchain/src/actions/getIteratorHead.js:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/blockchain/src/actions/getIteratorHead.js#L8) diff --git a/packages/blockchain/docs/functions/isTevmBlockTag.md b/packages/blockchain/docs/functions/isTevmBlockTag.md index bf79b44bba..1bf671338a 100644 --- a/packages/blockchain/docs/functions/isTevmBlockTag.md +++ b/packages/blockchain/docs/functions/isTevmBlockTag.md @@ -22,4 +22,4 @@ true if valid block tag ## Defined in -[utils/isTevmBlockTag.js:17](https://github.com/evmts/tevm-monorepo/blob/main/packages/blockchain/src/utils/isTevmBlockTag.js#L17) +[packages/blockchain/src/utils/isTevmBlockTag.js:17](https://github.com/evmts/tevm-monorepo/blob/main/packages/blockchain/src/utils/isTevmBlockTag.js#L17) diff --git a/packages/blockchain/docs/functions/putBlock.md b/packages/blockchain/docs/functions/putBlock.md index c6cb54c0c4..f38cb545d9 100644 --- a/packages/blockchain/docs/functions/putBlock.md +++ b/packages/blockchain/docs/functions/putBlock.md @@ -30,4 +30,4 @@ The block to be added to the blockchain. ## Defined in -[actions/putBlock.js:7](https://github.com/evmts/tevm-monorepo/blob/main/packages/blockchain/src/actions/putBlock.js#L7) +[packages/blockchain/src/actions/putBlock.js:7](https://github.com/evmts/tevm-monorepo/blob/main/packages/blockchain/src/actions/putBlock.js#L7) diff --git a/packages/blockchain/docs/functions/setIteratorHead.md b/packages/blockchain/docs/functions/setIteratorHead.md index 6b758ad99b..4bdc8e5e78 100644 --- a/packages/blockchain/docs/functions/setIteratorHead.md +++ b/packages/blockchain/docs/functions/setIteratorHead.md @@ -35,4 +35,4 @@ The head hash to save ## Defined in -[actions/setIteratorHead.js:7](https://github.com/evmts/tevm-monorepo/blob/main/packages/blockchain/src/actions/setIteratorHead.js#L7) +[packages/blockchain/src/actions/setIteratorHead.js:7](https://github.com/evmts/tevm-monorepo/blob/main/packages/blockchain/src/actions/setIteratorHead.js#L7) diff --git a/packages/blockchain/docs/functions/shallowCopy.md b/packages/blockchain/docs/functions/shallowCopy.md index c71150c7a6..3681007a95 100644 --- a/packages/blockchain/docs/functions/shallowCopy.md +++ b/packages/blockchain/docs/functions/shallowCopy.md @@ -22,4 +22,4 @@ ## Defined in -[actions/shallowCopy.js:7](https://github.com/evmts/tevm-monorepo/blob/main/packages/blockchain/src/actions/shallowCopy.js#L7) +[packages/blockchain/src/actions/shallowCopy.js:7](https://github.com/evmts/tevm-monorepo/blob/main/packages/blockchain/src/actions/shallowCopy.js#L7) diff --git a/packages/blockchain/docs/functions/validateHeader.md b/packages/blockchain/docs/functions/validateHeader.md index 755d27bb33..109fae2467 100644 --- a/packages/blockchain/docs/functions/validateHeader.md +++ b/packages/blockchain/docs/functions/validateHeader.md @@ -34,4 +34,4 @@ If this is an uncle header, this is the height of the block that is including it ## Defined in -[actions/validateHeader.js:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/blockchain/src/actions/validateHeader.js#L8) +[packages/blockchain/src/actions/validateHeader.js:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/blockchain/src/actions/validateHeader.js#L8) diff --git a/packages/blockchain/docs/type-aliases/Chain.md b/packages/blockchain/docs/type-aliases/Chain.md index a457bba118..423470099c 100644 --- a/packages/blockchain/docs/type-aliases/Chain.md +++ b/packages/blockchain/docs/type-aliases/Chain.md @@ -209,4 +209,4 @@ If this is an uncle header, this is the height of the block that is including it ## Defined in -[Chain.ts:16](https://github.com/evmts/tevm-monorepo/blob/main/packages/blockchain/src/Chain.ts#L16) +[packages/blockchain/src/Chain.ts:16](https://github.com/evmts/tevm-monorepo/blob/main/packages/blockchain/src/Chain.ts#L16) diff --git a/packages/blockchain/docs/type-aliases/ChainOptions.md b/packages/blockchain/docs/type-aliases/ChainOptions.md index 9f7089e2ed..c7d8e9d36c 100644 --- a/packages/blockchain/docs/type-aliases/ChainOptions.md +++ b/packages/blockchain/docs/type-aliases/ChainOptions.md @@ -59,4 +59,4 @@ Logging level of blockchain package. Defaults to `warn` ## Defined in -[ChainOptions.ts:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/blockchain/src/ChainOptions.ts#L9) +[packages/blockchain/src/ChainOptions.ts:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/blockchain/src/ChainOptions.ts#L9) diff --git a/packages/blockchain/package.json b/packages/blockchain/package.json index d9a1c1d989..403733b633 100644 --- a/packages/blockchain/package.json +++ b/packages/blockchain/package.json @@ -19,6 +19,7 @@ "contributors": [ "Will Cory " ], + "sideEffects": false, "type": "module", "exports": { "./package.json": "./package.json", @@ -81,6 +82,5 @@ }, "publishConfig": { "access": "public" - }, - "sideEffects": false + } } \ No newline at end of file diff --git a/packages/client-types/docs/README.md b/packages/client-types/docs/README.md index 4ee613d5d8..6c5b3257ab 100644 --- a/packages/client-types/docs/README.md +++ b/packages/client-types/docs/README.md @@ -26,10 +26,10 @@ # @tevm/spec -`@tevm/spec` is the official tevm spec represented as a typescript object [Tevm](./src/Tevm.ts). This spec is implemented by all tevm clients +`@tevm/spec` is the official tevm spec represented as a typescript object [Tevm](). This spec is implemented by all tevm clients including the -## [Tevm.ts](./src/Tevm.ts) +## [Tevm.ts]() `Tevm` is the API type of Tevm implemented by @@ -49,17 +49,17 @@ This API is implemented with the following packages The high-level action based API is what most users and internal code are using whenever possible. It's more ergonomic, types are generic, and it is able to return more than 1 error. -- [@tevm/api/params](./src/params) - Inputs for tevm handlers -- [@tevm/api/result](./src/result) - Outputs for tevm handlers -- [@tevm/api/handlers](./src/handlers) - Generic handler types for processing params into results +- [@tevm/api/params]() - Inputs for tevm handlers +- [@tevm/api/result]() - Outputs for tevm handlers +- [@tevm/api/handlers]() - Generic handler types for processing params into results #### Tevm low-level JSON-rpc based API The lower level JSON-RPC api is more suitable for sending tevm requests remotely and mirrors the high level api. Though sometimes a single JSON-RPC method will be overloaded with multiple higher level API actions. -- [@tevm/api/params](./src/params) - Inputs for tevm handlers -- [@tevm/api/result](./src/result) - Outputs for tevm handlers -- [@tevm/api/handlers](./src/handlers) - Generic handler types for processing params into results +- [@tevm/api/params]() - Inputs for tevm handlers +- [@tevm/api/result]() - Outputs for tevm handlers +- [@tevm/api/handlers]() - Generic handler types for processing params into results ## Visit [Docs](https://tevm.sh/) for docs, guides, API and more! @@ -67,4 +67,4 @@ The lower level JSON-RPC api is more suitable for sending tevm requests remotely ## License 📄 - + diff --git a/packages/client-types/docs/_media/LICENSE b/packages/client-types/docs/_media/LICENSE deleted file mode 100644 index b5a4fa7a69..0000000000 --- a/packages/client-types/docs/_media/LICENSE +++ /dev/null @@ -1,22 +0,0 @@ -(The MIT License) - -Copyright 2020-2022 - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/packages/client-types/docs/type-aliases/TevmClient.md b/packages/client-types/docs/type-aliases/TevmClient.md index cc1c59a101..788fce460b 100644 --- a/packages/client-types/docs/type-aliases/TevmClient.md +++ b/packages/client-types/docs/type-aliases/TevmClient.md @@ -8,6 +8,62 @@ > **TevmClient**: `object` +## Deprecated + +This type has been superseded by Provider types from `@tevm/decorators` package +The docs have not been updated to reflect this change if you are looking at this + +A local EVM instance running in the browser, Bun, or Node.js. Akin to anvil or ganache. The TevmClient interface +is a unified interface that all Clients implement. This provides a consistent developer experience no matter how you are +using Tevm. + +## See + +[TevmClient guide](https://tevm.sh/learn/clients/) for more documentation on clients + +#### JSON-RPC + +Tevm exposes a JSON-RPC interface for interacting with the EVM via the TevmClient.request + +## Examples + +```typescript +import {createMemoryClient, type Tevm} from 'tevm' + +const tevm: Tevm = createMemoryClient() + +await tevm.request({ + method: 'eth_blockNumber', + params: [], + id: 1, + jsonrpc: '2.0', +}) // 0n +``` + +#### Actions + +TevmClient exposes a higher level `actions` based api similar to [viem](https://viem.sh) for interacting with TevmClient in a typesasafe +ergonomic way. + +```typescript +// same as eth_blockNumber example +const account = await tevm.account({address: `0x${'0'.repeat(40)}`}) +console.log(account.balance) // 0n +``` + +#### Ethereum actions + +Ethereum actions are namespaced under TevmClient.eth + +```typescript +const blockNumber = await tevm.eth.blockNumber() +console.log(blockNumber) // 0n +``` + +#### Anvil hardhat and ganache compatibility + +Will have anvil_* ganache_* and hardhat_* JSON-RPC compatibility in future versions + ## Type declaration ### ~~call~~ @@ -419,62 +475,6 @@ await tevm.setAccount({ }) ``` -## Deprecated - -This type has been superseded by Provider types from `@tevm/decorators` package -The docs have not been updated to reflect this change if you are looking at this - -A local EVM instance running in the browser, Bun, or Node.js. Akin to anvil or ganache. The TevmClient interface -is a unified interface that all Clients implement. This provides a consistent developer experience no matter how you are -using Tevm. - -## See - -[TevmClient guide](https://tevm.sh/learn/clients/) for more documentation on clients - -#### JSON-RPC - -Tevm exposes a JSON-RPC interface for interacting with the EVM via the TevmClient.request - -## Examples - -```typescript -import {createMemoryClient, type Tevm} from 'tevm' - -const tevm: Tevm = createMemoryClient() - -await tevm.request({ - method: 'eth_blockNumber', - params: [], - id: 1, - jsonrpc: '2.0', -}) // 0n -``` - -#### Actions - -TevmClient exposes a higher level `actions` based api similar to [viem](https://viem.sh) for interacting with TevmClient in a typesasafe -ergonomic way. - -```typescript -// same as eth_blockNumber example -const account = await tevm.account({address: `0x${'0'.repeat(40)}`}) -console.log(account.balance) // 0n -``` - -#### Ethereum actions - -Ethereum actions are namespaced under TevmClient.eth - -```typescript -const blockNumber = await tevm.eth.blockNumber() -console.log(blockNumber) // 0n -``` - -#### Anvil hardhat and ganache compatibility - -Will have anvil_* ganache_* and hardhat_* JSON-RPC compatibility in future versions - ## Defined in [TevmClient.ts:132](https://github.com/evmts/tevm-monorepo/blob/main/packages/client-types/src/TevmClient.ts#L132) diff --git a/packages/client-types/package.json b/packages/client-types/package.json index 5e7876f510..a10d4b8a98 100644 --- a/packages/client-types/package.json +++ b/packages/client-types/package.json @@ -19,6 +19,7 @@ "contributors": [ "Will Cory " ], + "sideEffects": false, "type": "module", "exports": { "./package.json": "./package.json", @@ -69,6 +70,5 @@ }, "publishConfig": { "access": "public" - }, - "sideEffects": false + } } \ No newline at end of file diff --git a/packages/common/docs/globals.md b/packages/common/docs/globals.md index a66d62bc5b..5c0b71b381 100644 --- a/packages/common/docs/globals.md +++ b/packages/common/docs/globals.md @@ -27,23 +27,340 @@ ## Variables +- [abstractTestnet](variables/abstractTestnet.md) +- [acala](variables/acala.md) +- [ancient8](variables/ancient8.md) +- [ancient8Sepolia](variables/ancient8Sepolia.md) +- [anvil](variables/anvil.md) +- [apexTestnet](variables/apexTestnet.md) - [arbitrum](variables/arbitrum.md) +- [arbitrumGoerli](variables/arbitrumGoerli.md) +- [arbitrumNova](variables/arbitrumNova.md) +- [arbitrumSepolia](variables/arbitrumSepolia.md) +- [areonNetwork](variables/areonNetwork.md) +- [areonNetworkTestnet](variables/areonNetworkTestnet.md) +- [artelaTestnet](variables/artelaTestnet.md) +- [assetChainTestnet](variables/assetChainTestnet.md) +- [astar](variables/astar.md) +- [astarZkEVM](variables/astarZkEVM.md) +- [astarZkyoto](variables/astarZkyoto.md) +- [atletaOlympia](variables/atletaOlympia.md) +- [aurora](variables/aurora.md) +- [auroraTestnet](variables/auroraTestnet.md) +- [auroria](variables/auroria.md) - [avalanche](variables/avalanche.md) +- [avalancheFuji](variables/avalancheFuji.md) +- [b3](variables/b3.md) +- [b3Sepolia](variables/b3Sepolia.md) +- [bahamut](variables/bahamut.md) - [base](variables/base.md) +- [baseGoerli](variables/baseGoerli.md) - [baseSepolia](variables/baseSepolia.md) +- [beam](variables/beam.md) +- [beamTestnet](variables/beamTestnet.md) +- [bearNetworkChainMainnet](variables/bearNetworkChainMainnet.md) +- [bearNetworkChainTestnet](variables/bearNetworkChainTestnet.md) +- [berachainTestnet](variables/berachainTestnet.md) +- [berachainTestnetbArtio](variables/berachainTestnetbArtio.md) +- [bevmMainnet](variables/bevmMainnet.md) +- [bitTorrent](variables/bitTorrent.md) +- [bitTorrentTestnet](variables/bitTorrentTestnet.md) +- [bitkub](variables/bitkub.md) +- [bitkubTestnet](variables/bitkubTestnet.md) - [blast](variables/blast.md) +- [blastSepolia](variables/blastSepolia.md) +- [bob](variables/bob.md) +- [bobSepolia](variables/bobSepolia.md) +- [boba](variables/boba.md) +- [bobaSepolia](variables/bobaSepolia.md) +- [botanixTestnet](variables/botanixTestnet.md) +- [bronos](variables/bronos.md) +- [bronosTestnet](variables/bronosTestnet.md) +- [bsc](variables/bsc.md) +- [bscGreenfield](variables/bscGreenfield.md) +- [bscTestnet](variables/bscTestnet.md) +- [btr](variables/btr.md) +- [btrTestnet](variables/btrTestnet.md) +- [bxn](variables/bxn.md) +- [bxnTestnet](variables/bxnTestnet.md) +- [canto](variables/canto.md) +- [celo](variables/celo.md) +- [celoAlfajores](variables/celoAlfajores.md) +- [chiliz](variables/chiliz.md) +- [chips](variables/chips.md) +- [classic](variables/classic.md) +- [confluxESpace](variables/confluxESpace.md) +- [confluxESpaceTestnet](variables/confluxESpaceTestnet.md) +- [coreDao](variables/coreDao.md) +- [crab](variables/crab.md) +- [cronos](variables/cronos.md) +- [cronosTestnet](variables/cronosTestnet.md) +- [cronoszkEVM](variables/cronoszkEVM.md) +- [cronoszkEVMTestnet](variables/cronoszkEVMTestnet.md) +- [crossbell](variables/crossbell.md) +- [curtis](variables/curtis.md) +- [cyber](variables/cyber.md) +- [cyberTestnet](variables/cyberTestnet.md) +- [darwinia](variables/darwinia.md) +- [dchain](variables/dchain.md) +- [dchainTestnet](variables/dchainTestnet.md) +- [defichainEvm](variables/defichainEvm.md) +- [defichainEvmTestnet](variables/defichainEvmTestnet.md) +- [degen](variables/degen.md) +- [dfk](variables/dfk.md) +- [dodochainTestnet](variables/dodochainTestnet.md) +- [dogechain](variables/dogechain.md) +- [dreyerxMainnet](variables/dreyerxMainnet.md) +- [dreyerxTestnet](variables/dreyerxTestnet.md) +- [edgeless](variables/edgeless.md) +- [edgelessTestnet](variables/edgelessTestnet.md) +- [edgeware](variables/edgeware.md) +- [edgewareTestnet](variables/edgewareTestnet.md) +- [ekta](variables/ekta.md) +- [ektaTestnet](variables/ektaTestnet.md) +- [eon](variables/eon.md) +- [eos](variables/eos.md) +- [eosTestnet](variables/eosTestnet.md) +- [etherlink](variables/etherlink.md) +- [etherlinkTestnet](variables/etherlinkTestnet.md) +- [evmos](variables/evmos.md) +- [evmosTestnet](variables/evmosTestnet.md) +- [fantom](variables/fantom.md) +- [fantomSonicTestnet](variables/fantomSonicTestnet.md) +- [fantomTestnet](variables/fantomTestnet.md) +- [fibo](variables/fibo.md) +- [filecoin](variables/filecoin.md) +- [filecoinCalibration](variables/filecoinCalibration.md) +- [filecoinHyperspace](variables/filecoinHyperspace.md) +- [flare](variables/flare.md) +- [flareTestnet](variables/flareTestnet.md) +- [flowMainnet](variables/flowMainnet.md) +- [flowPreviewnet](variables/flowPreviewnet.md) +- [flowTestnet](variables/flowTestnet.md) +- [fluence](variables/fluence.md) +- [fluenceStage](variables/fluenceStage.md) +- [fluenceTestnet](variables/fluenceTestnet.md) +- [forma](variables/forma.md) +- [foundry](variables/foundry.md) +- [fraxtal](variables/fraxtal.md) +- [fraxtalTestnet](variables/fraxtalTestnet.md) +- [funkiMainnet](variables/funkiMainnet.md) +- [funkiSepolia](variables/funkiSepolia.md) +- [fuse](variables/fuse.md) +- [fuseSparknet](variables/fuseSparknet.md) +- [gnosis](variables/gnosis.md) +- [gnosisChiado](variables/gnosisChiado.md) +- [gobi](variables/gobi.md) +- [goerli](variables/goerli.md) +- [gravity](variables/gravity.md) +- [ham](variables/ham.md) +- [haqqMainnet](variables/haqqMainnet.md) +- [haqqTestedge2](variables/haqqTestedge2.md) +- [hardhat](variables/hardhat.md) +- [harmonyOne](variables/harmonyOne.md) +- [hashkeyTestnet](variables/hashkeyTestnet.md) +- [hedera](variables/hedera.md) +- [hederaPreviewnet](variables/hederaPreviewnet.md) +- [hederaTestnet](variables/hederaTestnet.md) +- [holesky](variables/holesky.md) +- [immutableZkEvm](variables/immutableZkEvm.md) +- [immutableZkEvmTestnet](variables/immutableZkEvmTestnet.md) +- [inEVM](variables/inEVM.md) +- [iota](variables/iota.md) +- [iotaTestnet](variables/iotaTestnet.md) +- [iotex](variables/iotex.md) +- [iotexTestnet](variables/iotexTestnet.md) +- [jbc](variables/jbc.md) +- [jbcTestnet](variables/jbcTestnet.md) +- [kaia](variables/kaia.md) +- [kairos](variables/kairos.md) +- [kakarotSepolia](variables/kakarotSepolia.md) +- [karura](variables/karura.md) +- [kava](variables/kava.md) +- [kavaTestnet](variables/kavaTestnet.md) +- [kcc](variables/kcc.md) +- [klaytn](variables/klaytn.md) +- [klaytnBaobab](variables/klaytnBaobab.md) +- [koi](variables/koi.md) +- [kroma](variables/kroma.md) +- [kromaSepolia](variables/kromaSepolia.md) +- [l3x](variables/l3x.md) +- [l3xTestnet](variables/l3xTestnet.md) +- [lightlinkPegasus](variables/lightlinkPegasus.md) +- [lightlinkPhoenix](variables/lightlinkPhoenix.md) +- [linea](variables/linea.md) +- [lineaGoerli](variables/lineaGoerli.md) +- [lineaSepolia](variables/lineaSepolia.md) +- [lineaTestnet](variables/lineaTestnet.md) +- [lisk](variables/lisk.md) +- [liskSepolia](variables/liskSepolia.md) +- [localhost](variables/localhost.md) +- [lukso](variables/lukso.md) +- [luksoTestnet](variables/luksoTestnet.md) +- [lycan](variables/lycan.md) +- [lyra](variables/lyra.md) - [mainnet](variables/mainnet.md) +- [mandala](variables/mandala.md) - [manta](variables/manta.md) +- [mantaSepoliaTestnet](variables/mantaSepoliaTestnet.md) +- [mantaTestnet](variables/mantaTestnet.md) - [mantle](variables/mantle.md) +- [mantleSepoliaTestnet](variables/mantleSepoliaTestnet.md) +- [mantleTestnet](variables/mantleTestnet.md) +- [merlin](variables/merlin.md) +- [metachain](variables/metachain.md) +- [metachainIstanbul](variables/metachainIstanbul.md) +- [metalL2](variables/metalL2.md) +- [meter](variables/meter.md) +- [meterTestnet](variables/meterTestnet.md) +- [metis](variables/metis.md) +- [metisGoerli](variables/metisGoerli.md) +- [mev](variables/mev.md) +- [mevTestnet](variables/mevTestnet.md) +- [mintSepoliaTestnet](variables/mintSepoliaTestnet.md) +- [mode](variables/mode.md) +- [modeTestnet](variables/modeTestnet.md) +- [moonbaseAlpha](variables/moonbaseAlpha.md) +- [moonbeam](variables/moonbeam.md) +- [moonbeamDev](variables/moonbeamDev.md) +- [moonriver](variables/moonriver.md) +- [morphHolesky](variables/morphHolesky.md) +- [morphSepolia](variables/morphSepolia.md) +- [nautilus](variables/nautilus.md) +- [neonDevnet](variables/neonDevnet.md) +- [neonMainnet](variables/neonMainnet.md) +- [nexi](variables/nexi.md) +- [nexilix](variables/nexilix.md) +- [oasisTestnet](variables/oasisTestnet.md) +- [oasys](variables/oasys.md) +- [okc](variables/okc.md) +- [oortMainnetDev](variables/oortMainnetDev.md) +- [opBNB](variables/opBNB.md) +- [opBNBTestnet](variables/opBNBTestnet.md) - [optimism](variables/optimism.md) +- [optimismGoerli](variables/optimismGoerli.md) - [optimismSepolia](variables/optimismSepolia.md) +- [otimDevnet](variables/otimDevnet.md) +- [palm](variables/palm.md) +- [palmTestnet](variables/palmTestnet.md) +- [pgn](variables/pgn.md) +- [pgnTestnet](variables/pgnTestnet.md) +- [phoenix](variables/phoenix.md) +- [playfiAlbireo](variables/playfiAlbireo.md) +- [plinga](variables/plinga.md) +- [plumeTestnet](variables/plumeTestnet.md) - [polygon](variables/polygon.md) +- [polygonAmoy](variables/polygonAmoy.md) +- [polygonMumbai](variables/polygonMumbai.md) +- [polygonZkEvm](variables/polygonZkEvm.md) +- [polygonZkEvmCardona](variables/polygonZkEvmCardona.md) +- [polygonZkEvmTestnet](variables/polygonZkEvmTestnet.md) +- [pulsechain](variables/pulsechain.md) +- [pulsechainV4](variables/pulsechainV4.md) +- [qMainnet](variables/qMainnet.md) +- [qTestnet](variables/qTestnet.md) +- [real](variables/real.md) +- [redbellyTestnet](variables/redbellyTestnet.md) - [redstone](variables/redstone.md) +- [reyaNetwork](variables/reyaNetwork.md) +- [rollux](variables/rollux.md) +- [rolluxTestnet](variables/rolluxTestnet.md) +- [ronin](variables/ronin.md) +- [root](variables/root.md) +- [rootPorcini](variables/rootPorcini.md) +- [rootstock](variables/rootstock.md) +- [rootstockTestnet](variables/rootstockTestnet.md) +- [rss3](variables/rss3.md) +- [rss3Sepolia](variables/rss3Sepolia.md) +- [saigon](variables/saigon.md) +- [sapphire](variables/sapphire.md) +- [sapphireTestnet](variables/sapphireTestnet.md) +- [satoshiVM](variables/satoshiVM.md) +- [satoshiVMTestnet](variables/satoshiVMTestnet.md) - [scroll](variables/scroll.md) +- [scrollSepolia](variables/scrollSepolia.md) +- [sei](variables/sei.md) +- [seiDevnet](variables/seiDevnet.md) +- [seiTestnet](variables/seiTestnet.md) - [sepolia](variables/sepolia.md) +- [shapeSepolia](variables/shapeSepolia.md) +- [shardeumSphinx](variables/shardeumSphinx.md) +- [shibarium](variables/shibarium.md) +- [shibariumTestnet](variables/shibariumTestnet.md) +- [shimmer](variables/shimmer.md) +- [shimmerTestnet](variables/shimmerTestnet.md) +- [skaleBlockBrawlers](variables/skaleBlockBrawlers.md) +- [skaleCalypso](variables/skaleCalypso.md) +- [skaleCalypsoTestnet](variables/skaleCalypsoTestnet.md) +- [skaleCryptoBlades](variables/skaleCryptoBlades.md) +- [skaleCryptoColosseum](variables/skaleCryptoColosseum.md) +- [skaleEuropa](variables/skaleEuropa.md) +- [skaleEuropaTestnet](variables/skaleEuropaTestnet.md) +- [skaleExorde](variables/skaleExorde.md) +- [skaleHumanProtocol](variables/skaleHumanProtocol.md) +- [skaleNebula](variables/skaleNebula.md) +- [skaleNebulaTestnet](variables/skaleNebulaTestnet.md) +- [skaleRazor](variables/skaleRazor.md) +- [skaleTitan](variables/skaleTitan.md) +- [skaleTitanTestnet](variables/skaleTitanTestnet.md) +- [sketchpad](variables/sketchpad.md) +- [soneiumMinato](variables/soneiumMinato.md) +- [songbird](variables/songbird.md) +- [songbirdTestnet](variables/songbirdTestnet.md) +- [sophonTestnet](variables/sophonTestnet.md) +- [spicy](variables/spicy.md) +- [storyTestnet](variables/storyTestnet.md) +- [stratis](variables/stratis.md) +- [syscoin](variables/syscoin.md) +- [syscoinTestnet](variables/syscoinTestnet.md) +- [taiko](variables/taiko.md) +- [taikoHekla](variables/taikoHekla.md) +- [taikoJolnir](variables/taikoJolnir.md) +- [taikoKatla](variables/taikoKatla.md) +- [taikoTestnetSepolia](variables/taikoTestnetSepolia.md) +- [taraxa](variables/taraxa.md) +- [taraxaTestnet](variables/taraxaTestnet.md) +- [telcoinTestnet](variables/telcoinTestnet.md) +- [telos](variables/telos.md) +- [telosTestnet](variables/telosTestnet.md) +- [tenet](variables/tenet.md) - [tevmDefault](variables/tevmDefault.md) +- [thaiChain](variables/thaiChain.md) +- [thunderTestnet](variables/thunderTestnet.md) +- [tron](variables/tron.md) +- [unreal](variables/unreal.md) +- [vechain](variables/vechain.md) +- [wanchain](variables/wanchain.md) +- [wanchainTestnet](variables/wanchainTestnet.md) +- [wemix](variables/wemix.md) +- [wemixTestnet](variables/wemixTestnet.md) +- [x1Testnet](variables/x1Testnet.md) +- [xLayer](variables/xLayer.md) +- [xLayerTestnet](variables/xLayerTestnet.md) +- [xai](variables/xai.md) +- [xaiTestnet](variables/xaiTestnet.md) +- [xdc](variables/xdc.md) +- [xdcTestnet](variables/xdcTestnet.md) +- [xrSepolia](variables/xrSepolia.md) +- [yooldoVerse](variables/yooldoVerse.md) +- [yooldoVerseTestnet](variables/yooldoVerseTestnet.md) +- [zetachain](variables/zetachain.md) +- [zetachainAthensTestnet](variables/zetachainAthensTestnet.md) +- [zhejiang](variables/zhejiang.md) +- [zilliqa](variables/zilliqa.md) +- [zilliqaTestnet](variables/zilliqaTestnet.md) +- [zircuitTestnet](variables/zircuitTestnet.md) +- [zkFair](variables/zkFair.md) +- [zkFairTestnet](variables/zkFairTestnet.md) +- [zkLinkNova](variables/zkLinkNova.md) +- [zkLinkNovaSepoliaTestnet](variables/zkLinkNovaSepoliaTestnet.md) +- [zksync](variables/zksync.md) +- [zksyncInMemoryNode](variables/zksyncInMemoryNode.md) +- [zksyncLocalNode](variables/zksyncLocalNode.md) +- [zksyncSepoliaTestnet](variables/zksyncSepoliaTestnet.md) - [zora](variables/zora.md) - [zoraSepolia](variables/zoraSepolia.md) +- [zoraTestnet](variables/zoraTestnet.md) ## Functions diff --git a/packages/common/docs/type-aliases/Hardfork.md b/packages/common/docs/type-aliases/Hardfork.md index 16e4e20369..7d0a00d618 100644 --- a/packages/common/docs/type-aliases/Hardfork.md +++ b/packages/common/docs/type-aliases/Hardfork.md @@ -13,7 +13,7 @@ If you use older hardforks you might run into issues with EIPs not being support ## Example -```typesxcript +```typescript import { createCommon, mainnet } from 'tevm/common'` const hardfork: Hardfork = 'shanghai' diff --git a/packages/common/docs/variables/abstractTestnet.md b/packages/common/docs/variables/abstractTestnet.md new file mode 100644 index 0000000000..3826bafbd6 --- /dev/null +++ b/packages/common/docs/variables/abstractTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / abstractTestnet + +# Variable: abstractTestnet + +> `const` **abstractTestnet**: `object` + +Creates a common configuration for the abstractTestnet chain. + +## Description + +Chain ID: 11124 +Chain Name: Abstract Testnet +Default Block Explorer: https://explorer.testnet.abs.xyz +Default RPC URL: https://api.testnet.abs.xyz + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { abstractTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: abstractTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/abstractTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/abstractTestnet.js#L26) diff --git a/packages/common/docs/variables/acala.md b/packages/common/docs/variables/acala.md new file mode 100644 index 0000000000..dc0b1d07c3 --- /dev/null +++ b/packages/common/docs/variables/acala.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / acala + +# Variable: acala + +> `const` **acala**: `object` + +Creates a common configuration for the acala chain. + +## Description + +Chain ID: 787 +Chain Name: Acala +Default Block Explorer: https://blockscout.acala.network +Default RPC URL: https://eth-rpc-acala.aca-api.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { acala } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: acala, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/acala.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/acala.js#L26) diff --git a/packages/common/docs/variables/ancient8.md b/packages/common/docs/variables/ancient8.md new file mode 100644 index 0000000000..409e8a62df --- /dev/null +++ b/packages/common/docs/variables/ancient8.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / ancient8 + +# Variable: ancient8 + +> `const` **ancient8**: `object` + +Creates a common configuration for the ancient8 chain. + +## Description + +Chain ID: 888888888 +Chain Name: Ancient8 +Default Block Explorer: https://scan.ancient8.gg +Default RPC URL: https://rpc.ancient8.gg + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { ancient8 } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: ancient8, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/ancient8.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/ancient8.js#L26) diff --git a/packages/common/docs/variables/ancient8Sepolia.md b/packages/common/docs/variables/ancient8Sepolia.md new file mode 100644 index 0000000000..4d1c1c8c51 --- /dev/null +++ b/packages/common/docs/variables/ancient8Sepolia.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / ancient8Sepolia + +# Variable: ancient8Sepolia + +> `const` **ancient8Sepolia**: `object` + +Creates a common configuration for the ancient8Sepolia chain. + +## Description + +Chain ID: 28122024 +Chain Name: Ancient8 Testnet +Default Block Explorer: https://scanv2-testnet.ancient8.gg +Default RPC URL: https://rpcv2-testnet.ancient8.gg + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { ancient8Sepolia } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: ancient8Sepolia, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/ancient8Sepolia.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/ancient8Sepolia.js#L26) diff --git a/packages/common/docs/variables/anvil.md b/packages/common/docs/variables/anvil.md new file mode 100644 index 0000000000..bc976384bc --- /dev/null +++ b/packages/common/docs/variables/anvil.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / anvil + +# Variable: anvil + +> `const` **anvil**: `object` + +Creates a common configuration for the anvil chain. + +## Description + +Chain ID: 31337 +Chain Name: Anvil +Default Block Explorer: Not specified +Default RPC URL: http://127.0.0.1:8545 + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { anvil } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: anvil, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/anvil.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/anvil.js#L26) diff --git a/packages/common/docs/variables/apexTestnet.md b/packages/common/docs/variables/apexTestnet.md new file mode 100644 index 0000000000..62cf69b7ba --- /dev/null +++ b/packages/common/docs/variables/apexTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / apexTestnet + +# Variable: apexTestnet + +> `const` **apexTestnet**: `object` + +Creates a common configuration for the apexTestnet chain. + +## Description + +Chain ID: 3993 +Chain Name: APEX Testnet +Default Block Explorer: https://exp-testnet.apexlayer.xyz +Default RPC URL: https://rpc-testnet.apexlayer.xyz + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { apexTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: apexTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/apexTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/apexTestnet.js#L26) diff --git a/packages/common/docs/variables/arbitrumGoerli.md b/packages/common/docs/variables/arbitrumGoerli.md new file mode 100644 index 0000000000..97187c150e --- /dev/null +++ b/packages/common/docs/variables/arbitrumGoerli.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / arbitrumGoerli + +# Variable: arbitrumGoerli + +> `const` **arbitrumGoerli**: `object` + +Creates a common configuration for the arbitrumGoerli chain. + +## Description + +Chain ID: 421613 +Chain Name: Arbitrum Goerli +Default Block Explorer: https://goerli.arbiscan.io +Default RPC URL: https://goerli-rollup.arbitrum.io/rpc + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { arbitrumGoerli } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: arbitrumGoerli, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/arbitrumGoerli.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/arbitrumGoerli.js#L26) diff --git a/packages/common/docs/variables/arbitrumNova.md b/packages/common/docs/variables/arbitrumNova.md new file mode 100644 index 0000000000..2efc3d05cc --- /dev/null +++ b/packages/common/docs/variables/arbitrumNova.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / arbitrumNova + +# Variable: arbitrumNova + +> `const` **arbitrumNova**: `object` + +Creates a common configuration for the arbitrumNova chain. + +## Description + +Chain ID: 42170 +Chain Name: Arbitrum Nova +Default Block Explorer: https://nova.arbiscan.io +Default RPC URL: https://nova.arbitrum.io/rpc + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { arbitrumNova } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: arbitrumNova, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/arbitrumNova.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/arbitrumNova.js#L26) diff --git a/packages/common/docs/variables/arbitrumSepolia.md b/packages/common/docs/variables/arbitrumSepolia.md new file mode 100644 index 0000000000..a4fcf33cb7 --- /dev/null +++ b/packages/common/docs/variables/arbitrumSepolia.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / arbitrumSepolia + +# Variable: arbitrumSepolia + +> `const` **arbitrumSepolia**: `object` + +Creates a common configuration for the arbitrumSepolia chain. + +## Description + +Chain ID: 421614 +Chain Name: Arbitrum Sepolia +Default Block Explorer: https://sepolia.arbiscan.io +Default RPC URL: https://sepolia-rollup.arbitrum.io/rpc + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { arbitrumSepolia } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: arbitrumSepolia, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/arbitrumSepolia.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/arbitrumSepolia.js#L26) diff --git a/packages/common/docs/variables/areonNetwork.md b/packages/common/docs/variables/areonNetwork.md new file mode 100644 index 0000000000..b2f1fa4d40 --- /dev/null +++ b/packages/common/docs/variables/areonNetwork.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / areonNetwork + +# Variable: areonNetwork + +> `const` **areonNetwork**: `object` + +Creates a common configuration for the areonNetwork chain. + +## Description + +Chain ID: 463 +Chain Name: Areon Network +Default Block Explorer: https://areonscan.com +Default RPC URL: https://mainnet-rpc.areon.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { areonNetwork } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: areonNetwork, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/areonNetwork.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/areonNetwork.js#L26) diff --git a/packages/common/docs/variables/areonNetworkTestnet.md b/packages/common/docs/variables/areonNetworkTestnet.md new file mode 100644 index 0000000000..5bd7c2396b --- /dev/null +++ b/packages/common/docs/variables/areonNetworkTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / areonNetworkTestnet + +# Variable: areonNetworkTestnet + +> `const` **areonNetworkTestnet**: `object` + +Creates a common configuration for the areonNetworkTestnet chain. + +## Description + +Chain ID: 462 +Chain Name: Areon Network Testnet +Default Block Explorer: https://areonscan.com +Default RPC URL: https://testnet-rpc.areon.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { areonNetworkTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: areonNetworkTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/areonNetworkTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/areonNetworkTestnet.js#L26) diff --git a/packages/common/docs/variables/artelaTestnet.md b/packages/common/docs/variables/artelaTestnet.md new file mode 100644 index 0000000000..3b390c60e2 --- /dev/null +++ b/packages/common/docs/variables/artelaTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / artelaTestnet + +# Variable: artelaTestnet + +> `const` **artelaTestnet**: `object` + +Creates a common configuration for the artelaTestnet chain. + +## Description + +Chain ID: 11822 +Chain Name: Artela Testnet +Default Block Explorer: https://betanet-scan.artela.network +Default RPC URL: https://betanet-rpc1.artela.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { artelaTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: artelaTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/artelaTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/artelaTestnet.js#L26) diff --git a/packages/common/docs/variables/assetChainTestnet.md b/packages/common/docs/variables/assetChainTestnet.md new file mode 100644 index 0000000000..4e0a1e08e5 --- /dev/null +++ b/packages/common/docs/variables/assetChainTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / assetChainTestnet + +# Variable: assetChainTestnet + +> `const` **assetChainTestnet**: `object` + +Creates a common configuration for the assetChainTestnet chain. + +## Description + +Chain ID: 42421 +Chain Name: AssetChain Testnet +Default Block Explorer: https://scan-testnet.assetchain.org +Default RPC URL: https://enugu-rpc.assetchain.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { assetChainTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: assetChainTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/assetChainTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/assetChainTestnet.js#L26) diff --git a/packages/common/docs/variables/astar.md b/packages/common/docs/variables/astar.md new file mode 100644 index 0000000000..8cf0a14e20 --- /dev/null +++ b/packages/common/docs/variables/astar.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / astar + +# Variable: astar + +> `const` **astar**: `object` + +Creates a common configuration for the astar chain. + +## Description + +Chain ID: 592 +Chain Name: Astar +Default Block Explorer: https://astar.subscan.io +Default RPC URL: https://astar.api.onfinality.io/public + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { astar } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: astar, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/astar.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/astar.js#L26) diff --git a/packages/common/docs/variables/astarZkEVM.md b/packages/common/docs/variables/astarZkEVM.md new file mode 100644 index 0000000000..92fbffea09 --- /dev/null +++ b/packages/common/docs/variables/astarZkEVM.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / astarZkEVM + +# Variable: astarZkEVM + +> `const` **astarZkEVM**: `object` + +Creates a common configuration for the astarZkEVM chain. + +## Description + +Chain ID: 3776 +Chain Name: Astar zkEVM +Default Block Explorer: https://astar-zkevm.explorer.startale.com +Default RPC URL: https://rpc.startale.com/astar-zkevm + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { astarZkEVM } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: astarZkEVM, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/astarZkEVM.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/astarZkEVM.js#L26) diff --git a/packages/common/docs/variables/astarZkyoto.md b/packages/common/docs/variables/astarZkyoto.md new file mode 100644 index 0000000000..676e485bff --- /dev/null +++ b/packages/common/docs/variables/astarZkyoto.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / astarZkyoto + +# Variable: astarZkyoto + +> `const` **astarZkyoto**: `object` + +Creates a common configuration for the astarZkyoto chain. + +## Description + +Chain ID: 6038361 +Chain Name: Astar zkEVM Testnet zKyoto +Default Block Explorer: https://zkyoto.explorer.startale.com +Default RPC URL: https://rpc.startale.com/zkyoto + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { astarZkyoto } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: astarZkyoto, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/astarZkyoto.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/astarZkyoto.js#L26) diff --git a/packages/common/docs/variables/atletaOlympia.md b/packages/common/docs/variables/atletaOlympia.md new file mode 100644 index 0000000000..b023f7c36f --- /dev/null +++ b/packages/common/docs/variables/atletaOlympia.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / atletaOlympia + +# Variable: atletaOlympia + +> `const` **atletaOlympia**: `object` + +Creates a common configuration for the atletaOlympia chain. + +## Description + +Chain ID: 2340 +Chain Name: Atleta Olympia +Default Block Explorer: https://blockscout.atleta.network +Default RPC URL: https://testnet-rpc.atleta.network:9944 + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { atletaOlympia } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: atletaOlympia, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/atletaOlympia.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/atletaOlympia.js#L26) diff --git a/packages/common/docs/variables/aurora.md b/packages/common/docs/variables/aurora.md new file mode 100644 index 0000000000..b6f04b3f4d --- /dev/null +++ b/packages/common/docs/variables/aurora.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / aurora + +# Variable: aurora + +> `const` **aurora**: `object` + +Creates a common configuration for the aurora chain. + +## Description + +Chain ID: 1313161554 +Chain Name: Aurora +Default Block Explorer: https://aurorascan.dev +Default RPC URL: https://mainnet.aurora.dev + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { aurora } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: aurora, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/aurora.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/aurora.js#L26) diff --git a/packages/common/docs/variables/auroraTestnet.md b/packages/common/docs/variables/auroraTestnet.md new file mode 100644 index 0000000000..e34bbaa646 --- /dev/null +++ b/packages/common/docs/variables/auroraTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / auroraTestnet + +# Variable: auroraTestnet + +> `const` **auroraTestnet**: `object` + +Creates a common configuration for the auroraTestnet chain. + +## Description + +Chain ID: 1313161555 +Chain Name: Aurora Testnet +Default Block Explorer: https://testnet.aurorascan.dev +Default RPC URL: https://testnet.aurora.dev + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { auroraTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: auroraTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/auroraTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/auroraTestnet.js#L26) diff --git a/packages/common/docs/variables/auroria.md b/packages/common/docs/variables/auroria.md new file mode 100644 index 0000000000..c106707a3b --- /dev/null +++ b/packages/common/docs/variables/auroria.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / auroria + +# Variable: auroria + +> `const` **auroria**: `object` + +Creates a common configuration for the auroria chain. + +## Description + +Chain ID: 205205 +Chain Name: Auroria Testnet +Default Block Explorer: https://auroria.explorer.stratisevm.com +Default RPC URL: https://auroria.rpc.stratisevm.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { auroria } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: auroria, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/auroria.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/auroria.js#L26) diff --git a/packages/common/docs/variables/avalancheFuji.md b/packages/common/docs/variables/avalancheFuji.md new file mode 100644 index 0000000000..c62ee3c166 --- /dev/null +++ b/packages/common/docs/variables/avalancheFuji.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / avalancheFuji + +# Variable: avalancheFuji + +> `const` **avalancheFuji**: `object` + +Creates a common configuration for the avalancheFuji chain. + +## Description + +Chain ID: 43113 +Chain Name: Avalanche Fuji +Default Block Explorer: https://testnet.snowtrace.io +Default RPC URL: https://api.avax-test.network/ext/bc/C/rpc + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { avalancheFuji } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: avalancheFuji, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/avalancheFuji.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/avalancheFuji.js#L26) diff --git a/packages/common/docs/variables/b3.md b/packages/common/docs/variables/b3.md new file mode 100644 index 0000000000..2987abd50f --- /dev/null +++ b/packages/common/docs/variables/b3.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / b3 + +# Variable: b3 + +> `const` **b3**: `object` + +Creates a common configuration for the b3 chain. + +## Description + +Chain ID: 8333 +Chain Name: B3 +Default Block Explorer: https://explorer.b3.fun +Default RPC URL: https://mainnet-rpc.b3.fun/http + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { b3 } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: b3, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/b3.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/b3.js#L26) diff --git a/packages/common/docs/variables/b3Sepolia.md b/packages/common/docs/variables/b3Sepolia.md new file mode 100644 index 0000000000..8c055aabf1 --- /dev/null +++ b/packages/common/docs/variables/b3Sepolia.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / b3Sepolia + +# Variable: b3Sepolia + +> `const` **b3Sepolia**: `object` + +Creates a common configuration for the b3Sepolia chain. + +## Description + +Chain ID: 1993 +Chain Name: B3 Sepolia +Default Block Explorer: https://sepolia.explorer.b3.fun +Default RPC URL: https://sepolia.b3.fun/http + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { b3Sepolia } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: b3Sepolia, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/b3Sepolia.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/b3Sepolia.js#L26) diff --git a/packages/common/docs/variables/bahamut.md b/packages/common/docs/variables/bahamut.md new file mode 100644 index 0000000000..fad5e99272 --- /dev/null +++ b/packages/common/docs/variables/bahamut.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / bahamut + +# Variable: bahamut + +> `const` **bahamut**: `object` + +Creates a common configuration for the bahamut chain. + +## Description + +Chain ID: 5165 +Chain Name: Bahamut +Default Block Explorer: https://www.ftnscan.com +Default RPC URL: https://rpc1.bahamut.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { bahamut } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: bahamut, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/bahamut.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/bahamut.js#L26) diff --git a/packages/common/docs/variables/baseGoerli.md b/packages/common/docs/variables/baseGoerli.md new file mode 100644 index 0000000000..d13a6fc65d --- /dev/null +++ b/packages/common/docs/variables/baseGoerli.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / baseGoerli + +# Variable: baseGoerli + +> `const` **baseGoerli**: `object` + +Creates a common configuration for the baseGoerli chain. + +## Description + +Chain ID: 84531 +Chain Name: Base Goerli +Default Block Explorer: https://goerli.basescan.org +Default RPC URL: https://goerli.base.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { baseGoerli } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: baseGoerli, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/baseGoerli.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/baseGoerli.js#L26) diff --git a/packages/common/docs/variables/beam.md b/packages/common/docs/variables/beam.md new file mode 100644 index 0000000000..208c976836 --- /dev/null +++ b/packages/common/docs/variables/beam.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / beam + +# Variable: beam + +> `const` **beam**: `object` + +Creates a common configuration for the beam chain. + +## Description + +Chain ID: 4337 +Chain Name: Beam +Default Block Explorer: https://subnets.avax.network/beam +Default RPC URL: https://build.onbeam.com/rpc + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { beam } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: beam, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/beam.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/beam.js#L26) diff --git a/packages/common/docs/variables/beamTestnet.md b/packages/common/docs/variables/beamTestnet.md new file mode 100644 index 0000000000..233f13b021 --- /dev/null +++ b/packages/common/docs/variables/beamTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / beamTestnet + +# Variable: beamTestnet + +> `const` **beamTestnet**: `object` + +Creates a common configuration for the beamTestnet chain. + +## Description + +Chain ID: 13337 +Chain Name: Beam Testnet +Default Block Explorer: https://subnets-test.avax.network/beam +Default RPC URL: https://build.onbeam.com/rpc/testnet + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { beamTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: beamTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/beamTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/beamTestnet.js#L26) diff --git a/packages/common/docs/variables/bearNetworkChainMainnet.md b/packages/common/docs/variables/bearNetworkChainMainnet.md new file mode 100644 index 0000000000..825b3b9645 --- /dev/null +++ b/packages/common/docs/variables/bearNetworkChainMainnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / bearNetworkChainMainnet + +# Variable: bearNetworkChainMainnet + +> `const` **bearNetworkChainMainnet**: `object` + +Creates a common configuration for the bearNetworkChainMainnet chain. + +## Description + +Chain ID: 641230 +Chain Name: Bear Network Chain Mainnet +Default Block Explorer: https://brnkscan.bearnetwork.net +Default RPC URL: https://brnkc-mainnet.bearnetwork.net + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { bearNetworkChainMainnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: bearNetworkChainMainnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/bearNetworkChainMainnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/bearNetworkChainMainnet.js#L26) diff --git a/packages/common/docs/variables/bearNetworkChainTestnet.md b/packages/common/docs/variables/bearNetworkChainTestnet.md new file mode 100644 index 0000000000..77caf36d99 --- /dev/null +++ b/packages/common/docs/variables/bearNetworkChainTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / bearNetworkChainTestnet + +# Variable: bearNetworkChainTestnet + +> `const` **bearNetworkChainTestnet**: `object` + +Creates a common configuration for the bearNetworkChainTestnet chain. + +## Description + +Chain ID: 751230 +Chain Name: Bear Network Chain Testnet +Default Block Explorer: https://brnktest-scan.bearnetwork.net +Default RPC URL: https://brnkc-test.bearnetwork.net + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { bearNetworkChainTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: bearNetworkChainTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/bearNetworkChainTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/bearNetworkChainTestnet.js#L26) diff --git a/packages/common/docs/variables/berachainTestnet.md b/packages/common/docs/variables/berachainTestnet.md new file mode 100644 index 0000000000..d16529211f --- /dev/null +++ b/packages/common/docs/variables/berachainTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / berachainTestnet + +# Variable: berachainTestnet + +> `const` **berachainTestnet**: `object` + +Creates a common configuration for the berachainTestnet chain. + +## Description + +Chain ID: 80085 +Chain Name: Berachain Artio +Default Block Explorer: https://artio.beratrail.io +Default RPC URL: https://artio.rpc.berachain.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { berachainTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: berachainTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/berachainTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/berachainTestnet.js#L26) diff --git a/packages/common/docs/variables/berachainTestnetbArtio.md b/packages/common/docs/variables/berachainTestnetbArtio.md new file mode 100644 index 0000000000..22e52ffa17 --- /dev/null +++ b/packages/common/docs/variables/berachainTestnetbArtio.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / berachainTestnetbArtio + +# Variable: berachainTestnetbArtio + +> `const` **berachainTestnetbArtio**: `object` + +Creates a common configuration for the berachainTestnetbArtio chain. + +## Description + +Chain ID: 80084 +Chain Name: Berachain bArtio +Default Block Explorer: https://bartio.beratrail.io +Default RPC URL: https://bartio.rpc.berachain.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { berachainTestnetbArtio } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: berachainTestnetbArtio, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/berachainTestnetbArtio.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/berachainTestnetbArtio.js#L26) diff --git a/packages/common/docs/variables/bevmMainnet.md b/packages/common/docs/variables/bevmMainnet.md new file mode 100644 index 0000000000..01ea857140 --- /dev/null +++ b/packages/common/docs/variables/bevmMainnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / bevmMainnet + +# Variable: bevmMainnet + +> `const` **bevmMainnet**: `object` + +Creates a common configuration for the bevmMainnet chain. + +## Description + +Chain ID: 11501 +Chain Name: BEVM Mainnet +Default Block Explorer: https://scan-mainnet.bevm.io +Default RPC URL: https://rpc-mainnet-1.bevm.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { bevmMainnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: bevmMainnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/bevmMainnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/bevmMainnet.js#L26) diff --git a/packages/common/docs/variables/bitTorrent.md b/packages/common/docs/variables/bitTorrent.md new file mode 100644 index 0000000000..06737e68ba --- /dev/null +++ b/packages/common/docs/variables/bitTorrent.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / bitTorrent + +# Variable: bitTorrent + +> `const` **bitTorrent**: `object` + +Creates a common configuration for the bitTorrent chain. + +## Description + +Chain ID: 199 +Chain Name: BitTorrent +Default Block Explorer: https://bttcscan.com +Default RPC URL: https://rpc.bittorrentchain.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { bitTorrent } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: bitTorrent, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/bitTorrent.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/bitTorrent.js#L26) diff --git a/packages/common/docs/variables/bitTorrentTestnet.md b/packages/common/docs/variables/bitTorrentTestnet.md new file mode 100644 index 0000000000..dd4d9a34b0 --- /dev/null +++ b/packages/common/docs/variables/bitTorrentTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / bitTorrentTestnet + +# Variable: bitTorrentTestnet + +> `const` **bitTorrentTestnet**: `object` + +Creates a common configuration for the bitTorrentTestnet chain. + +## Description + +Chain ID: 1028 +Chain Name: BitTorrent Chain Testnet +Default Block Explorer: https://testnet.bttcscan.com +Default RPC URL: https://testrpc.bittorrentchain.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { bitTorrentTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: bitTorrentTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/bitTorrentTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/bitTorrentTestnet.js#L26) diff --git a/packages/common/docs/variables/bitkub.md b/packages/common/docs/variables/bitkub.md new file mode 100644 index 0000000000..f7de36d429 --- /dev/null +++ b/packages/common/docs/variables/bitkub.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / bitkub + +# Variable: bitkub + +> `const` **bitkub**: `object` + +Creates a common configuration for the bitkub chain. + +## Description + +Chain ID: 96 +Chain Name: Bitkub +Default Block Explorer: https://www.bkcscan.com +Default RPC URL: https://rpc.bitkubchain.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { bitkub } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: bitkub, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/bitkub.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/bitkub.js#L26) diff --git a/packages/common/docs/variables/bitkubTestnet.md b/packages/common/docs/variables/bitkubTestnet.md new file mode 100644 index 0000000000..c07939b12d --- /dev/null +++ b/packages/common/docs/variables/bitkubTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / bitkubTestnet + +# Variable: bitkubTestnet + +> `const` **bitkubTestnet**: `object` + +Creates a common configuration for the bitkubTestnet chain. + +## Description + +Chain ID: 25925 +Chain Name: Bitkub Testnet +Default Block Explorer: https://testnet.bkcscan.com +Default RPC URL: https://rpc-testnet.bitkubchain.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { bitkubTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: bitkubTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/bitkubTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/bitkubTestnet.js#L26) diff --git a/packages/common/docs/variables/blastSepolia.md b/packages/common/docs/variables/blastSepolia.md new file mode 100644 index 0000000000..9f912008c8 --- /dev/null +++ b/packages/common/docs/variables/blastSepolia.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / blastSepolia + +# Variable: blastSepolia + +> `const` **blastSepolia**: `object` + +Creates a common configuration for the blastSepolia chain. + +## Description + +Chain ID: 168587773 +Chain Name: Blast Sepolia +Default Block Explorer: https://sepolia.blastscan.io +Default RPC URL: https://sepolia.blast.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { blastSepolia } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: blastSepolia, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/blastSepolia.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/blastSepolia.js#L26) diff --git a/packages/common/docs/variables/bob.md b/packages/common/docs/variables/bob.md new file mode 100644 index 0000000000..3c83379cd0 --- /dev/null +++ b/packages/common/docs/variables/bob.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / bob + +# Variable: bob + +> `const` **bob**: `object` + +Creates a common configuration for the bob chain. + +## Description + +Chain ID: 60808 +Chain Name: BOB +Default Block Explorer: https://explorer.gobob.xyz +Default RPC URL: https://rpc.gobob.xyz + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { bob } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: bob, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/bob.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/bob.js#L26) diff --git a/packages/common/docs/variables/bobSepolia.md b/packages/common/docs/variables/bobSepolia.md new file mode 100644 index 0000000000..16e77e8705 --- /dev/null +++ b/packages/common/docs/variables/bobSepolia.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / bobSepolia + +# Variable: bobSepolia + +> `const` **bobSepolia**: `object` + +Creates a common configuration for the bobSepolia chain. + +## Description + +Chain ID: 808813 +Chain Name: BOB Sepolia +Default Block Explorer: https://bob-sepolia.explorer.gobob.xyz +Default RPC URL: https://bob-sepolia.rpc.gobob.xyz + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { bobSepolia } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: bobSepolia, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/bobSepolia.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/bobSepolia.js#L26) diff --git a/packages/common/docs/variables/boba.md b/packages/common/docs/variables/boba.md new file mode 100644 index 0000000000..af28e23643 --- /dev/null +++ b/packages/common/docs/variables/boba.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / boba + +# Variable: boba + +> `const` **boba**: `object` + +Creates a common configuration for the boba chain. + +## Description + +Chain ID: 288 +Chain Name: Boba Network +Default Block Explorer: https://bobascan.com +Default RPC URL: https://mainnet.boba.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { boba } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: boba, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/boba.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/boba.js#L26) diff --git a/packages/common/docs/variables/bobaSepolia.md b/packages/common/docs/variables/bobaSepolia.md new file mode 100644 index 0000000000..7b5ae6d31d --- /dev/null +++ b/packages/common/docs/variables/bobaSepolia.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / bobaSepolia + +# Variable: bobaSepolia + +> `const` **bobaSepolia**: `object` + +Creates a common configuration for the bobaSepolia chain. + +## Description + +Chain ID: 28882 +Chain Name: Boba Sepolia +Default Block Explorer: https://testnet.bobascan.com +Default RPC URL: https://sepolia.boba.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { bobaSepolia } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: bobaSepolia, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/bobaSepolia.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/bobaSepolia.js#L26) diff --git a/packages/common/docs/variables/botanixTestnet.md b/packages/common/docs/variables/botanixTestnet.md new file mode 100644 index 0000000000..fcdc00230c --- /dev/null +++ b/packages/common/docs/variables/botanixTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / botanixTestnet + +# Variable: botanixTestnet + +> `const` **botanixTestnet**: `object` + +Creates a common configuration for the botanixTestnet chain. + +## Description + +Chain ID: 3636 +Chain Name: Botanix Testnet +Default Block Explorer: https://blockscout.botanixlabs.dev +Default RPC URL: https://poa-node.botanixlabs.dev + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { botanixTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: botanixTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/botanixTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/botanixTestnet.js#L26) diff --git a/packages/common/docs/variables/bronos.md b/packages/common/docs/variables/bronos.md new file mode 100644 index 0000000000..584dae58f8 --- /dev/null +++ b/packages/common/docs/variables/bronos.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / bronos + +# Variable: bronos + +> `const` **bronos**: `object` + +Creates a common configuration for the bronos chain. + +## Description + +Chain ID: 1039 +Chain Name: Bronos +Default Block Explorer: https://broscan.bronos.org +Default RPC URL: https://evm.bronos.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { bronos } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: bronos, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/bronos.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/bronos.js#L26) diff --git a/packages/common/docs/variables/bronosTestnet.md b/packages/common/docs/variables/bronosTestnet.md new file mode 100644 index 0000000000..2b5f12af02 --- /dev/null +++ b/packages/common/docs/variables/bronosTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / bronosTestnet + +# Variable: bronosTestnet + +> `const` **bronosTestnet**: `object` + +Creates a common configuration for the bronosTestnet chain. + +## Description + +Chain ID: 1038 +Chain Name: Bronos Testnet +Default Block Explorer: https://tbroscan.bronos.org +Default RPC URL: https://evm-testnet.bronos.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { bronosTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: bronosTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/bronosTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/bronosTestnet.js#L26) diff --git a/packages/common/docs/variables/bsc.md b/packages/common/docs/variables/bsc.md new file mode 100644 index 0000000000..254a584653 --- /dev/null +++ b/packages/common/docs/variables/bsc.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / bsc + +# Variable: bsc + +> `const` **bsc**: `object` + +Creates a common configuration for the bsc chain. + +## Description + +Chain ID: 56 +Chain Name: BNB Smart Chain +Default Block Explorer: https://bscscan.com +Default RPC URL: https://rpc.ankr.com/bsc + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { bsc } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: bsc, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/bsc.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/bsc.js#L26) diff --git a/packages/common/docs/variables/bscGreenfield.md b/packages/common/docs/variables/bscGreenfield.md new file mode 100644 index 0000000000..e2ebe25a89 --- /dev/null +++ b/packages/common/docs/variables/bscGreenfield.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / bscGreenfield + +# Variable: bscGreenfield + +> `const` **bscGreenfield**: `object` + +Creates a common configuration for the bscGreenfield chain. + +## Description + +Chain ID: 1017 +Chain Name: BNB Greenfield Chain +Default Block Explorer: https://greenfieldscan.com +Default RPC URL: https://greenfield-chain.bnbchain.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { bscGreenfield } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: bscGreenfield, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/bscGreenfield.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/bscGreenfield.js#L26) diff --git a/packages/common/docs/variables/bscTestnet.md b/packages/common/docs/variables/bscTestnet.md new file mode 100644 index 0000000000..997ded478d --- /dev/null +++ b/packages/common/docs/variables/bscTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / bscTestnet + +# Variable: bscTestnet + +> `const` **bscTestnet**: `object` + +Creates a common configuration for the bscTestnet chain. + +## Description + +Chain ID: 97 +Chain Name: Binance Smart Chain Testnet +Default Block Explorer: https://testnet.bscscan.com +Default RPC URL: https://data-seed-prebsc-1-s1.bnbchain.org:8545 + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { bscTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: bscTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/bscTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/bscTestnet.js#L26) diff --git a/packages/common/docs/variables/btr.md b/packages/common/docs/variables/btr.md new file mode 100644 index 0000000000..7dadef5adf --- /dev/null +++ b/packages/common/docs/variables/btr.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / btr + +# Variable: btr + +> `const` **btr**: `object` + +Creates a common configuration for the btr chain. + +## Description + +Chain ID: 200901 +Chain Name: Bitlayer +Default Block Explorer: https://www.btrscan.com +Default RPC URL: https://rpc.bitlayer.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { btr } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: btr, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/btr.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/btr.js#L26) diff --git a/packages/common/docs/variables/btrTestnet.md b/packages/common/docs/variables/btrTestnet.md new file mode 100644 index 0000000000..555673c570 --- /dev/null +++ b/packages/common/docs/variables/btrTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / btrTestnet + +# Variable: btrTestnet + +> `const` **btrTestnet**: `object` + +Creates a common configuration for the btrTestnet chain. + +## Description + +Chain ID: 200810 +Chain Name: Bitlayer Testnet +Default Block Explorer: https://testnet.btrscan.com +Default RPC URL: https://testnet-rpc.bitlayer.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { btrTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: btrTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/btrTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/btrTestnet.js#L26) diff --git a/packages/common/docs/variables/bxn.md b/packages/common/docs/variables/bxn.md new file mode 100644 index 0000000000..665c1c807a --- /dev/null +++ b/packages/common/docs/variables/bxn.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / bxn + +# Variable: bxn + +> `const` **bxn**: `object` + +Creates a common configuration for the bxn chain. + +## Description + +Chain ID: 4999 +Chain Name: BlackFort Exchange Network +Default Block Explorer: https://explorer.blackfort.network +Default RPC URL: https://mainnet.blackfort.network/rpc + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { bxn } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: bxn, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/bxn.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/bxn.js#L26) diff --git a/packages/common/docs/variables/bxnTestnet.md b/packages/common/docs/variables/bxnTestnet.md new file mode 100644 index 0000000000..645dec0984 --- /dev/null +++ b/packages/common/docs/variables/bxnTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / bxnTestnet + +# Variable: bxnTestnet + +> `const` **bxnTestnet**: `object` + +Creates a common configuration for the bxnTestnet chain. + +## Description + +Chain ID: 4777 +Chain Name: BlackFort Exchange Network Testnet +Default Block Explorer: https://testnet-explorer.blackfort.network +Default RPC URL: https://testnet.blackfort.network/rpc + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { bxnTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: bxnTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/bxnTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/bxnTestnet.js#L26) diff --git a/packages/common/docs/variables/canto.md b/packages/common/docs/variables/canto.md new file mode 100644 index 0000000000..b6749586ff --- /dev/null +++ b/packages/common/docs/variables/canto.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / canto + +# Variable: canto + +> `const` **canto**: `object` + +Creates a common configuration for the canto chain. + +## Description + +Chain ID: 7700 +Chain Name: Canto +Default Block Explorer: https://tuber.build +Default RPC URL: https://canto.gravitychain.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { canto } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: canto, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/canto.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/canto.js#L26) diff --git a/packages/common/docs/variables/celo.md b/packages/common/docs/variables/celo.md new file mode 100644 index 0000000000..e4ec2a0df5 --- /dev/null +++ b/packages/common/docs/variables/celo.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / celo + +# Variable: celo + +> `const` **celo**: `object` + +Creates a common configuration for the celo chain. + +## Description + +Chain ID: 42220 +Chain Name: Celo +Default Block Explorer: https://celoscan.io +Default RPC URL: https://forno.celo.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { celo } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: celo, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/celo.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/celo.js#L26) diff --git a/packages/common/docs/variables/celoAlfajores.md b/packages/common/docs/variables/celoAlfajores.md new file mode 100644 index 0000000000..1a6277569f --- /dev/null +++ b/packages/common/docs/variables/celoAlfajores.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / celoAlfajores + +# Variable: celoAlfajores + +> `const` **celoAlfajores**: `object` + +Creates a common configuration for the celoAlfajores chain. + +## Description + +Chain ID: 44787 +Chain Name: Alfajores +Default Block Explorer: https://explorer.celo.org/alfajores +Default RPC URL: https://alfajores-forno.celo-testnet.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { celoAlfajores } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: celoAlfajores, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/celoAlfajores.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/celoAlfajores.js#L26) diff --git a/packages/common/docs/variables/chiliz.md b/packages/common/docs/variables/chiliz.md new file mode 100644 index 0000000000..4c6b30b466 --- /dev/null +++ b/packages/common/docs/variables/chiliz.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / chiliz + +# Variable: chiliz + +> `const` **chiliz**: `object` + +Creates a common configuration for the chiliz chain. + +## Description + +Chain ID: 88888 +Chain Name: Chiliz Chain +Default Block Explorer: https://scan.chiliz.com +Default RPC URL: https://rpc.ankr.com/chiliz + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { chiliz } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: chiliz, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/chiliz.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/chiliz.js#L26) diff --git a/packages/common/docs/variables/chips.md b/packages/common/docs/variables/chips.md new file mode 100644 index 0000000000..cd50c21dc7 --- /dev/null +++ b/packages/common/docs/variables/chips.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / chips + +# Variable: chips + +> `const` **chips**: `object` + +Creates a common configuration for the chips chain. + +## Description + +Chain ID: 2882 +Chain Name: Chips Network +Default Block Explorer: Not specified +Default RPC URL: https://node.chips.ooo/wasp/api/v1/chains/iota1pp3d3mnap3ufmgqnjsnw344sqmf5svjh26y2khnmc89sv6788y3r207a8fn/evm + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { chips } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: chips, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/chips.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/chips.js#L26) diff --git a/packages/common/docs/variables/classic.md b/packages/common/docs/variables/classic.md new file mode 100644 index 0000000000..27765d4bf5 --- /dev/null +++ b/packages/common/docs/variables/classic.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / classic + +# Variable: classic + +> `const` **classic**: `object` + +Creates a common configuration for the classic chain. + +## Description + +Chain ID: 61 +Chain Name: Ethereum Classic +Default Block Explorer: https://blockscout.com/etc/mainnet +Default RPC URL: https://etc.rivet.link + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { classic } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: classic, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/classic.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/classic.js#L26) diff --git a/packages/common/docs/variables/confluxESpace.md b/packages/common/docs/variables/confluxESpace.md new file mode 100644 index 0000000000..c3283201c7 --- /dev/null +++ b/packages/common/docs/variables/confluxESpace.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / confluxESpace + +# Variable: confluxESpace + +> `const` **confluxESpace**: `object` + +Creates a common configuration for the confluxESpace chain. + +## Description + +Chain ID: 1030 +Chain Name: Conflux eSpace +Default Block Explorer: https://evm.confluxscan.io +Default RPC URL: https://evm.confluxrpc.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { confluxESpace } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: confluxESpace, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/confluxESpace.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/confluxESpace.js#L26) diff --git a/packages/common/docs/variables/confluxESpaceTestnet.md b/packages/common/docs/variables/confluxESpaceTestnet.md new file mode 100644 index 0000000000..fb6e74abab --- /dev/null +++ b/packages/common/docs/variables/confluxESpaceTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / confluxESpaceTestnet + +# Variable: confluxESpaceTestnet + +> `const` **confluxESpaceTestnet**: `object` + +Creates a common configuration for the confluxESpaceTestnet chain. + +## Description + +Chain ID: 71 +Chain Name: Conflux eSpace Testnet +Default Block Explorer: https://evmtestnet.confluxscan.io +Default RPC URL: https://evmtestnet.confluxrpc.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { confluxESpaceTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: confluxESpaceTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/confluxESpaceTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/confluxESpaceTestnet.js#L26) diff --git a/packages/common/docs/variables/coreDao.md b/packages/common/docs/variables/coreDao.md new file mode 100644 index 0000000000..b83cb37d5c --- /dev/null +++ b/packages/common/docs/variables/coreDao.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / coreDao + +# Variable: coreDao + +> `const` **coreDao**: `object` + +Creates a common configuration for the coreDao chain. + +## Description + +Chain ID: 1116 +Chain Name: Core Dao +Default Block Explorer: https://scan.coredao.org +Default RPC URL: https://rpc.coredao.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { coreDao } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: coreDao, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/coreDao.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/coreDao.js#L26) diff --git a/packages/common/docs/variables/crab.md b/packages/common/docs/variables/crab.md new file mode 100644 index 0000000000..b82f199bbf --- /dev/null +++ b/packages/common/docs/variables/crab.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / crab + +# Variable: crab + +> `const` **crab**: `object` + +Creates a common configuration for the crab chain. + +## Description + +Chain ID: 44 +Chain Name: Crab Network +Default Block Explorer: https://crab-scan.darwinia.network +Default RPC URL: https://crab-rpc.darwinia.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { crab } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: crab, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/crab.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/crab.js#L26) diff --git a/packages/common/docs/variables/cronos.md b/packages/common/docs/variables/cronos.md new file mode 100644 index 0000000000..e6979e8b1f --- /dev/null +++ b/packages/common/docs/variables/cronos.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / cronos + +# Variable: cronos + +> `const` **cronos**: `object` + +Creates a common configuration for the cronos chain. + +## Description + +Chain ID: 25 +Chain Name: Cronos Mainnet +Default Block Explorer: https://explorer.cronos.org +Default RPC URL: https://evm.cronos.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { cronos } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: cronos, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/cronos.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/cronos.js#L26) diff --git a/packages/common/docs/variables/cronosTestnet.md b/packages/common/docs/variables/cronosTestnet.md new file mode 100644 index 0000000000..f938696c42 --- /dev/null +++ b/packages/common/docs/variables/cronosTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / cronosTestnet + +# Variable: cronosTestnet + +> `const` **cronosTestnet**: `object` + +Creates a common configuration for the cronosTestnet chain. + +## Description + +Chain ID: 338 +Chain Name: Cronos Testnet +Default Block Explorer: https://cronos.org/explorer/testnet3 +Default RPC URL: https://evm-t3.cronos.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { cronosTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: cronosTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/cronosTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/cronosTestnet.js#L26) diff --git a/packages/common/docs/variables/cronoszkEVM.md b/packages/common/docs/variables/cronoszkEVM.md new file mode 100644 index 0000000000..7ca6e8e137 --- /dev/null +++ b/packages/common/docs/variables/cronoszkEVM.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / cronoszkEVM + +# Variable: cronoszkEVM + +> `const` **cronoszkEVM**: `object` + +Creates a common configuration for the cronoszkEVM chain. + +## Description + +Chain ID: 388 +Chain Name: Cronos zkEVM Mainnet +Default Block Explorer: https://explorer.zkevm.cronos.org +Default RPC URL: https://mainnet.zkevm.cronos.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { cronoszkEVM } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: cronoszkEVM, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/cronoszkEVM.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/cronoszkEVM.js#L26) diff --git a/packages/common/docs/variables/cronoszkEVMTestnet.md b/packages/common/docs/variables/cronoszkEVMTestnet.md new file mode 100644 index 0000000000..074c2355a6 --- /dev/null +++ b/packages/common/docs/variables/cronoszkEVMTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / cronoszkEVMTestnet + +# Variable: cronoszkEVMTestnet + +> `const` **cronoszkEVMTestnet**: `object` + +Creates a common configuration for the cronoszkEVMTestnet chain. + +## Description + +Chain ID: 282 +Chain Name: Cronos zkEVM Testnet +Default Block Explorer: https://explorer.zkevm.cronos.org/testnet +Default RPC URL: https://testnet.zkevm.cronos.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { cronoszkEVMTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: cronoszkEVMTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/cronoszkEVMTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/cronoszkEVMTestnet.js#L26) diff --git a/packages/common/docs/variables/crossbell.md b/packages/common/docs/variables/crossbell.md new file mode 100644 index 0000000000..7e195084a9 --- /dev/null +++ b/packages/common/docs/variables/crossbell.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / crossbell + +# Variable: crossbell + +> `const` **crossbell**: `object` + +Creates a common configuration for the crossbell chain. + +## Description + +Chain ID: 3737 +Chain Name: Crossbell +Default Block Explorer: https://scan.crossbell.io +Default RPC URL: https://rpc.crossbell.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { crossbell } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: crossbell, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/crossbell.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/crossbell.js#L26) diff --git a/packages/common/docs/variables/curtis.md b/packages/common/docs/variables/curtis.md new file mode 100644 index 0000000000..af0670978f --- /dev/null +++ b/packages/common/docs/variables/curtis.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / curtis + +# Variable: curtis + +> `const` **curtis**: `object` + +Creates a common configuration for the curtis chain. + +## Description + +Chain ID: 33111 +Chain Name: Curtis +Default Block Explorer: https://explorer.curtis.apechain.com +Default RPC URL: https://rpc.curtis.apechain.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { curtis } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: curtis, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/curtis.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/curtis.js#L26) diff --git a/packages/common/docs/variables/cyber.md b/packages/common/docs/variables/cyber.md new file mode 100644 index 0000000000..988b6550aa --- /dev/null +++ b/packages/common/docs/variables/cyber.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / cyber + +# Variable: cyber + +> `const` **cyber**: `object` + +Creates a common configuration for the cyber chain. + +## Description + +Chain ID: 7560 +Chain Name: Cyber +Default Block Explorer: https://cyberscan.co +Default RPC URL: https://cyber.alt.technology + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { cyber } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: cyber, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/cyber.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/cyber.js#L26) diff --git a/packages/common/docs/variables/cyberTestnet.md b/packages/common/docs/variables/cyberTestnet.md new file mode 100644 index 0000000000..631035dc95 --- /dev/null +++ b/packages/common/docs/variables/cyberTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / cyberTestnet + +# Variable: cyberTestnet + +> `const` **cyberTestnet**: `object` + +Creates a common configuration for the cyberTestnet chain. + +## Description + +Chain ID: 111557560 +Chain Name: Cyber Testnet +Default Block Explorer: https://testnet.cyberscan.co +Default RPC URL: https://cyber-testnet.alt.technology + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { cyberTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: cyberTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/cyberTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/cyberTestnet.js#L26) diff --git a/packages/common/docs/variables/darwinia.md b/packages/common/docs/variables/darwinia.md new file mode 100644 index 0000000000..09555b3337 --- /dev/null +++ b/packages/common/docs/variables/darwinia.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / darwinia + +# Variable: darwinia + +> `const` **darwinia**: `object` + +Creates a common configuration for the darwinia chain. + +## Description + +Chain ID: 46 +Chain Name: Darwinia Network +Default Block Explorer: https://explorer.darwinia.network +Default RPC URL: https://rpc.darwinia.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { darwinia } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: darwinia, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/darwinia.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/darwinia.js#L26) diff --git a/packages/common/docs/variables/dchain.md b/packages/common/docs/variables/dchain.md new file mode 100644 index 0000000000..c625b2e2b5 --- /dev/null +++ b/packages/common/docs/variables/dchain.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / dchain + +# Variable: dchain + +> `const` **dchain**: `object` + +Creates a common configuration for the dchain chain. + +## Description + +Chain ID: 2716446429837000 +Chain Name: Dchain +Default Block Explorer: https://dchain-2716446429837000-1.sagaexplorer.io +Default RPC URL: https://dchain-2716446429837000-1.jsonrpc.sagarpc.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { dchain } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: dchain, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/dchain.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/dchain.js#L26) diff --git a/packages/common/docs/variables/dchainTestnet.md b/packages/common/docs/variables/dchainTestnet.md new file mode 100644 index 0000000000..2dda219eee --- /dev/null +++ b/packages/common/docs/variables/dchainTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / dchainTestnet + +# Variable: dchainTestnet + +> `const` **dchainTestnet**: `object` + +Creates a common configuration for the dchainTestnet chain. + +## Description + +Chain ID: 2713017997578000 +Chain Name: Dchain Testnet +Default Block Explorer: https://dchaintestnet-2713017997578000-1.testnet.sagaexplorer.io +Default RPC URL: https://dchaintestnet-2713017997578000-1.jsonrpc.testnet.sagarpc.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { dchainTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: dchainTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/dchainTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/dchainTestnet.js#L26) diff --git a/packages/common/docs/variables/defichainEvm.md b/packages/common/docs/variables/defichainEvm.md new file mode 100644 index 0000000000..882b5e9763 --- /dev/null +++ b/packages/common/docs/variables/defichainEvm.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / defichainEvm + +# Variable: defichainEvm + +> `const` **defichainEvm**: `object` + +Creates a common configuration for the defichainEvm chain. + +## Description + +Chain ID: 1130 +Chain Name: DeFiChain EVM Mainnet +Default Block Explorer: https://meta.defiscan.live +Default RPC URL: https://eth.mainnet.ocean.jellyfishsdk.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { defichainEvm } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: defichainEvm, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/defichainEvm.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/defichainEvm.js#L26) diff --git a/packages/common/docs/variables/defichainEvmTestnet.md b/packages/common/docs/variables/defichainEvmTestnet.md new file mode 100644 index 0000000000..f861aaa90c --- /dev/null +++ b/packages/common/docs/variables/defichainEvmTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / defichainEvmTestnet + +# Variable: defichainEvmTestnet + +> `const` **defichainEvmTestnet**: `object` + +Creates a common configuration for the defichainEvmTestnet chain. + +## Description + +Chain ID: 1131 +Chain Name: DeFiChain EVM Testnet +Default Block Explorer: https://meta.defiscan.live/?network=TestNet +Default RPC URL: https://eth.testnet.ocean.jellyfishsdk.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { defichainEvmTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: defichainEvmTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/defichainEvmTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/defichainEvmTestnet.js#L26) diff --git a/packages/common/docs/variables/degen.md b/packages/common/docs/variables/degen.md new file mode 100644 index 0000000000..d59e6b69b9 --- /dev/null +++ b/packages/common/docs/variables/degen.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / degen + +# Variable: degen + +> `const` **degen**: `object` + +Creates a common configuration for the degen chain. + +## Description + +Chain ID: 666666666 +Chain Name: Degen +Default Block Explorer: https://explorer.degen.tips +Default RPC URL: https://rpc.degen.tips + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { degen } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: degen, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/degen.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/degen.js#L26) diff --git a/packages/common/docs/variables/dfk.md b/packages/common/docs/variables/dfk.md new file mode 100644 index 0000000000..ef6a286610 --- /dev/null +++ b/packages/common/docs/variables/dfk.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / dfk + +# Variable: dfk + +> `const` **dfk**: `object` + +Creates a common configuration for the dfk chain. + +## Description + +Chain ID: 53935 +Chain Name: DFK Chain +Default Block Explorer: https://subnets.avax.network/defi-kingdoms +Default RPC URL: https://subnets.avax.network/defi-kingdoms/dfk-chain/rpc + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { dfk } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: dfk, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/dfk.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/dfk.js#L26) diff --git a/packages/common/docs/variables/dodochainTestnet.md b/packages/common/docs/variables/dodochainTestnet.md new file mode 100644 index 0000000000..b188d7fcb4 --- /dev/null +++ b/packages/common/docs/variables/dodochainTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / dodochainTestnet + +# Variable: dodochainTestnet + +> `const` **dodochainTestnet**: `object` + +Creates a common configuration for the dodochainTestnet chain. + +## Description + +Chain ID: 53457 +Chain Name: DODOchain Testnet +Default Block Explorer: https://testnet-scan.dodochain.com +Default RPC URL: https://dodochain-testnet.alt.technology + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { dodochainTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: dodochainTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/dodochainTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/dodochainTestnet.js#L26) diff --git a/packages/common/docs/variables/dogechain.md b/packages/common/docs/variables/dogechain.md new file mode 100644 index 0000000000..bb6f9ba001 --- /dev/null +++ b/packages/common/docs/variables/dogechain.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / dogechain + +# Variable: dogechain + +> `const` **dogechain**: `object` + +Creates a common configuration for the dogechain chain. + +## Description + +Chain ID: 2000 +Chain Name: Dogechain +Default Block Explorer: https://explorer.dogechain.dog +Default RPC URL: https://rpc.dogechain.dog + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { dogechain } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: dogechain, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/dogechain.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/dogechain.js#L26) diff --git a/packages/common/docs/variables/dreyerxMainnet.md b/packages/common/docs/variables/dreyerxMainnet.md new file mode 100644 index 0000000000..89332a4bf9 --- /dev/null +++ b/packages/common/docs/variables/dreyerxMainnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / dreyerxMainnet + +# Variable: dreyerxMainnet + +> `const` **dreyerxMainnet**: `object` + +Creates a common configuration for the dreyerxMainnet chain. + +## Description + +Chain ID: 23451 +Chain Name: DreyerX Mainnet +Default Block Explorer: https://scan.dreyerx.com +Default RPC URL: https://rpc.dreyerx.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { dreyerxMainnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: dreyerxMainnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/dreyerxMainnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/dreyerxMainnet.js#L26) diff --git a/packages/common/docs/variables/dreyerxTestnet.md b/packages/common/docs/variables/dreyerxTestnet.md new file mode 100644 index 0000000000..edc14b5443 --- /dev/null +++ b/packages/common/docs/variables/dreyerxTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / dreyerxTestnet + +# Variable: dreyerxTestnet + +> `const` **dreyerxTestnet**: `object` + +Creates a common configuration for the dreyerxTestnet chain. + +## Description + +Chain ID: 23452 +Chain Name: DreyerX Testnet +Default Block Explorer: https://testnet-scan.dreyerx.com +Default RPC URL: http://testnet-rpc.dreyerx.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { dreyerxTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: dreyerxTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/dreyerxTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/dreyerxTestnet.js#L26) diff --git a/packages/common/docs/variables/edgeless.md b/packages/common/docs/variables/edgeless.md new file mode 100644 index 0000000000..cdfc6094b4 --- /dev/null +++ b/packages/common/docs/variables/edgeless.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / edgeless + +# Variable: edgeless + +> `const` **edgeless**: `object` + +Creates a common configuration for the edgeless chain. + +## Description + +Chain ID: 2026 +Chain Name: Edgeless Network +Default Block Explorer: https://explorer.edgeless.network +Default RPC URL: https://rpc.edgeless.network/http + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { edgeless } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: edgeless, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/edgeless.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/edgeless.js#L26) diff --git a/packages/common/docs/variables/edgelessTestnet.md b/packages/common/docs/variables/edgelessTestnet.md new file mode 100644 index 0000000000..794fb55daa --- /dev/null +++ b/packages/common/docs/variables/edgelessTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / edgelessTestnet + +# Variable: edgelessTestnet + +> `const` **edgelessTestnet**: `object` + +Creates a common configuration for the edgelessTestnet chain. + +## Description + +Chain ID: 202 +Chain Name: Edgeless Testnet +Default Block Explorer: https://testnet.explorer.edgeless.network +Default RPC URL: https://edgeless-testnet.rpc.caldera.xyz/http + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { edgelessTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: edgelessTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/edgelessTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/edgelessTestnet.js#L26) diff --git a/packages/common/docs/variables/edgeware.md b/packages/common/docs/variables/edgeware.md new file mode 100644 index 0000000000..85d31e2330 --- /dev/null +++ b/packages/common/docs/variables/edgeware.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / edgeware + +# Variable: edgeware + +> `const` **edgeware**: `object` + +Creates a common configuration for the edgeware chain. + +## Description + +Chain ID: 2021 +Chain Name: Edgeware EdgeEVM Mainnet +Default Block Explorer: https://edgscan.live +Default RPC URL: https://edgeware-evm.jelliedowl.net + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { edgeware } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: edgeware, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/edgeware.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/edgeware.js#L26) diff --git a/packages/common/docs/variables/edgewareTestnet.md b/packages/common/docs/variables/edgewareTestnet.md new file mode 100644 index 0000000000..d54d17dfc7 --- /dev/null +++ b/packages/common/docs/variables/edgewareTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / edgewareTestnet + +# Variable: edgewareTestnet + +> `const` **edgewareTestnet**: `object` + +Creates a common configuration for the edgewareTestnet chain. + +## Description + +Chain ID: 2022 +Chain Name: Beresheet BereEVM Testnet +Default Block Explorer: https://testnet.edgscan.live +Default RPC URL: https://beresheet-evm.jelliedowl.net + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { edgewareTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: edgewareTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/edgewareTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/edgewareTestnet.js#L26) diff --git a/packages/common/docs/variables/ekta.md b/packages/common/docs/variables/ekta.md new file mode 100644 index 0000000000..b4507c4858 --- /dev/null +++ b/packages/common/docs/variables/ekta.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / ekta + +# Variable: ekta + +> `const` **ekta**: `object` + +Creates a common configuration for the ekta chain. + +## Description + +Chain ID: 1994 +Chain Name: Ekta +Default Block Explorer: https://ektascan.io +Default RPC URL: https://main.ekta.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { ekta } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: ekta, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/ekta.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/ekta.js#L26) diff --git a/packages/common/docs/variables/ektaTestnet.md b/packages/common/docs/variables/ektaTestnet.md new file mode 100644 index 0000000000..e371f4316b --- /dev/null +++ b/packages/common/docs/variables/ektaTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / ektaTestnet + +# Variable: ektaTestnet + +> `const` **ektaTestnet**: `object` + +Creates a common configuration for the ektaTestnet chain. + +## Description + +Chain ID: 1004 +Chain Name: Ekta Testnet +Default Block Explorer: https://test.ektascan.io +Default RPC URL: https://test.ekta.io:8545 + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { ektaTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: ektaTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/ektaTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/ektaTestnet.js#L26) diff --git a/packages/common/docs/variables/eon.md b/packages/common/docs/variables/eon.md new file mode 100644 index 0000000000..3919a1149b --- /dev/null +++ b/packages/common/docs/variables/eon.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / eon + +# Variable: eon + +> `const` **eon**: `object` + +Creates a common configuration for the eon chain. + +## Description + +Chain ID: 7332 +Chain Name: Horizen EON +Default Block Explorer: https://eon-explorer.horizenlabs.io +Default RPC URL: https://eon-rpc.horizenlabs.io/ethv1 + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { eon } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: eon, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/eon.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/eon.js#L26) diff --git a/packages/common/docs/variables/eos.md b/packages/common/docs/variables/eos.md new file mode 100644 index 0000000000..db608dbc57 --- /dev/null +++ b/packages/common/docs/variables/eos.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / eos + +# Variable: eos + +> `const` **eos**: `object` + +Creates a common configuration for the eos chain. + +## Description + +Chain ID: 17777 +Chain Name: EOS EVM +Default Block Explorer: https://explorer.evm.eosnetwork.com +Default RPC URL: https://api.evm.eosnetwork.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { eos } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: eos, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/eos.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/eos.js#L26) diff --git a/packages/common/docs/variables/eosTestnet.md b/packages/common/docs/variables/eosTestnet.md new file mode 100644 index 0000000000..c5306716cd --- /dev/null +++ b/packages/common/docs/variables/eosTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / eosTestnet + +# Variable: eosTestnet + +> `const` **eosTestnet**: `object` + +Creates a common configuration for the eosTestnet chain. + +## Description + +Chain ID: 15557 +Chain Name: EOS EVM Testnet +Default Block Explorer: https://explorer.testnet.evm.eosnetwork.com +Default RPC URL: https://api.testnet.evm.eosnetwork.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { eosTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: eosTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/eosTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/eosTestnet.js#L26) diff --git a/packages/common/docs/variables/etherlink.md b/packages/common/docs/variables/etherlink.md new file mode 100644 index 0000000000..3b7bcd6dbc --- /dev/null +++ b/packages/common/docs/variables/etherlink.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / etherlink + +# Variable: etherlink + +> `const` **etherlink**: `object` + +Creates a common configuration for the etherlink chain. + +## Description + +Chain ID: 42793 +Chain Name: Etherlink +Default Block Explorer: https://explorer.etherlink.com +Default RPC URL: https://node.mainnet.etherlink.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { etherlink } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: etherlink, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/etherlink.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/etherlink.js#L26) diff --git a/packages/common/docs/variables/etherlinkTestnet.md b/packages/common/docs/variables/etherlinkTestnet.md new file mode 100644 index 0000000000..eb81c15f6d --- /dev/null +++ b/packages/common/docs/variables/etherlinkTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / etherlinkTestnet + +# Variable: etherlinkTestnet + +> `const` **etherlinkTestnet**: `object` + +Creates a common configuration for the etherlinkTestnet chain. + +## Description + +Chain ID: 128123 +Chain Name: Etherlink Testnet +Default Block Explorer: https://testnet-explorer.etherlink.com +Default RPC URL: https://node.ghostnet.etherlink.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { etherlinkTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: etherlinkTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/etherlinkTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/etherlinkTestnet.js#L26) diff --git a/packages/common/docs/variables/evmos.md b/packages/common/docs/variables/evmos.md new file mode 100644 index 0000000000..2e85a3d637 --- /dev/null +++ b/packages/common/docs/variables/evmos.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / evmos + +# Variable: evmos + +> `const` **evmos**: `object` + +Creates a common configuration for the evmos chain. + +## Description + +Chain ID: 9001 +Chain Name: Evmos +Default Block Explorer: https://escan.live +Default RPC URL: https://eth.bd.evmos.org:8545 + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { evmos } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: evmos, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/evmos.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/evmos.js#L26) diff --git a/packages/common/docs/variables/evmosTestnet.md b/packages/common/docs/variables/evmosTestnet.md new file mode 100644 index 0000000000..e5cb0adaf1 --- /dev/null +++ b/packages/common/docs/variables/evmosTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / evmosTestnet + +# Variable: evmosTestnet + +> `const` **evmosTestnet**: `object` + +Creates a common configuration for the evmosTestnet chain. + +## Description + +Chain ID: 9000 +Chain Name: Evmos Testnet +Default Block Explorer: https://evm.evmos.dev/ +Default RPC URL: https://eth.bd.evmos.dev:8545 + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { evmosTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: evmosTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/evmosTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/evmosTestnet.js#L26) diff --git a/packages/common/docs/variables/fantom.md b/packages/common/docs/variables/fantom.md new file mode 100644 index 0000000000..b66e56aeff --- /dev/null +++ b/packages/common/docs/variables/fantom.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / fantom + +# Variable: fantom + +> `const` **fantom**: `object` + +Creates a common configuration for the fantom chain. + +## Description + +Chain ID: 250 +Chain Name: Fantom +Default Block Explorer: https://ftmscan.com +Default RPC URL: https://rpc.ankr.com/fantom + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { fantom } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: fantom, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/fantom.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/fantom.js#L26) diff --git a/packages/common/docs/variables/fantomSonicTestnet.md b/packages/common/docs/variables/fantomSonicTestnet.md new file mode 100644 index 0000000000..eafc48c557 --- /dev/null +++ b/packages/common/docs/variables/fantomSonicTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / fantomSonicTestnet + +# Variable: fantomSonicTestnet + +> `const` **fantomSonicTestnet**: `object` + +Creates a common configuration for the fantomSonicTestnet chain. + +## Description + +Chain ID: 64240 +Chain Name: Fantom Sonic Open Testnet +Default Block Explorer: https://public-sonic.fantom.network +Default RPC URL: https://rpcapi.sonic.fantom.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { fantomSonicTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: fantomSonicTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/fantomSonicTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/fantomSonicTestnet.js#L26) diff --git a/packages/common/docs/variables/fantomTestnet.md b/packages/common/docs/variables/fantomTestnet.md new file mode 100644 index 0000000000..c112e6ffad --- /dev/null +++ b/packages/common/docs/variables/fantomTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / fantomTestnet + +# Variable: fantomTestnet + +> `const` **fantomTestnet**: `object` + +Creates a common configuration for the fantomTestnet chain. + +## Description + +Chain ID: 4002 +Chain Name: Fantom Testnet +Default Block Explorer: https://testnet.ftmscan.com +Default RPC URL: https://rpc.testnet.fantom.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { fantomTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: fantomTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/fantomTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/fantomTestnet.js#L26) diff --git a/packages/common/docs/variables/fibo.md b/packages/common/docs/variables/fibo.md new file mode 100644 index 0000000000..92b177c7bc --- /dev/null +++ b/packages/common/docs/variables/fibo.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / fibo + +# Variable: fibo + +> `const` **fibo**: `object` + +Creates a common configuration for the fibo chain. + +## Description + +Chain ID: 12306 +Chain Name: Fibo Chain +Default Block Explorer: https://scan.fibochain.org +Default RPC URL: https://network.hzroc.art + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { fibo } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: fibo, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/fibo.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/fibo.js#L26) diff --git a/packages/common/docs/variables/filecoin.md b/packages/common/docs/variables/filecoin.md new file mode 100644 index 0000000000..769e39bf1b --- /dev/null +++ b/packages/common/docs/variables/filecoin.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / filecoin + +# Variable: filecoin + +> `const` **filecoin**: `object` + +Creates a common configuration for the filecoin chain. + +## Description + +Chain ID: 314 +Chain Name: Filecoin Mainnet +Default Block Explorer: https://filfox.info/en +Default RPC URL: https://api.node.glif.io/rpc/v1 + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { filecoin } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: filecoin, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/filecoin.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/filecoin.js#L26) diff --git a/packages/common/docs/variables/filecoinCalibration.md b/packages/common/docs/variables/filecoinCalibration.md new file mode 100644 index 0000000000..3018daed21 --- /dev/null +++ b/packages/common/docs/variables/filecoinCalibration.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / filecoinCalibration + +# Variable: filecoinCalibration + +> `const` **filecoinCalibration**: `object` + +Creates a common configuration for the filecoinCalibration chain. + +## Description + +Chain ID: 314159 +Chain Name: Filecoin Calibration +Default Block Explorer: https://calibration.filscan.io +Default RPC URL: https://api.calibration.node.glif.io/rpc/v1 + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { filecoinCalibration } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: filecoinCalibration, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/filecoinCalibration.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/filecoinCalibration.js#L26) diff --git a/packages/common/docs/variables/filecoinHyperspace.md b/packages/common/docs/variables/filecoinHyperspace.md new file mode 100644 index 0000000000..629fdbf6ef --- /dev/null +++ b/packages/common/docs/variables/filecoinHyperspace.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / filecoinHyperspace + +# Variable: filecoinHyperspace + +> `const` **filecoinHyperspace**: `object` + +Creates a common configuration for the filecoinHyperspace chain. + +## Description + +Chain ID: 3141 +Chain Name: Filecoin Hyperspace +Default Block Explorer: https://hyperspace.filfox.info/en +Default RPC URL: https://api.hyperspace.node.glif.io/rpc/v1 + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { filecoinHyperspace } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: filecoinHyperspace, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/filecoinHyperspace.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/filecoinHyperspace.js#L26) diff --git a/packages/common/docs/variables/flare.md b/packages/common/docs/variables/flare.md new file mode 100644 index 0000000000..ee1ef0e4cd --- /dev/null +++ b/packages/common/docs/variables/flare.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / flare + +# Variable: flare + +> `const` **flare**: `object` + +Creates a common configuration for the flare chain. + +## Description + +Chain ID: 14 +Chain Name: Flare Mainnet +Default Block Explorer: https://flare-explorer.flare.network +Default RPC URL: https://flare-api.flare.network/ext/C/rpc + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { flare } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: flare, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/flare.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/flare.js#L26) diff --git a/packages/common/docs/variables/flareTestnet.md b/packages/common/docs/variables/flareTestnet.md new file mode 100644 index 0000000000..c78280e8e9 --- /dev/null +++ b/packages/common/docs/variables/flareTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / flareTestnet + +# Variable: flareTestnet + +> `const` **flareTestnet**: `object` + +Creates a common configuration for the flareTestnet chain. + +## Description + +Chain ID: 114 +Chain Name: Coston2 +Default Block Explorer: https://coston2-explorer.flare.network +Default RPC URL: https://coston2-api.flare.network/ext/C/rpc + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { flareTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: flareTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/flareTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/flareTestnet.js#L26) diff --git a/packages/common/docs/variables/flowMainnet.md b/packages/common/docs/variables/flowMainnet.md new file mode 100644 index 0000000000..f726d253d5 --- /dev/null +++ b/packages/common/docs/variables/flowMainnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / flowMainnet + +# Variable: flowMainnet + +> `const` **flowMainnet**: `object` + +Creates a common configuration for the flowMainnet chain. + +## Description + +Chain ID: 747 +Chain Name: FlowEVM Mainnet +Default Block Explorer: https://flowdiver.io +Default RPC URL: https://mainnet.evm.nodes.onflow.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { flowMainnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: flowMainnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/flowMainnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/flowMainnet.js#L26) diff --git a/packages/common/docs/variables/flowPreviewnet.md b/packages/common/docs/variables/flowPreviewnet.md new file mode 100644 index 0000000000..507fd76309 --- /dev/null +++ b/packages/common/docs/variables/flowPreviewnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / flowPreviewnet + +# Variable: flowPreviewnet + +> `const` **flowPreviewnet**: `object` + +Creates a common configuration for the flowPreviewnet chain. + +## Description + +Chain ID: 646 +Chain Name: FlowEVM Previewnet +Default Block Explorer: https://previewnet.flowdiver.io +Default RPC URL: https://previewnet.evm.nodes.onflow.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { flowPreviewnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: flowPreviewnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/flowPreviewnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/flowPreviewnet.js#L26) diff --git a/packages/common/docs/variables/flowTestnet.md b/packages/common/docs/variables/flowTestnet.md new file mode 100644 index 0000000000..875585dbab --- /dev/null +++ b/packages/common/docs/variables/flowTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / flowTestnet + +# Variable: flowTestnet + +> `const` **flowTestnet**: `object` + +Creates a common configuration for the flowTestnet chain. + +## Description + +Chain ID: 545 +Chain Name: FlowEVM Testnet +Default Block Explorer: https://testnet.flowdiver.io +Default RPC URL: https://testnet.evm.nodes.onflow.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { flowTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: flowTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/flowTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/flowTestnet.js#L26) diff --git a/packages/common/docs/variables/fluence.md b/packages/common/docs/variables/fluence.md new file mode 100644 index 0000000000..a0d46271db --- /dev/null +++ b/packages/common/docs/variables/fluence.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / fluence + +# Variable: fluence + +> `const` **fluence**: `object` + +Creates a common configuration for the fluence chain. + +## Description + +Chain ID: 9999999 +Chain Name: Fluence +Default Block Explorer: https://blockscout.mainnet.fluence.dev +Default RPC URL: https://rpc.mainnet.fluence.dev + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { fluence } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: fluence, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/fluence.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/fluence.js#L26) diff --git a/packages/common/docs/variables/fluenceStage.md b/packages/common/docs/variables/fluenceStage.md new file mode 100644 index 0000000000..0d2dbf7637 --- /dev/null +++ b/packages/common/docs/variables/fluenceStage.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / fluenceStage + +# Variable: fluenceStage + +> `const` **fluenceStage**: `object` + +Creates a common configuration for the fluenceStage chain. + +## Description + +Chain ID: 123420000220 +Chain Name: Fluence Stage +Default Block Explorer: https://blockscout.stage.fluence.dev +Default RPC URL: https://rpc.stage.fluence.dev + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { fluenceStage } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: fluenceStage, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/fluenceStage.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/fluenceStage.js#L26) diff --git a/packages/common/docs/variables/fluenceTestnet.md b/packages/common/docs/variables/fluenceTestnet.md new file mode 100644 index 0000000000..ccf792bebe --- /dev/null +++ b/packages/common/docs/variables/fluenceTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / fluenceTestnet + +# Variable: fluenceTestnet + +> `const` **fluenceTestnet**: `object` + +Creates a common configuration for the fluenceTestnet chain. + +## Description + +Chain ID: 52164803 +Chain Name: Fluence Testnet +Default Block Explorer: https://blockscout.testnet.fluence.dev +Default RPC URL: https://rpc.testnet.fluence.dev + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { fluenceTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: fluenceTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/fluenceTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/fluenceTestnet.js#L26) diff --git a/packages/common/docs/variables/forma.md b/packages/common/docs/variables/forma.md new file mode 100644 index 0000000000..f5e807d886 --- /dev/null +++ b/packages/common/docs/variables/forma.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / forma + +# Variable: forma + +> `const` **forma**: `object` + +Creates a common configuration for the forma chain. + +## Description + +Chain ID: 984122 +Chain Name: Forma +Default Block Explorer: https://explorer.forma.art +Default RPC URL: https://rpc.forma.art + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { forma } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: forma, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/forma.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/forma.js#L26) diff --git a/packages/common/docs/variables/foundry.md b/packages/common/docs/variables/foundry.md new file mode 100644 index 0000000000..4a509d7821 --- /dev/null +++ b/packages/common/docs/variables/foundry.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / foundry + +# Variable: foundry + +> `const` **foundry**: `object` + +Creates a common configuration for the foundry chain. + +## Description + +Chain ID: 31337 +Chain Name: Foundry +Default Block Explorer: Not specified +Default RPC URL: http://127.0.0.1:8545 + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { foundry } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: foundry, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/foundry.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/foundry.js#L26) diff --git a/packages/common/docs/variables/fraxtal.md b/packages/common/docs/variables/fraxtal.md new file mode 100644 index 0000000000..6ea944bd2b --- /dev/null +++ b/packages/common/docs/variables/fraxtal.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / fraxtal + +# Variable: fraxtal + +> `const` **fraxtal**: `object` + +Creates a common configuration for the fraxtal chain. + +## Description + +Chain ID: 252 +Chain Name: Fraxtal +Default Block Explorer: https://fraxscan.com +Default RPC URL: https://rpc.frax.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { fraxtal } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: fraxtal, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/fraxtal.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/fraxtal.js#L26) diff --git a/packages/common/docs/variables/fraxtalTestnet.md b/packages/common/docs/variables/fraxtalTestnet.md new file mode 100644 index 0000000000..74c83b7d49 --- /dev/null +++ b/packages/common/docs/variables/fraxtalTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / fraxtalTestnet + +# Variable: fraxtalTestnet + +> `const` **fraxtalTestnet**: `object` + +Creates a common configuration for the fraxtalTestnet chain. + +## Description + +Chain ID: 2522 +Chain Name: Fraxtal Testnet +Default Block Explorer: https://holesky.fraxscan.com +Default RPC URL: https://rpc.testnet.frax.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { fraxtalTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: fraxtalTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/fraxtalTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/fraxtalTestnet.js#L26) diff --git a/packages/common/docs/variables/funkiMainnet.md b/packages/common/docs/variables/funkiMainnet.md new file mode 100644 index 0000000000..ef6b0dcc99 --- /dev/null +++ b/packages/common/docs/variables/funkiMainnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / funkiMainnet + +# Variable: funkiMainnet + +> `const` **funkiMainnet**: `object` + +Creates a common configuration for the funkiMainnet chain. + +## Description + +Chain ID: 33979 +Chain Name: Funki +Default Block Explorer: https://funkiscan.io +Default RPC URL: https://rpc-mainnet.funkichain.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { funkiMainnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: funkiMainnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/funkiMainnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/funkiMainnet.js#L26) diff --git a/packages/common/docs/variables/funkiSepolia.md b/packages/common/docs/variables/funkiSepolia.md new file mode 100644 index 0000000000..775b99746b --- /dev/null +++ b/packages/common/docs/variables/funkiSepolia.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / funkiSepolia + +# Variable: funkiSepolia + +> `const` **funkiSepolia**: `object` + +Creates a common configuration for the funkiSepolia chain. + +## Description + +Chain ID: 3397901 +Chain Name: Funki Sepolia Sandbox +Default Block Explorer: https://sepolia-sandbox.funkichain.com/ +Default RPC URL: https://funki-testnet.alt.technology + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { funkiSepolia } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: funkiSepolia, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/funkiSepolia.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/funkiSepolia.js#L26) diff --git a/packages/common/docs/variables/fuse.md b/packages/common/docs/variables/fuse.md new file mode 100644 index 0000000000..5079e7e12d --- /dev/null +++ b/packages/common/docs/variables/fuse.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / fuse + +# Variable: fuse + +> `const` **fuse**: `object` + +Creates a common configuration for the fuse chain. + +## Description + +Chain ID: 122 +Chain Name: Fuse +Default Block Explorer: https://explorer.fuse.io +Default RPC URL: https://rpc.fuse.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { fuse } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: fuse, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/fuse.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/fuse.js#L26) diff --git a/packages/common/docs/variables/fuseSparknet.md b/packages/common/docs/variables/fuseSparknet.md new file mode 100644 index 0000000000..6793d938af --- /dev/null +++ b/packages/common/docs/variables/fuseSparknet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / fuseSparknet + +# Variable: fuseSparknet + +> `const` **fuseSparknet**: `object` + +Creates a common configuration for the fuseSparknet chain. + +## Description + +Chain ID: 123 +Chain Name: Fuse Sparknet +Default Block Explorer: https://explorer.fusespark.io +Default RPC URL: https://rpc.fusespark.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { fuseSparknet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: fuseSparknet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/fuseSparknet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/fuseSparknet.js#L26) diff --git a/packages/common/docs/variables/gnosis.md b/packages/common/docs/variables/gnosis.md new file mode 100644 index 0000000000..6c4ced6ee7 --- /dev/null +++ b/packages/common/docs/variables/gnosis.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / gnosis + +# Variable: gnosis + +> `const` **gnosis**: `object` + +Creates a common configuration for the gnosis chain. + +## Description + +Chain ID: 100 +Chain Name: Gnosis +Default Block Explorer: https://gnosisscan.io +Default RPC URL: https://rpc.gnosischain.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { gnosis } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: gnosis, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/gnosis.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/gnosis.js#L26) diff --git a/packages/common/docs/variables/gnosisChiado.md b/packages/common/docs/variables/gnosisChiado.md new file mode 100644 index 0000000000..68b6533a6e --- /dev/null +++ b/packages/common/docs/variables/gnosisChiado.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / gnosisChiado + +# Variable: gnosisChiado + +> `const` **gnosisChiado**: `object` + +Creates a common configuration for the gnosisChiado chain. + +## Description + +Chain ID: 10200 +Chain Name: Gnosis Chiado +Default Block Explorer: https://blockscout.chiadochain.net +Default RPC URL: https://rpc.chiadochain.net + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { gnosisChiado } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: gnosisChiado, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/gnosisChiado.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/gnosisChiado.js#L26) diff --git a/packages/common/docs/variables/gobi.md b/packages/common/docs/variables/gobi.md new file mode 100644 index 0000000000..3da941469b --- /dev/null +++ b/packages/common/docs/variables/gobi.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / gobi + +# Variable: gobi + +> `const` **gobi**: `object` + +Creates a common configuration for the gobi chain. + +## Description + +Chain ID: 1663 +Chain Name: Horizen Gobi Testnet +Default Block Explorer: https://gobi-explorer.horizen.io +Default RPC URL: https://gobi-testnet.horizenlabs.io/ethv1 + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { gobi } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: gobi, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/gobi.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/gobi.js#L26) diff --git a/packages/common/docs/variables/goerli.md b/packages/common/docs/variables/goerli.md new file mode 100644 index 0000000000..c82cc03e29 --- /dev/null +++ b/packages/common/docs/variables/goerli.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / goerli + +# Variable: goerli + +> `const` **goerli**: `object` + +Creates a common configuration for the goerli chain. + +## Description + +Chain ID: 5 +Chain Name: Goerli +Default Block Explorer: https://goerli.etherscan.io +Default RPC URL: https://rpc.ankr.com/eth_goerli + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { goerli } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: goerli, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/goerli.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/goerli.js#L26) diff --git a/packages/common/docs/variables/gravity.md b/packages/common/docs/variables/gravity.md new file mode 100644 index 0000000000..f3491925c5 --- /dev/null +++ b/packages/common/docs/variables/gravity.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / gravity + +# Variable: gravity + +> `const` **gravity**: `object` + +Creates a common configuration for the gravity chain. + +## Description + +Chain ID: 1625 +Chain Name: Gravity Alpha Mainnet +Default Block Explorer: https://explorer.gravity.xyz +Default RPC URL: https://rpc.gravity.xyz + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { gravity } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: gravity, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/gravity.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/gravity.js#L26) diff --git a/packages/common/docs/variables/ham.md b/packages/common/docs/variables/ham.md new file mode 100644 index 0000000000..275af2f0ea --- /dev/null +++ b/packages/common/docs/variables/ham.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / ham + +# Variable: ham + +> `const` **ham**: `object` + +Creates a common configuration for the ham chain. + +## Description + +Chain ID: 5112 +Chain Name: Ham +Default Block Explorer: https://explorer.ham.fun +Default RPC URL: https://rpc.ham.fun + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { ham } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: ham, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/ham.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/ham.js#L26) diff --git a/packages/common/docs/variables/haqqMainnet.md b/packages/common/docs/variables/haqqMainnet.md new file mode 100644 index 0000000000..320fed9971 --- /dev/null +++ b/packages/common/docs/variables/haqqMainnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / haqqMainnet + +# Variable: haqqMainnet + +> `const` **haqqMainnet**: `object` + +Creates a common configuration for the haqqMainnet chain. + +## Description + +Chain ID: 11235 +Chain Name: HAQQ Mainnet +Default Block Explorer: https://explorer.haqq.network +Default RPC URL: https://rpc.eth.haqq.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { haqqMainnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: haqqMainnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/haqqMainnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/haqqMainnet.js#L26) diff --git a/packages/common/docs/variables/haqqTestedge2.md b/packages/common/docs/variables/haqqTestedge2.md new file mode 100644 index 0000000000..cc025f3a34 --- /dev/null +++ b/packages/common/docs/variables/haqqTestedge2.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / haqqTestedge2 + +# Variable: haqqTestedge2 + +> `const` **haqqTestedge2**: `object` + +Creates a common configuration for the haqqTestedge2 chain. + +## Description + +Chain ID: 54211 +Chain Name: HAQQ Testedge 2 +Default Block Explorer: https://explorer.testedge2.haqq.network +Default RPC URL: https://rpc.eth.testedge2.haqq.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { haqqTestedge2 } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: haqqTestedge2, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/haqqTestedge2.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/haqqTestedge2.js#L26) diff --git a/packages/common/docs/variables/hardhat.md b/packages/common/docs/variables/hardhat.md new file mode 100644 index 0000000000..6ec709349f --- /dev/null +++ b/packages/common/docs/variables/hardhat.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / hardhat + +# Variable: hardhat + +> `const` **hardhat**: `object` + +Creates a common configuration for the hardhat chain. + +## Description + +Chain ID: 31337 +Chain Name: Hardhat +Default Block Explorer: Not specified +Default RPC URL: http://127.0.0.1:8545 + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { hardhat } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: hardhat, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/hardhat.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/hardhat.js#L26) diff --git a/packages/common/docs/variables/harmonyOne.md b/packages/common/docs/variables/harmonyOne.md new file mode 100644 index 0000000000..ff51da790e --- /dev/null +++ b/packages/common/docs/variables/harmonyOne.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / harmonyOne + +# Variable: harmonyOne + +> `const` **harmonyOne**: `object` + +Creates a common configuration for the harmonyOne chain. + +## Description + +Chain ID: 1666600000 +Chain Name: Harmony One +Default Block Explorer: https://explorer.harmony.one +Default RPC URL: https://rpc.ankr.com/harmony + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { harmonyOne } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: harmonyOne, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/harmonyOne.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/harmonyOne.js#L26) diff --git a/packages/common/docs/variables/hashkeyTestnet.md b/packages/common/docs/variables/hashkeyTestnet.md new file mode 100644 index 0000000000..79407d6763 --- /dev/null +++ b/packages/common/docs/variables/hashkeyTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / hashkeyTestnet + +# Variable: hashkeyTestnet + +> `const` **hashkeyTestnet**: `object` + +Creates a common configuration for the hashkeyTestnet chain. + +## Description + +Chain ID: 133 +Chain Name: HashKey Chain Testnet +Default Block Explorer: https://hashkeychain-testnet-explorer.alt.technology +Default RPC URL: https://hashkeychain-testnet.alt.technology + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { hashkeyTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: hashkeyTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/hashkeyTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/hashkeyTestnet.js#L26) diff --git a/packages/common/docs/variables/hedera.md b/packages/common/docs/variables/hedera.md new file mode 100644 index 0000000000..823feeab14 --- /dev/null +++ b/packages/common/docs/variables/hedera.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / hedera + +# Variable: hedera + +> `const` **hedera**: `object` + +Creates a common configuration for the hedera chain. + +## Description + +Chain ID: 295 +Chain Name: Hedera Mainnet +Default Block Explorer: https://hashscan.io/mainnet +Default RPC URL: https://mainnet.hashio.io/api + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { hedera } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: hedera, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/hedera.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/hedera.js#L26) diff --git a/packages/common/docs/variables/hederaPreviewnet.md b/packages/common/docs/variables/hederaPreviewnet.md new file mode 100644 index 0000000000..07df188809 --- /dev/null +++ b/packages/common/docs/variables/hederaPreviewnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / hederaPreviewnet + +# Variable: hederaPreviewnet + +> `const` **hederaPreviewnet**: `object` + +Creates a common configuration for the hederaPreviewnet chain. + +## Description + +Chain ID: 297 +Chain Name: Hedera Previewnet +Default Block Explorer: https://hashscan.io/previewnet +Default RPC URL: https://previewnet.hashio.io/api + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { hederaPreviewnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: hederaPreviewnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/hederaPreviewnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/hederaPreviewnet.js#L26) diff --git a/packages/common/docs/variables/hederaTestnet.md b/packages/common/docs/variables/hederaTestnet.md new file mode 100644 index 0000000000..ed2f3014ad --- /dev/null +++ b/packages/common/docs/variables/hederaTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / hederaTestnet + +# Variable: hederaTestnet + +> `const` **hederaTestnet**: `object` + +Creates a common configuration for the hederaTestnet chain. + +## Description + +Chain ID: 296 +Chain Name: Hedera Testnet +Default Block Explorer: https://hashscan.io/testnet +Default RPC URL: https://testnet.hashio.io/api + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { hederaTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: hederaTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/hederaTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/hederaTestnet.js#L26) diff --git a/packages/common/docs/variables/holesky.md b/packages/common/docs/variables/holesky.md new file mode 100644 index 0000000000..5bb0492911 --- /dev/null +++ b/packages/common/docs/variables/holesky.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / holesky + +# Variable: holesky + +> `const` **holesky**: `object` + +Creates a common configuration for the holesky chain. + +## Description + +Chain ID: 17000 +Chain Name: Holesky +Default Block Explorer: https://holesky.etherscan.io +Default RPC URL: https://ethereum-holesky-rpc.publicnode.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { holesky } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: holesky, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/holesky.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/holesky.js#L26) diff --git a/packages/common/docs/variables/immutableZkEvm.md b/packages/common/docs/variables/immutableZkEvm.md new file mode 100644 index 0000000000..ef00eb6332 --- /dev/null +++ b/packages/common/docs/variables/immutableZkEvm.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / immutableZkEvm + +# Variable: immutableZkEvm + +> `const` **immutableZkEvm**: `object` + +Creates a common configuration for the immutableZkEvm chain. + +## Description + +Chain ID: 13371 +Chain Name: Immutable zkEVM +Default Block Explorer: https://explorer.immutable.com +Default RPC URL: https://rpc.immutable.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { immutableZkEvm } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: immutableZkEvm, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/immutableZkEvm.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/immutableZkEvm.js#L26) diff --git a/packages/common/docs/variables/immutableZkEvmTestnet.md b/packages/common/docs/variables/immutableZkEvmTestnet.md new file mode 100644 index 0000000000..03bf5b4e11 --- /dev/null +++ b/packages/common/docs/variables/immutableZkEvmTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / immutableZkEvmTestnet + +# Variable: immutableZkEvmTestnet + +> `const` **immutableZkEvmTestnet**: `object` + +Creates a common configuration for the immutableZkEvmTestnet chain. + +## Description + +Chain ID: 13473 +Chain Name: Immutable zkEVM Testnet +Default Block Explorer: https://explorer.testnet.immutable.com/ +Default RPC URL: https://rpc.testnet.immutable.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { immutableZkEvmTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: immutableZkEvmTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/immutableZkEvmTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/immutableZkEvmTestnet.js#L26) diff --git a/packages/common/docs/variables/inEVM.md b/packages/common/docs/variables/inEVM.md new file mode 100644 index 0000000000..6284d02ad9 --- /dev/null +++ b/packages/common/docs/variables/inEVM.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / inEVM + +# Variable: inEVM + +> `const` **inEVM**: `object` + +Creates a common configuration for the inEVM chain. + +## Description + +Chain ID: 2525 +Chain Name: inEVM Mainnet +Default Block Explorer: https://inevm.calderaexplorer.xyz +Default RPC URL: https://mainnet.rpc.inevm.com/http + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { inEVM } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: inEVM, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/inEVM.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/inEVM.js#L26) diff --git a/packages/common/docs/variables/iota.md b/packages/common/docs/variables/iota.md new file mode 100644 index 0000000000..e980b52a29 --- /dev/null +++ b/packages/common/docs/variables/iota.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / iota + +# Variable: iota + +> `const` **iota**: `object` + +Creates a common configuration for the iota chain. + +## Description + +Chain ID: 8822 +Chain Name: IOTA EVM +Default Block Explorer: https://explorer.evm.iota.org +Default RPC URL: https://json-rpc.evm.iotaledger.net + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { iota } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: iota, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/iota.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/iota.js#L26) diff --git a/packages/common/docs/variables/iotaTestnet.md b/packages/common/docs/variables/iotaTestnet.md new file mode 100644 index 0000000000..b0fb2353c3 --- /dev/null +++ b/packages/common/docs/variables/iotaTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / iotaTestnet + +# Variable: iotaTestnet + +> `const` **iotaTestnet**: `object` + +Creates a common configuration for the iotaTestnet chain. + +## Description + +Chain ID: 1075 +Chain Name: IOTA EVM Testnet +Default Block Explorer: https://explorer.evm.testnet.iotaledger.net +Default RPC URL: https://json-rpc.evm.testnet.iotaledger.net + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { iotaTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: iotaTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/iotaTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/iotaTestnet.js#L26) diff --git a/packages/common/docs/variables/iotex.md b/packages/common/docs/variables/iotex.md new file mode 100644 index 0000000000..939bab19fd --- /dev/null +++ b/packages/common/docs/variables/iotex.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / iotex + +# Variable: iotex + +> `const` **iotex**: `object` + +Creates a common configuration for the iotex chain. + +## Description + +Chain ID: 4689 +Chain Name: IoTeX +Default Block Explorer: https://iotexscan.io +Default RPC URL: https://babel-api.mainnet.iotex.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { iotex } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: iotex, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/iotex.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/iotex.js#L26) diff --git a/packages/common/docs/variables/iotexTestnet.md b/packages/common/docs/variables/iotexTestnet.md new file mode 100644 index 0000000000..70be8300a6 --- /dev/null +++ b/packages/common/docs/variables/iotexTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / iotexTestnet + +# Variable: iotexTestnet + +> `const` **iotexTestnet**: `object` + +Creates a common configuration for the iotexTestnet chain. + +## Description + +Chain ID: 4690 +Chain Name: IoTeX Testnet +Default Block Explorer: https://testnet.iotexscan.io +Default RPC URL: https://babel-api.testnet.iotex.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { iotexTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: iotexTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/iotexTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/iotexTestnet.js#L26) diff --git a/packages/common/docs/variables/jbc.md b/packages/common/docs/variables/jbc.md new file mode 100644 index 0000000000..ab5d064dd4 --- /dev/null +++ b/packages/common/docs/variables/jbc.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / jbc + +# Variable: jbc + +> `const` **jbc**: `object` + +Creates a common configuration for the jbc chain. + +## Description + +Chain ID: 8899 +Chain Name: JIBCHAIN L1 +Default Block Explorer: https://exp-l1.jibchain.net +Default RPC URL: https://rpc-l1.jibchain.net + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { jbc } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: jbc, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/jbc.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/jbc.js#L26) diff --git a/packages/common/docs/variables/jbcTestnet.md b/packages/common/docs/variables/jbcTestnet.md new file mode 100644 index 0000000000..290c77c186 --- /dev/null +++ b/packages/common/docs/variables/jbcTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / jbcTestnet + +# Variable: jbcTestnet + +> `const` **jbcTestnet**: `object` + +Creates a common configuration for the jbcTestnet chain. + +## Description + +Chain ID: 88991 +Chain Name: Jibchain Testnet +Default Block Explorer: https://exp.testnet.jibchain.net +Default RPC URL: https://rpc.testnet.jibchain.net + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { jbcTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: jbcTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/jbcTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/jbcTestnet.js#L26) diff --git a/packages/common/docs/variables/kaia.md b/packages/common/docs/variables/kaia.md new file mode 100644 index 0000000000..a0946ff4e0 --- /dev/null +++ b/packages/common/docs/variables/kaia.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / kaia + +# Variable: kaia + +> `const` **kaia**: `object` + +Creates a common configuration for the kaia chain. + +## Description + +Chain ID: 8217 +Chain Name: Kaia +Default Block Explorer: https://kaiascope.com +Default RPC URL: https://public-en.node.kaia.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { kaia } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: kaia, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/kaia.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/kaia.js#L26) diff --git a/packages/common/docs/variables/kairos.md b/packages/common/docs/variables/kairos.md new file mode 100644 index 0000000000..0b7768c7fb --- /dev/null +++ b/packages/common/docs/variables/kairos.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / kairos + +# Variable: kairos + +> `const` **kairos**: `object` + +Creates a common configuration for the kairos chain. + +## Description + +Chain ID: 1001 +Chain Name: Kairos Testnet +Default Block Explorer: https://kairos.kaiascope.com +Default RPC URL: https://public-en-kairos.node.kaia.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { kairos } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: kairos, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/kairos.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/kairos.js#L26) diff --git a/packages/common/docs/variables/kakarotSepolia.md b/packages/common/docs/variables/kakarotSepolia.md new file mode 100644 index 0000000000..92fd05bee9 --- /dev/null +++ b/packages/common/docs/variables/kakarotSepolia.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / kakarotSepolia + +# Variable: kakarotSepolia + +> `const` **kakarotSepolia**: `object` + +Creates a common configuration for the kakarotSepolia chain. + +## Description + +Chain ID: 1802203764 +Chain Name: Kakarot Sepolia +Default Block Explorer: https://sepolia.kakarotscan.org +Default RPC URL: https://sepolia-rpc.kakarot.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { kakarotSepolia } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: kakarotSepolia, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/kakarotSepolia.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/kakarotSepolia.js#L26) diff --git a/packages/common/docs/variables/karura.md b/packages/common/docs/variables/karura.md new file mode 100644 index 0000000000..8daba13fd7 --- /dev/null +++ b/packages/common/docs/variables/karura.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / karura + +# Variable: karura + +> `const` **karura**: `object` + +Creates a common configuration for the karura chain. + +## Description + +Chain ID: 686 +Chain Name: Karura +Default Block Explorer: https://blockscout.karura.network +Default RPC URL: https://eth-rpc-karura.aca-api.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { karura } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: karura, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/karura.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/karura.js#L26) diff --git a/packages/common/docs/variables/kava.md b/packages/common/docs/variables/kava.md new file mode 100644 index 0000000000..9cfae1b238 --- /dev/null +++ b/packages/common/docs/variables/kava.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / kava + +# Variable: kava + +> `const` **kava**: `object` + +Creates a common configuration for the kava chain. + +## Description + +Chain ID: 2222 +Chain Name: Kava EVM +Default Block Explorer: https://kavascan.com +Default RPC URL: https://evm.kava.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { kava } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: kava, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/kava.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/kava.js#L26) diff --git a/packages/common/docs/variables/kavaTestnet.md b/packages/common/docs/variables/kavaTestnet.md new file mode 100644 index 0000000000..8b8aab6a83 --- /dev/null +++ b/packages/common/docs/variables/kavaTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / kavaTestnet + +# Variable: kavaTestnet + +> `const` **kavaTestnet**: `object` + +Creates a common configuration for the kavaTestnet chain. + +## Description + +Chain ID: 2221 +Chain Name: Kava EVM Testnet +Default Block Explorer: https://testnet.kavascan.com/ +Default RPC URL: https://evm.testnet.kava.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { kavaTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: kavaTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/kavaTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/kavaTestnet.js#L26) diff --git a/packages/common/docs/variables/kcc.md b/packages/common/docs/variables/kcc.md new file mode 100644 index 0000000000..64ec0a7455 --- /dev/null +++ b/packages/common/docs/variables/kcc.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / kcc + +# Variable: kcc + +> `const` **kcc**: `object` + +Creates a common configuration for the kcc chain. + +## Description + +Chain ID: 321 +Chain Name: KCC Mainnet +Default Block Explorer: https://explorer.kcc.io +Default RPC URL: https://kcc-rpc.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { kcc } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: kcc, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/kcc.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/kcc.js#L26) diff --git a/packages/common/docs/variables/klaytn.md b/packages/common/docs/variables/klaytn.md new file mode 100644 index 0000000000..1f08f0fe37 --- /dev/null +++ b/packages/common/docs/variables/klaytn.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / klaytn + +# Variable: klaytn + +> `const` **klaytn**: `object` + +Creates a common configuration for the klaytn chain. + +## Description + +Chain ID: 8217 +Chain Name: Klaytn +Default Block Explorer: https://scope.klaytn.com +Default RPC URL: https://public-en-cypress.klaytn.net + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { klaytn } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: klaytn, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/klaytn.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/klaytn.js#L26) diff --git a/packages/common/docs/variables/klaytnBaobab.md b/packages/common/docs/variables/klaytnBaobab.md new file mode 100644 index 0000000000..e2831e5b64 --- /dev/null +++ b/packages/common/docs/variables/klaytnBaobab.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / klaytnBaobab + +# Variable: klaytnBaobab + +> `const` **klaytnBaobab**: `object` + +Creates a common configuration for the klaytnBaobab chain. + +## Description + +Chain ID: 1001 +Chain Name: Klaytn Baobab Testnet +Default Block Explorer: https://baobab.klaytnscope.com +Default RPC URL: https://public-en-baobab.klaytn.net + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { klaytnBaobab } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: klaytnBaobab, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/klaytnBaobab.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/klaytnBaobab.js#L26) diff --git a/packages/common/docs/variables/koi.md b/packages/common/docs/variables/koi.md new file mode 100644 index 0000000000..b02d4f9437 --- /dev/null +++ b/packages/common/docs/variables/koi.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / koi + +# Variable: koi + +> `const` **koi**: `object` + +Creates a common configuration for the koi chain. + +## Description + +Chain ID: 701 +Chain Name: Koi Network +Default Block Explorer: https://koi-scan.darwinia.network +Default RPC URL: https://koi-rpc.darwinia.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { koi } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: koi, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/koi.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/koi.js#L26) diff --git a/packages/common/docs/variables/kroma.md b/packages/common/docs/variables/kroma.md new file mode 100644 index 0000000000..23e494c6ac --- /dev/null +++ b/packages/common/docs/variables/kroma.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / kroma + +# Variable: kroma + +> `const` **kroma**: `object` + +Creates a common configuration for the kroma chain. + +## Description + +Chain ID: 255 +Chain Name: Kroma +Default Block Explorer: https://blockscout.kroma.network +Default RPC URL: https://api.kroma.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { kroma } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: kroma, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/kroma.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/kroma.js#L26) diff --git a/packages/common/docs/variables/kromaSepolia.md b/packages/common/docs/variables/kromaSepolia.md new file mode 100644 index 0000000000..db4591ddfa --- /dev/null +++ b/packages/common/docs/variables/kromaSepolia.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / kromaSepolia + +# Variable: kromaSepolia + +> `const` **kromaSepolia**: `object` + +Creates a common configuration for the kromaSepolia chain. + +## Description + +Chain ID: 2358 +Chain Name: Kroma Sepolia +Default Block Explorer: https://blockscout.sepolia.kroma.network +Default RPC URL: https://api.sepolia.kroma.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { kromaSepolia } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: kromaSepolia, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/kromaSepolia.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/kromaSepolia.js#L26) diff --git a/packages/common/docs/variables/l3x.md b/packages/common/docs/variables/l3x.md new file mode 100644 index 0000000000..fd649638ec --- /dev/null +++ b/packages/common/docs/variables/l3x.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / l3x + +# Variable: l3x + +> `const` **l3x**: `object` + +Creates a common configuration for the l3x chain. + +## Description + +Chain ID: 12324 +Chain Name: L3X Protocol +Default Block Explorer: https://explorer.l3x.com +Default RPC URL: https://rpc-mainnet.l3x.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { l3x } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: l3x, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/l3x.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/l3x.js#L26) diff --git a/packages/common/docs/variables/l3xTestnet.md b/packages/common/docs/variables/l3xTestnet.md new file mode 100644 index 0000000000..560ad9e24a --- /dev/null +++ b/packages/common/docs/variables/l3xTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / l3xTestnet + +# Variable: l3xTestnet + +> `const` **l3xTestnet**: `object` + +Creates a common configuration for the l3xTestnet chain. + +## Description + +Chain ID: 12325 +Chain Name: L3X Protocol Testnet +Default Block Explorer: https://explorer-testnet.l3x.com +Default RPC URL: https://rpc-testnet.l3x.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { l3xTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: l3xTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/l3xTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/l3xTestnet.js#L26) diff --git a/packages/common/docs/variables/lightlinkPegasus.md b/packages/common/docs/variables/lightlinkPegasus.md new file mode 100644 index 0000000000..0523a7ec8e --- /dev/null +++ b/packages/common/docs/variables/lightlinkPegasus.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / lightlinkPegasus + +# Variable: lightlinkPegasus + +> `const` **lightlinkPegasus**: `object` + +Creates a common configuration for the lightlinkPegasus chain. + +## Description + +Chain ID: 1891 +Chain Name: LightLink Pegasus Testnet +Default Block Explorer: https://pegasus.lightlink.io +Default RPC URL: https://replicator.pegasus.lightlink.io/rpc/v1 + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { lightlinkPegasus } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: lightlinkPegasus, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/lightlinkPegasus.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/lightlinkPegasus.js#L26) diff --git a/packages/common/docs/variables/lightlinkPhoenix.md b/packages/common/docs/variables/lightlinkPhoenix.md new file mode 100644 index 0000000000..b29b4c3fea --- /dev/null +++ b/packages/common/docs/variables/lightlinkPhoenix.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / lightlinkPhoenix + +# Variable: lightlinkPhoenix + +> `const` **lightlinkPhoenix**: `object` + +Creates a common configuration for the lightlinkPhoenix chain. + +## Description + +Chain ID: 1890 +Chain Name: LightLink Phoenix Mainnet +Default Block Explorer: https://phoenix.lightlink.io +Default RPC URL: https://replicator.phoenix.lightlink.io/rpc/v1 + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { lightlinkPhoenix } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: lightlinkPhoenix, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/lightlinkPhoenix.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/lightlinkPhoenix.js#L26) diff --git a/packages/common/docs/variables/linea.md b/packages/common/docs/variables/linea.md new file mode 100644 index 0000000000..a169083603 --- /dev/null +++ b/packages/common/docs/variables/linea.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / linea + +# Variable: linea + +> `const` **linea**: `object` + +Creates a common configuration for the linea chain. + +## Description + +Chain ID: 59144 +Chain Name: Linea Mainnet +Default Block Explorer: https://lineascan.build +Default RPC URL: https://rpc.linea.build + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { linea } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: linea, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/linea.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/linea.js#L26) diff --git a/packages/common/docs/variables/lineaGoerli.md b/packages/common/docs/variables/lineaGoerli.md new file mode 100644 index 0000000000..31306473f8 --- /dev/null +++ b/packages/common/docs/variables/lineaGoerli.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / lineaGoerli + +# Variable: lineaGoerli + +> `const` **lineaGoerli**: `object` + +Creates a common configuration for the lineaGoerli chain. + +## Description + +Chain ID: 59140 +Chain Name: Linea Goerli Testnet +Default Block Explorer: https://goerli.lineascan.build +Default RPC URL: https://rpc.goerli.linea.build + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { lineaGoerli } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: lineaGoerli, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/lineaGoerli.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/lineaGoerli.js#L26) diff --git a/packages/common/docs/variables/lineaSepolia.md b/packages/common/docs/variables/lineaSepolia.md new file mode 100644 index 0000000000..4e6eded42f --- /dev/null +++ b/packages/common/docs/variables/lineaSepolia.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / lineaSepolia + +# Variable: lineaSepolia + +> `const` **lineaSepolia**: `object` + +Creates a common configuration for the lineaSepolia chain. + +## Description + +Chain ID: 59141 +Chain Name: Linea Sepolia Testnet +Default Block Explorer: https://sepolia.lineascan.build +Default RPC URL: https://rpc.sepolia.linea.build + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { lineaSepolia } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: lineaSepolia, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/lineaSepolia.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/lineaSepolia.js#L26) diff --git a/packages/common/docs/variables/lineaTestnet.md b/packages/common/docs/variables/lineaTestnet.md new file mode 100644 index 0000000000..acde0beb0a --- /dev/null +++ b/packages/common/docs/variables/lineaTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / lineaTestnet + +# Variable: lineaTestnet + +> `const` **lineaTestnet**: `object` + +Creates a common configuration for the lineaTestnet chain. + +## Description + +Chain ID: 59140 +Chain Name: Linea Goerli Testnet +Default Block Explorer: https://goerli.lineascan.build +Default RPC URL: https://rpc.goerli.linea.build + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { lineaTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: lineaTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/lineaTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/lineaTestnet.js#L26) diff --git a/packages/common/docs/variables/lisk.md b/packages/common/docs/variables/lisk.md new file mode 100644 index 0000000000..0548990cd1 --- /dev/null +++ b/packages/common/docs/variables/lisk.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / lisk + +# Variable: lisk + +> `const` **lisk**: `object` + +Creates a common configuration for the lisk chain. + +## Description + +Chain ID: 1135 +Chain Name: Lisk +Default Block Explorer: https://blockscout.lisk.com +Default RPC URL: https://rpc.api.lisk.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { lisk } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: lisk, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/lisk.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/lisk.js#L26) diff --git a/packages/common/docs/variables/liskSepolia.md b/packages/common/docs/variables/liskSepolia.md new file mode 100644 index 0000000000..198bb440f8 --- /dev/null +++ b/packages/common/docs/variables/liskSepolia.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / liskSepolia + +# Variable: liskSepolia + +> `const` **liskSepolia**: `object` + +Creates a common configuration for the liskSepolia chain. + +## Description + +Chain ID: 4202 +Chain Name: Lisk Sepolia +Default Block Explorer: https://sepolia-blockscout.lisk.com +Default RPC URL: https://rpc.sepolia-api.lisk.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { liskSepolia } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: liskSepolia, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/liskSepolia.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/liskSepolia.js#L26) diff --git a/packages/common/docs/variables/localhost.md b/packages/common/docs/variables/localhost.md new file mode 100644 index 0000000000..9855d8c3a5 --- /dev/null +++ b/packages/common/docs/variables/localhost.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / localhost + +# Variable: localhost + +> `const` **localhost**: `object` + +Creates a common configuration for the localhost chain. + +## Description + +Chain ID: 1337 +Chain Name: Localhost +Default Block Explorer: Not specified +Default RPC URL: http://127.0.0.1:8545 + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { localhost } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: localhost, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/localhost.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/localhost.js#L26) diff --git a/packages/common/docs/variables/lukso.md b/packages/common/docs/variables/lukso.md new file mode 100644 index 0000000000..6f6e2749d8 --- /dev/null +++ b/packages/common/docs/variables/lukso.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / lukso + +# Variable: lukso + +> `const` **lukso**: `object` + +Creates a common configuration for the lukso chain. + +## Description + +Chain ID: 42 +Chain Name: LUKSO +Default Block Explorer: https://explorer.execution.mainnet.lukso.network +Default RPC URL: https://rpc.mainnet.lukso.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { lukso } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: lukso, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/lukso.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/lukso.js#L26) diff --git a/packages/common/docs/variables/luksoTestnet.md b/packages/common/docs/variables/luksoTestnet.md new file mode 100644 index 0000000000..cc5d84de59 --- /dev/null +++ b/packages/common/docs/variables/luksoTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / luksoTestnet + +# Variable: luksoTestnet + +> `const` **luksoTestnet**: `object` + +Creates a common configuration for the luksoTestnet chain. + +## Description + +Chain ID: 4201 +Chain Name: LUKSO Testnet +Default Block Explorer: https://explorer.execution.testnet.lukso.network +Default RPC URL: https://rpc.testnet.lukso.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { luksoTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: luksoTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/luksoTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/luksoTestnet.js#L26) diff --git a/packages/common/docs/variables/lycan.md b/packages/common/docs/variables/lycan.md new file mode 100644 index 0000000000..28da522665 --- /dev/null +++ b/packages/common/docs/variables/lycan.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / lycan + +# Variable: lycan + +> `const` **lycan**: `object` + +Creates a common configuration for the lycan chain. + +## Description + +Chain ID: 721 +Chain Name: Lycan +Default Block Explorer: https://explorer.lycanchain.com +Default RPC URL: https://rpc.lycanchain.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { lycan } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: lycan, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/lycan.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/lycan.js#L26) diff --git a/packages/common/docs/variables/lyra.md b/packages/common/docs/variables/lyra.md new file mode 100644 index 0000000000..f4049f06e8 --- /dev/null +++ b/packages/common/docs/variables/lyra.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / lyra + +# Variable: lyra + +> `const` **lyra**: `object` + +Creates a common configuration for the lyra chain. + +## Description + +Chain ID: 957 +Chain Name: Lyra Chain +Default Block Explorer: https://explorer.lyra.finance +Default RPC URL: https://rpc.lyra.finance + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { lyra } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: lyra, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/lyra.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/lyra.js#L26) diff --git a/packages/common/docs/variables/mandala.md b/packages/common/docs/variables/mandala.md new file mode 100644 index 0000000000..5bc1f45e8d --- /dev/null +++ b/packages/common/docs/variables/mandala.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / mandala + +# Variable: mandala + +> `const` **mandala**: `object` + +Creates a common configuration for the mandala chain. + +## Description + +Chain ID: 595 +Chain Name: Mandala TC9 +Default Block Explorer: https://blockscout.mandala.aca-staging.network +Default RPC URL: https://eth-rpc-tc9.aca-staging.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { mandala } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: mandala, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/mandala.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/mandala.js#L26) diff --git a/packages/common/docs/variables/mantaSepoliaTestnet.md b/packages/common/docs/variables/mantaSepoliaTestnet.md new file mode 100644 index 0000000000..0ae3284d86 --- /dev/null +++ b/packages/common/docs/variables/mantaSepoliaTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / mantaSepoliaTestnet + +# Variable: mantaSepoliaTestnet + +> `const` **mantaSepoliaTestnet**: `object` + +Creates a common configuration for the mantaSepoliaTestnet chain. + +## Description + +Chain ID: 3441006 +Chain Name: Manta Pacific Sepolia Testnet +Default Block Explorer: https://pacific-explorer.sepolia-testnet.manta.network +Default RPC URL: https://pacific-rpc.sepolia-testnet.manta.network/http + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { mantaSepoliaTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: mantaSepoliaTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/mantaSepoliaTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/mantaSepoliaTestnet.js#L26) diff --git a/packages/common/docs/variables/mantaTestnet.md b/packages/common/docs/variables/mantaTestnet.md new file mode 100644 index 0000000000..4cc14f9bef --- /dev/null +++ b/packages/common/docs/variables/mantaTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / mantaTestnet + +# Variable: mantaTestnet + +> `const` **mantaTestnet**: `object` + +Creates a common configuration for the mantaTestnet chain. + +## Description + +Chain ID: 3441005 +Chain Name: Manta Pacific Testnet +Default Block Explorer: https://pacific-explorer.testnet.manta.network +Default RPC URL: https://manta-testnet.calderachain.xyz/http + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { mantaTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: mantaTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/mantaTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/mantaTestnet.js#L26) diff --git a/packages/common/docs/variables/mantleSepoliaTestnet.md b/packages/common/docs/variables/mantleSepoliaTestnet.md new file mode 100644 index 0000000000..9515d959e6 --- /dev/null +++ b/packages/common/docs/variables/mantleSepoliaTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / mantleSepoliaTestnet + +# Variable: mantleSepoliaTestnet + +> `const` **mantleSepoliaTestnet**: `object` + +Creates a common configuration for the mantleSepoliaTestnet chain. + +## Description + +Chain ID: 5003 +Chain Name: Mantle Sepolia Testnet +Default Block Explorer: https://explorer.sepolia.mantle.xyz/ +Default RPC URL: https://rpc.sepolia.mantle.xyz + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { mantleSepoliaTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: mantleSepoliaTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/mantleSepoliaTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/mantleSepoliaTestnet.js#L26) diff --git a/packages/common/docs/variables/mantleTestnet.md b/packages/common/docs/variables/mantleTestnet.md new file mode 100644 index 0000000000..3dcbb90f34 --- /dev/null +++ b/packages/common/docs/variables/mantleTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / mantleTestnet + +# Variable: mantleTestnet + +> `const` **mantleTestnet**: `object` + +Creates a common configuration for the mantleTestnet chain. + +## Description + +Chain ID: 5001 +Chain Name: Mantle Testnet +Default Block Explorer: https://explorer.testnet.mantle.xyz +Default RPC URL: https://rpc.testnet.mantle.xyz + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { mantleTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: mantleTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/mantleTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/mantleTestnet.js#L26) diff --git a/packages/common/docs/variables/merlin.md b/packages/common/docs/variables/merlin.md new file mode 100644 index 0000000000..8006373278 --- /dev/null +++ b/packages/common/docs/variables/merlin.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / merlin + +# Variable: merlin + +> `const` **merlin**: `object` + +Creates a common configuration for the merlin chain. + +## Description + +Chain ID: 4200 +Chain Name: Merlin +Default Block Explorer: https://scan.merlinchain.io +Default RPC URL: https://rpc.merlinchain.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { merlin } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: merlin, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/merlin.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/merlin.js#L26) diff --git a/packages/common/docs/variables/metachain.md b/packages/common/docs/variables/metachain.md new file mode 100644 index 0000000000..2777ab1499 --- /dev/null +++ b/packages/common/docs/variables/metachain.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / metachain + +# Variable: metachain + +> `const` **metachain**: `object` + +Creates a common configuration for the metachain chain. + +## Description + +Chain ID: 571 +Chain Name: MetaChain Mainnet +Default Block Explorer: https://explorer.metatime.com +Default RPC URL: https://rpc.metatime.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { metachain } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: metachain, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/metachain.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/metachain.js#L26) diff --git a/packages/common/docs/variables/metachainIstanbul.md b/packages/common/docs/variables/metachainIstanbul.md new file mode 100644 index 0000000000..83d4d7ac92 --- /dev/null +++ b/packages/common/docs/variables/metachainIstanbul.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / metachainIstanbul + +# Variable: metachainIstanbul + +> `const` **metachainIstanbul**: `object` + +Creates a common configuration for the metachainIstanbul chain. + +## Description + +Chain ID: 1453 +Chain Name: MetaChain Istanbul +Default Block Explorer: https://istanbul-explorer.metachain.dev +Default RPC URL: https://istanbul-rpc.metachain.dev + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { metachainIstanbul } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: metachainIstanbul, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/metachainIstanbul.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/metachainIstanbul.js#L26) diff --git a/packages/common/docs/variables/metalL2.md b/packages/common/docs/variables/metalL2.md new file mode 100644 index 0000000000..204d31af1e --- /dev/null +++ b/packages/common/docs/variables/metalL2.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / metalL2 + +# Variable: metalL2 + +> `const` **metalL2**: `object` + +Creates a common configuration for the metalL2 chain. + +## Description + +Chain ID: 1750 +Chain Name: Metal L2 +Default Block Explorer: https://explorer.metall2.com +Default RPC URL: https://rpc.metall2.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { metalL2 } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: metalL2, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/metalL2.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/metalL2.js#L26) diff --git a/packages/common/docs/variables/meter.md b/packages/common/docs/variables/meter.md new file mode 100644 index 0000000000..4c344a6da7 --- /dev/null +++ b/packages/common/docs/variables/meter.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / meter + +# Variable: meter + +> `const` **meter**: `object` + +Creates a common configuration for the meter chain. + +## Description + +Chain ID: 82 +Chain Name: Meter +Default Block Explorer: https://scan.meter.io +Default RPC URL: https://rpc.meter.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { meter } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: meter, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/meter.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/meter.js#L26) diff --git a/packages/common/docs/variables/meterTestnet.md b/packages/common/docs/variables/meterTestnet.md new file mode 100644 index 0000000000..9ba89cf397 --- /dev/null +++ b/packages/common/docs/variables/meterTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / meterTestnet + +# Variable: meterTestnet + +> `const` **meterTestnet**: `object` + +Creates a common configuration for the meterTestnet chain. + +## Description + +Chain ID: 83 +Chain Name: Meter Testnet +Default Block Explorer: https://scan-warringstakes.meter.io +Default RPC URL: https://rpctest.meter.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { meterTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: meterTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/meterTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/meterTestnet.js#L26) diff --git a/packages/common/docs/variables/metis.md b/packages/common/docs/variables/metis.md new file mode 100644 index 0000000000..799addbd5b --- /dev/null +++ b/packages/common/docs/variables/metis.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / metis + +# Variable: metis + +> `const` **metis**: `object` + +Creates a common configuration for the metis chain. + +## Description + +Chain ID: 1088 +Chain Name: Metis +Default Block Explorer: https://explorer.metis.io +Default RPC URL: https://andromeda.metis.io/?owner=1088 + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { metis } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: metis, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/metis.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/metis.js#L26) diff --git a/packages/common/docs/variables/metisGoerli.md b/packages/common/docs/variables/metisGoerli.md new file mode 100644 index 0000000000..db319fa61b --- /dev/null +++ b/packages/common/docs/variables/metisGoerli.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / metisGoerli + +# Variable: metisGoerli + +> `const` **metisGoerli**: `object` + +Creates a common configuration for the metisGoerli chain. + +## Description + +Chain ID: 599 +Chain Name: Metis Goerli +Default Block Explorer: https://goerli.explorer.metisdevops.link +Default RPC URL: https://goerli.gateway.metisdevops.link + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { metisGoerli } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: metisGoerli, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/metisGoerli.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/metisGoerli.js#L26) diff --git a/packages/common/docs/variables/mev.md b/packages/common/docs/variables/mev.md new file mode 100644 index 0000000000..3faf31a141 --- /dev/null +++ b/packages/common/docs/variables/mev.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / mev + +# Variable: mev + +> `const` **mev**: `object` + +Creates a common configuration for the mev chain. + +## Description + +Chain ID: 7518 +Chain Name: MEVerse Chain Mainnet +Default Block Explorer: https://www.meversescan.io +Default RPC URL: https://rpc.meversemainnet.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { mev } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: mev, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/mev.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/mev.js#L26) diff --git a/packages/common/docs/variables/mevTestnet.md b/packages/common/docs/variables/mevTestnet.md new file mode 100644 index 0000000000..dd8679c17a --- /dev/null +++ b/packages/common/docs/variables/mevTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / mevTestnet + +# Variable: mevTestnet + +> `const` **mevTestnet**: `object` + +Creates a common configuration for the mevTestnet chain. + +## Description + +Chain ID: 4759 +Chain Name: MEVerse Chain Testnet +Default Block Explorer: https://testnet.meversescan.io/ +Default RPC URL: https://rpc.meversetestnet.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { mevTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: mevTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/mevTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/mevTestnet.js#L26) diff --git a/packages/common/docs/variables/mintSepoliaTestnet.md b/packages/common/docs/variables/mintSepoliaTestnet.md new file mode 100644 index 0000000000..f6c3fbef0d --- /dev/null +++ b/packages/common/docs/variables/mintSepoliaTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / mintSepoliaTestnet + +# Variable: mintSepoliaTestnet + +> `const` **mintSepoliaTestnet**: `object` + +Creates a common configuration for the mintSepoliaTestnet chain. + +## Description + +Chain ID: 1686 +Chain Name: Mint Sepolia Testnet +Default Block Explorer: https://testnet-explorer.mintchain.io +Default RPC URL: https://testnet-rpc.mintchain.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { mintSepoliaTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: mintSepoliaTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/mintSepoliaTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/mintSepoliaTestnet.js#L26) diff --git a/packages/common/docs/variables/mode.md b/packages/common/docs/variables/mode.md new file mode 100644 index 0000000000..59746c2646 --- /dev/null +++ b/packages/common/docs/variables/mode.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / mode + +# Variable: mode + +> `const` **mode**: `object` + +Creates a common configuration for the mode chain. + +## Description + +Chain ID: 34443 +Chain Name: Mode Mainnet +Default Block Explorer: https://modescan.io +Default RPC URL: https://mainnet.mode.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { mode } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: mode, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/mode.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/mode.js#L26) diff --git a/packages/common/docs/variables/modeTestnet.md b/packages/common/docs/variables/modeTestnet.md new file mode 100644 index 0000000000..0e5d70776b --- /dev/null +++ b/packages/common/docs/variables/modeTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / modeTestnet + +# Variable: modeTestnet + +> `const` **modeTestnet**: `object` + +Creates a common configuration for the modeTestnet chain. + +## Description + +Chain ID: 919 +Chain Name: Mode Testnet +Default Block Explorer: https://sepolia.explorer.mode.network +Default RPC URL: https://sepolia.mode.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { modeTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: modeTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/modeTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/modeTestnet.js#L26) diff --git a/packages/common/docs/variables/moonbaseAlpha.md b/packages/common/docs/variables/moonbaseAlpha.md new file mode 100644 index 0000000000..296424dcf5 --- /dev/null +++ b/packages/common/docs/variables/moonbaseAlpha.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / moonbaseAlpha + +# Variable: moonbaseAlpha + +> `const` **moonbaseAlpha**: `object` + +Creates a common configuration for the moonbaseAlpha chain. + +## Description + +Chain ID: 1287 +Chain Name: Moonbase Alpha +Default Block Explorer: https://moonbase.moonscan.io +Default RPC URL: https://rpc.api.moonbase.moonbeam.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { moonbaseAlpha } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: moonbaseAlpha, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/moonbaseAlpha.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/moonbaseAlpha.js#L26) diff --git a/packages/common/docs/variables/moonbeam.md b/packages/common/docs/variables/moonbeam.md new file mode 100644 index 0000000000..07095fdd64 --- /dev/null +++ b/packages/common/docs/variables/moonbeam.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / moonbeam + +# Variable: moonbeam + +> `const` **moonbeam**: `object` + +Creates a common configuration for the moonbeam chain. + +## Description + +Chain ID: 1284 +Chain Name: Moonbeam +Default Block Explorer: https://moonscan.io +Default RPC URL: https://moonbeam.public.blastapi.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { moonbeam } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: moonbeam, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/moonbeam.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/moonbeam.js#L26) diff --git a/packages/common/docs/variables/moonbeamDev.md b/packages/common/docs/variables/moonbeamDev.md new file mode 100644 index 0000000000..a3ca5b6aaa --- /dev/null +++ b/packages/common/docs/variables/moonbeamDev.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / moonbeamDev + +# Variable: moonbeamDev + +> `const` **moonbeamDev**: `object` + +Creates a common configuration for the moonbeamDev chain. + +## Description + +Chain ID: 1281 +Chain Name: Moonbeam Development Node +Default Block Explorer: Not specified +Default RPC URL: http://127.0.0.1:9944 + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { moonbeamDev } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: moonbeamDev, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/moonbeamDev.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/moonbeamDev.js#L26) diff --git a/packages/common/docs/variables/moonriver.md b/packages/common/docs/variables/moonriver.md new file mode 100644 index 0000000000..f2212c20c6 --- /dev/null +++ b/packages/common/docs/variables/moonriver.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / moonriver + +# Variable: moonriver + +> `const` **moonriver**: `object` + +Creates a common configuration for the moonriver chain. + +## Description + +Chain ID: 1285 +Chain Name: Moonriver +Default Block Explorer: https://moonriver.moonscan.io +Default RPC URL: https://moonriver.public.blastapi.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { moonriver } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: moonriver, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/moonriver.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/moonriver.js#L26) diff --git a/packages/common/docs/variables/morphHolesky.md b/packages/common/docs/variables/morphHolesky.md new file mode 100644 index 0000000000..8bedd7fbc8 --- /dev/null +++ b/packages/common/docs/variables/morphHolesky.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / morphHolesky + +# Variable: morphHolesky + +> `const` **morphHolesky**: `object` + +Creates a common configuration for the morphHolesky chain. + +## Description + +Chain ID: 2810 +Chain Name: Morph Holesky +Default Block Explorer: https://explorer-holesky.morphl2.io +Default RPC URL: https://rpc-quicknode-holesky.morphl2.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { morphHolesky } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: morphHolesky, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/morphHolesky.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/morphHolesky.js#L26) diff --git a/packages/common/docs/variables/morphSepolia.md b/packages/common/docs/variables/morphSepolia.md new file mode 100644 index 0000000000..7c0ee6f64f --- /dev/null +++ b/packages/common/docs/variables/morphSepolia.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / morphSepolia + +# Variable: morphSepolia + +> `const` **morphSepolia**: `object` + +Creates a common configuration for the morphSepolia chain. + +## Description + +Chain ID: 2710 +Chain Name: Morph Sepolia +Default Block Explorer: https://explorer-testnet.morphl2.io +Default RPC URL: https://rpc-testnet.morphl2.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { morphSepolia } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: morphSepolia, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/morphSepolia.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/morphSepolia.js#L26) diff --git a/packages/common/docs/variables/nautilus.md b/packages/common/docs/variables/nautilus.md new file mode 100644 index 0000000000..3d5ca1cee9 --- /dev/null +++ b/packages/common/docs/variables/nautilus.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / nautilus + +# Variable: nautilus + +> `const` **nautilus**: `object` + +Creates a common configuration for the nautilus chain. + +## Description + +Chain ID: 22222 +Chain Name: Nautilus Mainnet +Default Block Explorer: https://nautscan.com +Default RPC URL: https://api.nautilus.nautchain.xyz + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { nautilus } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: nautilus, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/nautilus.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/nautilus.js#L26) diff --git a/packages/common/docs/variables/neonDevnet.md b/packages/common/docs/variables/neonDevnet.md new file mode 100644 index 0000000000..2eebcd1743 --- /dev/null +++ b/packages/common/docs/variables/neonDevnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / neonDevnet + +# Variable: neonDevnet + +> `const` **neonDevnet**: `object` + +Creates a common configuration for the neonDevnet chain. + +## Description + +Chain ID: 245022926 +Chain Name: Neon EVM DevNet +Default Block Explorer: https://devnet.neonscan.org +Default RPC URL: https://devnet.neonevm.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { neonDevnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: neonDevnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/neonDevnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/neonDevnet.js#L26) diff --git a/packages/common/docs/variables/neonMainnet.md b/packages/common/docs/variables/neonMainnet.md new file mode 100644 index 0000000000..691315199b --- /dev/null +++ b/packages/common/docs/variables/neonMainnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / neonMainnet + +# Variable: neonMainnet + +> `const` **neonMainnet**: `object` + +Creates a common configuration for the neonMainnet chain. + +## Description + +Chain ID: 245022934 +Chain Name: Neon EVM MainNet +Default Block Explorer: https://neonscan.org +Default RPC URL: https://neon-proxy-mainnet.solana.p2p.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { neonMainnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: neonMainnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/neonMainnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/neonMainnet.js#L26) diff --git a/packages/common/docs/variables/nexi.md b/packages/common/docs/variables/nexi.md new file mode 100644 index 0000000000..7f6cf85d69 --- /dev/null +++ b/packages/common/docs/variables/nexi.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / nexi + +# Variable: nexi + +> `const` **nexi**: `object` + +Creates a common configuration for the nexi chain. + +## Description + +Chain ID: 4242 +Chain Name: Nexi +Default Block Explorer: https://www.nexiscan.com +Default RPC URL: https://rpc.chain.nexi.technology + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { nexi } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: nexi, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/nexi.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/nexi.js#L26) diff --git a/packages/common/docs/variables/nexilix.md b/packages/common/docs/variables/nexilix.md new file mode 100644 index 0000000000..ac802711e3 --- /dev/null +++ b/packages/common/docs/variables/nexilix.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / nexilix + +# Variable: nexilix + +> `const` **nexilix**: `object` + +Creates a common configuration for the nexilix chain. + +## Description + +Chain ID: 240 +Chain Name: Nexilix Smart Chain +Default Block Explorer: https://scan.nexilix.com +Default RPC URL: https://rpcurl.pos.nexilix.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { nexilix } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: nexilix, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/nexilix.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/nexilix.js#L26) diff --git a/packages/common/docs/variables/oasisTestnet.md b/packages/common/docs/variables/oasisTestnet.md new file mode 100644 index 0000000000..d717975c01 --- /dev/null +++ b/packages/common/docs/variables/oasisTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / oasisTestnet + +# Variable: oasisTestnet + +> `const` **oasisTestnet**: `object` + +Creates a common configuration for the oasisTestnet chain. + +## Description + +Chain ID: 4090 +Chain Name: Oasis Testnet +Default Block Explorer: https://oasis.ftnscan.com +Default RPC URL: https://rpc1.oasis.bahamutchain.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { oasisTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: oasisTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/oasisTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/oasisTestnet.js#L26) diff --git a/packages/common/docs/variables/oasys.md b/packages/common/docs/variables/oasys.md new file mode 100644 index 0000000000..afa2b244ea --- /dev/null +++ b/packages/common/docs/variables/oasys.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / oasys + +# Variable: oasys + +> `const` **oasys**: `object` + +Creates a common configuration for the oasys chain. + +## Description + +Chain ID: 248 +Chain Name: Oasys +Default Block Explorer: https://scan.oasys.games +Default RPC URL: https://rpc.mainnet.oasys.games + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { oasys } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: oasys, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/oasys.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/oasys.js#L26) diff --git a/packages/common/docs/variables/okc.md b/packages/common/docs/variables/okc.md new file mode 100644 index 0000000000..f1bc3ebe15 --- /dev/null +++ b/packages/common/docs/variables/okc.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / okc + +# Variable: okc + +> `const` **okc**: `object` + +Creates a common configuration for the okc chain. + +## Description + +Chain ID: 66 +Chain Name: OKC +Default Block Explorer: https://www.oklink.com/okc +Default RPC URL: https://exchainrpc.okex.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { okc } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: okc, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/okc.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/okc.js#L26) diff --git a/packages/common/docs/variables/oortMainnetDev.md b/packages/common/docs/variables/oortMainnetDev.md new file mode 100644 index 0000000000..2e3807e60c --- /dev/null +++ b/packages/common/docs/variables/oortMainnetDev.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / oortMainnetDev + +# Variable: oortMainnetDev + +> `const` **oortMainnetDev**: `object` + +Creates a common configuration for the oortMainnetDev chain. + +## Description + +Chain ID: 9700 +Chain Name: OORT MainnetDev +Default Block Explorer: https://dev-scan.oortech.com +Default RPC URL: https://dev-rpc.oortech.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { oortMainnetDev } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: oortMainnetDev, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/oortMainnetDev.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/oortMainnetDev.js#L26) diff --git a/packages/common/docs/variables/opBNB.md b/packages/common/docs/variables/opBNB.md new file mode 100644 index 0000000000..5ebafa2c1c --- /dev/null +++ b/packages/common/docs/variables/opBNB.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / opBNB + +# Variable: opBNB + +> `const` **opBNB**: `object` + +Creates a common configuration for the opBNB chain. + +## Description + +Chain ID: 204 +Chain Name: opBNB +Default Block Explorer: https://mainnet.opbnbscan.com +Default RPC URL: https://opbnb-mainnet-rpc.bnbchain.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { opBNB } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: opBNB, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/opBNB.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/opBNB.js#L26) diff --git a/packages/common/docs/variables/opBNBTestnet.md b/packages/common/docs/variables/opBNBTestnet.md new file mode 100644 index 0000000000..5d40fc6f48 --- /dev/null +++ b/packages/common/docs/variables/opBNBTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / opBNBTestnet + +# Variable: opBNBTestnet + +> `const` **opBNBTestnet**: `object` + +Creates a common configuration for the opBNBTestnet chain. + +## Description + +Chain ID: 5611 +Chain Name: opBNB Testnet +Default Block Explorer: https://testnet.opbnbscan.com +Default RPC URL: https://opbnb-testnet-rpc.bnbchain.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { opBNBTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: opBNBTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/opBNBTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/opBNBTestnet.js#L26) diff --git a/packages/common/docs/variables/optimismGoerli.md b/packages/common/docs/variables/optimismGoerli.md new file mode 100644 index 0000000000..2c40bbe66d --- /dev/null +++ b/packages/common/docs/variables/optimismGoerli.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / optimismGoerli + +# Variable: optimismGoerli + +> `const` **optimismGoerli**: `object` + +Creates a common configuration for the optimismGoerli chain. + +## Description + +Chain ID: 420 +Chain Name: Optimism Goerli +Default Block Explorer: https://goerli-optimism.etherscan.io +Default RPC URL: https://goerli.optimism.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { optimismGoerli } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: optimismGoerli, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/optimismGoerli.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/optimismGoerli.js#L26) diff --git a/packages/common/docs/variables/otimDevnet.md b/packages/common/docs/variables/otimDevnet.md new file mode 100644 index 0000000000..6530b2fcea --- /dev/null +++ b/packages/common/docs/variables/otimDevnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / otimDevnet + +# Variable: otimDevnet + +> `const` **otimDevnet**: `object` + +Creates a common configuration for the otimDevnet chain. + +## Description + +Chain ID: 41144114 +Chain Name: Otim Devnet +Default Block Explorer: Not specified +Default RPC URL: http://devnet.otim.xyz + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { otimDevnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: otimDevnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/otimDevnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/otimDevnet.js#L26) diff --git a/packages/common/docs/variables/palm.md b/packages/common/docs/variables/palm.md new file mode 100644 index 0000000000..81463d0682 --- /dev/null +++ b/packages/common/docs/variables/palm.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / palm + +# Variable: palm + +> `const` **palm**: `object` + +Creates a common configuration for the palm chain. + +## Description + +Chain ID: 11297108109 +Chain Name: Palm +Default Block Explorer: https://palm.chainlens.com +Default RPC URL: https://palm-mainnet.public.blastapi.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { palm } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: palm, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/palm.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/palm.js#L26) diff --git a/packages/common/docs/variables/palmTestnet.md b/packages/common/docs/variables/palmTestnet.md new file mode 100644 index 0000000000..23a3023520 --- /dev/null +++ b/packages/common/docs/variables/palmTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / palmTestnet + +# Variable: palmTestnet + +> `const` **palmTestnet**: `object` + +Creates a common configuration for the palmTestnet chain. + +## Description + +Chain ID: 11297108099 +Chain Name: Palm Testnet +Default Block Explorer: https://palm.chainlens.com +Default RPC URL: https://palm-mainnet.public.blastapi.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { palmTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: palmTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/palmTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/palmTestnet.js#L26) diff --git a/packages/common/docs/variables/pgn.md b/packages/common/docs/variables/pgn.md new file mode 100644 index 0000000000..6d599984b8 --- /dev/null +++ b/packages/common/docs/variables/pgn.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / pgn + +# Variable: pgn + +> `const` **pgn**: `object` + +Creates a common configuration for the pgn chain. + +## Description + +Chain ID: 424 +Chain Name: PGN +Default Block Explorer: https://explorer.publicgoods.network +Default RPC URL: https://rpc.publicgoods.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { pgn } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: pgn, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/pgn.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/pgn.js#L26) diff --git a/packages/common/docs/variables/pgnTestnet.md b/packages/common/docs/variables/pgnTestnet.md new file mode 100644 index 0000000000..c1cafa6573 --- /dev/null +++ b/packages/common/docs/variables/pgnTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / pgnTestnet + +# Variable: pgnTestnet + +> `const` **pgnTestnet**: `object` + +Creates a common configuration for the pgnTestnet chain. + +## Description + +Chain ID: 58008 +Chain Name: PGN +Default Block Explorer: https://explorer.sepolia.publicgoods.network +Default RPC URL: https://sepolia.publicgoods.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { pgnTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: pgnTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/pgnTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/pgnTestnet.js#L26) diff --git a/packages/common/docs/variables/phoenix.md b/packages/common/docs/variables/phoenix.md new file mode 100644 index 0000000000..c4f37a7307 --- /dev/null +++ b/packages/common/docs/variables/phoenix.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / phoenix + +# Variable: phoenix + +> `const` **phoenix**: `object` + +Creates a common configuration for the phoenix chain. + +## Description + +Chain ID: 13381 +Chain Name: Phoenix Blockchain +Default Block Explorer: https://phoenixplorer.com +Default RPC URL: https://rpc.phoenixplorer.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { phoenix } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: phoenix, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/phoenix.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/phoenix.js#L26) diff --git a/packages/common/docs/variables/playfiAlbireo.md b/packages/common/docs/variables/playfiAlbireo.md new file mode 100644 index 0000000000..491eb240b3 --- /dev/null +++ b/packages/common/docs/variables/playfiAlbireo.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / playfiAlbireo + +# Variable: playfiAlbireo + +> `const` **playfiAlbireo**: `object` + +Creates a common configuration for the playfiAlbireo chain. + +## Description + +Chain ID: 1612127 +Chain Name: PlayFi Albireo Testnet +Default Block Explorer: https://albireo-explorer.playfi.ai +Default RPC URL: https://albireo-rpc.playfi.ai + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { playfiAlbireo } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: playfiAlbireo, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/playfiAlbireo.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/playfiAlbireo.js#L26) diff --git a/packages/common/docs/variables/plinga.md b/packages/common/docs/variables/plinga.md new file mode 100644 index 0000000000..bf235ba213 --- /dev/null +++ b/packages/common/docs/variables/plinga.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / plinga + +# Variable: plinga + +> `const` **plinga**: `object` + +Creates a common configuration for the plinga chain. + +## Description + +Chain ID: 242 +Chain Name: Plinga +Default Block Explorer: https://www.plgscan.com +Default RPC URL: https://rpcurl.mainnet.plgchain.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { plinga } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: plinga, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/plinga.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/plinga.js#L26) diff --git a/packages/common/docs/variables/plumeTestnet.md b/packages/common/docs/variables/plumeTestnet.md new file mode 100644 index 0000000000..0b5e50f825 --- /dev/null +++ b/packages/common/docs/variables/plumeTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / plumeTestnet + +# Variable: plumeTestnet + +> `const` **plumeTestnet**: `object` + +Creates a common configuration for the plumeTestnet chain. + +## Description + +Chain ID: 161221135 +Chain Name: Plume Testnet +Default Block Explorer: https://testnet-explorer.plumenetwork.xyz +Default RPC URL: https://testnet-rpc.plumenetwork.xyz/http + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { plumeTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: plumeTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/plumeTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/plumeTestnet.js#L26) diff --git a/packages/common/docs/variables/polygonAmoy.md b/packages/common/docs/variables/polygonAmoy.md new file mode 100644 index 0000000000..c1e4561c82 --- /dev/null +++ b/packages/common/docs/variables/polygonAmoy.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / polygonAmoy + +# Variable: polygonAmoy + +> `const` **polygonAmoy**: `object` + +Creates a common configuration for the polygonAmoy chain. + +## Description + +Chain ID: 80002 +Chain Name: Polygon Amoy +Default Block Explorer: https://amoy.polygonscan.com +Default RPC URL: https://rpc-amoy.polygon.technology + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { polygonAmoy } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: polygonAmoy, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/polygonAmoy.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/polygonAmoy.js#L26) diff --git a/packages/common/docs/variables/polygonMumbai.md b/packages/common/docs/variables/polygonMumbai.md new file mode 100644 index 0000000000..4de8059bc7 --- /dev/null +++ b/packages/common/docs/variables/polygonMumbai.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / polygonMumbai + +# Variable: polygonMumbai + +> `const` **polygonMumbai**: `object` + +Creates a common configuration for the polygonMumbai chain. + +## Description + +Chain ID: 80001 +Chain Name: Polygon Mumbai +Default Block Explorer: https://mumbai.polygonscan.com +Default RPC URL: https://rpc.ankr.com/polygon_mumbai + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { polygonMumbai } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: polygonMumbai, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/polygonMumbai.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/polygonMumbai.js#L26) diff --git a/packages/common/docs/variables/polygonZkEvm.md b/packages/common/docs/variables/polygonZkEvm.md new file mode 100644 index 0000000000..4eb5354980 --- /dev/null +++ b/packages/common/docs/variables/polygonZkEvm.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / polygonZkEvm + +# Variable: polygonZkEvm + +> `const` **polygonZkEvm**: `object` + +Creates a common configuration for the polygonZkEvm chain. + +## Description + +Chain ID: 1101 +Chain Name: Polygon zkEVM +Default Block Explorer: https://zkevm.polygonscan.com +Default RPC URL: https://zkevm-rpc.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { polygonZkEvm } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: polygonZkEvm, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/polygonZkEvm.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/polygonZkEvm.js#L26) diff --git a/packages/common/docs/variables/polygonZkEvmCardona.md b/packages/common/docs/variables/polygonZkEvmCardona.md new file mode 100644 index 0000000000..cfa0a3eddb --- /dev/null +++ b/packages/common/docs/variables/polygonZkEvmCardona.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / polygonZkEvmCardona + +# Variable: polygonZkEvmCardona + +> `const` **polygonZkEvmCardona**: `object` + +Creates a common configuration for the polygonZkEvmCardona chain. + +## Description + +Chain ID: 2442 +Chain Name: Polygon zkEVM Cardona +Default Block Explorer: https://cardona-zkevm.polygonscan.com +Default RPC URL: https://rpc.cardona.zkevm-rpc.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { polygonZkEvmCardona } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: polygonZkEvmCardona, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/polygonZkEvmCardona.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/polygonZkEvmCardona.js#L26) diff --git a/packages/common/docs/variables/polygonZkEvmTestnet.md b/packages/common/docs/variables/polygonZkEvmTestnet.md new file mode 100644 index 0000000000..642814e6e8 --- /dev/null +++ b/packages/common/docs/variables/polygonZkEvmTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / polygonZkEvmTestnet + +# Variable: polygonZkEvmTestnet + +> `const` **polygonZkEvmTestnet**: `object` + +Creates a common configuration for the polygonZkEvmTestnet chain. + +## Description + +Chain ID: 1442 +Chain Name: Polygon zkEVM Testnet +Default Block Explorer: https://testnet-zkevm.polygonscan.com +Default RPC URL: https://rpc.public.zkevm-test.net + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { polygonZkEvmTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: polygonZkEvmTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/polygonZkEvmTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/polygonZkEvmTestnet.js#L26) diff --git a/packages/common/docs/variables/pulsechain.md b/packages/common/docs/variables/pulsechain.md new file mode 100644 index 0000000000..0ca6b7ec0f --- /dev/null +++ b/packages/common/docs/variables/pulsechain.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / pulsechain + +# Variable: pulsechain + +> `const` **pulsechain**: `object` + +Creates a common configuration for the pulsechain chain. + +## Description + +Chain ID: 369 +Chain Name: PulseChain +Default Block Explorer: https://scan.pulsechain.com +Default RPC URL: https://rpc.pulsechain.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { pulsechain } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: pulsechain, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/pulsechain.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/pulsechain.js#L26) diff --git a/packages/common/docs/variables/pulsechainV4.md b/packages/common/docs/variables/pulsechainV4.md new file mode 100644 index 0000000000..a2ccaffe67 --- /dev/null +++ b/packages/common/docs/variables/pulsechainV4.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / pulsechainV4 + +# Variable: pulsechainV4 + +> `const` **pulsechainV4**: `object` + +Creates a common configuration for the pulsechainV4 chain. + +## Description + +Chain ID: 943 +Chain Name: PulseChain V4 +Default Block Explorer: https://scan.v4.testnet.pulsechain.com +Default RPC URL: https://rpc.v4.testnet.pulsechain.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { pulsechainV4 } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: pulsechainV4, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/pulsechainV4.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/pulsechainV4.js#L26) diff --git a/packages/common/docs/variables/qMainnet.md b/packages/common/docs/variables/qMainnet.md new file mode 100644 index 0000000000..72da9d6cca --- /dev/null +++ b/packages/common/docs/variables/qMainnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / qMainnet + +# Variable: qMainnet + +> `const` **qMainnet**: `object` + +Creates a common configuration for the qMainnet chain. + +## Description + +Chain ID: 35441 +Chain Name: Q Mainnet +Default Block Explorer: https://explorer.q.org +Default RPC URL: https://rpc.q.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { qMainnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: qMainnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/qMainnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/qMainnet.js#L26) diff --git a/packages/common/docs/variables/qTestnet.md b/packages/common/docs/variables/qTestnet.md new file mode 100644 index 0000000000..fdbd0b4ae3 --- /dev/null +++ b/packages/common/docs/variables/qTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / qTestnet + +# Variable: qTestnet + +> `const` **qTestnet**: `object` + +Creates a common configuration for the qTestnet chain. + +## Description + +Chain ID: 35443 +Chain Name: Q Testnet +Default Block Explorer: https://explorer.qtestnet.org +Default RPC URL: https://rpc.qtestnet.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { qTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: qTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/qTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/qTestnet.js#L26) diff --git a/packages/common/docs/variables/real.md b/packages/common/docs/variables/real.md new file mode 100644 index 0000000000..764d5398f9 --- /dev/null +++ b/packages/common/docs/variables/real.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / real + +# Variable: real + +> `const` **real**: `object` + +Creates a common configuration for the real chain. + +## Description + +Chain ID: 111188 +Chain Name: re.al +Default Block Explorer: https://explorer.re.al +Default RPC URL: https://real.drpc.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { real } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: real, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/real.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/real.js#L26) diff --git a/packages/common/docs/variables/redbellyTestnet.md b/packages/common/docs/variables/redbellyTestnet.md new file mode 100644 index 0000000000..4cf80d8a78 --- /dev/null +++ b/packages/common/docs/variables/redbellyTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / redbellyTestnet + +# Variable: redbellyTestnet + +> `const` **redbellyTestnet**: `object` + +Creates a common configuration for the redbellyTestnet chain. + +## Description + +Chain ID: 153 +Chain Name: Redbelly Network Testnet +Default Block Explorer: https://explorer.testnet.redbelly.network +Default RPC URL: https://governors.testnet.redbelly.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { redbellyTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: redbellyTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/redbellyTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/redbellyTestnet.js#L26) diff --git a/packages/common/docs/variables/reyaNetwork.md b/packages/common/docs/variables/reyaNetwork.md new file mode 100644 index 0000000000..2a4b40b556 --- /dev/null +++ b/packages/common/docs/variables/reyaNetwork.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / reyaNetwork + +# Variable: reyaNetwork + +> `const` **reyaNetwork**: `object` + +Creates a common configuration for the reyaNetwork chain. + +## Description + +Chain ID: 1729 +Chain Name: Reya Network +Default Block Explorer: https://explorer.reya.network +Default RPC URL: https://rpc.reya.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { reyaNetwork } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: reyaNetwork, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/reyaNetwork.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/reyaNetwork.js#L26) diff --git a/packages/common/docs/variables/rollux.md b/packages/common/docs/variables/rollux.md new file mode 100644 index 0000000000..7ef153bec1 --- /dev/null +++ b/packages/common/docs/variables/rollux.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / rollux + +# Variable: rollux + +> `const` **rollux**: `object` + +Creates a common configuration for the rollux chain. + +## Description + +Chain ID: 570 +Chain Name: Rollux Mainnet +Default Block Explorer: https://explorer.rollux.com +Default RPC URL: https://rpc.rollux.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { rollux } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: rollux, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/rollux.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/rollux.js#L26) diff --git a/packages/common/docs/variables/rolluxTestnet.md b/packages/common/docs/variables/rolluxTestnet.md new file mode 100644 index 0000000000..0404af5d46 --- /dev/null +++ b/packages/common/docs/variables/rolluxTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / rolluxTestnet + +# Variable: rolluxTestnet + +> `const` **rolluxTestnet**: `object` + +Creates a common configuration for the rolluxTestnet chain. + +## Description + +Chain ID: 57000 +Chain Name: Rollux Testnet +Default Block Explorer: https://rollux.tanenbaum.io +Default RPC URL: https://rpc-tanenbaum.rollux.com/ + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { rolluxTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: rolluxTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/rolluxTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/rolluxTestnet.js#L26) diff --git a/packages/common/docs/variables/ronin.md b/packages/common/docs/variables/ronin.md new file mode 100644 index 0000000000..c30600339f --- /dev/null +++ b/packages/common/docs/variables/ronin.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / ronin + +# Variable: ronin + +> `const` **ronin**: `object` + +Creates a common configuration for the ronin chain. + +## Description + +Chain ID: 2020 +Chain Name: Ronin +Default Block Explorer: https://app.roninchain.com +Default RPC URL: https://api.roninchain.com/rpc + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { ronin } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: ronin, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/ronin.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/ronin.js#L26) diff --git a/packages/common/docs/variables/root.md b/packages/common/docs/variables/root.md new file mode 100644 index 0000000000..a2e31ea15a --- /dev/null +++ b/packages/common/docs/variables/root.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / root + +# Variable: root + +> `const` **root**: `object` + +Creates a common configuration for the root chain. + +## Description + +Chain ID: 7668 +Chain Name: The Root Network +Default Block Explorer: https://rootscan.io +Default RPC URL: https://root.rootnet.live/archive + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { root } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: root, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/root.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/root.js#L26) diff --git a/packages/common/docs/variables/rootPorcini.md b/packages/common/docs/variables/rootPorcini.md new file mode 100644 index 0000000000..6b9f156096 --- /dev/null +++ b/packages/common/docs/variables/rootPorcini.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / rootPorcini + +# Variable: rootPorcini + +> `const` **rootPorcini**: `object` + +Creates a common configuration for the rootPorcini chain. + +## Description + +Chain ID: 7672 +Chain Name: The Root Network - Porcini +Default Block Explorer: https://porcini.rootscan.io +Default RPC URL: https://porcini.rootnet.app/archive + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { rootPorcini } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: rootPorcini, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/rootPorcini.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/rootPorcini.js#L26) diff --git a/packages/common/docs/variables/rootstock.md b/packages/common/docs/variables/rootstock.md new file mode 100644 index 0000000000..62824357bf --- /dev/null +++ b/packages/common/docs/variables/rootstock.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / rootstock + +# Variable: rootstock + +> `const` **rootstock**: `object` + +Creates a common configuration for the rootstock chain. + +## Description + +Chain ID: 30 +Chain Name: Rootstock Mainnet +Default Block Explorer: https://explorer.rsk.co +Default RPC URL: https://public-node.rsk.co + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { rootstock } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: rootstock, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/rootstock.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/rootstock.js#L26) diff --git a/packages/common/docs/variables/rootstockTestnet.md b/packages/common/docs/variables/rootstockTestnet.md new file mode 100644 index 0000000000..00c63b3fe9 --- /dev/null +++ b/packages/common/docs/variables/rootstockTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / rootstockTestnet + +# Variable: rootstockTestnet + +> `const` **rootstockTestnet**: `object` + +Creates a common configuration for the rootstockTestnet chain. + +## Description + +Chain ID: 31 +Chain Name: Rootstock Testnet +Default Block Explorer: https://explorer.testnet.rootstock.io +Default RPC URL: https://public-node.testnet.rsk.co + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { rootstockTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: rootstockTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/rootstockTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/rootstockTestnet.js#L26) diff --git a/packages/common/docs/variables/rss3.md b/packages/common/docs/variables/rss3.md new file mode 100644 index 0000000000..efa757aff3 --- /dev/null +++ b/packages/common/docs/variables/rss3.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / rss3 + +# Variable: rss3 + +> `const` **rss3**: `object` + +Creates a common configuration for the rss3 chain. + +## Description + +Chain ID: 12553 +Chain Name: RSS3 VSL Mainnet +Default Block Explorer: https://scan.rss3.io +Default RPC URL: https://rpc.rss3.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { rss3 } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: rss3, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/rss3.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/rss3.js#L26) diff --git a/packages/common/docs/variables/rss3Sepolia.md b/packages/common/docs/variables/rss3Sepolia.md new file mode 100644 index 0000000000..c024ded64d --- /dev/null +++ b/packages/common/docs/variables/rss3Sepolia.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / rss3Sepolia + +# Variable: rss3Sepolia + +> `const` **rss3Sepolia**: `object` + +Creates a common configuration for the rss3Sepolia chain. + +## Description + +Chain ID: 2331 +Chain Name: RSS3 VSL Sepolia Testnet +Default Block Explorer: https://scan.testnet.rss3.io +Default RPC URL: https://rpc.testnet.rss3.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { rss3Sepolia } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: rss3Sepolia, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/rss3Sepolia.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/rss3Sepolia.js#L26) diff --git a/packages/common/docs/variables/saigon.md b/packages/common/docs/variables/saigon.md new file mode 100644 index 0000000000..4df3c0b493 --- /dev/null +++ b/packages/common/docs/variables/saigon.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / saigon + +# Variable: saigon + +> `const` **saigon**: `object` + +Creates a common configuration for the saigon chain. + +## Description + +Chain ID: 2021 +Chain Name: Saigon Testnet +Default Block Explorer: https://saigon-app.roninchain.com +Default RPC URL: https://saigon-testnet.roninchain.com/rpc + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { saigon } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: saigon, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/saigon.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/saigon.js#L26) diff --git a/packages/common/docs/variables/sapphire.md b/packages/common/docs/variables/sapphire.md new file mode 100644 index 0000000000..18bf47e23f --- /dev/null +++ b/packages/common/docs/variables/sapphire.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / sapphire + +# Variable: sapphire + +> `const` **sapphire**: `object` + +Creates a common configuration for the sapphire chain. + +## Description + +Chain ID: 23294 +Chain Name: Oasis Sapphire +Default Block Explorer: https://explorer.oasis.io/mainnet/sapphire +Default RPC URL: https://sapphire.oasis.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { sapphire } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: sapphire, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/sapphire.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/sapphire.js#L26) diff --git a/packages/common/docs/variables/sapphireTestnet.md b/packages/common/docs/variables/sapphireTestnet.md new file mode 100644 index 0000000000..32f2558ba1 --- /dev/null +++ b/packages/common/docs/variables/sapphireTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / sapphireTestnet + +# Variable: sapphireTestnet + +> `const` **sapphireTestnet**: `object` + +Creates a common configuration for the sapphireTestnet chain. + +## Description + +Chain ID: 23295 +Chain Name: Oasis Sapphire Testnet +Default Block Explorer: https://explorer.oasis.io/testnet/sapphire +Default RPC URL: https://testnet.sapphire.oasis.dev + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { sapphireTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: sapphireTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/sapphireTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/sapphireTestnet.js#L26) diff --git a/packages/common/docs/variables/satoshiVM.md b/packages/common/docs/variables/satoshiVM.md new file mode 100644 index 0000000000..01a7c71ea7 --- /dev/null +++ b/packages/common/docs/variables/satoshiVM.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / satoshiVM + +# Variable: satoshiVM + +> `const` **satoshiVM**: `object` + +Creates a common configuration for the satoshiVM chain. + +## Description + +Chain ID: 3109 +Chain Name: SatoshiVM Alpha Mainnet +Default Block Explorer: https://svmscan.io +Default RPC URL: https://alpha-rpc-node-http.svmscan.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { satoshiVM } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: satoshiVM, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/satoshiVM.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/satoshiVM.js#L26) diff --git a/packages/common/docs/variables/satoshiVMTestnet.md b/packages/common/docs/variables/satoshiVMTestnet.md new file mode 100644 index 0000000000..cdf97b7ed2 --- /dev/null +++ b/packages/common/docs/variables/satoshiVMTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / satoshiVMTestnet + +# Variable: satoshiVMTestnet + +> `const` **satoshiVMTestnet**: `object` + +Creates a common configuration for the satoshiVMTestnet chain. + +## Description + +Chain ID: 3110 +Chain Name: SatoshiVM Testnet +Default Block Explorer: https://testnet.svmscan.io +Default RPC URL: https://test-rpc-node-http.svmscan.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { satoshiVMTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: satoshiVMTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/satoshiVMTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/satoshiVMTestnet.js#L26) diff --git a/packages/common/docs/variables/scrollSepolia.md b/packages/common/docs/variables/scrollSepolia.md new file mode 100644 index 0000000000..69cd603d89 --- /dev/null +++ b/packages/common/docs/variables/scrollSepolia.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / scrollSepolia + +# Variable: scrollSepolia + +> `const` **scrollSepolia**: `object` + +Creates a common configuration for the scrollSepolia chain. + +## Description + +Chain ID: 534351 +Chain Name: Scroll Sepolia +Default Block Explorer: https://sepolia.scrollscan.com +Default RPC URL: https://sepolia-rpc.scroll.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { scrollSepolia } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: scrollSepolia, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/scrollSepolia.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/scrollSepolia.js#L26) diff --git a/packages/common/docs/variables/sei.md b/packages/common/docs/variables/sei.md new file mode 100644 index 0000000000..ac4653754b --- /dev/null +++ b/packages/common/docs/variables/sei.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / sei + +# Variable: sei + +> `const` **sei**: `object` + +Creates a common configuration for the sei chain. + +## Description + +Chain ID: 1329 +Chain Name: Sei Network +Default Block Explorer: https://seitrace.com +Default RPC URL: https://evm-rpc.sei-apis.com/ + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { sei } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: sei, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/sei.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/sei.js#L26) diff --git a/packages/common/docs/variables/seiDevnet.md b/packages/common/docs/variables/seiDevnet.md new file mode 100644 index 0000000000..09040ece8b --- /dev/null +++ b/packages/common/docs/variables/seiDevnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / seiDevnet + +# Variable: seiDevnet + +> `const` **seiDevnet**: `object` + +Creates a common configuration for the seiDevnet chain. + +## Description + +Chain ID: 713715 +Chain Name: Sei Devnet +Default Block Explorer: https://seitrace.com +Default RPC URL: https://evm-rpc-arctic-1.sei-apis.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { seiDevnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: seiDevnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/seiDevnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/seiDevnet.js#L26) diff --git a/packages/common/docs/variables/seiTestnet.md b/packages/common/docs/variables/seiTestnet.md new file mode 100644 index 0000000000..de2f317651 --- /dev/null +++ b/packages/common/docs/variables/seiTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / seiTestnet + +# Variable: seiTestnet + +> `const` **seiTestnet**: `object` + +Creates a common configuration for the seiTestnet chain. + +## Description + +Chain ID: 1328 +Chain Name: Sei Testnet +Default Block Explorer: https://seitrace.com +Default RPC URL: https://evm-rpc-testnet.sei-apis.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { seiTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: seiTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/seiTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/seiTestnet.js#L26) diff --git a/packages/common/docs/variables/shapeSepolia.md b/packages/common/docs/variables/shapeSepolia.md new file mode 100644 index 0000000000..51ee038572 --- /dev/null +++ b/packages/common/docs/variables/shapeSepolia.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / shapeSepolia + +# Variable: shapeSepolia + +> `const` **shapeSepolia**: `object` + +Creates a common configuration for the shapeSepolia chain. + +## Description + +Chain ID: 11011 +Chain Name: Shape Sepolia Testnet +Default Block Explorer: https://shape-sepolia-explorer.alchemy.com +Default RPC URL: https://sepolia.shape.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { shapeSepolia } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: shapeSepolia, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/shapeSepolia.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/shapeSepolia.js#L26) diff --git a/packages/common/docs/variables/shardeumSphinx.md b/packages/common/docs/variables/shardeumSphinx.md new file mode 100644 index 0000000000..816372fde1 --- /dev/null +++ b/packages/common/docs/variables/shardeumSphinx.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / shardeumSphinx + +# Variable: shardeumSphinx + +> `const` **shardeumSphinx**: `object` + +Creates a common configuration for the shardeumSphinx chain. + +## Description + +Chain ID: 8082 +Chain Name: Shardeum Sphinx +Default Block Explorer: https://explorer-sphinx.shardeum.org +Default RPC URL: https://sphinx.shardeum.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { shardeumSphinx } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: shardeumSphinx, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/shardeumSphinx.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/shardeumSphinx.js#L26) diff --git a/packages/common/docs/variables/shibarium.md b/packages/common/docs/variables/shibarium.md new file mode 100644 index 0000000000..009d2a121d --- /dev/null +++ b/packages/common/docs/variables/shibarium.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / shibarium + +# Variable: shibarium + +> `const` **shibarium**: `object` + +Creates a common configuration for the shibarium chain. + +## Description + +Chain ID: 109 +Chain Name: Shibarium +Default Block Explorer: https://shibariumscan.io +Default RPC URL: https://rpc.shibrpc.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { shibarium } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: shibarium, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/shibarium.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/shibarium.js#L26) diff --git a/packages/common/docs/variables/shibariumTestnet.md b/packages/common/docs/variables/shibariumTestnet.md new file mode 100644 index 0000000000..94c27731d8 --- /dev/null +++ b/packages/common/docs/variables/shibariumTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / shibariumTestnet + +# Variable: shibariumTestnet + +> `const` **shibariumTestnet**: `object` + +Creates a common configuration for the shibariumTestnet chain. + +## Description + +Chain ID: 157 +Chain Name: Puppynet Shibarium +Default Block Explorer: https://puppyscan.shib.io +Default RPC URL: https://puppynet.shibrpc.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { shibariumTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: shibariumTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/shibariumTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/shibariumTestnet.js#L26) diff --git a/packages/common/docs/variables/shimmer.md b/packages/common/docs/variables/shimmer.md new file mode 100644 index 0000000000..a7160fa99d --- /dev/null +++ b/packages/common/docs/variables/shimmer.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / shimmer + +# Variable: shimmer + +> `const` **shimmer**: `object` + +Creates a common configuration for the shimmer chain. + +## Description + +Chain ID: 148 +Chain Name: Shimmer +Default Block Explorer: https://explorer.evm.shimmer.network +Default RPC URL: https://json-rpc.evm.shimmer.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { shimmer } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: shimmer, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/shimmer.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/shimmer.js#L26) diff --git a/packages/common/docs/variables/shimmerTestnet.md b/packages/common/docs/variables/shimmerTestnet.md new file mode 100644 index 0000000000..03ae3f6088 --- /dev/null +++ b/packages/common/docs/variables/shimmerTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / shimmerTestnet + +# Variable: shimmerTestnet + +> `const` **shimmerTestnet**: `object` + +Creates a common configuration for the shimmerTestnet chain. + +## Description + +Chain ID: 1073 +Chain Name: Shimmer Testnet +Default Block Explorer: https://explorer.evm.testnet.shimmer.network +Default RPC URL: https://json-rpc.evm.testnet.shimmer.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { shimmerTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: shimmerTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/shimmerTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/shimmerTestnet.js#L26) diff --git a/packages/common/docs/variables/skaleBlockBrawlers.md b/packages/common/docs/variables/skaleBlockBrawlers.md new file mode 100644 index 0000000000..ced9e3862e --- /dev/null +++ b/packages/common/docs/variables/skaleBlockBrawlers.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / skaleBlockBrawlers + +# Variable: skaleBlockBrawlers + +> `const` **skaleBlockBrawlers**: `object` + +Creates a common configuration for the skaleBlockBrawlers chain. + +## Description + +Chain ID: 391845894 +Chain Name: SKALE | Block Brawlers +Default Block Explorer: https://frayed-decent-antares.explorer.mainnet.skalenodes.com +Default RPC URL: https://mainnet.skalenodes.com/v1/frayed-decent-antares + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { skaleBlockBrawlers } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: skaleBlockBrawlers, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/skaleBlockBrawlers.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/skaleBlockBrawlers.js#L26) diff --git a/packages/common/docs/variables/skaleCalypso.md b/packages/common/docs/variables/skaleCalypso.md new file mode 100644 index 0000000000..19c5942579 --- /dev/null +++ b/packages/common/docs/variables/skaleCalypso.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / skaleCalypso + +# Variable: skaleCalypso + +> `const` **skaleCalypso**: `object` + +Creates a common configuration for the skaleCalypso chain. + +## Description + +Chain ID: 1564830818 +Chain Name: SKALE | Calypso NFT Hub +Default Block Explorer: https://honorable-steel-rasalhague.explorer.mainnet.skalenodes.com +Default RPC URL: https://mainnet.skalenodes.com/v1/honorable-steel-rasalhague + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { skaleCalypso } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: skaleCalypso, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/skaleCalypso.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/skaleCalypso.js#L26) diff --git a/packages/common/docs/variables/skaleCalypsoTestnet.md b/packages/common/docs/variables/skaleCalypsoTestnet.md new file mode 100644 index 0000000000..056a715b0f --- /dev/null +++ b/packages/common/docs/variables/skaleCalypsoTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / skaleCalypsoTestnet + +# Variable: skaleCalypsoTestnet + +> `const` **skaleCalypsoTestnet**: `object` + +Creates a common configuration for the skaleCalypsoTestnet chain. + +## Description + +Chain ID: 974399131 +Chain Name: SKALE Calypso Testnet +Default Block Explorer: https://giant-half-dual-testnet.explorer.testnet.skalenodes.com +Default RPC URL: https://testnet.skalenodes.com/v1/giant-half-dual-testnet + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { skaleCalypsoTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: skaleCalypsoTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/skaleCalypsoTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/skaleCalypsoTestnet.js#L26) diff --git a/packages/common/docs/variables/skaleCryptoBlades.md b/packages/common/docs/variables/skaleCryptoBlades.md new file mode 100644 index 0000000000..4ffd1ec3f2 --- /dev/null +++ b/packages/common/docs/variables/skaleCryptoBlades.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / skaleCryptoBlades + +# Variable: skaleCryptoBlades + +> `const` **skaleCryptoBlades**: `object` + +Creates a common configuration for the skaleCryptoBlades chain. + +## Description + +Chain ID: 1026062157 +Chain Name: SKALE | CryptoBlades +Default Block Explorer: https://affectionate-immediate-pollux.explorer.mainnet.skalenodes.com +Default RPC URL: https://mainnet.skalenodes.com/v1/affectionate-immediate-pollux + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { skaleCryptoBlades } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: skaleCryptoBlades, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/skaleCryptoBlades.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/skaleCryptoBlades.js#L26) diff --git a/packages/common/docs/variables/skaleCryptoColosseum.md b/packages/common/docs/variables/skaleCryptoColosseum.md new file mode 100644 index 0000000000..c695b68f78 --- /dev/null +++ b/packages/common/docs/variables/skaleCryptoColosseum.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / skaleCryptoColosseum + +# Variable: skaleCryptoColosseum + +> `const` **skaleCryptoColosseum**: `object` + +Creates a common configuration for the skaleCryptoColosseum chain. + +## Description + +Chain ID: 1032942172 +Chain Name: SKALE | Crypto Colosseum +Default Block Explorer: https://haunting-devoted-deneb.explorer.mainnet.skalenodes.com +Default RPC URL: https://mainnet.skalenodes.com/v1/haunting-devoted-deneb + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { skaleCryptoColosseum } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: skaleCryptoColosseum, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/skaleCryptoColosseum.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/skaleCryptoColosseum.js#L26) diff --git a/packages/common/docs/variables/skaleEuropa.md b/packages/common/docs/variables/skaleEuropa.md new file mode 100644 index 0000000000..c4e70cb04a --- /dev/null +++ b/packages/common/docs/variables/skaleEuropa.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / skaleEuropa + +# Variable: skaleEuropa + +> `const` **skaleEuropa**: `object` + +Creates a common configuration for the skaleEuropa chain. + +## Description + +Chain ID: 2046399126 +Chain Name: SKALE | Europa Liquidity Hub +Default Block Explorer: https://elated-tan-skat.explorer.mainnet.skalenodes.com +Default RPC URL: https://mainnet.skalenodes.com/v1/elated-tan-skat + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { skaleEuropa } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: skaleEuropa, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/skaleEuropa.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/skaleEuropa.js#L26) diff --git a/packages/common/docs/variables/skaleEuropaTestnet.md b/packages/common/docs/variables/skaleEuropaTestnet.md new file mode 100644 index 0000000000..73da21b207 --- /dev/null +++ b/packages/common/docs/variables/skaleEuropaTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / skaleEuropaTestnet + +# Variable: skaleEuropaTestnet + +> `const` **skaleEuropaTestnet**: `object` + +Creates a common configuration for the skaleEuropaTestnet chain. + +## Description + +Chain ID: 1444673419 +Chain Name: SKALE Europa Testnet +Default Block Explorer: https://juicy-low-small-testnet.explorer.testnet.skalenodes.com +Default RPC URL: https://testnet.skalenodes.com/v1/juicy-low-small-testnet + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { skaleEuropaTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: skaleEuropaTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/skaleEuropaTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/skaleEuropaTestnet.js#L26) diff --git a/packages/common/docs/variables/skaleExorde.md b/packages/common/docs/variables/skaleExorde.md new file mode 100644 index 0000000000..5eff2ac849 --- /dev/null +++ b/packages/common/docs/variables/skaleExorde.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / skaleExorde + +# Variable: skaleExorde + +> `const` **skaleExorde**: `object` + +Creates a common configuration for the skaleExorde chain. + +## Description + +Chain ID: 2139927552 +Chain Name: SKALE | Exorde +Default Block Explorer: https://light-vast-diphda.explorer.mainnet.skalenodes.com +Default RPC URL: https://mainnet.skalenodes.com/v1/light-vast-diphda + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { skaleExorde } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: skaleExorde, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/skaleExorde.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/skaleExorde.js#L26) diff --git a/packages/common/docs/variables/skaleHumanProtocol.md b/packages/common/docs/variables/skaleHumanProtocol.md new file mode 100644 index 0000000000..fe880f0534 --- /dev/null +++ b/packages/common/docs/variables/skaleHumanProtocol.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / skaleHumanProtocol + +# Variable: skaleHumanProtocol + +> `const` **skaleHumanProtocol**: `object` + +Creates a common configuration for the skaleHumanProtocol chain. + +## Description + +Chain ID: 1273227453 +Chain Name: SKALE | Human Protocol +Default Block Explorer: https://wan-red-ain.explorer.mainnet.skalenodes.com +Default RPC URL: https://mainnet.skalenodes.com/v1/wan-red-ain + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { skaleHumanProtocol } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: skaleHumanProtocol, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/skaleHumanProtocol.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/skaleHumanProtocol.js#L26) diff --git a/packages/common/docs/variables/skaleNebula.md b/packages/common/docs/variables/skaleNebula.md new file mode 100644 index 0000000000..e026abd6c6 --- /dev/null +++ b/packages/common/docs/variables/skaleNebula.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / skaleNebula + +# Variable: skaleNebula + +> `const` **skaleNebula**: `object` + +Creates a common configuration for the skaleNebula chain. + +## Description + +Chain ID: 1482601649 +Chain Name: SKALE | Nebula Gaming Hub +Default Block Explorer: https://green-giddy-denebola.explorer.mainnet.skalenodes.com +Default RPC URL: https://mainnet.skalenodes.com/v1/green-giddy-denebola + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { skaleNebula } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: skaleNebula, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/skaleNebula.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/skaleNebula.js#L26) diff --git a/packages/common/docs/variables/skaleNebulaTestnet.md b/packages/common/docs/variables/skaleNebulaTestnet.md new file mode 100644 index 0000000000..a5a84c6ad8 --- /dev/null +++ b/packages/common/docs/variables/skaleNebulaTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / skaleNebulaTestnet + +# Variable: skaleNebulaTestnet + +> `const` **skaleNebulaTestnet**: `object` + +Creates a common configuration for the skaleNebulaTestnet chain. + +## Description + +Chain ID: 37084624 +Chain Name: SKALE Nebula Testnet +Default Block Explorer: https://lanky-ill-funny-testnet.explorer.testnet.skalenodes.com +Default RPC URL: https://testnet.skalenodes.com/v1/lanky-ill-funny-testnet + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { skaleNebulaTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: skaleNebulaTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/skaleNebulaTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/skaleNebulaTestnet.js#L26) diff --git a/packages/common/docs/variables/skaleRazor.md b/packages/common/docs/variables/skaleRazor.md new file mode 100644 index 0000000000..1ee94f4487 --- /dev/null +++ b/packages/common/docs/variables/skaleRazor.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / skaleRazor + +# Variable: skaleRazor + +> `const` **skaleRazor**: `object` + +Creates a common configuration for the skaleRazor chain. + +## Description + +Chain ID: 278611351 +Chain Name: SKALE | Razor Network +Default Block Explorer: https://turbulent-unique-scheat.explorer.mainnet.skalenodes.com +Default RPC URL: https://mainnet.skalenodes.com/v1/turbulent-unique-scheat + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { skaleRazor } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: skaleRazor, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/skaleRazor.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/skaleRazor.js#L26) diff --git a/packages/common/docs/variables/skaleTitan.md b/packages/common/docs/variables/skaleTitan.md new file mode 100644 index 0000000000..e55520d3e4 --- /dev/null +++ b/packages/common/docs/variables/skaleTitan.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / skaleTitan + +# Variable: skaleTitan + +> `const` **skaleTitan**: `object` + +Creates a common configuration for the skaleTitan chain. + +## Description + +Chain ID: 1350216234 +Chain Name: SKALE | Titan Community Hub +Default Block Explorer: https://parallel-stormy-spica.explorer.mainnet.skalenodes.com +Default RPC URL: https://mainnet.skalenodes.com/v1/parallel-stormy-spica + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { skaleTitan } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: skaleTitan, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/skaleTitan.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/skaleTitan.js#L26) diff --git a/packages/common/docs/variables/skaleTitanTestnet.md b/packages/common/docs/variables/skaleTitanTestnet.md new file mode 100644 index 0000000000..d498bc4272 --- /dev/null +++ b/packages/common/docs/variables/skaleTitanTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / skaleTitanTestnet + +# Variable: skaleTitanTestnet + +> `const` **skaleTitanTestnet**: `object` + +Creates a common configuration for the skaleTitanTestnet chain. + +## Description + +Chain ID: 1020352220 +Chain Name: SKALE Titan Hub +Default Block Explorer: https://aware-fake-trim-testnet.explorer.testnet.skalenodes.com +Default RPC URL: https://testnet.skalenodes.com/v1/aware-fake-trim-testnet + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { skaleTitanTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: skaleTitanTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/skaleTitanTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/skaleTitanTestnet.js#L26) diff --git a/packages/common/docs/variables/sketchpad.md b/packages/common/docs/variables/sketchpad.md new file mode 100644 index 0000000000..b899e040ad --- /dev/null +++ b/packages/common/docs/variables/sketchpad.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / sketchpad + +# Variable: sketchpad + +> `const` **sketchpad**: `object` + +Creates a common configuration for the sketchpad chain. + +## Description + +Chain ID: 984123 +Chain Name: Forma Sketchpad +Default Block Explorer: https://explorer.sketchpad-1.forma.art +Default RPC URL: https://rpc.sketchpad-1.forma.art + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { sketchpad } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: sketchpad, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/sketchpad.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/sketchpad.js#L26) diff --git a/packages/common/docs/variables/soneiumMinato.md b/packages/common/docs/variables/soneiumMinato.md new file mode 100644 index 0000000000..7369300506 --- /dev/null +++ b/packages/common/docs/variables/soneiumMinato.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / soneiumMinato + +# Variable: soneiumMinato + +> `const` **soneiumMinato**: `object` + +Creates a common configuration for the soneiumMinato chain. + +## Description + +Chain ID: 1946 +Chain Name: Soneium Minato +Default Block Explorer: https://explorer-testnet.soneium.org +Default RPC URL: https://rpc.minato.soneium.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { soneiumMinato } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: soneiumMinato, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/soneiumMinato.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/soneiumMinato.js#L26) diff --git a/packages/common/docs/variables/songbird.md b/packages/common/docs/variables/songbird.md new file mode 100644 index 0000000000..a95a256000 --- /dev/null +++ b/packages/common/docs/variables/songbird.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / songbird + +# Variable: songbird + +> `const` **songbird**: `object` + +Creates a common configuration for the songbird chain. + +## Description + +Chain ID: 19 +Chain Name: Songbird Mainnet +Default Block Explorer: https://songbird-explorer.flare.network +Default RPC URL: https://songbird-api.flare.network/ext/C/rpc + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { songbird } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: songbird, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/songbird.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/songbird.js#L26) diff --git a/packages/common/docs/variables/songbirdTestnet.md b/packages/common/docs/variables/songbirdTestnet.md new file mode 100644 index 0000000000..d0ba65b22a --- /dev/null +++ b/packages/common/docs/variables/songbirdTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / songbirdTestnet + +# Variable: songbirdTestnet + +> `const` **songbirdTestnet**: `object` + +Creates a common configuration for the songbirdTestnet chain. + +## Description + +Chain ID: 16 +Chain Name: Coston +Default Block Explorer: https://coston-explorer.flare.network +Default RPC URL: https://coston-api.flare.network/ext/C/rpc + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { songbirdTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: songbirdTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/songbirdTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/songbirdTestnet.js#L26) diff --git a/packages/common/docs/variables/sophonTestnet.md b/packages/common/docs/variables/sophonTestnet.md new file mode 100644 index 0000000000..e34c5eb6f4 --- /dev/null +++ b/packages/common/docs/variables/sophonTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / sophonTestnet + +# Variable: sophonTestnet + +> `const` **sophonTestnet**: `object` + +Creates a common configuration for the sophonTestnet chain. + +## Description + +Chain ID: 531050104 +Chain Name: Sophon Testnet +Default Block Explorer: https://explorer.testnet.sophon.xyz +Default RPC URL: https://rpc.testnet.sophon.xyz + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { sophonTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: sophonTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/sophonTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/sophonTestnet.js#L26) diff --git a/packages/common/docs/variables/spicy.md b/packages/common/docs/variables/spicy.md new file mode 100644 index 0000000000..7e38022e37 --- /dev/null +++ b/packages/common/docs/variables/spicy.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / spicy + +# Variable: spicy + +> `const` **spicy**: `object` + +Creates a common configuration for the spicy chain. + +## Description + +Chain ID: 88882 +Chain Name: Chiliz Spicy Testnet +Default Block Explorer: http://spicy-explorer.chiliz.com +Default RPC URL: https://spicy-rpc.chiliz.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { spicy } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: spicy, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/spicy.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/spicy.js#L26) diff --git a/packages/common/docs/variables/storyTestnet.md b/packages/common/docs/variables/storyTestnet.md new file mode 100644 index 0000000000..56cf04a769 --- /dev/null +++ b/packages/common/docs/variables/storyTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / storyTestnet + +# Variable: storyTestnet + +> `const` **storyTestnet**: `object` + +Creates a common configuration for the storyTestnet chain. + +## Description + +Chain ID: 1513 +Chain Name: Story Testnet +Default Block Explorer: https://testnet.storyscan.xyz +Default RPC URL: https://testnet.storyrpc.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { storyTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: storyTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/storyTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/storyTestnet.js#L26) diff --git a/packages/common/docs/variables/stratis.md b/packages/common/docs/variables/stratis.md new file mode 100644 index 0000000000..8204cc540f --- /dev/null +++ b/packages/common/docs/variables/stratis.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / stratis + +# Variable: stratis + +> `const` **stratis**: `object` + +Creates a common configuration for the stratis chain. + +## Description + +Chain ID: 105105 +Chain Name: Stratis Mainnet +Default Block Explorer: https://explorer.stratisevm.com +Default RPC URL: https://rpc.stratisevm.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { stratis } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: stratis, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/stratis.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/stratis.js#L26) diff --git a/packages/common/docs/variables/syscoin.md b/packages/common/docs/variables/syscoin.md new file mode 100644 index 0000000000..5b4e6aa5bd --- /dev/null +++ b/packages/common/docs/variables/syscoin.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / syscoin + +# Variable: syscoin + +> `const` **syscoin**: `object` + +Creates a common configuration for the syscoin chain. + +## Description + +Chain ID: 57 +Chain Name: Syscoin Mainnet +Default Block Explorer: https://explorer.syscoin.org +Default RPC URL: https://rpc.syscoin.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { syscoin } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: syscoin, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/syscoin.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/syscoin.js#L26) diff --git a/packages/common/docs/variables/syscoinTestnet.md b/packages/common/docs/variables/syscoinTestnet.md new file mode 100644 index 0000000000..8acd185841 --- /dev/null +++ b/packages/common/docs/variables/syscoinTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / syscoinTestnet + +# Variable: syscoinTestnet + +> `const` **syscoinTestnet**: `object` + +Creates a common configuration for the syscoinTestnet chain. + +## Description + +Chain ID: 5700 +Chain Name: Syscoin Tanenbaum Testnet +Default Block Explorer: https://tanenbaum.io +Default RPC URL: https://rpc.tanenbaum.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { syscoinTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: syscoinTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/syscoinTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/syscoinTestnet.js#L26) diff --git a/packages/common/docs/variables/taiko.md b/packages/common/docs/variables/taiko.md new file mode 100644 index 0000000000..14b69d9936 --- /dev/null +++ b/packages/common/docs/variables/taiko.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / taiko + +# Variable: taiko + +> `const` **taiko**: `object` + +Creates a common configuration for the taiko chain. + +## Description + +Chain ID: 167000 +Chain Name: Taiko Mainnet +Default Block Explorer: https://taikoscan.io +Default RPC URL: https://rpc.mainnet.taiko.xyz + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { taiko } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: taiko, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/taiko.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/taiko.js#L26) diff --git a/packages/common/docs/variables/taikoHekla.md b/packages/common/docs/variables/taikoHekla.md new file mode 100644 index 0000000000..d9dab55c29 --- /dev/null +++ b/packages/common/docs/variables/taikoHekla.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / taikoHekla + +# Variable: taikoHekla + +> `const` **taikoHekla**: `object` + +Creates a common configuration for the taikoHekla chain. + +## Description + +Chain ID: 167009 +Chain Name: Taiko Hekla L2 +Default Block Explorer: https://hekla.taikoscan.network +Default RPC URL: https://rpc.hekla.taiko.xyz + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { taikoHekla } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: taikoHekla, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/taikoHekla.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/taikoHekla.js#L26) diff --git a/packages/common/docs/variables/taikoJolnir.md b/packages/common/docs/variables/taikoJolnir.md new file mode 100644 index 0000000000..5fcdbb3123 --- /dev/null +++ b/packages/common/docs/variables/taikoJolnir.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / taikoJolnir + +# Variable: taikoJolnir + +> `const` **taikoJolnir**: `object` + +Creates a common configuration for the taikoJolnir chain. + +## Description + +Chain ID: 167007 +Chain Name: Taiko Jolnir (Alpha-5 Testnet) +Default Block Explorer: https://explorer.jolnir.taiko.xyz +Default RPC URL: https://rpc.jolnir.taiko.xyz + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { taikoJolnir } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: taikoJolnir, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/taikoJolnir.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/taikoJolnir.js#L26) diff --git a/packages/common/docs/variables/taikoKatla.md b/packages/common/docs/variables/taikoKatla.md new file mode 100644 index 0000000000..505c499395 --- /dev/null +++ b/packages/common/docs/variables/taikoKatla.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / taikoKatla + +# Variable: taikoKatla + +> `const` **taikoKatla**: `object` + +Creates a common configuration for the taikoKatla chain. + +## Description + +Chain ID: 167008 +Chain Name: Taiko Katla (Alpha-6 Testnet) +Default Block Explorer: https://explorer.katla.taiko.xyz +Default RPC URL: https://rpc.katla.taiko.xyz + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { taikoKatla } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: taikoKatla, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/taikoKatla.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/taikoKatla.js#L26) diff --git a/packages/common/docs/variables/taikoTestnetSepolia.md b/packages/common/docs/variables/taikoTestnetSepolia.md new file mode 100644 index 0000000000..0b4d4dae6b --- /dev/null +++ b/packages/common/docs/variables/taikoTestnetSepolia.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / taikoTestnetSepolia + +# Variable: taikoTestnetSepolia + +> `const` **taikoTestnetSepolia**: `object` + +Creates a common configuration for the taikoTestnetSepolia chain. + +## Description + +Chain ID: 167005 +Chain Name: Taiko (Alpha-3 Testnet) +Default Block Explorer: https://explorer.test.taiko.xyz +Default RPC URL: https://rpc.test.taiko.xyz + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { taikoTestnetSepolia } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: taikoTestnetSepolia, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/taikoTestnetSepolia.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/taikoTestnetSepolia.js#L26) diff --git a/packages/common/docs/variables/taraxa.md b/packages/common/docs/variables/taraxa.md new file mode 100644 index 0000000000..f3f0b5b52f --- /dev/null +++ b/packages/common/docs/variables/taraxa.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / taraxa + +# Variable: taraxa + +> `const` **taraxa**: `object` + +Creates a common configuration for the taraxa chain. + +## Description + +Chain ID: 841 +Chain Name: Taraxa Mainnet +Default Block Explorer: https://explorer.mainnet.taraxa.io +Default RPC URL: https://rpc.mainnet.taraxa.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { taraxa } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: taraxa, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/taraxa.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/taraxa.js#L26) diff --git a/packages/common/docs/variables/taraxaTestnet.md b/packages/common/docs/variables/taraxaTestnet.md new file mode 100644 index 0000000000..67bcac3b19 --- /dev/null +++ b/packages/common/docs/variables/taraxaTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / taraxaTestnet + +# Variable: taraxaTestnet + +> `const` **taraxaTestnet**: `object` + +Creates a common configuration for the taraxaTestnet chain. + +## Description + +Chain ID: 842 +Chain Name: Taraxa Testnet +Default Block Explorer: https://explorer.testnet.taraxa.io +Default RPC URL: https://rpc.testnet.taraxa.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { taraxaTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: taraxaTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/taraxaTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/taraxaTestnet.js#L26) diff --git a/packages/common/docs/variables/telcoinTestnet.md b/packages/common/docs/variables/telcoinTestnet.md new file mode 100644 index 0000000000..3086b44f14 --- /dev/null +++ b/packages/common/docs/variables/telcoinTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / telcoinTestnet + +# Variable: telcoinTestnet + +> `const` **telcoinTestnet**: `object` + +Creates a common configuration for the telcoinTestnet chain. + +## Description + +Chain ID: 2017 +Chain Name: Telcoin Adiri Testnet +Default Block Explorer: https://telscan.io +Default RPC URL: https://rpc.telcoin.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { telcoinTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: telcoinTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/telcoinTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/telcoinTestnet.js#L26) diff --git a/packages/common/docs/variables/telos.md b/packages/common/docs/variables/telos.md new file mode 100644 index 0000000000..e0fc1f1d48 --- /dev/null +++ b/packages/common/docs/variables/telos.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / telos + +# Variable: telos + +> `const` **telos**: `object` + +Creates a common configuration for the telos chain. + +## Description + +Chain ID: 40 +Chain Name: Telos +Default Block Explorer: https://www.teloscan.io/ +Default RPC URL: https://mainnet.telos.net/evm + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { telos } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: telos, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/telos.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/telos.js#L26) diff --git a/packages/common/docs/variables/telosTestnet.md b/packages/common/docs/variables/telosTestnet.md new file mode 100644 index 0000000000..26cf103d0c --- /dev/null +++ b/packages/common/docs/variables/telosTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / telosTestnet + +# Variable: telosTestnet + +> `const` **telosTestnet**: `object` + +Creates a common configuration for the telosTestnet chain. + +## Description + +Chain ID: 41 +Chain Name: Telos +Default Block Explorer: https://testnet.teloscan.io/ +Default RPC URL: https://testnet.telos.net/evm + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { telosTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: telosTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/telosTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/telosTestnet.js#L26) diff --git a/packages/common/docs/variables/tenet.md b/packages/common/docs/variables/tenet.md new file mode 100644 index 0000000000..01987a94b5 --- /dev/null +++ b/packages/common/docs/variables/tenet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / tenet + +# Variable: tenet + +> `const` **tenet**: `object` + +Creates a common configuration for the tenet chain. + +## Description + +Chain ID: 1559 +Chain Name: Tenet +Default Block Explorer: https://tenetscan.io +Default RPC URL: https://rpc.tenet.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { tenet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: tenet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/tenet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/tenet.js#L26) diff --git a/packages/common/docs/variables/thaiChain.md b/packages/common/docs/variables/thaiChain.md new file mode 100644 index 0000000000..87d76d4f2a --- /dev/null +++ b/packages/common/docs/variables/thaiChain.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / thaiChain + +# Variable: thaiChain + +> `const` **thaiChain**: `object` + +Creates a common configuration for the thaiChain chain. + +## Description + +Chain ID: 7 +Chain Name: ThaiChain +Default Block Explorer: https://exp.thaichain.org +Default RPC URL: https://rpc.thaichain.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { thaiChain } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: thaiChain, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/thaiChain.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/thaiChain.js#L26) diff --git a/packages/common/docs/variables/thunderTestnet.md b/packages/common/docs/variables/thunderTestnet.md new file mode 100644 index 0000000000..4e62628723 --- /dev/null +++ b/packages/common/docs/variables/thunderTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / thunderTestnet + +# Variable: thunderTestnet + +> `const` **thunderTestnet**: `object` + +Creates a common configuration for the thunderTestnet chain. + +## Description + +Chain ID: 997 +Chain Name: 5ireChain Thunder Testnet +Default Block Explorer: https://explorer.5ire.network +Default RPC URL: https://rpc-testnet.5ire.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { thunderTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: thunderTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/thunderTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/thunderTestnet.js#L26) diff --git a/packages/common/docs/variables/tron.md b/packages/common/docs/variables/tron.md new file mode 100644 index 0000000000..dedf120d8d --- /dev/null +++ b/packages/common/docs/variables/tron.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / tron + +# Variable: tron + +> `const` **tron**: `object` + +Creates a common configuration for the tron chain. + +## Description + +Chain ID: 728126428 +Chain Name: Tron +Default Block Explorer: https://tronscan.org +Default RPC URL: https://api.trongrid.io/jsonrpc + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { tron } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: tron, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/tron.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/tron.js#L26) diff --git a/packages/common/docs/variables/unreal.md b/packages/common/docs/variables/unreal.md new file mode 100644 index 0000000000..a20e6c39f9 --- /dev/null +++ b/packages/common/docs/variables/unreal.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / unreal + +# Variable: unreal + +> `const` **unreal**: `object` + +Creates a common configuration for the unreal chain. + +## Description + +Chain ID: 18233 +Chain Name: Unreal +Default Block Explorer: https://unreal.blockscout.com +Default RPC URL: https://rpc.unreal-orbit.gelato.digital + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { unreal } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: unreal, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/unreal.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/unreal.js#L26) diff --git a/packages/common/docs/variables/vechain.md b/packages/common/docs/variables/vechain.md new file mode 100644 index 0000000000..7fc92ab69c --- /dev/null +++ b/packages/common/docs/variables/vechain.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / vechain + +# Variable: vechain + +> `const` **vechain**: `object` + +Creates a common configuration for the vechain chain. + +## Description + +Chain ID: 100009 +Chain Name: Vechain +Default Block Explorer: https://explore.vechain.org +Default RPC URL: https://mainnet.vechain.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { vechain } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: vechain, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/vechain.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/vechain.js#L26) diff --git a/packages/common/docs/variables/wanchain.md b/packages/common/docs/variables/wanchain.md new file mode 100644 index 0000000000..8e899ae8b2 --- /dev/null +++ b/packages/common/docs/variables/wanchain.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / wanchain + +# Variable: wanchain + +> `const` **wanchain**: `object` + +Creates a common configuration for the wanchain chain. + +## Description + +Chain ID: 888 +Chain Name: Wanchain +Default Block Explorer: https://wanscan.org +Default RPC URL: https://gwan-ssl.wandevs.org:56891 + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { wanchain } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: wanchain, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/wanchain.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/wanchain.js#L26) diff --git a/packages/common/docs/variables/wanchainTestnet.md b/packages/common/docs/variables/wanchainTestnet.md new file mode 100644 index 0000000000..650c7f7698 --- /dev/null +++ b/packages/common/docs/variables/wanchainTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / wanchainTestnet + +# Variable: wanchainTestnet + +> `const` **wanchainTestnet**: `object` + +Creates a common configuration for the wanchainTestnet chain. + +## Description + +Chain ID: 999 +Chain Name: Wanchain Testnet +Default Block Explorer: https://wanscan.org +Default RPC URL: https://gwan-ssl.wandevs.org:46891 + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { wanchainTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: wanchainTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/wanchainTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/wanchainTestnet.js#L26) diff --git a/packages/common/docs/variables/wemix.md b/packages/common/docs/variables/wemix.md new file mode 100644 index 0000000000..7a55ae0c89 --- /dev/null +++ b/packages/common/docs/variables/wemix.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / wemix + +# Variable: wemix + +> `const` **wemix**: `object` + +Creates a common configuration for the wemix chain. + +## Description + +Chain ID: 1111 +Chain Name: WEMIX +Default Block Explorer: https://explorer.wemix.com +Default RPC URL: https://api.wemix.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { wemix } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: wemix, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/wemix.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/wemix.js#L26) diff --git a/packages/common/docs/variables/wemixTestnet.md b/packages/common/docs/variables/wemixTestnet.md new file mode 100644 index 0000000000..96ee005e99 --- /dev/null +++ b/packages/common/docs/variables/wemixTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / wemixTestnet + +# Variable: wemixTestnet + +> `const` **wemixTestnet**: `object` + +Creates a common configuration for the wemixTestnet chain. + +## Description + +Chain ID: 1112 +Chain Name: WEMIX Testnet +Default Block Explorer: https://testnet.wemixscan.com +Default RPC URL: https://api.test.wemix.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { wemixTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: wemixTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/wemixTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/wemixTestnet.js#L26) diff --git a/packages/common/docs/variables/x1Testnet.md b/packages/common/docs/variables/x1Testnet.md new file mode 100644 index 0000000000..1a4300c237 --- /dev/null +++ b/packages/common/docs/variables/x1Testnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / x1Testnet + +# Variable: x1Testnet + +> `const` **x1Testnet**: `object` + +Creates a common configuration for the x1Testnet chain. + +## Description + +Chain ID: 195 +Chain Name: X1 Testnet +Default Block Explorer: https://www.oklink.com/xlayer-test +Default RPC URL: https://xlayertestrpc.okx.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { x1Testnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: x1Testnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/x1Testnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/x1Testnet.js#L26) diff --git a/packages/common/docs/variables/xLayer.md b/packages/common/docs/variables/xLayer.md new file mode 100644 index 0000000000..11a71bf2d6 --- /dev/null +++ b/packages/common/docs/variables/xLayer.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / xLayer + +# Variable: xLayer + +> `const` **xLayer**: `object` + +Creates a common configuration for the xLayer chain. + +## Description + +Chain ID: 196 +Chain Name: X Layer Mainnet +Default Block Explorer: https://www.oklink.com/xlayer +Default RPC URL: https://rpc.xlayer.tech + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { xLayer } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: xLayer, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/xLayer.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/xLayer.js#L26) diff --git a/packages/common/docs/variables/xLayerTestnet.md b/packages/common/docs/variables/xLayerTestnet.md new file mode 100644 index 0000000000..1811399e74 --- /dev/null +++ b/packages/common/docs/variables/xLayerTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / xLayerTestnet + +# Variable: xLayerTestnet + +> `const` **xLayerTestnet**: `object` + +Creates a common configuration for the xLayerTestnet chain. + +## Description + +Chain ID: 195 +Chain Name: X1 Testnet +Default Block Explorer: https://www.oklink.com/xlayer-test +Default RPC URL: https://xlayertestrpc.okx.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { xLayerTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: xLayerTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/xLayerTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/xLayerTestnet.js#L26) diff --git a/packages/common/docs/variables/xai.md b/packages/common/docs/variables/xai.md new file mode 100644 index 0000000000..b35aa963a7 --- /dev/null +++ b/packages/common/docs/variables/xai.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / xai + +# Variable: xai + +> `const` **xai**: `object` + +Creates a common configuration for the xai chain. + +## Description + +Chain ID: 660279 +Chain Name: Xai Mainnet +Default Block Explorer: https://explorer.xai-chain.net +Default RPC URL: https://xai-chain.net/rpc + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { xai } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: xai, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/xai.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/xai.js#L26) diff --git a/packages/common/docs/variables/xaiTestnet.md b/packages/common/docs/variables/xaiTestnet.md new file mode 100644 index 0000000000..e2227097b5 --- /dev/null +++ b/packages/common/docs/variables/xaiTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / xaiTestnet + +# Variable: xaiTestnet + +> `const` **xaiTestnet**: `object` + +Creates a common configuration for the xaiTestnet chain. + +## Description + +Chain ID: 37714555429 +Chain Name: Xai Testnet +Default Block Explorer: https://testnet-explorer-v2.xai-chain.net +Default RPC URL: https://testnet-v2.xai-chain.net/rpc + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { xaiTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: xaiTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/xaiTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/xaiTestnet.js#L26) diff --git a/packages/common/docs/variables/xdc.md b/packages/common/docs/variables/xdc.md new file mode 100644 index 0000000000..bd19a98011 --- /dev/null +++ b/packages/common/docs/variables/xdc.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / xdc + +# Variable: xdc + +> `const` **xdc**: `object` + +Creates a common configuration for the xdc chain. + +## Description + +Chain ID: 50 +Chain Name: XinFin Network +Default Block Explorer: https://xdc.blocksscan.io +Default RPC URL: https://rpc.xinfin.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { xdc } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: xdc, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/xdc.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/xdc.js#L26) diff --git a/packages/common/docs/variables/xdcTestnet.md b/packages/common/docs/variables/xdcTestnet.md new file mode 100644 index 0000000000..8f8fc03ae8 --- /dev/null +++ b/packages/common/docs/variables/xdcTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / xdcTestnet + +# Variable: xdcTestnet + +> `const` **xdcTestnet**: `object` + +Creates a common configuration for the xdcTestnet chain. + +## Description + +Chain ID: 51 +Chain Name: Apothem Network +Default Block Explorer: https://apothem.blocksscan.io +Default RPC URL: https://erpc.apothem.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { xdcTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: xdcTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/xdcTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/xdcTestnet.js#L26) diff --git a/packages/common/docs/variables/xrSepolia.md b/packages/common/docs/variables/xrSepolia.md new file mode 100644 index 0000000000..17d8fab6a0 --- /dev/null +++ b/packages/common/docs/variables/xrSepolia.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / xrSepolia + +# Variable: xrSepolia + +> `const` **xrSepolia**: `object` + +Creates a common configuration for the xrSepolia chain. + +## Description + +Chain ID: 2730 +Chain Name: XR Sepolia +Default Block Explorer: https://xr-sepolia-testnet.explorer.caldera.xyz +Default RPC URL: https://xr-sepolia-testnet.rpc.caldera.xyz/http + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { xrSepolia } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: xrSepolia, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/xrSepolia.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/xrSepolia.js#L26) diff --git a/packages/common/docs/variables/yooldoVerse.md b/packages/common/docs/variables/yooldoVerse.md new file mode 100644 index 0000000000..760c6eb65b --- /dev/null +++ b/packages/common/docs/variables/yooldoVerse.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / yooldoVerse + +# Variable: yooldoVerse + +> `const` **yooldoVerse**: `object` + +Creates a common configuration for the yooldoVerse chain. + +## Description + +Chain ID: 50005 +Chain Name: Yooldo Verse +Default Block Explorer: https://explorer.yooldo-verse.xyz +Default RPC URL: https://rpc.yooldo-verse.xyz + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { yooldoVerse } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: yooldoVerse, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/yooldoVerse.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/yooldoVerse.js#L26) diff --git a/packages/common/docs/variables/yooldoVerseTestnet.md b/packages/common/docs/variables/yooldoVerseTestnet.md new file mode 100644 index 0000000000..90e31d00b3 --- /dev/null +++ b/packages/common/docs/variables/yooldoVerseTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / yooldoVerseTestnet + +# Variable: yooldoVerseTestnet + +> `const` **yooldoVerseTestnet**: `object` + +Creates a common configuration for the yooldoVerseTestnet chain. + +## Description + +Chain ID: 50006 +Chain Name: Yooldo Verse Testnet +Default Block Explorer: https://explorer.testnet.yooldo-verse.xyz +Default RPC URL: https://rpc.testnet.yooldo-verse.xyz + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { yooldoVerseTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: yooldoVerseTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/yooldoVerseTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/yooldoVerseTestnet.js#L26) diff --git a/packages/common/docs/variables/zetachain.md b/packages/common/docs/variables/zetachain.md new file mode 100644 index 0000000000..fdab8f4eb6 --- /dev/null +++ b/packages/common/docs/variables/zetachain.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / zetachain + +# Variable: zetachain + +> `const` **zetachain**: `object` + +Creates a common configuration for the zetachain chain. + +## Description + +Chain ID: 7000 +Chain Name: ZetaChain +Default Block Explorer: https://explorer.zetachain.com +Default RPC URL: https://zetachain-evm.blockpi.network/v1/rpc/public + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { zetachain } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: zetachain, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/zetachain.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/zetachain.js#L26) diff --git a/packages/common/docs/variables/zetachainAthensTestnet.md b/packages/common/docs/variables/zetachainAthensTestnet.md new file mode 100644 index 0000000000..f68745adce --- /dev/null +++ b/packages/common/docs/variables/zetachainAthensTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / zetachainAthensTestnet + +# Variable: zetachainAthensTestnet + +> `const` **zetachainAthensTestnet**: `object` + +Creates a common configuration for the zetachainAthensTestnet chain. + +## Description + +Chain ID: 7001 +Chain Name: ZetaChain Athens Testnet +Default Block Explorer: https://athens.explorer.zetachain.com +Default RPC URL: https://zetachain-athens-evm.blockpi.network/v1/rpc/public + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { zetachainAthensTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: zetachainAthensTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/zetachainAthensTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/zetachainAthensTestnet.js#L26) diff --git a/packages/common/docs/variables/zhejiang.md b/packages/common/docs/variables/zhejiang.md new file mode 100644 index 0000000000..623c2c7d86 --- /dev/null +++ b/packages/common/docs/variables/zhejiang.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / zhejiang + +# Variable: zhejiang + +> `const` **zhejiang**: `object` + +Creates a common configuration for the zhejiang chain. + +## Description + +Chain ID: 1337803 +Chain Name: Zhejiang +Default Block Explorer: https://zhejiang.beaconcha.in +Default RPC URL: https://rpc.zhejiang.ethpandaops.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { zhejiang } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: zhejiang, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/zhejiang.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/zhejiang.js#L26) diff --git a/packages/common/docs/variables/zilliqa.md b/packages/common/docs/variables/zilliqa.md new file mode 100644 index 0000000000..d6dd090ef0 --- /dev/null +++ b/packages/common/docs/variables/zilliqa.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / zilliqa + +# Variable: zilliqa + +> `const` **zilliqa**: `object` + +Creates a common configuration for the zilliqa chain. + +## Description + +Chain ID: 32769 +Chain Name: Zilliqa +Default Block Explorer: https://evmx.zilliqa.com +Default RPC URL: https://api.zilliqa.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { zilliqa } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: zilliqa, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/zilliqa.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/zilliqa.js#L26) diff --git a/packages/common/docs/variables/zilliqaTestnet.md b/packages/common/docs/variables/zilliqaTestnet.md new file mode 100644 index 0000000000..8bca871fc4 --- /dev/null +++ b/packages/common/docs/variables/zilliqaTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / zilliqaTestnet + +# Variable: zilliqaTestnet + +> `const` **zilliqaTestnet**: `object` + +Creates a common configuration for the zilliqaTestnet chain. + +## Description + +Chain ID: 33101 +Chain Name: Zilliqa Testnet +Default Block Explorer: https://evmx.testnet.zilliqa.com +Default RPC URL: https://dev-api.zilliqa.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { zilliqaTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: zilliqaTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/zilliqaTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/zilliqaTestnet.js#L26) diff --git a/packages/common/docs/variables/zircuitTestnet.md b/packages/common/docs/variables/zircuitTestnet.md new file mode 100644 index 0000000000..02571de39f --- /dev/null +++ b/packages/common/docs/variables/zircuitTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / zircuitTestnet + +# Variable: zircuitTestnet + +> `const` **zircuitTestnet**: `object` + +Creates a common configuration for the zircuitTestnet chain. + +## Description + +Chain ID: 48899 +Chain Name: Zircuit Testnet +Default Block Explorer: https://explorer.zircuit.com +Default RPC URL: https://zircuit1.p2pify.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { zircuitTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: zircuitTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/zircuitTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/zircuitTestnet.js#L26) diff --git a/packages/common/docs/variables/zkFair.md b/packages/common/docs/variables/zkFair.md new file mode 100644 index 0000000000..e7db2acb25 --- /dev/null +++ b/packages/common/docs/variables/zkFair.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / zkFair + +# Variable: zkFair + +> `const` **zkFair**: `object` + +Creates a common configuration for the zkFair chain. + +## Description + +Chain ID: 42766 +Chain Name: ZKFair Mainnet +Default Block Explorer: https://scan.zkfair.io +Default RPC URL: https://rpc.zkfair.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { zkFair } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: zkFair, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/zkFair.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/zkFair.js#L26) diff --git a/packages/common/docs/variables/zkFairTestnet.md b/packages/common/docs/variables/zkFairTestnet.md new file mode 100644 index 0000000000..ee776d38f9 --- /dev/null +++ b/packages/common/docs/variables/zkFairTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / zkFairTestnet + +# Variable: zkFairTestnet + +> `const` **zkFairTestnet**: `object` + +Creates a common configuration for the zkFairTestnet chain. + +## Description + +Chain ID: 43851 +Chain Name: ZKFair Testnet +Default Block Explorer: https://testnet-scan.zkfair.io +Default RPC URL: https://testnet-rpc.zkfair.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { zkFairTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: zkFairTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/zkFairTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/zkFairTestnet.js#L26) diff --git a/packages/common/docs/variables/zkLinkNova.md b/packages/common/docs/variables/zkLinkNova.md new file mode 100644 index 0000000000..90b89ea3b0 --- /dev/null +++ b/packages/common/docs/variables/zkLinkNova.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / zkLinkNova + +# Variable: zkLinkNova + +> `const` **zkLinkNova**: `object` + +Creates a common configuration for the zkLinkNova chain. + +## Description + +Chain ID: 810180 +Chain Name: zkLink Nova +Default Block Explorer: https://explorer.zklink.io +Default RPC URL: https://rpc.zklink.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { zkLinkNova } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: zkLinkNova, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/zkLinkNova.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/zkLinkNova.js#L26) diff --git a/packages/common/docs/variables/zkLinkNovaSepoliaTestnet.md b/packages/common/docs/variables/zkLinkNovaSepoliaTestnet.md new file mode 100644 index 0000000000..83ced2e631 --- /dev/null +++ b/packages/common/docs/variables/zkLinkNovaSepoliaTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / zkLinkNovaSepoliaTestnet + +# Variable: zkLinkNovaSepoliaTestnet + +> `const` **zkLinkNovaSepoliaTestnet**: `object` + +Creates a common configuration for the zkLinkNovaSepoliaTestnet chain. + +## Description + +Chain ID: 810181 +Chain Name: zkLink Nova Sepolia Testnet +Default Block Explorer: https://sepolia.explorer.zklink.io +Default RPC URL: https://sepolia.rpc.zklink.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { zkLinkNovaSepoliaTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: zkLinkNovaSepoliaTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/zkLinkNovaSepoliaTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/zkLinkNovaSepoliaTestnet.js#L26) diff --git a/packages/common/docs/variables/zksync.md b/packages/common/docs/variables/zksync.md new file mode 100644 index 0000000000..dd3e16c5bc --- /dev/null +++ b/packages/common/docs/variables/zksync.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / zksync + +# Variable: zksync + +> `const` **zksync**: `object` + +Creates a common configuration for the zksync chain. + +## Description + +Chain ID: 324 +Chain Name: ZKsync Era +Default Block Explorer: https://era.zksync.network/ +Default RPC URL: https://mainnet.era.zksync.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { zksync } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: zksync, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/zksync.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/zksync.js#L26) diff --git a/packages/common/docs/variables/zksyncInMemoryNode.md b/packages/common/docs/variables/zksyncInMemoryNode.md new file mode 100644 index 0000000000..6c5a2c8c49 --- /dev/null +++ b/packages/common/docs/variables/zksyncInMemoryNode.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / zksyncInMemoryNode + +# Variable: zksyncInMemoryNode + +> `const` **zksyncInMemoryNode**: `object` + +Creates a common configuration for the zksyncInMemoryNode chain. + +## Description + +Chain ID: 260 +Chain Name: ZKsync InMemory Node +Default Block Explorer: Not specified +Default RPC URL: http://localhost:8011 + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { zksyncInMemoryNode } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: zksyncInMemoryNode, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/zksyncInMemoryNode.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/zksyncInMemoryNode.js#L26) diff --git a/packages/common/docs/variables/zksyncLocalNode.md b/packages/common/docs/variables/zksyncLocalNode.md new file mode 100644 index 0000000000..d0e445e2d0 --- /dev/null +++ b/packages/common/docs/variables/zksyncLocalNode.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / zksyncLocalNode + +# Variable: zksyncLocalNode + +> `const` **zksyncLocalNode**: `object` + +Creates a common configuration for the zksyncLocalNode chain. + +## Description + +Chain ID: 270 +Chain Name: ZKsync CLI Local Node +Default Block Explorer: Not specified +Default RPC URL: http://localhost:3050 + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { zksyncLocalNode } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: zksyncLocalNode, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/zksyncLocalNode.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/zksyncLocalNode.js#L26) diff --git a/packages/common/docs/variables/zksyncSepoliaTestnet.md b/packages/common/docs/variables/zksyncSepoliaTestnet.md new file mode 100644 index 0000000000..284f5f7a7a --- /dev/null +++ b/packages/common/docs/variables/zksyncSepoliaTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / zksyncSepoliaTestnet + +# Variable: zksyncSepoliaTestnet + +> `const` **zksyncSepoliaTestnet**: `object` + +Creates a common configuration for the zksyncSepoliaTestnet chain. + +## Description + +Chain ID: 300 +Chain Name: ZKsync Sepolia Testnet +Default Block Explorer: https://sepolia-era.zksync.network/ +Default RPC URL: https://sepolia.era.zksync.dev + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { zksyncSepoliaTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: zksyncSepoliaTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/zksyncSepoliaTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/zksyncSepoliaTestnet.js#L26) diff --git a/packages/common/docs/variables/zoraTestnet.md b/packages/common/docs/variables/zoraTestnet.md new file mode 100644 index 0000000000..c2109617a5 --- /dev/null +++ b/packages/common/docs/variables/zoraTestnet.md @@ -0,0 +1,151 @@ +[**@tevm/common**](../README.md) • **Docs** + +*** + +[@tevm/common](../globals.md) / zoraTestnet + +# Variable: zoraTestnet + +> `const` **zoraTestnet**: `object` + +Creates a common configuration for the zoraTestnet chain. + +## Description + +Chain ID: 999 +Chain Name: Zora Goerli Testnet +Default Block Explorer: https://testnet.explorer.zora.energy +Default RPC URL: https://testnet.rpc.zora.energy + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { zoraTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: zoraTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +#### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +### id + +> **id**: `number` + +ID in number form + +### name + +> **name**: `string` + +Human-readable name + +### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +#### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +### rpcUrls.default + +> **default**: `ChainRpcUrls` + +### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + +## Defined in + +[packages/common/src/presets/zoraTestnet.js:26](https://github.com/evmts/tevm-monorepo/blob/main/packages/common/src/presets/zoraTestnet.js#L26) diff --git a/packages/common/package.json b/packages/common/package.json index dbe36dfc3d..41639c8eda 100644 --- a/packages/common/package.json +++ b/packages/common/package.json @@ -19,6 +19,7 @@ "contributors": [ "Will Cory " ], + "sideEffects": false, "type": "module", "exports": { "./package.json": "./package.json", @@ -76,6 +77,5 @@ }, "publishConfig": { "access": "public" - }, - "sideEffects": false + } } \ No newline at end of file diff --git a/packages/common/src/Hardfork.ts b/packages/common/src/Hardfork.ts index 3be12f18ed..2a4a6076fc 100644 --- a/packages/common/src/Hardfork.ts +++ b/packages/common/src/Hardfork.ts @@ -2,7 +2,7 @@ * Ethereum hardfork options. Default option is currently cancun. * If you use older hardforks you might run into issues with EIPs not being supported. * @example - * ```typesxcript + * ```typescript * import { createCommon, mainnet } from 'tevm/common'` * * const hardfork: Hardfork = 'shanghai' diff --git a/packages/contract/docs/functions/createContract.md b/packages/contract/docs/functions/createContract.md index b8969217db..9d0238f6d9 100644 --- a/packages/contract/docs/functions/createContract.md +++ b/packages/contract/docs/functions/createContract.md @@ -8,13 +8,15 @@ > **createContract**\<`TName`, `TAbi`, `TAddress`, `TBytecode`, `TDeployedBytecode`, `TCode`, `THumanReadableAbi`\>(`__namedParameters`): [`Contract`](../type-aliases/Contract.md)\<`TName`, `THumanReadableAbi`, `TAddress`, `TBytecode`, `TDeployedBytecode`, `TCode`\> -Creates a tevm Contract instance from human readable abi +Creates a Tevm Contract instance from a human-readable ABI or JSON ABI. +This function is the core of Tevm's contract interaction capabilities, +allowing for type-safe and easy-to-use contract interfaces. ## Type Parameters • **TName** *extends* `string` -• **TAbi** *extends* readonly `string`[] \| `Abi` +• **TAbi** *extends* `Abi` \| readonly `string`[] • **TAddress** *extends* `undefined` \| \`0x$\{string\}\` = `undefined` @@ -36,4 +38,4 @@ Creates a tevm Contract instance from human readable abi ## Defined in -[createContract.js:35](https://github.com/evmts/tevm-monorepo/blob/main/packages/contract/src/createContract.js#L35) +[createContract.js:73](https://github.com/evmts/tevm-monorepo/blob/main/packages/contract/src/createContract.js#L73) diff --git a/packages/contract/docs/globals.md b/packages/contract/docs/globals.md index fbb0bf606b..4fbe87db41 100644 --- a/packages/contract/docs/globals.md +++ b/packages/contract/docs/globals.md @@ -9,8 +9,6 @@ - [Contract](type-aliases/Contract.md) - [CreateContractFn](type-aliases/CreateContractFn.md) - [CreateContractParams](type-aliases/CreateContractParams.md) -- [CreateScript](type-aliases/CreateScript.md) -- [DeployArgs](type-aliases/DeployArgs.md) - [EventActionCreator](type-aliases/EventActionCreator.md) - [MaybeExtractEventArgsFromAbi](type-aliases/MaybeExtractEventArgsFromAbi.md) - [ReadActionCreator](type-aliases/ReadActionCreator.md) diff --git a/packages/contract/docs/type-aliases/Contract.md b/packages/contract/docs/type-aliases/Contract.md index 1d1f492613..139b9c854f 100644 --- a/packages/contract/docs/type-aliases/Contract.md +++ b/packages/contract/docs/type-aliases/Contract.md @@ -8,115 +8,126 @@ > **Contract**\<`TName`, `THumanReadableAbi`, `TAddress`, `TBytecode`, `TDeployedBytecode`, `TCode`\>: `object` -Represents a specific contract abi and optional bytecode. +Represents a specific contract with its ABI and optional bytecode. +Contracts provide type-safe interfaces for interacting with smart contracts, +including read and write methods, event filtering, and deployment. ## Examples +Creating and using a Contract instance: ```typescript -import {createContract} from 'tevm/contract' - -const contract = createContract({ - address, - bytecode, - deployedBytecode, - humanReadableAbi, +import { createContract } from 'tevm/contract' + +const MyContract = createContract({ + name: 'MyToken', + humanReadableAbi: [ + 'function balanceOf(address account) view returns (uint256)', + 'function transfer(address to, uint256 amount) returns (bool)', + 'event Transfer(address indexed from, address indexed to, uint256 value)' + ], + address: '0x1234567890123456789012345678901234567890' }) -``` - -Contracts have actions creators for read methods, write methods, deploying, and events -```typescript -tevm.contract( -- { abi: [...], args: ['0x1234...'], functionName: 'balanceOf' }, -+ MyContract.read.balanceOf('0x1234...'), -) -``` - -These contracts can be automatically generated by using [@tevm/bundler](https://todo.todo) -and then importing it. The Tevm bundler will automatically resolve your solidity imports into -tevm contract instances - -```typescript -import { MyContract } from './MyContract.sol' - -console.log(MyContract.humanReadableAbi) -``` -Address can be added to a contract using the `withAddress` method +// Read contract state +const balanceAction = MyContract.read.balanceOf('0xabcdef...') +const balance = await tevm.contract(balanceAction) -```typescript -import { MyContract } from './MyContract.sol' +// Write to contract +const transferAction = MyContract.write.transfer('0xfedcba...', 1000n) +const result = await tevm.contract(transferAction) -const MyContractOptimism = MyContract.withAddress('0x420...') +// Create event filter +const transferFilter = MyContract.events.Transfer({ fromBlock: 'latest' }) +const logs = await tevm.eth.getLogs(transferFilter) ``` -Contracts can also be used with other libraries such as Viem and ethers. +Using with other libraries: ```typescript -import { MyContract } from './MyContract.sol' -import { createPublicClient } from 'viem' +import { createPublicClient, http } from 'viem' +import { mainnet } from 'viem/chains' -// see viem docs -const client = createPublicClient({...}) +const client = createPublicClient({ + chain: mainnet, + transport: http() +}) -const result = await client.readContract( - MyContract.withAddress('0x420...').read.balanceOf('0x1234...'), +const balance = await client.readContract( + MyContract.read.balanceOf('0xabcdef...') ) +``` ## Type Parameters • **TName** *extends* `string` +The name of the contract + • **THumanReadableAbi** *extends* `ReadonlyArray`\<`string`\> +The human-readable ABI of the contract + • **TAddress** *extends* `undefined` \| `Address` = `undefined` +The address of the contract (optional) + • **TBytecode** *extends* `undefined` \| `Hex` = `undefined` +The creation bytecode of the contract (optional) + • **TDeployedBytecode** *extends* `undefined` \| `Hex` = `undefined` +The deployed bytecode of the contract (optional) + • **TCode** *extends* `undefined` \| `Hex` = `undefined` +The runtime bytecode of the contract (optional) + ## Type declaration ### abi > **abi**: `ParseAbi`\<`THumanReadableAbi`\> -The json abi of the contract +The JSON ABI of the contract. #### Example ```typescript -import { MyContract } from './MyContract.sol' -console.log(MyContract.abi) // [{name: 'balanceOf', inputs: [...], outputs: [...], ...}] +console.log(MyContract.abi) +// [{name: 'balanceOf', inputs: [...], outputs: [...], ...}] ``` ### address > **address**: `TAddress` -Configured address of the contract. If not set it will be undefined -To set use the `withAddress` method +The configured address of the contract. If not set, it will be undefined. +Use the `withAddress` method to set or change the address. ### bytecode > **bytecode**: `TBytecode` -The contract bytecode is not defined on Contract objects are expected -to be deployed to the chain. See `Script` type which is a contract with bytecode -It's provided here to allow easier access of the property when using a -`Contract | Script` union type +The creation bytecode of the contract. ### code > **code**: `TCode` -Code i +The runtime bytecode of the contract, encoded with constructor arguments. ### deploy() > **deploy**: (...`args`) => `EncodeDeployDataParameters`\<`ParseAbi`\<`THumanReadableAbi`\>\> -Action creator for deploying the contract +Action creator for deploying the contract. + +#### Example + +```typescript +const deployAction = MyContract.deploy('Constructor', 'Args') +const deployedContract = await tevm.contract(deployAction) +``` #### Parameters @@ -130,35 +141,30 @@ Action creator for deploying the contract > **deployedBytecode**: `TDeployedBytecode` -The contract deployedBytecode is not defined on Contract objects are expected -to be deployed to the chain. See `Script` type which is a contract with deployedBytecode -It's provided here to allow easier access of the property when using a -`Contract | Script` union type +The deployed bytecode of the contract. ### events > **events**: [`EventActionCreator`](EventActionCreator.md)\<`THumanReadableAbi`, `TAddress`, `TBytecode`, `TDeployedBytecode`\> -Action creators for events. Can be used to create event filters in a typesafe way +Action creators for events. Used to create event filters in a type-safe way. #### Example ```typescript -tevm.eth.getLog( - MyContract.withAddress('0x420...').events.Transfer({ from: '0x1234...' }), -) -=== +const transferFilter = MyContract.events.Transfer({ from: '0x1234...' }) +const logs = await tevm.eth.getLogs(transferFilter) +``` ### humanReadableAbi > **humanReadableAbi**: `THumanReadableAbi` -The human readable abi of the contract +The human-readable ABI of the contract. #### Example ```typescript -import { MyContract } from './MyContract.sol' console.log(MyContract.humanReadableAbi) // ['function balanceOf(address): uint256', ...] ``` @@ -167,70 +173,76 @@ console.log(MyContract.humanReadableAbi) > `optional` **name**: `TName` -The name of the contract. If imported this will match the name of the contract import +The name of the contract. If imported, this will match the name of the contract import. ### read > **read**: [`ReadActionCreator`](ReadActionCreator.md)\<`THumanReadableAbi`, `TAddress`, `TCode`\> -Action creators for contract view and pure functions +Action creators for contract view and pure functions. #### Example ```typescript -tevm.contract( - MyContract.withAddress('0x420...').read.balanceOf('0x1234...'), -) +const balanceAction = MyContract.read.balanceOf('0x1234...') +const balance = await tevm.contract(balanceAction) ``` -### script - -> **script**: [`CreateScript`](CreateScript.md)\<`TName`, `THumanReadableAbi`, `TAddress`, `TBytecode`\> - -Creates a deployless instance of the contract that can be used with -tevm and viem as [deployless contracts](https://viem.sh/docs/contract/readContract#deployless-reads) - ### withAddress() -> **withAddress**: \<`TAddress`\>(`address`) => [`Contract`](Contract.md)\<`TName`, `THumanReadableAbi`, `TAddress`, `TBytecode`, `TDeployedBytecode`, `TCode`\> +> **withAddress**: \<`TNewAddress`\>(`address`) => [`Contract`](Contract.md)\<`TName`, `THumanReadableAbi`, `TNewAddress`, `TBytecode`, `TDeployedBytecode`, `TCode`\> -Adds an address to the contract. All action creators will return -the address property if added. THis method returns a new contract +Adds an address to the contract. All action creators will include +the address property if added. This method returns a new contract; it does not modify the existing contract. #### Example ```typescript -import { MyContract } from './MyContract.sol' -const MyContractOptimism = MyContract.withAddress('0x420...') +const MyContractWithAddress = MyContract.withAddress('0x1234...') ``` #### Type Parameters -• **TAddress** *extends* `Address` +• **TNewAddress** *extends* `Address` #### Parameters -• **address**: `TAddress` +• **address**: `TNewAddress` #### Returns -[`Contract`](Contract.md)\<`TName`, `THumanReadableAbi`, `TAddress`, `TBytecode`, `TDeployedBytecode`, `TCode`\> +[`Contract`](Contract.md)\<`TName`, `THumanReadableAbi`, `TNewAddress`, `TBytecode`, `TDeployedBytecode`, `TCode`\> + +### withCode() + +> **withCode**: (`encodedBytecode`) => [`Contract`](Contract.md)\<`TName`, `THumanReadableAbi`, `TAddress`, `TBytecode`, `TDeployedBytecode`, `Hex`\> + +#### Parameters + +• **encodedBytecode**: `Hex` + +The encoded bytecode of the contract + +#### Returns + +[`Contract`](Contract.md)\<`TName`, `THumanReadableAbi`, `TAddress`, `TBytecode`, `TDeployedBytecode`, `Hex`\> + +A new contract instance with updated code ### write > **write**: [`WriteActionCreator`](WriteActionCreator.md)\<`THumanReadableAbi`, `TAddress`, `TCode`\> -Action creators for contract payable and nonpayable functions +Action creators for contract payable and nonpayable functions. #### Example ```typescript -tevm.contract( - MyContract.withAddress('0x420...').read.balanceOf('0x1234...'), -) +const transferAction = MyContract.write.transfer('0x5678...', 1000n) +const result = await tevm.contract(transferAction) ``` ## Defined in -[Contract.ts:59](https://github.com/evmts/tevm-monorepo/blob/main/packages/contract/src/Contract.ts#L59) +[Contract.ts:62](https://github.com/evmts/tevm-monorepo/blob/main/packages/contract/src/Contract.ts#L62) diff --git a/packages/contract/docs/type-aliases/CreateContractFn.md b/packages/contract/docs/type-aliases/CreateContractFn.md index 6950ff8c0d..d5d6312f00 100644 --- a/packages/contract/docs/type-aliases/CreateContractFn.md +++ b/packages/contract/docs/type-aliases/CreateContractFn.md @@ -14,32 +14,67 @@ code, }`) => [`Contract`](Contract.md)\<`TName`, `THumanReadableAbi`, `TAddress`, `TBytecode`, `TDeployedBytecode`, `TCode`\> -Type of `createContract` factory function -Creates a tevm Contract instance from human readable abi +Type of `createContract` factory function. +Creates a tevm Contract instance from a human readable ABI or JSON ABI. ## Examples +Using a human readable ABI: ```typescript -import { type Contract, createContract} from 'tevm/contract' +import { type Contract, createContract } from 'tevm/contract' const contract: Contract = createContract({ - name: 'MyContract', - abi: [ - ... - ], + name: 'ERC20', + humanReadableAbi: [ + 'function balanceOf(address owner) view returns (uint256)', + 'function transfer(address to, uint256 amount) returns (bool)', + 'event Transfer(address indexed from, address indexed to, uint256 value)', + ], }) ``` -To use a json abi first pass it into `formatAbi` to turn it into human readable - +Using a JSON ABI (needs to be formatted): ```typescript -import { type Contract, createContract} from 'tevm/contract' +import { type Contract, createContract } from 'tevm/contract' +import { formatAbi } from '@tevm/utils' + +const jsonAbi = [ + { + "inputs": [{"name": "owner", "type": "address"}], + "name": "balanceOf", + "outputs": [{"type": "uint256"}], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [ + {"name": "to", "type": "address"}, + {"name": "amount", "type": "uint256"} + ], + "name": "transfer", + "outputs": [{"type": "bool"}], + "stateMutability": "nonpayable", + "type": "function" + }, + { + "anonymous": false, + "inputs": [ + {"indexed": true, "name": "from", "type": "address"}, + {"indexed": true, "name": "to", "type": "address"}, + {"indexed": false, "name": "value", "type": "uint256"} + ], + "name": "Transfer", + "type": "event" + } +] const contract = createContract({ - name: 'MyContract', - abi: [ - ... - ], + name: 'ERC20', + abi: formatAbi(jsonAbi), + address: '0x6B175474E89094C44Da98b954EedeAC495271d0F', // DAI token address on Ethereum mainnet + bytecode: '0x60806040526000805534801561001457600080fd5b50610771806100246000396000f3fe', // Example bytecode (truncated) + deployedBytecode: '0x608060405234801561001057600080fd5b50600436106100885760003560e01c806370a082311161005b57806370a08231146101bc', // Example deployed bytecode (truncated) + code: '0x608060405234801561001057600080fd5b50600436106100885760003560e01c806370a082311161005b57806370a08231146101bc', // Example runtime code (truncated) }) ``` @@ -47,16 +82,28 @@ const contract = createContract({ • **TName** *extends* `string` +The name of the contract + • **TAbi** *extends* readonly `string`[] \| `Abi` +The ABI type (either string[] for human readable or Abi for JSON) + • **TAddress** *extends* `undefined` \| `Address` = `undefined` +The contract address type (optional) + • **TBytecode** *extends* `undefined` \| `Hex` = `undefined` +The contract bytecode type (optional) + • **TDeployedBytecode** *extends* `undefined` \| `Hex` = `undefined` +The deployed bytecode type (optional) + • **TCode** *extends* `undefined` \| `Hex` = `undefined` +The runtime bytecode type (optional) + • **THumanReadableAbi** *extends* readonly `string`[] = `TAbi` *extends* readonly `string`[] ? `TAbi` : `TAbi` *extends* `Abi` ? `FormatAbi`\<`TAbi`\> : `never` ## Parameters @@ -75,4 +122,4 @@ const contract = createContract({ ## Defined in -[CreateContractFn.ts:33](https://github.com/evmts/tevm-monorepo/blob/main/packages/contract/src/CreateContractFn.ts#L33) +[CreateContractFn.ts:77](https://github.com/evmts/tevm-monorepo/blob/main/packages/contract/src/CreateContractFn.ts#L77) diff --git a/packages/contract/docs/type-aliases/CreateContractParams.md b/packages/contract/docs/type-aliases/CreateContractParams.md index ace4de394c..5bc8e0adb2 100644 --- a/packages/contract/docs/type-aliases/CreateContractParams.md +++ b/packages/contract/docs/type-aliases/CreateContractParams.md @@ -8,26 +8,71 @@ > **CreateContractParams**\<`TName`, `TAbi`, `TAddress`, `TBytecode`, `TDeployedBytecode`, `TCode`\>: `object` \| `object` -Params for creating a [Contract](Contract.md) instance +Parameters for creating a [Contract](Contract.md) instance. +This type allows for two mutually exclusive ways of specifying the ABI: +either as a human-readable ABI or as a JSON ABI. ## See CreateContract +## Examples + +Using human-readable ABI: +```typescript +const params: CreateContractParams = { + name: 'ERC20', + humanReadableAbi: [ + 'function balanceOf(address owner) view returns (uint256)', + 'function transfer(address to, uint256 amount) returns (bool)', + ], + address: '0x6B175474E89094C44Da98b954EedeAC495271d0F', +} +``` + +Using JSON ABI: +```typescript +const params: CreateContractParams = { + name: 'ERC20', + abi: [ + { + "inputs": [{"name": "owner", "type": "address"}], + "name": "balanceOf", + "outputs": [{"type": "uint256"}], + "stateMutability": "view", + "type": "function" + }, + ], + address: '0x6B175474E89094C44Da98b954EedeAC495271d0F', +} +``` + ## Type Parameters • **TName** *extends* `string` \| `undefined` \| `never` +The name of the contract (optional) + • **TAbi** *extends* readonly `string`[] \| `Abi` +The ABI type (either string[] for human readable or Abi for JSON) + • **TAddress** *extends* `undefined` \| `Address` \| `never` +The contract address type (optional) + • **TBytecode** *extends* `undefined` \| `Hex` \| `never` +The contract creation bytecode type (optional) + • **TDeployedBytecode** *extends* `undefined` \| `Hex` \| `never` +The deployed bytecode type (optional) + • **TCode** *extends* `undefined` \| `Hex` \| `never` +The runtime bytecode type (optional) + ## Defined in -[CreateContractParams.ts:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/contract/src/CreateContractParams.ts#L8) +[CreateContractParams.ts:49](https://github.com/evmts/tevm-monorepo/blob/main/packages/contract/src/CreateContractParams.ts#L49) diff --git a/packages/contract/docs/type-aliases/CreateScript.md b/packages/contract/docs/type-aliases/CreateScript.md deleted file mode 100644 index f6871450e8..0000000000 --- a/packages/contract/docs/type-aliases/CreateScript.md +++ /dev/null @@ -1,35 +0,0 @@ -[**@tevm/contract**](../README.md) • **Docs** - -*** - -[@tevm/contract](../globals.md) / CreateScript - -# Type Alias: CreateScript()\ - -> **CreateScript**\<`TName`, `THumanReadableAbi`, `TAddress`, `TBytecode`\>: (...`args`) => [`Contract`](Contract.md)\<`TName`, `THumanReadableAbi`, `TAddress`, `Hex`, `Hex`, `Hex`\> - -Creates a deployless instance of a contract -Can be used to execute code that isn't deployed in tevm -or [viem](https://viem.sh/docs/actions/public/call#deployless-calls) - -## Type Parameters - -• **TName** *extends* `string` - -• **THumanReadableAbi** *extends* `string`[] \| readonly `string`[] - -• **TAddress** *extends* `Address` \| `undefined` = `undefined` - -• **TBytecode** *extends* `Hex` \| `undefined` = `undefined` - -## Parameters - -• ...**args**: [`DeployArgs`](DeployArgs.md)\<`THumanReadableAbi`, `TBytecode`\> - -## Returns - -[`Contract`](Contract.md)\<`TName`, `THumanReadableAbi`, `TAddress`, `Hex`, `Hex`, `Hex`\> - -## Defined in - -[CreateScript.ts:10](https://github.com/evmts/tevm-monorepo/blob/main/packages/contract/src/CreateScript.ts#L10) diff --git a/packages/contract/docs/type-aliases/DeployArgs.md b/packages/contract/docs/type-aliases/DeployArgs.md deleted file mode 100644 index a032d47523..0000000000 --- a/packages/contract/docs/type-aliases/DeployArgs.md +++ /dev/null @@ -1,25 +0,0 @@ -[**@tevm/contract**](../README.md) • **Docs** - -*** - -[@tevm/contract](../globals.md) / DeployArgs - -# Type Alias: DeployArgs\ - -> **DeployArgs**\<`THumanReadableAbi`, `TBytecode`, `TAbi`, `THasConstructor`\>: `THasConstructor` *extends* `false` ? `TBytecode` *extends* `Hex` ? [] \| [`object`] : [`object`] : `TBytecode` *extends* `Hex` ? [`object`] : [`object`] - -Inferred arguments for a contract deployment - -## Type Parameters - -• **THumanReadableAbi** *extends* `string`[] \| readonly `string`[] - -• **TBytecode** *extends* `Hex` \| `undefined` = `undefined` - -• **TAbi** *extends* `ParseAbi`\<`THumanReadableAbi`\> = `ParseAbi`\<`THumanReadableAbi`\> - -• **THasConstructor** = `TAbi` *extends* `Abi` ? `Abi` *extends* `TAbi` ? `true` : [`Extract`\<`TAbi`\[`number`\], `object`\>] *extends* [`never`] ? `false` : `true` : `true` - -## Defined in - -[DeployArgs.ts:6](https://github.com/evmts/tevm-monorepo/blob/main/packages/contract/src/DeployArgs.ts#L6) diff --git a/packages/contract/docs/type-aliases/EventActionCreator.md b/packages/contract/docs/type-aliases/EventActionCreator.md index c2cc317eb6..1f2ad2db42 100644 --- a/packages/contract/docs/type-aliases/EventActionCreator.md +++ b/packages/contract/docs/type-aliases/EventActionCreator.md @@ -8,28 +8,44 @@ > **EventActionCreator**\<`THumanReadableAbi`, `TBytecode`, `TDeployedBytecode`, `TAddress`, `TAddressArgs`\>: `{ [TEventName in ExtractAbiEventNames>]: Function & Object & TAddressArgs }` -A mapping of event names to action creators for events. Can be used to create event filters in a typesafe way +A mapping of event names to action creators for events. Can be used to create event filters in a typesafe way. ## Example ```typescript -tevm.eth.getLog( - MyScript.withAddress('0x420...').events.Transfer({ from: '0x1234...' }), -) -=== +// Creating an event filter for a Transfer event +const filter = MyContract.events.Transfer({ + fromBlock: 'latest', + toBlock: 'latest', + args: { from: '0x1234...', to: '0x5678...' } +}) + +// Using the filter with tevm +const logs = await tevm.eth.getLogs(filter) +``` ## Type Parameters • **THumanReadableAbi** *extends* readonly `string`[] +The human-readable ABI of the contract. + • **TBytecode** *extends* `Hex` \| `undefined` +The bytecode of the contract. + • **TDeployedBytecode** *extends* `Hex` \| `undefined` +The deployed bytecode of the contract. + • **TAddress** *extends* `Address` \| `undefined` +The address of the contract. + • **TAddressArgs** = `TAddress` *extends* `undefined` ? `object` : `object` +Additional arguments for the address. + ## Defined in -[event/EventActionCreator.ts:41](https://github.com/evmts/tevm-monorepo/blob/main/packages/contract/src/event/EventActionCreator.ts#L41) +[event/EventActionCreator.ts:59](https://github.com/evmts/tevm-monorepo/blob/main/packages/contract/src/event/EventActionCreator.ts#L59) diff --git a/packages/contract/docs/type-aliases/MaybeExtractEventArgsFromAbi.md b/packages/contract/docs/type-aliases/MaybeExtractEventArgsFromAbi.md index 70a3b50607..eb2f40d04b 100644 --- a/packages/contract/docs/type-aliases/MaybeExtractEventArgsFromAbi.md +++ b/packages/contract/docs/type-aliases/MaybeExtractEventArgsFromAbi.md @@ -8,14 +8,18 @@ > **MaybeExtractEventArgsFromAbi**\<`TAbi`, `TEventName`\>: `Exclude`\<`TAbi` *extends* `Abi` \| readonly `unknown`[] ? `TEventName` *extends* `string` ? `GetEventArgs`\<`TAbi`, `TEventName`\> : `undefined` : `undefined`, readonly `unknown`[] \| `Record`\<`string`, `unknown`\>\> -Adapted from viem. This is a helper type to extract the event args from an abi +Extracts event arguments from an ABI. ## Type Parameters • **TAbi** *extends* `Abi` \| readonly `unknown`[] \| `undefined` +The ABI type, can be an Abi, readonly unknown[], or undefined. + • **TEventName** *extends* `string` \| `undefined` +The name of the event, can be a string or undefined. + ## Defined in -[event/EventActionCreator.ts:18](https://github.com/evmts/tevm-monorepo/blob/main/packages/contract/src/event/EventActionCreator.ts#L18) +[event/EventActionCreator.ts:20](https://github.com/evmts/tevm-monorepo/blob/main/packages/contract/src/event/EventActionCreator.ts#L20) diff --git a/packages/contract/docs/type-aliases/ReadActionCreator.md b/packages/contract/docs/type-aliases/ReadActionCreator.md index 31a1141040..6c714d9fa9 100644 --- a/packages/contract/docs/type-aliases/ReadActionCreator.md +++ b/packages/contract/docs/type-aliases/ReadActionCreator.md @@ -8,26 +8,38 @@ > **ReadActionCreator**\<`THumanReadableAbi`, `TAddress`, `TCode`, `TAddressArgs`\>: \{ \[TFunctionName in ExtractAbiFunctionNames\, "pure" \| "view"\>\]: Function & Object & (TCode extends undefined ? Object : Object) & TAddressArgs \} -A mapping of view and pure contract methods to action creators +A mapping of view and pure contract methods to action creators. +This type provides a way to create type-safe read actions for contract methods. ## Example ```typescript -tevm.contract( - MyScript.withAddress('0x420...').read.balanceOf('0x1234...'), -) +// Assuming we have a contract with a 'balanceOf' method +const balanceAction = MyContract.read.balanceOf('0x1234...') + +// Use the action with tevm +const balance = await tevm.contract(balanceAction) +console.log('Balance:', balance) ``` ## Type Parameters • **THumanReadableAbi** *extends* readonly `string`[] +The human-readable ABI of the contract. + • **TAddress** *extends* `Address` \| `undefined` +The address of the contract (optional). + • **TCode** *extends* `Hex` \| `undefined` +The runtime bytecode of the contract (optional). + • **TAddressArgs** = `TAddress` *extends* `undefined` ? `object` : `object` +Additional arguments for the address (derived from TAddress). + ## Defined in -[read/ReadActionCreator.ts:23](https://github.com/evmts/tevm-monorepo/blob/main/packages/contract/src/read/ReadActionCreator.ts#L23) +[read/ReadActionCreator.ts:36](https://github.com/evmts/tevm-monorepo/blob/main/packages/contract/src/read/ReadActionCreator.ts#L36) diff --git a/packages/contract/docs/type-aliases/ValueOf.md b/packages/contract/docs/type-aliases/ValueOf.md index ca1ffb8845..b5c8295c3d 100644 --- a/packages/contract/docs/type-aliases/ValueOf.md +++ b/packages/contract/docs/type-aliases/ValueOf.md @@ -8,10 +8,14 @@ > **ValueOf**\<`T`\>: `T`\[keyof `T`\] +Utility type to get the value type of an object. + ## Type Parameters • **T** +The object type. + ## Defined in -[event/EventActionCreator.ts:30](https://github.com/evmts/tevm-monorepo/blob/main/packages/contract/src/event/EventActionCreator.ts#L30) +[event/EventActionCreator.ts:36](https://github.com/evmts/tevm-monorepo/blob/main/packages/contract/src/event/EventActionCreator.ts#L36) diff --git a/packages/contract/docs/type-aliases/WriteActionCreator.md b/packages/contract/docs/type-aliases/WriteActionCreator.md index 5ecfdaaaea..7bfb2a4baa 100644 --- a/packages/contract/docs/type-aliases/WriteActionCreator.md +++ b/packages/contract/docs/type-aliases/WriteActionCreator.md @@ -8,26 +8,38 @@ > **WriteActionCreator**\<`THumanReadableAbi`, `TAddress`, `TCode`, `TAddressArgs`\>: \{ \[TFunctionName in ExtractAbiFunctionNames\, "payable" \| "nonpayable"\>\]: Function & Object & (TCode extends undefined ? Object : Object) & TAddressArgs \} -A mapping of payable and nonpayable contract methods to action creators +A mapping of payable and nonpayable contract methods to action creators. +This type provides a way to create type-safe write actions for contract methods. ## Example ```typescript -tevm.contract( - MyContract.withAddress('0x420...').read.balanceOf('0x1234...'), -) +// Assuming we have a contract with a 'transfer' method +const transferAction = MyContract.write.transfer('0x1234...', 1000n) + +// Use the action with tevm +const result = await tevm.contract(transferAction) +console.log('Transaction hash:', result.transactionHash) ``` ## Type Parameters • **THumanReadableAbi** *extends* readonly `string`[] +The human-readable ABI of the contract. + • **TAddress** *extends* `Address` \| `undefined` +The address of the contract (optional). + • **TCode** *extends* `Hex` \| `undefined` +The runtime bytecode of the contract (optional). + • **TAddressArgs** = `TAddress` *extends* `undefined` ? `object` : `object` +Additional arguments for the address (derived from TAddress). + ## Defined in -[write/WriteActionCreator.ts:23](https://github.com/evmts/tevm-monorepo/blob/main/packages/contract/src/write/WriteActionCreator.ts#L23) +[write/WriteActionCreator.ts:36](https://github.com/evmts/tevm-monorepo/blob/main/packages/contract/src/write/WriteActionCreator.ts#L36) diff --git a/packages/contract/docs/variables/ERC20.md b/packages/contract/docs/variables/ERC20.md index a683510c2c..f001707cee 100644 --- a/packages/contract/docs/variables/ERC20.md +++ b/packages/contract/docs/variables/ERC20.md @@ -8,8 +8,38 @@ > `const` **ERC20**: [`Contract`](../type-aliases/Contract.md)\<`"OzERC20"`, readonly [`"constructor(string name, string symbol)"`, `"error ERC20InsufficientAllowance(address spender, uint256 allowance, uint256 needed)"`, `"error ERC20InsufficientBalance(address sender, uint256 balance, uint256 needed)"`, `"error ERC20InvalidApprover(address approver)"`, `"error ERC20InvalidReceiver(address receiver)"`, `"error ERC20InvalidSender(address sender)"`, `"error ERC20InvalidSpender(address spender)"`, `"event Approval(address indexed owner, address indexed spender, uint256 value)"`, `"event Transfer(address indexed from, address indexed to, uint256 value)"`, `"function allowance(address owner, address spender) view returns (uint256)"`, `"function approve(address spender, uint256 value) returns (bool)"`, `"function balanceOf(address account) view returns (uint256)"`, `"function decimals() view returns (uint8)"`, `"function name() view returns (string)"`, `"function symbol() view returns (string)"`, `"function totalSupply() view returns (uint256)"`, `"function transfer(address to, uint256 value) returns (bool)"`, `"function transferFrom(address from, address to, uint256 value) returns (bool)"`], `undefined`, `"0x608060405234801562000010575f80fd5b5060405162001392380380620013928339818101604052810190620000369190620001eb565b81818160039081620000499190620004a5565b5080600490816200005b9190620004a5565b505050505062000589565b5f604051905090565b5f80fd5b5f80fd5b5f80fd5b5f80fd5b5f601f19601f8301169050919050565b7f4e487b71000000000000000000000000000000000000000000000000000000005f52604160045260245ffd5b620000c7826200007f565b810181811067ffffffffffffffff82111715620000e957620000e86200008f565b5b80604052505050565b5f620000fd62000066565b90506200010b8282620000bc565b919050565b5f67ffffffffffffffff8211156200012d576200012c6200008f565b5b62000138826200007f565b9050602081019050919050565b5f5b838110156200016457808201518184015260208101905062000147565b5f8484015250505050565b5f620001856200017f8462000110565b620000f2565b905082815260208101848484011115620001a457620001a36200007b565b5b620001b184828562000145565b509392505050565b5f82601f830112620001d057620001cf62000077565b5b8151620001e28482602086016200016f565b91505092915050565b5f80604083850312156200020457620002036200006f565b5b5f83015167ffffffffffffffff81111562000224576200022362000073565b5b6200023285828601620001b9565b925050602083015167ffffffffffffffff81111562000256576200025562000073565b5b6200026485828601620001b9565b9150509250929050565b5f81519050919050565b7f4e487b71000000000000000000000000000000000000000000000000000000005f52602260045260245ffd5b5f6002820490506001821680620002bd57607f821691505b602082108103620002d357620002d262000278565b5b50919050565b5f819050815f5260205f209050919050565b5f6020601f8301049050919050565b5f82821b905092915050565b5f60088302620003377fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff82620002fa565b620003438683620002fa565b95508019841693508086168417925050509392505050565b5f819050919050565b5f819050919050565b5f6200038d6200038762000381846200035b565b62000364565b6200035b565b9050919050565b5f819050919050565b620003a8836200036d565b620003c0620003b78262000394565b84845462000306565b825550505050565b5f90565b620003d6620003c8565b620003e38184846200039d565b505050565b5b818110156200040a57620003fe5f82620003cc565b600181019050620003e9565b5050565b601f82111562000459576200042381620002d9565b6200042e84620002eb565b810160208510156200043e578190505b620004566200044d85620002eb565b830182620003e8565b50505b505050565b5f82821c905092915050565b5f6200047b5f19846008026200045e565b1980831691505092915050565b5f6200049583836200046a565b9150826002028217905092915050565b620004b0826200026e565b67ffffffffffffffff811115620004cc57620004cb6200008f565b5b620004d88254620002a5565b620004e58282856200040e565b5f60209050601f8311600181146200051b575f841562000506578287015190505b62000512858262000488565b86555062000581565b601f1984166200052b86620002d9565b5f5b8281101562000554578489015182556001820191506020850194506020810190506200052d565b8683101562000574578489015162000570601f8916826200046a565b8355505b6001600288020188555050505b505050505050565b610dfb80620005975f395ff3fe608060405234801561000f575f80fd5b5060043610610091575f3560e01c8063313ce56711610064578063313ce5671461013157806370a082311461014f57806395d89b411461017f578063a9059cbb1461019d578063dd62ed3e146101cd57610091565b806306fdde0314610095578063095ea7b3146100b357806318160ddd146100e357806323b872dd14610101575b5f80fd5b61009d6101fd565b6040516100aa9190610a74565b60405180910390f35b6100cd60048036038101906100c89190610b25565b61028d565b6040516100da9190610b7d565b60405180910390f35b6100eb6102af565b6040516100f89190610ba5565b60405180910390f35b61011b60048036038101906101169190610bbe565b6102b8565b6040516101289190610b7d565b60405180910390f35b6101396102e6565b6040516101469190610c29565b60405180910390f35b61016960048036038101906101649190610c42565b6102ee565b6040516101769190610ba5565b60405180910390f35b610187610333565b6040516101949190610a74565b60405180910390f35b6101b760048036038101906101b29190610b25565b6103c3565b6040516101c49190610b7d565b60405180910390f35b6101e760048036038101906101e29190610c6d565b6103e5565b6040516101f49190610ba5565b60405180910390f35b60606003805461020c90610cd8565b80601f016020809104026020016040519081016040528092919081815260200182805461023890610cd8565b80156102835780601f1061025a57610100808354040283529160200191610283565b820191905f5260205f20905b81548152906001019060200180831161026657829003601f168201915b5050505050905090565b5f80610297610467565b90506102a481858561046e565b600191505092915050565b5f600254905090565b5f806102c2610467565b90506102cf858285610480565b6102da858585610512565b60019150509392505050565b5f6012905090565b5f805f8373ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f20549050919050565b60606004805461034290610cd8565b80601f016020809104026020016040519081016040528092919081815260200182805461036e90610cd8565b80156103b95780601f10610390576101008083540402835291602001916103b9565b820191905f5260205f20905b81548152906001019060200180831161039c57829003601f168201915b5050505050905090565b5f806103cd610467565b90506103da818585610512565b600191505092915050565b5f60015f8473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f8373ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f2054905092915050565b5f33905090565b61047b8383836001610602565b505050565b5f61048b84846103e5565b90507fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff811461050c57818110156104fd578281836040517ffb8f41b20000000000000000000000000000000000000000000000000000000081526004016104f493929190610d17565b60405180910390fd5b61050b84848484035f610602565b5b50505050565b5f73ffffffffffffffffffffffffffffffffffffffff168373ffffffffffffffffffffffffffffffffffffffff1603610582575f6040517f96c6fd1e0000000000000000000000000000000000000000000000000000000081526004016105799190610d4c565b60405180910390fd5b5f73ffffffffffffffffffffffffffffffffffffffff168273ffffffffffffffffffffffffffffffffffffffff16036105f2575f6040517fec442f050000000000000000000000000000000000000000000000000000000081526004016105e99190610d4c565b60405180910390fd5b6105fd8383836107d1565b505050565b5f73ffffffffffffffffffffffffffffffffffffffff168473ffffffffffffffffffffffffffffffffffffffff1603610672575f6040517fe602df050000000000000000000000000000000000000000000000000000000081526004016106699190610d4c565b60405180910390fd5b5f73ffffffffffffffffffffffffffffffffffffffff168373ffffffffffffffffffffffffffffffffffffffff16036106e2575f6040517f94280d620000000000000000000000000000000000000000000000000000000081526004016106d99190610d4c565b60405180910390fd5b8160015f8673ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f8573ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f208190555080156107cb578273ffffffffffffffffffffffffffffffffffffffff168473ffffffffffffffffffffffffffffffffffffffff167f8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925846040516107c29190610ba5565b60405180910390a35b50505050565b5f73ffffffffffffffffffffffffffffffffffffffff168373ffffffffffffffffffffffffffffffffffffffff1603610821578060025f8282546108159190610d92565b925050819055506108ef565b5f805f8573ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f20549050818110156108aa578381836040517fe450d38c0000000000000000000000000000000000000000000000000000000081526004016108a193929190610d17565b60405180910390fd5b8181035f808673ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f2081905550505b5f73ffffffffffffffffffffffffffffffffffffffff168273ffffffffffffffffffffffffffffffffffffffff1603610936578060025f8282540392505081905550610980565b805f808473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f82825401925050819055505b8173ffffffffffffffffffffffffffffffffffffffff168373ffffffffffffffffffffffffffffffffffffffff167fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef836040516109dd9190610ba5565b60405180910390a3505050565b5f81519050919050565b5f82825260208201905092915050565b5f5b83811015610a21578082015181840152602081019050610a06565b5f8484015250505050565b5f601f19601f8301169050919050565b5f610a46826109ea565b610a5081856109f4565b9350610a60818560208601610a04565b610a6981610a2c565b840191505092915050565b5f6020820190508181035f830152610a8c8184610a3c565b905092915050565b5f80fd5b5f73ffffffffffffffffffffffffffffffffffffffff82169050919050565b5f610ac182610a98565b9050919050565b610ad181610ab7565b8114610adb575f80fd5b50565b5f81359050610aec81610ac8565b92915050565b5f819050919050565b610b0481610af2565b8114610b0e575f80fd5b50565b5f81359050610b1f81610afb565b92915050565b5f8060408385031215610b3b57610b3a610a94565b5b5f610b4885828601610ade565b9250506020610b5985828601610b11565b9150509250929050565b5f8115159050919050565b610b7781610b63565b82525050565b5f602082019050610b905f830184610b6e565b92915050565b610b9f81610af2565b82525050565b5f602082019050610bb85f830184610b96565b92915050565b5f805f60608486031215610bd557610bd4610a94565b5b5f610be286828701610ade565b9350506020610bf386828701610ade565b9250506040610c0486828701610b11565b9150509250925092565b5f60ff82169050919050565b610c2381610c0e565b82525050565b5f602082019050610c3c5f830184610c1a565b92915050565b5f60208284031215610c5757610c56610a94565b5b5f610c6484828501610ade565b91505092915050565b5f8060408385031215610c8357610c82610a94565b5b5f610c9085828601610ade565b9250506020610ca185828601610ade565b9150509250929050565b7f4e487b71000000000000000000000000000000000000000000000000000000005f52602260045260245ffd5b5f6002820490506001821680610cef57607f821691505b602082108103610d0257610d01610cab565b5b50919050565b610d1181610ab7565b82525050565b5f606082019050610d2a5f830186610d08565b610d376020830185610b96565b610d446040830184610b96565b949350505050565b5f602082019050610d5f5f830184610d08565b92915050565b7f4e487b71000000000000000000000000000000000000000000000000000000005f52601160045260245ffd5b5f610d9c82610af2565b9150610da783610af2565b9250828201905080821115610dbf57610dbe610d65565b5b9291505056fea264697066735822122055b5ce6d6026c56b28a641568d3e9a6c81fb1079127f85ede16ed31d67d3eff464736f6c63430008160033"`, `"0x608060405234801561000f575f80fd5b5060043610610091575f3560e01c8063313ce56711610064578063313ce5671461013157806370a082311461014f57806395d89b411461017f578063a9059cbb1461019d578063dd62ed3e146101cd57610091565b806306fdde0314610095578063095ea7b3146100b357806318160ddd146100e357806323b872dd14610101575b5f80fd5b61009d6101fd565b6040516100aa9190610a74565b60405180910390f35b6100cd60048036038101906100c89190610b25565b61028d565b6040516100da9190610b7d565b60405180910390f35b6100eb6102af565b6040516100f89190610ba5565b60405180910390f35b61011b60048036038101906101169190610bbe565b6102b8565b6040516101289190610b7d565b60405180910390f35b6101396102e6565b6040516101469190610c29565b60405180910390f35b61016960048036038101906101649190610c42565b6102ee565b6040516101769190610ba5565b60405180910390f35b610187610333565b6040516101949190610a74565b60405180910390f35b6101b760048036038101906101b29190610b25565b6103c3565b6040516101c49190610b7d565b60405180910390f35b6101e760048036038101906101e29190610c6d565b6103e5565b6040516101f49190610ba5565b60405180910390f35b60606003805461020c90610cd8565b80601f016020809104026020016040519081016040528092919081815260200182805461023890610cd8565b80156102835780601f1061025a57610100808354040283529160200191610283565b820191905f5260205f20905b81548152906001019060200180831161026657829003601f168201915b5050505050905090565b5f80610297610467565b90506102a481858561046e565b600191505092915050565b5f600254905090565b5f806102c2610467565b90506102cf858285610480565b6102da858585610512565b60019150509392505050565b5f6012905090565b5f805f8373ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f20549050919050565b60606004805461034290610cd8565b80601f016020809104026020016040519081016040528092919081815260200182805461036e90610cd8565b80156103b95780601f10610390576101008083540402835291602001916103b9565b820191905f5260205f20905b81548152906001019060200180831161039c57829003601f168201915b5050505050905090565b5f806103cd610467565b90506103da818585610512565b600191505092915050565b5f60015f8473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f8373ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f2054905092915050565b5f33905090565b61047b8383836001610602565b505050565b5f61048b84846103e5565b90507fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff811461050c57818110156104fd578281836040517ffb8f41b20000000000000000000000000000000000000000000000000000000081526004016104f493929190610d17565b60405180910390fd5b61050b84848484035f610602565b5b50505050565b5f73ffffffffffffffffffffffffffffffffffffffff168373ffffffffffffffffffffffffffffffffffffffff1603610582575f6040517f96c6fd1e0000000000000000000000000000000000000000000000000000000081526004016105799190610d4c565b60405180910390fd5b5f73ffffffffffffffffffffffffffffffffffffffff168273ffffffffffffffffffffffffffffffffffffffff16036105f2575f6040517fec442f050000000000000000000000000000000000000000000000000000000081526004016105e99190610d4c565b60405180910390fd5b6105fd8383836107d1565b505050565b5f73ffffffffffffffffffffffffffffffffffffffff168473ffffffffffffffffffffffffffffffffffffffff1603610672575f6040517fe602df050000000000000000000000000000000000000000000000000000000081526004016106699190610d4c565b60405180910390fd5b5f73ffffffffffffffffffffffffffffffffffffffff168373ffffffffffffffffffffffffffffffffffffffff16036106e2575f6040517f94280d620000000000000000000000000000000000000000000000000000000081526004016106d99190610d4c565b60405180910390fd5b8160015f8673ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f8573ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f208190555080156107cb578273ffffffffffffffffffffffffffffffffffffffff168473ffffffffffffffffffffffffffffffffffffffff167f8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925846040516107c29190610ba5565b60405180910390a35b50505050565b5f73ffffffffffffffffffffffffffffffffffffffff168373ffffffffffffffffffffffffffffffffffffffff1603610821578060025f8282546108159190610d92565b925050819055506108ef565b5f805f8573ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f20549050818110156108aa578381836040517fe450d38c0000000000000000000000000000000000000000000000000000000081526004016108a193929190610d17565b60405180910390fd5b8181035f808673ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f2081905550505b5f73ffffffffffffffffffffffffffffffffffffffff168273ffffffffffffffffffffffffffffffffffffffff1603610936578060025f8282540392505081905550610980565b805f808473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f82825401925050819055505b8173ffffffffffffffffffffffffffffffffffffffff168373ffffffffffffffffffffffffffffffffffffffff167fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef836040516109dd9190610ba5565b60405180910390a3505050565b5f81519050919050565b5f82825260208201905092915050565b5f5b83811015610a21578082015181840152602081019050610a06565b5f8484015250505050565b5f601f19601f8301169050919050565b5f610a46826109ea565b610a5081856109f4565b9350610a60818560208601610a04565b610a6981610a2c565b840191505092915050565b5f6020820190508181035f830152610a8c8184610a3c565b905092915050565b5f80fd5b5f73ffffffffffffffffffffffffffffffffffffffff82169050919050565b5f610ac182610a98565b9050919050565b610ad181610ab7565b8114610adb575f80fd5b50565b5f81359050610aec81610ac8565b92915050565b5f819050919050565b610b0481610af2565b8114610b0e575f80fd5b50565b5f81359050610b1f81610afb565b92915050565b5f8060408385031215610b3b57610b3a610a94565b5b5f610b4885828601610ade565b9250506020610b5985828601610b11565b9150509250929050565b5f8115159050919050565b610b7781610b63565b82525050565b5f602082019050610b905f830184610b6e565b92915050565b610b9f81610af2565b82525050565b5f602082019050610bb85f830184610b96565b92915050565b5f805f60608486031215610bd557610bd4610a94565b5b5f610be286828701610ade565b9350506020610bf386828701610ade565b9250506040610c0486828701610b11565b9150509250925092565b5f60ff82169050919050565b610c2381610c0e565b82525050565b5f602082019050610c3c5f830184610c1a565b92915050565b5f60208284031215610c5757610c56610a94565b5b5f610c6484828501610ade565b91505092915050565b5f8060408385031215610c8357610c82610a94565b5b5f610c9085828601610ade565b9250506020610ca185828601610ade565b9150509250929050565b7f4e487b71000000000000000000000000000000000000000000000000000000005f52602260045260245ffd5b5f6002820490506001821680610cef57607f821691505b602082108103610d0257610d01610cab565b5b50919050565b610d1181610ab7565b82525050565b5f606082019050610d2a5f830186610d08565b610d376020830185610b96565b610d446040830184610b96565b949350505050565b5f602082019050610d5f5f830184610d08565b92915050565b7f4e487b71000000000000000000000000000000000000000000000000000000005f52601160045260245ffd5b5f610d9c82610af2565b9150610da783610af2565b9250828201905080821115610dbf57610dbe610d65565b5b9291505056fea264697066735822122055b5ce6d6026c56b28a641568d3e9a6c81fb1079127f85ede16ed31d67d3eff464736f6c63430008160033"`, `undefined`\> -Bytecode and ABI for the ERC20 contract from open zeppelin. +Bytecode and ABI for the ERC20 contract from OpenZeppelin. +This constant represents a standard ERC20 token implementation. + +## Examples + +Using the ERC20 contract in a deployment script: +```typescript +import { ERC20 } from 'tevm/contract' + +// Deploy the ERC20 contract +const deployedERC20 = await tevm.deployContract(ERC20.deploy('MyToken', 'MTK')) +console.log('ERC20 deployed at:', deployedERC20.address) + +// Interact with the deployed contract +const balance = await tevm.contract(ERC20.read.balanceOf(deployedERC20.address, '0x1234...')) +console.log('Balance:', balance) +``` + +Using the ERC20 contract with an existing deployment: +```typescript +import { ERC20 } from 'tevm/contract' + +const existingERC20 = ERC20.withAddress('0x1234...') + +// Read token name +const name = await tevm.contract(existingERC20.read.name()) +console.log('Token name:', name) + +// Transfer tokens +await tevm.contract(existingERC20.write.transfer('0x5678...', 1000n)) +``` ## Defined in -[contract-lib/ERC20.ts:32](https://github.com/evmts/tevm-monorepo/blob/main/packages/contract/src/contract-lib/ERC20.ts#L32) +[contract-lib/ERC20.ts:62](https://github.com/evmts/tevm-monorepo/blob/main/packages/contract/src/contract-lib/ERC20.ts#L62) diff --git a/packages/contract/docs/variables/ERC721.md b/packages/contract/docs/variables/ERC721.md index 9b442856e9..04dce41b9f 100644 --- a/packages/contract/docs/variables/ERC721.md +++ b/packages/contract/docs/variables/ERC721.md @@ -8,8 +8,39 @@ > `const` **ERC721**: [`Contract`](../type-aliases/Contract.md)\<`"OzERC721"`, readonly [`"constructor(string name, string symbol)"`, `"error ERC721IncorrectOwner(address sender, uint256 tokenId, address owner)"`, `"error ERC721InsufficientApproval(address operator, uint256 tokenId)"`, `"error ERC721InvalidApprover(address approver)"`, `"error ERC721InvalidOperator(address operator)"`, `"error ERC721InvalidOwner(address owner)"`, `"error ERC721InvalidReceiver(address receiver)"`, `"error ERC721InvalidSender(address sender)"`, `"error ERC721NonexistentToken(uint256 tokenId)"`, `"event Approval(address indexed owner, address indexed approved, uint256 indexed tokenId)"`, `"event ApprovalForAll(address indexed owner, address indexed operator, bool approved)"`, `"event Transfer(address indexed from, address indexed to, uint256 indexed tokenId)"`, `"function approve(address to, uint256 tokenId)"`, `"function balanceOf(address owner) view returns (uint256)"`, `"function getApproved(uint256 tokenId) view returns (address)"`, `"function isApprovedForAll(address owner, address operator) view returns (bool)"`, `"function name() view returns (string)"`, `"function ownerOf(uint256 tokenId) view returns (address)"`, `"function safeTransferFrom(address from, address to, uint256 tokenId)"`, `"function safeTransferFrom(address from, address to, uint256 tokenId, bytes data)"`, `"function setApprovalForAll(address operator, bool approved)"`, `"function supportsInterface(bytes4 interfaceId) view returns (bool)"`, `"function symbol() view returns (string)"`, `"function tokenURI(uint256 tokenId) view returns (string)"`, `"function transferFrom(address from, address to, uint256 tokenId)"`], `undefined`, `"0x608060405234801562000010575f80fd5b5060405162002174380380620021748339818101604052810190620000369190620001ea565b8181815f9081620000489190620004a4565b5080600190816200005a9190620004a4565b505050505062000588565b5f604051905090565b5f80fd5b5f80fd5b5f80fd5b5f80fd5b5f601f19601f8301169050919050565b7f4e487b71000000000000000000000000000000000000000000000000000000005f52604160045260245ffd5b620000c6826200007e565b810181811067ffffffffffffffff82111715620000e857620000e76200008e565b5b80604052505050565b5f620000fc62000065565b90506200010a8282620000bb565b919050565b5f67ffffffffffffffff8211156200012c576200012b6200008e565b5b62000137826200007e565b9050602081019050919050565b5f5b838110156200016357808201518184015260208101905062000146565b5f8484015250505050565b5f620001846200017e846200010f565b620000f1565b905082815260208101848484011115620001a357620001a26200007a565b5b620001b084828562000144565b509392505050565b5f82601f830112620001cf57620001ce62000076565b5b8151620001e18482602086016200016e565b91505092915050565b5f80604083850312156200020357620002026200006e565b5b5f83015167ffffffffffffffff81111562000223576200022262000072565b5b6200023185828601620001b8565b925050602083015167ffffffffffffffff81111562000255576200025462000072565b5b6200026385828601620001b8565b9150509250929050565b5f81519050919050565b7f4e487b71000000000000000000000000000000000000000000000000000000005f52602260045260245ffd5b5f6002820490506001821680620002bc57607f821691505b602082108103620002d257620002d162000277565b5b50919050565b5f819050815f5260205f209050919050565b5f6020601f8301049050919050565b5f82821b905092915050565b5f60088302620003367fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff82620002f9565b620003428683620002f9565b95508019841693508086168417925050509392505050565b5f819050919050565b5f819050919050565b5f6200038c6200038662000380846200035a565b62000363565b6200035a565b9050919050565b5f819050919050565b620003a7836200036c565b620003bf620003b68262000393565b84845462000305565b825550505050565b5f90565b620003d5620003c7565b620003e28184846200039c565b505050565b5b818110156200040957620003fd5f82620003cb565b600181019050620003e8565b5050565b601f82111562000458576200042281620002d8565b6200042d84620002ea565b810160208510156200043d578190505b620004556200044c85620002ea565b830182620003e7565b50505b505050565b5f82821c905092915050565b5f6200047a5f19846008026200045d565b1980831691505092915050565b5f62000494838362000469565b9150826002028217905092915050565b620004af826200026d565b67ffffffffffffffff811115620004cb57620004ca6200008e565b5b620004d78254620002a4565b620004e48282856200040d565b5f60209050601f8311600181146200051a575f841562000505578287015190505b62000511858262000487565b86555062000580565b601f1984166200052a86620002d8565b5f5b8281101562000553578489015182556001820191506020850194506020810190506200052c565b868310156200057357848901516200056f601f89168262000469565b8355505b6001600288020188555050505b505050505050565b611bde80620005965f395ff3fe608060405234801561000f575f80fd5b50600436106100cd575f3560e01c80636352211e1161008a578063a22cb46511610064578063a22cb46514610221578063b88d4fde1461023d578063c87b56dd14610259578063e985e9c514610289576100cd565b80636352211e146101a357806370a08231146101d357806395d89b4114610203576100cd565b806301ffc9a7146100d157806306fdde0314610101578063081812fc1461011f578063095ea7b31461014f57806323b872dd1461016b57806342842e0e14610187575b5f80fd5b6100eb60048036038101906100e6919061146f565b6102b9565b6040516100f891906114b4565b60405180910390f35b61010961039a565b6040516101169190611557565b60405180910390f35b610139600480360381019061013491906115aa565b610429565b6040516101469190611614565b60405180910390f35b61016960048036038101906101649190611657565b610444565b005b61018560048036038101906101809190611695565b61045a565b005b6101a1600480360381019061019c9190611695565b610559565b005b6101bd60048036038101906101b891906115aa565b610578565b6040516101ca9190611614565b60405180910390f35b6101ed60048036038101906101e891906116e5565b610589565b6040516101fa919061171f565b60405180910390f35b61020b61063f565b6040516102189190611557565b60405180910390f35b61023b60048036038101906102369190611762565b6106cf565b005b610257600480360381019061025291906118cc565b6106e5565b005b610273600480360381019061026e91906115aa565b610702565b6040516102809190611557565b60405180910390f35b6102a3600480360381019061029e919061194c565b610768565b6040516102b091906114b4565b60405180910390f35b5f7f80ac58cd000000000000000000000000000000000000000000000000000000007bffffffffffffffffffffffffffffffffffffffffffffffffffffffff1916827bffffffffffffffffffffffffffffffffffffffffffffffffffffffff1916148061038357507f5b5e139f000000000000000000000000000000000000000000000000000000007bffffffffffffffffffffffffffffffffffffffffffffffffffffffff1916827bffffffffffffffffffffffffffffffffffffffffffffffffffffffff1916145b806103935750610392826107f6565b5b9050919050565b60605f80546103a8906119b7565b80601f01602080910402602001604051908101604052809291908181526020018280546103d4906119b7565b801561041f5780601f106103f65761010080835404028352916020019161041f565b820191905f5260205f20905b81548152906001019060200180831161040257829003601f168201915b5050505050905090565b5f6104338261085f565b5061043d826108e5565b9050919050565b610456828261045161091e565b610925565b5050565b5f73ffffffffffffffffffffffffffffffffffffffff168273ffffffffffffffffffffffffffffffffffffffff16036104ca575f6040517f64a0ae920000000000000000000000000000000000000000000000000000000081526004016104c19190611614565b60405180910390fd5b5f6104dd83836104d861091e565b610937565b90508373ffffffffffffffffffffffffffffffffffffffff168173ffffffffffffffffffffffffffffffffffffffff1614610553578382826040517f64283d7b00000000000000000000000000000000000000000000000000000000815260040161054a939291906119e7565b60405180910390fd5b50505050565b61057383838360405180602001604052805f8152506106e5565b505050565b5f6105828261085f565b9050919050565b5f8073ffffffffffffffffffffffffffffffffffffffff168273ffffffffffffffffffffffffffffffffffffffff16036105fa575f6040517f89c62b640000000000000000000000000000000000000000000000000000000081526004016105f19190611614565b60405180910390fd5b60035f8373ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f20549050919050565b60606001805461064e906119b7565b80601f016020809104026020016040519081016040528092919081815260200182805461067a906119b7565b80156106c55780601f1061069c576101008083540402835291602001916106c5565b820191905f5260205f20905b8154815290600101906020018083116106a857829003601f168201915b5050505050905090565b6106e16106da61091e565b8383610b42565b5050565b6106f084848461045a565b6106fc84848484610cab565b50505050565b606061070d8261085f565b505f610717610e5d565b90505f8151116107355760405180602001604052805f815250610760565b8061073f84610e73565b604051602001610750929190611a56565b6040516020818303038152906040525b915050919050565b5f60055f8473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f8373ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f9054906101000a900460ff16905092915050565b5f7f01ffc9a7000000000000000000000000000000000000000000000000000000007bffffffffffffffffffffffffffffffffffffffffffffffffffffffff1916827bffffffffffffffffffffffffffffffffffffffffffffffffffffffff1916149050919050565b5f8061086a83610f3d565b90505f73ffffffffffffffffffffffffffffffffffffffff168173ffffffffffffffffffffffffffffffffffffffff16036108dc57826040517f7e2732890000000000000000000000000000000000000000000000000000000081526004016108d3919061171f565b60405180910390fd5b80915050919050565b5f60045f8381526020019081526020015f205f9054906101000a900473ffffffffffffffffffffffffffffffffffffffff169050919050565b5f33905090565b6109328383836001610f76565b505050565b5f8061094284610f3d565b90505f73ffffffffffffffffffffffffffffffffffffffff168373ffffffffffffffffffffffffffffffffffffffff161461098357610982818486611135565b5b5f73ffffffffffffffffffffffffffffffffffffffff168173ffffffffffffffffffffffffffffffffffffffff1614610a0e576109c25f855f80610f76565b600160035f8373ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f82825403925050819055505b5f73ffffffffffffffffffffffffffffffffffffffff168573ffffffffffffffffffffffffffffffffffffffff1614610a8d57600160035f8773ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f82825401925050819055505b8460025f8681526020019081526020015f205f6101000a81548173ffffffffffffffffffffffffffffffffffffffff021916908373ffffffffffffffffffffffffffffffffffffffff160217905550838573ffffffffffffffffffffffffffffffffffffffff168273ffffffffffffffffffffffffffffffffffffffff167fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef60405160405180910390a4809150509392505050565b5f73ffffffffffffffffffffffffffffffffffffffff168273ffffffffffffffffffffffffffffffffffffffff1603610bb257816040517f5b08ba18000000000000000000000000000000000000000000000000000000008152600401610ba99190611614565b60405180910390fd5b8060055f8573ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f8473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f6101000a81548160ff0219169083151502179055508173ffffffffffffffffffffffffffffffffffffffff168373ffffffffffffffffffffffffffffffffffffffff167f17307eab39ab6107e8899845ad3d59bd9653f200f220920489ca2b5937696c3183604051610c9e91906114b4565b60405180910390a3505050565b5f8373ffffffffffffffffffffffffffffffffffffffff163b1115610e57578273ffffffffffffffffffffffffffffffffffffffff1663150b7a02610cee61091e565b8685856040518563ffffffff1660e01b8152600401610d109493929190611acb565b6020604051808303815f875af1925050508015610d4b57506040513d601f19601f82011682018060405250810190610d489190611b29565b60015b610dcc573d805f8114610d79576040519150601f19603f3d011682016040523d82523d5f602084013e610d7e565b606091505b505f815103610dc457836040517f64a0ae92000000000000000000000000000000000000000000000000000000008152600401610dbb9190611614565b60405180910390fd5b805181602001fd5b63150b7a0260e01b7bffffffffffffffffffffffffffffffffffffffffffffffffffffffff1916817bffffffffffffffffffffffffffffffffffffffffffffffffffffffff191614610e5557836040517f64a0ae92000000000000000000000000000000000000000000000000000000008152600401610e4c9190611614565b60405180910390fd5b505b50505050565b606060405180602001604052805f815250905090565b60605f6001610e81846111f8565b0190505f8167ffffffffffffffff811115610e9f57610e9e6117a8565b5b6040519080825280601f01601f191660200182016040528015610ed15781602001600182028036833780820191505090505b5090505f82602001820190505b600115610f32578080600190039150507f3031323334353637383961626364656600000000000000000000000000000000600a86061a8153600a8581610f2757610f26611b54565b5b0494505f8503610ede575b819350505050919050565b5f60025f8381526020019081526020015f205f9054906101000a900473ffffffffffffffffffffffffffffffffffffffff169050919050565b8080610fae57505f73ffffffffffffffffffffffffffffffffffffffff168273ffffffffffffffffffffffffffffffffffffffff1614155b156110e0575f610fbd8461085f565b90505f73ffffffffffffffffffffffffffffffffffffffff168373ffffffffffffffffffffffffffffffffffffffff161415801561102757508273ffffffffffffffffffffffffffffffffffffffff168173ffffffffffffffffffffffffffffffffffffffff1614155b801561103a57506110388184610768565b155b1561107c57826040517fa9fbf51f0000000000000000000000000000000000000000000000000000000081526004016110739190611614565b60405180910390fd5b81156110de57838573ffffffffffffffffffffffffffffffffffffffff168273ffffffffffffffffffffffffffffffffffffffff167f8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b92560405160405180910390a45b505b8360045f8581526020019081526020015f205f6101000a81548173ffffffffffffffffffffffffffffffffffffffff021916908373ffffffffffffffffffffffffffffffffffffffff16021790555050505050565b611140838383611349565b6111f3575f73ffffffffffffffffffffffffffffffffffffffff168373ffffffffffffffffffffffffffffffffffffffff16036111b457806040517f7e2732890000000000000000000000000000000000000000000000000000000081526004016111ab919061171f565b60405180910390fd5b81816040517f177e802f0000000000000000000000000000000000000000000000000000000081526004016111ea929190611b81565b60405180910390fd5b505050565b5f805f90507a184f03e93ff9f4daa797ed6e38ed64bf6a1f0100000000000000008310611254577a184f03e93ff9f4daa797ed6e38ed64bf6a1f010000000000000000838161124a57611249611b54565b5b0492506040810190505b6d04ee2d6d415b85acef81000000008310611291576d04ee2d6d415b85acef8100000000838161128757611286611b54565b5b0492506020810190505b662386f26fc1000083106112c057662386f26fc1000083816112b6576112b5611b54565b5b0492506010810190505b6305f5e10083106112e9576305f5e10083816112df576112de611b54565b5b0492506008810190505b612710831061130e57612710838161130457611303611b54565b5b0492506004810190505b60648310611331576064838161132757611326611b54565b5b0492506002810190505b600a8310611340576001810190505b80915050919050565b5f8073ffffffffffffffffffffffffffffffffffffffff168373ffffffffffffffffffffffffffffffffffffffff161415801561140057508273ffffffffffffffffffffffffffffffffffffffff168473ffffffffffffffffffffffffffffffffffffffff1614806113c157506113c08484610768565b5b806113ff57508273ffffffffffffffffffffffffffffffffffffffff166113e7836108e5565b73ffffffffffffffffffffffffffffffffffffffff16145b5b90509392505050565b5f604051905090565b5f80fd5b5f80fd5b5f7fffffffff0000000000000000000000000000000000000000000000000000000082169050919050565b61144e8161141a565b8114611458575f80fd5b50565b5f8135905061146981611445565b92915050565b5f6020828403121561148457611483611412565b5b5f6114918482850161145b565b91505092915050565b5f8115159050919050565b6114ae8161149a565b82525050565b5f6020820190506114c75f8301846114a5565b92915050565b5f81519050919050565b5f82825260208201905092915050565b5f5b838110156115045780820151818401526020810190506114e9565b5f8484015250505050565b5f601f19601f8301169050919050565b5f611529826114cd565b61153381856114d7565b93506115438185602086016114e7565b61154c8161150f565b840191505092915050565b5f6020820190508181035f83015261156f818461151f565b905092915050565b5f819050919050565b61158981611577565b8114611593575f80fd5b50565b5f813590506115a481611580565b92915050565b5f602082840312156115bf576115be611412565b5b5f6115cc84828501611596565b91505092915050565b5f73ffffffffffffffffffffffffffffffffffffffff82169050919050565b5f6115fe826115d5565b9050919050565b61160e816115f4565b82525050565b5f6020820190506116275f830184611605565b92915050565b611636816115f4565b8114611640575f80fd5b50565b5f813590506116518161162d565b92915050565b5f806040838503121561166d5761166c611412565b5b5f61167a85828601611643565b925050602061168b85828601611596565b9150509250929050565b5f805f606084860312156116ac576116ab611412565b5b5f6116b986828701611643565b93505060206116ca86828701611643565b92505060406116db86828701611596565b9150509250925092565b5f602082840312156116fa576116f9611412565b5b5f61170784828501611643565b91505092915050565b61171981611577565b82525050565b5f6020820190506117325f830184611710565b92915050565b6117418161149a565b811461174b575f80fd5b50565b5f8135905061175c81611738565b92915050565b5f806040838503121561177857611777611412565b5b5f61178585828601611643565b92505060206117968582860161174e565b9150509250929050565b5f80fd5b5f80fd5b7f4e487b71000000000000000000000000000000000000000000000000000000005f52604160045260245ffd5b6117de8261150f565b810181811067ffffffffffffffff821117156117fd576117fc6117a8565b5b80604052505050565b5f61180f611409565b905061181b82826117d5565b919050565b5f67ffffffffffffffff82111561183a576118396117a8565b5b6118438261150f565b9050602081019050919050565b828183375f83830152505050565b5f61187061186b84611820565b611806565b90508281526020810184848401111561188c5761188b6117a4565b5b611897848285611850565b509392505050565b5f82601f8301126118b3576118b26117a0565b5b81356118c384826020860161185e565b91505092915050565b5f805f80608085870312156118e4576118e3611412565b5b5f6118f187828801611643565b945050602061190287828801611643565b935050604061191387828801611596565b925050606085013567ffffffffffffffff81111561193457611933611416565b5b6119408782880161189f565b91505092959194509250565b5f806040838503121561196257611961611412565b5b5f61196f85828601611643565b925050602061198085828601611643565b9150509250929050565b7f4e487b71000000000000000000000000000000000000000000000000000000005f52602260045260245ffd5b5f60028204905060018216806119ce57607f821691505b6020821081036119e1576119e061198a565b5b50919050565b5f6060820190506119fa5f830186611605565b611a076020830185611710565b611a146040830184611605565b949350505050565b5f81905092915050565b5f611a30826114cd565b611a3a8185611a1c565b9350611a4a8185602086016114e7565b80840191505092915050565b5f611a618285611a26565b9150611a6d8284611a26565b91508190509392505050565b5f81519050919050565b5f82825260208201905092915050565b5f611a9d82611a79565b611aa78185611a83565b9350611ab78185602086016114e7565b611ac08161150f565b840191505092915050565b5f608082019050611ade5f830187611605565b611aeb6020830186611605565b611af86040830185611710565b8181036060830152611b0a8184611a93565b905095945050505050565b5f81519050611b2381611445565b92915050565b5f60208284031215611b3e57611b3d611412565b5b5f611b4b84828501611b15565b91505092915050565b7f4e487b71000000000000000000000000000000000000000000000000000000005f52601260045260245ffd5b5f604082019050611b945f830185611605565b611ba16020830184611710565b939250505056fea2646970667358221220660c47cef4875784ced30d2987fb0203ddda8f97b11c21c4a3205a82e611b4d064736f6c63430008160033"`, `"0x608060405234801561000f575f80fd5b50600436106100cd575f3560e01c80636352211e1161008a578063a22cb46511610064578063a22cb46514610221578063b88d4fde1461023d578063c87b56dd14610259578063e985e9c514610289576100cd565b80636352211e146101a357806370a08231146101d357806395d89b4114610203576100cd565b806301ffc9a7146100d157806306fdde0314610101578063081812fc1461011f578063095ea7b31461014f57806323b872dd1461016b57806342842e0e14610187575b5f80fd5b6100eb60048036038101906100e6919061146f565b6102b9565b6040516100f891906114b4565b60405180910390f35b61010961039a565b6040516101169190611557565b60405180910390f35b610139600480360381019061013491906115aa565b610429565b6040516101469190611614565b60405180910390f35b61016960048036038101906101649190611657565b610444565b005b61018560048036038101906101809190611695565b61045a565b005b6101a1600480360381019061019c9190611695565b610559565b005b6101bd60048036038101906101b891906115aa565b610578565b6040516101ca9190611614565b60405180910390f35b6101ed60048036038101906101e891906116e5565b610589565b6040516101fa919061171f565b60405180910390f35b61020b61063f565b6040516102189190611557565b60405180910390f35b61023b60048036038101906102369190611762565b6106cf565b005b610257600480360381019061025291906118cc565b6106e5565b005b610273600480360381019061026e91906115aa565b610702565b6040516102809190611557565b60405180910390f35b6102a3600480360381019061029e919061194c565b610768565b6040516102b091906114b4565b60405180910390f35b5f7f80ac58cd000000000000000000000000000000000000000000000000000000007bffffffffffffffffffffffffffffffffffffffffffffffffffffffff1916827bffffffffffffffffffffffffffffffffffffffffffffffffffffffff1916148061038357507f5b5e139f000000000000000000000000000000000000000000000000000000007bffffffffffffffffffffffffffffffffffffffffffffffffffffffff1916827bffffffffffffffffffffffffffffffffffffffffffffffffffffffff1916145b806103935750610392826107f6565b5b9050919050565b60605f80546103a8906119b7565b80601f01602080910402602001604051908101604052809291908181526020018280546103d4906119b7565b801561041f5780601f106103f65761010080835404028352916020019161041f565b820191905f5260205f20905b81548152906001019060200180831161040257829003601f168201915b5050505050905090565b5f6104338261085f565b5061043d826108e5565b9050919050565b610456828261045161091e565b610925565b5050565b5f73ffffffffffffffffffffffffffffffffffffffff168273ffffffffffffffffffffffffffffffffffffffff16036104ca575f6040517f64a0ae920000000000000000000000000000000000000000000000000000000081526004016104c19190611614565b60405180910390fd5b5f6104dd83836104d861091e565b610937565b90508373ffffffffffffffffffffffffffffffffffffffff168173ffffffffffffffffffffffffffffffffffffffff1614610553578382826040517f64283d7b00000000000000000000000000000000000000000000000000000000815260040161054a939291906119e7565b60405180910390fd5b50505050565b61057383838360405180602001604052805f8152506106e5565b505050565b5f6105828261085f565b9050919050565b5f8073ffffffffffffffffffffffffffffffffffffffff168273ffffffffffffffffffffffffffffffffffffffff16036105fa575f6040517f89c62b640000000000000000000000000000000000000000000000000000000081526004016105f19190611614565b60405180910390fd5b60035f8373ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f20549050919050565b60606001805461064e906119b7565b80601f016020809104026020016040519081016040528092919081815260200182805461067a906119b7565b80156106c55780601f1061069c576101008083540402835291602001916106c5565b820191905f5260205f20905b8154815290600101906020018083116106a857829003601f168201915b5050505050905090565b6106e16106da61091e565b8383610b42565b5050565b6106f084848461045a565b6106fc84848484610cab565b50505050565b606061070d8261085f565b505f610717610e5d565b90505f8151116107355760405180602001604052805f815250610760565b8061073f84610e73565b604051602001610750929190611a56565b6040516020818303038152906040525b915050919050565b5f60055f8473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f8373ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f9054906101000a900460ff16905092915050565b5f7f01ffc9a7000000000000000000000000000000000000000000000000000000007bffffffffffffffffffffffffffffffffffffffffffffffffffffffff1916827bffffffffffffffffffffffffffffffffffffffffffffffffffffffff1916149050919050565b5f8061086a83610f3d565b90505f73ffffffffffffffffffffffffffffffffffffffff168173ffffffffffffffffffffffffffffffffffffffff16036108dc57826040517f7e2732890000000000000000000000000000000000000000000000000000000081526004016108d3919061171f565b60405180910390fd5b80915050919050565b5f60045f8381526020019081526020015f205f9054906101000a900473ffffffffffffffffffffffffffffffffffffffff169050919050565b5f33905090565b6109328383836001610f76565b505050565b5f8061094284610f3d565b90505f73ffffffffffffffffffffffffffffffffffffffff168373ffffffffffffffffffffffffffffffffffffffff161461098357610982818486611135565b5b5f73ffffffffffffffffffffffffffffffffffffffff168173ffffffffffffffffffffffffffffffffffffffff1614610a0e576109c25f855f80610f76565b600160035f8373ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f82825403925050819055505b5f73ffffffffffffffffffffffffffffffffffffffff168573ffffffffffffffffffffffffffffffffffffffff1614610a8d57600160035f8773ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f82825401925050819055505b8460025f8681526020019081526020015f205f6101000a81548173ffffffffffffffffffffffffffffffffffffffff021916908373ffffffffffffffffffffffffffffffffffffffff160217905550838573ffffffffffffffffffffffffffffffffffffffff168273ffffffffffffffffffffffffffffffffffffffff167fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef60405160405180910390a4809150509392505050565b5f73ffffffffffffffffffffffffffffffffffffffff168273ffffffffffffffffffffffffffffffffffffffff1603610bb257816040517f5b08ba18000000000000000000000000000000000000000000000000000000008152600401610ba99190611614565b60405180910390fd5b8060055f8573ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f8473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f6101000a81548160ff0219169083151502179055508173ffffffffffffffffffffffffffffffffffffffff168373ffffffffffffffffffffffffffffffffffffffff167f17307eab39ab6107e8899845ad3d59bd9653f200f220920489ca2b5937696c3183604051610c9e91906114b4565b60405180910390a3505050565b5f8373ffffffffffffffffffffffffffffffffffffffff163b1115610e57578273ffffffffffffffffffffffffffffffffffffffff1663150b7a02610cee61091e565b8685856040518563ffffffff1660e01b8152600401610d109493929190611acb565b6020604051808303815f875af1925050508015610d4b57506040513d601f19601f82011682018060405250810190610d489190611b29565b60015b610dcc573d805f8114610d79576040519150601f19603f3d011682016040523d82523d5f602084013e610d7e565b606091505b505f815103610dc457836040517f64a0ae92000000000000000000000000000000000000000000000000000000008152600401610dbb9190611614565b60405180910390fd5b805181602001fd5b63150b7a0260e01b7bffffffffffffffffffffffffffffffffffffffffffffffffffffffff1916817bffffffffffffffffffffffffffffffffffffffffffffffffffffffff191614610e5557836040517f64a0ae92000000000000000000000000000000000000000000000000000000008152600401610e4c9190611614565b60405180910390fd5b505b50505050565b606060405180602001604052805f815250905090565b60605f6001610e81846111f8565b0190505f8167ffffffffffffffff811115610e9f57610e9e6117a8565b5b6040519080825280601f01601f191660200182016040528015610ed15781602001600182028036833780820191505090505b5090505f82602001820190505b600115610f32578080600190039150507f3031323334353637383961626364656600000000000000000000000000000000600a86061a8153600a8581610f2757610f26611b54565b5b0494505f8503610ede575b819350505050919050565b5f60025f8381526020019081526020015f205f9054906101000a900473ffffffffffffffffffffffffffffffffffffffff169050919050565b8080610fae57505f73ffffffffffffffffffffffffffffffffffffffff168273ffffffffffffffffffffffffffffffffffffffff1614155b156110e0575f610fbd8461085f565b90505f73ffffffffffffffffffffffffffffffffffffffff168373ffffffffffffffffffffffffffffffffffffffff161415801561102757508273ffffffffffffffffffffffffffffffffffffffff168173ffffffffffffffffffffffffffffffffffffffff1614155b801561103a57506110388184610768565b155b1561107c57826040517fa9fbf51f0000000000000000000000000000000000000000000000000000000081526004016110739190611614565b60405180910390fd5b81156110de57838573ffffffffffffffffffffffffffffffffffffffff168273ffffffffffffffffffffffffffffffffffffffff167f8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b92560405160405180910390a45b505b8360045f8581526020019081526020015f205f6101000a81548173ffffffffffffffffffffffffffffffffffffffff021916908373ffffffffffffffffffffffffffffffffffffffff16021790555050505050565b611140838383611349565b6111f3575f73ffffffffffffffffffffffffffffffffffffffff168373ffffffffffffffffffffffffffffffffffffffff16036111b457806040517f7e2732890000000000000000000000000000000000000000000000000000000081526004016111ab919061171f565b60405180910390fd5b81816040517f177e802f0000000000000000000000000000000000000000000000000000000081526004016111ea929190611b81565b60405180910390fd5b505050565b5f805f90507a184f03e93ff9f4daa797ed6e38ed64bf6a1f0100000000000000008310611254577a184f03e93ff9f4daa797ed6e38ed64bf6a1f010000000000000000838161124a57611249611b54565b5b0492506040810190505b6d04ee2d6d415b85acef81000000008310611291576d04ee2d6d415b85acef8100000000838161128757611286611b54565b5b0492506020810190505b662386f26fc1000083106112c057662386f26fc1000083816112b6576112b5611b54565b5b0492506010810190505b6305f5e10083106112e9576305f5e10083816112df576112de611b54565b5b0492506008810190505b612710831061130e57612710838161130457611303611b54565b5b0492506004810190505b60648310611331576064838161132757611326611b54565b5b0492506002810190505b600a8310611340576001810190505b80915050919050565b5f8073ffffffffffffffffffffffffffffffffffffffff168373ffffffffffffffffffffffffffffffffffffffff161415801561140057508273ffffffffffffffffffffffffffffffffffffffff168473ffffffffffffffffffffffffffffffffffffffff1614806113c157506113c08484610768565b5b806113ff57508273ffffffffffffffffffffffffffffffffffffffff166113e7836108e5565b73ffffffffffffffffffffffffffffffffffffffff16145b5b90509392505050565b5f604051905090565b5f80fd5b5f80fd5b5f7fffffffff0000000000000000000000000000000000000000000000000000000082169050919050565b61144e8161141a565b8114611458575f80fd5b50565b5f8135905061146981611445565b92915050565b5f6020828403121561148457611483611412565b5b5f6114918482850161145b565b91505092915050565b5f8115159050919050565b6114ae8161149a565b82525050565b5f6020820190506114c75f8301846114a5565b92915050565b5f81519050919050565b5f82825260208201905092915050565b5f5b838110156115045780820151818401526020810190506114e9565b5f8484015250505050565b5f601f19601f8301169050919050565b5f611529826114cd565b61153381856114d7565b93506115438185602086016114e7565b61154c8161150f565b840191505092915050565b5f6020820190508181035f83015261156f818461151f565b905092915050565b5f819050919050565b61158981611577565b8114611593575f80fd5b50565b5f813590506115a481611580565b92915050565b5f602082840312156115bf576115be611412565b5b5f6115cc84828501611596565b91505092915050565b5f73ffffffffffffffffffffffffffffffffffffffff82169050919050565b5f6115fe826115d5565b9050919050565b61160e816115f4565b82525050565b5f6020820190506116275f830184611605565b92915050565b611636816115f4565b8114611640575f80fd5b50565b5f813590506116518161162d565b92915050565b5f806040838503121561166d5761166c611412565b5b5f61167a85828601611643565b925050602061168b85828601611596565b9150509250929050565b5f805f606084860312156116ac576116ab611412565b5b5f6116b986828701611643565b93505060206116ca86828701611643565b92505060406116db86828701611596565b9150509250925092565b5f602082840312156116fa576116f9611412565b5b5f61170784828501611643565b91505092915050565b61171981611577565b82525050565b5f6020820190506117325f830184611710565b92915050565b6117418161149a565b811461174b575f80fd5b50565b5f8135905061175c81611738565b92915050565b5f806040838503121561177857611777611412565b5b5f61178585828601611643565b92505060206117968582860161174e565b9150509250929050565b5f80fd5b5f80fd5b7f4e487b71000000000000000000000000000000000000000000000000000000005f52604160045260245ffd5b6117de8261150f565b810181811067ffffffffffffffff821117156117fd576117fc6117a8565b5b80604052505050565b5f61180f611409565b905061181b82826117d5565b919050565b5f67ffffffffffffffff82111561183a576118396117a8565b5b6118438261150f565b9050602081019050919050565b828183375f83830152505050565b5f61187061186b84611820565b611806565b90508281526020810184848401111561188c5761188b6117a4565b5b611897848285611850565b509392505050565b5f82601f8301126118b3576118b26117a0565b5b81356118c384826020860161185e565b91505092915050565b5f805f80608085870312156118e4576118e3611412565b5b5f6118f187828801611643565b945050602061190287828801611643565b935050604061191387828801611596565b925050606085013567ffffffffffffffff81111561193457611933611416565b5b6119408782880161189f565b91505092959194509250565b5f806040838503121561196257611961611412565b5b5f61196f85828601611643565b925050602061198085828601611643565b9150509250929050565b7f4e487b71000000000000000000000000000000000000000000000000000000005f52602260045260245ffd5b5f60028204905060018216806119ce57607f821691505b6020821081036119e1576119e061198a565b5b50919050565b5f6060820190506119fa5f830186611605565b611a076020830185611710565b611a146040830184611605565b949350505050565b5f81905092915050565b5f611a30826114cd565b611a3a8185611a1c565b9350611a4a8185602086016114e7565b80840191505092915050565b5f611a618285611a26565b9150611a6d8284611a26565b91508190509392505050565b5f81519050919050565b5f82825260208201905092915050565b5f611a9d82611a79565b611aa78185611a83565b9350611ab78185602086016114e7565b611ac08161150f565b840191505092915050565b5f608082019050611ade5f830187611605565b611aeb6020830186611605565b611af86040830185611710565b8181036060830152611b0a8184611a93565b905095945050505050565b5f81519050611b2381611445565b92915050565b5f60208284031215611b3e57611b3d611412565b5b5f611b4b84828501611b15565b91505092915050565b7f4e487b71000000000000000000000000000000000000000000000000000000005f52601260045260245ffd5b5f604082019050611b945f830185611605565b611ba16020830184611710565b939250505056fea2646970667358221220660c47cef4875784ced30d2987fb0203ddda8f97b11c21c4a3205a82e611b4d064736f6c63430008160033"`, `undefined`\> -Bytecode and ABI for the ERC721 contract from open zeppelin. +Bytecode and ABI for the ERC721 contract from OpenZeppelin. +This constant represents a standard ERC721 token implementation for non-fungible tokens (NFTs). +For more details, see the [OpenZeppelin ERC721 documentation](https://docs.openzeppelin.com/contracts/4.x/erc721). + +## Examples + +Using the ERC721 contract in a deployment script: +```typescript +import { ERC721 } from 'tevm/contract' + +// Deploy the ERC721 contract +const deployedERC721 = await tevm.deployContract(ERC721.deploy('MyNFT', 'MNFT')) +console.log('ERC721 deployed at:', deployedERC721.address) + +// Interact with the deployed contract +const owner = await tevm.contract(ERC721.read.ownerOf(deployedERC721.address, 1n)) +console.log('Owner of token 1:', owner) +``` + +Using the ERC721 contract with an existing deployment: +```typescript +import { ERC721 } from 'tevm/contract' + +const existingERC721 = ERC721.withAddress('0x1234...') + +// Read token name +const name = await tevm.contract(existingERC721.read.name()) +console.log('Token name:', name) + +// Transfer token +await tevm.contract(existingERC721.write.transferFrom('0xabcd...', '0x5678...', 1n)) +``` ## Defined in -[contract-lib/ERC721.ts:39](https://github.com/evmts/tevm-monorepo/blob/main/packages/contract/src/contract-lib/ERC721.ts#L39) +[contract-lib/ERC721.ts:71](https://github.com/evmts/tevm-monorepo/blob/main/packages/contract/src/contract-lib/ERC721.ts#L71) diff --git a/packages/contract/docs/variables/SimpleContract.md b/packages/contract/docs/variables/SimpleContract.md index 68f6f9d6d8..64bf4b4254 100644 --- a/packages/contract/docs/variables/SimpleContract.md +++ b/packages/contract/docs/variables/SimpleContract.md @@ -8,6 +8,39 @@ > `const` **SimpleContract**: [`Contract`](../type-aliases/Contract.md)\<`"SimpleContract"`, readonly [`"constructor(uint256 initialValue)"`, `"event ValueSet(uint256 newValue)"`, `"function get() view returns (uint256)"`, `"function set(uint256 newValue)"`], `undefined`, `"0x608060405234801561000f575f80fd5b5060405161022638038061022683398181016040528101906100319190610074565b805f819055505061009f565b5f80fd5b5f819050919050565b61005381610041565b811461005d575f80fd5b50565b5f8151905061006e8161004a565b92915050565b5f602082840312156100895761008861003d565b5b5f61009684828501610060565b91505092915050565b61017a806100ac5f395ff3fe608060405234801561000f575f80fd5b5060043610610034575f3560e01c806360fe47b1146100385780636d4ce63c14610054575b5f80fd5b610052600480360381019061004d91906100f1565b610072565b005b61005c6100b2565b604051610069919061012b565b60405180910390f35b805f819055507f012c78e2b84325878b1bd9d250d772cfe5bda7722d795f45036fa5e1e6e303fc816040516100a7919061012b565b60405180910390a150565b5f8054905090565b5f80fd5b5f819050919050565b6100d0816100be565b81146100da575f80fd5b50565b5f813590506100eb816100c7565b92915050565b5f60208284031215610106576101056100ba565b5b5f610113848285016100dd565b91505092915050565b610125816100be565b82525050565b5f60208201905061013e5f83018461011c565b9291505056fea2646970667358221220792d4ee4a770b6a319a0ec659b77ea24497824649e20dcdea1dd7acf6118a5fe64736f6c63430008160033"`, `"0x608060405234801561000f575f80fd5b5060043610610034575f3560e01c806360fe47b1146100385780636d4ce63c14610054575b5f80fd5b610052600480360381019061004d91906100f1565b610072565b005b61005c6100b2565b604051610069919061012b565b60405180910390f35b805f819055507f012c78e2b84325878b1bd9d250d772cfe5bda7722d795f45036fa5e1e6e303fc816040516100a7919061012b565b60405180910390a150565b5f8054905090565b5f80fd5b5f819050919050565b6100d0816100be565b81146100da575f80fd5b50565b5f813590506100eb816100c7565b92915050565b5f60208284031215610106576101056100ba565b5b5f610113848285016100dd565b91505092915050565b610125816100be565b82525050565b5f60208201905061013e5f83018461011c565b9291505056fea2646970667358221220792d4ee4a770b6a319a0ec659b77ea24497824649e20dcdea1dd7acf6118a5fe64736f6c63430008160033"`, `undefined`\> +Bytecode and ABI for a simple contract with a single state variable. +This constant represents a basic contract that can get and set a uint256 value. + +## Examples + +Using the SimpleContract in a deployment script: +```typescript +import { SimpleContract } from 'tevm/contract' + +// Deploy the SimpleContract with an initial value +const deployedSimpleContract = await tevm.deployContract(SimpleContract.deploy(42n)) +console.log('SimpleContract deployed at:', deployedSimpleContract.address) + +// Interact with the deployed contract +const value = await tevm.contract(SimpleContract.read.get()) +console.log('Current value:', value) +``` + +Using the SimpleContract with an existing deployment: +```typescript +import { SimpleContract } from 'tevm/contract' + +const existingSimpleContract = SimpleContract.withAddress('0x1234...') + +// Read current value +const currentValue = await tevm.contract(existingSimpleContract.read.get()) +console.log('Current value:', currentValue) + +// Set a new value +await tevm.contract(existingSimpleContract.write.set(100n)) +console.log('New value set') +``` + ## Defined in -[contract-lib/SimpleContract.s.sol.ts:15](https://github.com/evmts/tevm-monorepo/blob/main/packages/contract/src/contract-lib/SimpleContract.s.sol.ts#L15) +[contract-lib/SimpleContract.s.sol.ts:50](https://github.com/evmts/tevm-monorepo/blob/main/packages/contract/src/contract-lib/SimpleContract.s.sol.ts#L50) diff --git a/packages/contract/package.json b/packages/contract/package.json index b960dbb2a8..d0644ad6ad 100644 --- a/packages/contract/package.json +++ b/packages/contract/package.json @@ -21,6 +21,7 @@ "contributors": [ "Will Cory " ], + "sideEffects": false, "type": "module", "exports": { "./package.json": "./package.json", @@ -76,6 +77,5 @@ }, "publishConfig": { "access": "public" - }, - "sideEffects": false + } } \ No newline at end of file diff --git a/packages/contract/src/Contract.ts b/packages/contract/src/Contract.ts index a160d97683..219ef6fefb 100644 --- a/packages/contract/src/Contract.ts +++ b/packages/contract/src/Contract.ts @@ -1,150 +1,155 @@ import type { Address, EncodeDeployDataParameters, Hex, ParseAbi } from '@tevm/utils' -import type { CreateScript } from './CreateScript.js' import type { EventActionCreator } from './event/EventActionCreator.js' import type { ReadActionCreator } from './read/ReadActionCreator.js' import type { WriteActionCreator } from './write/WriteActionCreator.js' /** - * Represents a specific contract abi and optional bytecode. + * Represents a specific contract with its ABI and optional bytecode. + * Contracts provide type-safe interfaces for interacting with smart contracts, + * including read and write methods, event filtering, and deployment. + * + * @template TName - The name of the contract + * @template THumanReadableAbi - The human-readable ABI of the contract + * @template TAddress - The address of the contract (optional) + * @template TBytecode - The creation bytecode of the contract (optional) + * @template TDeployedBytecode - The deployed bytecode of the contract (optional) + * @template TCode - The runtime bytecode of the contract (optional) + * * @example + * Creating and using a Contract instance: * ```typescript - * import {createContract} from 'tevm/contract' + * import { createContract } from 'tevm/contract' * - * const contract = createContract({ - * address, - * bytecode, - * deployedBytecode, - * humanReadableAbi, + * const MyContract = createContract({ + * name: 'MyToken', + * humanReadableAbi: [ + * 'function balanceOf(address account) view returns (uint256)', + * 'function transfer(address to, uint256 amount) returns (bool)', + * 'event Transfer(address indexed from, address indexed to, uint256 value)' + * ], + * address: '0x1234567890123456789012345678901234567890' * }) - * ``` * - * Contracts have actions creators for read methods, write methods, deploying, and events - * @example - * ```typescript - * tevm.contract( - * - { abi: [...], args: ['0x1234...'], functionName: 'balanceOf' }, - * + MyContract.read.balanceOf('0x1234...'), - * ) - * ``` + * // Read contract state + * const balanceAction = MyContract.read.balanceOf('0xabcdef...') + * const balance = await tevm.contract(balanceAction) * - * These contracts can be automatically generated by using [@tevm/bundler](https://todo.todo) - * and then importing it. The Tevm bundler will automatically resolve your solidity imports into - * tevm contract instances - * @example - * ```typescript - * import { MyContract } from './MyContract.sol' + * // Write to contract + * const transferAction = MyContract.write.transfer('0xfedcba...', 1000n) + * const result = await tevm.contract(transferAction) * - * console.log(MyContract.humanReadableAbi) + * // Create event filter + * const transferFilter = MyContract.events.Transfer({ fromBlock: 'latest' }) + * const logs = await tevm.eth.getLogs(transferFilter) * ``` - * Address can be added to a contract using the `withAddress` method - * @example - * ```typescript - * import { MyContract } from './MyContract.sol' * - * const MyContractOptimism = MyContract.withAddress('0x420...') - * ``` - * Contracts can also be used with other libraries such as Viem and ethers. * @example + * Using with other libraries: * ```typescript - * import { MyContract } from './MyContract.sol' - * import { createPublicClient } from 'viem' + * import { createPublicClient, http } from 'viem' + * import { mainnet } from 'viem/chains' * - * // see viem docs - * const client = createPublicClient({...}) + * const client = createPublicClient({ + * chain: mainnet, + * transport: http() + * }) * - * const result = await client.readContract( - * MyContract.withAddress('0x420...').read.balanceOf('0x1234...'), + * const balance = await client.readContract( + * MyContract.read.balanceOf('0xabcdef...') * ) + * ``` */ export type Contract< TName extends string, THumanReadableAbi extends ReadonlyArray, TAddress extends undefined | Address = undefined, - // Bytecode is the contract bytecode with constructor TBytecode extends undefined | Hex = undefined, - // DeployedBytecode is the raw bytecode without constructor TDeployedBytecode extends undefined | Hex = undefined, - // Code is Bytecode encoded with constructor arguments TCode extends undefined | Hex = undefined, > = { /** - * Configured address of the contract. If not set it will be undefined - * To set use the `withAddress` method + * The configured address of the contract. If not set, it will be undefined. + * Use the `withAddress` method to set or change the address. */ address: TAddress + /** - * The json abi of the contract + * The JSON ABI of the contract. * @example * ```typescript - * import { MyContract } from './MyContract.sol' - * console.log(MyContract.abi) // [{name: 'balanceOf', inputs: [...], outputs: [...], ...}] + * console.log(MyContract.abi) + * // [{name: 'balanceOf', inputs: [...], outputs: [...], ...}] * ``` */ abi: ParseAbi + /** - * Code i + * The runtime bytecode of the contract, encoded with constructor arguments. */ code: TCode + /** - * The contract bytecode is not defined on Contract objects are expected - * to be deployed to the chain. See `Script` type which is a contract with bytecode - * It's provided here to allow easier access of the property when using a - * `Contract | Script` union type + * The creation bytecode of the contract. */ bytecode: TBytecode + /** - * The contract deployedBytecode is not defined on Contract objects are expected - * to be deployed to the chain. See `Script` type which is a contract with deployedBytecode - * It's provided here to allow easier access of the property when using a - * `Contract | Script` union type + * The deployed bytecode of the contract. */ deployedBytecode: TDeployedBytecode + /** - * The human readable abi of the contract + * The human-readable ABI of the contract. * @example * ```typescript - * import { MyContract } from './MyContract.sol' * console.log(MyContract.humanReadableAbi) * // ['function balanceOf(address): uint256', ...] * ``` */ humanReadableAbi: THumanReadableAbi + /** - * The name of the contract. If imported this will match the name of the contract import + * The name of the contract. If imported, this will match the name of the contract import. */ name?: TName + /** - * Action creators for events. Can be used to create event filters in a typesafe way + * Action creators for events. Used to create event filters in a type-safe way. * @example * ```typescript - * tevm.eth.getLog( - * MyContract.withAddress('0x420...').events.Transfer({ from: '0x1234...' }), - * ) - * === + * const transferFilter = MyContract.events.Transfer({ from: '0x1234...' }) + * const logs = await tevm.eth.getLogs(transferFilter) + * ``` */ events: EventActionCreator + /** - * Action creators for contract view and pure functions + * Action creators for contract view and pure functions. * @example * ```typescript - * tevm.contract( - * MyContract.withAddress('0x420...').read.balanceOf('0x1234...'), - *) + * const balanceAction = MyContract.read.balanceOf('0x1234...') + * const balance = await tevm.contract(balanceAction) * ``` */ read: ReadActionCreator + /** - * Action creators for contract payable and nonpayable functions + * Action creators for contract payable and nonpayable functions. * @example * ```typescript - * tevm.contract( - * MyContract.withAddress('0x420...').read.balanceOf('0x1234...'), - * ) + * const transferAction = MyContract.write.transfer('0x5678...', 1000n) + * const result = await tevm.contract(transferAction) * ``` */ write: WriteActionCreator + /** - * Action creator for deploying the contract + * Action creator for deploying the contract. + * @example + * ```typescript + * const deployAction = MyContract.deploy('Constructor', 'Args') + * const deployedContract = await tevm.contract(deployAction) + * ``` */ deploy: ( ...args: EncodeDeployDataParameters> extends { args: infer TArgs } @@ -153,22 +158,46 @@ export type Contract< : [] : [] ) => EncodeDeployDataParameters> + /** - * Adds an address to the contract. All action creators will return - * the address property if added. THis method returns a new contract + * Adds an address to the contract. All action creators will include + * the address property if added. This method returns a new contract; * it does not modify the existing contract. * @example * ```typescript - * import { MyContract } from './MyContract.sol' - * const MyContractOptimism = MyContract.withAddress('0x420...') + * const MyContractWithAddress = MyContract.withAddress('0x1234...') * ``` */ - withAddress: ( - address: TAddress, - ) => Contract + withAddress: ( + address: TNewAddress, + ) => Contract + /** - * Creates a deployless instance of the contract that can be used with - * tevm and viem as [deployless contracts](https://viem.sh/docs/contract/readContract#deployless-reads) + * Updates the bytecode of the contract. + * Returns a new contract instance with the updated code. + * @param {Hex} encodedBytecode - The encoded bytecode of the contract + * @returns {Contract} A new contract instance with updated code + * @example + * ```typescript + * import { createPublicClient, http } from 'viem' + * import { mainnet } from 'viem/chains' + * + * const client = createPublicClient({ + * chain: mainnet, + * transport: http() + * }) + * + * const ADDRESS = '0x6B175474E89094C44Da98b954EedeAC495271d0F' + * const UpdatedContract = Contract.withCode('0x60806040...') + * const {data, abi, code, args} = UpdatedContract.read.balanceOf('0x1234567890123456789012345678901234567890') + * const balance = await client.call({ + * to: ADDRESS, + * data, + * abi, + * code, + * args + * }) + * ``` */ - script: CreateScript + withCode: (encodedBytecode: Hex) => Contract } diff --git a/packages/contract/src/CreateContractFn.ts b/packages/contract/src/CreateContractFn.ts index 04316f58dc..90717b30be 100644 --- a/packages/contract/src/CreateContractFn.ts +++ b/packages/contract/src/CreateContractFn.ts @@ -3,30 +3,74 @@ import type { Contract } from './Contract.js' import type { CreateContractParams } from './CreateContractParams.js' /** - * Type of `createContract` factory function - * Creates a tevm Contract instance from human readable abi + * Type of `createContract` factory function. + * Creates a tevm Contract instance from a human readable ABI or JSON ABI. + * + * @typeParam TName - The name of the contract + * @typeParam TAbi - The ABI type (either string[] for human readable or Abi for JSON) + * @typeParam TAddress - The contract address type (optional) + * @typeParam TBytecode - The contract bytecode type (optional) + * @typeParam TDeployedBytecode - The deployed bytecode type (optional) + * @typeParam TCode - The runtime bytecode type (optional) + * * @example + * Using a human readable ABI: * ```typescript - * import { type Contract, createContract} from 'tevm/contract' + * import { type Contract, createContract } from 'tevm/contract' * * const contract: Contract = createContract({ - * name: 'MyContract', - * abi: [ - * ... - * ], + * name: 'ERC20', + * humanReadableAbi: [ + * 'function balanceOf(address owner) view returns (uint256)', + * 'function transfer(address to, uint256 amount) returns (bool)', + * 'event Transfer(address indexed from, address indexed to, uint256 value)', + * ], * }) * ``` * - * To use a json abi first pass it into `formatAbi` to turn it into human readable * @example + * Using a JSON ABI (needs to be formatted): * ```typescript - * import { type Contract, createContract} from 'tevm/contract' + * import { type Contract, createContract } from 'tevm/contract' + * import { formatAbi } from '@tevm/utils' + * + * const jsonAbi = [ + * { + * "inputs": [{"name": "owner", "type": "address"}], + * "name": "balanceOf", + * "outputs": [{"type": "uint256"}], + * "stateMutability": "view", + * "type": "function" + * }, + * { + * "inputs": [ + * {"name": "to", "type": "address"}, + * {"name": "amount", "type": "uint256"} + * ], + * "name": "transfer", + * "outputs": [{"type": "bool"}], + * "stateMutability": "nonpayable", + * "type": "function" + * }, + * { + * "anonymous": false, + * "inputs": [ + * {"indexed": true, "name": "from", "type": "address"}, + * {"indexed": true, "name": "to", "type": "address"}, + * {"indexed": false, "name": "value", "type": "uint256"} + * ], + * "name": "Transfer", + * "type": "event" + * } + * ] * * const contract = createContract({ - * name: 'MyContract', - * abi: [ - * ... - * ], + * name: 'ERC20', + * abi: formatAbi(jsonAbi), + * address: '0x6B175474E89094C44Da98b954EedeAC495271d0F', // DAI token address on Ethereum mainnet + * bytecode: '0x60806040526000805534801561001457600080fd5b50610771806100246000396000f3fe', // Example bytecode (truncated) + * deployedBytecode: '0x608060405234801561001057600080fd5b50600436106100885760003560e01c806370a082311161005b57806370a08231146101bc', // Example deployed bytecode (truncated) + * code: '0x608060405234801561001057600080fd5b50600436106100885760003560e01c806370a082311161005b57806370a08231146101bc', // Example runtime code (truncated) * }) * ``` */ diff --git a/packages/contract/src/CreateContractParams.ts b/packages/contract/src/CreateContractParams.ts index 79c23e5bfa..330654afd5 100644 --- a/packages/contract/src/CreateContractParams.ts +++ b/packages/contract/src/CreateContractParams.ts @@ -2,35 +2,85 @@ import type { Abi, Address, FormatAbi, Hex, ParseAbi } from '@tevm/utils' import type { Contract } from './Contract.js' /** - * Params for creating a {@link Contract} instance + * Parameters for creating a {@link Contract} instance. + * This type allows for two mutually exclusive ways of specifying the ABI: + * either as a human-readable ABI or as a JSON ABI. + * + * @typeParam TName - The name of the contract (optional) + * @typeParam TAbi - The ABI type (either string[] for human readable or Abi for JSON) + * @typeParam TAddress - The contract address type (optional) + * @typeParam TBytecode - The contract creation bytecode type (optional) + * @typeParam TDeployedBytecode - The deployed bytecode type (optional) + * @typeParam TCode - The runtime bytecode type (optional) + * * @see {@link CreateContract} + * + * @example + * Using human-readable ABI: + * ```typescript + * const params: CreateContractParams = { + * name: 'ERC20', + * humanReadableAbi: [ + * 'function balanceOf(address owner) view returns (uint256)', + * 'function transfer(address to, uint256 amount) returns (bool)', + * ], + * address: '0x6B175474E89094C44Da98b954EedeAC495271d0F', + * } + * ``` + * + * @example + * Using JSON ABI: + * ```typescript + * const params: CreateContractParams = { + * name: 'ERC20', + * abi: [ + * { + * "inputs": [{"name": "owner", "type": "address"}], + * "name": "balanceOf", + * "outputs": [{"type": "uint256"}], + * "stateMutability": "view", + * "type": "function" + * }, + * ], + * address: '0x6B175474E89094C44Da98b954EedeAC495271d0F', + * } + * ``` */ export type CreateContractParams< TName extends string | undefined | never, TAbi extends readonly string[] | Abi, TAddress extends undefined | Address | never, - // Bytecode is the contract bytecode with constructor TBytecode extends undefined | Hex | never, - // DeployedBytecode is the raw bytecode without constructor TDeployedBytecode extends undefined | Hex | never, - // Code is Bytecode encoded with constructor arguments TCode extends undefined | Hex | never, > = | { + /** Optional name of the contract */ name?: TName + /** Human-readable ABI of the contract */ humanReadableAbi: TAbi extends readonly string[] ? TAbi : FormatAbi abi?: never + /** Optional address of the deployed contract */ address?: TAddress + /** Optional creation bytecode of the contract */ bytecode?: TBytecode + /** Optional deployed bytecode of the contract */ deployedBytecode?: TDeployedBytecode + /** Optional runtime bytecode of the contract */ code?: TCode } | { + /** Optional name of the contract */ name?: TName humanReadableAbi?: never + /** JSON ABI of the contract */ abi: TAbi extends readonly string[] ? ParseAbi : TAbi extends Abi ? TAbi : never + /** Optional address of the deployed contract */ address?: TAddress + /** Optional creation bytecode of the contract */ bytecode?: TBytecode + /** Optional deployed bytecode of the contract */ deployedBytecode?: TDeployedBytecode + /** Optional runtime bytecode of the contract */ code?: TCode } diff --git a/packages/contract/src/CreateScript.ts b/packages/contract/src/CreateScript.ts deleted file mode 100644 index 105927d88b..0000000000 --- a/packages/contract/src/CreateScript.ts +++ /dev/null @@ -1,15 +0,0 @@ -import type { Address, Hex } from '@tevm/utils' -import type { Contract } from './Contract.js' -import type { DeployArgs } from './DeployArgs.js' - -/** - * Creates a deployless instance of a contract - * Can be used to execute code that isn't deployed in tevm - * or [viem](https://viem.sh/docs/actions/public/call#deployless-calls) - */ -export type CreateScript< - TName extends string, - THumanReadableAbi extends string[] | readonly string[], - TAddress extends Address | undefined = undefined, - TBytecode extends Hex | undefined = undefined, -> = (...args: DeployArgs) => Contract diff --git a/packages/contract/src/DeployArgs.ts b/packages/contract/src/DeployArgs.ts deleted file mode 100644 index 18de98faae..0000000000 --- a/packages/contract/src/DeployArgs.ts +++ /dev/null @@ -1,26 +0,0 @@ -import type { Abi, EncodeDeployDataParameters, Hex, ParseAbi } from '@tevm/utils' - -/** - * Inferred arguments for a contract deployment - */ -export type DeployArgs< - THumanReadableAbi extends string[] | readonly string[], - TBytecode extends Hex | undefined = undefined, - TAbi extends ParseAbi = ParseAbi, - THasConstructor = TAbi extends Abi - ? Abi extends TAbi - ? true - : [Extract] extends [never] - ? false - : true - : true, -> = THasConstructor extends false - ? TBytecode extends Hex - ? // allow no args to be passed in if no args - [] | [{ bytecode?: Hex }] - : // if only bytecode is needed require only that - [{ bytecode: Hex }] - : // otherwise require encoding args and bytecode if necessary - TBytecode extends Hex - ? [{ constructorArgs: EncodeDeployDataParameters['args'] }] - : [{ constructorArgs: EncodeDeployDataParameters['args']; bytecode: Hex }] diff --git a/packages/contract/src/contract-lib/ERC20.ts b/packages/contract/src/contract-lib/ERC20.ts index a5a7528fb1..37efb1abc7 100644 --- a/packages/contract/src/contract-lib/ERC20.ts +++ b/packages/contract/src/contract-lib/ERC20.ts @@ -27,6 +27,36 @@ const _OzERC20 = { '0x608060405234801561000f575f80fd5b5060043610610091575f3560e01c8063313ce56711610064578063313ce5671461013157806370a082311461014f57806395d89b411461017f578063a9059cbb1461019d578063dd62ed3e146101cd57610091565b806306fdde0314610095578063095ea7b3146100b357806318160ddd146100e357806323b872dd14610101575b5f80fd5b61009d6101fd565b6040516100aa9190610a74565b60405180910390f35b6100cd60048036038101906100c89190610b25565b61028d565b6040516100da9190610b7d565b60405180910390f35b6100eb6102af565b6040516100f89190610ba5565b60405180910390f35b61011b60048036038101906101169190610bbe565b6102b8565b6040516101289190610b7d565b60405180910390f35b6101396102e6565b6040516101469190610c29565b60405180910390f35b61016960048036038101906101649190610c42565b6102ee565b6040516101769190610ba5565b60405180910390f35b610187610333565b6040516101949190610a74565b60405180910390f35b6101b760048036038101906101b29190610b25565b6103c3565b6040516101c49190610b7d565b60405180910390f35b6101e760048036038101906101e29190610c6d565b6103e5565b6040516101f49190610ba5565b60405180910390f35b60606003805461020c90610cd8565b80601f016020809104026020016040519081016040528092919081815260200182805461023890610cd8565b80156102835780601f1061025a57610100808354040283529160200191610283565b820191905f5260205f20905b81548152906001019060200180831161026657829003601f168201915b5050505050905090565b5f80610297610467565b90506102a481858561046e565b600191505092915050565b5f600254905090565b5f806102c2610467565b90506102cf858285610480565b6102da858585610512565b60019150509392505050565b5f6012905090565b5f805f8373ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f20549050919050565b60606004805461034290610cd8565b80601f016020809104026020016040519081016040528092919081815260200182805461036e90610cd8565b80156103b95780601f10610390576101008083540402835291602001916103b9565b820191905f5260205f20905b81548152906001019060200180831161039c57829003601f168201915b5050505050905090565b5f806103cd610467565b90506103da818585610512565b600191505092915050565b5f60015f8473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f8373ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f2054905092915050565b5f33905090565b61047b8383836001610602565b505050565b5f61048b84846103e5565b90507fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff811461050c57818110156104fd578281836040517ffb8f41b20000000000000000000000000000000000000000000000000000000081526004016104f493929190610d17565b60405180910390fd5b61050b84848484035f610602565b5b50505050565b5f73ffffffffffffffffffffffffffffffffffffffff168373ffffffffffffffffffffffffffffffffffffffff1603610582575f6040517f96c6fd1e0000000000000000000000000000000000000000000000000000000081526004016105799190610d4c565b60405180910390fd5b5f73ffffffffffffffffffffffffffffffffffffffff168273ffffffffffffffffffffffffffffffffffffffff16036105f2575f6040517fec442f050000000000000000000000000000000000000000000000000000000081526004016105e99190610d4c565b60405180910390fd5b6105fd8383836107d1565b505050565b5f73ffffffffffffffffffffffffffffffffffffffff168473ffffffffffffffffffffffffffffffffffffffff1603610672575f6040517fe602df050000000000000000000000000000000000000000000000000000000081526004016106699190610d4c565b60405180910390fd5b5f73ffffffffffffffffffffffffffffffffffffffff168373ffffffffffffffffffffffffffffffffffffffff16036106e2575f6040517f94280d620000000000000000000000000000000000000000000000000000000081526004016106d99190610d4c565b60405180910390fd5b8160015f8673ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f8573ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f208190555080156107cb578273ffffffffffffffffffffffffffffffffffffffff168473ffffffffffffffffffffffffffffffffffffffff167f8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925846040516107c29190610ba5565b60405180910390a35b50505050565b5f73ffffffffffffffffffffffffffffffffffffffff168373ffffffffffffffffffffffffffffffffffffffff1603610821578060025f8282546108159190610d92565b925050819055506108ef565b5f805f8573ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f20549050818110156108aa578381836040517fe450d38c0000000000000000000000000000000000000000000000000000000081526004016108a193929190610d17565b60405180910390fd5b8181035f808673ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f2081905550505b5f73ffffffffffffffffffffffffffffffffffffffff168273ffffffffffffffffffffffffffffffffffffffff1603610936578060025f8282540392505081905550610980565b805f808473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f82825401925050819055505b8173ffffffffffffffffffffffffffffffffffffffff168373ffffffffffffffffffffffffffffffffffffffff167fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef836040516109dd9190610ba5565b60405180910390a3505050565b5f81519050919050565b5f82825260208201905092915050565b5f5b83811015610a21578082015181840152602081019050610a06565b5f8484015250505050565b5f601f19601f8301169050919050565b5f610a46826109ea565b610a5081856109f4565b9350610a60818560208601610a04565b610a6981610a2c565b840191505092915050565b5f6020820190508181035f830152610a8c8184610a3c565b905092915050565b5f80fd5b5f73ffffffffffffffffffffffffffffffffffffffff82169050919050565b5f610ac182610a98565b9050919050565b610ad181610ab7565b8114610adb575f80fd5b50565b5f81359050610aec81610ac8565b92915050565b5f819050919050565b610b0481610af2565b8114610b0e575f80fd5b50565b5f81359050610b1f81610afb565b92915050565b5f8060408385031215610b3b57610b3a610a94565b5b5f610b4885828601610ade565b9250506020610b5985828601610b11565b9150509250929050565b5f8115159050919050565b610b7781610b63565b82525050565b5f602082019050610b905f830184610b6e565b92915050565b610b9f81610af2565b82525050565b5f602082019050610bb85f830184610b96565b92915050565b5f805f60608486031215610bd557610bd4610a94565b5b5f610be286828701610ade565b9350506020610bf386828701610ade565b9250506040610c0486828701610b11565b9150509250925092565b5f60ff82169050919050565b610c2381610c0e565b82525050565b5f602082019050610c3c5f830184610c1a565b92915050565b5f60208284031215610c5757610c56610a94565b5b5f610c6484828501610ade565b91505092915050565b5f8060408385031215610c8357610c82610a94565b5b5f610c9085828601610ade565b9250506020610ca185828601610ade565b9150509250929050565b7f4e487b71000000000000000000000000000000000000000000000000000000005f52602260045260245ffd5b5f6002820490506001821680610cef57607f821691505b602082108103610d0257610d01610cab565b5b50919050565b610d1181610ab7565b82525050565b5f606082019050610d2a5f830186610d08565b610d376020830185610b96565b610d446040830184610b96565b949350505050565b5f602082019050610d5f5f830184610d08565b92915050565b7f4e487b71000000000000000000000000000000000000000000000000000000005f52601160045260245ffd5b5f610d9c82610af2565b9150610da783610af2565b9250828201905080821115610dbf57610dbe610d65565b5b9291505056fea264697066735822122055b5ce6d6026c56b28a641568d3e9a6c81fb1079127f85ede16ed31d67d3eff464736f6c63430008160033', } as const /** - * Bytecode and ABI for the ERC20 contract from open zeppelin. + * Bytecode and ABI for the ERC20 contract from OpenZeppelin. + * This constant represents a standard ERC20 token implementation. + * + * @example + * Using the ERC20 contract in a deployment script: + * ```typescript + * import { ERC20 } from 'tevm/contract' + * + * // Deploy the ERC20 contract + * const deployedERC20 = await tevm.deployContract(ERC20.deploy('MyToken', 'MTK')) + * console.log('ERC20 deployed at:', deployedERC20.address) + * + * // Interact with the deployed contract + * const balance = await tevm.contract(ERC20.read.balanceOf(deployedERC20.address, '0x1234...')) + * console.log('Balance:', balance) + * ``` + * + * @example + * Using the ERC20 contract with an existing deployment: + * ```typescript + * import { ERC20 } from 'tevm/contract' + * + * const existingERC20 = ERC20.withAddress('0x1234...') + * + * // Read token name + * const name = await tevm.contract(existingERC20.read.name()) + * console.log('Token name:', name) + * + * // Transfer tokens + * await tevm.contract(existingERC20.write.transfer('0x5678...', 1000n)) + * ``` */ export const ERC20 = createContract(_OzERC20) diff --git a/packages/contract/src/contract-lib/ERC721.ts b/packages/contract/src/contract-lib/ERC721.ts index ad10c09c0d..f87e5fae94 100644 --- a/packages/contract/src/contract-lib/ERC721.ts +++ b/packages/contract/src/contract-lib/ERC721.ts @@ -34,6 +34,38 @@ const _OzERC721 = { '0x608060405234801561000f575f80fd5b50600436106100cd575f3560e01c80636352211e1161008a578063a22cb46511610064578063a22cb46514610221578063b88d4fde1461023d578063c87b56dd14610259578063e985e9c514610289576100cd565b80636352211e146101a357806370a08231146101d357806395d89b4114610203576100cd565b806301ffc9a7146100d157806306fdde0314610101578063081812fc1461011f578063095ea7b31461014f57806323b872dd1461016b57806342842e0e14610187575b5f80fd5b6100eb60048036038101906100e6919061146f565b6102b9565b6040516100f891906114b4565b60405180910390f35b61010961039a565b6040516101169190611557565b60405180910390f35b610139600480360381019061013491906115aa565b610429565b6040516101469190611614565b60405180910390f35b61016960048036038101906101649190611657565b610444565b005b61018560048036038101906101809190611695565b61045a565b005b6101a1600480360381019061019c9190611695565b610559565b005b6101bd60048036038101906101b891906115aa565b610578565b6040516101ca9190611614565b60405180910390f35b6101ed60048036038101906101e891906116e5565b610589565b6040516101fa919061171f565b60405180910390f35b61020b61063f565b6040516102189190611557565b60405180910390f35b61023b60048036038101906102369190611762565b6106cf565b005b610257600480360381019061025291906118cc565b6106e5565b005b610273600480360381019061026e91906115aa565b610702565b6040516102809190611557565b60405180910390f35b6102a3600480360381019061029e919061194c565b610768565b6040516102b091906114b4565b60405180910390f35b5f7f80ac58cd000000000000000000000000000000000000000000000000000000007bffffffffffffffffffffffffffffffffffffffffffffffffffffffff1916827bffffffffffffffffffffffffffffffffffffffffffffffffffffffff1916148061038357507f5b5e139f000000000000000000000000000000000000000000000000000000007bffffffffffffffffffffffffffffffffffffffffffffffffffffffff1916827bffffffffffffffffffffffffffffffffffffffffffffffffffffffff1916145b806103935750610392826107f6565b5b9050919050565b60605f80546103a8906119b7565b80601f01602080910402602001604051908101604052809291908181526020018280546103d4906119b7565b801561041f5780601f106103f65761010080835404028352916020019161041f565b820191905f5260205f20905b81548152906001019060200180831161040257829003601f168201915b5050505050905090565b5f6104338261085f565b5061043d826108e5565b9050919050565b610456828261045161091e565b610925565b5050565b5f73ffffffffffffffffffffffffffffffffffffffff168273ffffffffffffffffffffffffffffffffffffffff16036104ca575f6040517f64a0ae920000000000000000000000000000000000000000000000000000000081526004016104c19190611614565b60405180910390fd5b5f6104dd83836104d861091e565b610937565b90508373ffffffffffffffffffffffffffffffffffffffff168173ffffffffffffffffffffffffffffffffffffffff1614610553578382826040517f64283d7b00000000000000000000000000000000000000000000000000000000815260040161054a939291906119e7565b60405180910390fd5b50505050565b61057383838360405180602001604052805f8152506106e5565b505050565b5f6105828261085f565b9050919050565b5f8073ffffffffffffffffffffffffffffffffffffffff168273ffffffffffffffffffffffffffffffffffffffff16036105fa575f6040517f89c62b640000000000000000000000000000000000000000000000000000000081526004016105f19190611614565b60405180910390fd5b60035f8373ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f20549050919050565b60606001805461064e906119b7565b80601f016020809104026020016040519081016040528092919081815260200182805461067a906119b7565b80156106c55780601f1061069c576101008083540402835291602001916106c5565b820191905f5260205f20905b8154815290600101906020018083116106a857829003601f168201915b5050505050905090565b6106e16106da61091e565b8383610b42565b5050565b6106f084848461045a565b6106fc84848484610cab565b50505050565b606061070d8261085f565b505f610717610e5d565b90505f8151116107355760405180602001604052805f815250610760565b8061073f84610e73565b604051602001610750929190611a56565b6040516020818303038152906040525b915050919050565b5f60055f8473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f8373ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f9054906101000a900460ff16905092915050565b5f7f01ffc9a7000000000000000000000000000000000000000000000000000000007bffffffffffffffffffffffffffffffffffffffffffffffffffffffff1916827bffffffffffffffffffffffffffffffffffffffffffffffffffffffff1916149050919050565b5f8061086a83610f3d565b90505f73ffffffffffffffffffffffffffffffffffffffff168173ffffffffffffffffffffffffffffffffffffffff16036108dc57826040517f7e2732890000000000000000000000000000000000000000000000000000000081526004016108d3919061171f565b60405180910390fd5b80915050919050565b5f60045f8381526020019081526020015f205f9054906101000a900473ffffffffffffffffffffffffffffffffffffffff169050919050565b5f33905090565b6109328383836001610f76565b505050565b5f8061094284610f3d565b90505f73ffffffffffffffffffffffffffffffffffffffff168373ffffffffffffffffffffffffffffffffffffffff161461098357610982818486611135565b5b5f73ffffffffffffffffffffffffffffffffffffffff168173ffffffffffffffffffffffffffffffffffffffff1614610a0e576109c25f855f80610f76565b600160035f8373ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f82825403925050819055505b5f73ffffffffffffffffffffffffffffffffffffffff168573ffffffffffffffffffffffffffffffffffffffff1614610a8d57600160035f8773ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f82825401925050819055505b8460025f8681526020019081526020015f205f6101000a81548173ffffffffffffffffffffffffffffffffffffffff021916908373ffffffffffffffffffffffffffffffffffffffff160217905550838573ffffffffffffffffffffffffffffffffffffffff168273ffffffffffffffffffffffffffffffffffffffff167fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef60405160405180910390a4809150509392505050565b5f73ffffffffffffffffffffffffffffffffffffffff168273ffffffffffffffffffffffffffffffffffffffff1603610bb257816040517f5b08ba18000000000000000000000000000000000000000000000000000000008152600401610ba99190611614565b60405180910390fd5b8060055f8573ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f8473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019081526020015f205f6101000a81548160ff0219169083151502179055508173ffffffffffffffffffffffffffffffffffffffff168373ffffffffffffffffffffffffffffffffffffffff167f17307eab39ab6107e8899845ad3d59bd9653f200f220920489ca2b5937696c3183604051610c9e91906114b4565b60405180910390a3505050565b5f8373ffffffffffffffffffffffffffffffffffffffff163b1115610e57578273ffffffffffffffffffffffffffffffffffffffff1663150b7a02610cee61091e565b8685856040518563ffffffff1660e01b8152600401610d109493929190611acb565b6020604051808303815f875af1925050508015610d4b57506040513d601f19601f82011682018060405250810190610d489190611b29565b60015b610dcc573d805f8114610d79576040519150601f19603f3d011682016040523d82523d5f602084013e610d7e565b606091505b505f815103610dc457836040517f64a0ae92000000000000000000000000000000000000000000000000000000008152600401610dbb9190611614565b60405180910390fd5b805181602001fd5b63150b7a0260e01b7bffffffffffffffffffffffffffffffffffffffffffffffffffffffff1916817bffffffffffffffffffffffffffffffffffffffffffffffffffffffff191614610e5557836040517f64a0ae92000000000000000000000000000000000000000000000000000000008152600401610e4c9190611614565b60405180910390fd5b505b50505050565b606060405180602001604052805f815250905090565b60605f6001610e81846111f8565b0190505f8167ffffffffffffffff811115610e9f57610e9e6117a8565b5b6040519080825280601f01601f191660200182016040528015610ed15781602001600182028036833780820191505090505b5090505f82602001820190505b600115610f32578080600190039150507f3031323334353637383961626364656600000000000000000000000000000000600a86061a8153600a8581610f2757610f26611b54565b5b0494505f8503610ede575b819350505050919050565b5f60025f8381526020019081526020015f205f9054906101000a900473ffffffffffffffffffffffffffffffffffffffff169050919050565b8080610fae57505f73ffffffffffffffffffffffffffffffffffffffff168273ffffffffffffffffffffffffffffffffffffffff1614155b156110e0575f610fbd8461085f565b90505f73ffffffffffffffffffffffffffffffffffffffff168373ffffffffffffffffffffffffffffffffffffffff161415801561102757508273ffffffffffffffffffffffffffffffffffffffff168173ffffffffffffffffffffffffffffffffffffffff1614155b801561103a57506110388184610768565b155b1561107c57826040517fa9fbf51f0000000000000000000000000000000000000000000000000000000081526004016110739190611614565b60405180910390fd5b81156110de57838573ffffffffffffffffffffffffffffffffffffffff168273ffffffffffffffffffffffffffffffffffffffff167f8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b92560405160405180910390a45b505b8360045f8581526020019081526020015f205f6101000a81548173ffffffffffffffffffffffffffffffffffffffff021916908373ffffffffffffffffffffffffffffffffffffffff16021790555050505050565b611140838383611349565b6111f3575f73ffffffffffffffffffffffffffffffffffffffff168373ffffffffffffffffffffffffffffffffffffffff16036111b457806040517f7e2732890000000000000000000000000000000000000000000000000000000081526004016111ab919061171f565b60405180910390fd5b81816040517f177e802f0000000000000000000000000000000000000000000000000000000081526004016111ea929190611b81565b60405180910390fd5b505050565b5f805f90507a184f03e93ff9f4daa797ed6e38ed64bf6a1f0100000000000000008310611254577a184f03e93ff9f4daa797ed6e38ed64bf6a1f010000000000000000838161124a57611249611b54565b5b0492506040810190505b6d04ee2d6d415b85acef81000000008310611291576d04ee2d6d415b85acef8100000000838161128757611286611b54565b5b0492506020810190505b662386f26fc1000083106112c057662386f26fc1000083816112b6576112b5611b54565b5b0492506010810190505b6305f5e10083106112e9576305f5e10083816112df576112de611b54565b5b0492506008810190505b612710831061130e57612710838161130457611303611b54565b5b0492506004810190505b60648310611331576064838161132757611326611b54565b5b0492506002810190505b600a8310611340576001810190505b80915050919050565b5f8073ffffffffffffffffffffffffffffffffffffffff168373ffffffffffffffffffffffffffffffffffffffff161415801561140057508273ffffffffffffffffffffffffffffffffffffffff168473ffffffffffffffffffffffffffffffffffffffff1614806113c157506113c08484610768565b5b806113ff57508273ffffffffffffffffffffffffffffffffffffffff166113e7836108e5565b73ffffffffffffffffffffffffffffffffffffffff16145b5b90509392505050565b5f604051905090565b5f80fd5b5f80fd5b5f7fffffffff0000000000000000000000000000000000000000000000000000000082169050919050565b61144e8161141a565b8114611458575f80fd5b50565b5f8135905061146981611445565b92915050565b5f6020828403121561148457611483611412565b5b5f6114918482850161145b565b91505092915050565b5f8115159050919050565b6114ae8161149a565b82525050565b5f6020820190506114c75f8301846114a5565b92915050565b5f81519050919050565b5f82825260208201905092915050565b5f5b838110156115045780820151818401526020810190506114e9565b5f8484015250505050565b5f601f19601f8301169050919050565b5f611529826114cd565b61153381856114d7565b93506115438185602086016114e7565b61154c8161150f565b840191505092915050565b5f6020820190508181035f83015261156f818461151f565b905092915050565b5f819050919050565b61158981611577565b8114611593575f80fd5b50565b5f813590506115a481611580565b92915050565b5f602082840312156115bf576115be611412565b5b5f6115cc84828501611596565b91505092915050565b5f73ffffffffffffffffffffffffffffffffffffffff82169050919050565b5f6115fe826115d5565b9050919050565b61160e816115f4565b82525050565b5f6020820190506116275f830184611605565b92915050565b611636816115f4565b8114611640575f80fd5b50565b5f813590506116518161162d565b92915050565b5f806040838503121561166d5761166c611412565b5b5f61167a85828601611643565b925050602061168b85828601611596565b9150509250929050565b5f805f606084860312156116ac576116ab611412565b5b5f6116b986828701611643565b93505060206116ca86828701611643565b92505060406116db86828701611596565b9150509250925092565b5f602082840312156116fa576116f9611412565b5b5f61170784828501611643565b91505092915050565b61171981611577565b82525050565b5f6020820190506117325f830184611710565b92915050565b6117418161149a565b811461174b575f80fd5b50565b5f8135905061175c81611738565b92915050565b5f806040838503121561177857611777611412565b5b5f61178585828601611643565b92505060206117968582860161174e565b9150509250929050565b5f80fd5b5f80fd5b7f4e487b71000000000000000000000000000000000000000000000000000000005f52604160045260245ffd5b6117de8261150f565b810181811067ffffffffffffffff821117156117fd576117fc6117a8565b5b80604052505050565b5f61180f611409565b905061181b82826117d5565b919050565b5f67ffffffffffffffff82111561183a576118396117a8565b5b6118438261150f565b9050602081019050919050565b828183375f83830152505050565b5f61187061186b84611820565b611806565b90508281526020810184848401111561188c5761188b6117a4565b5b611897848285611850565b509392505050565b5f82601f8301126118b3576118b26117a0565b5b81356118c384826020860161185e565b91505092915050565b5f805f80608085870312156118e4576118e3611412565b5b5f6118f187828801611643565b945050602061190287828801611643565b935050604061191387828801611596565b925050606085013567ffffffffffffffff81111561193457611933611416565b5b6119408782880161189f565b91505092959194509250565b5f806040838503121561196257611961611412565b5b5f61196f85828601611643565b925050602061198085828601611643565b9150509250929050565b7f4e487b71000000000000000000000000000000000000000000000000000000005f52602260045260245ffd5b5f60028204905060018216806119ce57607f821691505b6020821081036119e1576119e061198a565b5b50919050565b5f6060820190506119fa5f830186611605565b611a076020830185611710565b611a146040830184611605565b949350505050565b5f81905092915050565b5f611a30826114cd565b611a3a8185611a1c565b9350611a4a8185602086016114e7565b80840191505092915050565b5f611a618285611a26565b9150611a6d8284611a26565b91508190509392505050565b5f81519050919050565b5f82825260208201905092915050565b5f611a9d82611a79565b611aa78185611a83565b9350611ab78185602086016114e7565b611ac08161150f565b840191505092915050565b5f608082019050611ade5f830187611605565b611aeb6020830186611605565b611af86040830185611710565b8181036060830152611b0a8184611a93565b905095945050505050565b5f81519050611b2381611445565b92915050565b5f60208284031215611b3e57611b3d611412565b5b5f611b4b84828501611b15565b91505092915050565b7f4e487b71000000000000000000000000000000000000000000000000000000005f52601260045260245ffd5b5f604082019050611b945f830185611605565b611ba16020830184611710565b939250505056fea2646970667358221220660c47cef4875784ced30d2987fb0203ddda8f97b11c21c4a3205a82e611b4d064736f6c63430008160033', } as const /** - * Bytecode and ABI for the ERC721 contract from open zeppelin. + * Bytecode and ABI for the ERC721 contract from OpenZeppelin. + * This constant represents a standard ERC721 token implementation for non-fungible tokens (NFTs). + * For more details, see the [OpenZeppelin ERC721 documentation](https://docs.openzeppelin.com/contracts/4.x/erc721). + * + * @example + * Using the ERC721 contract in a deployment script: + * ```typescript + * import { ERC721 } from 'tevm/contract' + * + * // Deploy the ERC721 contract + * const deployedERC721 = await tevm.deployContract(ERC721.deploy('MyNFT', 'MNFT')) + * console.log('ERC721 deployed at:', deployedERC721.address) + * + * // Interact with the deployed contract + * const owner = await tevm.contract(ERC721.read.ownerOf(deployedERC721.address, 1n)) + * console.log('Owner of token 1:', owner) + * ``` + * + * @example + * Using the ERC721 contract with an existing deployment: + * ```typescript + * import { ERC721 } from 'tevm/contract' + * + * const existingERC721 = ERC721.withAddress('0x1234...') + * + * // Read token name + * const name = await tevm.contract(existingERC721.read.name()) + * console.log('Token name:', name) + * + * // Transfer token + * await tevm.contract(existingERC721.write.transferFrom('0xabcd...', '0x5678...', 1n)) + * ``` + * */ export const ERC721 = createContract(_OzERC721) diff --git a/packages/contract/src/contract-lib/SimpleContract.s.sol.ts b/packages/contract/src/contract-lib/SimpleContract.s.sol.ts index fca1371c26..7ffec66b51 100644 --- a/packages/contract/src/contract-lib/SimpleContract.s.sol.ts +++ b/packages/contract/src/contract-lib/SimpleContract.s.sol.ts @@ -12,4 +12,39 @@ const _SimpleContract = { deployedBytecode: '0x608060405234801561000f575f80fd5b5060043610610034575f3560e01c806360fe47b1146100385780636d4ce63c14610054575b5f80fd5b610052600480360381019061004d91906100f1565b610072565b005b61005c6100b2565b604051610069919061012b565b60405180910390f35b805f819055507f012c78e2b84325878b1bd9d250d772cfe5bda7722d795f45036fa5e1e6e303fc816040516100a7919061012b565b60405180910390a150565b5f8054905090565b5f80fd5b5f819050919050565b6100d0816100be565b81146100da575f80fd5b50565b5f813590506100eb816100c7565b92915050565b5f60208284031215610106576101056100ba565b5b5f610113848285016100dd565b91505092915050565b610125816100be565b82525050565b5f60208201905061013e5f83018461011c565b9291505056fea2646970667358221220792d4ee4a770b6a319a0ec659b77ea24497824649e20dcdea1dd7acf6118a5fe64736f6c63430008160033', } as const +/** + * Bytecode and ABI for a simple contract with a single state variable. + * This constant represents a basic contract that can get and set a uint256 value. + * + * @example + * Using the SimpleContract in a deployment script: + * ```typescript + * import { SimpleContract } from 'tevm/contract' + * + * // Deploy the SimpleContract with an initial value + * const deployedSimpleContract = await tevm.deployContract(SimpleContract.deploy(42n)) + * console.log('SimpleContract deployed at:', deployedSimpleContract.address) + * + * // Interact with the deployed contract + * const value = await tevm.contract(SimpleContract.read.get()) + * console.log('Current value:', value) + * ``` + * + * @example + * Using the SimpleContract with an existing deployment: + * ```typescript + * import { SimpleContract } from 'tevm/contract' + * + * const existingSimpleContract = SimpleContract.withAddress('0x1234...') + * + * // Read current value + * const currentValue = await tevm.contract(existingSimpleContract.read.get()) + * console.log('Current value:', currentValue) + * + * // Set a new value + * await tevm.contract(existingSimpleContract.write.set(100n)) + * console.log('New value set') + * ``` + * + */ export const SimpleContract = createContract(_SimpleContract) diff --git a/packages/contract/src/createContract.js b/packages/contract/src/createContract.js index 68c112bfac..0b3fe39177 100644 --- a/packages/contract/src/createContract.js +++ b/packages/contract/src/createContract.js @@ -1,36 +1,74 @@ import { InvalidParamsError } from '@tevm/errors' -import { encodeDeployData, formatAbi, getAddress, parseAbi } from '@tevm/utils' +import { formatAbi, getAddress, parseAbi } from '@tevm/utils' import { eventsFactory } from './event/eventFactory.js' import { readFactory } from './read/readFactory.js' import { writeFactory } from './write/writeFactory.js' /** - * Creates a tevm Contract instance from human readable abi + * Creates a Tevm Contract instance from a human-readable ABI or JSON ABI. + * This function is the core of Tevm's contract interaction capabilities, + * allowing for type-safe and easy-to-use contract interfaces. + * * @type {import('./CreateContractFn.js').CreateContractFn} + * @throws {InvalidParamsError} If neither humanReadableAbi nor abi is provided. + * * @example + * Using a human-readable ABI: * ```typescript - * import { type Contract, createContract} from 'tevm/contract' + * import { createContract } from 'tevm/contract' * - * const contract: Contract = createContract({ - * name: 'MyContract', - * abi: [ - * ... - * ], + * const contract = createContract({ + * name: 'ERC20', + * humanReadableAbi: [ + * 'function balanceOf(address account) view returns (uint256)', + * 'function transfer(address to, uint256 amount) returns (bool)', + * 'event Transfer(address indexed from, address indexed to, uint256 value)' + * ], + * address: '0x6B175474E89094C44Da98b954EedeAC495271d0F' // DAI token address * }) + * + * // Read contract state + * const balanceAction = contract.read.balanceOf('0x1234...') + * const balance = await tevm.contract(balanceAction) + * + * // Write to contract + * const transferAction = contract.write.transfer('0x5678...', 1000n) + * const result = await tevm.contract(transferAction) + * + * // Create event filter + * const transferFilter = contract.events.Transfer({ fromBlock: 'latest' }) + * const logs = await tevm.eth.getLogs(transferFilter) * ``` * - * To use a json abi first pass it into `formatAbi` to turn it into human readable * @example + * Using a JSON ABI: * ```typescript - * import { type Contract, createContract} from 'tevm/contract' + * import { createContract } from 'tevm/contract' * * const contract = createContract({ - * name: 'MyContract', - * abi: [ - * ... - * ], + * name: 'ERC20', + * abi: [ + * { + * "inputs": [{"name": "account", "type": "address"}], + * "name": "balanceOf", + * "outputs": [{"type": "uint256"}], + * "stateMutability": "view", + * "type": "function" + * }, + * // ... other ABI entries + * ], + * address: '0x6B175474E89094C44Da98b954EedeAC495271d0F', + * bytecode: '0x60806040...', // Optional: Creation bytecode + * deployedBytecode: '0x608060405...', // Optional: Deployed bytecode + * code: '0x608060405...' // Optional: Runtime bytecode * }) + * + * // Use the contract as in the previous example * ``` + * + * @see {@link Contract} for the full API of the returned Contract instance. + * @see {@link https://tevm.sh/learn/contracts/} for more information on working with contracts in Tevm. + * @see {@link https://tevm.sh/reference/tevm/contract/types/Contract/} for detailed Contract type documentation. */ export const createContract = ({ name, @@ -86,59 +124,31 @@ export const createContract = ({ }), ) } + /** - * @type {import('./CreateScript.js').CreateScript} + * @param {import('@tevm/utils').Hex} encodedBytecode */ - const script = (params) => { - const _bytecode = (() => { - // this case needs test coverage - if (params && 'bytecode' in params && params.bytecode) { - return params.bytecode - } - // this case needs test coverage - if (bytecode) { - return bytecode - } - // this case needs test coverage - if (deployedBytecode) { - return deployedBytecode - } - // this case needs test coverage - throw new Error('Unknown bytecode error') - })() - const constructorAbi = abi.find((item) => item.type === 'constructor') - const code = (() => { - if (!constructorAbi) { - return _bytecode - } - // this case needs test coverage - if (!('constructorArgs' in params) || /** @type {Array}*/ (params.constructorArgs)?.length < 1) { - return _bytecode - } - // this case needs test coverage - return encodeDeployData({ - abi: /** @type {any}*/ (abi), - bytecode: _bytecode, - args: /** @type {any}*/ (params.constructorArgs), - }) - })() + const withCode = (encodedBytecode) => { return createContract( - /** @type {any}*/ ({ + /** @type {any} */ ({ ...baseContract, - bytecode: _bytecode, - code, + code: encodedBytecode, }), ) } + return /**@type any*/ ({ ...baseContract, + withCode, withAddress, - script, /** * @param {Array} args */ deploy: (...args) => { const maybeArgs = args.length > 0 ? { args } : {} + if (!baseContract.bytecode) { + throw new Error('Bytecode is required to generate deploy data') + } return { ...maybeArgs, bytecode: baseContract.bytecode, diff --git a/packages/contract/src/createContract.spec.ts b/packages/contract/src/createContract.spec.ts index d0aa5ccabb..9914e6a19b 100644 --- a/packages/contract/src/createContract.spec.ts +++ b/packages/contract/src/createContract.spec.ts @@ -1,4 +1,4 @@ -import { type Hex, encodeDeployData, formatAbi, parseAbi } from '@tevm/utils' +import { type Hex, formatAbi, parseAbi } from '@tevm/utils' import { assertType, describe, expect, it } from 'vitest' import type { Contract } from './Contract.js' import { createContract } from './createContract.js' @@ -14,6 +14,23 @@ describe(createContract.name, () => { expect(contract.name).toBe('DummyContract') }) + it('should set deployedBytecode correctly', () => { + const contractWithoutDeployedBytecode = createContract({ + humanReadableAbi: formatAbi(dummyAbi), + name: 'DummyContract', + bytecode: '0x420', + }) + expect(contractWithoutDeployedBytecode.deployedBytecode).toBeUndefined() + + const contractWithDeployedBytecode = createContract({ + humanReadableAbi: formatAbi(dummyAbi), + name: 'DummyContract', + bytecode: '0x420', + deployedBytecode: '0x69', + }) + expect(contractWithDeployedBytecode.deployedBytecode).toBe('0x69') + }) + it('should contain the ABI', () => { expect(contract.abi).toEqual(parseAbi(formatAbi(dummyAbi))) }) @@ -22,8 +39,19 @@ describe(createContract.name, () => { expect(contract.humanReadableAbi).toBeDefined() }) + it('deploy should throw if bytecode is not provided', () => { + expect(() => + createContract({ + humanReadableAbi: formatAbi(dummyAbi), + name: 'DummyContract', + }).deploy(), + ).toThrowErrorMatchingInlineSnapshot('[Error: Bytecode is required to generate deploy data]') + }) + it('should contain deploy', () => { - expect(contract.deploy()).toMatchInlineSnapshot(` + expect( + createContract({ humanReadableAbi: formatAbi(dummyAbi), name: 'DummyContract', bytecode: '0x420' }).deploy(), + ).toMatchInlineSnapshot(` { "abi": [ { @@ -142,12 +170,13 @@ describe(createContract.name, () => { "type": "event", }, ], - "bytecode": undefined, + "bytecode": "0x420", } `) expect( createContract({ humanReadableAbi: ['constructor(uint256 num) payable'] as const, + bytecode: '0x420', } as const).deploy(20n), ).toMatchInlineSnapshot(` { @@ -166,7 +195,7 @@ describe(createContract.name, () => { "args": [ 20n, ], - "bytecode": undefined, + "bytecode": "0x420", } `) }) @@ -177,9 +206,7 @@ describe(createContract.name, () => { { "exampleRead": [Function], "exampleReadNoArgs": [Function], - "exampleWrite": [Function], "overloadedRead": [Function], - "overloadedWrite": [Function], } `) }) @@ -188,10 +215,7 @@ describe(createContract.name, () => { // see ./write for more tests expect(contract.write).toMatchInlineSnapshot(` { - "exampleRead": [Function], - "exampleReadNoArgs": [Function], "exampleWrite": [Function], - "overloadedRead": [Function], "overloadedWrite": [Function], } `) @@ -303,66 +327,6 @@ describe(createContract.name, () => { } `) }) - it('should handle bytecode from params in script function', () => { - const params = { bytecode: '0x123456' } as const - const scriptContract = contract.script(params) - expect(scriptContract.bytecode).toBe(params.bytecode) - expect(scriptContract.code).toBe(params.bytecode) - }) - - it('should handle bytecode from base contract in script function', () => { - const contractWithBytecode = createContract({ - humanReadableAbi: formatAbi(dummyAbi), - name: 'DummyContract', - bytecode: '0x654321', - }) - const scriptContract = contractWithBytecode.script({}) - expect(scriptContract.bytecode).toBe('0x654321') - expect(scriptContract.code).toBe('0x654321') - }) - - it('should handle deployedBytecode from base contract in script function', () => { - const contractWithDeployedBytecode = createContract({ - humanReadableAbi: formatAbi(dummyAbi), - name: 'DummyContract', - deployedBytecode: '0xabcdef', - }) - const scriptContract = contractWithDeployedBytecode.script({} as any) - expect(scriptContract.bytecode).toBe('0xabcdef') - expect(scriptContract.code).toBe('0xabcdef') - }) - - it('should throw an error if no bytecode is provided in script function', () => { - expect(() => contract.script({} as any)).toThrow('Unknown bytecode error') - }) - - it('should handle constructor without args in script function', () => { - const contractWithConstructor = createContract({ - humanReadableAbi: ['constructor() payable'] as const, - name: 'ContractWithConstructor', - bytecode: '0x123456', - }) - const scriptContract = contractWithConstructor.script({} as any) - expect(scriptContract.bytecode).toBe('0x123456') - expect(scriptContract.code).toBe('0x123456') - }) - - it('should handle constructor with args in script function', () => { - const contractWithConstructor = createContract({ - humanReadableAbi: ['constructor(uint256 num) payable'] as const, - name: 'ContractWithConstructor', - bytecode: '0x123456', - }) - const scriptContract = contractWithConstructor.script({ constructorArgs: [42n] }) - expect(scriptContract.bytecode).toBe('0x123456') - expect(scriptContract.code).toBe( - encodeDeployData({ - abi: contractWithConstructor.abi, - bytecode: '0x123456', - args: [42n], - }), - ) - }) it('should throw if no abi or humanReadableAbi is provided', () => { expect(() => createContract({ name: 'ContractWithConstructor' } as any)).toThrowErrorMatchingInlineSnapshot(` @@ -425,4 +389,22 @@ describe(createContract.name, () => { humanReadableAbi: ['function name() view returns (string)'], }) }) + + it('should contain withCode method', () => { + const contract = createContract({ + humanReadableAbi: formatAbi(dummyAbi), + name: 'DummyContract', + }) + expect(contract.withCode).toBeDefined() + expect(typeof contract.withCode).toBe('function') + }) + + it('should update code properties with withCode method', () => { + const contract = createContract({ + humanReadableAbi: formatAbi(dummyAbi), + name: 'DummyContract', + }) + const updatedContract = contract.withCode('0xabcdef') + expect(updatedContract.code).toBe('0xabcdef') + }) }) diff --git a/packages/contract/src/event/EventActionCreator.ts b/packages/contract/src/event/EventActionCreator.ts index 77d9bba16d..edab6a4d27 100644 --- a/packages/contract/src/event/EventActionCreator.ts +++ b/packages/contract/src/event/EventActionCreator.ts @@ -13,7 +13,9 @@ import type { } from '@tevm/utils' /** - * Adapted from viem. This is a helper type to extract the event args from an abi + * Extracts event arguments from an ABI. + * @template TAbi - The ABI type, can be an Abi, readonly unknown[], or undefined. + * @template TEventName - The name of the event, can be a string or undefined. */ export type MaybeExtractEventArgsFromAbi< TAbi extends Abi | readonly unknown[] | undefined, @@ -27,16 +29,32 @@ export type MaybeExtractEventArgsFromAbi< readonly unknown[] | Record > +/** + * Utility type to get the value type of an object. + * @template T - The object type. + */ export type ValueOf = T[keyof T] /** - * A mapping of event names to action creators for events. Can be used to create event filters in a typesafe way + * A mapping of event names to action creators for events. Can be used to create event filters in a typesafe way. + * @template THumanReadableAbi - The human-readable ABI of the contract. + * @template TBytecode - The bytecode of the contract. + * @template TDeployedBytecode - The deployed bytecode of the contract. + * @template TAddress - The address of the contract. + * @template TAddressArgs - Additional arguments for the address. + * * @example * ```typescript - * tevm.eth.getLog( - * MyScript.withAddress('0x420...').events.Transfer({ from: '0x1234...' }), - * ) - * === + * // Creating an event filter for a Transfer event + * const filter = MyContract.events.Transfer({ + * fromBlock: 'latest', + * toBlock: 'latest', + * args: { from: '0x1234...', to: '0x5678...' } + * }) + * + * // Using the filter with tevm + * const logs = await tevm.eth.getLogs(filter) + * ``` */ export type EventActionCreator< THumanReadableAbi extends readonly string[], @@ -45,13 +63,11 @@ export type EventActionCreator< TAddress extends Address | undefined, TAddressArgs = TAddress extends undefined ? {} : { address: TAddress }, > = { - // for every event in the abi, create an action creator [TEventName in ExtractAbiEventNames>]: (< TStrict extends boolean = false, TFromBlock extends BlockNumber | BlockTag | undefined = undefined, TToBlock extends BlockNumber | BlockTag | undefined = undefined, >( - // take take these actions. These match the shape of viem actions params: Pick< // CreateEventFilterParameters create viem like parameters // we are taking the subset that aren't implied already from Contract.event.eventName specification diff --git a/packages/contract/src/event/eventFactory.js b/packages/contract/src/event/eventFactory.js index cbdceeedf8..c035f4b589 100644 --- a/packages/contract/src/event/eventFactory.js +++ b/packages/contract/src/event/eventFactory.js @@ -1,13 +1,45 @@ import { formatAbi } from '@tevm/utils' /** - * Creates the event action creators from parameters - * @param {object} params - * @param {import('@tevm/utils').Abi} params.abi - * @param {import('@tevm/utils').Hex} [params.bytecode] - * @param {import('@tevm/utils').Hex} [params.deployedBytecode] - * @param {import('@tevm/utils').Address} [params.address] - * @returns {import('./EventActionCreator.js').EventActionCreator} + * Creates the event action creators from the given parameters. + * This factory function generates a set of typed event creators for a contract, + * allowing for easy and type-safe creation of event filters. + * + * @param {object} params - The parameters for creating event action creators. + * @param {import('@tevm/utils').Abi} params.abi - The ABI of the contract. + * @param {import('@tevm/utils').Hex} [params.bytecode] - The bytecode of the contract (optional). + * @param {import('@tevm/utils').Hex} [params.deployedBytecode] - The deployed bytecode of the contract (optional). + * @param {import('@tevm/utils').Address} [params.address] - The address of the deployed contract (optional). + * @returns {import('./EventActionCreator.js').EventActionCreator} An object containing event action creators for each event in the ABI. + * + * @example + * ```javascript + * import { eventsFactory } from './eventFactory.js' + * + * const abi = [ + * { + * type: 'event', + * name: 'Transfer', + * inputs: [ + * { type: 'address', name: 'from', indexed: true }, + * { type: 'address', name: 'to', indexed: true }, + * { type: 'uint256', name: 'value', indexed: false } + * ] + * } + * ] + * + * const events = eventsFactory({ abi }) + * + * // Create a filter for the Transfer event + * const transferFilter = events.Transfer({ + * fromBlock: 'latest', + * toBlock: 'latest', + * args: { from: '0x1234...', to: '0x5678...' } + * }) + * + * // Use the filter with tevm + * const logs = await tevm.eth.getLogs(transferFilter) + * ``` */ export const eventsFactory = ({ abi, bytecode, deployedBytecode, address }) => Object.fromEntries( @@ -17,7 +49,13 @@ export const eventsFactory = ({ abi, bytecode, deployedBytecode, address }) => }) .map((eventAbi) => { /** - * @param {object} params + * Creates an event filter for a specific event. + * @param {object} params - The parameters for creating the event filter. + * @param {import('@tevm/utils').BlockNumber | import('@tevm/utils').BlockTag} [params.fromBlock] - The starting block for the filter. + * @param {import('@tevm/utils').BlockNumber | import('@tevm/utils').BlockTag} [params.toBlock] - The ending block for the filter. + * @param {object} [params.args] - The indexed arguments to filter by. + * @param {boolean} [params.strict] - Whether to use strict matching for arguments. + * @returns {object} An object representing the event filter, including ABI and bytecode information. */ const creator = (params) => { return { diff --git a/packages/contract/src/index.ts b/packages/contract/src/index.ts index 85cbab2591..0d92f8c115 100644 --- a/packages/contract/src/index.ts +++ b/packages/contract/src/index.ts @@ -1,11 +1,9 @@ export type { Contract } from './Contract.js' -export type { CreateScript } from './CreateScript.js' export type { EventActionCreator, MaybeExtractEventArgsFromAbi, ValueOf, } from './event/EventActionCreator.js' -export type { DeployArgs } from './DeployArgs.js' export type { ReadActionCreator } from './read/ReadActionCreator.js' export type { WriteActionCreator } from './write/WriteActionCreator.js' export type { CreateContractParams } from './CreateContractParams.js' diff --git a/packages/contract/src/read/ReadActionCreator.ts b/packages/contract/src/read/ReadActionCreator.ts index f707b56866..f107a1690c 100644 --- a/packages/contract/src/read/ReadActionCreator.ts +++ b/packages/contract/src/read/ReadActionCreator.ts @@ -7,39 +7,52 @@ import type { Hex, ParseAbi, } from '@tevm/utils' -export type ValueOf = T[keyof T] -// Adapted from viem +/** + * Utility type to get the value type of an object. + * @template T - The object type. + */ +export type ValueOf = T[keyof T] /** - * A mapping of view and pure contract methods to action creators + * A mapping of view and pure contract methods to action creators. + * This type provides a way to create type-safe read actions for contract methods. + * + * @template THumanReadableAbi - The human-readable ABI of the contract. + * @template TAddress - The address of the contract (optional). + * @template TCode - The runtime bytecode of the contract (optional). + * @template TAddressArgs - Additional arguments for the address (derived from TAddress). + * * @example * ```typescript - * tevm.contract( - * MyScript.withAddress('0x420...').read.balanceOf('0x1234...'), - *) + * // Assuming we have a contract with a 'balanceOf' method + * const balanceAction = MyContract.read.balanceOf('0x1234...') + * + * // Use the action with tevm + * const balance = await tevm.contract(balanceAction) + * console.log('Balance:', balance) * ``` */ export type ReadActionCreator< THumanReadableAbi extends readonly string[], TAddress extends Address | undefined, TCode extends Hex | undefined, - // we have address and to so we support both tevm and viem with natively + // We have address and to so we support both tevm and viem natively TAddressArgs = TAddress extends undefined ? {} : { address: TAddress; to: TAddress }, > = { // For every view and pure function in the abi, create an action creator [TFunctionName in ExtractAbiFunctionNames, 'pure' | 'view'>]: (< - // extract the read functions from abi - // keep args etc. generic for typesafety reasons. This is adapted from viem + // Extract the read functions from abi + // Keep args etc. generic for typesafety reasons. This is adapted from viem TArgs extends AbiParametersToPrimitiveTypes< ExtractAbiFunction, TFunctionName>['inputs'] > & any[] = AbiParametersToPrimitiveTypes, TFunctionName>['inputs']> & any[], >( - // take the same args of the function + // Take the same args of the function ...args: TArgs - // return an action creator that matches the viem api + // Return an action creator that matches the viem api ) => { functionName: TFunctionName humanReadableAbi: FormatAbi<[ExtractAbiFunction, TFunctionName>]> diff --git a/packages/contract/src/read/readFactory.js b/packages/contract/src/read/readFactory.js index 6c1a54d849..36a6a7f504 100644 --- a/packages/contract/src/read/readFactory.js +++ b/packages/contract/src/read/readFactory.js @@ -1,28 +1,65 @@ import { formatAbi } from '@tevm/utils' /** - * Creates read action creators from parameters - * @param {object} params - * @param {import('@tevm/utils').Abi} params.methods - * @param {import('@tevm/utils').Hex} [params.code] - * @param {import('@tevm/utils').Address} [params.address] - * @returns {import('./ReadActionCreator.js').ReadActionCreator} A mapping of method names to action creators + * Creates read action creators from contract parameters. + * This factory function generates a set of typed read action creators for a contract, + * allowing for easy and type-safe creation of read actions for view and pure functions. + * + * @param {object} params - The parameters for creating read action creators. + * @param {import('@tevm/utils').Abi} params.methods - The ABI of the contract methods. + * @param {import('@tevm/utils').Hex} [params.code] - The runtime bytecode of the contract (optional). + * @param {import('@tevm/utils').Address} [params.address] - The address of the deployed contract (optional). + * @returns {import('./ReadActionCreator.js').ReadActionCreator} An object containing read action creators for each view and pure function in the ABI. + * + * @example + * ```javascript + * import { readFactory } from './readFactory.js' + * + * const abi = [ + * { + * type: 'function', + * name: 'balanceOf', + * inputs: [{ type: 'address', name: 'account' }], + * outputs: [{ type: 'uint256' }], + * stateMutability: 'view' + * } + * ] + * + * const readActions = readFactory({ + * methods: abi, + * address: '0x1234...', + * code: '0x60806040...' + * }) + * + * // Create a read action for the balanceOf function + * const balanceAction = readActions.balanceOf('0x5678...') + * + * // Use the action with tevm + * const balance = await tevm.contract(balanceAction) + * console.log('Balance:', balance) + * ``` */ export const readFactory = ({ methods, address, code }) => Object.fromEntries( methods .filter(({ type }) => type === 'function') + .filter((method) => { + const abiFunction = /** @type {import('@tevm/utils').AbiFunction} */ (method) + return abiFunction.stateMutability === 'view' || abiFunction.stateMutability === 'pure' + }) .map((method) => { /** - * @param {...any} args + * Creates a read action for a specific contract method. + * @param {...any} args - The arguments for the contract method. + * @returns {object} An object representing the read action, including ABI and method information. */ const creator = (...args) => { - // need to handle case where there is an overload - // TODO make this more efficient + // Handle case where there is an overload + // TODO: make this more efficient const methodAbi = methods.filter( (m) => /**@type {import('@tevm/utils').AbiFunction}*/ (m).name === - /**@type {import('@tevm/utils').AbiFunction}*/ (method)?.name, + /**@type {import('@tevm/utils').AbiFunction}*/ (method).name, ) const maybeArgs = args.length > 0 ? { args } : {} return { diff --git a/packages/contract/src/read/readFactory.spec.ts b/packages/contract/src/read/readFactory.spec.ts index dd2bfebfae..92754644a6 100644 --- a/packages/contract/src/read/readFactory.spec.ts +++ b/packages/contract/src/read/readFactory.spec.ts @@ -1,4 +1,4 @@ -import { formatAbi } from '@tevm/utils' +import { encodeDeployData, formatAbi } from '@tevm/utils' import { describe, expect, it } from 'vitest' import { createContract } from '../createContract.js' import { dummyAbi } from '../test/fixtures.js' @@ -137,6 +137,22 @@ describe(readFactory.name, () => { `) }) + it('should work with a contract without deployedBytecode', () => { + const contractWithoutDeployedBytecode = createContract({ + name: 'DummyContractNoDeployed', + humanReadableAbi: formatAbi(dummyAbi), + bytecode: '0x420', + }) + const read = contractWithoutDeployedBytecode.read.exampleRead('test', BigInt(123)) + expect(read).toMatchObject({ + abi: expect.any(Array), + functionName: 'exampleRead', + args: ['test', BigInt(123)], + }) + expect((read as any).deployedBytecode).toBeUndefined() + expect((read as any).code).toBeUndefined() + }) + it('should return an empty object when the provided methods includes no functions', () => { const dummyAbiNoFunction = dummyAbi.filter((abi) => abi.type !== 'function') const read = readFactory({ @@ -156,7 +172,12 @@ describe(readFactory.name, () => { humanReadableAbi: formatAbi(dummyAbi), bytecode: '0x420', deployedBytecode: '0x69', - }).script() + }).withCode( + encodeDeployData({ + abi: dummyAbi, + bytecode: '0x420', + }), + ) expect(script.read.exampleRead('data', BigInt(420))).toMatchInlineSnapshot(` { "abi": [ diff --git a/packages/contract/src/script.spec.ts b/packages/contract/src/script.spec.ts deleted file mode 100644 index f41f70d68c..0000000000 --- a/packages/contract/src/script.spec.ts +++ /dev/null @@ -1,321 +0,0 @@ -import { formatAbi, parseAbi } from '@tevm/utils' -import { describe, expect, it } from 'vitest' -import { createContract } from './createContract.js' -import { dummyAbi } from './test/fixtures.js' - -describe(createContract.name, () => { - const contract = createContract({ - humanReadableAbi: formatAbi(dummyAbi), - name: 'DummyContract', - bytecode: '0x420', - deployedBytecode: '0x69', - }).script() - - it('should have correct bytecode', () => { - expect(contract.bytecode).toBe('0x420') - expect(contract.deployedBytecode).toBe('0x69') - }) - it('should have correct name', () => { - expect(contract.name).toBe('DummyContract') - }) - - it('should contain the ABI', () => { - expect(contract.abi).toEqual(parseAbi(formatAbi(dummyAbi))) - }) - - it('should generate human readable ABI', () => { - expect(contract.humanReadableAbi).toBeDefined() - }) - - it('should contain read', () => { - // see ./read for more tests - expect(contract.read).toMatchInlineSnapshot(` - { - "exampleRead": [Function], - "exampleReadNoArgs": [Function], - "exampleWrite": [Function], - "overloadedRead": [Function], - "overloadedWrite": [Function], - } - `) - }) - - it('should contain script', () => { - expect(contract.script()).toMatchInlineSnapshot(` - { - "abi": [ - { - "inputs": [ - { - "name": "str", - "type": "string", - }, - { - "name": "num", - "type": "uint256", - }, - ], - "name": "exampleWrite", - "outputs": [ - { - "type": "string", - }, - ], - "stateMutability": "payable", - "type": "function", - }, - { - "inputs": [ - { - "name": "str", - "type": "string", - }, - ], - "name": "overloadedWrite", - "outputs": [ - { - "type": "string", - }, - ], - "stateMutability": "payable", - "type": "function", - }, - { - "inputs": [], - "name": "overloadedWrite", - "outputs": [ - { - "type": "string", - }, - ], - "stateMutability": "payable", - "type": "function", - }, - { - "inputs": [ - { - "name": "str", - "type": "string", - }, - { - "name": "num", - "type": "uint256", - }, - ], - "name": "exampleRead", - "outputs": [ - { - "type": "string", - }, - ], - "stateMutability": "pure", - "type": "function", - }, - { - "inputs": [], - "name": "exampleReadNoArgs", - "outputs": [ - { - "type": "string", - }, - ], - "stateMutability": "pure", - "type": "function", - }, - { - "inputs": [ - { - "name": "str", - "type": "string", - }, - ], - "name": "overloadedRead", - "outputs": [ - { - "type": "string", - }, - ], - "stateMutability": "pure", - "type": "function", - }, - { - "inputs": [], - "name": "overloadedRead", - "outputs": [ - { - "type": "string", - }, - ], - "stateMutability": "pure", - "type": "function", - }, - { - "inputs": [ - { - "name": "data", - "type": "string", - }, - ], - "name": "exampleEvent", - "type": "event", - }, - ], - "bytecode": "0x420", - "code": "0x420", - "deploy": [Function], - "deployedBytecode": "0x69", - "events": { - "exampleEvent": [Function], - }, - "humanReadableAbi": [ - "function exampleWrite(string str, uint256 num) payable returns (string)", - "function overloadedWrite(string str) payable returns (string)", - "function overloadedWrite() payable returns (string)", - "function exampleRead(string str, uint256 num) pure returns (string)", - "function exampleReadNoArgs() pure returns (string)", - "function overloadedRead(string str) pure returns (string)", - "function overloadedRead() pure returns (string)", - "event exampleEvent(string data)", - ], - "name": "DummyContract", - "read": { - "exampleRead": [Function], - "exampleReadNoArgs": [Function], - "exampleWrite": [Function], - "overloadedRead": [Function], - "overloadedWrite": [Function], - }, - "script": [Function], - "withAddress": [Function], - "write": { - "exampleRead": [Function], - "exampleReadNoArgs": [Function], - "exampleWrite": [Function], - "overloadedRead": [Function], - "overloadedWrite": [Function], - }, - } - `) - }) - - it('should contain write', () => { - // see ./write for more tests - expect(contract.write).toMatchInlineSnapshot(` - { - "exampleRead": [Function], - "exampleReadNoArgs": [Function], - "exampleWrite": [Function], - "overloadedRead": [Function], - "overloadedWrite": [Function], - } - `) - }) - - it('should contain events', () => { - // see ./events for more tests - expect(contract.events).toMatchInlineSnapshot(` - { - "exampleEvent": [Function], - } - `) - }) - - it('should be able to read write and event with an address', () => { - expect(contract.withAddress(`0x${'a'.repeat(40)}`).write.exampleWrite('hello', 2n)).toMatchInlineSnapshot(` - { - "abi": [ - { - "inputs": [ - { - "name": "str", - "type": "string", - }, - { - "name": "num", - "type": "uint256", - }, - ], - "name": "exampleWrite", - "outputs": [ - { - "type": "string", - }, - ], - "stateMutability": "payable", - "type": "function", - }, - ], - "address": "0xaAaAaAaaAaAaAaaAaAAAAAAAAaaaAaAaAaaAaaAa", - "args": [ - "hello", - 2n, - ], - "functionName": "exampleWrite", - "humanReadableAbi": [ - "function exampleWrite(string str, uint256 num) payable returns (string)", - ], - "to": "0xaAaAaAaaAaAaAaaAaAAAAAAAAaaaAaAaAaaAaaAa", - } - `) - expect(contract.withAddress(`0x${'a'.repeat(40)}`).read.exampleRead('hello', 2n)).toMatchInlineSnapshot(` - { - "abi": [ - { - "inputs": [ - { - "name": "str", - "type": "string", - }, - { - "name": "num", - "type": "uint256", - }, - ], - "name": "exampleRead", - "outputs": [ - { - "type": "string", - }, - ], - "stateMutability": "pure", - "type": "function", - }, - ], - "address": "0xaAaAaAaaAaAaAaaAaAAAAAAAAaaaAaAaAaaAaaAa", - "args": [ - "hello", - 2n, - ], - "code": "0x420", - "functionName": "exampleRead", - "humanReadableAbi": [ - "function exampleRead(string str, uint256 num) pure returns (string)", - ], - "to": "0xaAaAaAaaAaAaAaaAaAAAAAAAAaaaAaAaAaaAaaAa", - } - `) - expect(contract.withAddress(`0x${'a'.repeat(40)}`).events.exampleEvent({})).toMatchInlineSnapshot(` - { - "abi": [ - { - "inputs": [ - { - "name": "data", - "type": "string", - }, - ], - "name": "exampleEvent", - "type": "event", - }, - ], - "address": "0xaAaAaAaaAaAaAaaAaAAAAAAAAaaaAaAaAaaAaaAa", - "bytecode": "0x420", - "deployedBytecode": "0x69", - "eventName": "exampleEvent", - "humanReadableAbi": [ - "event exampleEvent(string data)", - ], - } - `) - }) -}) diff --git a/packages/contract/src/write/WriteActionCreator.ts b/packages/contract/src/write/WriteActionCreator.ts index cc4ec62523..4e4f4039f3 100644 --- a/packages/contract/src/write/WriteActionCreator.ts +++ b/packages/contract/src/write/WriteActionCreator.ts @@ -7,37 +7,50 @@ import type { Hex, ParseAbi, } from '@tevm/utils' -export type ValueOf = T[keyof T] -// Adapted from viem +/** + * Utility type to get the value type of an object. + * @template T - The object type. + */ +export type ValueOf = T[keyof T] /** - * A mapping of payable and nonpayable contract methods to action creators + * A mapping of payable and nonpayable contract methods to action creators. + * This type provides a way to create type-safe write actions for contract methods. + * + * @template THumanReadableAbi - The human-readable ABI of the contract. + * @template TAddress - The address of the contract (optional). + * @template TCode - The runtime bytecode of the contract (optional). + * @template TAddressArgs - Additional arguments for the address (derived from TAddress). + * * @example * ```typescript - * tevm.contract( - * MyContract.withAddress('0x420...').read.balanceOf('0x1234...'), - * ) + * // Assuming we have a contract with a 'transfer' method + * const transferAction = MyContract.write.transfer('0x1234...', 1000n) + * + * // Use the action with tevm + * const result = await tevm.contract(transferAction) + * console.log('Transaction hash:', result.transactionHash) * ``` */ export type WriteActionCreator< THumanReadableAbi extends readonly string[], TAddress extends Address | undefined, TCode extends Hex | undefined, - // we have address and to so we support both tevm and viem with natively + // We have address and to so we support both tevm and viem with natively TAddressArgs = TAddress extends undefined ? {} : { address: TAddress; to: TAddress }, > = { - // for each payable and nonpayable function in the abi, create an action creator + // For each payable and nonpayable function in the abi, create an action creator [TFunctionName in ExtractAbiFunctionNames, 'payable' | 'nonpayable'>]: (< - // extract the names of the functions - // use generic args to maintain typesafety. This is adapted from viem + // Extract the names of the functions + // Use generic args to maintain typesafety. This is adapted from viem TArgs extends AbiParametersToPrimitiveTypes< ExtractAbiFunction, TFunctionName>['inputs'] > & any[] = AbiParametersToPrimitiveTypes, TFunctionName>['inputs']> & any[], >( - // take the same args as the function + // Take the same args as the function ...args: TArgs ) => { functionName: TFunctionName diff --git a/packages/contract/src/write/writeFactory.js b/packages/contract/src/write/writeFactory.js index 60c72512bb..bbb3c1468a 100644 --- a/packages/contract/src/write/writeFactory.js +++ b/packages/contract/src/write/writeFactory.js @@ -1,41 +1,85 @@ import { formatAbi } from '@tevm/utils' /** - * Creates write action creators from parameters - * @param {object} params - * @param {import('@tevm/utils').Abi} params.methods - * @param {import('@tevm/utils').Hex} [params.code] - * @param {import('@tevm/utils').Address} [params.address] + * Creates write action creators from contract parameters. + * This factory function generates a set of typed write action creators for a contract, + * allowing for easy and type-safe creation of write actions for payable and nonpayable functions. + * + * @param {object} params - The parameters for creating write action creators. + * @param {import('@tevm/utils').Abi} params.methods - The ABI of the contract methods. + * @param {import('@tevm/utils').Hex} [params.code] - The runtime bytecode of the contract (optional). + * @param {import('@tevm/utils').Address} [params.address] - The address of the deployed contract (optional). + * @returns {import('./WriteActionCreator.js').WriteActionCreator} An object containing write action creators for each payable and nonpayable function in the ABI. + * + * @example + * ```javascript + * import { writeFactory } from './writeFactory.js' + * + * const abi = [ + * { + * type: 'function', + * name: 'transfer', + * inputs: [ + * { type: 'address', name: 'to' }, + * { type: 'uint256', name: 'amount' } + * ], + * outputs: [{ type: 'bool' }], + * stateMutability: 'nonpayable' + * } + * ] + * + * const writeActions = writeFactory({ + * methods: abi, + * address: '0x1234...', + * code: '0x60806040...' + * }) + * + * // Create a write action for the transfer function + * const transferAction = writeActions.transfer('0x5678...', 1000n) + * + * // Use the action with tevm + * const result = await tevm.contract(transferAction) + * console.log('Transaction hash:', result.transactionHash) + * ``` */ export const writeFactory = ({ methods, address, code }) => Object.fromEntries( - methods.map((method) => { - /** - * @param {...any} args - */ - const creator = (...args) => { - // need to handle case where there is an overload - // TODO make this more efficient - const methodAbi = methods.filter( - (m) => - /**@type {import('@tevm/utils').AbiFunction}*/ (m).name === - /**@type {import('@tevm/utils').AbiFunction}*/ (method)?.name, - ) - // viem and wagmi barf if we padd in undefined or [] for args so do this to accomidate viem and wagmi - const maybeArgs = args.length > 0 ? { args } : {} - return { - abi: methodAbi, - humanReadableAbi: formatAbi([method]), - functionName: /**@type {import('@tevm/utils').AbiFunction}*/ (method).name, - ...(address !== undefined ? { address, to: address } : {}), - ...maybeArgs, + methods + .filter(({ type }) => type === 'function') + .filter((method) => { + const abiFunction = /** @type {import('@tevm/utils').AbiFunction} */ (method) + return abiFunction.stateMutability === 'payable' || abiFunction.stateMutability === 'nonpayable' + }) + .map((method) => { + /** + * Creates a write action for a specific contract method. + * @param {...any} args - The arguments for the contract method. + * @returns {object} An object representing the write action, including ABI and method information. + */ + const creator = (...args) => { + // Handle case where there is an overload + // TODO: make this more efficient + const methodAbi = methods.filter( + (m) => + /**@type {import('@tevm/utils').AbiFunction}*/ (m).name === + /**@type {import('@tevm/utils').AbiFunction}*/ (method)?.name, + ) + // viem and wagmi barf if we pass in undefined or [] for args so do this to accommodate viem and wagmi + const maybeArgs = args.length > 0 ? { args } : {} + return { + abi: methodAbi, + humanReadableAbi: formatAbi([method]), + functionName: /**@type {import('@tevm/utils').AbiFunction}*/ (method).name, + ...(address !== undefined ? { address, to: address } : {}), + ...(code !== undefined ? { code } : {}), + ...maybeArgs, + } } - } - creator.abi = [method] - creator.humanReadableAbi = formatAbi([method]) - creator.code = code - creator.address = address - creator.to = address - return [/**@type {import('@tevm/utils').AbiFunction}*/ (method).name, creator] - }), + creator.abi = [method] + creator.humanReadableAbi = formatAbi([method]) + creator.code = code + creator.address = address + creator.to = address + return [/**@type {import('@tevm/utils').AbiFunction}*/ (method).name, creator] + }), ) diff --git a/packages/contract/src/write/writeFactory.spec.ts b/packages/contract/src/write/writeFactory.spec.ts index 216b15910b..5d20f98f2d 100644 --- a/packages/contract/src/write/writeFactory.spec.ts +++ b/packages/contract/src/write/writeFactory.spec.ts @@ -75,6 +75,22 @@ describe('write', () => { ] `) }) + it('should work with a contract without deployedBytecode', () => { + const contractWithoutDeployedBytecode = createContract({ + name: 'DummyContractNoDeployed', + humanReadableAbi: formatAbi(dummyAbi), + bytecode: '0x420', + code: '0x69', + }) + const write = contractWithoutDeployedBytecode.write.exampleWrite('test', BigInt(123)) + expect(write).toMatchObject({ + abi: expect.any(Array), + functionName: 'exampleWrite', + args: ['test', BigInt(123)], + }) + expect((write as any).deployedBytecode).toBeUndefined() + expect((write as any).code).toBe('0x69') + }) it('should work for overloaded function', () => { const writeInfo1Arg = contract.write.overloadedWrite('data') expect(writeInfo1Arg.args).toMatchInlineSnapshot(` diff --git a/packages/decorators/docs/README.md b/packages/decorators/docs/README.md index 267a926f04..6bc265f528 100644 --- a/packages/decorators/docs/README.md +++ b/packages/decorators/docs/README.md @@ -30,4 +30,4 @@ Action decorators for the tevm base client ## License 📄 - + diff --git a/packages/decorators/docs/_media/LICENSE b/packages/decorators/docs/_media/LICENSE deleted file mode 100644 index b5a4fa7a69..0000000000 --- a/packages/decorators/docs/_media/LICENSE +++ /dev/null @@ -1,22 +0,0 @@ -(The MIT License) - -Copyright 2020-2022 - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/packages/decorators/docs/functions/requestEip1193.md b/packages/decorators/docs/functions/requestEip1193.md index 0c26ec4ec7..edfa8e738c 100644 --- a/packages/decorators/docs/functions/requestEip1193.md +++ b/packages/decorators/docs/functions/requestEip1193.md @@ -8,8 +8,6 @@ > **requestEip1193**(): `Extension`\<[`Eip1193RequestProvider`](../type-aliases/Eip1193RequestProvider.md)\> -A decorator that adds the EIP-1193 request method to the client - ## Returns `Extension`\<[`Eip1193RequestProvider`](../type-aliases/Eip1193RequestProvider.md)\> diff --git a/packages/decorators/docs/functions/tevmSend.md b/packages/decorators/docs/functions/tevmSend.md index a014a3e65c..bf6757ed9b 100644 --- a/packages/decorators/docs/functions/tevmSend.md +++ b/packages/decorators/docs/functions/tevmSend.md @@ -8,10 +8,6 @@ > **tevmSend**(): `Extension`\<[`TevmSendApi`](../type-aliases/TevmSendApi.md)\> -The low level method for sending and recieving a JSON-RPC request. -Strictly adheres to the JSON-RPC 2.0 spec. -See `requestEip1193` for a more user friendly method. - ## Returns `Extension`\<[`TevmSendApi`](../type-aliases/TevmSendApi.md)\> diff --git a/packages/decorators/docs/type-aliases/EthActionsApi.md b/packages/decorators/docs/type-aliases/EthActionsApi.md index a29f312feb..f3d38779f5 100644 --- a/packages/decorators/docs/type-aliases/EthActionsApi.md +++ b/packages/decorators/docs/type-aliases/EthActionsApi.md @@ -11,6 +11,10 @@ The actions api is the high level API for interacting with a Tevm client similar to [viem actions](https://viem.sh/learn/actions/) These actions correspond 1:1 eith the public ethereum JSON-RPC api +## See + +[https://tevm.sh/learn/actions/](https://tevm.sh/learn/actions/) + ## Type declaration ### eth @@ -154,10 +158,6 @@ Block tag defaults to 'pending' tag which is the optimistic state of the VM const storageValue = await tevm.eth.getStorageAt({address: '0x123...', position: 0}) ``` -## See - -[https://tevm.sh/learn/actions/](https://tevm.sh/learn/actions/) - ## Defined in [actions/EthActionsApi.ts:16](https://github.com/evmts/tevm-monorepo/blob/main/packages/decorators/src/actions/EthActionsApi.ts#L16) diff --git a/packages/decorators/docs/type-aliases/TevmActionsApi.md b/packages/decorators/docs/type-aliases/TevmActionsApi.md index 9c95febea3..3914b52619 100644 --- a/packages/decorators/docs/type-aliases/TevmActionsApi.md +++ b/packages/decorators/docs/type-aliases/TevmActionsApi.md @@ -10,6 +10,10 @@ The actions api is the high level API for interacting with a Tevm client similar to [viem actions](https://viem.sh/learn/actions/) +## See + +[https://tevm.sh/learn/actions/](https://tevm.sh/learn/actions/) + ## Type declaration ### call @@ -178,10 +182,6 @@ await tevm.setAccount({ }) ``` -## See - -[https://tevm.sh/learn/actions/](https://tevm.sh/learn/actions/) - ## Defined in [actions/TevmActionsApi.ts:17](https://github.com/evmts/tevm-monorepo/blob/main/packages/decorators/src/actions/TevmActionsApi.ts#L17) diff --git a/packages/decorators/package.json b/packages/decorators/package.json index 3bb91aae91..d8b11b62ae 100644 --- a/packages/decorators/package.json +++ b/packages/decorators/package.json @@ -19,6 +19,7 @@ "contributors": [ "Will Cory " ], + "sideEffects": false, "type": "module", "exports": { "./package.json": "./package.json", @@ -77,6 +78,5 @@ }, "publishConfig": { "access": "public" - }, - "sideEffects": false + } } \ No newline at end of file diff --git a/packages/effect/package.json b/packages/effect/package.json index 0816697c80..e4b38423a8 100644 --- a/packages/effect/package.json +++ b/packages/effect/package.json @@ -16,6 +16,7 @@ "contributors": [ "Will Cory " ], + "sideEffects": false, "type": "module", "exports": { "./package.json": "./package.json", @@ -69,6 +70,5 @@ }, "publishConfig": { "access": "public" - }, - "sideEffects": false + } } \ No newline at end of file diff --git a/packages/errors/docs/classes/ForkError.md b/packages/errors/docs/classes/ForkError.md index a9a420e0aa..1457957769 100644 --- a/packages/errors/docs/classes/ForkError.md +++ b/packages/errors/docs/classes/ForkError.md @@ -80,7 +80,7 @@ Additional parameters for the error. #### Defined in -[packages/errors/src/fork/ForkError.js:72](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/fork/ForkError.js#L72) +[packages/errors/src/fork/ForkError.js:73](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/fork/ForkError.js#L73) *** @@ -178,7 +178,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -[packages/errors/src/fork/ForkError.js:71](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/fork/ForkError.js#L71) +[packages/errors/src/fork/ForkError.js:72](https://github.com/evmts/tevm-monorepo/blob/main/packages/errors/src/fork/ForkError.js#L72) *** diff --git a/packages/errors/package.json b/packages/errors/package.json index a52ca3274a..7544a2d0b3 100644 --- a/packages/errors/package.json +++ b/packages/errors/package.json @@ -19,6 +19,7 @@ "contributors": [ "Will Cory " ], + "sideEffects": false, "type": "module", "exports": { "./package.json": "./package.json", @@ -73,6 +74,5 @@ }, "publishConfig": { "access": "public" - }, - "sideEffects": false + } } \ No newline at end of file diff --git a/packages/evm/docs/README.md b/packages/evm/docs/README.md index 60781586cf..6caa02b524 100644 --- a/packages/evm/docs/README.md +++ b/packages/evm/docs/README.md @@ -36,4 +36,4 @@ Some files are adapted from [ethereumjs](https://github.com/ethereumjs/ethereumj ## License 📄 - + diff --git a/packages/evm/docs/_media/LICENSE b/packages/evm/docs/_media/LICENSE deleted file mode 100644 index b5a4fa7a69..0000000000 --- a/packages/evm/docs/_media/LICENSE +++ /dev/null @@ -1,22 +0,0 @@ -(The MIT License) - -Copyright 2020-2022 - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/packages/evm/docs/classes/EthjsMessage.md b/packages/evm/docs/classes/EthjsMessage.md index 0ec87f6e9f..f8d925cb7f 100644 --- a/packages/evm/docs/classes/EthjsMessage.md +++ b/packages/evm/docs/classes/EthjsMessage.md @@ -22,7 +22,7 @@ #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:64 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:65 ## Properties @@ -32,17 +32,17 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:38 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:39 *** ### accessWitness? -> `optional` **accessWitness**: `AccessWitness` +> `optional` **accessWitness**: `AccessWitnessInterface` #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:63 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:64 *** @@ -55,7 +55,7 @@ the purpose is to figure out where `value` should be taken from (not from `calle #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:57 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:58 *** @@ -67,7 +67,7 @@ List of versioned hashes if message is a blob transaction in the outer VM #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:62 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:63 *** @@ -77,7 +77,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:33 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:34 *** @@ -87,7 +87,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:43 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:44 *** @@ -97,7 +97,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:37 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:38 *** @@ -107,19 +107,19 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:42 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:43 *** ### createdAddresses? -> `optional` **createdAddresses**: `Set`\<`string`\> +> `optional` **createdAddresses**: `Set`\<\`0x$\{string\}\`\> Map of addresses which were created (used in EIP 6780) #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:51 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:52 *** @@ -129,7 +129,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:35 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:36 *** @@ -139,7 +139,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:52 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:53 *** @@ -149,7 +149,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:36 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:37 *** @@ -159,7 +159,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:34 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:35 *** @@ -169,7 +169,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:58 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:59 *** @@ -179,7 +179,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:40 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:41 *** @@ -189,7 +189,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:39 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:40 *** @@ -199,19 +199,19 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:41 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:42 *** ### selfdestruct? -> `optional` **selfdestruct**: `Set`\<`string`\> +> `optional` **selfdestruct**: `Set`\<\`0x$\{string\}\`\> Set of addresses to selfdestruct. Key is the unprefixed address. #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:47 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:48 *** @@ -221,7 +221,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:31 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:32 *** @@ -231,7 +231,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:32 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:33 ## Accessors @@ -247,4 +247,4 @@ Note: should only be called in instances where `_codeAddress` or `to` is defined #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:68 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:69 diff --git a/packages/evm/docs/classes/Evm.md b/packages/evm/docs/classes/Evm.md index d1c50e80b0..41f075e261 100644 --- a/packages/evm/docs/classes/Evm.md +++ b/packages/evm/docs/classes/Evm.md @@ -32,19 +32,19 @@ Initialized bn128 WASM object for precompile usage (internal) [`Evm`](Evm.md) +#### Inherited from + +`EthereumEVM.constructor` + #### Deprecated The direct usage of this constructor is replaced since non-finalized async initialization lead to side effects. Please use the async EVM.create constructor instead (same API). -#### Inherited from - -`EthereumEVM.constructor` - #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:77 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:78 ## Properties @@ -58,7 +58,21 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:27 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:27 + +*** + +### \_bls? + +> `protected` `readonly` `optional` **\_bls**: `EVMBLSInterface` + +#### Inherited from + +`EthereumEVM._bls` + +#### Defined in + +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:47 *** @@ -72,7 +86,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:37 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:37 *** @@ -100,7 +114,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:40 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:40 *** @@ -124,7 +138,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:56 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:57 *** @@ -138,7 +152,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:39 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:39 *** @@ -152,7 +166,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:41 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:41 *** @@ -166,7 +180,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:34 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:34 *** @@ -180,7 +194,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:43 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:43 *** @@ -194,7 +208,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:42 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:42 *** @@ -216,7 +230,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:23 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:23 *** @@ -230,7 +244,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:35 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:35 *** @@ -244,7 +258,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:36 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:36 *** @@ -258,7 +272,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:31 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:31 *** @@ -272,7 +286,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:28 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:28 *** @@ -286,7 +300,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:29 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:29 *** @@ -300,7 +314,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:32 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:32 *** @@ -314,7 +328,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:44 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:44 *** @@ -342,7 +356,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:33 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:33 *** @@ -356,7 +370,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:22 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:22 ## Accessors @@ -374,7 +388,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:46 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:46 *** @@ -392,7 +406,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:45 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:45 ## Methods @@ -416,7 +430,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:112 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:113 *** @@ -438,7 +452,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:83 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:84 *** @@ -460,7 +474,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:84 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:85 *** @@ -482,7 +496,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:110 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:111 *** @@ -504,7 +518,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:109 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:110 *** @@ -528,7 +542,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:111 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:112 *** @@ -564,7 +578,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:131 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:132 *** @@ -585,7 +599,7 @@ available for EVM execution #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:82 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:83 *** @@ -611,7 +625,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:127 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:128 *** @@ -636,7 +650,7 @@ if no such precompile exists. #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:104 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:105 *** @@ -680,7 +694,7 @@ if an exception happens during the message execution. #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:94 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:95 *** @@ -705,7 +719,7 @@ shouldn't be used directly from the evm class #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:99 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:100 *** @@ -731,7 +745,7 @@ Starts the actual bytecode processing for a CALL or CREATE #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:88 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:89 *** @@ -759,7 +773,7 @@ Executes a precompiled contract with given data and gas limit. #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:108 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:109 *** @@ -785,7 +799,7 @@ EVM #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:126 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:127 *** diff --git a/packages/evm/docs/classes/EvmError.md b/packages/evm/docs/classes/EvmError.md index 1052a7cacf..4eb5e80680 100644 --- a/packages/evm/docs/classes/EvmError.md +++ b/packages/evm/docs/classes/EvmError.md @@ -22,7 +22,7 @@ #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:39 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:37 ## Properties @@ -32,7 +32,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:37 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:35 *** @@ -42,4 +42,4 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:38 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:36 diff --git a/packages/evm/docs/enumerations/EvmErrorMessage.md b/packages/evm/docs/enumerations/EvmErrorMessage.md index eb2aa5edec..9fe4509084 100644 --- a/packages/evm/docs/enumerations/EvmErrorMessage.md +++ b/packages/evm/docs/enumerations/EvmErrorMessage.md @@ -8,33 +8,13 @@ ## Enumeration Members -### AUTHCALL\_NONZERO\_VALUEEXT - -> **AUTHCALL\_NONZERO\_VALUEEXT**: `"attempting to execute AUTHCALL with nonzero external value"` - -#### Defined in - -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:26 - -*** - ### AUTHCALL\_UNSET > **AUTHCALL\_UNSET**: `"attempting to AUTHCALL without AUTH set"` #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:25 - -*** - -### AUTH\_INVALID\_S - -> **AUTH\_INVALID\_S**: `"invalid Signature: s-values greater than secp256k1n/2 are considered invalid"` - -#### Defined in - -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:27 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:25 *** @@ -44,7 +24,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:31 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:29 *** @@ -54,7 +34,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:30 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:28 *** @@ -64,7 +44,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:28 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:26 *** @@ -74,7 +54,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:29 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:27 *** @@ -84,7 +64,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:4 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:4 *** @@ -94,7 +74,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:3 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:3 *** @@ -104,7 +84,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:13 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:13 *** @@ -114,7 +94,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:23 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:23 *** @@ -124,7 +104,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:17 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:17 *** @@ -134,7 +114,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:12 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:12 *** @@ -144,7 +124,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:18 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:18 *** @@ -154,7 +134,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:21 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:21 *** @@ -164,7 +144,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:32 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:30 *** @@ -174,7 +154,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:22 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:22 *** @@ -184,7 +164,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:33 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:31 *** @@ -194,7 +174,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:24 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:24 *** @@ -204,7 +184,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:7 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:7 *** @@ -214,7 +194,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:20 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:20 *** @@ -224,7 +204,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:8 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:8 *** @@ -234,7 +214,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:34 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:32 *** @@ -244,7 +224,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:19 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:19 *** @@ -254,7 +234,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:2 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:2 *** @@ -264,7 +244,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:9 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:9 *** @@ -274,7 +254,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:15 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:15 *** @@ -284,7 +264,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:10 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:10 *** @@ -294,7 +274,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:6 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:6 *** @@ -304,7 +284,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:5 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:5 *** @@ -314,7 +294,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:11 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:11 *** @@ -324,7 +304,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:14 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:14 *** @@ -334,4 +314,4 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:16 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:16 diff --git a/packages/evm/docs/functions/createEvm.md b/packages/evm/docs/functions/createEvm.md index c084a1e3c9..1670812b55 100644 --- a/packages/evm/docs/functions/createEvm.md +++ b/packages/evm/docs/functions/createEvm.md @@ -19,30 +19,6 @@ Wraps [ethereumjs EVM](https://github.com/ethereumjs/ethereumjs-monorepo/tree/ma `Promise`\<[`Evm`](../classes/Evm.md)\> -## Example - -```typescript -import { createEvm } from '@tevm/evm' -import { mainnet } from '@tevm/common' -import { createBlockchain } from '@tevm/blockchain' -import { createStateManager } from '@tevm/state-manager' -import { EthjsAddress } from '@tevm/utils' - -const common = mainnet.clone() -const stateManager = createStateManager({ common }) -const blockchain = createBlockchain({ common }) -const evm = await createEvm({ common, stateManager, blockchain}) - -const runCallResult = await evm.runCall({ - to: EthjsAddress.from(`0x${'00'.repeat(20)}`), - value: 420n, - skipBalance: true, -}) -console.log(runCallResult) -```` -@param {import('./CreateEvmOptions.js').CreateEvmOptions} options -@returns {Promise} A tevm Evm instance with tevm specific defaults - ## Defined in [packages/evm/src/createEvm.js:30](https://github.com/evmts/tevm-monorepo/blob/main/packages/evm/src/createEvm.js#L30) diff --git a/packages/evm/docs/functions/getActivePrecompiles.md b/packages/evm/docs/functions/getActivePrecompiles.md index 26c3b99304..a9c24210eb 100644 --- a/packages/evm/docs/functions/getActivePrecompiles.md +++ b/packages/evm/docs/functions/getActivePrecompiles.md @@ -20,4 +20,4 @@ ## Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/precompiles/index.d.ts:37 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/precompiles/index.d.ts:38 diff --git a/packages/evm/docs/interfaces/EvmResult.md b/packages/evm/docs/interfaces/EvmResult.md index 33b66c02a8..a5600434ba 100644 --- a/packages/evm/docs/interfaces/EvmResult.md +++ b/packages/evm/docs/interfaces/EvmResult.md @@ -18,7 +18,7 @@ Address of created account during transaction, if any #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:248 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:273 *** @@ -30,4 +30,4 @@ Contains the results from running the code, if any, as described in runCode #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:252 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:277 diff --git a/packages/evm/docs/interfaces/EvmRunCallOpts.md b/packages/evm/docs/interfaces/EvmRunCallOpts.md index f079f94bac..2f9ba72325 100644 --- a/packages/evm/docs/interfaces/EvmRunCallOpts.md +++ b/packages/evm/docs/interfaces/EvmRunCallOpts.md @@ -16,11 +16,11 @@ Options for running a call (or create) operation with `EVM.runCall()` ### accessWitness? -> `optional` **accessWitness**: `AccessWitness` +> `optional` **accessWitness**: `AccessWitnessInterface` #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:115 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:114 *** @@ -36,7 +36,7 @@ Versioned hashes for each blob in a blob transaction #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:77 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:76 *** @@ -52,7 +52,7 @@ The `block` the `tx` belongs to. If omitted a default blank block will be used. #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:29 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:28 *** @@ -68,7 +68,7 @@ The address that ran this code (`msg.sender`). Defaults to the zero address. #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:41 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:40 *** @@ -84,19 +84,19 @@ The EVM code to run. #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:45 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:44 *** ### createdAddresses? -> `optional` **createdAddresses**: `Set`\<`string`\> +> `optional` **createdAddresses**: `Set`\<\`0x$\{string\}\`\> Created addresses in current context. Used in EIP 6780 #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:97 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:96 *** @@ -112,7 +112,7 @@ The input data. #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:49 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:48 *** @@ -124,7 +124,7 @@ If the call is a DELEGATECALL. Defaults to false. #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:106 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:105 *** @@ -140,7 +140,7 @@ The call depth. Defaults to `0` #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:61 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:60 *** @@ -156,7 +156,7 @@ The gas limit for the call. Defaults to `16777215` (`0xffffff`) #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:53 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:52 *** @@ -172,7 +172,7 @@ The gas price for the call. Defaults to `0` #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:33 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:32 *** @@ -184,7 +184,7 @@ Refund counter. Defaults to `0` #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:110 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:109 *** @@ -196,7 +196,7 @@ If the code location is a precompile. #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:89 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:88 *** @@ -212,7 +212,7 @@ If the call should be executed statically. Defaults to false. #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:65 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:64 *** @@ -224,7 +224,7 @@ Optionally pass in an already-built message. #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:114 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:113 *** @@ -240,7 +240,7 @@ The address where the call originated from. Defaults to the zero address. #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:37 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:36 *** @@ -252,13 +252,13 @@ An optional salt to pass to CREATE2. #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:93 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:92 *** ### selfdestruct? -> `optional` **selfdestruct**: `Set`\<`string`\> +> `optional` **selfdestruct**: `Set`\<\`0x$\{string\}\`\> Addresses to selfdestruct. Defaults to the empty set. @@ -268,7 +268,7 @@ Addresses to selfdestruct. Defaults to the empty set. #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:69 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:68 *** @@ -281,7 +281,7 @@ sets balance to message value to ensure execution doesn't fail. #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:102 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:101 *** @@ -297,7 +297,7 @@ The address of the account that is executing this code (`address(this)`). Defaul #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:73 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:72 *** @@ -313,4 +313,4 @@ The value in ether that is being sent to `opts.address`. Defaults to `0` #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:57 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:56 diff --git a/packages/evm/docs/interfaces/ExecResult.md b/packages/evm/docs/interfaces/ExecResult.md index 3e2caf25b5..e955fbfa65 100644 --- a/packages/evm/docs/interfaces/ExecResult.md +++ b/packages/evm/docs/interfaces/ExecResult.md @@ -18,19 +18,19 @@ Amount of blob gas consumed by the transaction #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:294 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:319 *** ### createdAddresses? -> `optional` **createdAddresses**: `Set`\<`string`\> +> `optional` **createdAddresses**: `Set`\<\`0x$\{string\}\`\> Map of addresses which were created (used in EIP 6780) #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:286 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:311 *** @@ -42,7 +42,7 @@ Description of the exception, if any occurred #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:262 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:287 *** @@ -54,7 +54,7 @@ Amount of gas the code used to run #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:270 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:295 *** @@ -66,7 +66,7 @@ Amount of gas left #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:266 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:291 *** @@ -78,7 +78,7 @@ The gas refund counter #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:290 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:315 *** @@ -90,7 +90,7 @@ Array of logs that the contract emitted #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:278 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:303 *** @@ -102,7 +102,7 @@ Return value from the contract #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:274 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:299 *** @@ -112,16 +112,16 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:258 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:283 *** ### selfdestruct? -> `optional` **selfdestruct**: `Set`\<`string`\> +> `optional` **selfdestruct**: `Set`\<\`0x$\{string\}\`\> A set of accounts to selfdestruct #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:282 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:307 diff --git a/packages/evm/docs/interfaces/InterpreterStep.md b/packages/evm/docs/interfaces/InterpreterStep.md index ebe8aaf513..4be32897ea 100644 --- a/packages/evm/docs/interfaces/InterpreterStep.md +++ b/packages/evm/docs/interfaces/InterpreterStep.md @@ -14,7 +14,7 @@ #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/interpreter.d.ts:94 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/interpreter.d.ts:91 *** @@ -24,7 +24,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/interpreter.d.ts:95 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/interpreter.d.ts:92 *** @@ -34,7 +34,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/interpreter.d.ts:98 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/interpreter.d.ts:95 *** @@ -44,7 +44,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/interpreter.d.ts:87 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/interpreter.d.ts:84 *** @@ -54,7 +54,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/interpreter.d.ts:81 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/interpreter.d.ts:79 *** @@ -64,7 +64,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/interpreter.d.ts:82 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/interpreter.d.ts:80 *** @@ -74,7 +74,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/interpreter.d.ts:96 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/interpreter.d.ts:93 *** @@ -84,7 +84,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/interpreter.d.ts:97 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/interpreter.d.ts:94 *** @@ -110,7 +110,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/interpreter.d.ts:88 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/interpreter.d.ts:85 *** @@ -120,17 +120,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/interpreter.d.ts:86 - -*** - -### returnStack - -> **returnStack**: `bigint`[] - -#### Defined in - -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/interpreter.d.ts:85 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/interpreter.d.ts:83 *** @@ -140,7 +130,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/interpreter.d.ts:84 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/interpreter.d.ts:82 *** @@ -150,4 +140,4 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/interpreter.d.ts:83 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/interpreter.d.ts:81 diff --git a/packages/evm/docs/interfaces/PrecompileInput.md b/packages/evm/docs/interfaces/PrecompileInput.md index 9901e87d29..e1794e01d8 100644 --- a/packages/evm/docs/interfaces/PrecompileInput.md +++ b/packages/evm/docs/interfaces/PrecompileInput.md @@ -14,7 +14,7 @@ #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/precompiles/types.d.ts:11 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/precompiles/types.d.ts:11 *** @@ -24,7 +24,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/precompiles/types.d.ts:12 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/precompiles/types.d.ts:12 *** @@ -34,7 +34,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/precompiles/types.d.ts:10 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/precompiles/types.d.ts:10 *** @@ -44,7 +44,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/precompiles/types.d.ts:8 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/precompiles/types.d.ts:8 *** @@ -54,4 +54,4 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/precompiles/types.d.ts:9 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/precompiles/types.d.ts:9 diff --git a/packages/evm/docs/type-aliases/CreateEvmOptions.md b/packages/evm/docs/type-aliases/CreateEvmOptions.md index d89503c0e9..8890656bcf 100644 --- a/packages/evm/docs/type-aliases/CreateEvmOptions.md +++ b/packages/evm/docs/type-aliases/CreateEvmOptions.md @@ -10,6 +10,37 @@ Options for [createEvm](https://tevm.sh/reference/tevm/evm/functions/createevm/) +## Example + +```typescript +import { createEvm, CreateEvmOptions } from 'tevm/evm' +import { mainnet } from 'tevm/common' +import { createStateManager } from 'tevm/state' +import { createBlockchain } from 'tevm/blockchain'} +import { EthjsAddress } from 'tevm/utils' + +const evm = createEvm({ + common: mainnet.copy(), + stateManager: createStateManager(), + blockchain: createBlockchain(), +}) + +const result = await evm.runCall({ + to: EthjsAddress.fromString(`0x${'0'.repeat(40)}`), + value: 420n, + skipBalance: true, +}) + +console.log(result) +``` +The EVM is normally encapsolated by both `@tevm/vm` Vm, TevmNode, and MemoryClient. + +## See + + - [MemoryClient](https://tevm.sh/reference/tevm/memory-client/type-aliases/memoryclient/) + - [TevmNode](https://tevm.sh/reference/tevm/node/functions/createbaseclient/) + - [Vm](https://tevm.sh/reference/tevm/vm/functions/createvm/) + ## Type declaration ### allowUnlimitedContractSize? @@ -117,37 +148,6 @@ Enable profiler. Defaults to false. A custom Tevm state manager -## Example - -```typescript -import { createEvm, CreateEvmOptions } from 'tevm/evm' -import { mainnet } from 'tevm/common' -import { createStateManager } from 'tevm/state' -import { createBlockchain } from 'tevm/blockchain'} -import { EthjsAddress } from 'tevm/utils' - -const evm = createEvm({ - common: mainnet.copy(), - stateManager: createStateManager(), - blockchain: createBlockchain(), -}) - -const result = await evm.runCall({ - to: EthjsAddress.fromString(`0x${'0'.repeat(40)}`), - value: 420n, - skipBalance: true, -}) - -console.log(result) -``` -The EVM is normally encapsolated by both `@tevm/vm` Vm, TevmNode, and MemoryClient. - -## See - - - [MemoryClient](https://tevm.sh/reference/tevm/memory-client/type-aliases/memoryclient/) - - [TevmNode](https://tevm.sh/reference/tevm/node/functions/createbaseclient/) - - [Vm](https://tevm.sh/reference/tevm/vm/functions/createvm/) - ## Defined in [packages/evm/src/CreateEvmOptions.ts:37](https://github.com/evmts/tevm-monorepo/blob/main/packages/evm/src/CreateEvmOptions.ts#L37) diff --git a/packages/evm/docs/variables/Eof.md b/packages/evm/docs/variables/Eof.md index 23f08eaf25..8694b57258 100644 --- a/packages/evm/docs/variables/Eof.md +++ b/packages/evm/docs/variables/Eof.md @@ -48,4 +48,4 @@ ## Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/eof.d.ts:18 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/eof.d.ts:18 diff --git a/packages/evm/package.json b/packages/evm/package.json index bf964913b1..7a5f7bdcba 100644 --- a/packages/evm/package.json +++ b/packages/evm/package.json @@ -19,6 +19,7 @@ "contributors": [ "Will Cory " ], + "sideEffects": false, "type": "module", "exports": { "./package.json": "./package.json", @@ -77,6 +78,5 @@ }, "publishConfig": { "access": "public" - }, - "sideEffects": false + } } \ No newline at end of file diff --git a/packages/http-client/docs/README.md b/packages/http-client/docs/README.md index 2d7a4bdf6e..0cf67be68b 100644 --- a/packages/http-client/docs/README.md +++ b/packages/http-client/docs/README.md @@ -38,4 +38,4 @@ npm install @tevm/remote-tevm ## License 📄 - + diff --git a/packages/http-client/docs/_media/LICENSE b/packages/http-client/docs/_media/LICENSE deleted file mode 100644 index b5a4fa7a69..0000000000 --- a/packages/http-client/docs/_media/LICENSE +++ /dev/null @@ -1,22 +0,0 @@ -(The MIT License) - -Copyright 2020-2022 - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/packages/http-client/docs/functions/createHttpClient.md b/packages/http-client/docs/functions/createHttpClient.md index 1a53705bd4..d4c945ae18 100644 --- a/packages/http-client/docs/functions/createHttpClient.md +++ b/packages/http-client/docs/functions/createHttpClient.md @@ -16,17 +16,6 @@ [`HttpClient`](../type-aliases/HttpClient.md) -## Deprecated - -a new version of HttpClient will be built in a future version -For now we suggest you use viem - -## Example - -```ts - -``` - ## Defined in [createHttpClient.js:11](https://github.com/evmts/tevm-monorepo/blob/main/packages/http-client/src/createHttpClient.js#L11) diff --git a/packages/http-client/docs/type-aliases/HttpClient.md b/packages/http-client/docs/type-aliases/HttpClient.md index f6a2723f30..1b7886c305 100644 --- a/packages/http-client/docs/type-aliases/HttpClient.md +++ b/packages/http-client/docs/type-aliases/HttpClient.md @@ -8,6 +8,10 @@ > **HttpClient**: `TevmClient` & `object` +## Deprecated + +a new http client will be created in a future version. For now it's recomended to use viem + ## Type declaration ### ~~name~~ @@ -22,10 +26,6 @@ Name of the client The url being used to connect to the remote Tevm backend -## Deprecated - -a new http client will be created in a future version. For now it's recomended to use viem - ## Defined in [HttpClient.ts:6](https://github.com/evmts/tevm-monorepo/blob/main/packages/http-client/src/HttpClient.ts#L6) diff --git a/packages/http-client/docs/type-aliases/HttpClientOptions.md b/packages/http-client/docs/type-aliases/HttpClientOptions.md index bc149fa986..10da5ae81e 100644 --- a/packages/http-client/docs/type-aliases/HttpClientOptions.md +++ b/packages/http-client/docs/type-aliases/HttpClientOptions.md @@ -8,6 +8,10 @@ > **HttpClientOptions**: `object` +## Deprecated + +Options for a HttpClient + ## Type declaration ### ~~name?~~ @@ -22,10 +26,6 @@ Optional name for the client Remote URL to connect to -## Deprecated - -Options for a HttpClient - ## Defined in [HttpClientOptions.ts:5](https://github.com/evmts/tevm-monorepo/blob/main/packages/http-client/src/HttpClientOptions.ts#L5) diff --git a/packages/http-client/package.json b/packages/http-client/package.json index fc36b76ea6..8d5b76cb13 100644 --- a/packages/http-client/package.json +++ b/packages/http-client/package.json @@ -19,6 +19,7 @@ "contributors": [ "Will Cory " ], + "sideEffects": false, "type": "module", "exports": { "./package.json": "./package.json", @@ -79,6 +80,5 @@ }, "publishConfig": { "access": "public" - }, - "sideEffects": false + } } \ No newline at end of file diff --git a/packages/http-client/src/createHttpClient.spec.ts b/packages/http-client/src/createHttpClient.spec.ts index fde2a9bfca..ef454b0ab4 100644 --- a/packages/http-client/src/createHttpClient.spec.ts +++ b/packages/http-client/src/createHttpClient.spec.ts @@ -30,7 +30,7 @@ describe.skip(createHttpClient.name, () => { 'tevm.script', async () => { const { Add } = await import('./test/Add.s.sol.js') - expect(await client.contract(Add.script().read.add(399n, 21n))).toEqual({ + expect(await client.contract(Add.withCode(Add.deployedBytecode).read.add(399n, 21n))).toEqual({ data: 420n, executionGasUsed: 927n, createdAddresses: new Set(), diff --git a/packages/jsonrpc/docs/README.md b/packages/jsonrpc/docs/README.md index 9e4c158727..1ebce546ae 100644 --- a/packages/jsonrpc/docs/README.md +++ b/packages/jsonrpc/docs/README.md @@ -26,7 +26,7 @@ # @tevm/jsonrpc -[Simple lightweight client](./src/jsonrpc.js) for interacting with a jsonrpc api +[Simple lightweight client]() for interacting with a jsonrpc api ## Visit [Docs](https://tevm.sh/) for docs, guides, API and more! @@ -34,4 +34,4 @@ ## License 📄 - + diff --git a/packages/jsonrpc/docs/_media/LICENSE b/packages/jsonrpc/docs/_media/LICENSE deleted file mode 100644 index b5a4fa7a69..0000000000 --- a/packages/jsonrpc/docs/_media/LICENSE +++ /dev/null @@ -1,22 +0,0 @@ -(The MIT License) - -Copyright 2020-2022 - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/packages/jsonrpc/docs/functions/createJsonRpcFetcher.md b/packages/jsonrpc/docs/functions/createJsonRpcFetcher.md index 0f43190ab7..507728d635 100644 --- a/packages/jsonrpc/docs/functions/createJsonRpcFetcher.md +++ b/packages/jsonrpc/docs/functions/createJsonRpcFetcher.md @@ -20,27 +20,6 @@ the `result` field from the JSON-RPC response -## Deprecated - -Makes a JSON-RPC request to a url -Returns the entire JSON-RPC response rather than throwing and only returning result -Used currently as an adapter to avoid refactoring existing code - -## See - -https://ethereum.org/en/developers/docs/apis/json-rpc/ - -## Example - -```typescript -const url = 'https://mainnet.optimism.io' -const params = { - method: 'eth_getBlockByNumber', - params: ['latest', false], -} -const {result: block} = await fetchJsonRpc(url, params) -``` - ## Defined in [packages/jsonrpc/src/createJsonRpcFetcher.js:19](https://github.com/evmts/tevm-monorepo/blob/main/packages/jsonrpc/src/createJsonRpcFetcher.js#L19) diff --git a/packages/jsonrpc/docs/functions/http.md b/packages/jsonrpc/docs/functions/http.md index 3fee2bce4b..52bccd01cf 100644 --- a/packages/jsonrpc/docs/functions/http.md +++ b/packages/jsonrpc/docs/functions/http.md @@ -26,4 +26,4 @@ Creates a HTTP transport that connects to a JSON-RPC API. ## Defined in -node\_modules/.pnpm/viem@2.16.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/clients/transports/http.d.ts:44 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/clients/transports/http.d.ts:44 diff --git a/packages/jsonrpc/docs/functions/loadBalance.md b/packages/jsonrpc/docs/functions/loadBalance.md index d0e12d4304..126f9165ee 100644 --- a/packages/jsonrpc/docs/functions/loadBalance.md +++ b/packages/jsonrpc/docs/functions/loadBalance.md @@ -16,10 +16,6 @@ `Transport` -## Description - -Creates a load balanced transport that spreads requests between child transports using a round robin algorithm. - ## Defined in -node\_modules/.pnpm/@ponder+utils@0.1.6\_typescript@5.5.4\_viem@2.16.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8\_/node\_modules/@ponder/utils/dist/index.d.ts:44 +node\_modules/.pnpm/@ponder+utils@0.1.7\_typescript@5.5.4\_viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8\_/node\_modules/@ponder/utils/dist/index.d.ts:44 diff --git a/packages/jsonrpc/docs/functions/rateLimit.md b/packages/jsonrpc/docs/functions/rateLimit.md index 76223fa117..8be79195ec 100644 --- a/packages/jsonrpc/docs/functions/rateLimit.md +++ b/packages/jsonrpc/docs/functions/rateLimit.md @@ -22,10 +22,6 @@ `Transport` -## Description - -Creates a rate limited transport that throttles request throughput. - ## Defined in -node\_modules/.pnpm/@ponder+utils@0.1.6\_typescript@5.5.4\_viem@2.16.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8\_/node\_modules/@ponder/utils/dist/index.d.ts:49 +node\_modules/.pnpm/@ponder+utils@0.1.7\_typescript@5.5.4\_viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8\_/node\_modules/@ponder/utils/dist/index.d.ts:49 diff --git a/packages/jsonrpc/docs/functions/webSocket.md b/packages/jsonrpc/docs/functions/webSocket.md index cbd4d3339f..f90c9225d8 100644 --- a/packages/jsonrpc/docs/functions/webSocket.md +++ b/packages/jsonrpc/docs/functions/webSocket.md @@ -26,4 +26,4 @@ Creates a WebSocket transport that connects to a JSON-RPC API. ## Defined in -node\_modules/.pnpm/viem@2.16.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/clients/transports/webSocket.d.ts:54 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/clients/transports/webSocket.d.ts:59 diff --git a/packages/jsonrpc/package.json b/packages/jsonrpc/package.json index bc45f63221..adf2b0a74a 100644 --- a/packages/jsonrpc/package.json +++ b/packages/jsonrpc/package.json @@ -21,6 +21,7 @@ "contributors": [ "Will Cory " ], + "sideEffects": false, "type": "module", "exports": { "./package.json": "./package.json", @@ -75,6 +76,5 @@ }, "publishConfig": { "access": "public" - }, - "sideEffects": false + } } \ No newline at end of file diff --git a/packages/logger/package.json b/packages/logger/package.json index d02f43dd0f..2dddfb46e0 100644 --- a/packages/logger/package.json +++ b/packages/logger/package.json @@ -19,6 +19,7 @@ "contributors": [ "Will Cory " ], + "sideEffects": false, "type": "module", "exports": { "./package.json": "./package.json", @@ -70,6 +71,5 @@ }, "publishConfig": { "access": "public" - }, - "sideEffects": false + } } \ No newline at end of file diff --git a/packages/memory-client/docs/functions/createClient.md b/packages/memory-client/docs/functions/createClient.md index 3ef1f0381f..18607b9544 100644 --- a/packages/memory-client/docs/functions/createClient.md +++ b/packages/memory-client/docs/functions/createClient.md @@ -28,4 +28,4 @@ ## Defined in -node\_modules/.pnpm/viem@2.16.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/clients/createClient.d.ts:99 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/clients/createClient.d.ts:99 diff --git a/packages/memory-client/docs/functions/createMemoryClient.md b/packages/memory-client/docs/functions/createMemoryClient.md index ba57c542c1..65fe187e93 100644 --- a/packages/memory-client/docs/functions/createMemoryClient.md +++ b/packages/memory-client/docs/functions/createMemoryClient.md @@ -13,7 +13,7 @@ It comes batteries included with all wallet, test, public, and tevm actions. ## Type Parameters -• **TCommon** *extends* `Chain` & `object` = `Chain` & `object` +• **TCommon** *extends* `object` & `object` & `ChainConfig`\<`undefined` \| `ChainFormatters`, `undefined` \| `Record`\<`string`, `unknown`\>\> = `object` & `object` & `ChainConfig`\<`undefined` \| `ChainFormatters`, `undefined` \| `Record`\<`string`, `unknown`\>\> • **TAccountOrAddress** *extends* `undefined` \| \`0x$\{string\}\` \| `Account` = `undefined` @@ -42,16 +42,6 @@ Adds an EVM chain to the wallet. - Docs: https://viem.sh/docs/actions/wallet/addChain - JSON-RPC Methods: [`eth_addEthereumChain`](https://eips.ethereum.org/EIPS/eip-3085) -#### Parameters - -• **args**: `AddChainParameters` - -AddChainParameters - -#### Returns - -`Promise`\<`void`\> - #### Example ```ts @@ -64,6 +54,16 @@ const client = createWalletClient({ await client.addChain({ chain: optimism }) ``` +#### Parameters + +• **args**: `AddChainParameters` + +AddChainParameters + +#### Returns + +`Promise`\<`void`\> + ### batch? > `optional` **batch**: `object` @@ -132,63 +132,63 @@ Filter. CreateBlockFilterReturnType ### createContractEventFilter() -> **createContractEventFilter**: \<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>(`args`) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> +> **createContractEventFilter**: \<`abi`, `eventName`, `args`, `strict`, `fromBlock`, `toBlock`\>(`args`) => `Promise`\<`CreateContractEventFilterReturnType`\<`abi`, `eventName`, `args`, `strict`, `fromBlock`, `toBlock`\>\> #### Type Parameters -• **TAbi** *extends* `Abi` \| readonly `unknown`[] +• **abi** *extends* `Abi` \| readonly `unknown`[] -• **TEventName** *extends* `undefined` \| `string` +• **eventName** *extends* `undefined` \| `string` -• **TArgs** *extends* `undefined` \| `Record`\<`string`, `unknown`\> \| readonly `unknown`[] +• **args** *extends* `undefined` \| `Record`\<`string`, `unknown`\> \| readonly `unknown`[] -• **TStrict** *extends* `undefined` \| `boolean` = `undefined` +• **strict** *extends* `undefined` \| `boolean` = `undefined` -• **TFromBlock** *extends* `undefined` \| `bigint` \| `BlockTag` = `undefined` +• **fromBlock** *extends* `undefined` \| `bigint` \| `BlockTag` = `undefined` -• **TToBlock** *extends* `undefined` \| `bigint` \| `BlockTag` = `undefined` +• **toBlock** *extends* `undefined` \| `bigint` \| `BlockTag` = `undefined` #### Parameters -• **args**: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\> +• **args**: `CreateContractEventFilterParameters`\<`abi`, `eventName`, `args`, `strict`, `fromBlock`, `toBlock`\> CreateContractEventFilterParameters #### Returns -`Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> +`Promise`\<`CreateContractEventFilterReturnType`\<`abi`, `eventName`, `args`, `strict`, `fromBlock`, `toBlock`\>\> [`Filter`](https://viem.sh/docs/glossary/types#filter). CreateContractEventFilterReturnType ### createEventFilter() -> **createEventFilter**: \<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>(`args`?) => `Promise`\<\{ \[K in string \| number \| symbol\]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>\[K\] \}\> +> **createEventFilter**: \<`abiEvent`, `abiEvents`, `strict`, `fromBlock`, `toBlock`, `_EventName`, `_Args`\>(`args`?) => `Promise`\<\{ \[K in string \| number \| symbol\]: Filter\<"event", abiEvents, \_EventName, \_Args, strict, fromBlock, toBlock\>\[K\] \}\> #### Type Parameters -• **TAbiEvent** *extends* `undefined` \| `AbiEvent` = `undefined` +• **abiEvent** *extends* `undefined` \| `AbiEvent` = `undefined` -• **TAbiEvents** *extends* `undefined` \| readonly `unknown`[] \| readonly `AbiEvent`[] = `TAbiEvent` *extends* `AbiEvent` ? [`TAbiEvent`\<`TAbiEvent`\>] : `undefined` +• **abiEvents** *extends* `undefined` \| readonly `unknown`[] \| readonly `AbiEvent`[] = `abiEvent` *extends* `AbiEvent` ? [`abiEvent`\<`abiEvent`\>] : `undefined` -• **TStrict** *extends* `undefined` \| `boolean` = `undefined` +• **strict** *extends* `undefined` \| `boolean` = `undefined` -• **TFromBlock** *extends* `undefined` \| `bigint` \| `BlockTag` = `undefined` +• **fromBlock** *extends* `undefined` \| `bigint` \| `BlockTag` = `undefined` -• **TToBlock** *extends* `undefined` \| `bigint` \| `BlockTag` = `undefined` +• **toBlock** *extends* `undefined` \| `bigint` \| `BlockTag` = `undefined` -• **_EventName** *extends* `undefined` \| `string` = `MaybeAbiEventName`\<`TAbiEvent`\> +• **_EventName** *extends* `undefined` \| `string` = `MaybeAbiEventName`\<`abiEvent`\> • **_Args** *extends* `undefined` \| `Record`\<`string`, `unknown`\> \| readonly `unknown`[] = `undefined` #### Parameters -• **args?**: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\> +• **args?**: `CreateEventFilterParameters`\<`abiEvent`, `abiEvents`, `strict`, `fromBlock`, `toBlock`, `_EventName`, `_Args`\> CreateEventFilterParameters #### Returns -`Promise`\<\{ \[K in string \| number \| symbol\]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>\[K\] \}\> +`Promise`\<\{ \[K in string \| number \| symbol\]: Filter\<"event", abiEvents, \_EventName, \_Args, strict, fromBlock, toBlock\>\[K\] \}\> [`Filter`](https://viem.sh/docs/glossary/types#filter). CreateEventFilterReturnType @@ -244,16 +244,6 @@ Removes a transaction from the mempool. - Docs: https://viem.sh/docs/actions/test/dropTransaction -#### Parameters - -• **args**: `DropTransactionParameters` - -DropTransactionParameters - -#### Returns - -`Promise`\<`void`\> - #### Example ```ts @@ -270,6 +260,16 @@ await client.dropTransaction({ }) ``` +#### Parameters + +• **args**: `DropTransactionParameters` + +DropTransactionParameters + +#### Returns + +`Promise`\<`void`\> + ### dumpState() > **dumpState**: () => `Promise`\<\`0x$\{string\}\`\> @@ -279,10 +279,6 @@ accounts properties, etc.) into a savable data blob. - Docs: https://viem.sh/docs/actions/test/dumpState -#### Returns - -`Promise`\<\`0x$\{string\}\`\> - #### Example ```ts @@ -297,13 +293,17 @@ const client = createTestClient({ await client.dumpState() ``` +#### Returns + +`Promise`\<\`0x$\{string\}\`\> + ### estimateContractGas() -> **estimateContractGas**: \<`TChain`, `abi`, `functionName`, `args`\>(`args`) => `Promise`\<`bigint`\> +> **estimateContractGas**: \<`chain`, `abi`, `functionName`, `args`\>(`args`) => `Promise`\<`bigint`\> #### Type Parameters -• **TChain** *extends* `undefined` \| `Chain` +• **chain** *extends* `undefined` \| `Chain` • **abi** *extends* `Abi` \| readonly `unknown`[] @@ -313,7 +313,7 @@ await client.dumpState() #### Parameters -• **args**: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\> +• **args**: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `chain`\> EstimateContractGasParameters @@ -325,21 +325,21 @@ The gas estimate (in wei). EstimateContractGasReturnType ### estimateFeesPerGas() -> **estimateFeesPerGas**: \<`TChainOverride`, `TType`\>(`args`?) => `Promise`\<`EstimateFeesPerGasReturnType`\> +> **estimateFeesPerGas**: \<`chainOverride`, `type`\>(`args`?) => `Promise`\<`EstimateFeesPerGasReturnType`\<`type`\>\> #### Type Parameters -• **TChainOverride** *extends* `undefined` \| `Chain` = `undefined` +• **chainOverride** *extends* `undefined` \| `Chain` = `undefined` -• **TType** *extends* `FeeValuesType` = `"eip1559"` +• **type** *extends* `FeeValuesType` = `"eip1559"` #### Parameters -• **args?**: `EstimateFeesPerGasParameters`\<`TCommon`, `TChainOverride`, `TType`\> +• **args?**: `EstimateFeesPerGasParameters`\<`TCommon`, `chainOverride`, `type`\> #### Returns -`Promise`\<`EstimateFeesPerGasReturnType`\> +`Promise`\<`EstimateFeesPerGasReturnType`\<`type`\>\> An estimate (in wei) for the fees per gas. EstimateFeesPerGasReturnType @@ -361,15 +361,15 @@ The gas estimate (in wei). EstimateGasReturnType ### estimateMaxPriorityFeePerGas() -> **estimateMaxPriorityFeePerGas**: \<`TChainOverride`\>(`args`?) => `Promise`\<`bigint`\> +> **estimateMaxPriorityFeePerGas**: \<`chainOverride`\>(`args`?) => `Promise`\<`bigint`\> #### Type Parameters -• **TChainOverride** *extends* `undefined` \| `Chain` = `undefined` +• **chainOverride** *extends* `undefined` \| `Chain` = `undefined` #### Parameters -• **args?**: `GetChainParameter`\<`TCommon`, `TChainOverride`\> +• **args?**: `GetChainParameter`\<`TCommon`, `chainOverride`\> #### Returns @@ -441,23 +441,23 @@ The blob base fee (in wei). GetBlobBaseFeeReturnType ### getBlock() -> **getBlock**: \<`TIncludeTransactions`, `TBlockTag`\>(`args`?) => `Promise`\<\{ \[K in string \| number \| symbol\]: FormattedBlock\\[K\] \}\> +> **getBlock**: \<`includeTransactions`, `blockTag`\>(`args`?) => `Promise`\<\{ \[K in string \| number \| symbol\]: FormattedBlock\\[K\] \}\> #### Type Parameters -• **TIncludeTransactions** *extends* `boolean` = `false` +• **includeTransactions** *extends* `boolean` = `false` -• **TBlockTag** *extends* `BlockTag` = `"latest"` +• **blockTag** *extends* `BlockTag` = `"latest"` #### Parameters -• **args?**: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\> +• **args?**: `GetBlockParameters`\<`includeTransactions`, `blockTag`\> GetBlockParameters #### Returns -`Promise`\<\{ \[K in string \| number \| symbol\]: FormattedBlock\\[K\] \}\> +`Promise`\<\{ \[K in string \| number \| symbol\]: FormattedBlock\\[K\] \}\> Information about the block. GetBlockReturnType @@ -497,6 +497,10 @@ The block transaction count. GetBlockTransactionCountReturnType > **getBytecode**: (`args`) => `Promise`\<`GetCodeReturnType`\> +#### Deprecated + +Use `getCode` instead. + #### Parameters • **args**: `GetCodeParameters` @@ -505,10 +509,6 @@ The block transaction count. GetBlockTransactionCountReturnType `Promise`\<`GetCodeReturnType`\> -#### Deprecated - -Use `getCode` instead. - ### getChainId > **getChainId**: () => `Promise`\<`number`\> & () => `Promise`\<`number`\> @@ -840,59 +840,59 @@ The gas estimate (in wei). GetFeeHistoryReturnType ### getFilterChanges() -> **getFilterChanges**: \<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>(`args`) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> +> **getFilterChanges**: \<`filterType`, `abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>(`args`) => `Promise`\<`GetFilterChangesReturnType`\<`filterType`, `abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> #### Type Parameters -• **TFilterType** *extends* `FilterType` +• **filterType** *extends* `FilterType` -• **TAbi** *extends* `undefined` \| `Abi` \| readonly `unknown`[] +• **abi** *extends* `undefined` \| `Abi` \| readonly `unknown`[] -• **TEventName** *extends* `undefined` \| `string` +• **eventName** *extends* `undefined` \| `string` -• **TStrict** *extends* `undefined` \| `boolean` = `undefined` +• **strict** *extends* `undefined` \| `boolean` = `undefined` -• **TFromBlock** *extends* `undefined` \| `bigint` \| `BlockTag` = `undefined` +• **fromBlock** *extends* `undefined` \| `bigint` \| `BlockTag` = `undefined` -• **TToBlock** *extends* `undefined` \| `bigint` \| `BlockTag` = `undefined` +• **toBlock** *extends* `undefined` \| `bigint` \| `BlockTag` = `undefined` #### Parameters -• **args**: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\> +• **args**: `GetFilterChangesParameters`\<`filterType`, `abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\> GetFilterChangesParameters #### Returns -`Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> +`Promise`\<`GetFilterChangesReturnType`\<`filterType`, `abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> Logs or hashes. GetFilterChangesReturnType ### getFilterLogs() -> **getFilterLogs**: \<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>(`args`) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> +> **getFilterLogs**: \<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>(`args`) => `Promise`\<`GetFilterLogsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> #### Type Parameters -• **TAbi** *extends* `undefined` \| `Abi` \| readonly `unknown`[] +• **abi** *extends* `undefined` \| `Abi` \| readonly `unknown`[] -• **TEventName** *extends* `undefined` \| `string` +• **eventName** *extends* `undefined` \| `string` -• **TStrict** *extends* `undefined` \| `boolean` = `undefined` +• **strict** *extends* `undefined` \| `boolean` = `undefined` -• **TFromBlock** *extends* `undefined` \| `bigint` \| `BlockTag` = `undefined` +• **fromBlock** *extends* `undefined` \| `bigint` \| `BlockTag` = `undefined` -• **TToBlock** *extends* `undefined` \| `bigint` \| `BlockTag` = `undefined` +• **toBlock** *extends* `undefined` \| `bigint` \| `BlockTag` = `undefined` #### Parameters -• **args**: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\> +• **args**: `GetFilterLogsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\> GetFilterLogsParameters #### Returns -`Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> +`Promise`\<`GetFilterLogsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> A list of event logs. GetFilterLogsReturnType @@ -908,29 +908,29 @@ The gas price (in wei). GetGasPriceReturnType ### getLogs() -> **getLogs**: \<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>(`args`?) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> +> **getLogs**: \<`abiEvent`, `abiEvents`, `strict`, `fromBlock`, `toBlock`\>(`args`?) => `Promise`\<`GetLogsReturnType`\<`abiEvent`, `abiEvents`, `strict`, `fromBlock`, `toBlock`\>\> #### Type Parameters -• **TAbiEvent** *extends* `undefined` \| `AbiEvent` = `undefined` +• **abiEvent** *extends* `undefined` \| `AbiEvent` = `undefined` -• **TAbiEvents** *extends* `undefined` \| readonly `unknown`[] \| readonly `AbiEvent`[] = `TAbiEvent` *extends* `AbiEvent` ? [`TAbiEvent`\<`TAbiEvent`\>] : `undefined` +• **abiEvents** *extends* `undefined` \| readonly `unknown`[] \| readonly `AbiEvent`[] = `abiEvent` *extends* `AbiEvent` ? [`abiEvent`\<`abiEvent`\>] : `undefined` -• **TStrict** *extends* `undefined` \| `boolean` = `undefined` +• **strict** *extends* `undefined` \| `boolean` = `undefined` -• **TFromBlock** *extends* `undefined` \| `bigint` \| `BlockTag` = `undefined` +• **fromBlock** *extends* `undefined` \| `bigint` \| `BlockTag` = `undefined` -• **TToBlock** *extends* `undefined` \| `bigint` \| `BlockTag` = `undefined` +• **toBlock** *extends* `undefined` \| `bigint` \| `BlockTag` = `undefined` #### Parameters -• **args?**: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\> +• **args?**: `GetLogsParameters`\<`abiEvent`, `abiEvents`, `strict`, `fromBlock`, `toBlock`\> GetLogsParameters #### Returns -`Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> +`Promise`\<`GetLogsReturnType`\<`abiEvent`, `abiEvents`, `strict`, `fromBlock`, `toBlock`\>\> A list of event logs. GetLogsReturnType @@ -976,21 +976,21 @@ The value of the storage slot. GetStorageAtReturnType ### getTransaction() -> **getTransaction**: \<`TBlockTag`\>(`args`) => `Promise`\<\{ \[K in string \| number \| symbol\]: FormattedTransaction\\[K\] \}\> +> **getTransaction**: \<`blockTag`\>(`args`) => `Promise`\<\{ \[K in string \| number \| symbol\]: FormattedTransaction\\[K\] \}\> #### Type Parameters -• **TBlockTag** *extends* `BlockTag` = `"latest"` +• **blockTag** *extends* `BlockTag` = `"latest"` #### Parameters -• **args**: `GetTransactionParameters`\<`TBlockTag`\> +• **args**: `GetTransactionParameters`\<`blockTag`\> GetTransactionParameters #### Returns -`Promise`\<\{ \[K in string \| number \| symbol\]: FormattedTransaction\\[K\] \}\> +`Promise`\<\{ \[K in string \| number \| symbol\]: FormattedTransaction\\[K\] \}\> The transaction information. GetTransactionReturnType @@ -1070,16 +1070,6 @@ Impersonate an account or contract address. This lets you send transactions from - Docs: https://viem.sh/docs/actions/test/impersonateAccount -#### Parameters - -• **args**: `ImpersonateAccountParameters` - -ImpersonateAccountParameters - -#### Returns - -`Promise`\<`void`\> - #### Example ```ts @@ -1096,23 +1086,23 @@ await client.impersonateAccount({ }) ``` -### increaseTime() +#### Parameters -> **increaseTime**: (`args`) => `Promise`\<\`0x$\{string\}\`\> +• **args**: `ImpersonateAccountParameters` -Jump forward in time by the given amount of time, in seconds. +ImpersonateAccountParameters -- Docs: https://viem.sh/docs/actions/test/increaseTime +#### Returns -#### Parameters +`Promise`\<`void`\> -• **args**: `IncreaseTimeParameters` +### increaseTime() -– IncreaseTimeParameters +> **increaseTime**: (`args`) => `Promise`\<\`0x$\{string\}\`\> -#### Returns +Jump forward in time by the given amount of time, in seconds. -`Promise`\<\`0x$\{string\}\`\> +- Docs: https://viem.sh/docs/actions/test/increaseTime #### Example @@ -1130,6 +1120,16 @@ await client.increaseTime({ }) ``` +#### Parameters + +• **args**: `IncreaseTimeParameters` + +– IncreaseTimeParameters + +#### Returns + +`Promise`\<\`0x$\{string\}\`\> + ### inspectTxpool() > **inspectTxpool**: () => `Promise`\<`InspectTxpoolReturnType`\> @@ -1154,14 +1154,6 @@ Adds state previously dumped with `dumpState` to the current chain. - Docs: https://viem.sh/docs/actions/test/loadState -#### Parameters - -• **args**: `LoadStateParameters` - -#### Returns - -`Promise`\<`void`\> - #### Example ```ts @@ -1176,23 +1168,21 @@ const client = createTestClient({ await client.loadState({ state: '0x...' }) ``` -### mine() - -> **mine**: (`args`) => `Promise`\<`void`\> +#### Parameters -Mine a specified number of blocks. +• **args**: `LoadStateParameters` -- Docs: https://viem.sh/docs/actions/test/mine +#### Returns -#### Parameters +`Promise`\<`void`\> -• **args**: `MineParameters` +### mine() -– MineParameters +> **mine**: (`args`) => `Promise`\<`void`\> -#### Returns +Mine a specified number of blocks. -`Promise`\<`void`\> +- Docs: https://viem.sh/docs/actions/test/mine #### Example @@ -1208,6 +1198,16 @@ const client = createTestClient({ await client.mine({ blocks: 1 }) ``` +#### Parameters + +• **args**: `MineParameters` + +– MineParameters + +#### Returns + +`Promise`\<`void`\> + ### multicall() > **multicall**: \<`contracts`, `allowFailure`\>(`args`) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> @@ -1244,7 +1244,7 @@ Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 millis ### prepareTransactionRequest -> **prepareTransactionRequest**: \<`TRequest`, `TChainOverride`, `TAccountOverride`\>(`args`) => `Promise`\<\{ \[K in string \| number \| symbol\]: (UnionRequiredBy\ & Object, ParameterTypeToParameters\<(...)\[(...)\] extends readonly (...)\[\] ? (...)\[(...)\] : (...) \| (...) \| (...) \| (...) \| (...) \| (...)\>\> & (unknown extends TRequest\["kzg"\] ? Object : Pick\))\[K\] \}\> & \<`TRequest`, `TChainOverride`, `TAccountOverride`\>(`args`) => `Promise`\<\{ \[K in string \| number \| symbol\]: (UnionRequiredBy\ & Object, ParameterTypeToParameters\<(...)\[(...)\] extends readonly (...)\[\] ? (...)\[(...)\] : (...) \| (...) \| (...) \| (...) \| (...) \| (...)\>\> & (unknown extends TRequest\["kzg"\] ? Object : Pick\))\[K\] \}\> +> **prepareTransactionRequest**: \<`request`, `chainOverride`, `accountOverride`\>(`args`) => `Promise`\<\{ \[K in string \| number \| symbol\]: (UnionRequiredBy\ & Object, ParameterTypeToParameters\<(...)\[(...)\] extends readonly (...)\[\] ? (...)\[(...)\] : (...) \| (...) \| (...) \| (...) \| (...) \| (...)\>\> & (unknown extends request\["kzg"\] ? Object : Pick\))\[K\] \}\> & \<`request`, `chainOverride`, `accountOverride`\>(`args`) => `Promise`\<\{ \[K in string \| number \| symbol\]: (UnionRequiredBy\ & Object, ParameterTypeToParameters\<(...)\[(...)\] extends readonly (...)\[\] ? (...)\[(...)\] : (...) \| (...) \| (...) \| (...) \| (...) \| (...)\>\> & (unknown extends request\["kzg"\] ? Object : Pick\))\[K\] \}\> Prepares a transaction request for signing. @@ -1320,10 +1320,6 @@ Removes [`setBlockTimestampInterval`](https://viem.sh/docs/actions/test/setBlock - Docs: https://viem.sh/docs/actions/test/removeBlockTimestampInterval -#### Returns - -`Promise`\<`void`\> - #### Example ```ts @@ -1339,6 +1335,10 @@ const client = createTestClient({ await client.removeBlockTimestampInterval() ``` +#### Returns + +`Promise`\<`void`\> + ### request > **request**: `EIP1193RequestFn`\<[`object`, `object`, `object`, `object`, `object`]\> @@ -1381,16 +1381,6 @@ Resets fork back to its original state. - Docs: https://viem.sh/docs/actions/test/reset -#### Parameters - -• **args?**: `ResetParameters` - -– ResetParameters - -#### Returns - -`Promise`\<`void`\> - #### Example ```ts @@ -1405,23 +1395,23 @@ const client = createTestClient({ await client.reset({ blockNumber: 69420n }) ``` -### revert() +#### Parameters -> **revert**: (`args`) => `Promise`\<`void`\> +• **args?**: `ResetParameters` -Revert the state of the blockchain at the current block. +– ResetParameters -- Docs: https://viem.sh/docs/actions/test/revert +#### Returns -#### Parameters +`Promise`\<`void`\> -• **args**: `RevertParameters` +### revert() -– RevertParameters +> **revert**: (`args`) => `Promise`\<`void`\> -#### Returns +Revert the state of the blockchain at the current block. -`Promise`\<`void`\> +- Docs: https://viem.sh/docs/actions/test/revert #### Example @@ -1437,6 +1427,16 @@ const client = createTestClient({ await client.revert({ id: '0x…' }) ``` +#### Parameters + +• **args**: `RevertParameters` + +– RevertParameters + +#### Returns + +`Promise`\<`void`\> + ### sendRawTransaction > **sendRawTransaction**: (`args`) => `Promise`\<\`0x$\{string\}\`\> & (`args`) => `Promise`\<\`0x$\{string\}\`\> @@ -1473,17 +1473,17 @@ const hash = await client.sendRawTransaction({ ### sendTransaction() -> **sendTransaction**: \<`TRequest`, `TChainOverride`\>(`args`) => `Promise`\<\`0x$\{string\}\`\> +> **sendTransaction**: \<`request`, `chainOverride`\>(`args`) => `Promise`\<\`0x$\{string\}\`\> #### Type Parameters -• **TRequest** *extends* `object` +• **request** *extends* `Omit`\<`object`, `"from"`\> \| `Omit`\<`object`, `"from"`\> \| `Omit`\<`object`, `"from"`\> \| `Omit`\<`object`, `"from"`\> \| `Omit`\<`object`, `"from"`\> & `object` -• **TChainOverride** *extends* `undefined` \| `Chain` = `undefined` +• **chainOverride** *extends* `undefined` \| `Chain` = `undefined` #### Parameters -• **args**: `SendTransactionParameters`\<`TCommon`, `TAccountOrAddress` *extends* `Account` ? `Account` : `undefined`, `TChainOverride`, `TRequest`\> +• **args**: `SendTransactionParameters`\<`TCommon`, `TAccountOrAddress` *extends* `Account` ? `Account` : `undefined`, `chainOverride`, `request`\> SendTransactionParameters @@ -1495,15 +1495,15 @@ The [Transaction](https://viem.sh/docs/glossary/terms#transaction) hash. SendTra ### sendUnsignedTransaction() -> **sendUnsignedTransaction**: \<`TChain`\>(`args`) => `Promise`\<\`0x$\{string\}\`\> +> **sendUnsignedTransaction**: \<`chain`\>(`args`) => `Promise`\<\`0x$\{string\}\`\> #### Type Parameters -• **TChain** *extends* `undefined` \| `Chain` +• **chain** *extends* `undefined` \| `Chain` #### Parameters -• **args**: `SendUnsignedTransactionParameters`\<`TChain`\> +• **args**: `SendUnsignedTransactionParameters`\<`chain`\> – SendUnsignedTransactionParameters @@ -1521,14 +1521,6 @@ Enables or disables the automatic mining of new blocks with each new transaction - Docs: https://viem.sh/docs/actions/test/setAutomine -#### Parameters - -• **args**: `boolean` - -#### Returns - -`Promise`\<`void`\> - #### Example ```ts @@ -1543,23 +1535,21 @@ const client = createTestClient({ await client.setAutomine() ``` -### setBalance() - -> **setBalance**: (`args`) => `Promise`\<`void`\> +#### Parameters -Modifies the balance of an account. +• **args**: `boolean` -- Docs: https://viem.sh/docs/actions/test/setBalance +#### Returns -#### Parameters +`Promise`\<`void`\> -• **args**: `SetBalanceParameters` +### setBalance() -– SetBalanceParameters +> **setBalance**: (`args`) => `Promise`\<`void`\> -#### Returns +Modifies the balance of an account. -`Promise`\<`void`\> +- Docs: https://viem.sh/docs/actions/test/setBalance #### Example @@ -1578,23 +1568,23 @@ await client.setBalance({ }) ``` -### setBlockGasLimit() +#### Parameters -> **setBlockGasLimit**: (`args`) => `Promise`\<`void`\> +• **args**: `SetBalanceParameters` -Sets the block's gas limit. +– SetBalanceParameters -- Docs: https://viem.sh/docs/actions/test/setBlockGasLimit +#### Returns -#### Parameters +`Promise`\<`void`\> -• **args**: `SetBlockGasLimitParameters` +### setBlockGasLimit() -– SetBlockGasLimitParameters +> **setBlockGasLimit**: (`args`) => `Promise`\<`void`\> -#### Returns +Sets the block's gas limit. -`Promise`\<`void`\> +- Docs: https://viem.sh/docs/actions/test/setBlockGasLimit #### Example @@ -1610,23 +1600,23 @@ const client = createTestClient({ await client.setBlockGasLimit({ gasLimit: 420_000n }) ``` -### setBlockTimestampInterval() +#### Parameters -> **setBlockTimestampInterval**: (`args`) => `Promise`\<`void`\> +• **args**: `SetBlockGasLimitParameters` -Similar to [`increaseTime`](https://viem.sh/docs/actions/test/increaseTime), but sets a block timestamp `interval`. The timestamp of future blocks will be computed as `lastBlock_timestamp` + `interval`. +– SetBlockGasLimitParameters -- Docs: https://viem.sh/docs/actions/test/setBlockTimestampInterval +#### Returns -#### Parameters +`Promise`\<`void`\> -• **args**: `SetBlockTimestampIntervalParameters` +### setBlockTimestampInterval() -– SetBlockTimestampIntervalParameters +> **setBlockTimestampInterval**: (`args`) => `Promise`\<`void`\> -#### Returns +Similar to [`increaseTime`](https://viem.sh/docs/actions/test/increaseTime), but sets a block timestamp `interval`. The timestamp of future blocks will be computed as `lastBlock_timestamp` + `interval`. -`Promise`\<`void`\> +- Docs: https://viem.sh/docs/actions/test/setBlockTimestampInterval #### Example @@ -1642,23 +1632,23 @@ const client = createTestClient({ await client.setBlockTimestampInterval({ interval: 5 }) ``` -### setCode() +#### Parameters -> **setCode**: (`args`) => `Promise`\<`void`\> +• **args**: `SetBlockTimestampIntervalParameters` -Modifies the bytecode stored at an account's address. +– SetBlockTimestampIntervalParameters -- Docs: https://viem.sh/docs/actions/test/setCode +#### Returns -#### Parameters +`Promise`\<`void`\> -• **args**: `SetCodeParameters` +### setCode() -– SetCodeParameters +> **setCode**: (`args`) => `Promise`\<`void`\> -#### Returns +Modifies the bytecode stored at an account's address. -`Promise`\<`void`\> +- Docs: https://viem.sh/docs/actions/test/setCode #### Example @@ -1677,23 +1667,23 @@ await client.setCode({ }) ``` -### setCoinbase() +#### Parameters -> **setCoinbase**: (`args`) => `Promise`\<`void`\> +• **args**: `SetCodeParameters` -Sets the coinbase address to be used in new blocks. +– SetCodeParameters -- Docs: https://viem.sh/docs/actions/test/setCoinbase +#### Returns -#### Parameters +`Promise`\<`void`\> -• **args**: `SetCoinbaseParameters` +### setCoinbase() -– SetCoinbaseParameters +> **setCoinbase**: (`args`) => `Promise`\<`void`\> -#### Returns +Sets the coinbase address to be used in new blocks. -`Promise`\<`void`\> +- Docs: https://viem.sh/docs/actions/test/setCoinbase #### Example @@ -1711,23 +1701,23 @@ await client.setCoinbase({ }) ``` -### setIntervalMining() +#### Parameters -> **setIntervalMining**: (`args`) => `Promise`\<`void`\> +• **args**: `SetCoinbaseParameters` -Sets the automatic mining interval (in seconds) of blocks. Setting the interval to 0 will disable automatic mining. +– SetCoinbaseParameters -- Docs: https://viem.sh/docs/actions/test/setIntervalMining +#### Returns -#### Parameters +`Promise`\<`void`\> -• **args**: `SetIntervalMiningParameters` +### setIntervalMining() -– SetIntervalMiningParameters +> **setIntervalMining**: (`args`) => `Promise`\<`void`\> -#### Returns +Sets the automatic mining interval (in seconds) of blocks. Setting the interval to 0 will disable automatic mining. -`Promise`\<`void`\> +- Docs: https://viem.sh/docs/actions/test/setIntervalMining #### Example @@ -1743,21 +1733,23 @@ const client = createTestClient({ await client.setIntervalMining({ interval: 5 }) ``` -### setLoggingEnabled() +#### Parameters -> **setLoggingEnabled**: (`args`) => `Promise`\<`void`\> +• **args**: `SetIntervalMiningParameters` -Enable or disable logging on the test node network. +– SetIntervalMiningParameters -- Docs: https://viem.sh/docs/actions/test/setLoggingEnabled +#### Returns -#### Parameters +`Promise`\<`void`\> -• **args**: `boolean` +### setLoggingEnabled() -#### Returns +> **setLoggingEnabled**: (`args`) => `Promise`\<`void`\> -`Promise`\<`void`\> +Enable or disable logging on the test node network. + +- Docs: https://viem.sh/docs/actions/test/setLoggingEnabled #### Example @@ -1773,6 +1765,14 @@ const client = createTestClient({ await client.setLoggingEnabled() ``` +#### Parameters + +• **args**: `boolean` + +#### Returns + +`Promise`\<`void`\> + ### setMinGasPrice() > **setMinGasPrice**: (`args`) => `Promise`\<`void`\> @@ -1783,16 +1783,6 @@ Change the minimum gas price accepted by the network (in wei). Note: `setMinGasPrice` can only be used on clients that do not have EIP-1559 enabled. -#### Parameters - -• **args**: `SetMinGasPriceParameters` - -– SetBlockGasLimitParameters - -#### Returns - -`Promise`\<`void`\> - #### Example ```ts @@ -1809,23 +1799,23 @@ await client.setMinGasPrice({ }) ``` -### setNextBlockBaseFeePerGas() +#### Parameters -> **setNextBlockBaseFeePerGas**: (`args`) => `Promise`\<`void`\> +• **args**: `SetMinGasPriceParameters` -Sets the next block's base fee per gas. +– SetBlockGasLimitParameters -- Docs: https://viem.sh/docs/actions/test/setNextBlockBaseFeePerGas +#### Returns -#### Parameters +`Promise`\<`void`\> -• **args**: `SetNextBlockBaseFeePerGasParameters` +### setNextBlockBaseFeePerGas() -– SetNextBlockBaseFeePerGasParameters +> **setNextBlockBaseFeePerGas**: (`args`) => `Promise`\<`void`\> -#### Returns +Sets the next block's base fee per gas. -`Promise`\<`void`\> +- Docs: https://viem.sh/docs/actions/test/setNextBlockBaseFeePerGas #### Example @@ -1843,23 +1833,23 @@ await client.setNextBlockBaseFeePerGas({ }) ``` -### setNextBlockTimestamp() +#### Parameters -> **setNextBlockTimestamp**: (`args`) => `Promise`\<`void`\> +• **args**: `SetNextBlockBaseFeePerGasParameters` -Sets the next block's timestamp. +– SetNextBlockBaseFeePerGasParameters -- Docs: https://viem.sh/docs/actions/test/setNextBlockTimestamp +#### Returns -#### Parameters +`Promise`\<`void`\> -• **args**: `SetNextBlockTimestampParameters` +### setNextBlockTimestamp() -– SetNextBlockTimestampParameters +> **setNextBlockTimestamp**: (`args`) => `Promise`\<`void`\> -#### Returns +Sets the next block's timestamp. -`Promise`\<`void`\> +- Docs: https://viem.sh/docs/actions/test/setNextBlockTimestamp #### Example @@ -1875,23 +1865,23 @@ const client = createTestClient({ await client.setNextBlockTimestamp({ timestamp: 1671744314n }) ``` -### setNonce() +#### Parameters -> **setNonce**: (`args`) => `Promise`\<`void`\> +• **args**: `SetNextBlockTimestampParameters` -Modifies (overrides) the nonce of an account. +– SetNextBlockTimestampParameters -- Docs: https://viem.sh/docs/actions/test/setNonce +#### Returns -#### Parameters +`Promise`\<`void`\> -• **args**: `SetNonceParameters` +### setNonce() -– SetNonceParameters +> **setNonce**: (`args`) => `Promise`\<`void`\> -#### Returns +Modifies (overrides) the nonce of an account. -`Promise`\<`void`\> +- Docs: https://viem.sh/docs/actions/test/setNonce #### Example @@ -1910,21 +1900,23 @@ await client.setNonce({ }) ``` -### setRpcUrl() +#### Parameters -> **setRpcUrl**: (`args`) => `Promise`\<`void`\> +• **args**: `SetNonceParameters` -Sets the backend RPC URL. +– SetNonceParameters -- Docs: https://viem.sh/docs/actions/test/setRpcUrl +#### Returns -#### Parameters +`Promise`\<`void`\> -• **args**: `string` +### setRpcUrl() -#### Returns +> **setRpcUrl**: (`args`) => `Promise`\<`void`\> -`Promise`\<`void`\> +Sets the backend RPC URL. + +- Docs: https://viem.sh/docs/actions/test/setRpcUrl #### Example @@ -1940,23 +1932,21 @@ const client = createTestClient({ await client.setRpcUrl('https://eth-mainnet.g.alchemy.com/v2') ``` -### setStorageAt() - -> **setStorageAt**: (`args`) => `Promise`\<`void`\> +#### Parameters -Writes to a slot of an account's storage. +• **args**: `string` -- Docs: https://viem.sh/docs/actions/test/setStorageAt +#### Returns -#### Parameters +`Promise`\<`void`\> -• **args**: `SetStorageAtParameters` +### setStorageAt() -– SetStorageAtParameters +> **setStorageAt**: (`args`) => `Promise`\<`void`\> -#### Returns +Writes to a slot of an account's storage. -`Promise`\<`void`\> +- Docs: https://viem.sh/docs/actions/test/setStorageAt #### Example @@ -1976,6 +1966,16 @@ await client.setStorageAt({ }) ``` +#### Parameters + +• **args**: `SetStorageAtParameters` + +– SetStorageAtParameters + +#### Returns + +`Promise`\<`void`\> + ### signMessage() > **signMessage**: (`args`) => `Promise`\<\`0x$\{string\}\`\> @@ -1994,37 +1994,37 @@ The signed message. SignMessageReturnType ### signTransaction() -> **signTransaction**: \<`TChainOverride`\>(`args`) => `Promise`\<\`0x02$\{string\}\` \| \`0x01$\{string\}\` \| \`0x03$\{string\}\` \| `TransactionSerializedLegacy`\> +> **signTransaction**: \<`chainOverride`\>(`args`) => `Promise`\<\`0x02$\{string\}\` \| \`0x01$\{string\}\` \| \`0x03$\{string\}\` \| \`0x04$\{string\}\` \| `TransactionSerializedLegacy`\> #### Type Parameters -• **TChainOverride** *extends* `undefined` \| `Chain` +• **chainOverride** *extends* `undefined` \| `Chain` #### Parameters -• **args**: `SignTransactionParameters`\<`TCommon`, `TAccountOrAddress` *extends* `Account` ? `Account` : `undefined`, `TChainOverride`\> +• **args**: `SignTransactionParameters`\<`TCommon`, `TAccountOrAddress` *extends* `Account` ? `Account` : `undefined`, `chainOverride`\> SignTransactionParameters #### Returns -`Promise`\<\`0x02$\{string\}\` \| \`0x01$\{string\}\` \| \`0x03$\{string\}\` \| `TransactionSerializedLegacy`\> +`Promise`\<\`0x02$\{string\}\` \| \`0x01$\{string\}\` \| \`0x03$\{string\}\` \| \`0x04$\{string\}\` \| `TransactionSerializedLegacy`\> The signed message. SignTransactionReturnType ### signTypedData() -> **signTypedData**: \<`TTypedData`, `TPrimaryType`\>(`args`) => `Promise`\<\`0x$\{string\}\`\> +> **signTypedData**: \<`typedData`, `primaryType`\>(`args`) => `Promise`\<\`0x$\{string\}\`\> #### Type Parameters -• **TTypedData** *extends* `object` \| `object` +• **typedData** *extends* `object` \| `object` -• **TPrimaryType** *extends* `string` +• **primaryType** *extends* `string` #### Parameters -• **args**: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `TAccountOrAddress` *extends* `Account` ? `Account` : `undefined`\> +• **args**: `SignTypedDataParameters`\<`typedData`, `primaryType`, `TAccountOrAddress` *extends* `Account` ? `Account` : `undefined`\> SignTypedDataParameters @@ -2070,10 +2070,6 @@ Snapshot the state of the blockchain at the current block. - Docs: https://viem.sh/docs/actions/test/snapshot -#### Returns - -`Promise`\<\`0x$\{string\}\`\> - #### Example ```ts @@ -2089,6 +2085,10 @@ const client = createTestClient({ await client.snapshot() ``` +#### Returns + +`Promise`\<\`0x$\{string\}\`\> + ### stopImpersonatingAccount() > **stopImpersonatingAccount**: (`args`) => `Promise`\<`void`\> @@ -2097,16 +2097,6 @@ Stop impersonating an account after having previously used [`impersonateAccount` - Docs: https://viem.sh/docs/actions/test/stopImpersonatingAccount -#### Parameters - -• **args**: `StopImpersonatingAccountParameters` - -– StopImpersonatingAccountParameters - -#### Returns - -`Promise`\<`void`\> - #### Example ```ts @@ -2124,24 +2114,24 @@ await client.stopImpersonatingAccount({ }) ``` -### switchChain() +#### Parameters -> **switchChain**: (`args`) => `Promise`\<`void`\> +• **args**: `StopImpersonatingAccountParameters` -Switch the target chain in a wallet. +– StopImpersonatingAccountParameters -- Docs: https://viem.sh/docs/actions/wallet/switchChain -- JSON-RPC Methods: [`eth_switchEthereumChain`](https://eips.ethereum.org/EIPS/eip-3326) +#### Returns -#### Parameters +`Promise`\<`void`\> -• **args**: `SwitchChainParameters` +### switchChain() -SwitchChainParameters +> **switchChain**: (`args`) => `Promise`\<`void`\> -#### Returns +Switch the target chain in a wallet. -`Promise`\<`void`\> +- Docs: https://viem.sh/docs/actions/wallet/switchChain +- JSON-RPC Methods: [`eth_switchEthereumChain`](https://eips.ethereum.org/EIPS/eip-3326) #### Example @@ -2156,12 +2146,45 @@ const client = createWalletClient({ await client.switchChain({ id: optimism.id }) ``` +#### Parameters + +• **args**: `SwitchChainParameters` + +SwitchChainParameters + +#### Returns + +`Promise`\<`void`\> + ### tevm > **tevm**: `object` & `EIP1193Events` & `object` & `Eip1193RequestProvider` Low level access to TEVM can be accessed via `tevm`. These APIs are not guaranteed to be stable. +#### See + +TevmNode + +#### Example + +```typescript +import { createMemoryClient } from 'tevm' + +const memoryClient = createMemoryClient() + +// low level access to the TEVM VM, blockchain, EVM, stateManager, mempool, receiptsManager and more are available +const vm = await memoryClient.tevm.getVm() +vm.runBlock(...) +const { blockchain, evm, stateManager } = vm +blockchain.addBlock(...) +evm.runCall(...) +stateManager.putAccount(...) + +const mempool = await memoryClient.tevm.getTxPool() +const receiptsManager = await memoryClient.tevm.getReceiptsManager() +``` + #### Type declaration ##### deepCopy() @@ -2301,10 +2324,6 @@ Returns promise that resulves when the client is ready The client is usable without calling this method but may have extra latency on the first call from initialization -###### Returns - -`Promise`\<`true`\> - ###### Example ```ts @@ -2312,6 +2331,10 @@ const client = createMemoryClient() await client.ready() ``` +###### Returns + +`Promise`\<`true`\> + ##### removeFilter() > `readonly` **removeFilter**: (`id`) => `void` @@ -2387,29 +2410,6 @@ Arguments to pass to the event listeners. True if the event was emitted, false otherwise. -#### See - -TevmNode - -#### Example - -```typescript -import { createMemoryClient } from 'tevm' - -const memoryClient = createMemoryClient() - -// low level access to the TEVM VM, blockchain, EVM, stateManager, mempool, receiptsManager and more are available -const vm = await memoryClient.tevm.getVm() -vm.runBlock(...) -const { blockchain, evm, stateManager } = vm -blockchain.addBlock(...) -evm.runCall(...) -stateManager.putAccount(...) - -const mempool = await memoryClient.tevm.getTxPool() -const receiptsManager = await memoryClient.tevm.getReceiptsManager() -``` - ### tevmCall > **tevmCall**: `CallHandler` @@ -2590,10 +2590,6 @@ await client.tevmMine() Returns a promise that resolves when the TEVM is ready. This is not needed to explicitly be called as all actions will wait for the TEVM to be ready. -#### Returns - -`Promise`\<`true`\> - #### Example ```typescript @@ -2605,6 +2601,10 @@ await client.tevmReady() ``` Same as calling `client.tevm.ready()` +#### Returns + +`Promise`\<`true`\> + ### ~~tevmScript~~ > **tevmScript**: `ScriptHandler` @@ -2815,10 +2815,6 @@ Returns promise that resulves when the client is ready The client is usable without calling this method but may have extra latency on the first call from initialization -###### Returns - -`Promise`\<`true`\> - ###### Example ```ts @@ -2826,6 +2822,10 @@ const client = createMemoryClient() await client.ready() ``` +###### Returns + +`Promise`\<`true`\> + ###### removeFilter() > `readonly` **removeFilter**: (`id`) => `void` @@ -3105,17 +3105,17 @@ A function that can be invoked to stop watching for new block numbers. WatchBloc ### watchBlocks() -> **watchBlocks**: \<`TIncludeTransactions`, `TBlockTag`\>(`args`) => `WatchBlocksReturnType` +> **watchBlocks**: \<`includeTransactions`, `blockTag`\>(`args`) => `WatchBlocksReturnType` #### Type Parameters -• **TIncludeTransactions** *extends* `boolean` = `false` +• **includeTransactions** *extends* `boolean` = `false` -• **TBlockTag** *extends* `BlockTag` = `"latest"` +• **blockTag** *extends* `BlockTag` = `"latest"` #### Parameters -• **args**: `WatchBlocksParameters`\<[`TevmTransport`](../type-aliases/TevmTransport.md), `TCommon`, `TIncludeTransactions`, `TBlockTag`\> +• **args**: `WatchBlocksParameters`\<[`TevmTransport`](../type-aliases/TevmTransport.md), `TCommon`, `includeTransactions`, `blockTag`\> WatchBlocksParameters @@ -3127,19 +3127,19 @@ A function that can be invoked to stop watching for new block numbers. WatchBloc ### watchContractEvent() -> **watchContractEvent**: \<`TAbi`, `TEventName`, `TStrict`\>(`args`) => `WatchContractEventReturnType` +> **watchContractEvent**: \<`abi`, `eventName`, `strict`\>(`args`) => `WatchContractEventReturnType` #### Type Parameters -• **TAbi** *extends* `Abi` \| readonly `unknown`[] +• **abi** *extends* `Abi` \| readonly `unknown`[] -• **TEventName** *extends* `string` +• **eventName** *extends* `string` -• **TStrict** *extends* `undefined` \| `boolean` = `undefined` +• **strict** *extends* `undefined` \| `boolean` = `undefined` #### Parameters -• **args**: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, [`TevmTransport`](../type-aliases/TevmTransport.md)\> +• **args**: `WatchContractEventParameters`\<`abi`, `eventName`, `strict`, [`TevmTransport`](../type-aliases/TevmTransport.md)\> WatchContractEventParameters @@ -3151,19 +3151,19 @@ A function that can be invoked to stop watching for new event logs. WatchContrac ### watchEvent() -> **watchEvent**: \<`TAbiEvent`, `TAbiEvents`, `TStrict`\>(`args`) => `WatchEventReturnType` +> **watchEvent**: \<`abiEvent`, `abiEvents`, `strict`\>(`args`) => `WatchEventReturnType` #### Type Parameters -• **TAbiEvent** *extends* `undefined` \| `AbiEvent` = `undefined` +• **abiEvent** *extends* `undefined` \| `AbiEvent` = `undefined` -• **TAbiEvents** *extends* `undefined` \| readonly `unknown`[] \| readonly `AbiEvent`[] = `TAbiEvent` *extends* `AbiEvent` ? [`TAbiEvent`\<`TAbiEvent`\>] : `undefined` +• **abiEvents** *extends* `undefined` \| readonly `unknown`[] \| readonly `AbiEvent`[] = `abiEvent` *extends* `AbiEvent` ? [`abiEvent`\<`abiEvent`\>] : `undefined` -• **TStrict** *extends* `undefined` \| `boolean` = `undefined` +• **strict** *extends* `undefined` \| `boolean` = `undefined` #### Parameters -• **args**: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, [`TevmTransport`](../type-aliases/TevmTransport.md)\> +• **args**: `WatchEventParameters`\<`abiEvent`, `abiEvents`, `strict`, [`TevmTransport`](../type-aliases/TevmTransport.md)\> WatchEventParameters @@ -3191,7 +3191,7 @@ A function that can be invoked to stop watching for new pending transaction hash ### writeContract() -> **writeContract**: \<`abi`, `functionName`, `args`, `TChainOverride`\>(`args`) => `Promise`\<\`0x$\{string\}\`\> +> **writeContract**: \<`abi`, `functionName`, `args`, `chainOverride`\>(`args`) => `Promise`\<\`0x$\{string\}\`\> #### Type Parameters @@ -3201,11 +3201,11 @@ A function that can be invoked to stop watching for new pending transaction hash • **args** *extends* `unknown` -• **TChainOverride** *extends* `undefined` \| `Chain` = `undefined` +• **chainOverride** *extends* `undefined` \| `Chain` = `undefined` #### Parameters -• **args**: `WriteContractParameters`\<`abi`, `functionName`, `args`, `TCommon`, `TAccountOrAddress` *extends* `Account` ? `Account` : `undefined`, `TChainOverride`\> +• **args**: `WriteContractParameters`\<`abi`, `functionName`, `args`, `TCommon`, `TAccountOrAddress` *extends* `Account` ? `Account` : `undefined`, `chainOverride`\> WriteContractParameters @@ -3215,186 +3215,6 @@ WriteContractParameters A [Transaction Hash](https://viem.sh/docs/glossary/terms#hash). WriteContractReturnType -## Example - -```typescript -import { createMemoryClient } from "tevm"; - -const client = createMemoryClient({ - fork: { - transport: http("https://mainnet.optimism.io")({}), - }, -}); - -const blockNumber = await client.getBlockNumber(); -console.log(blockNumber); -``` - -## See - - - [Client Guide](https://tevm.sh/learn/clients/) - - [Actions Guide](https://tevm.sh/learn/actions/) - - [Reference Docs](https://tevm.sh/reference/tevm/memory-client/functions/creatememoryclient/) - - For more information on viem clients, see the [viem client docs](https://viem.sh/docs/clients/introduction) - -## Actions API - -MemoryClient supports the following viem actions: - -- [TEVM actions API](https://tevm.sh/reference/tevm/memory-client/type-aliases/tevmactions/) -```typescript -import { createMemoryClient } from "tevm"; - -const tevm = createMemoryClient(); -await tevm.setAccount({ address: `0x${'01'.repeat(20)}`, balance: 100n }); -``` -- [Viem public actions API](https://viem.sh/docs/actions/public/introduction) such as [getBlockNumber](https://viem.sh/docs/actions/public/getBlockNumber) -```typescript -import { createMemoryClient } from "tevm"; - -const tevm = createMemoryClient(); -const bn = await tevm.getBlockNumber(); -``` -- [Test actions](https://viem.sh/docs/actions/test/introduction) are included by default. -```typescript -import { createMemoryClient } from "tevm"; - -const tevm = createMemoryClient(); -await tevm.setBalance({ address: `0x${'01'.repeat(20)}`, balance: 100n }); -``` - -## Forking - -To fork an existing network, pass an EIP-1193 transport to the `fork.transport` option with an optional block tag. -When you fork, TEVM will pin the block tag and lazily cache state from the fork transport. -It's highly recommended to pass in a `common` object that matches the chain. This will increase the performance of forking with known values. - -```typescript -import { createMemoryClient, http } from "tevm"; -import { optimism } from "tevm/common"; - -const forkedClient = createMemoryClient({ - fork: { - transport: http("https://mainnet.optimism.io")({}), - blockTag: '0xa6a63cd70fbbe396321ca6fe79e1b6735760c03538208b50d7e3a5dac5226435', - }, - common: optimism, -}); -``` - -The `common` object extends the viem chain interface with EVM-specific information. When using TEVM, you should also use `tevm/common` rather than `viem/chains` or use `createCommon` and pass in a viem chain. - -Viem clients, including MemoryClient, are themselves EIP-1193 transports. This means you can fork a client with another client. - -## Mining Modes - -TEVM supports two mining modes: -- Manual: Using `tevm.mine()` -- Auto: Automatically mines a block after every transaction. - -TEVM state does not update until blocks are mined. - -## Using TEVM over HTTP - -TEVM can be run as an HTTP server using `@tevm/server` to handle JSON-RPC requests. - -```typescript -import { createServer } from "tevm/server"; -import { createMemoryClient } from "tevm"; - -const memoryClient = createMemoryClient(); - -const server = createServer({ - request: memoryClient.request, -}); - -server.listen(8545, () => console.log("listening on 8545")); -``` - -This allows you to use any Ethereum client to communicate with it, including a viem public client. - -```typescript -import { createPublicClient, http } from "viem"; -import { mainnet } from "viem/chains"; - -const publicClient = createPublicClient({ - chain: mainnet, - transport: http("https://localhost:8545"), -}); - -console.log(await publicClient.getChainId()); -``` - -## State Persistence (Experimental) - -It is possible to persist the TEVM client to a synchronous source using the `persister` option. - -```typescript -import { createMemoryClient, createSyncPersister } from "tevm"; -import { createMemoryClient } from "tevm/sync-storage-persister"; - -// Client state will be hydrated and persisted from/to local storage -const clientWithLocalStoragePersistence = createMemoryClient({ - persister: createSyncPersister({ - storage: localStorage, - }), -}); -``` - -## Network Support - -TEVM guarantees support for the following networks: -- Ethereum mainnet -- Standard OP Stack chains - -Other EVM chains are likely to work but do not officially carry support. More official chain support will be added in the near future. - -Note: Optimism deposit transactions are not currently supported but will be in a future release. TEVM filters out these transactions from blocks. - -## Network and Hardfork Support - -TEVM supports enabling and disabling different EIPs, but the following EIPs are always turned on: -- 1559 -- 4895 -- 4844 -- 4788 - -Currently, only EIP-1559 Fee Market transactions are supported. - -## Tree Shakeable Actions - -TEVM supports tree-shakeable actions using `createTevmNode()` and the `tevm/actions` package. If you are building a UI, you should use tree-shakeable actions to optimize bundle size. These are described in detail in the [actions API guide](https://tevm.sh/learn/actions/). - -## Composing with TEVM Contracts and Bundler - -MemoryClient can compose with TEVM contracts and the TEVM bundler. For more information, see the [TEVM contracts guide](https://tevm.sh/learn/contracts/) and the [TEVM Solidity imports guide](https://tevm.sh/learn/solidity-imports/). - -```typescript -import { createMemoryClient } from "tevm"; -import { MyERC721 } from './MyERC721.sol'; - -const tevm = createMemoryClient({ - fork: { - transport: http("https://mainnet.optimism.io")({}), - }, -}); - -const address = '0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045'; - -await tevm.runContractCall( - MyERC721.write.mint({ - caller: address, - }), -); - -const balance = await tevm.runContractCall( - MyERC721.read.balanceOf({ - caller: address, - }), -); -console.log(balance); // 1n -``` - ## Defined in [packages/memory-client/src/createMemoryClient.js:189](https://github.com/evmts/tevm-monorepo/blob/main/packages/memory-client/src/createMemoryClient.js#L189) diff --git a/packages/memory-client/docs/functions/createTevmTransport.md b/packages/memory-client/docs/functions/createTevmTransport.md index 2db01ca013..a1c059dac9 100644 --- a/packages/memory-client/docs/functions/createTevmTransport.md +++ b/packages/memory-client/docs/functions/createTevmTransport.md @@ -8,13 +8,9 @@ > **createTevmTransport**(`options`): [`TevmTransport`](../type-aliases/TevmTransport.md)\<`string`\> -Creates a custom TEVM Transport for viem. - -A Transport in viem is the intermediary layer responsible for executing outgoing RPC requests. This custom TEVM Transport integrates an in-memory Ethereum client, making it ideal for local-first applications, optimistic updates, and advanced TEVM functionalities like scripting. - ## Parameters -• **options**: `TevmNodeOptions`\<`Common`\> = `{}` +• **options**: `TevmNodeOptions`\<`object`\> = `{}` Configuration options for the base client, similar to those used in `memoryClient` or a low-level `baseClient`. @@ -24,38 +20,6 @@ Configuration options for the base client, similar to those used in `memoryClien A configured TEVM transport. -## Example - -```typescript -import { createClient, http } from 'viem' -import { createTevmTransport } from 'tevm' -import { optimism } from 'tevm/common' - -const client = createClient({ - transport: createTevmTransport({ - fork: { transport: http('https://mainnet.optimism.io')({}) } - }), - chain: optimism, -}) - -async function example() { - const blockNumber = await client.getBlockNumber() - console.log(blockNumber) -} - -example() -``` - -## See - - - [createClient](createClient.md) - - [Viem Client Docs](https://viem.sh/docs/clients/introduction) - - [Client Guide](https://tevm.sh/learn/clients/) - - [tevm JSON-RPC Guide](https://tevm.sh/learn/json-rpc/) - - [EIP-1193 spec](https://eips.ethereum.org/EIPS/eip-1193) - - [Ethereum jsonrpc docs](https://ethereum.org/en/developers/docs/apis/json-rpc/) - - [CreateMemoryClient Docs](https://tevm.sh/reference/tevm/memory-client/functions/creatememoryclient/) - For a batteries-included client if not worried about tree shaking - ## Defined in [packages/memory-client/src/createTevmTransport.js:58](https://github.com/evmts/tevm-monorepo/blob/main/packages/memory-client/src/createTevmTransport.js#L58) diff --git a/packages/memory-client/docs/functions/publicActions.md b/packages/memory-client/docs/functions/publicActions.md index 5ddc1130d0..eab2e4dfae 100644 --- a/packages/memory-client/docs/functions/publicActions.md +++ b/packages/memory-client/docs/functions/publicActions.md @@ -6,24 +6,24 @@ # Function: publicActions() -> **publicActions**\<`TTransport`, `TChain`, `TAccount`\>(`client`): `PublicActions`\<`TTransport`, `TChain`, `TAccount`\> +> **publicActions**\<`transport`, `chain`, `account`\>(`client`): `PublicActions`\<`transport`, `chain`, `account`\> ## Type Parameters -• **TTransport** *extends* `Transport` = `Transport` +• **transport** *extends* `Transport` = `Transport` -• **TChain** *extends* `undefined` \| `Chain` = `undefined` \| `Chain` +• **chain** *extends* `undefined` \| `Chain` = `undefined` \| `Chain` -• **TAccount** *extends* `undefined` \| `Account` = `undefined` \| `Account` +• **account** *extends* `undefined` \| `Account` = `undefined` \| `Account` ## Parameters -• **client**: `Client`\<`TTransport`, `TChain`, `TAccount`\> +• **client**: `Client`\<`transport`, `chain`, `account`\> ## Returns -`PublicActions`\<`TTransport`, `TChain`, `TAccount`\> +`PublicActions`\<`transport`, `chain`, `account`\> ## Defined in -node\_modules/.pnpm/viem@2.16.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/clients/decorators/public.d.ts:1339 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/clients/decorators/public.d.ts:1339 diff --git a/packages/memory-client/docs/functions/testActions.md b/packages/memory-client/docs/functions/testActions.md index 7d2deb3dbc..2e370ee0f3 100644 --- a/packages/memory-client/docs/functions/testActions.md +++ b/packages/memory-client/docs/functions/testActions.md @@ -6,17 +6,17 @@ # Function: testActions() -> **testActions**\<`TMode`\>(`__namedParameters`): \<`TTransport`, `TChain`, `TAccount`\>(`client`) => `TestActions` +> **testActions**\<`mode`\>(`__namedParameters`): \<`transport`, `chain`, `account`\>(`client`) => `TestActions` ## Type Parameters -• **TMode** *extends* `TestClientMode` +• **mode** *extends* `TestClientMode` ## Parameters • **\_\_namedParameters** -• **\_\_namedParameters.mode**: `TMode` +• **\_\_namedParameters.mode**: `mode` ## Returns @@ -24,15 +24,15 @@ ### Type Parameters -• **TTransport** *extends* `Transport` = `Transport` +• **transport** *extends* `Transport` = `Transport` -• **TChain** *extends* `Chain` \| `undefined` = `Chain` \| `undefined` +• **chain** *extends* `Chain` \| `undefined` = `Chain` \| `undefined` -• **TAccount** *extends* `Account` \| `undefined` = `Account` \| `undefined` +• **account** *extends* `Account` \| `undefined` = `Account` \| `undefined` ### Parameters -• **client**: `Client`\<`TTransport`, `TChain`, `TAccount`\> +• **client**: `Client`\<`transport`, `chain`, `account`\> ### Returns @@ -40,4 +40,4 @@ ## Defined in -node\_modules/.pnpm/viem@2.16.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/clients/decorators/test.d.ts:637 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/clients/decorators/test.d.ts:637 diff --git a/packages/memory-client/docs/functions/tevmCall.md b/packages/memory-client/docs/functions/tevmCall.md index 6fd20448c9..4522f846f0 100644 --- a/packages/memory-client/docs/functions/tevmCall.md +++ b/packages/memory-client/docs/functions/tevmCall.md @@ -8,11 +8,6 @@ > **tevmCall**(`client`, `params`): `Promise`\<`CallResult`\<`TevmCallError`\>\> -A tree-shakeable version of the `tevmCall` action for viem. -Executes a call against the VM. It is similar to `eth_call` but provides more options for controlling the execution environment. - -By default, it does not modify the state after the call is complete, but this can be configured with the `createTransaction` option. - ## Parameters • **client**: `Client`\<[`TevmTransport`](../type-aliases/TevmTransport.md)\<`string`\>, `undefined` \| `Chain`, `undefined` \| `Account`, `undefined`, `undefined` \| `object`\> @@ -29,43 +24,6 @@ Parameters for the call, including the target address, call data, sender address The result of the call. -## Example - -```typescript -import { createClient, http } from 'viem' -import { tevmCall } from 'tevm/actions' -import { optimism } from 'tevm/common' -import { createTevmTransport } from 'tevm' - -const client = createClient({ - transport: createTevmTransport({ - fork: { transport: http('https://mainnet.optimism.io')({}) } - }), - chain: optimism, -}) - -async function example() { - const res = await tevmCall(client, { - to: '0x123...', - data: '0x123...', - from: '0x123...', - gas: 1000000, - gasPrice: 1n, - skipBalance: true, - }) - console.log(res) -} - -example() -``` - -## See - - - [CallParams](https://tevm.sh/reference/tevm/actions/type-aliases/callparams/) for options reference. - - [BaseCallParams](https://tevm.sh/reference/tevm/actions/type-aliases/basecallparams-1/) for the base call parameters. - - [CallResult](https://tevm.sh/reference/tevm/actions/type-aliases/callresult/) for return values reference. - - [TEVM Actions Guide](https://tevm.sh/learn/actions/) - ## Defined in [packages/memory-client/src/tevmCall.js:47](https://github.com/evmts/tevm-monorepo/blob/main/packages/memory-client/src/tevmCall.js#L47) diff --git a/packages/memory-client/docs/functions/tevmContract.md b/packages/memory-client/docs/functions/tevmContract.md index 33e3479ad0..af41d92e90 100644 --- a/packages/memory-client/docs/functions/tevmContract.md +++ b/packages/memory-client/docs/functions/tevmContract.md @@ -15,7 +15,7 @@ Internally, `tevmContract` wraps `tevmCall`. It automatically encodes and decode ## Type Parameters -• **TAbi** *extends* `Abi` \| readonly `unknown`[] = `Abi` +• **TAbi** *extends* readonly `unknown`[] \| `Abi` = `Abi` • **TFunctionName** *extends* `string` = `ContractFunctionName`\<`TAbi`\> @@ -29,40 +29,6 @@ Internally, `tevmContract` wraps `tevmCall`. It automatically encodes and decode `Promise`\<`ContractResult`\<`TAbi`, `TFunctionName`\>\> -## Example - -```typescript -import { tevmContract } from 'tevm/actions' -import { createClient, http } from 'viem' -import { optimism } from 'tevm/common' -import { createTevmTransport } from 'tevm' - -const client = createClient({ - transport: createTevmTransport({ - fork: { transport: http('https://mainnet.optimism.io')({}) } - }), - chain: optimism, -}) - -async function example() { - const res = await tevmContract(client, { - abi: [...], - functionName: 'myFunction', - args: [...], - }) - console.log(res) -} - -example() -``` - -## See - - - [ContractParams](https://tevm.sh/reference/tevm/actions/type-aliases/contractparams/) for options reference. - - [ContractResult](https://tevm.sh/reference/tevm/actions/type-aliases/contractresult/) for return values reference. - - [BaseCallParams](https://tevm.sh/reference/tevm/actions/type-aliases/basecallparams-1/) for the base call parameters. - - [TEVM Actions Guide](https://tevm.sh/learn/actions/) - ## Defined in [packages/memory-client/src/tevmContract.js:41](https://github.com/evmts/tevm-monorepo/blob/main/packages/memory-client/src/tevmContract.js#L41) diff --git a/packages/memory-client/docs/functions/tevmDeploy.md b/packages/memory-client/docs/functions/tevmDeploy.md index b59bba3584..0b716c017f 100644 --- a/packages/memory-client/docs/functions/tevmDeploy.md +++ b/packages/memory-client/docs/functions/tevmDeploy.md @@ -8,13 +8,6 @@ > **tevmDeploy**(`client`, `params`): `Promise`\<`DeployResult`\> -A tree-shakeable version of the `tevmDeploy` action for viem. -Deploys a contract using TEVM. - -This function deploys a contract by taking its ABI, bytecode, and constructor arguments. The deployed contract's address is available in the `result.createdAddress`. Note that the contract is not actually in the state until the transaction is mined. In manual mode, you must call `client.mine()` before you can interact with the deployed contract. - -As an alternative, the `setAccount` action can be used to directly put contract bytecode into the state without deploying it via a transaction. - ## Parameters • **client**: `Client`\<[`TevmTransport`](../type-aliases/TevmTransport.md)\<`string`\>, `undefined` \| `Chain`, `undefined` \| `Account`, `undefined`, `undefined` \| `object`\> @@ -31,80 +24,6 @@ Parameters for the contract deployment, including ABI, bytecode, and constructor The result of the contract deployment, including the created contract address. -## Examples - -```typescript -import { tevmDeploy } from 'tevm/actions' -import { createClient, http } from 'viem' -import { optimism } from 'tevm/common' -import { createTevmTransport } from 'tevm' - -const client = createClient({ - transport: createTevmTransport({ - fork: { transport: http('https://mainnet.optimism.io')({}) } - }), - chain: optimism, -}) - -async function example() { - const result = await tevmDeploy(client, { - abi: [...], - bytecode: '0x...', - args: ['constructorArg1', 123, ...], - }) - console.log(result.createdAddress) - - // In manual mode, you must mine the transaction - await client.mine() - - // Alternatively, you can get the contract address from the transaction receipt - const receipt = await client.getTransactionReceipt({ hash: result.transactionHash }) - console.log(receipt.contractAddress) -} - -example() -``` - -```typescript -import { tevmDeploy } from 'tevm/actions' -import { createClient, http } from 'viem' -import { optimism } from 'tevm/common' -import { createTevmTransport } from 'tevm' -import { MyContract } from './MyContract.sol' - -const client = createClient({ - transport: createTevmTransport({ - fork: { transport: http('https://mainnet.optimism.io')({}) } - }), - chain: optimism, -}) - -async function example() { - const result = await tevmDeploy(client, MyContract.deploy('constructor arg')) - console.log(result.createdAddress) - - // In manual mode, you must mine the transaction - await client.mine() - - // Alternatively, you can get the contract address from the transaction receipt - const receipt = await client.getTransactionReceipt({ hash: result.transactionHash }) - console.log(receipt.contractAddress) -} - -example() -``` - -## See - - - [DeployParams](https://tevm.sh/reference/tevm/actions/type-aliases/deployparams/) for options reference. - - [DeployResult](https://tevm.sh/reference/tevm/actions/type-aliases/deployresult/) for return values reference. - - [BaseCallParams](https://tevm.sh/reference/tevm/actions/type-aliases/basecallparams-1/) for the base call parameters. - - [TEVM Actions Guide](https://tevm.sh/learn/actions/) - - [SetAccount](https://tevm.sh/reference/tevm/actions/type-aliases/setaccountparams/) for putting contract bytecode into the state without deploying. - - [TEVM Bundler Guide](https://tevm.sh/learn/solidity-imports/) for using the TEVM bundler to deploy contracts. - -Additionally, you can use the viem wallet action `deploy` as a viable alternative. While it doesn't offer the same advanced functionality such as account impersonation or tracing capabilities, it works great for simple use cases. - ## Defined in [packages/memory-client/src/tevmDeploy.js:87](https://github.com/evmts/tevm-monorepo/blob/main/packages/memory-client/src/tevmDeploy.js#L87) diff --git a/packages/memory-client/docs/functions/tevmDumpState.md b/packages/memory-client/docs/functions/tevmDumpState.md index 2a7efa09c0..15f63a8c37 100644 --- a/packages/memory-client/docs/functions/tevmDumpState.md +++ b/packages/memory-client/docs/functions/tevmDumpState.md @@ -8,12 +8,6 @@ > **tevmDumpState**(`client`): `Promise`\<`DumpStateResult`\<`TevmDumpStateError`\>\> -A tree-shakeable version of the `tevmDumpState` action for viem. -Dumps the state of TEVM into a plain JavaScript object that can later be used to restore state -using the `tevmLoadState` action. - -This action is useful for persisting and restoring the state between different sessions or processes. - ## Parameters • **client**: `Client`\<[`TevmTransport`](../type-aliases/TevmTransport.md)\<`string`\>, `undefined` \| `Chain`, `undefined` \| `Account`, `undefined`, `undefined` \| `object`\> @@ -26,37 +20,6 @@ The viem client configured with TEVM transport. The dump of the TEVM state. -## Example - -```typescript -import { tevmDumpState } from 'tevm/actions' -import { createClient, http } from 'viem' -import { optimism } from 'tevm/common' -import { createTevmTransport } from 'tevm' -import fs from 'fs' - -const client = createClient({ - transport: createTevmTransport({ - fork: { transport: http('https://mainnet.optimism.io')({}) } - }), - chain: optimism, -}) - -async function example() { - const state = await tevmDumpState(client) - fs.writeFileSync('state.json', JSON.stringify(state)) - console.log('State dumped to state.json') -} - -example() -``` - -## See - - - [DumpStateResult](https://tevm.sh/reference/tevm/actions/type-aliases/dumpstateresult/) for return values reference. - - [TEVM Actions Guide](https://tevm.sh/learn/actions/) - - [tevmLoadState](https://tevm.sh/reference/tevm/actions/functions/tevmLoadState/) for restoring the state. - ## Defined in [packages/memory-client/src/tevmDumpState.js:41](https://github.com/evmts/tevm-monorepo/blob/main/packages/memory-client/src/tevmDumpState.js#L41) diff --git a/packages/memory-client/docs/functions/tevmGetAccount.md b/packages/memory-client/docs/functions/tevmGetAccount.md index 8b3995bcc8..4febd0f122 100644 --- a/packages/memory-client/docs/functions/tevmGetAccount.md +++ b/packages/memory-client/docs/functions/tevmGetAccount.md @@ -8,14 +8,6 @@ > **tevmGetAccount**(`client`, `params`): `Promise`\<`GetAccountResult`\<`TevmGetAccountError`\>\> -A tree-shakeable version of the `tevmGetAccount` action for viem. -Retrieves the account information from TEVM. - -This function allows you to retrieve information about an account, including its address and optionally its contract storage. -The `returnStorage` parameter determines whether the contract storage should be returned. Note that it only returns the storage that is cached in the VM. -In fork mode, if the storage hasn't been cached yet, it will not be returned. This defaults to `false`. -Be aware that returning storage can be very expensive if a contract has a lot of storage. - ## Parameters • **client**: `Client`\<[`TevmTransport`](../type-aliases/TevmTransport.md)\<`string`\>, `undefined` \| `Chain`, `undefined` \| `Account`, `undefined`, `undefined` \| `object`\> @@ -32,38 +24,6 @@ Parameters for retrieving the account information. The account information. -## Example - -```typescript -import { tevmGetAccount } from 'tevm/actions' -import { createClient, http } from 'viem' -import { optimism } from 'tevm/common' -import { createTevmTransport } from 'tevm' - -const client = createClient({ - transport: createTevmTransport({ - fork: { transport: http('https://mainnet.optimism.io')({}) } - }), - chain: optimism, -}) - -async function example() { - const account = await tevmGetAccount(client, { - address: '0x123...', - returnStorage: true, - }) - console.log(account) -} - -example() -``` - -## See - - - [GetAccountParams](https://tevm.sh/reference/tevm/actions/type-aliases/getaccountparams/) for options reference. - - [GetAccountResult](https://tevm.sh/reference/tevm/actions/type-aliases/getaccountresult/) for return values reference. - - [TEVM Actions Guide](https://tevm.sh/learn/actions/) - ## Defined in [packages/memory-client/src/tevmGetAccount.js:45](https://github.com/evmts/tevm-monorepo/blob/main/packages/memory-client/src/tevmGetAccount.js#L45) diff --git a/packages/memory-client/docs/functions/tevmLoadState.md b/packages/memory-client/docs/functions/tevmLoadState.md index 9da7da0bb4..0f28fadbdb 100644 --- a/packages/memory-client/docs/functions/tevmLoadState.md +++ b/packages/memory-client/docs/functions/tevmLoadState.md @@ -8,11 +8,6 @@ > **tevmLoadState**(`client`, `params`): `Promise`\<`LoadStateResult`\<`InternalError`\>\> -A tree-shakeable version of the `tevmLoadState` action for viem. -Loads the state into TEVM from a plain JavaScript object. - -This action is useful for restoring the state that was previously dumped using the `tevmDumpState` action. - ## Parameters • **client**: `Client`\<[`TevmTransport`](../type-aliases/TevmTransport.md)\<`string`\>, `undefined` \| `Chain`, `undefined` \| `Account`, `undefined`, `undefined` \| `object`\> @@ -29,38 +24,6 @@ The state to load into TEVM. The result of loading the state. -## Example - -```typescript -import { tevmLoadState } from 'tevm/actions' -import { createClient, http } from 'viem' -import { optimism } from 'tevm/common' -import { createTevmTransport } from 'tevm' -import fs from 'fs' - -const client = createClient({ - transport: createTevmTransport({ - fork: { transport: http('https://mainnet.optimism.io')({}) } - }), - chain: optimism, -}) - -async function example() { - const state = JSON.parse(fs.readFileSync('state.json', 'utf8')) - const result = await tevmLoadState(client, state) - console.log('State loaded:', result) -} - -example() -``` - -## See - - - [LoadStateParams](https://tevm.sh/reference/tevm/actions/type-aliases/loadstateparams/) for options reference. - - [LoadStateResult](https://tevm.sh/reference/tevm/actions/type-aliases/loadstateresult/) for return values reference. - - [TEVM Actions Guide](https://tevm.sh/learn/actions/) - - [tevmDumpState](https://tevm.sh/reference/tevm/actions/functions/tevmDumpState/) for dumping the state. - ## Defined in [packages/memory-client/src/tevmLoadState.js:42](https://github.com/evmts/tevm-monorepo/blob/main/packages/memory-client/src/tevmLoadState.js#L42) diff --git a/packages/memory-client/docs/functions/tevmMine.md b/packages/memory-client/docs/functions/tevmMine.md index d3b35dcefa..aef3725e30 100644 --- a/packages/memory-client/docs/functions/tevmMine.md +++ b/packages/memory-client/docs/functions/tevmMine.md @@ -8,16 +8,6 @@ > **tevmMine**(`client`, `params`?): `Promise`\<`MineResult`\> -A tree-shakeable version of the `tevmMine` action for viem. -Mines blocks in TEVM. - -This function allows you to mine blocks in the TEVM, which is necessary for updating the canonical head state. -The result of mining includes an array of block hashes of the mined blocks. - -You can customize the mining process with the `blockCount` and `interval` parameters: -- `blockCount`: The number of blocks to mine. Defaults to 1. -- `interval`: The interval between block timestamps in seconds. Defaults to 1. - ## Parameters • **client**: `Client`\<[`TevmTransport`](../type-aliases/TevmTransport.md)\<`string`\>, `undefined` \| `Chain`, `undefined` \| `Account`, `undefined`, `undefined` \| `object`\> @@ -34,40 +24,6 @@ Optional parameters for mining blocks. The result of mining blocks, including an array of block hashes. -## Example - -```typescript -import { tevmMine } from 'tevm/actions' -import { createClient, http } from 'viem' -import { optimism } from 'tevm/common' -import { createTevmTransport } from 'tevm' - -const client = createClient({ - transport: createTevmTransport({ - fork: { transport: http('https://mainnet.optimism.io')({}) } - }), - chain: optimism, -}) - -async function example() { - // Mine a single block - const result = await tevmMine(client) - console.log('Mined block hashes:', result.blockHashes) - - // Mine 5 blocks with a 10 second interval between each block - const resultWithParams = await tevmMine(client, { blockCount: 5, interval: 10 }) - console.log('Mined block hashes with params:', resultWithParams.blockHashes) -} - -example() -``` - -## See - - - [MineParams](https://tevm.sh/reference/tevm/actions/type-aliases/mineparams/) for options reference. - - [MineResult](https://tevm.sh/reference/tevm/actions/type-aliases/mineresult/) for return values reference. - - [TEVM Actions Guide](https://tevm.sh/learn/actions/) - ## Defined in [packages/memory-client/src/tevmMine.js:49](https://github.com/evmts/tevm-monorepo/blob/main/packages/memory-client/src/tevmMine.js#L49) diff --git a/packages/memory-client/docs/functions/tevmReady.md b/packages/memory-client/docs/functions/tevmReady.md index f5a279793d..82d55c3847 100644 --- a/packages/memory-client/docs/functions/tevmReady.md +++ b/packages/memory-client/docs/functions/tevmReady.md @@ -8,15 +8,6 @@ > **tevmReady**(`client`): `Promise`\<`true`\> -A tree-shakeable version of the `tevmReady` action for viem. -Checks if TEVM is ready. - -This function ensures that the TEVM is fully initialized and ready for operations. -It resolves to `true` if the TEVM is ready, and throws an error if the VM fails to initialize. - -Note: It is not necessary to explicitly call `tevmReady` because all actions implicitly wait for TEVM to be ready. -However, this can be useful if you want to isolate initialization from the action, for example, when running benchmark tests. - ## Parameters • **client**: `Client`\<[`TevmTransport`](../type-aliases/TevmTransport.md)\<`string`\>, `undefined` \| `Chain`, `undefined` \| `Account`, `undefined`, `undefined` \| `object`\> @@ -29,41 +20,6 @@ The viem client configured with TEVM transport. Resolves when ready, rejects if VM fails to initialize. -## Throws - -If the VM fails to initialize. - -## Example - -```typescript -import { tevmReady } from 'tevm/actions' -import { createClient, http } from 'viem' -import { optimism } from 'tevm/common' -import { createTevmTransport } from 'tevm' - -const client = createClient({ - transport: createTevmTransport({ - fork: { transport: http('https://mainnet.optimism.io')({}) } - }), - chain: optimism, -}) - -async function example() { - try { - await tevmReady(client) - console.log('TEVM is ready') - } catch (error) { - console.error('Failed to initialize TEVM:', error) - } -} - -example() -``` - -## See - -[TEVM Actions Guide](https://tevm.sh/learn/actions/) - ## Defined in [packages/memory-client/src/tevmReady.js:43](https://github.com/evmts/tevm-monorepo/blob/main/packages/memory-client/src/tevmReady.js#L43) diff --git a/packages/memory-client/docs/functions/tevmSetAccount.md b/packages/memory-client/docs/functions/tevmSetAccount.md index d42c26edf1..41a73090eb 100644 --- a/packages/memory-client/docs/functions/tevmSetAccount.md +++ b/packages/memory-client/docs/functions/tevmSetAccount.md @@ -8,12 +8,6 @@ > **tevmSetAccount**(`client`, `params`): `Promise`\<`SetAccountResult`\<`TevmSetAccountError`\>\> -A tree-shakeable version of the `tevmSetAccount` action for viem. -Sets the account in TEVM. - -This function allows you to set various properties of an account in TEVM, such as its balance, nonce, contract deployedBytecode, and storage state. -It is a powerful tool for setting up test environments and manipulating accounts for advanced scenarios. - ## Parameters • **client**: `Client`\<[`TevmTransport`](../type-aliases/TevmTransport.md)\<`string`\>, `undefined` \| `Chain`, `undefined` \| `Account`, `undefined`, `undefined` \| `object`\> @@ -30,45 +24,6 @@ Parameters for setting the account. The result of setting the account. -## Example - -```typescript -import { tevmSetAccount } from 'tevm/actions' -import { createClient, http } from 'viem' -import { optimism } from 'tevm/common' -import { createTevmTransport } from 'tevm' -import { numberToHex } from '@tevm/utils' -import { SimpleContract } from 'tevm/contract' - -const client = createClient({ - transport: createTevmTransport({ - fork: { transport: http('https://mainnet.optimism.io')({}) } - }), - chain: optimism, -}) - -async function example() { - await tevmSetAccount(client, { - address: `0x${'0123'.repeat(10)}`, - balance: 100n, - nonce: 1n, - deployedBytecode: SimpleContract.deployedBytecode, - state: { - [`0x${'0'.repeat(64)}`]: numberToHex(420n), - }, - }) - console.log('Account set') -} - -example() -``` - -## See - - - [SetAccountParams](https://tevm.sh/reference/tevm/actions/type-aliases/setaccountparams/) for options reference. - - [SetAccountResult](https://tevm.sh/reference/tevm/actions/type-aliases/setaccountresult/) for return values reference. - - [TEVM Actions Guide](https://tevm.sh/learn/actions/) - ## Defined in [packages/memory-client/src/tevmSetAccount.js:50](https://github.com/evmts/tevm-monorepo/blob/main/packages/memory-client/src/tevmSetAccount.js#L50) diff --git a/packages/memory-client/docs/functions/tevmViemActions.md b/packages/memory-client/docs/functions/tevmViemActions.md index c702ae9b95..79e1637a13 100644 --- a/packages/memory-client/docs/functions/tevmViemActions.md +++ b/packages/memory-client/docs/functions/tevmViemActions.md @@ -8,13 +8,6 @@ > **tevmViemActions**(): (`client`) => [`TevmViemActionsApi`](../type-aliases/TevmViemActionsApi.md) -A viem extension that adds TEVM actions to a viem client. -The viem client must already have TEVM support via `createTevmClient` or `createTevmTransport`. - -This extension provides a comprehensive set of actions to interact with the TEVM, including calls, contract interactions, deployments, mining, and more. - -Note: If you are building a frontend application, you should use the tree-shakable API instead to optimize bundle size. - ## Returns `Function` @@ -29,36 +22,6 @@ The viem extension to add TevmViemActionsApi [`TevmViemActionsApi`](../type-aliases/TevmViemActionsApi.md) -## Example - -```typescript -import { createClient, http } from 'viem' -import { optimism } from 'tevm/common' -import { createTevmTransport, tevmViemActions } from 'tevm' - -const client = createClient({ - transport: createTevmTransport({ - fork: { transport: http('https://mainnet.optimism.io')({}) } - }), - chain: optimism, -}).extend(tevmViemActions()) - -async function example() { - const account = await client.tevmGetAccount({ - address: '0x123...', - returnStorage: true, - }) - console.log(account) -} - -example() -``` - -## See - - - [TEVM Actions Guide](https://tevm.sh/learn/actions/) - - [Viem Client Guide](https://viem.sh/docs/clients/) - ## Defined in [packages/memory-client/src/tevmViemActions.js:39](https://github.com/evmts/tevm-monorepo/blob/main/packages/memory-client/src/tevmViemActions.js#L39) diff --git a/packages/memory-client/docs/functions/walletActions.md b/packages/memory-client/docs/functions/walletActions.md index 6a1786f207..81b5db05f0 100644 --- a/packages/memory-client/docs/functions/walletActions.md +++ b/packages/memory-client/docs/functions/walletActions.md @@ -6,24 +6,24 @@ # Function: walletActions() -> **walletActions**\<`TTransport`, `TChain`, `TAccount`\>(`client`): `WalletActions`\<`TChain`, `TAccount`\> +> **walletActions**\<`transport`, `chain`, `account`\>(`client`): `WalletActions`\<`chain`, `account`\> ## Type Parameters -• **TTransport** *extends* `Transport` +• **transport** *extends* `Transport` -• **TChain** *extends* `undefined` \| `Chain` = `undefined` \| `Chain` +• **chain** *extends* `undefined` \| `Chain` = `undefined` \| `Chain` -• **TAccount** *extends* `undefined` \| `Account` = `undefined` \| `Account` +• **account** *extends* `undefined` \| `Account` = `undefined` \| `Account` ## Parameters -• **client**: `Client`\<`TTransport`, `TChain`, `TAccount`\> +• **client**: `Client`\<`transport`, `chain`, `account`\> ## Returns -`WalletActions`\<`TChain`, `TAccount`\> +`WalletActions`\<`chain`, `account`\> ## Defined in -node\_modules/.pnpm/viem@2.16.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/clients/decorators/wallet.d.ts:560 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/clients/decorators/wallet.d.ts:560 diff --git a/packages/memory-client/docs/type-aliases/MemoryClient.md b/packages/memory-client/docs/type-aliases/MemoryClient.md index 409cdc960a..eaa4df3597 100644 --- a/packages/memory-client/docs/type-aliases/MemoryClient.md +++ b/packages/memory-client/docs/type-aliases/MemoryClient.md @@ -13,12 +13,6 @@ The MemoryClient comes preloaded with all wallet, test, public, and TEVM actions This client allows for extensive interaction with the EVM, including making JSON-RPC requests, managing accounts, forking networks, and handling state persistence. -## Type Parameters - -• **TChain** *extends* `Chain` \| `undefined` = `Chain` \| `undefined` - -• **TAccountOrAddress** *extends* `Account` \| `Address` \| `undefined` = `Account` \| `Address` \| `undefined` - ## Example ```typescript @@ -199,6 +193,12 @@ const balance = await tevm.runContractCall( console.log(balance); // 1n ``` +## Type Parameters + +• **TChain** *extends* `Chain` \| `undefined` = `Chain` \| `undefined` + +• **TAccountOrAddress** *extends* `Account` \| `Address` \| `undefined` = `Account` \| `Address` \| `undefined` + ## Defined in [packages/memory-client/src/MemoryClient.ts:193](https://github.com/evmts/tevm-monorepo/blob/main/packages/memory-client/src/MemoryClient.ts#L193) diff --git a/packages/memory-client/docs/type-aliases/MemoryClientOptions.md b/packages/memory-client/docs/type-aliases/MemoryClientOptions.md index b72de68cc1..79fd9da468 100644 --- a/packages/memory-client/docs/type-aliases/MemoryClientOptions.md +++ b/packages/memory-client/docs/type-aliases/MemoryClientOptions.md @@ -13,20 +13,6 @@ Configuration options for creating a [MemoryClient](MemoryClient.md). This type extends `TevmNodeOptions` and includes specific options for configuring the MemoryClient, such as the transport type, account, polling interval, and caching behavior. -## Type Parameters - -• **TCommon** *extends* `Common` & `Chain` = `Common` & `Chain` - -The common chain configuration, extending both `Common` and `Chain`. - -• **TAccountOrAddress** *extends* `Account` \| `Address` \| `undefined` = `undefined` - -The account or address type for the client. - -• **TRpcSchema** *extends* `RpcSchema` \| `undefined` = [`TevmRpcSchema`](TevmRpcSchema.md) - -The RPC schema type, defaults to `TevmRpcSchema`. - ## Example ```typescript @@ -52,6 +38,20 @@ const client = createMemoryClient(options); - [MemoryClient](MemoryClient.md) - [CreateMemoryClientFn](CreateMemoryClientFn.md) +## Type Parameters + +• **TCommon** *extends* `Common` & `Chain` = `Common` & `Chain` + +The common chain configuration, extending both `Common` and `Chain`. + +• **TAccountOrAddress** *extends* `Account` \| `Address` \| `undefined` = `undefined` + +The account or address type for the client. + +• **TRpcSchema** *extends* `RpcSchema` \| `undefined` = [`TevmRpcSchema`](TevmRpcSchema.md) + +The RPC schema type, defaults to `TevmRpcSchema`. + ## Defined in [packages/memory-client/src/MemoryClientOptions.ts:50](https://github.com/evmts/tevm-monorepo/blob/main/packages/memory-client/src/MemoryClientOptions.ts#L50) diff --git a/packages/memory-client/docs/type-aliases/TevmActions.md b/packages/memory-client/docs/type-aliases/TevmActions.md index 9d35e5012e..b0acef2891 100644 --- a/packages/memory-client/docs/type-aliases/TevmActions.md +++ b/packages/memory-client/docs/type-aliases/TevmActions.md @@ -11,6 +11,11 @@ Provides powerful actions for interacting with the EVM using the TEVM API. These actions allow for low-level access to the EVM, managing accounts, deploying contracts, and more. +## See + + - [Actions Guide](https://tevm.sh/learn/actions/) + - [Viem Actions API](https://viem.sh/docs/actions/introduction) + ## Type declaration ### tevm @@ -222,10 +227,6 @@ await client.tevmMine() Returns a promise that resolves when the TEVM is ready. This is not needed to explicitly be called as all actions will wait for the TEVM to be ready. -#### Returns - -`Promise`\<`true`\> - #### Example ```typescript @@ -237,6 +238,10 @@ await client.tevmReady() ``` Same as calling `client.tevm.ready()` +#### Returns + +`Promise`\<`true`\> + ### ~~tevmScript~~ > **tevmScript**: `TevmActionsApi`\[`"script"`\] @@ -296,11 +301,6 @@ await client.tevmSetAccount({ }) ``` -## See - - - [Actions Guide](https://tevm.sh/learn/actions/) - - [Viem Actions API](https://viem.sh/docs/actions/introduction) - ## Defined in [packages/memory-client/src/TevmActions.ts:11](https://github.com/evmts/tevm-monorepo/blob/main/packages/memory-client/src/TevmActions.ts#L11) diff --git a/packages/memory-client/docs/type-aliases/TevmViemActionsApi.md b/packages/memory-client/docs/type-aliases/TevmViemActionsApi.md index b6d9184572..4038ca4891 100644 --- a/packages/memory-client/docs/type-aliases/TevmViemActionsApi.md +++ b/packages/memory-client/docs/type-aliases/TevmViemActionsApi.md @@ -12,6 +12,15 @@ A custom [viem extension](https://viem.sh/docs/clients/custom#extending-with-act Tevm specific actions to the client. These actions come preloaded with [MemoryClient](https://tevm.sh/reference/tevm/memory-client/type-aliases/memoryclient/) To add these actions use the `extend` method on a TevmClient with the tevmViemActions() extension. +## Example + +```typescript +import { createTevmClient, tevmViemActions } from 'tevm' + +const client = createTevmClient() + .extend(tevmViemActions()) +``` + ## Type declaration ### tevm @@ -58,15 +67,6 @@ To add these actions use the `extend` method on a TevmClient with the tevmViemAc > **tevmSetAccount**: `TevmActionsApi`\[`"setAccount"`\] -## Example - -```typescript -import { createTevmClient, tevmViemActions } from 'tevm' - -const client = createTevmClient() - .extend(tevmViemActions()) -``` - ## Defined in [packages/memory-client/src/TevmViemActionsApi.ts:16](https://github.com/evmts/tevm-monorepo/blob/main/packages/memory-client/src/TevmViemActionsApi.ts#L16) diff --git a/packages/memory-client/package.json b/packages/memory-client/package.json index 3cabc371f2..5476dcc02e 100644 --- a/packages/memory-client/package.json +++ b/packages/memory-client/package.json @@ -19,6 +19,7 @@ "contributors": [ "Will Cory " ], + "sideEffects": false, "type": "module", "exports": { "./package.json": "./package.json", @@ -84,6 +85,5 @@ }, "publishConfig": { "access": "public" - }, - "sideEffects": false + } } \ No newline at end of file diff --git a/packages/memory-client/src/test/requests.spec.ts b/packages/memory-client/src/test/requests.spec.ts index f74f125112..c5835e21d8 100644 --- a/packages/memory-client/src/test/requests.spec.ts +++ b/packages/memory-client/src/test/requests.spec.ts @@ -2,7 +2,7 @@ import { optimism } from '@tevm/common' import { ERC20 } from '@tevm/contract' import type { CallJsonRpcRequest } from '@tevm/procedures' import { transports } from '@tevm/test-utils' -import { EthjsAddress, type Hex, bytesToHex, parseAbi } from '@tevm/utils' +import { EthjsAddress, type Hex, bytesToHex, encodeDeployData, parseAbi } from '@tevm/utils' import { decodeFunctionResult, encodeFunctionData, hexToBigInt, hexToBytes, toHex } from '@tevm/utils' import { describe, expect, it } from 'vitest' import { createMemoryClient } from '../createMemoryClient.js' @@ -22,7 +22,7 @@ describe('Tevm.request', async () => { params: [ { data: encodeFunctionData(ERC20.read.balanceOf(contractAddress)), - code: ERC20.script({ constructorArgs: ['Name', 'SYMBOL'] }).code, + code: encodeDeployData(ERC20.deploy('Name', 'SYMBOL')), }, ], jsonrpc: '2.0', diff --git a/packages/memory-client/src/test/tevm.spec.ts b/packages/memory-client/src/test/tevm.spec.ts index 00da5b70d2..95db9dc66f 100644 --- a/packages/memory-client/src/test/tevm.spec.ts +++ b/packages/memory-client/src/test/tevm.spec.ts @@ -3,7 +3,7 @@ import { ERC20 } from '@tevm/contract' import { transports } from '@tevm/test-utils' import { EthjsAddress } from '@tevm/utils' import { hexToBytes } from '@tevm/utils' -import { testActions } from 'viem' +import { encodeDeployData, testActions } from 'viem' import { describe, expect, it } from 'vitest' import { createMemoryClient } from '../createMemoryClient.js' import { DaiContract } from './DaiContract.sol.js' @@ -50,12 +50,12 @@ describe('Tevm should create a local vm in JavaScript', () => { it('should execute scripts based on their bytecode and return the result', async () => { const tevm = createMemoryClient() console.log( - ERC20.script({ constructorArgs: ['name', 'symbol'] }).read.balanceOf( + ERC20.withCode(encodeDeployData(ERC20.deploy('name', 'symbol'))).read.balanceOf( '0x00000000000000000000000000000000000000ff', ), ) const res = await tevm.tevmContract( - ERC20.script({ constructorArgs: ['name', 'symbol'] }).read.balanceOf( + ERC20.withCode(encodeDeployData(ERC20.deploy('name', 'symbol'))).read.balanceOf( '0x00000000000000000000000000000000000000ff', ), ) diff --git a/packages/memory-client/src/test/viem/readContract.spec.ts b/packages/memory-client/src/test/viem/readContract.spec.ts index 77ca7f990d..95b4a5ea10 100644 --- a/packages/memory-client/src/test/viem/readContract.spec.ts +++ b/packages/memory-client/src/test/viem/readContract.spec.ts @@ -1,5 +1,5 @@ import { SimpleContract } from '@tevm/test-utils' -import { encodeFunctionData, numberToHex } from 'viem' +import { encodeDeployData, encodeFunctionData, numberToHex } from 'viem' import { beforeEach, describe, expect, it } from 'vitest' import type { MemoryClient } from '../../MemoryClient.js' import { createMemoryClient } from '../../createMemoryClient.js' @@ -31,7 +31,7 @@ beforeEach(async () => { describe('readContract', () => { it('should work as script', async () => { expect(SimpleContract.bytecode).not.toBe(SimpleContract.deployedBytecode) - const { code } = SimpleContract.script({ constructorArgs: [42n] }) + const code = encodeDeployData(SimpleContract.deploy(42n)) expect( await mc.call({ code, diff --git a/packages/memory-client/src/tevmSetAccount.spec.ts b/packages/memory-client/src/tevmSetAccount.spec.ts index 210ad71400..646104e617 100644 --- a/packages/memory-client/src/tevmSetAccount.spec.ts +++ b/packages/memory-client/src/tevmSetAccount.spec.ts @@ -47,17 +47,6 @@ describe('tevmSetAccount', () => { hexToBytes(Object.keys(state)[0] as Hex), ), ).toEqual(hexToBytes(state[`0x${'0'.repeat(64)}`] as Hex)) - expect( - vm.stateManager._baseState.caches.storage._orderedMapCache?.getElementByKey( - EthjsAddress.fromString(address).toString().slice(2), - ), - ).toEqual( - new Map( - Object.entries({ - '0000000000000000000000000000000000000000000000000000000000000000': Uint8Array.from([42]), - }), - ), - ) expect(await vm.stateManager.dumpStorage(EthjsAddress.fromString(address))).toEqual({ '0000000000000000000000000000000000000000000000000000000000000000': bytesToHex(Uint8Array.from([42])), diff --git a/packages/node/docs/README.md b/packages/node/docs/README.md index d9c4c0a545..807159bf35 100644 --- a/packages/node/docs/README.md +++ b/packages/node/docs/README.md @@ -6,11 +6,11 @@ The internal node implementation for tevm. Based on the ethereumjs api and uses the following subpackages -- [@tevm/vm](../vm/) -- [@tevm/evm](../evm/) -- [@tevm/blockchain](../blockchain/) -- [@tevm/state](../state/) +- [@tevm/vm]() +- [@tevm/evm]() +- [@tevm/blockchain]() +- [@tevm/state]() ## License 📄 - + diff --git a/packages/node/docs/_media/LICENSE b/packages/node/docs/_media/LICENSE deleted file mode 100644 index b5a4fa7a69..0000000000 --- a/packages/node/docs/_media/LICENSE +++ /dev/null @@ -1,22 +0,0 @@ -(The MIT License) - -Copyright 2020-2022 - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/packages/node/docs/classes/ProviderRpcError.md b/packages/node/docs/classes/ProviderRpcError.md index 8d23ab9fe4..aa61412d4c 100644 --- a/packages/node/docs/classes/ProviderRpcError.md +++ b/packages/node/docs/classes/ProviderRpcError.md @@ -118,6 +118,10 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -128,10 +132,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from `Error.prepareStackTrace` @@ -204,7 +204,7 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 #### captureStackTrace(targetObject, constructorOpt) @@ -228,7 +228,7 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@20.12.14/node\_modules/@types/node/globals.d.ts:21 +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 #### captureStackTrace(targetObject, constructorOpt) @@ -253,3 +253,27 @@ Create .stack property on a target object ##### Defined in node\_modules/.pnpm/bun-types@1.1.22/node\_modules/bun-types/globals.d.ts:1629 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +`Error.captureStackTrace` + +##### Defined in + +node\_modules/.pnpm/@types+node@20.12.14/node\_modules/@types/node/globals.d.ts:21 diff --git a/packages/node/docs/functions/createTevmNode.md b/packages/node/docs/functions/createTevmNode.md index b1c684c561..92c5f0bfe9 100644 --- a/packages/node/docs/functions/createTevmNode.md +++ b/packages/node/docs/functions/createTevmNode.md @@ -8,21 +8,14 @@ > **createTevmNode**(`options`?): [`TevmNode`](../type-aliases/TevmNode.md)\<`"fork"` \| `"normal"`, `object`\> -Creates the base instance of a memory client - ## Parameters -• **options?**: [`TevmNodeOptions`](../type-aliases/TevmNodeOptions.md)\<`Common`\> = `{}` +• **options?**: [`TevmNodeOptions`](../type-aliases/TevmNodeOptions.md)\<`object`\> = `{}` ## Returns [`TevmNode`](../type-aliases/TevmNode.md)\<`"fork"` \| `"normal"`, `object`\> -## Example - -```ts - ``` - ## Defined in [packages/node/src/createTevmNode.js:27](https://github.com/evmts/tevm-monorepo/blob/main/packages/node/src/createTevmNode.js#L27) diff --git a/packages/node/docs/type-aliases/TevmNode.md b/packages/node/docs/type-aliases/TevmNode.md index 66bedbab8f..31a375e9d7 100644 --- a/packages/node/docs/type-aliases/TevmNode.md +++ b/packages/node/docs/type-aliases/TevmNode.md @@ -149,10 +149,6 @@ Returns promise that resulves when the client is ready The client is usable without calling this method but may have extra latency on the first call from initialization -#### Returns - -`Promise`\<`true`\> - #### Example ```ts @@ -160,6 +156,10 @@ const client = createMemoryClient() await client.ready() ``` +#### Returns + +`Promise`\<`true`\> + ### removeFilter() > `readonly` **removeFilter**: (`id`) => `void` diff --git a/packages/node/package.json b/packages/node/package.json index d617921aeb..d8597fb22a 100644 --- a/packages/node/package.json +++ b/packages/node/package.json @@ -19,6 +19,7 @@ "contributors": [ "Will Cory " ], + "sideEffects": false, "type": "module", "exports": { "./package.json": "./package.json", @@ -88,6 +89,5 @@ }, "publishConfig": { "access": "public" - }, - "sideEffects": false + } } \ No newline at end of file diff --git a/packages/precompiles/docs/README.md b/packages/precompiles/docs/README.md index 09d28c1917..c9e24ba565 100644 --- a/packages/precompiles/docs/README.md +++ b/packages/precompiles/docs/README.md @@ -38,4 +38,4 @@ npm install @tevm/remote-tevm ## License 📄 - + diff --git a/packages/precompiles/docs/_media/LICENSE b/packages/precompiles/docs/_media/LICENSE deleted file mode 100644 index b5a4fa7a69..0000000000 --- a/packages/precompiles/docs/_media/LICENSE +++ /dev/null @@ -1,22 +0,0 @@ -(The MIT License) - -Copyright 2020-2022 - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/packages/precompiles/package.json b/packages/precompiles/package.json index cee3646b2f..05b7b89bc4 100644 --- a/packages/precompiles/package.json +++ b/packages/precompiles/package.json @@ -19,6 +19,7 @@ "contributors": [ "Will Cory " ], + "sideEffects": false, "type": "module", "exports": { "./package.json": "./package.json", @@ -72,6 +73,5 @@ }, "publishConfig": { "access": "public" - }, - "sideEffects": false + } } \ No newline at end of file diff --git a/packages/predeploys/docs/README.md b/packages/predeploys/docs/README.md index e91b270a5c..9e3ffdb69f 100644 --- a/packages/predeploys/docs/README.md +++ b/packages/predeploys/docs/README.md @@ -32,4 +32,4 @@ ## License 📄 - + diff --git a/packages/predeploys/docs/_media/LICENSE b/packages/predeploys/docs/_media/LICENSE deleted file mode 100644 index b5a4fa7a69..0000000000 --- a/packages/predeploys/docs/_media/LICENSE +++ /dev/null @@ -1,22 +0,0 @@ -(The MIT License) - -Copyright 2020-2022 - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/packages/predeploys/docs/functions/definePredeploy.md b/packages/predeploys/docs/functions/definePredeploy.md index dc27bf129c..d0225255af 100644 --- a/packages/predeploys/docs/functions/definePredeploy.md +++ b/packages/predeploys/docs/functions/definePredeploy.md @@ -24,28 +24,6 @@ Defines a predeploy contract to use in the tevm vm [`Predeploy`](../type-aliases/Predeploy.md)\<`TName`, `THumanReadableAbi`\> -## Example - -```ts -import { definePredeploy } from 'tevm/predeploys' -import { createMemoryClient } from 'tevm/vm' -import { createContract } from 'tevm/contract' - -const predeploy = definePredeploy({ - address: `0x${'23'.repeat(20)}`, - contract: createContract({ - name: 'PredeployExample', - humanReadableAbi: ['function foo() external pure returns (uint256)'], - bytecode: '0x608060405234801561001057600080fd5b5061012f806100206000396000f3fe608060405260043610610041576000357c0100', - deployedBytecode: '0x608060405260043610610041576000357c010000 - }) -}) - -const vm = createMemoryClient({ - predeploys: [predeploy.predeploy()], -}) -``` - ## Defined in [definePredeploy.js:27](https://github.com/evmts/tevm-monorepo/blob/main/packages/predeploys/src/definePredeploy.js#L27) diff --git a/packages/predeploys/docs/type-aliases/DefinePredeployFn.md b/packages/predeploys/docs/type-aliases/DefinePredeployFn.md index deb7e33030..821c3f449a 100644 --- a/packages/predeploys/docs/type-aliases/DefinePredeployFn.md +++ b/packages/predeploys/docs/type-aliases/DefinePredeployFn.md @@ -10,20 +10,6 @@ Defines a predeploy contract to use in the tevm vm -## Type Parameters - -• **TName** *extends* `string` - -• **THumanReadableAbi** *extends* readonly `string`[] - -## Parameters - -• **contract**: `Contract`\<`TName`, `THumanReadableAbi`, `Address`, `Hex`, `Hex`\> - -## Returns - -[`Predeploy`](Predeploy.md)\<`TName`, `THumanReadableAbi`\> - ## Example ```ts @@ -46,6 +32,20 @@ const vm = createMemoryClient({ }) ``` +## Type Parameters + +• **TName** *extends* `string` + +• **THumanReadableAbi** *extends* readonly `string`[] + +## Parameters + +• **contract**: `Contract`\<`TName`, `THumanReadableAbi`, `Address`, `Hex`, `Hex`\> + +## Returns + +[`Predeploy`](Predeploy.md)\<`TName`, `THumanReadableAbi`\> + ## Defined in [DefinePredeployFn.ts:28](https://github.com/evmts/tevm-monorepo/blob/main/packages/predeploys/src/DefinePredeployFn.ts#L28) diff --git a/packages/predeploys/package.json b/packages/predeploys/package.json index f9cb208de4..a7e141b2c0 100644 --- a/packages/predeploys/package.json +++ b/packages/predeploys/package.json @@ -21,6 +21,7 @@ "contributors": [ "Will Cory " ], + "sideEffects": false, "type": "module", "exports": { "./package.json": "./package.json", @@ -74,6 +75,5 @@ }, "publishConfig": { "access": "public" - }, - "sideEffects": false + } } \ No newline at end of file diff --git a/packages/procedures/docs/README.md b/packages/procedures/docs/README.md index 80af987aae..dcd2b91ff8 100644 --- a/packages/procedures/docs/README.md +++ b/packages/procedures/docs/README.md @@ -26,11 +26,11 @@ # @tevm/procedures -Ethereumjs implementation of the [Tevm api](../api) implemented with ethereumjs +Ethereumjs implementation of the [Tevm api]() implemented with ethereumjs -Base handlers are defined in [src/handlers](./src/handlers/) +Base handlers are defined in [src/handlers]() -JsonRpc Implementation is defined in [src/jsonrpc](./src/handlers/) +JsonRpc Implementation is defined in [src/jsonrpc]() ## Visit [Docs](https://tevm.sh/) for docs, guides, API and more! @@ -38,4 +38,4 @@ JsonRpc Implementation is defined in [src/jsonrpc](./src/handlers/) ## License 📄 - + diff --git a/packages/procedures/docs/_media/LICENSE b/packages/procedures/docs/_media/LICENSE deleted file mode 100644 index b5a4fa7a69..0000000000 --- a/packages/procedures/docs/_media/LICENSE +++ /dev/null @@ -1,22 +0,0 @@ -(The MIT License) - -Copyright 2020-2022 - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/packages/procedures/docs/functions/anvilDropTransactionJsonRpcProcedure.md b/packages/procedures/docs/functions/anvilDropTransactionJsonRpcProcedure.md index d418988615..9ac43b7012 100644 --- a/packages/procedures/docs/functions/anvilDropTransactionJsonRpcProcedure.md +++ b/packages/procedures/docs/functions/anvilDropTransactionJsonRpcProcedure.md @@ -8,8 +8,6 @@ > **anvilDropTransactionJsonRpcProcedure**(`client`): [`AnvilDropTransactionProcedure`](../type-aliases/AnvilDropTransactionProcedure.md) -Request handler for anvil_dropTransaction JSON-RPC requests. - ## Parameters • **client**: `TevmNode`\<`"fork"` \| `"normal"`, `object`\> @@ -20,4 +18,4 @@ Request handler for anvil_dropTransaction JSON-RPC requests. ## Defined in -[procedures/src/anvil/anvilDropTransactionProcedure.js:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/anvilDropTransactionProcedure.js#L8) +[packages/procedures/src/anvil/anvilDropTransactionProcedure.js:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/anvilDropTransactionProcedure.js#L8) diff --git a/packages/procedures/docs/functions/anvilDumpStateJsonRpcProcedure.md b/packages/procedures/docs/functions/anvilDumpStateJsonRpcProcedure.md index eb4a4a9447..d6fa9660ac 100644 --- a/packages/procedures/docs/functions/anvilDumpStateJsonRpcProcedure.md +++ b/packages/procedures/docs/functions/anvilDumpStateJsonRpcProcedure.md @@ -10,8 +10,6 @@ **`Experimental`** -Request handler for anvil_dumpState JSON-RPC requests. - ## Parameters • **client**: `TevmNode`\<`"fork"` \| `"normal"`, `object`\> @@ -20,8 +18,6 @@ Request handler for anvil_dumpState JSON-RPC requests. [`AnvilDumpStateProcedure`](../type-aliases/AnvilDumpStateProcedure.md) -## Param - ## Defined in -[procedures/src/anvil/anvilDumpStateProcedure.js:10](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/anvilDumpStateProcedure.js#L10) +[packages/procedures/src/anvil/anvilDumpStateProcedure.js:10](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/anvilDumpStateProcedure.js#L10) diff --git a/packages/procedures/docs/functions/anvilGetAutomineJsonRpcProcedure.md b/packages/procedures/docs/functions/anvilGetAutomineJsonRpcProcedure.md index c7f79c24de..baa7677ee2 100644 --- a/packages/procedures/docs/functions/anvilGetAutomineJsonRpcProcedure.md +++ b/packages/procedures/docs/functions/anvilGetAutomineJsonRpcProcedure.md @@ -8,8 +8,6 @@ > **anvilGetAutomineJsonRpcProcedure**(`client`): [`AnvilGetAutomineProcedure`](../type-aliases/AnvilGetAutomineProcedure.md) -Request handler for anvil_getAutomine JSON-RPC requests. - ## Parameters • **client**: `TevmNode`\<`"fork"` \| `"normal"`, `object`\> @@ -20,4 +18,4 @@ Request handler for anvil_getAutomine JSON-RPC requests. ## Defined in -[procedures/src/anvil/anvilGetAutomineProcedure.js:6](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/anvilGetAutomineProcedure.js#L6) +[packages/procedures/src/anvil/anvilGetAutomineProcedure.js:6](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/anvilGetAutomineProcedure.js#L6) diff --git a/packages/procedures/docs/functions/anvilImpersonateAccountJsonRpcProcedure.md b/packages/procedures/docs/functions/anvilImpersonateAccountJsonRpcProcedure.md index 64b5f89f1c..dc32c5b475 100644 --- a/packages/procedures/docs/functions/anvilImpersonateAccountJsonRpcProcedure.md +++ b/packages/procedures/docs/functions/anvilImpersonateAccountJsonRpcProcedure.md @@ -8,8 +8,6 @@ > **anvilImpersonateAccountJsonRpcProcedure**(`client`): [`AnvilImpersonateAccountProcedure`](../type-aliases/AnvilImpersonateAccountProcedure.md) -Request handler for anvil_impersonateAccount JSON-RPC requests. - ## Parameters • **client**: `TevmNode`\<`"fork"` \| `"normal"`, `object`\> @@ -20,4 +18,4 @@ Request handler for anvil_impersonateAccount JSON-RPC requests. ## Defined in -[procedures/src/anvil/anvilImpersonateAccountProcedure.js:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/anvilImpersonateAccountProcedure.js#L8) +[packages/procedures/src/anvil/anvilImpersonateAccountProcedure.js:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/anvilImpersonateAccountProcedure.js#L8) diff --git a/packages/procedures/docs/functions/anvilLoadStateJsonRpcProcedure.md b/packages/procedures/docs/functions/anvilLoadStateJsonRpcProcedure.md index dca1f9b2f2..bc95cbd3cb 100644 --- a/packages/procedures/docs/functions/anvilLoadStateJsonRpcProcedure.md +++ b/packages/procedures/docs/functions/anvilLoadStateJsonRpcProcedure.md @@ -8,8 +8,6 @@ > **anvilLoadStateJsonRpcProcedure**(`client`): [`AnvilLoadStateProcedure`](../type-aliases/AnvilLoadStateProcedure.md) -Request handler for anvil_loadState JSON-RPC requests. - ## Parameters • **client**: `TevmNode`\<`"fork"` \| `"normal"`, `object`\> @@ -20,4 +18,4 @@ Request handler for anvil_loadState JSON-RPC requests. ## Defined in -[procedures/src/anvil/anvilLoadStateProcedure.js:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/anvilLoadStateProcedure.js#L9) +[packages/procedures/src/anvil/anvilLoadStateProcedure.js:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/anvilLoadStateProcedure.js#L9) diff --git a/packages/procedures/docs/functions/anvilResetJsonRpcProcedure.md b/packages/procedures/docs/functions/anvilResetJsonRpcProcedure.md index 9c43a5d0dc..444d68d28b 100644 --- a/packages/procedures/docs/functions/anvilResetJsonRpcProcedure.md +++ b/packages/procedures/docs/functions/anvilResetJsonRpcProcedure.md @@ -8,8 +8,6 @@ > **anvilResetJsonRpcProcedure**(`client`): [`AnvilResetProcedure`](../type-aliases/AnvilResetProcedure.md) -Request handler for anvil_reset JSON-RPC requests. - ## Parameters • **client**: `TevmNode`\<`"fork"` \| `"normal"`, `object`\> @@ -20,4 +18,4 @@ Request handler for anvil_reset JSON-RPC requests. ## Defined in -[procedures/src/anvil/anvilResetProcedure.js:6](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/anvilResetProcedure.js#L6) +[packages/procedures/src/anvil/anvilResetProcedure.js:6](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/anvilResetProcedure.js#L6) diff --git a/packages/procedures/docs/functions/anvilSetBalanceJsonRpcProcedure.md b/packages/procedures/docs/functions/anvilSetBalanceJsonRpcProcedure.md index 17fe7cf749..fd637f0008 100644 --- a/packages/procedures/docs/functions/anvilSetBalanceJsonRpcProcedure.md +++ b/packages/procedures/docs/functions/anvilSetBalanceJsonRpcProcedure.md @@ -8,8 +8,6 @@ > **anvilSetBalanceJsonRpcProcedure**(`client`): [`AnvilSetBalanceProcedure`](../type-aliases/AnvilSetBalanceProcedure.md) -Request handler for anvil_setBalance JSON-RPC requests. - ## Parameters • **client**: `TevmNode`\<`"fork"` \| `"normal"`, `object`\> @@ -20,4 +18,4 @@ Request handler for anvil_setBalance JSON-RPC requests. ## Defined in -[procedures/src/anvil/anvilSetBalanceProcedure.js:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/anvilSetBalanceProcedure.js#L8) +[packages/procedures/src/anvil/anvilSetBalanceProcedure.js:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/anvilSetBalanceProcedure.js#L8) diff --git a/packages/procedures/docs/functions/anvilSetChainIdJsonRpcProcedure.md b/packages/procedures/docs/functions/anvilSetChainIdJsonRpcProcedure.md index 972b7c3603..73e7081ecf 100644 --- a/packages/procedures/docs/functions/anvilSetChainIdJsonRpcProcedure.md +++ b/packages/procedures/docs/functions/anvilSetChainIdJsonRpcProcedure.md @@ -8,8 +8,6 @@ > **anvilSetChainIdJsonRpcProcedure**(`client`): [`AnvilSetChainIdProcedure`](../type-aliases/AnvilSetChainIdProcedure.md) -Request handler for anvil_setChainId JSON-RPC requests. - ## Parameters • **client**: `TevmNode`\<`"fork"` \| `"normal"`, `object`\> @@ -20,4 +18,4 @@ Request handler for anvil_setChainId JSON-RPC requests. ## Defined in -[procedures/src/anvil/anvilSetChainIdProcedure.js:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/anvilSetChainIdProcedure.js#L9) +[packages/procedures/src/anvil/anvilSetChainIdProcedure.js:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/anvilSetChainIdProcedure.js#L9) diff --git a/packages/procedures/docs/functions/anvilSetCoinbaseJsonRpcProcedure.md b/packages/procedures/docs/functions/anvilSetCoinbaseJsonRpcProcedure.md index 17138c0445..2943b5d3df 100644 --- a/packages/procedures/docs/functions/anvilSetCoinbaseJsonRpcProcedure.md +++ b/packages/procedures/docs/functions/anvilSetCoinbaseJsonRpcProcedure.md @@ -8,8 +8,6 @@ > **anvilSetCoinbaseJsonRpcProcedure**(`client`): [`AnvilSetCoinbaseProcedure`](../type-aliases/AnvilSetCoinbaseProcedure.md) -Request handler for anvil_SetCoinbase JSON-RPC requests. - ## Parameters • **client**: `TevmNode`\<`"fork"` \| `"normal"`, `object`\> @@ -20,4 +18,4 @@ Request handler for anvil_SetCoinbase JSON-RPC requests. ## Defined in -[procedures/src/anvil/anvilSetCoinbaseProcedure.js:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/anvilSetCoinbaseProcedure.js#L9) +[packages/procedures/src/anvil/anvilSetCoinbaseProcedure.js:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/anvilSetCoinbaseProcedure.js#L9) diff --git a/packages/procedures/docs/functions/anvilSetNonceJsonRpcProcedure.md b/packages/procedures/docs/functions/anvilSetNonceJsonRpcProcedure.md index 649c6788a6..36db884029 100644 --- a/packages/procedures/docs/functions/anvilSetNonceJsonRpcProcedure.md +++ b/packages/procedures/docs/functions/anvilSetNonceJsonRpcProcedure.md @@ -8,8 +8,6 @@ > **anvilSetNonceJsonRpcProcedure**(`client`): [`AnvilSetNonceProcedure`](../type-aliases/AnvilSetNonceProcedure.md) -Request handler for anvil_setNonce JSON-RPC requests. - ## Parameters • **client**: `TevmNode`\<`"fork"` \| `"normal"`, `object`\> @@ -20,4 +18,4 @@ Request handler for anvil_setNonce JSON-RPC requests. ## Defined in -[procedures/src/anvil/anvilSetNonceProcedure.js:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/anvilSetNonceProcedure.js#L8) +[packages/procedures/src/anvil/anvilSetNonceProcedure.js:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/anvilSetNonceProcedure.js#L8) diff --git a/packages/procedures/docs/functions/anvilSetStorageAtJsonRpcProcedure.md b/packages/procedures/docs/functions/anvilSetStorageAtJsonRpcProcedure.md index c1c247e32a..756bc746da 100644 --- a/packages/procedures/docs/functions/anvilSetStorageAtJsonRpcProcedure.md +++ b/packages/procedures/docs/functions/anvilSetStorageAtJsonRpcProcedure.md @@ -8,8 +8,6 @@ > **anvilSetStorageAtJsonRpcProcedure**(`client`): [`AnvilSetStorageAtProcedure`](../type-aliases/AnvilSetStorageAtProcedure.md) -Request handler for anvil_setStorageAt JSON-RPC requests. - ## Parameters • **client**: `TevmNode`\<`"fork"` \| `"normal"`, `object`\> @@ -20,4 +18,4 @@ Request handler for anvil_setStorageAt JSON-RPC requests. ## Defined in -[procedures/src/anvil/anvilSetStorageAtProcedure.js:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/anvilSetStorageAtProcedure.js#L8) +[packages/procedures/src/anvil/anvilSetStorageAtProcedure.js:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/anvilSetStorageAtProcedure.js#L8) diff --git a/packages/procedures/docs/functions/anvilStopImpersonatingAccountJsonRpcProcedure.md b/packages/procedures/docs/functions/anvilStopImpersonatingAccountJsonRpcProcedure.md index b094f1d133..bf1fdac183 100644 --- a/packages/procedures/docs/functions/anvilStopImpersonatingAccountJsonRpcProcedure.md +++ b/packages/procedures/docs/functions/anvilStopImpersonatingAccountJsonRpcProcedure.md @@ -8,8 +8,6 @@ > **anvilStopImpersonatingAccountJsonRpcProcedure**(`client`): [`AnvilStopImpersonatingAccountProcedure`](../type-aliases/AnvilStopImpersonatingAccountProcedure.md) -Request handler for anvil_stopImpersonatingAccount JSON-RPC requests. - ## Parameters • **client**: `TevmNode`\<`"fork"` \| `"normal"`, `object`\> @@ -20,4 +18,4 @@ Request handler for anvil_stopImpersonatingAccount JSON-RPC requests. ## Defined in -[procedures/src/anvil/anvilStopImpersonatingAccountProcedure.js:6](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/anvilStopImpersonatingAccountProcedure.js#L6) +[packages/procedures/src/anvil/anvilStopImpersonatingAccountProcedure.js:6](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/anvilStopImpersonatingAccountProcedure.js#L6) diff --git a/packages/procedures/docs/functions/blockNumberProcedure.md b/packages/procedures/docs/functions/blockNumberProcedure.md index 9c2a892c93..6537723c42 100644 --- a/packages/procedures/docs/functions/blockNumberProcedure.md +++ b/packages/procedures/docs/functions/blockNumberProcedure.md @@ -18,4 +18,4 @@ ## Defined in -[procedures/src/eth/blockNumberProcedure.js:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/blockNumberProcedure.js#L8) +[packages/procedures/src/eth/blockNumberProcedure.js:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/blockNumberProcedure.js#L8) diff --git a/packages/procedures/docs/functions/blockToJsonRpcBlock.md b/packages/procedures/docs/functions/blockToJsonRpcBlock.md index 50e2b7ba54..2a8aa052cf 100644 --- a/packages/procedures/docs/functions/blockToJsonRpcBlock.md +++ b/packages/procedures/docs/functions/blockToJsonRpcBlock.md @@ -20,4 +20,4 @@ ## Defined in -[procedures/src/utils/blockToJsonRpcBlock.js:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/utils/blockToJsonRpcBlock.js#L9) +[packages/procedures/src/utils/blockToJsonRpcBlock.js:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/utils/blockToJsonRpcBlock.js#L9) diff --git a/packages/procedures/docs/functions/callProcedure.md b/packages/procedures/docs/functions/callProcedure.md index ba4fe18012..e4070bfbad 100644 --- a/packages/procedures/docs/functions/callProcedure.md +++ b/packages/procedures/docs/functions/callProcedure.md @@ -8,8 +8,6 @@ > **callProcedure**(`client`): [`CallJsonRpcProcedure`](../type-aliases/CallJsonRpcProcedure.md) -Creates a Call JSON-RPC Procedure for handling call requests with Ethereumjs EVM - ## Parameters • **client**: `TevmNode`\<`"fork"` \| `"normal"`, `object`\> @@ -20,4 +18,4 @@ Creates a Call JSON-RPC Procedure for handling call requests with Ethereumjs EVM ## Defined in -[procedures/src/call/callProcedure.js:10](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/call/callProcedure.js#L10) +[packages/procedures/src/call/callProcedure.js:10](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/call/callProcedure.js#L10) diff --git a/packages/procedures/docs/functions/chainIdProcedure.md b/packages/procedures/docs/functions/chainIdProcedure.md index 09e00e0ff3..4a445909e0 100644 --- a/packages/procedures/docs/functions/chainIdProcedure.md +++ b/packages/procedures/docs/functions/chainIdProcedure.md @@ -18,4 +18,4 @@ ## Defined in -[procedures/src/eth/chainIdProcedure.js:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/chainIdProcedure.js#L8) +[packages/procedures/src/eth/chainIdProcedure.js:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/chainIdProcedure.js#L8) diff --git a/packages/procedures/docs/functions/debugTraceCallJsonRpcProcedure.md b/packages/procedures/docs/functions/debugTraceCallJsonRpcProcedure.md index 28aa4dbcc4..889249076a 100644 --- a/packages/procedures/docs/functions/debugTraceCallJsonRpcProcedure.md +++ b/packages/procedures/docs/functions/debugTraceCallJsonRpcProcedure.md @@ -8,8 +8,6 @@ > **debugTraceCallJsonRpcProcedure**(`client`): [`DebugTraceCallProcedure`](../type-aliases/DebugTraceCallProcedure.md) -Request handler for debug_traceCall JSON-RPC requests. - ## Parameters • **client**: `TevmNode`\<`"fork"` \| `"normal"`, `object`\> @@ -20,4 +18,4 @@ Request handler for debug_traceCall JSON-RPC requests. ## Defined in -[procedures/src/debug/debugTraceCallProcedure.js:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/debug/debugTraceCallProcedure.js#L9) +[packages/procedures/src/debug/debugTraceCallProcedure.js:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/debug/debugTraceCallProcedure.js#L9) diff --git a/packages/procedures/docs/functions/debugTraceTransactionJsonRpcProcedure.md b/packages/procedures/docs/functions/debugTraceTransactionJsonRpcProcedure.md index 45df00a8d2..d988c62071 100644 --- a/packages/procedures/docs/functions/debugTraceTransactionJsonRpcProcedure.md +++ b/packages/procedures/docs/functions/debugTraceTransactionJsonRpcProcedure.md @@ -8,8 +8,6 @@ > **debugTraceTransactionJsonRpcProcedure**(`client`): [`DebugTraceTransactionProcedure`](../type-aliases/DebugTraceTransactionProcedure.md) -Request handler for debug_traceTransaction JSON-RPC requests. - ## Parameters • **client**: `TevmNode`\<`"fork"` \| `"normal"`, `object`\> @@ -20,4 +18,4 @@ Request handler for debug_traceTransaction JSON-RPC requests. ## Defined in -[procedures/src/debug/debugTraceTransactionProcedure.js:12](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/debug/debugTraceTransactionProcedure.js#L12) +[packages/procedures/src/debug/debugTraceTransactionProcedure.js:12](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/debug/debugTraceTransactionProcedure.js#L12) diff --git a/packages/procedures/docs/functions/dumpStateProcedure.md b/packages/procedures/docs/functions/dumpStateProcedure.md index f53ef9ce28..a769ceb2ce 100644 --- a/packages/procedures/docs/functions/dumpStateProcedure.md +++ b/packages/procedures/docs/functions/dumpStateProcedure.md @@ -8,8 +8,6 @@ > **dumpStateProcedure**(`client`): [`DumpStateJsonRpcProcedure`](../type-aliases/DumpStateJsonRpcProcedure.md) -Creates a DumpState JSON-RPC Procedure for handling dumpState requests with Ethereumjs EVM - ## Parameters • **client**: `TevmNode`\<`"fork"` \| `"normal"`, `object`\> @@ -20,4 +18,4 @@ Creates a DumpState JSON-RPC Procedure for handling dumpState requests with Ethe ## Defined in -[procedures/src/dumpstate/dumpStateProcedure.js:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/dumpstate/dumpStateProcedure.js#L9) +[packages/procedures/src/dumpstate/dumpStateProcedure.js:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/dumpstate/dumpStateProcedure.js#L9) diff --git a/packages/procedures/docs/functions/ethAccountsProcedure.md b/packages/procedures/docs/functions/ethAccountsProcedure.md index 9bc52a15f6..1ef83fda7e 100644 --- a/packages/procedures/docs/functions/ethAccountsProcedure.md +++ b/packages/procedures/docs/functions/ethAccountsProcedure.md @@ -18,4 +18,4 @@ ## Defined in -[procedures/src/eth/ethAccountsProcedure.js:7](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/ethAccountsProcedure.js#L7) +[packages/procedures/src/eth/ethAccountsProcedure.js:7](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/ethAccountsProcedure.js#L7) diff --git a/packages/procedures/docs/functions/ethBlobBaseFeeJsonRpcProcedure.md b/packages/procedures/docs/functions/ethBlobBaseFeeJsonRpcProcedure.md index 6d4ac55cfe..f8f54e173f 100644 --- a/packages/procedures/docs/functions/ethBlobBaseFeeJsonRpcProcedure.md +++ b/packages/procedures/docs/functions/ethBlobBaseFeeJsonRpcProcedure.md @@ -8,8 +8,6 @@ > **ethBlobBaseFeeJsonRpcProcedure**(`client`): [`EthGasPriceJsonRpcProcedure`](../type-aliases/EthGasPriceJsonRpcProcedure.md) -Request handler for eth_coinbase JSON-RPC requests. - ## Parameters • **client**: `TevmNode`\<`"fork"` \| `"normal"`, `object`\> @@ -20,4 +18,4 @@ Request handler for eth_coinbase JSON-RPC requests. ## Defined in -[procedures/src/eth/ethBlobBaseFeeProcedure.js:10](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/ethBlobBaseFeeProcedure.js#L10) +[packages/procedures/src/eth/ethBlobBaseFeeProcedure.js:10](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/ethBlobBaseFeeProcedure.js#L10) diff --git a/packages/procedures/docs/functions/ethCallProcedure.md b/packages/procedures/docs/functions/ethCallProcedure.md index e6c40990c7..322125e6d8 100644 --- a/packages/procedures/docs/functions/ethCallProcedure.md +++ b/packages/procedures/docs/functions/ethCallProcedure.md @@ -8,8 +8,6 @@ > **ethCallProcedure**(`client`): [`EthCallJsonRpcProcedure`](../type-aliases/EthCallJsonRpcProcedure.md) -Executes a message call without creating a transaction on the block chain. - ## Parameters • **client**: `TevmNode`\<`"fork"` \| `"normal"`, `object`\> @@ -20,4 +18,4 @@ Executes a message call without creating a transaction on the block chain. ## Defined in -[procedures/src/eth/ethCallProcedure.js:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/ethCallProcedure.js#L8) +[packages/procedures/src/eth/ethCallProcedure.js:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/ethCallProcedure.js#L8) diff --git a/packages/procedures/docs/functions/ethCoinbaseJsonRpcProcedure.md b/packages/procedures/docs/functions/ethCoinbaseJsonRpcProcedure.md index 5e633eac44..77927f4b22 100644 --- a/packages/procedures/docs/functions/ethCoinbaseJsonRpcProcedure.md +++ b/packages/procedures/docs/functions/ethCoinbaseJsonRpcProcedure.md @@ -8,8 +8,6 @@ > **ethCoinbaseJsonRpcProcedure**(`client`): [`EthCoinbaseJsonRpcProcedure`](../type-aliases/EthCoinbaseJsonRpcProcedure.md) -Request handler for eth_coinbase JSON-RPC requests. - ## Parameters • **client**: `TevmNode`\<`"fork"` \| `"normal"`, `object`\> @@ -20,4 +18,4 @@ Request handler for eth_coinbase JSON-RPC requests. ## Defined in -[procedures/src/eth/ethCoinbaseProcedure.js:6](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/ethCoinbaseProcedure.js#L6) +[packages/procedures/src/eth/ethCoinbaseProcedure.js:6](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/ethCoinbaseProcedure.js#L6) diff --git a/packages/procedures/docs/functions/ethEstimateGasJsonRpcProcedure.md b/packages/procedures/docs/functions/ethEstimateGasJsonRpcProcedure.md index cc626b6123..1e3905b280 100644 --- a/packages/procedures/docs/functions/ethEstimateGasJsonRpcProcedure.md +++ b/packages/procedures/docs/functions/ethEstimateGasJsonRpcProcedure.md @@ -8,8 +8,6 @@ > **ethEstimateGasJsonRpcProcedure**(`client`): [`EthEstimateGasJsonRpcProcedure`](../type-aliases/EthEstimateGasJsonRpcProcedure.md) -Request handler for eth_estimateGas JSON-RPC requests. - ## Parameters • **client**: `TevmNode`\<`"fork"` \| `"normal"`, `object`\> @@ -20,4 +18,4 @@ Request handler for eth_estimateGas JSON-RPC requests. ## Defined in -[procedures/src/eth/ethEstimateGasProcedure.js:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/ethEstimateGasProcedure.js#L8) +[packages/procedures/src/eth/ethEstimateGasProcedure.js:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/ethEstimateGasProcedure.js#L8) diff --git a/packages/procedures/docs/functions/ethGetBlockByHashJsonRpcProcedure.md b/packages/procedures/docs/functions/ethGetBlockByHashJsonRpcProcedure.md index 639e909910..0f56ea204d 100644 --- a/packages/procedures/docs/functions/ethGetBlockByHashJsonRpcProcedure.md +++ b/packages/procedures/docs/functions/ethGetBlockByHashJsonRpcProcedure.md @@ -8,8 +8,6 @@ > **ethGetBlockByHashJsonRpcProcedure**(`client`): [`EthGetBlockByHashJsonRpcProcedure`](../type-aliases/EthGetBlockByHashJsonRpcProcedure.md) -Request handler for eth_getBlockByHash JSON-RPC requests. - ## Parameters • **client**: `TevmNode`\<`"fork"` \| `"normal"`, `object`\> @@ -20,4 +18,4 @@ Request handler for eth_getBlockByHash JSON-RPC requests. ## Defined in -[procedures/src/eth/ethGetBlockByHashProcedure.js:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/ethGetBlockByHashProcedure.js#L9) +[packages/procedures/src/eth/ethGetBlockByHashProcedure.js:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/ethGetBlockByHashProcedure.js#L9) diff --git a/packages/procedures/docs/functions/ethGetBlockByNumberJsonRpcProcedure.md b/packages/procedures/docs/functions/ethGetBlockByNumberJsonRpcProcedure.md index 97bb45bfe8..076181e5b0 100644 --- a/packages/procedures/docs/functions/ethGetBlockByNumberJsonRpcProcedure.md +++ b/packages/procedures/docs/functions/ethGetBlockByNumberJsonRpcProcedure.md @@ -8,8 +8,6 @@ > **ethGetBlockByNumberJsonRpcProcedure**(`client`): [`EthGetBlockByNumberJsonRpcProcedure`](../type-aliases/EthGetBlockByNumberJsonRpcProcedure.md) -Request handler for eth_getBlockByNumber JSON-RPC requests. - ## Parameters • **client**: `TevmNode`\<`"fork"` \| `"normal"`, `object`\> @@ -20,4 +18,4 @@ Request handler for eth_getBlockByNumber JSON-RPC requests. ## Defined in -[procedures/src/eth/ethGetBlockByNumberProcedure.js:10](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/ethGetBlockByNumberProcedure.js#L10) +[packages/procedures/src/eth/ethGetBlockByNumberProcedure.js:10](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/ethGetBlockByNumberProcedure.js#L10) diff --git a/packages/procedures/docs/functions/ethGetBlockTransactionCountByHashJsonRpcProcedure.md b/packages/procedures/docs/functions/ethGetBlockTransactionCountByHashJsonRpcProcedure.md index 646056cbf0..4f772ce1cd 100644 --- a/packages/procedures/docs/functions/ethGetBlockTransactionCountByHashJsonRpcProcedure.md +++ b/packages/procedures/docs/functions/ethGetBlockTransactionCountByHashJsonRpcProcedure.md @@ -8,8 +8,6 @@ > **ethGetBlockTransactionCountByHashJsonRpcProcedure**(`client`): [`EthGetBlockTransactionCountByHashJsonRpcProcedure`](../type-aliases/EthGetBlockTransactionCountByHashJsonRpcProcedure.md) -Request handler for eth_getBlockTransactionCountByHash JSON-RPC requests. - ## Parameters • **client**: `TevmNode`\<`"fork"` \| `"normal"`, `object`\> @@ -20,4 +18,4 @@ Request handler for eth_getBlockTransactionCountByHash JSON-RPC requests. ## Defined in -[procedures/src/eth/ethGetBlockTransactionCountByHashProcedure.js:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/ethGetBlockTransactionCountByHashProcedure.js#L8) +[packages/procedures/src/eth/ethGetBlockTransactionCountByHashProcedure.js:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/ethGetBlockTransactionCountByHashProcedure.js#L8) diff --git a/packages/procedures/docs/functions/ethGetBlockTransactionCountByNumberJsonRpcProcedure.md b/packages/procedures/docs/functions/ethGetBlockTransactionCountByNumberJsonRpcProcedure.md index 9c6b6627d9..fe2c66509c 100644 --- a/packages/procedures/docs/functions/ethGetBlockTransactionCountByNumberJsonRpcProcedure.md +++ b/packages/procedures/docs/functions/ethGetBlockTransactionCountByNumberJsonRpcProcedure.md @@ -8,8 +8,6 @@ > **ethGetBlockTransactionCountByNumberJsonRpcProcedure**(`client`): [`EthGetBlockTransactionCountByNumberJsonRpcProcedure`](../type-aliases/EthGetBlockTransactionCountByNumberJsonRpcProcedure.md) -Request handler for eth_getBlockTransactionCountByNumber JSON-RPC requests. - ## Parameters • **client**: `TevmNode`\<`"fork"` \| `"normal"`, `object`\> @@ -20,4 +18,4 @@ Request handler for eth_getBlockTransactionCountByNumber JSON-RPC requests. ## Defined in -[procedures/src/eth/ethGetBlockTransactionCountByNumberProcedure.js:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/ethGetBlockTransactionCountByNumberProcedure.js#L8) +[packages/procedures/src/eth/ethGetBlockTransactionCountByNumberProcedure.js:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/ethGetBlockTransactionCountByNumberProcedure.js#L8) diff --git a/packages/procedures/docs/functions/ethGetFilterChangesProcedure.md b/packages/procedures/docs/functions/ethGetFilterChangesProcedure.md index 59ccb63922..255ef59b4c 100644 --- a/packages/procedures/docs/functions/ethGetFilterChangesProcedure.md +++ b/packages/procedures/docs/functions/ethGetFilterChangesProcedure.md @@ -8,8 +8,6 @@ > **ethGetFilterChangesProcedure**(`client`): [`EthGetFilterChangesJsonRpcProcedure`](../type-aliases/EthGetFilterChangesJsonRpcProcedure.md) -Request handler for eth_getFilterChanges JSON-RPC requests. - ## Parameters • **client**: `TevmNode`\<`"fork"` \| `"normal"`, `object`\> @@ -20,4 +18,4 @@ Request handler for eth_getFilterChanges JSON-RPC requests. ## Defined in -[procedures/src/eth/ethGetFilterChangesProcedure.js:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/ethGetFilterChangesProcedure.js#L8) +[packages/procedures/src/eth/ethGetFilterChangesProcedure.js:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/ethGetFilterChangesProcedure.js#L8) diff --git a/packages/procedures/docs/functions/ethGetFilterLogsProcedure.md b/packages/procedures/docs/functions/ethGetFilterLogsProcedure.md index 7576cfb1b0..94b8a4d44e 100644 --- a/packages/procedures/docs/functions/ethGetFilterLogsProcedure.md +++ b/packages/procedures/docs/functions/ethGetFilterLogsProcedure.md @@ -8,8 +8,6 @@ > **ethGetFilterLogsProcedure**(`client`): [`EthGetFilterLogsJsonRpcProcedure`](../type-aliases/EthGetFilterLogsJsonRpcProcedure.md) -Request handler for eth_getFilterLogs JSON-RPC requests. - ## Parameters • **client**: `TevmNode`\<`"fork"` \| `"normal"`, `object`\> @@ -20,4 +18,4 @@ Request handler for eth_getFilterLogs JSON-RPC requests. ## Defined in -[procedures/src/eth/ethGetFilterLogsProcedure.js:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/ethGetFilterLogsProcedure.js#L9) +[packages/procedures/src/eth/ethGetFilterLogsProcedure.js:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/ethGetFilterLogsProcedure.js#L9) diff --git a/packages/procedures/docs/functions/ethGetLogsProcedure.md b/packages/procedures/docs/functions/ethGetLogsProcedure.md index 4bd02861a5..b55151b1f4 100644 --- a/packages/procedures/docs/functions/ethGetLogsProcedure.md +++ b/packages/procedures/docs/functions/ethGetLogsProcedure.md @@ -8,8 +8,6 @@ > **ethGetLogsProcedure**(`client`): [`EthGetLogsJsonRpcProcedure`](../type-aliases/EthGetLogsJsonRpcProcedure.md) -Executes a message call without creating a transaction on the block chain. - ## Parameters • **client**: `TevmNode`\<`"fork"` \| `"normal"`, `object`\> @@ -20,4 +18,4 @@ Executes a message call without creating a transaction on the block chain. ## Defined in -[procedures/src/eth/ethGetLogsProcedure.js:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/ethGetLogsProcedure.js#L9) +[packages/procedures/src/eth/ethGetLogsProcedure.js:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/ethGetLogsProcedure.js#L9) diff --git a/packages/procedures/docs/functions/ethGetTransactionByBlockHashAndIndexJsonRpcProcedure.md b/packages/procedures/docs/functions/ethGetTransactionByBlockHashAndIndexJsonRpcProcedure.md index 30ff74ac4e..8cb6a34f4e 100644 --- a/packages/procedures/docs/functions/ethGetTransactionByBlockHashAndIndexJsonRpcProcedure.md +++ b/packages/procedures/docs/functions/ethGetTransactionByBlockHashAndIndexJsonRpcProcedure.md @@ -8,8 +8,6 @@ > **ethGetTransactionByBlockHashAndIndexJsonRpcProcedure**(`client`): [`EthGetTransactionByBlockHashAndIndexJsonRpcProcedure`](../type-aliases/EthGetTransactionByBlockHashAndIndexJsonRpcProcedure.md) -Request handler for eth_getTransactionByBlockHashAndIndex JSON-RPC requests. - ## Parameters • **client**: `TevmNode`\<`"fork"` \| `"normal"`, `object`\> @@ -20,4 +18,4 @@ Request handler for eth_getTransactionByBlockHashAndIndex JSON-RPC requests. ## Defined in -[procedures/src/eth/ethGetTransactionByBlockHashAndIndexProcedure.js:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/ethGetTransactionByBlockHashAndIndexProcedure.js#L9) +[packages/procedures/src/eth/ethGetTransactionByBlockHashAndIndexProcedure.js:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/ethGetTransactionByBlockHashAndIndexProcedure.js#L9) diff --git a/packages/procedures/docs/functions/ethGetTransactionByBlockNumberAndIndexJsonRpcProcedure.md b/packages/procedures/docs/functions/ethGetTransactionByBlockNumberAndIndexJsonRpcProcedure.md index 248103cf59..c59100ba38 100644 --- a/packages/procedures/docs/functions/ethGetTransactionByBlockNumberAndIndexJsonRpcProcedure.md +++ b/packages/procedures/docs/functions/ethGetTransactionByBlockNumberAndIndexJsonRpcProcedure.md @@ -8,8 +8,6 @@ > **ethGetTransactionByBlockNumberAndIndexJsonRpcProcedure**(`client`): [`EthGetTransactionByBlockNumberAndIndexJsonRpcProcedure`](../type-aliases/EthGetTransactionByBlockNumberAndIndexJsonRpcProcedure.md) -Request handler for eth_getTransactionByBlockNumberAndIndex JSON-RPC requests. - ## Parameters • **client**: `TevmNode`\<`"fork"` \| `"normal"`, `object`\> @@ -20,4 +18,4 @@ Request handler for eth_getTransactionByBlockNumberAndIndex JSON-RPC requests. ## Defined in -[procedures/src/eth/ethGetTransactionByBlockNumberAndIndexProcedure.js:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/ethGetTransactionByBlockNumberAndIndexProcedure.js#L9) +[packages/procedures/src/eth/ethGetTransactionByBlockNumberAndIndexProcedure.js:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/ethGetTransactionByBlockNumberAndIndexProcedure.js#L9) diff --git a/packages/procedures/docs/functions/ethGetTransactionByHashJsonRpcProcedure.md b/packages/procedures/docs/functions/ethGetTransactionByHashJsonRpcProcedure.md index 7c67754960..ccba807108 100644 --- a/packages/procedures/docs/functions/ethGetTransactionByHashJsonRpcProcedure.md +++ b/packages/procedures/docs/functions/ethGetTransactionByHashJsonRpcProcedure.md @@ -8,8 +8,6 @@ > **ethGetTransactionByHashJsonRpcProcedure**(`client`): [`EthGetTransactionByHashJsonRpcProcedure`](../type-aliases/EthGetTransactionByHashJsonRpcProcedure.md) -Request handler for eth_getTransactionByHash JSON-RPC requests. - ## Parameters • **client**: `TevmNode`\<`"fork"` \| `"normal"`, `object`\> @@ -20,4 +18,4 @@ Request handler for eth_getTransactionByHash JSON-RPC requests. ## Defined in -[procedures/src/eth/ethGetTransactionByHashProcedure.js:10](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/ethGetTransactionByHashProcedure.js#L10) +[packages/procedures/src/eth/ethGetTransactionByHashProcedure.js:10](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/ethGetTransactionByHashProcedure.js#L10) diff --git a/packages/procedures/docs/functions/ethGetTransactionCountProcedure.md b/packages/procedures/docs/functions/ethGetTransactionCountProcedure.md index 15c453dd64..02851f7c26 100644 --- a/packages/procedures/docs/functions/ethGetTransactionCountProcedure.md +++ b/packages/procedures/docs/functions/ethGetTransactionCountProcedure.md @@ -6,13 +6,11 @@ # Function: ethGetTransactionCountProcedure() -> **ethGetTransactionCountProcedure**(`client`): [`EthGetTransactionCountJsonRpcProcedure`](../type-aliases/EthGetTransactionCountJsonRpcProcedure.md) - -Request handler for eth_getFilterLogs JSON-RPC requests. +> **ethGetTransactionCountProcedure**(`node`): [`EthGetTransactionCountJsonRpcProcedure`](../type-aliases/EthGetTransactionCountJsonRpcProcedure.md) ## Parameters -• **client**: `TevmNode`\<`"fork"` \| `"normal"`, `object`\> +• **node**: `TevmNode`\<`"fork"` \| `"normal"`, `object`\> ## Returns @@ -20,4 +18,4 @@ Request handler for eth_getFilterLogs JSON-RPC requests. ## Defined in -[procedures/src/eth/ethGetTransactionCountProcedure.js:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/ethGetTransactionCountProcedure.js#L9) +[packages/procedures/src/eth/ethGetTransactionCountProcedure.js:10](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/ethGetTransactionCountProcedure.js#L10) diff --git a/packages/procedures/docs/functions/ethGetTransactionReceiptJsonRpcProcedure.md b/packages/procedures/docs/functions/ethGetTransactionReceiptJsonRpcProcedure.md index 7d5e73710f..9c53b37208 100644 --- a/packages/procedures/docs/functions/ethGetTransactionReceiptJsonRpcProcedure.md +++ b/packages/procedures/docs/functions/ethGetTransactionReceiptJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -[procedures/src/eth/ethGetTransactionReceiptProcedure.js:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/ethGetTransactionReceiptProcedure.js#L8) +[packages/procedures/src/eth/ethGetTransactionReceiptProcedure.js:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/ethGetTransactionReceiptProcedure.js#L8) diff --git a/packages/procedures/docs/functions/ethNewBlockFilterProcedure.md b/packages/procedures/docs/functions/ethNewBlockFilterProcedure.md index fe4e837e36..c92e3c3528 100644 --- a/packages/procedures/docs/functions/ethNewBlockFilterProcedure.md +++ b/packages/procedures/docs/functions/ethNewBlockFilterProcedure.md @@ -8,8 +8,6 @@ > **ethNewBlockFilterProcedure**(`client`): [`EthNewBlockFilterJsonRpcProcedure`](../type-aliases/EthNewBlockFilterJsonRpcProcedure.md) -Request handler for eth_newBlock JSON-RPC requests. - ## Parameters • **client**: `TevmNode`\<`"fork"` \| `"normal"`, `object`\> @@ -20,4 +18,4 @@ Request handler for eth_newBlock JSON-RPC requests. ## Defined in -[procedures/src/eth/ethNewBlockFilterProcedure.js:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/ethNewBlockFilterProcedure.js#L8) +[packages/procedures/src/eth/ethNewBlockFilterProcedure.js:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/ethNewBlockFilterProcedure.js#L8) diff --git a/packages/procedures/docs/functions/ethNewFilterJsonRpcProcedure.md b/packages/procedures/docs/functions/ethNewFilterJsonRpcProcedure.md index 006e0d233c..2961317090 100644 --- a/packages/procedures/docs/functions/ethNewFilterJsonRpcProcedure.md +++ b/packages/procedures/docs/functions/ethNewFilterJsonRpcProcedure.md @@ -6,13 +6,11 @@ # Function: ethNewFilterJsonRpcProcedure() -> **ethNewFilterJsonRpcProcedure**(`client`): [`EthNewFilterJsonRpcProcedure`](../type-aliases/EthNewFilterJsonRpcProcedure.md) - -Request handler for eth_newFilter JSON-RPC requests. +> **ethNewFilterJsonRpcProcedure**(`tevmNode`): [`EthNewFilterJsonRpcProcedure`](../type-aliases/EthNewFilterJsonRpcProcedure.md) ## Parameters -• **client**: `TevmNode`\<`"fork"` \| `"normal"`, `object`\> +• **tevmNode**: `TevmNode`\<`"fork"` \| `"normal"`, `object`\> ## Returns @@ -20,4 +18,4 @@ Request handler for eth_newFilter JSON-RPC requests. ## Defined in -[procedures/src/eth/ethNewFilterProcedure.js:11](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/ethNewFilterProcedure.js#L11) +[packages/procedures/src/eth/ethNewFilterProcedure.js:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/ethNewFilterProcedure.js#L8) diff --git a/packages/procedures/docs/functions/ethNewPendingTransactionFilterProcedure.md b/packages/procedures/docs/functions/ethNewPendingTransactionFilterProcedure.md index 24be9a14a3..1e846641d7 100644 --- a/packages/procedures/docs/functions/ethNewPendingTransactionFilterProcedure.md +++ b/packages/procedures/docs/functions/ethNewPendingTransactionFilterProcedure.md @@ -8,8 +8,6 @@ > **ethNewPendingTransactionFilterProcedure**(`client`): [`EthNewPendingTransactionFilterJsonRpcProcedure`](../type-aliases/EthNewPendingTransactionFilterJsonRpcProcedure.md) -Request handler for eth_newPendingTransactionFilter JSON-RPC requests. - ## Parameters • **client**: `TevmNode`\<`"fork"` \| `"normal"`, `object`\> @@ -20,4 +18,4 @@ Request handler for eth_newPendingTransactionFilter JSON-RPC requests. ## Defined in -[procedures/src/eth/ethNewPendingTransactionFilterProcedure.js:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/ethNewPendingTransactionFilterProcedure.js#L8) +[packages/procedures/src/eth/ethNewPendingTransactionFilterProcedure.js:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/ethNewPendingTransactionFilterProcedure.js#L8) diff --git a/packages/procedures/docs/functions/ethProtocolVersionJsonRpcProcedure.md b/packages/procedures/docs/functions/ethProtocolVersionJsonRpcProcedure.md index 63c28dd23e..9f222d1990 100644 --- a/packages/procedures/docs/functions/ethProtocolVersionJsonRpcProcedure.md +++ b/packages/procedures/docs/functions/ethProtocolVersionJsonRpcProcedure.md @@ -8,12 +8,10 @@ > **ethProtocolVersionJsonRpcProcedure**(): [`EthProtocolVersionJsonRpcProcedure`](../type-aliases/EthProtocolVersionJsonRpcProcedure.md) -Request handler for eth_protocolVersion JSON-RPC requests. - ## Returns [`EthProtocolVersionJsonRpcProcedure`](../type-aliases/EthProtocolVersionJsonRpcProcedure.md) ## Defined in -[procedures/src/eth/ethProtocolVersionProcedure.js:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/ethProtocolVersionProcedure.js#L8) +[packages/procedures/src/eth/ethProtocolVersionProcedure.js:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/ethProtocolVersionProcedure.js#L8) diff --git a/packages/procedures/docs/functions/ethSendRawTransactionJsonRpcProcedure.md b/packages/procedures/docs/functions/ethSendRawTransactionJsonRpcProcedure.md index 4599035c8f..3cdf93f0f7 100644 --- a/packages/procedures/docs/functions/ethSendRawTransactionJsonRpcProcedure.md +++ b/packages/procedures/docs/functions/ethSendRawTransactionJsonRpcProcedure.md @@ -8,8 +8,6 @@ > **ethSendRawTransactionJsonRpcProcedure**(`client`): [`EthSendRawTransactionJsonRpcProcedure`](../type-aliases/EthSendRawTransactionJsonRpcProcedure.md) -Request handler for eth_sendRawTransaction JSON-RPC requests. - ## Parameters • **client**: `TevmNode`\<`"fork"` \| `"normal"`, `object`\> @@ -20,4 +18,4 @@ Request handler for eth_sendRawTransaction JSON-RPC requests. ## Defined in -[procedures/src/eth/ethSendRawTransactionProcedure.js:10](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/ethSendRawTransactionProcedure.js#L10) +[packages/procedures/src/eth/ethSendRawTransactionProcedure.js:10](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/ethSendRawTransactionProcedure.js#L10) diff --git a/packages/procedures/docs/functions/ethSendTransactionJsonRpcProcedure.md b/packages/procedures/docs/functions/ethSendTransactionJsonRpcProcedure.md index 3427221c4f..0833eefbeb 100644 --- a/packages/procedures/docs/functions/ethSendTransactionJsonRpcProcedure.md +++ b/packages/procedures/docs/functions/ethSendTransactionJsonRpcProcedure.md @@ -8,8 +8,6 @@ > **ethSendTransactionJsonRpcProcedure**(`client`): [`EthSendTransactionJsonRpcProcedure`](../type-aliases/EthSendTransactionJsonRpcProcedure.md) -Request handler for eth_sendTransaction JSON-RPC requests. - ## Parameters • **client**: `TevmNode`\<`"fork"` \| `"normal"`, `object`\> @@ -20,4 +18,4 @@ Request handler for eth_sendTransaction JSON-RPC requests. ## Defined in -[procedures/src/eth/ethSendTransactionProcedure.js:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/ethSendTransactionProcedure.js#L9) +[packages/procedures/src/eth/ethSendTransactionProcedure.js:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/ethSendTransactionProcedure.js#L9) diff --git a/packages/procedures/docs/functions/ethSignProcedure.md b/packages/procedures/docs/functions/ethSignProcedure.md index 1aef050d73..ddf5bf2e83 100644 --- a/packages/procedures/docs/functions/ethSignProcedure.md +++ b/packages/procedures/docs/functions/ethSignProcedure.md @@ -10,7 +10,7 @@ ## Parameters -• **accounts**: readonly `HDAccount`[] +• **accounts**: readonly `object`[] ## Returns @@ -18,4 +18,4 @@ ## Defined in -[procedures/src/eth/ethSignProcedure.js:7](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/ethSignProcedure.js#L7) +[packages/procedures/src/eth/ethSignProcedure.js:7](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/ethSignProcedure.js#L7) diff --git a/packages/procedures/docs/functions/ethSignTransactionProcedure.md b/packages/procedures/docs/functions/ethSignTransactionProcedure.md index 54aa74262d..33b9f4474e 100644 --- a/packages/procedures/docs/functions/ethSignTransactionProcedure.md +++ b/packages/procedures/docs/functions/ethSignTransactionProcedure.md @@ -12,7 +12,7 @@ • **options** -• **options.accounts**: readonly `HDAccount`[] +• **options.accounts**: readonly `object`[] • **options.getChainId** @@ -22,4 +22,4 @@ ## Defined in -[procedures/src/eth/ethSignTransactionProcedure.js:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/ethSignTransactionProcedure.js#L8) +[packages/procedures/src/eth/ethSignTransactionProcedure.js:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/ethSignTransactionProcedure.js#L8) diff --git a/packages/procedures/docs/functions/ethUninstallFilterJsonRpcProcedure.md b/packages/procedures/docs/functions/ethUninstallFilterJsonRpcProcedure.md index 94273c75be..9e527bc1d5 100644 --- a/packages/procedures/docs/functions/ethUninstallFilterJsonRpcProcedure.md +++ b/packages/procedures/docs/functions/ethUninstallFilterJsonRpcProcedure.md @@ -8,8 +8,6 @@ > **ethUninstallFilterJsonRpcProcedure**(`client`): [`EthUninstallFilterJsonRpcProcedure`](../type-aliases/EthUninstallFilterJsonRpcProcedure.md) -Request handler for eth_uninstallFilter JSON-RPC requests. - ## Parameters • **client**: `TevmNode`\<`"fork"` \| `"normal"`, `object`\> @@ -20,4 +18,4 @@ Request handler for eth_uninstallFilter JSON-RPC requests. ## Defined in -[procedures/src/eth/ethUninstallFilterProcedure.js:6](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/ethUninstallFilterProcedure.js#L6) +[packages/procedures/src/eth/ethUninstallFilterProcedure.js:6](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/ethUninstallFilterProcedure.js#L6) diff --git a/packages/procedures/docs/functions/gasPriceProcedure.md b/packages/procedures/docs/functions/gasPriceProcedure.md index a47143e9b8..72a9027a27 100644 --- a/packages/procedures/docs/functions/gasPriceProcedure.md +++ b/packages/procedures/docs/functions/gasPriceProcedure.md @@ -18,4 +18,4 @@ ## Defined in -[procedures/src/eth/gasPriceProcedure.js:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/gasPriceProcedure.js#L9) +[packages/procedures/src/eth/gasPriceProcedure.js:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/gasPriceProcedure.js#L9) diff --git a/packages/procedures/docs/functions/generateRandomId.md b/packages/procedures/docs/functions/generateRandomId.md index 7e1e0357ec..50f6585a73 100644 --- a/packages/procedures/docs/functions/generateRandomId.md +++ b/packages/procedures/docs/functions/generateRandomId.md @@ -14,4 +14,4 @@ ## Defined in -[procedures/src/utils/generateRandomId.js:4](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/utils/generateRandomId.js#L4) +[packages/procedures/src/utils/generateRandomId.js:4](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/utils/generateRandomId.js#L4) diff --git a/packages/procedures/docs/functions/getAccountProcedure.md b/packages/procedures/docs/functions/getAccountProcedure.md index e8c1de2860..924652ca4e 100644 --- a/packages/procedures/docs/functions/getAccountProcedure.md +++ b/packages/procedures/docs/functions/getAccountProcedure.md @@ -8,8 +8,6 @@ > **getAccountProcedure**(`client`): [`GetAccountJsonRpcProcedure`](../type-aliases/GetAccountJsonRpcProcedure.md) -Creates an GetAccount JSON-RPC Procedure for handling account requests with Ethereumjs VM - ## Parameters • **client**: `TevmNode`\<`"fork"` \| `"normal"`, `object`\> @@ -20,4 +18,4 @@ Creates an GetAccount JSON-RPC Procedure for handling account requests with Ethe ## Defined in -[procedures/src/getaccount/getAccountProcedure.js:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/getaccount/getAccountProcedure.js#L9) +[packages/procedures/src/getaccount/getAccountProcedure.js:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/getaccount/getAccountProcedure.js#L9) diff --git a/packages/procedures/docs/functions/getBalanceProcedure.md b/packages/procedures/docs/functions/getBalanceProcedure.md index 76e110cfff..b1d7a961a8 100644 --- a/packages/procedures/docs/functions/getBalanceProcedure.md +++ b/packages/procedures/docs/functions/getBalanceProcedure.md @@ -18,4 +18,4 @@ ## Defined in -[procedures/src/eth/getBalanceProcedure.js:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/getBalanceProcedure.js#L8) +[packages/procedures/src/eth/getBalanceProcedure.js:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/getBalanceProcedure.js#L8) diff --git a/packages/procedures/docs/functions/getCodeProcedure.md b/packages/procedures/docs/functions/getCodeProcedure.md index 7df3487869..61db87987b 100644 --- a/packages/procedures/docs/functions/getCodeProcedure.md +++ b/packages/procedures/docs/functions/getCodeProcedure.md @@ -18,4 +18,4 @@ ## Defined in -[procedures/src/eth/getCodeProcedure.js:7](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/getCodeProcedure.js#L7) +[packages/procedures/src/eth/getCodeProcedure.js:7](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/getCodeProcedure.js#L7) diff --git a/packages/procedures/docs/functions/getStorageAtProcedure.md b/packages/procedures/docs/functions/getStorageAtProcedure.md index 3d6f385882..9b1b924841 100644 --- a/packages/procedures/docs/functions/getStorageAtProcedure.md +++ b/packages/procedures/docs/functions/getStorageAtProcedure.md @@ -18,4 +18,4 @@ ## Defined in -[procedures/src/eth/getStorageAtProcedure.js:7](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/getStorageAtProcedure.js#L7) +[packages/procedures/src/eth/getStorageAtProcedure.js:7](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/getStorageAtProcedure.js#L7) diff --git a/packages/procedures/docs/functions/loadStateProcedure.md b/packages/procedures/docs/functions/loadStateProcedure.md index 8080df0822..a68874db88 100644 --- a/packages/procedures/docs/functions/loadStateProcedure.md +++ b/packages/procedures/docs/functions/loadStateProcedure.md @@ -8,8 +8,6 @@ > **loadStateProcedure**(`client`): [`LoadStateJsonRpcProcedure`](../type-aliases/LoadStateJsonRpcProcedure.md) -Creates a LoadState JSON-RPC Procedure for handling LoadState requests with Ethereumjs EVM - ## Parameters • **client**: `TevmNode`\<`"fork"` \| `"normal"`, `object`\> @@ -20,4 +18,4 @@ Creates a LoadState JSON-RPC Procedure for handling LoadState requests with Ethe ## Defined in -[procedures/src/loadstate/loadStateProcedure.js:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/loadstate/loadStateProcedure.js#L9) +[packages/procedures/src/loadstate/loadStateProcedure.js:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/loadstate/loadStateProcedure.js#L9) diff --git a/packages/procedures/docs/functions/mineProcedure.md b/packages/procedures/docs/functions/mineProcedure.md index 5f17acf718..a94b4ebc01 100644 --- a/packages/procedures/docs/functions/mineProcedure.md +++ b/packages/procedures/docs/functions/mineProcedure.md @@ -8,8 +8,6 @@ > **mineProcedure**(`client`): [`MineJsonRpcProcedure`](../type-aliases/MineJsonRpcProcedure.md) -Creates an Mine JSON-RPC Procedure for handling tevm_mine requests with Ethereumjs VM - ## Parameters • **client**: `TevmNode`\<`"fork"` \| `"normal"`, `object`\> @@ -20,4 +18,4 @@ Creates an Mine JSON-RPC Procedure for handling tevm_mine requests with Ethereum ## Defined in -[procedures/src/mine/mineProcedure.js:10](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/mine/mineProcedure.js#L10) +[packages/procedures/src/mine/mineProcedure.js:10](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/mine/mineProcedure.js#L10) diff --git a/packages/procedures/docs/functions/parseBlockTag.md b/packages/procedures/docs/functions/parseBlockTag.md index afb6c08ba6..844e597c85 100644 --- a/packages/procedures/docs/functions/parseBlockTag.md +++ b/packages/procedures/docs/functions/parseBlockTag.md @@ -18,4 +18,4 @@ ## Defined in -[procedures/src/utils/parseBlockTag.js:7](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/utils/parseBlockTag.js#L7) +[packages/procedures/src/utils/parseBlockTag.js:7](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/utils/parseBlockTag.js#L7) diff --git a/packages/procedures/docs/functions/requestBulkProcedure.md b/packages/procedures/docs/functions/requestBulkProcedure.md index e0776327cc..fde90a7f1b 100644 --- a/packages/procedures/docs/functions/requestBulkProcedure.md +++ b/packages/procedures/docs/functions/requestBulkProcedure.md @@ -18,4 +18,4 @@ ## Defined in -[procedures/src/requestBulkProcedure.js:7](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/requestBulkProcedure.js#L7) +[packages/procedures/src/requestBulkProcedure.js:7](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/requestBulkProcedure.js#L7) diff --git a/packages/procedures/docs/functions/requestProcedure.md b/packages/procedures/docs/functions/requestProcedure.md index 8fd77e1e1b..a399c33c9d 100644 --- a/packages/procedures/docs/functions/requestProcedure.md +++ b/packages/procedures/docs/functions/requestProcedure.md @@ -8,15 +8,6 @@ > **requestProcedure**(`client`): [`TevmJsonRpcRequestHandler`](../type-aliases/TevmJsonRpcRequestHandler.md) -Request handler for JSON-RPC requests. - -This implementation of the Tevm requestProcedure spec -implements it via the ethereumjs VM. - -Most users will want to use `Tevm.request` instead of -this method but this method may be desired if hyper optimizing -bundle size. - ## Parameters • **client**: `TevmNode`\<`"fork"` \| `"normal"`, `object`\> @@ -25,23 +16,6 @@ bundle size. [`TevmJsonRpcRequestHandler`](../type-aliases/TevmJsonRpcRequestHandler.md) -## Example - -```typescript -const blockNumberResponse = await tevm.request({ - method: 'eth_blockNumber', - params: [] - id: 1 - jsonrpc: '2.0' -}) -const accountResponse = await tevm.request({ - method: 'tevm_getAccount', - params: [{address: '0x123...'}] - id: 1 - jsonrpc: '2.0' -}) -``` - ## Defined in -[procedures/src/requestProcedure.js:32](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/requestProcedure.js#L32) +[packages/procedures/src/requestProcedure.js:32](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/requestProcedure.js#L32) diff --git a/packages/procedures/docs/functions/scriptProcedure.md b/packages/procedures/docs/functions/scriptProcedure.md index d32ec0cc96..20abff56bb 100644 --- a/packages/procedures/docs/functions/scriptProcedure.md +++ b/packages/procedures/docs/functions/scriptProcedure.md @@ -16,11 +16,6 @@ [`ScriptJsonRpcProcedure`](../type-aliases/ScriptJsonRpcProcedure.md) -## Deprecated - -Use CallJsonRpcProcedure instead -Creates a Script JSON-RPC Procedure for handling script requests with Ethereumjs VM - ## Defined in -[procedures/src/script/scriptProcedure.js:11](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/script/scriptProcedure.js#L11) +[packages/procedures/src/script/scriptProcedure.js:11](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/script/scriptProcedure.js#L11) diff --git a/packages/procedures/docs/functions/setAccountProcedure.md b/packages/procedures/docs/functions/setAccountProcedure.md index 57a2f0c43b..47a66f35de 100644 --- a/packages/procedures/docs/functions/setAccountProcedure.md +++ b/packages/procedures/docs/functions/setAccountProcedure.md @@ -8,8 +8,6 @@ > **setAccountProcedure**(`client`): [`SetAccountJsonRpcProcedure`](../type-aliases/SetAccountJsonRpcProcedure.md) -Creates an SetAccount JSON-RPC Procedure for handling tevm_setAccount requests with Ethereumjs VM - ## Parameters • **client**: `TevmNode`\<`"fork"` \| `"normal"`, `object`\> @@ -20,4 +18,4 @@ Creates an SetAccount JSON-RPC Procedure for handling tevm_setAccount requests w ## Defined in -[procedures/src/setaccount/setAccountProcedure.js:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/setaccount/setAccountProcedure.js#L9) +[packages/procedures/src/setaccount/setAccountProcedure.js:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/setaccount/setAccountProcedure.js#L9) diff --git a/packages/procedures/docs/functions/txToJsonRpcTx.md b/packages/procedures/docs/functions/txToJsonRpcTx.md index f0fcf0e68e..0c78ffeb3f 100644 --- a/packages/procedures/docs/functions/txToJsonRpcTx.md +++ b/packages/procedures/docs/functions/txToJsonRpcTx.md @@ -22,4 +22,4 @@ ## Defined in -[procedures/src/utils/txToJsonRpcTx.js:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/utils/txToJsonRpcTx.js#L9) +[packages/procedures/src/utils/txToJsonRpcTx.js:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/utils/txToJsonRpcTx.js#L9) diff --git a/packages/procedures/docs/type-aliases/AnvilDropTransactionJsonRpcRequest.md b/packages/procedures/docs/type-aliases/AnvilDropTransactionJsonRpcRequest.md index 5a0b5e5efd..ace8d7ac41 100644 --- a/packages/procedures/docs/type-aliases/AnvilDropTransactionJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/AnvilDropTransactionJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `anvil_dropTransaction` method ## Defined in -[procedures/src/anvil/AnvilJsonRpcRequest.ts:56](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilJsonRpcRequest.ts#L56) +[packages/procedures/src/anvil/AnvilJsonRpcRequest.ts:56](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilJsonRpcRequest.ts#L56) diff --git a/packages/procedures/docs/type-aliases/AnvilDropTransactionJsonRpcResponse.md b/packages/procedures/docs/type-aliases/AnvilDropTransactionJsonRpcResponse.md index dbcc98820b..43c99d94e1 100644 --- a/packages/procedures/docs/type-aliases/AnvilDropTransactionJsonRpcResponse.md +++ b/packages/procedures/docs/type-aliases/AnvilDropTransactionJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `anvil_dropTransaction` procedure ## Defined in -[procedures/src/anvil/AnvilJsonRpcResponse.ts:77](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilJsonRpcResponse.ts#L77) +[packages/procedures/src/anvil/AnvilJsonRpcResponse.ts:77](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilJsonRpcResponse.ts#L77) diff --git a/packages/procedures/docs/type-aliases/AnvilDropTransactionProcedure.md b/packages/procedures/docs/type-aliases/AnvilDropTransactionProcedure.md index 87760b58d1..3cfb371c8e 100644 --- a/packages/procedures/docs/type-aliases/AnvilDropTransactionProcedure.md +++ b/packages/procedures/docs/type-aliases/AnvilDropTransactionProcedure.md @@ -20,4 +20,4 @@ JSON-RPC procedure for `anvil_dropTransaction` ## Defined in -[procedures/src/anvil/AnvilProcedure.ts:77](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilProcedure.ts#L77) +[packages/procedures/src/anvil/AnvilProcedure.ts:77](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilProcedure.ts#L77) diff --git a/packages/procedures/docs/type-aliases/AnvilDumpStateJsonRpcRequest.md b/packages/procedures/docs/type-aliases/AnvilDumpStateJsonRpcRequest.md index 55b83f43db..2a092a73fb 100644 --- a/packages/procedures/docs/type-aliases/AnvilDumpStateJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/AnvilDumpStateJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `anvil_dumpState` method ## Defined in -[procedures/src/anvil/AnvilJsonRpcRequest.ts:93](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilJsonRpcRequest.ts#L93) +[packages/procedures/src/anvil/AnvilJsonRpcRequest.ts:93](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilJsonRpcRequest.ts#L93) diff --git a/packages/procedures/docs/type-aliases/AnvilDumpStateJsonRpcResponse.md b/packages/procedures/docs/type-aliases/AnvilDumpStateJsonRpcResponse.md index bcae41d347..0f3910d0e9 100644 --- a/packages/procedures/docs/type-aliases/AnvilDumpStateJsonRpcResponse.md +++ b/packages/procedures/docs/type-aliases/AnvilDumpStateJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `anvil_dumpState` procedure ## Defined in -[procedures/src/anvil/AnvilJsonRpcResponse.ts:132](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilJsonRpcResponse.ts#L132) +[packages/procedures/src/anvil/AnvilJsonRpcResponse.ts:132](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilJsonRpcResponse.ts#L132) diff --git a/packages/procedures/docs/type-aliases/AnvilDumpStateProcedure.md b/packages/procedures/docs/type-aliases/AnvilDumpStateProcedure.md index e00eba073a..a620f77130 100644 --- a/packages/procedures/docs/type-aliases/AnvilDumpStateProcedure.md +++ b/packages/procedures/docs/type-aliases/AnvilDumpStateProcedure.md @@ -20,4 +20,4 @@ JSON-RPC procedure for `anvil_dumpState` ## Defined in -[procedures/src/anvil/AnvilProcedure.ts:116](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilProcedure.ts#L116) +[packages/procedures/src/anvil/AnvilProcedure.ts:116](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilProcedure.ts#L116) diff --git a/packages/procedures/docs/type-aliases/AnvilGetAutomineJsonRpcRequest.md b/packages/procedures/docs/type-aliases/AnvilGetAutomineJsonRpcRequest.md index 53aa31df5f..d09f44e637 100644 --- a/packages/procedures/docs/type-aliases/AnvilGetAutomineJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/AnvilGetAutomineJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `anvil_getAutomine` method ## Defined in -[procedures/src/anvil/AnvilJsonRpcRequest.ts:32](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilJsonRpcRequest.ts#L32) +[packages/procedures/src/anvil/AnvilJsonRpcRequest.ts:32](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilJsonRpcRequest.ts#L32) diff --git a/packages/procedures/docs/type-aliases/AnvilGetAutomineJsonRpcResponse.md b/packages/procedures/docs/type-aliases/AnvilGetAutomineJsonRpcResponse.md index 6eb7dbf434..dc5ab0e645 100644 --- a/packages/procedures/docs/type-aliases/AnvilGetAutomineJsonRpcResponse.md +++ b/packages/procedures/docs/type-aliases/AnvilGetAutomineJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `anvil_getAutomine` procedure ## Defined in -[procedures/src/anvil/AnvilJsonRpcResponse.ts:58](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilJsonRpcResponse.ts#L58) +[packages/procedures/src/anvil/AnvilJsonRpcResponse.ts:58](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilJsonRpcResponse.ts#L58) diff --git a/packages/procedures/docs/type-aliases/AnvilGetAutomineProcedure.md b/packages/procedures/docs/type-aliases/AnvilGetAutomineProcedure.md index 14f24664d8..3e2c1f94b0 100644 --- a/packages/procedures/docs/type-aliases/AnvilGetAutomineProcedure.md +++ b/packages/procedures/docs/type-aliases/AnvilGetAutomineProcedure.md @@ -20,4 +20,4 @@ JSON-RPC procedure for `anvil_getAutomine` ## Defined in -[procedures/src/anvil/AnvilProcedure.ts:60](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilProcedure.ts#L60) +[packages/procedures/src/anvil/AnvilProcedure.ts:60](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilProcedure.ts#L60) diff --git a/packages/procedures/docs/type-aliases/AnvilImpersonateAccountJsonRpcRequest.md b/packages/procedures/docs/type-aliases/AnvilImpersonateAccountJsonRpcRequest.md index 2eca0b0b88..d3524b655e 100644 --- a/packages/procedures/docs/type-aliases/AnvilImpersonateAccountJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/AnvilImpersonateAccountJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `anvil_impersonateAccount` method ## Defined in -[procedures/src/anvil/AnvilJsonRpcRequest.ts:16](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilJsonRpcRequest.ts#L16) +[packages/procedures/src/anvil/AnvilJsonRpcRequest.ts:16](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilJsonRpcRequest.ts#L16) diff --git a/packages/procedures/docs/type-aliases/AnvilImpersonateAccountJsonRpcResponse.md b/packages/procedures/docs/type-aliases/AnvilImpersonateAccountJsonRpcResponse.md index e28ba9a1b7..3774e94588 100644 --- a/packages/procedures/docs/type-aliases/AnvilImpersonateAccountJsonRpcResponse.md +++ b/packages/procedures/docs/type-aliases/AnvilImpersonateAccountJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `anvil_impersonateAccount` procedure ## Defined in -[procedures/src/anvil/AnvilJsonRpcResponse.ts:29](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilJsonRpcResponse.ts#L29) +[packages/procedures/src/anvil/AnvilJsonRpcResponse.ts:29](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilJsonRpcResponse.ts#L29) diff --git a/packages/procedures/docs/type-aliases/AnvilImpersonateAccountProcedure.md b/packages/procedures/docs/type-aliases/AnvilImpersonateAccountProcedure.md index a9bfde55f5..067af7032f 100644 --- a/packages/procedures/docs/type-aliases/AnvilImpersonateAccountProcedure.md +++ b/packages/procedures/docs/type-aliases/AnvilImpersonateAccountProcedure.md @@ -20,4 +20,4 @@ JSON-RPC procedure for `anvil_impersonateAccount` ## Defined in -[procedures/src/anvil/AnvilProcedure.ts:41](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilProcedure.ts#L41) +[packages/procedures/src/anvil/AnvilProcedure.ts:41](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilProcedure.ts#L41) diff --git a/packages/procedures/docs/type-aliases/AnvilJsonRpcRequest.md b/packages/procedures/docs/type-aliases/AnvilJsonRpcRequest.md index f79fb95d39..e7af679841 100644 --- a/packages/procedures/docs/type-aliases/AnvilJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/AnvilJsonRpcRequest.md @@ -10,4 +10,4 @@ ## Defined in -[procedures/src/anvil/AnvilJsonRpcRequest.ts:101](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilJsonRpcRequest.ts#L101) +[packages/procedures/src/anvil/AnvilJsonRpcRequest.ts:101](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilJsonRpcRequest.ts#L101) diff --git a/packages/procedures/docs/type-aliases/AnvilLoadStateJsonRpcRequest.md b/packages/procedures/docs/type-aliases/AnvilLoadStateJsonRpcRequest.md index e6108b0d11..c787295fcd 100644 --- a/packages/procedures/docs/type-aliases/AnvilLoadStateJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/AnvilLoadStateJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `anvil_loadState` method ## Defined in -[procedures/src/anvil/AnvilJsonRpcRequest.ts:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilJsonRpcRequest.ts#L99) +[packages/procedures/src/anvil/AnvilJsonRpcRequest.ts:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilJsonRpcRequest.ts#L99) diff --git a/packages/procedures/docs/type-aliases/AnvilLoadStateJsonRpcResponse.md b/packages/procedures/docs/type-aliases/AnvilLoadStateJsonRpcResponse.md index 89cc9ea5b4..1f1b63a330 100644 --- a/packages/procedures/docs/type-aliases/AnvilLoadStateJsonRpcResponse.md +++ b/packages/procedures/docs/type-aliases/AnvilLoadStateJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `anvil_loadState` procedure ## Defined in -[procedures/src/anvil/AnvilJsonRpcResponse.ts:142](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilJsonRpcResponse.ts#L142) +[packages/procedures/src/anvil/AnvilJsonRpcResponse.ts:142](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilJsonRpcResponse.ts#L142) diff --git a/packages/procedures/docs/type-aliases/AnvilLoadStateProcedure.md b/packages/procedures/docs/type-aliases/AnvilLoadStateProcedure.md index b276d96353..150b9d9ff9 100644 --- a/packages/procedures/docs/type-aliases/AnvilLoadStateProcedure.md +++ b/packages/procedures/docs/type-aliases/AnvilLoadStateProcedure.md @@ -20,4 +20,4 @@ JSON-RPC procedure for `anvil_loadState` ## Defined in -[procedures/src/anvil/AnvilProcedure.ts:122](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilProcedure.ts#L122) +[packages/procedures/src/anvil/AnvilProcedure.ts:122](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilProcedure.ts#L122) diff --git a/packages/procedures/docs/type-aliases/AnvilMineJsonRpcRequest.md b/packages/procedures/docs/type-aliases/AnvilMineJsonRpcRequest.md index 8379a4920a..5680ee4f51 100644 --- a/packages/procedures/docs/type-aliases/AnvilMineJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/AnvilMineJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `anvil_mine` method ## Defined in -[procedures/src/anvil/AnvilJsonRpcRequest.ts:46](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilJsonRpcRequest.ts#L46) +[packages/procedures/src/anvil/AnvilJsonRpcRequest.ts:46](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilJsonRpcRequest.ts#L46) diff --git a/packages/procedures/docs/type-aliases/AnvilMineJsonRpcResponse.md b/packages/procedures/docs/type-aliases/AnvilMineJsonRpcResponse.md index 4f04f0449b..25d17983a3 100644 --- a/packages/procedures/docs/type-aliases/AnvilMineJsonRpcResponse.md +++ b/packages/procedures/docs/type-aliases/AnvilMineJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `anvil_mine` procedure ## Defined in -[procedures/src/anvil/AnvilJsonRpcResponse.ts:67](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilJsonRpcResponse.ts#L67) +[packages/procedures/src/anvil/AnvilJsonRpcResponse.ts:67](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilJsonRpcResponse.ts#L67) diff --git a/packages/procedures/docs/type-aliases/AnvilMineProcedure.md b/packages/procedures/docs/type-aliases/AnvilMineProcedure.md index d0464fb6cc..20596f61f9 100644 --- a/packages/procedures/docs/type-aliases/AnvilMineProcedure.md +++ b/packages/procedures/docs/type-aliases/AnvilMineProcedure.md @@ -20,4 +20,4 @@ JSON-RPC procedure for `anvil_mine` ## Defined in -[procedures/src/anvil/AnvilProcedure.ts:67](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilProcedure.ts#L67) +[packages/procedures/src/anvil/AnvilProcedure.ts:67](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilProcedure.ts#L67) diff --git a/packages/procedures/docs/type-aliases/AnvilRequestType.md b/packages/procedures/docs/type-aliases/AnvilRequestType.md index edb34b52ef..0925bc7a62 100644 --- a/packages/procedures/docs/type-aliases/AnvilRequestType.md +++ b/packages/procedures/docs/type-aliases/AnvilRequestType.md @@ -66,4 +66,4 @@ A mapping of `anvil_*` method names to their request type ## Defined in -[procedures/src/tevm-request-handler/AnvilRequestType.ts:19](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/tevm-request-handler/AnvilRequestType.ts#L19) +[packages/procedures/src/tevm-request-handler/AnvilRequestType.ts:19](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/tevm-request-handler/AnvilRequestType.ts#L19) diff --git a/packages/procedures/docs/type-aliases/AnvilResetJsonRpcRequest.md b/packages/procedures/docs/type-aliases/AnvilResetJsonRpcRequest.md index 65612c6268..1473f292dc 100644 --- a/packages/procedures/docs/type-aliases/AnvilResetJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/AnvilResetJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `anvil_reset` method ## Defined in -[procedures/src/anvil/AnvilJsonRpcRequest.ts:51](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilJsonRpcRequest.ts#L51) +[packages/procedures/src/anvil/AnvilJsonRpcRequest.ts:51](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilJsonRpcRequest.ts#L51) diff --git a/packages/procedures/docs/type-aliases/AnvilResetJsonRpcResponse.md b/packages/procedures/docs/type-aliases/AnvilResetJsonRpcResponse.md index 59565391c8..0b27808fe1 100644 --- a/packages/procedures/docs/type-aliases/AnvilResetJsonRpcResponse.md +++ b/packages/procedures/docs/type-aliases/AnvilResetJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `anvil_reset` procedure ## Defined in -[procedures/src/anvil/AnvilJsonRpcResponse.ts:72](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilJsonRpcResponse.ts#L72) +[packages/procedures/src/anvil/AnvilJsonRpcResponse.ts:72](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilJsonRpcResponse.ts#L72) diff --git a/packages/procedures/docs/type-aliases/AnvilResetProcedure.md b/packages/procedures/docs/type-aliases/AnvilResetProcedure.md index bd1cfd7835..346cbae3ad 100644 --- a/packages/procedures/docs/type-aliases/AnvilResetProcedure.md +++ b/packages/procedures/docs/type-aliases/AnvilResetProcedure.md @@ -20,4 +20,4 @@ JSON-RPC procedure for `anvil_reset` ## Defined in -[procedures/src/anvil/AnvilProcedure.ts:72](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilProcedure.ts#L72) +[packages/procedures/src/anvil/AnvilProcedure.ts:72](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilProcedure.ts#L72) diff --git a/packages/procedures/docs/type-aliases/AnvilReturnType.md b/packages/procedures/docs/type-aliases/AnvilReturnType.md index 59e879ed53..1e01ca7634 100644 --- a/packages/procedures/docs/type-aliases/AnvilReturnType.md +++ b/packages/procedures/docs/type-aliases/AnvilReturnType.md @@ -70,4 +70,4 @@ A mapping of `anvil_*` method names to their return type ## Defined in -[procedures/src/tevm-request-handler/AnvilReturnType.ts:21](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/tevm-request-handler/AnvilReturnType.ts#L21) +[packages/procedures/src/tevm-request-handler/AnvilReturnType.ts:21](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/tevm-request-handler/AnvilReturnType.ts#L21) diff --git a/packages/procedures/docs/type-aliases/AnvilSetBalanceJsonRpcRequest.md b/packages/procedures/docs/type-aliases/AnvilSetBalanceJsonRpcRequest.md index b169614d94..cf5c2d4de8 100644 --- a/packages/procedures/docs/type-aliases/AnvilSetBalanceJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/AnvilSetBalanceJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `anvil_setBalance` method ## Defined in -[procedures/src/anvil/AnvilJsonRpcRequest.ts:64](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilJsonRpcRequest.ts#L64) +[packages/procedures/src/anvil/AnvilJsonRpcRequest.ts:64](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilJsonRpcRequest.ts#L64) diff --git a/packages/procedures/docs/type-aliases/AnvilSetBalanceJsonRpcResponse.md b/packages/procedures/docs/type-aliases/AnvilSetBalanceJsonRpcResponse.md index 2d062cb1cc..067d82aa07 100644 --- a/packages/procedures/docs/type-aliases/AnvilSetBalanceJsonRpcResponse.md +++ b/packages/procedures/docs/type-aliases/AnvilSetBalanceJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `anvil_setBalance` procedure ## Defined in -[procedures/src/anvil/AnvilJsonRpcResponse.ts:86](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilJsonRpcResponse.ts#L86) +[packages/procedures/src/anvil/AnvilJsonRpcResponse.ts:86](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilJsonRpcResponse.ts#L86) diff --git a/packages/procedures/docs/type-aliases/AnvilSetBalanceProcedure.md b/packages/procedures/docs/type-aliases/AnvilSetBalanceProcedure.md index 30aa9e4272..67dce75a81 100644 --- a/packages/procedures/docs/type-aliases/AnvilSetBalanceProcedure.md +++ b/packages/procedures/docs/type-aliases/AnvilSetBalanceProcedure.md @@ -20,4 +20,4 @@ JSON-RPC procedure for `anvil_setBalance` ## Defined in -[procedures/src/anvil/AnvilProcedure.ts:84](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilProcedure.ts#L84) +[packages/procedures/src/anvil/AnvilProcedure.ts:84](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilProcedure.ts#L84) diff --git a/packages/procedures/docs/type-aliases/AnvilSetChainIdJsonRpcRequest.md b/packages/procedures/docs/type-aliases/AnvilSetChainIdJsonRpcRequest.md index 1b0a17cdf8..b50b365e35 100644 --- a/packages/procedures/docs/type-aliases/AnvilSetChainIdJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/AnvilSetChainIdJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `anvil_setChainId` method ## Defined in -[procedures/src/anvil/AnvilJsonRpcRequest.ts:87](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilJsonRpcRequest.ts#L87) +[packages/procedures/src/anvil/AnvilJsonRpcRequest.ts:87](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilJsonRpcRequest.ts#L87) diff --git a/packages/procedures/docs/type-aliases/AnvilSetChainIdJsonRpcResponse.md b/packages/procedures/docs/type-aliases/AnvilSetChainIdJsonRpcResponse.md index 1a0d2fe54d..76629022a2 100644 --- a/packages/procedures/docs/type-aliases/AnvilSetChainIdJsonRpcResponse.md +++ b/packages/procedures/docs/type-aliases/AnvilSetChainIdJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `anvil_setChainId` procedure ## Defined in -[procedures/src/anvil/AnvilJsonRpcResponse.ts:122](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilJsonRpcResponse.ts#L122) +[packages/procedures/src/anvil/AnvilJsonRpcResponse.ts:122](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilJsonRpcResponse.ts#L122) diff --git a/packages/procedures/docs/type-aliases/AnvilSetChainIdProcedure.md b/packages/procedures/docs/type-aliases/AnvilSetChainIdProcedure.md index f86230fbc2..1310be9631 100644 --- a/packages/procedures/docs/type-aliases/AnvilSetChainIdProcedure.md +++ b/packages/procedures/docs/type-aliases/AnvilSetChainIdProcedure.md @@ -20,4 +20,4 @@ JSON-RPC procedure for `anvil_setChainId` ## Defined in -[procedures/src/anvil/AnvilProcedure.ts:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilProcedure.ts#L108) +[packages/procedures/src/anvil/AnvilProcedure.ts:108](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilProcedure.ts#L108) diff --git a/packages/procedures/docs/type-aliases/AnvilSetCodeJsonRpcRequest.md b/packages/procedures/docs/type-aliases/AnvilSetCodeJsonRpcRequest.md index 2f5c1171f9..a584491b3f 100644 --- a/packages/procedures/docs/type-aliases/AnvilSetCodeJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/AnvilSetCodeJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `anvil_setCode` method ## Defined in -[procedures/src/anvil/AnvilJsonRpcRequest.ts:69](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilJsonRpcRequest.ts#L69) +[packages/procedures/src/anvil/AnvilJsonRpcRequest.ts:69](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilJsonRpcRequest.ts#L69) diff --git a/packages/procedures/docs/type-aliases/AnvilSetCodeJsonRpcResponse.md b/packages/procedures/docs/type-aliases/AnvilSetCodeJsonRpcResponse.md index 3adaa205cf..74cba370c1 100644 --- a/packages/procedures/docs/type-aliases/AnvilSetCodeJsonRpcResponse.md +++ b/packages/procedures/docs/type-aliases/AnvilSetCodeJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `anvil_setCode` procedure ## Defined in -[procedures/src/anvil/AnvilJsonRpcResponse.ts:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilJsonRpcResponse.ts#L95) +[packages/procedures/src/anvil/AnvilJsonRpcResponse.ts:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilJsonRpcResponse.ts#L95) diff --git a/packages/procedures/docs/type-aliases/AnvilSetCodeProcedure.md b/packages/procedures/docs/type-aliases/AnvilSetCodeProcedure.md index 6488383717..0640aeea3c 100644 --- a/packages/procedures/docs/type-aliases/AnvilSetCodeProcedure.md +++ b/packages/procedures/docs/type-aliases/AnvilSetCodeProcedure.md @@ -20,4 +20,4 @@ JSON-RPC procedure for `anvil_setCode` ## Defined in -[procedures/src/anvil/AnvilProcedure.ts:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilProcedure.ts#L91) +[packages/procedures/src/anvil/AnvilProcedure.ts:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilProcedure.ts#L91) diff --git a/packages/procedures/docs/type-aliases/AnvilSetCoinbaseJsonRpcRequest.md b/packages/procedures/docs/type-aliases/AnvilSetCoinbaseJsonRpcRequest.md index 16f82c8ed9..523b93a65a 100644 --- a/packages/procedures/docs/type-aliases/AnvilSetCoinbaseJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/AnvilSetCoinbaseJsonRpcRequest.md @@ -13,4 +13,4 @@ Not included atm because tevm_call supports it and i was getting methodNotFound ## Defined in -[procedures/src/anvil/AnvilJsonRpcRequest.ts:41](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilJsonRpcRequest.ts#L41) +[packages/procedures/src/anvil/AnvilJsonRpcRequest.ts:41](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilJsonRpcRequest.ts#L41) diff --git a/packages/procedures/docs/type-aliases/AnvilSetCoinbaseJsonRpcResponse.md b/packages/procedures/docs/type-aliases/AnvilSetCoinbaseJsonRpcResponse.md index ef9526a46a..8ad47d3e89 100644 --- a/packages/procedures/docs/type-aliases/AnvilSetCoinbaseJsonRpcResponse.md +++ b/packages/procedures/docs/type-aliases/AnvilSetCoinbaseJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `anvil_setCoinbase` procedure ## Defined in -[procedures/src/anvil/AnvilJsonRpcResponse.ts:47](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilJsonRpcResponse.ts#L47) +[packages/procedures/src/anvil/AnvilJsonRpcResponse.ts:47](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilJsonRpcResponse.ts#L47) diff --git a/packages/procedures/docs/type-aliases/AnvilSetCoinbaseProcedure.md b/packages/procedures/docs/type-aliases/AnvilSetCoinbaseProcedure.md index 8a2d501c13..3071632f17 100644 --- a/packages/procedures/docs/type-aliases/AnvilSetCoinbaseProcedure.md +++ b/packages/procedures/docs/type-aliases/AnvilSetCoinbaseProcedure.md @@ -18,4 +18,4 @@ ## Defined in -[procedures/src/anvil/AnvilProcedure.ts:34](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilProcedure.ts#L34) +[packages/procedures/src/anvil/AnvilProcedure.ts:34](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilProcedure.ts#L34) diff --git a/packages/procedures/docs/type-aliases/AnvilSetNonceJsonRpcRequest.md b/packages/procedures/docs/type-aliases/AnvilSetNonceJsonRpcRequest.md index c5d3e7e41c..5440cda925 100644 --- a/packages/procedures/docs/type-aliases/AnvilSetNonceJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/AnvilSetNonceJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `anvil_setNonce` method ## Defined in -[procedures/src/anvil/AnvilJsonRpcRequest.ts:74](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilJsonRpcRequest.ts#L74) +[packages/procedures/src/anvil/AnvilJsonRpcRequest.ts:74](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilJsonRpcRequest.ts#L74) diff --git a/packages/procedures/docs/type-aliases/AnvilSetNonceJsonRpcResponse.md b/packages/procedures/docs/type-aliases/AnvilSetNonceJsonRpcResponse.md index 4f155869d9..547fef5062 100644 --- a/packages/procedures/docs/type-aliases/AnvilSetNonceJsonRpcResponse.md +++ b/packages/procedures/docs/type-aliases/AnvilSetNonceJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `anvil_setNonce` procedure ## Defined in -[procedures/src/anvil/AnvilJsonRpcResponse.ts:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilJsonRpcResponse.ts#L104) +[packages/procedures/src/anvil/AnvilJsonRpcResponse.ts:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilJsonRpcResponse.ts#L104) diff --git a/packages/procedures/docs/type-aliases/AnvilSetNonceProcedure.md b/packages/procedures/docs/type-aliases/AnvilSetNonceProcedure.md index c2d9b3b044..d94e641eea 100644 --- a/packages/procedures/docs/type-aliases/AnvilSetNonceProcedure.md +++ b/packages/procedures/docs/type-aliases/AnvilSetNonceProcedure.md @@ -20,4 +20,4 @@ JSON-RPC procedure for `anvil_setNonce` ## Defined in -[procedures/src/anvil/AnvilProcedure.ts:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilProcedure.ts#L96) +[packages/procedures/src/anvil/AnvilProcedure.ts:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilProcedure.ts#L96) diff --git a/packages/procedures/docs/type-aliases/AnvilSetStorageAtJsonRpcRequest.md b/packages/procedures/docs/type-aliases/AnvilSetStorageAtJsonRpcRequest.md index 7c63323c21..17e280b4e6 100644 --- a/packages/procedures/docs/type-aliases/AnvilSetStorageAtJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/AnvilSetStorageAtJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `anvil_setStorageAt` method ## Defined in -[procedures/src/anvil/AnvilJsonRpcRequest.ts:79](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilJsonRpcRequest.ts#L79) +[packages/procedures/src/anvil/AnvilJsonRpcRequest.ts:79](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilJsonRpcRequest.ts#L79) diff --git a/packages/procedures/docs/type-aliases/AnvilSetStorageAtJsonRpcResponse.md b/packages/procedures/docs/type-aliases/AnvilSetStorageAtJsonRpcResponse.md index 698d185de8..29dc917af4 100644 --- a/packages/procedures/docs/type-aliases/AnvilSetStorageAtJsonRpcResponse.md +++ b/packages/procedures/docs/type-aliases/AnvilSetStorageAtJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `anvil_setStorageAt` procedure ## Defined in -[procedures/src/anvil/AnvilJsonRpcResponse.ts:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilJsonRpcResponse.ts#L113) +[packages/procedures/src/anvil/AnvilJsonRpcResponse.ts:113](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilJsonRpcResponse.ts#L113) diff --git a/packages/procedures/docs/type-aliases/AnvilSetStorageAtProcedure.md b/packages/procedures/docs/type-aliases/AnvilSetStorageAtProcedure.md index 2014a8df23..b820cd796b 100644 --- a/packages/procedures/docs/type-aliases/AnvilSetStorageAtProcedure.md +++ b/packages/procedures/docs/type-aliases/AnvilSetStorageAtProcedure.md @@ -20,4 +20,4 @@ JSON-RPC procedure for `anvil_setStorageAt` ## Defined in -[procedures/src/anvil/AnvilProcedure.ts:101](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilProcedure.ts#L101) +[packages/procedures/src/anvil/AnvilProcedure.ts:101](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilProcedure.ts#L101) diff --git a/packages/procedures/docs/type-aliases/AnvilStopImpersonatingAccountJsonRpcRequest.md b/packages/procedures/docs/type-aliases/AnvilStopImpersonatingAccountJsonRpcRequest.md index c96b1f8809..ccf88b3045 100644 --- a/packages/procedures/docs/type-aliases/AnvilStopImpersonatingAccountJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/AnvilStopImpersonatingAccountJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `anvil_stopImpersonatingAccount` method ## Defined in -[procedures/src/anvil/AnvilJsonRpcRequest.ts:21](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilJsonRpcRequest.ts#L21) +[packages/procedures/src/anvil/AnvilJsonRpcRequest.ts:21](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilJsonRpcRequest.ts#L21) diff --git a/packages/procedures/docs/type-aliases/AnvilStopImpersonatingAccountJsonRpcResponse.md b/packages/procedures/docs/type-aliases/AnvilStopImpersonatingAccountJsonRpcResponse.md index 73db01075d..cdf9e19304 100644 --- a/packages/procedures/docs/type-aliases/AnvilStopImpersonatingAccountJsonRpcResponse.md +++ b/packages/procedures/docs/type-aliases/AnvilStopImpersonatingAccountJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `anvil_stopImpersonatingAccount` procedure ## Defined in -[procedures/src/anvil/AnvilJsonRpcResponse.ts:38](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilJsonRpcResponse.ts#L38) +[packages/procedures/src/anvil/AnvilJsonRpcResponse.ts:38](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilJsonRpcResponse.ts#L38) diff --git a/packages/procedures/docs/type-aliases/AnvilStopImpersonatingAccountProcedure.md b/packages/procedures/docs/type-aliases/AnvilStopImpersonatingAccountProcedure.md index 670c37d939..d4e0fbca44 100644 --- a/packages/procedures/docs/type-aliases/AnvilStopImpersonatingAccountProcedure.md +++ b/packages/procedures/docs/type-aliases/AnvilStopImpersonatingAccountProcedure.md @@ -20,4 +20,4 @@ JSON-RPC procedure for `anvil_stopImpersonatingAccount` ## Defined in -[procedures/src/anvil/AnvilProcedure.ts:48](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilProcedure.ts#L48) +[packages/procedures/src/anvil/AnvilProcedure.ts:48](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/anvil/AnvilProcedure.ts#L48) diff --git a/packages/procedures/docs/type-aliases/BigIntToHex.md b/packages/procedures/docs/type-aliases/BigIntToHex.md index 88a9e561ee..f9ced7bf21 100644 --- a/packages/procedures/docs/type-aliases/BigIntToHex.md +++ b/packages/procedures/docs/type-aliases/BigIntToHex.md @@ -14,4 +14,4 @@ ## Defined in -[procedures/src/utils/SerializeToJson.ts:19](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/utils/SerializeToJson.ts#L19) +[packages/procedures/src/utils/SerializeToJson.ts:19](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/utils/SerializeToJson.ts#L19) diff --git a/packages/procedures/docs/type-aliases/CallJsonRpcProcedure.md b/packages/procedures/docs/type-aliases/CallJsonRpcProcedure.md index f26d1097a8..5fc8532ab2 100644 --- a/packages/procedures/docs/type-aliases/CallJsonRpcProcedure.md +++ b/packages/procedures/docs/type-aliases/CallJsonRpcProcedure.md @@ -20,4 +20,4 @@ Call JSON-RPC procedure executes a call against the tevm EVM ## Defined in -[procedures/src/call/CallJsonRpcProcedure.ts:7](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/call/CallJsonRpcProcedure.ts#L7) +[packages/procedures/src/call/CallJsonRpcProcedure.ts:7](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/call/CallJsonRpcProcedure.ts#L7) diff --git a/packages/procedures/docs/type-aliases/CallJsonRpcRequest.md b/packages/procedures/docs/type-aliases/CallJsonRpcRequest.md index e948324b36..4678bd78d3 100644 --- a/packages/procedures/docs/type-aliases/CallJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/CallJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `tevm_call` ## Defined in -[procedures/src/call/CallJsonRpcRequest.ts:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/call/CallJsonRpcRequest.ts#L8) +[packages/procedures/src/call/CallJsonRpcRequest.ts:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/call/CallJsonRpcRequest.ts#L8) diff --git a/packages/procedures/docs/type-aliases/CallJsonRpcResponse.md b/packages/procedures/docs/type-aliases/CallJsonRpcResponse.md index bad3b87b44..7db4ac3a59 100644 --- a/packages/procedures/docs/type-aliases/CallJsonRpcResponse.md +++ b/packages/procedures/docs/type-aliases/CallJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `tevm_call` procedure ## Defined in -[procedures/src/call/CallJsonRpcResponse.ts:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/call/CallJsonRpcResponse.ts#L8) +[packages/procedures/src/call/CallJsonRpcResponse.ts:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/call/CallJsonRpcResponse.ts#L8) diff --git a/packages/procedures/docs/type-aliases/DebugJsonRpcRequest.md b/packages/procedures/docs/type-aliases/DebugJsonRpcRequest.md index ea68545477..d73523daf4 100644 --- a/packages/procedures/docs/type-aliases/DebugJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/DebugJsonRpcRequest.md @@ -10,4 +10,4 @@ ## Defined in -[procedures/src/debug/DebugJsonRpcRequest.ts:19](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/debug/DebugJsonRpcRequest.ts#L19) +[packages/procedures/src/debug/DebugJsonRpcRequest.ts:19](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/debug/DebugJsonRpcRequest.ts#L19) diff --git a/packages/procedures/docs/type-aliases/DebugRequestType.md b/packages/procedures/docs/type-aliases/DebugRequestType.md index 15de511f81..374314aed3 100644 --- a/packages/procedures/docs/type-aliases/DebugRequestType.md +++ b/packages/procedures/docs/type-aliases/DebugRequestType.md @@ -22,4 +22,4 @@ A mapping of `debug_*` method names to their request type ## Defined in -[procedures/src/tevm-request-handler/DebugRequestType.ts:6](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/tevm-request-handler/DebugRequestType.ts#L6) +[packages/procedures/src/tevm-request-handler/DebugRequestType.ts:6](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/tevm-request-handler/DebugRequestType.ts#L6) diff --git a/packages/procedures/docs/type-aliases/DebugReturnType.md b/packages/procedures/docs/type-aliases/DebugReturnType.md index fcf5d505be..ecdea64369 100644 --- a/packages/procedures/docs/type-aliases/DebugReturnType.md +++ b/packages/procedures/docs/type-aliases/DebugReturnType.md @@ -22,4 +22,4 @@ A mapping of `debug_*` method names to their return type ## Defined in -[procedures/src/tevm-request-handler/DebugReturnType.ts:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/tevm-request-handler/DebugReturnType.ts#L9) +[packages/procedures/src/tevm-request-handler/DebugReturnType.ts:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/tevm-request-handler/DebugReturnType.ts#L9) diff --git a/packages/procedures/docs/type-aliases/DebugTraceCallJsonRpcRequest.md b/packages/procedures/docs/type-aliases/DebugTraceCallJsonRpcRequest.md index fc1ae91d6e..0d1b43f818 100644 --- a/packages/procedures/docs/type-aliases/DebugTraceCallJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/DebugTraceCallJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `debug_traceCall` method ## Defined in -[procedures/src/debug/DebugJsonRpcRequest.ts:17](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/debug/DebugJsonRpcRequest.ts#L17) +[packages/procedures/src/debug/DebugJsonRpcRequest.ts:17](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/debug/DebugJsonRpcRequest.ts#L17) diff --git a/packages/procedures/docs/type-aliases/DebugTraceCallJsonRpcResponse.md b/packages/procedures/docs/type-aliases/DebugTraceCallJsonRpcResponse.md index 6e6dcadd52..d9e9e84092 100644 --- a/packages/procedures/docs/type-aliases/DebugTraceCallJsonRpcResponse.md +++ b/packages/procedures/docs/type-aliases/DebugTraceCallJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `debug_traceCall` procedure ## Defined in -[procedures/src/debug/DebugJsonRpcResponse.ts:22](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/debug/DebugJsonRpcResponse.ts#L22) +[packages/procedures/src/debug/DebugJsonRpcResponse.ts:22](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/debug/DebugJsonRpcResponse.ts#L22) diff --git a/packages/procedures/docs/type-aliases/DebugTraceCallProcedure.md b/packages/procedures/docs/type-aliases/DebugTraceCallProcedure.md index e1ad2d95cc..5daa564055 100644 --- a/packages/procedures/docs/type-aliases/DebugTraceCallProcedure.md +++ b/packages/procedures/docs/type-aliases/DebugTraceCallProcedure.md @@ -20,4 +20,4 @@ JSON-RPC procedure for `debug_traceCall` ## Defined in -[procedures/src/debug/DebugProcedure.ts:14](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/debug/DebugProcedure.ts#L14) +[packages/procedures/src/debug/DebugProcedure.ts:14](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/debug/DebugProcedure.ts#L14) diff --git a/packages/procedures/docs/type-aliases/DebugTraceTransactionJsonRpcRequest.md b/packages/procedures/docs/type-aliases/DebugTraceTransactionJsonRpcRequest.md index 702c2fa7b6..75a3f9c9ff 100644 --- a/packages/procedures/docs/type-aliases/DebugTraceTransactionJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/DebugTraceTransactionJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `debug_traceTransaction` method ## Defined in -[procedures/src/debug/DebugJsonRpcRequest.ts:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/debug/DebugJsonRpcRequest.ts#L9) +[packages/procedures/src/debug/DebugJsonRpcRequest.ts:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/debug/DebugJsonRpcRequest.ts#L9) diff --git a/packages/procedures/docs/type-aliases/DebugTraceTransactionJsonRpcResponse.md b/packages/procedures/docs/type-aliases/DebugTraceTransactionJsonRpcResponse.md index d461042291..aa06cdeaf3 100644 --- a/packages/procedures/docs/type-aliases/DebugTraceTransactionJsonRpcResponse.md +++ b/packages/procedures/docs/type-aliases/DebugTraceTransactionJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `debug_traceTransaction` procedure ## Defined in -[procedures/src/debug/DebugJsonRpcResponse.ts:13](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/debug/DebugJsonRpcResponse.ts#L13) +[packages/procedures/src/debug/DebugJsonRpcResponse.ts:13](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/debug/DebugJsonRpcResponse.ts#L13) diff --git a/packages/procedures/docs/type-aliases/DebugTraceTransactionProcedure.md b/packages/procedures/docs/type-aliases/DebugTraceTransactionProcedure.md index 934a43feeb..a2f52c9ec6 100644 --- a/packages/procedures/docs/type-aliases/DebugTraceTransactionProcedure.md +++ b/packages/procedures/docs/type-aliases/DebugTraceTransactionProcedure.md @@ -20,4 +20,4 @@ JSON-RPC procedure for `debug_traceTransaction` ## Defined in -[procedures/src/debug/DebugProcedure.ts:7](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/debug/DebugProcedure.ts#L7) +[packages/procedures/src/debug/DebugProcedure.ts:7](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/debug/DebugProcedure.ts#L7) diff --git a/packages/procedures/docs/type-aliases/DumpStateJsonRpcProcedure.md b/packages/procedures/docs/type-aliases/DumpStateJsonRpcProcedure.md index 747b3ef043..92d25ba77d 100644 --- a/packages/procedures/docs/type-aliases/DumpStateJsonRpcProcedure.md +++ b/packages/procedures/docs/type-aliases/DumpStateJsonRpcProcedure.md @@ -20,4 +20,4 @@ the state as a JSON-RPC successful result ## Defined in -[procedures/src/dumpstate/DumpStateJsonRpcProcedure.ts:16](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/dumpstate/DumpStateJsonRpcProcedure.ts#L16) +[packages/procedures/src/dumpstate/DumpStateJsonRpcProcedure.ts:16](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/dumpstate/DumpStateJsonRpcProcedure.ts#L16) diff --git a/packages/procedures/docs/type-aliases/DumpStateJsonRpcRequest.md b/packages/procedures/docs/type-aliases/DumpStateJsonRpcRequest.md index b5e840856f..739fcf7dc0 100644 --- a/packages/procedures/docs/type-aliases/DumpStateJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/DumpStateJsonRpcRequest.md @@ -12,4 +12,4 @@ The JSON-RPC request for the `tevm_dumpState` method ## Defined in -[procedures/src/dumpstate/DumpStateJsonRpcRequest.ts:6](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/dumpstate/DumpStateJsonRpcRequest.ts#L6) +[packages/procedures/src/dumpstate/DumpStateJsonRpcRequest.ts:6](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/dumpstate/DumpStateJsonRpcRequest.ts#L6) diff --git a/packages/procedures/docs/type-aliases/DumpStateJsonRpcResponse.md b/packages/procedures/docs/type-aliases/DumpStateJsonRpcResponse.md index f36beb23e8..d3d4e9d985 100644 --- a/packages/procedures/docs/type-aliases/DumpStateJsonRpcResponse.md +++ b/packages/procedures/docs/type-aliases/DumpStateJsonRpcResponse.md @@ -12,4 +12,4 @@ The response to the `tevm_dumpState` JSON-RPC request. ## Defined in -[procedures/src/dumpstate/DumpStateJsonRpcResponse.ts:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/dumpstate/DumpStateJsonRpcResponse.ts#L9) +[packages/procedures/src/dumpstate/DumpStateJsonRpcResponse.ts:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/dumpstate/DumpStateJsonRpcResponse.ts#L9) diff --git a/packages/procedures/docs/type-aliases/EthAccountsJsonRpcProcedure.md b/packages/procedures/docs/type-aliases/EthAccountsJsonRpcProcedure.md index f4aebc9e55..b4694e4ce2 100644 --- a/packages/procedures/docs/type-aliases/EthAccountsJsonRpcProcedure.md +++ b/packages/procedures/docs/type-aliases/EthAccountsJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -[procedures/src/eth/EthProcedure.ts:83](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L83) +[packages/procedures/src/eth/EthProcedure.ts:83](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L83) diff --git a/packages/procedures/docs/type-aliases/EthAccountsJsonRpcRequest.md b/packages/procedures/docs/type-aliases/EthAccountsJsonRpcRequest.md index b24e2c5d4a..896119e113 100644 --- a/packages/procedures/docs/type-aliases/EthAccountsJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/EthAccountsJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_accounts` procedure ## Defined in -[procedures/src/eth/EthJsonRpcRequest.ts:40](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L40) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:40](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L40) diff --git a/packages/procedures/docs/type-aliases/EthAccountsJsonRpcResponse.md b/packages/procedures/docs/type-aliases/EthAccountsJsonRpcResponse.md index 4d1fc82936..d8ac56cbd5 100644 --- a/packages/procedures/docs/type-aliases/EthAccountsJsonRpcResponse.md +++ b/packages/procedures/docs/type-aliases/EthAccountsJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_accounts` procedure ## Defined in -[procedures/src/eth/EthJsonRpcResponse.ts:14](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L14) +[packages/procedures/src/eth/EthJsonRpcResponse.ts:14](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L14) diff --git a/packages/procedures/docs/type-aliases/EthBlockNumberJsonRpcProcedure.md b/packages/procedures/docs/type-aliases/EthBlockNumberJsonRpcProcedure.md index 49fd6f5971..89637cbc6a 100644 --- a/packages/procedures/docs/type-aliases/EthBlockNumberJsonRpcProcedure.md +++ b/packages/procedures/docs/type-aliases/EthBlockNumberJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -[procedures/src/eth/EthProcedure.ts:85](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L85) +[packages/procedures/src/eth/EthProcedure.ts:85](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L85) diff --git a/packages/procedures/docs/type-aliases/EthBlockNumberJsonRpcRequest.md b/packages/procedures/docs/type-aliases/EthBlockNumberJsonRpcRequest.md index b0836028d0..96080096a3 100644 --- a/packages/procedures/docs/type-aliases/EthBlockNumberJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/EthBlockNumberJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_blockNumber` procedure ## Defined in -[procedures/src/eth/EthJsonRpcRequest.ts:45](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L45) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:45](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L45) diff --git a/packages/procedures/docs/type-aliases/EthBlockNumberJsonRpcResponse.md b/packages/procedures/docs/type-aliases/EthBlockNumberJsonRpcResponse.md index 9a20527be5..66271b9952 100644 --- a/packages/procedures/docs/type-aliases/EthBlockNumberJsonRpcResponse.md +++ b/packages/procedures/docs/type-aliases/EthBlockNumberJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_blockNumber` procedure ## Defined in -[procedures/src/eth/EthJsonRpcResponse.ts:20](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L20) +[packages/procedures/src/eth/EthJsonRpcResponse.ts:20](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L20) diff --git a/packages/procedures/docs/type-aliases/EthCallJsonRpcProcedure.md b/packages/procedures/docs/type-aliases/EthCallJsonRpcProcedure.md index 806ca9a0a5..3f11b6b4e3 100644 --- a/packages/procedures/docs/type-aliases/EthCallJsonRpcProcedure.md +++ b/packages/procedures/docs/type-aliases/EthCallJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -[procedures/src/eth/EthProcedure.ts:89](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L89) +[packages/procedures/src/eth/EthProcedure.ts:89](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L89) diff --git a/packages/procedures/docs/type-aliases/EthCallJsonRpcRequest.md b/packages/procedures/docs/type-aliases/EthCallJsonRpcRequest.md index d1e8b4c62a..396e4b933f 100644 --- a/packages/procedures/docs/type-aliases/EthCallJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/EthCallJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_call` procedure ## Defined in -[procedures/src/eth/EthJsonRpcRequest.ts:50](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L50) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:50](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L50) diff --git a/packages/procedures/docs/type-aliases/EthCallJsonRpcResponse.md b/packages/procedures/docs/type-aliases/EthCallJsonRpcResponse.md index 032a1e5d23..350aa650cb 100644 --- a/packages/procedures/docs/type-aliases/EthCallJsonRpcResponse.md +++ b/packages/procedures/docs/type-aliases/EthCallJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_call` procedure ## Defined in -[procedures/src/eth/EthJsonRpcResponse.ts:30](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L30) +[packages/procedures/src/eth/EthJsonRpcResponse.ts:30](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L30) diff --git a/packages/procedures/docs/type-aliases/EthChainIdJsonRpcProcedure.md b/packages/procedures/docs/type-aliases/EthChainIdJsonRpcProcedure.md index 005e909787..e54102b15b 100644 --- a/packages/procedures/docs/type-aliases/EthChainIdJsonRpcProcedure.md +++ b/packages/procedures/docs/type-aliases/EthChainIdJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -[procedures/src/eth/EthProcedure.ts:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L91) +[packages/procedures/src/eth/EthProcedure.ts:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L91) diff --git a/packages/procedures/docs/type-aliases/EthChainIdJsonRpcRequest.md b/packages/procedures/docs/type-aliases/EthChainIdJsonRpcRequest.md index 77058a11ad..fe142d1efd 100644 --- a/packages/procedures/docs/type-aliases/EthChainIdJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/EthChainIdJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_chainId` procedure ## Defined in -[procedures/src/eth/EthJsonRpcRequest.ts:63](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L63) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:63](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L63) diff --git a/packages/procedures/docs/type-aliases/EthChainIdJsonRpcResponse.md b/packages/procedures/docs/type-aliases/EthChainIdJsonRpcResponse.md index db4d1c6e44..8953c348ba 100644 --- a/packages/procedures/docs/type-aliases/EthChainIdJsonRpcResponse.md +++ b/packages/procedures/docs/type-aliases/EthChainIdJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_chainId` procedure ## Defined in -[procedures/src/eth/EthJsonRpcResponse.ts:36](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L36) +[packages/procedures/src/eth/EthJsonRpcResponse.ts:36](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L36) diff --git a/packages/procedures/docs/type-aliases/EthCoinbaseJsonRpcProcedure.md b/packages/procedures/docs/type-aliases/EthCoinbaseJsonRpcProcedure.md index d6626254d2..16d82102ba 100644 --- a/packages/procedures/docs/type-aliases/EthCoinbaseJsonRpcProcedure.md +++ b/packages/procedures/docs/type-aliases/EthCoinbaseJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -[procedures/src/eth/EthProcedure.ts:93](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L93) +[packages/procedures/src/eth/EthProcedure.ts:93](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L93) diff --git a/packages/procedures/docs/type-aliases/EthCoinbaseJsonRpcRequest.md b/packages/procedures/docs/type-aliases/EthCoinbaseJsonRpcRequest.md index 0a482ac8d9..770cf480c2 100644 --- a/packages/procedures/docs/type-aliases/EthCoinbaseJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/EthCoinbaseJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_coinbase` procedure ## Defined in -[procedures/src/eth/EthJsonRpcRequest.ts:68](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L68) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:68](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L68) diff --git a/packages/procedures/docs/type-aliases/EthCoinbaseJsonRpcResponse.md b/packages/procedures/docs/type-aliases/EthCoinbaseJsonRpcResponse.md index c23d3c79f6..b3c3b59e43 100644 --- a/packages/procedures/docs/type-aliases/EthCoinbaseJsonRpcResponse.md +++ b/packages/procedures/docs/type-aliases/EthCoinbaseJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_coinbase` procedure ## Defined in -[procedures/src/eth/EthJsonRpcResponse.ts:42](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L42) +[packages/procedures/src/eth/EthJsonRpcResponse.ts:42](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L42) diff --git a/packages/procedures/docs/type-aliases/EthEstimateGasJsonRpcProcedure.md b/packages/procedures/docs/type-aliases/EthEstimateGasJsonRpcProcedure.md index a312fe7364..ee7cc4d1e2 100644 --- a/packages/procedures/docs/type-aliases/EthEstimateGasJsonRpcProcedure.md +++ b/packages/procedures/docs/type-aliases/EthEstimateGasJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -[procedures/src/eth/EthProcedure.ts:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L95) +[packages/procedures/src/eth/EthProcedure.ts:95](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L95) diff --git a/packages/procedures/docs/type-aliases/EthEstimateGasJsonRpcRequest.md b/packages/procedures/docs/type-aliases/EthEstimateGasJsonRpcRequest.md index e2363332e6..5a44938401 100644 --- a/packages/procedures/docs/type-aliases/EthEstimateGasJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/EthEstimateGasJsonRpcRequest.md @@ -6,10 +6,10 @@ # Type Alias: EthEstimateGasJsonRpcRequest -> **EthEstimateGasJsonRpcRequest**: `JsonRpcRequest`\<`"eth_estimateGas"`, readonly [[`JsonRpcTransaction`](JsonRpcTransaction.md)]\> +> **EthEstimateGasJsonRpcRequest**: `JsonRpcRequest`\<`"eth_estimateGas"`, readonly [[`JsonRpcTransaction`](JsonRpcTransaction.md), `BlockTag` \| `Hex`, [`SerializeToJson`](SerializeToJson.md)\<`BaseCallParams`\[`"stateOverrideSet"`\]\>, [`SerializeToJson`](SerializeToJson.md)\<`BaseCallParams`\[`"blockOverrideSet"`\]\>]\> JSON-RPC request for `eth_estimateGas` procedure ## Defined in -[procedures/src/eth/EthJsonRpcRequest.ts:73](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L73) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:73](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L73) diff --git a/packages/procedures/docs/type-aliases/EthEstimateGasJsonRpcResponse.md b/packages/procedures/docs/type-aliases/EthEstimateGasJsonRpcResponse.md index 66894b1d9b..95b4bd4d7c 100644 --- a/packages/procedures/docs/type-aliases/EthEstimateGasJsonRpcResponse.md +++ b/packages/procedures/docs/type-aliases/EthEstimateGasJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_estimateGas` procedure ## Defined in -[procedures/src/eth/EthJsonRpcResponse.ts:48](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L48) +[packages/procedures/src/eth/EthJsonRpcResponse.ts:48](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L48) diff --git a/packages/procedures/docs/type-aliases/EthGasPriceJsonRpcProcedure.md b/packages/procedures/docs/type-aliases/EthGasPriceJsonRpcProcedure.md index cacf1403bf..75894539a7 100644 --- a/packages/procedures/docs/type-aliases/EthGasPriceJsonRpcProcedure.md +++ b/packages/procedures/docs/type-aliases/EthGasPriceJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -[procedures/src/eth/EthProcedure.ts:101](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L101) +[packages/procedures/src/eth/EthProcedure.ts:101](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L101) diff --git a/packages/procedures/docs/type-aliases/EthGasPriceJsonRpcRequest.md b/packages/procedures/docs/type-aliases/EthGasPriceJsonRpcRequest.md index aa60a014a3..2660b9d4d3 100644 --- a/packages/procedures/docs/type-aliases/EthGasPriceJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/EthGasPriceJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_gasPrice` procedure ## Defined in -[procedures/src/eth/EthJsonRpcRequest.ts:83](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L83) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:91](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L91) diff --git a/packages/procedures/docs/type-aliases/EthGasPriceJsonRpcResponse.md b/packages/procedures/docs/type-aliases/EthGasPriceJsonRpcResponse.md index ae1d49589d..e031bf7ea4 100644 --- a/packages/procedures/docs/type-aliases/EthGasPriceJsonRpcResponse.md +++ b/packages/procedures/docs/type-aliases/EthGasPriceJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_gasPrice` procedure ## Defined in -[procedures/src/eth/EthJsonRpcResponse.ts:60](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L60) +[packages/procedures/src/eth/EthJsonRpcResponse.ts:60](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L60) diff --git a/packages/procedures/docs/type-aliases/EthGetBalanceJsonRpcProcedure.md b/packages/procedures/docs/type-aliases/EthGetBalanceJsonRpcProcedure.md index 0ecfe5d081..184a801dc4 100644 --- a/packages/procedures/docs/type-aliases/EthGetBalanceJsonRpcProcedure.md +++ b/packages/procedures/docs/type-aliases/EthGetBalanceJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -[procedures/src/eth/EthProcedure.ts:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L103) +[packages/procedures/src/eth/EthProcedure.ts:103](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L103) diff --git a/packages/procedures/docs/type-aliases/EthGetBalanceJsonRpcRequest.md b/packages/procedures/docs/type-aliases/EthGetBalanceJsonRpcRequest.md index a279a5683b..582368ab27 100644 --- a/packages/procedures/docs/type-aliases/EthGetBalanceJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/EthGetBalanceJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_getBalance` procedure ## Defined in -[procedures/src/eth/EthJsonRpcRequest.ts:88](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L88) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:96](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L96) diff --git a/packages/procedures/docs/type-aliases/EthGetBalanceJsonRpcResponse.md b/packages/procedures/docs/type-aliases/EthGetBalanceJsonRpcResponse.md index fb606ff812..1d4b223690 100644 --- a/packages/procedures/docs/type-aliases/EthGetBalanceJsonRpcResponse.md +++ b/packages/procedures/docs/type-aliases/EthGetBalanceJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_getBalance` procedure ## Defined in -[procedures/src/eth/EthJsonRpcResponse.ts:66](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L66) +[packages/procedures/src/eth/EthJsonRpcResponse.ts:66](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L66) diff --git a/packages/procedures/docs/type-aliases/EthGetBlockByHashJsonRpcProcedure.md b/packages/procedures/docs/type-aliases/EthGetBlockByHashJsonRpcProcedure.md index 53475c8eb3..894fba9c21 100644 --- a/packages/procedures/docs/type-aliases/EthGetBlockByHashJsonRpcProcedure.md +++ b/packages/procedures/docs/type-aliases/EthGetBlockByHashJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -[procedures/src/eth/EthProcedure.ts:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L107) +[packages/procedures/src/eth/EthProcedure.ts:107](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L107) diff --git a/packages/procedures/docs/type-aliases/EthGetBlockByHashJsonRpcRequest.md b/packages/procedures/docs/type-aliases/EthGetBlockByHashJsonRpcRequest.md index c0107a4ae1..5b97395d1d 100644 --- a/packages/procedures/docs/type-aliases/EthGetBlockByHashJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/EthGetBlockByHashJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_getBlockByHash` procedure ## Defined in -[procedures/src/eth/EthJsonRpcRequest.ts:93](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L93) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:101](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L101) diff --git a/packages/procedures/docs/type-aliases/EthGetBlockByHashJsonRpcResponse.md b/packages/procedures/docs/type-aliases/EthGetBlockByHashJsonRpcResponse.md index 5645e4664a..458f7335a3 100644 --- a/packages/procedures/docs/type-aliases/EthGetBlockByHashJsonRpcResponse.md +++ b/packages/procedures/docs/type-aliases/EthGetBlockByHashJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_getBlockByHash` procedure ## Defined in -[procedures/src/eth/EthJsonRpcResponse.ts:72](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L72) +[packages/procedures/src/eth/EthJsonRpcResponse.ts:72](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L72) diff --git a/packages/procedures/docs/type-aliases/EthGetBlockByNumberJsonRpcProcedure.md b/packages/procedures/docs/type-aliases/EthGetBlockByNumberJsonRpcProcedure.md index 9e35fec7c3..8efc79e490 100644 --- a/packages/procedures/docs/type-aliases/EthGetBlockByNumberJsonRpcProcedure.md +++ b/packages/procedures/docs/type-aliases/EthGetBlockByNumberJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -[procedures/src/eth/EthProcedure.ts:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L111) +[packages/procedures/src/eth/EthProcedure.ts:111](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L111) diff --git a/packages/procedures/docs/type-aliases/EthGetBlockByNumberJsonRpcRequest.md b/packages/procedures/docs/type-aliases/EthGetBlockByNumberJsonRpcRequest.md index 3030124bbd..a640bbb873 100644 --- a/packages/procedures/docs/type-aliases/EthGetBlockByNumberJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/EthGetBlockByNumberJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_getBlockByNumber` procedure ## Defined in -[procedures/src/eth/EthJsonRpcRequest.ts:101](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L101) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:109](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L109) diff --git a/packages/procedures/docs/type-aliases/EthGetBlockByNumberJsonRpcResponse.md b/packages/procedures/docs/type-aliases/EthGetBlockByNumberJsonRpcResponse.md index e907c69bab..a8c97145fc 100644 --- a/packages/procedures/docs/type-aliases/EthGetBlockByNumberJsonRpcResponse.md +++ b/packages/procedures/docs/type-aliases/EthGetBlockByNumberJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_getBlockByNumber` procedure ## Defined in -[procedures/src/eth/EthJsonRpcResponse.ts:78](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L78) +[packages/procedures/src/eth/EthJsonRpcResponse.ts:78](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L78) diff --git a/packages/procedures/docs/type-aliases/EthGetBlockTransactionCountByHashJsonRpcProcedure.md b/packages/procedures/docs/type-aliases/EthGetBlockTransactionCountByHashJsonRpcProcedure.md index 03cc36ba20..2b9b9fc75a 100644 --- a/packages/procedures/docs/type-aliases/EthGetBlockTransactionCountByHashJsonRpcProcedure.md +++ b/packages/procedures/docs/type-aliases/EthGetBlockTransactionCountByHashJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -[procedures/src/eth/EthProcedure.ts:115](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L115) +[packages/procedures/src/eth/EthProcedure.ts:115](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L115) diff --git a/packages/procedures/docs/type-aliases/EthGetBlockTransactionCountByHashJsonRpcRequest.md b/packages/procedures/docs/type-aliases/EthGetBlockTransactionCountByHashJsonRpcRequest.md index 5818d6f1bd..1c6c58f47c 100644 --- a/packages/procedures/docs/type-aliases/EthGetBlockTransactionCountByHashJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/EthGetBlockTransactionCountByHashJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_getBlockTransactionCountByHash` procedure ## Defined in -[procedures/src/eth/EthJsonRpcRequest.ts:109](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L109) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:117](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L117) diff --git a/packages/procedures/docs/type-aliases/EthGetBlockTransactionCountByHashJsonRpcResponse.md b/packages/procedures/docs/type-aliases/EthGetBlockTransactionCountByHashJsonRpcResponse.md index f0b4c409c5..15fd88c2f8 100644 --- a/packages/procedures/docs/type-aliases/EthGetBlockTransactionCountByHashJsonRpcResponse.md +++ b/packages/procedures/docs/type-aliases/EthGetBlockTransactionCountByHashJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_getBlockTransactionCountByHash` procedure ## Defined in -[procedures/src/eth/EthJsonRpcResponse.ts:84](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L84) +[packages/procedures/src/eth/EthJsonRpcResponse.ts:84](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L84) diff --git a/packages/procedures/docs/type-aliases/EthGetBlockTransactionCountByNumberJsonRpcProcedure.md b/packages/procedures/docs/type-aliases/EthGetBlockTransactionCountByNumberJsonRpcProcedure.md index 6b5aed4004..ecdea6b4f0 100644 --- a/packages/procedures/docs/type-aliases/EthGetBlockTransactionCountByNumberJsonRpcProcedure.md +++ b/packages/procedures/docs/type-aliases/EthGetBlockTransactionCountByNumberJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -[procedures/src/eth/EthProcedure.ts:119](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L119) +[packages/procedures/src/eth/EthProcedure.ts:119](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L119) diff --git a/packages/procedures/docs/type-aliases/EthGetBlockTransactionCountByNumberJsonRpcRequest.md b/packages/procedures/docs/type-aliases/EthGetBlockTransactionCountByNumberJsonRpcRequest.md index bb57ae9682..7dc5c0efc3 100644 --- a/packages/procedures/docs/type-aliases/EthGetBlockTransactionCountByNumberJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/EthGetBlockTransactionCountByNumberJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_getBlockTransactionCountByNumber` procedure ## Defined in -[procedures/src/eth/EthJsonRpcRequest.ts:117](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L117) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:125](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L125) diff --git a/packages/procedures/docs/type-aliases/EthGetBlockTransactionCountByNumberJsonRpcResponse.md b/packages/procedures/docs/type-aliases/EthGetBlockTransactionCountByNumberJsonRpcResponse.md index 1394c6ad6b..9ba4c79e41 100644 --- a/packages/procedures/docs/type-aliases/EthGetBlockTransactionCountByNumberJsonRpcResponse.md +++ b/packages/procedures/docs/type-aliases/EthGetBlockTransactionCountByNumberJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_getBlockTransactionCountByNumber` procedure ## Defined in -[procedures/src/eth/EthJsonRpcResponse.ts:94](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L94) +[packages/procedures/src/eth/EthJsonRpcResponse.ts:94](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L94) diff --git a/packages/procedures/docs/type-aliases/EthGetCodeJsonRpcProcedure.md b/packages/procedures/docs/type-aliases/EthGetCodeJsonRpcProcedure.md index a7c095c667..ddb3dc615b 100644 --- a/packages/procedures/docs/type-aliases/EthGetCodeJsonRpcProcedure.md +++ b/packages/procedures/docs/type-aliases/EthGetCodeJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -[procedures/src/eth/EthProcedure.ts:123](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L123) +[packages/procedures/src/eth/EthProcedure.ts:123](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L123) diff --git a/packages/procedures/docs/type-aliases/EthGetCodeJsonRpcRequest.md b/packages/procedures/docs/type-aliases/EthGetCodeJsonRpcRequest.md index 1deae20ff3..e986e5580a 100644 --- a/packages/procedures/docs/type-aliases/EthGetCodeJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/EthGetCodeJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_getCode` procedure ## Defined in -[procedures/src/eth/EthJsonRpcRequest.ts:125](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L125) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:133](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L133) diff --git a/packages/procedures/docs/type-aliases/EthGetCodeJsonRpcResponse.md b/packages/procedures/docs/type-aliases/EthGetCodeJsonRpcResponse.md index 05e125f043..2f136ac97d 100644 --- a/packages/procedures/docs/type-aliases/EthGetCodeJsonRpcResponse.md +++ b/packages/procedures/docs/type-aliases/EthGetCodeJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_getCode` procedure ## Defined in -[procedures/src/eth/EthJsonRpcResponse.ts:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L104) +[packages/procedures/src/eth/EthJsonRpcResponse.ts:104](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L104) diff --git a/packages/procedures/docs/type-aliases/EthGetFilterChangesJsonRpcProcedure.md b/packages/procedures/docs/type-aliases/EthGetFilterChangesJsonRpcProcedure.md index d5be94d796..1265d153f5 100644 --- a/packages/procedures/docs/type-aliases/EthGetFilterChangesJsonRpcProcedure.md +++ b/packages/procedures/docs/type-aliases/EthGetFilterChangesJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -[procedures/src/eth/EthProcedure.ts:125](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L125) +[packages/procedures/src/eth/EthProcedure.ts:125](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L125) diff --git a/packages/procedures/docs/type-aliases/EthGetFilterChangesJsonRpcRequest.md b/packages/procedures/docs/type-aliases/EthGetFilterChangesJsonRpcRequest.md index 1631959402..fae99a184c 100644 --- a/packages/procedures/docs/type-aliases/EthGetFilterChangesJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/EthGetFilterChangesJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_getFilterChanges` procedure ## Defined in -[procedures/src/eth/EthJsonRpcRequest.ts:130](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L130) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:138](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L138) diff --git a/packages/procedures/docs/type-aliases/EthGetFilterChangesJsonRpcResponse.md b/packages/procedures/docs/type-aliases/EthGetFilterChangesJsonRpcResponse.md index fa8963e498..07251f2a17 100644 --- a/packages/procedures/docs/type-aliases/EthGetFilterChangesJsonRpcResponse.md +++ b/packages/procedures/docs/type-aliases/EthGetFilterChangesJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_getFilterChanges` procedure ## Defined in -[procedures/src/eth/EthJsonRpcResponse.ts:110](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L110) +[packages/procedures/src/eth/EthJsonRpcResponse.ts:110](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L110) diff --git a/packages/procedures/docs/type-aliases/EthGetFilterLogsJsonRpcProcedure.md b/packages/procedures/docs/type-aliases/EthGetFilterLogsJsonRpcProcedure.md index 9986a95ab8..2fa58a725c 100644 --- a/packages/procedures/docs/type-aliases/EthGetFilterLogsJsonRpcProcedure.md +++ b/packages/procedures/docs/type-aliases/EthGetFilterLogsJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -[procedures/src/eth/EthProcedure.ts:129](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L129) +[packages/procedures/src/eth/EthProcedure.ts:129](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L129) diff --git a/packages/procedures/docs/type-aliases/EthGetFilterLogsJsonRpcRequest.md b/packages/procedures/docs/type-aliases/EthGetFilterLogsJsonRpcRequest.md index 7878728726..c95cdbd6c9 100644 --- a/packages/procedures/docs/type-aliases/EthGetFilterLogsJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/EthGetFilterLogsJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_getFilterLogs` procedure ## Defined in -[procedures/src/eth/EthJsonRpcRequest.ts:135](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L135) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:143](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L143) diff --git a/packages/procedures/docs/type-aliases/EthGetFilterLogsJsonRpcResponse.md b/packages/procedures/docs/type-aliases/EthGetFilterLogsJsonRpcResponse.md index fe7078581a..3adb8c0bf9 100644 --- a/packages/procedures/docs/type-aliases/EthGetFilterLogsJsonRpcResponse.md +++ b/packages/procedures/docs/type-aliases/EthGetFilterLogsJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_getFilterLogs` procedure ## Defined in -[procedures/src/eth/EthJsonRpcResponse.ts:120](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L120) +[packages/procedures/src/eth/EthJsonRpcResponse.ts:120](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L120) diff --git a/packages/procedures/docs/type-aliases/EthGetLogsJsonRpcProcedure.md b/packages/procedures/docs/type-aliases/EthGetLogsJsonRpcProcedure.md index 21c6912d75..b418a76cce 100644 --- a/packages/procedures/docs/type-aliases/EthGetLogsJsonRpcProcedure.md +++ b/packages/procedures/docs/type-aliases/EthGetLogsJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -[procedures/src/eth/EthProcedure.ts:133](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L133) +[packages/procedures/src/eth/EthProcedure.ts:133](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L133) diff --git a/packages/procedures/docs/type-aliases/EthGetLogsJsonRpcRequest.md b/packages/procedures/docs/type-aliases/EthGetLogsJsonRpcRequest.md index 176b3259bc..1e39fae031 100644 --- a/packages/procedures/docs/type-aliases/EthGetLogsJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/EthGetLogsJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_getLogs` procedure ## Defined in -[procedures/src/eth/EthJsonRpcRequest.ts:140](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L140) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:148](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L148) diff --git a/packages/procedures/docs/type-aliases/EthGetLogsJsonRpcResponse.md b/packages/procedures/docs/type-aliases/EthGetLogsJsonRpcResponse.md index 34653cd6c3..4debcb0162 100644 --- a/packages/procedures/docs/type-aliases/EthGetLogsJsonRpcResponse.md +++ b/packages/procedures/docs/type-aliases/EthGetLogsJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_getLogs` procedure ## Defined in -[procedures/src/eth/EthJsonRpcResponse.ts:130](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L130) +[packages/procedures/src/eth/EthJsonRpcResponse.ts:130](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L130) diff --git a/packages/procedures/docs/type-aliases/EthGetStorageAtJsonRpcProcedure.md b/packages/procedures/docs/type-aliases/EthGetStorageAtJsonRpcProcedure.md index 5755d6be5e..05e87297fc 100644 --- a/packages/procedures/docs/type-aliases/EthGetStorageAtJsonRpcProcedure.md +++ b/packages/procedures/docs/type-aliases/EthGetStorageAtJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -[procedures/src/eth/EthProcedure.ts:135](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L135) +[packages/procedures/src/eth/EthProcedure.ts:135](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L135) diff --git a/packages/procedures/docs/type-aliases/EthGetStorageAtJsonRpcRequest.md b/packages/procedures/docs/type-aliases/EthGetStorageAtJsonRpcRequest.md index 66d71fa76b..5686d02483 100644 --- a/packages/procedures/docs/type-aliases/EthGetStorageAtJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/EthGetStorageAtJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_getStorageAt` procedure ## Defined in -[procedures/src/eth/EthJsonRpcRequest.ts:145](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L145) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:153](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L153) diff --git a/packages/procedures/docs/type-aliases/EthGetStorageAtJsonRpcResponse.md b/packages/procedures/docs/type-aliases/EthGetStorageAtJsonRpcResponse.md index c2f42db044..29cf674990 100644 --- a/packages/procedures/docs/type-aliases/EthGetStorageAtJsonRpcResponse.md +++ b/packages/procedures/docs/type-aliases/EthGetStorageAtJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_getStorageAt` procedure ## Defined in -[procedures/src/eth/EthJsonRpcResponse.ts:140](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L140) +[packages/procedures/src/eth/EthJsonRpcResponse.ts:140](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L140) diff --git a/packages/procedures/docs/type-aliases/EthGetTransactionByBlockHashAndIndexJsonRpcProcedure.md b/packages/procedures/docs/type-aliases/EthGetTransactionByBlockHashAndIndexJsonRpcProcedure.md index 2b0812cdf0..9c6b87d354 100644 --- a/packages/procedures/docs/type-aliases/EthGetTransactionByBlockHashAndIndexJsonRpcProcedure.md +++ b/packages/procedures/docs/type-aliases/EthGetTransactionByBlockHashAndIndexJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -[procedures/src/eth/EthProcedure.ts:155](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L155) +[packages/procedures/src/eth/EthProcedure.ts:155](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L155) diff --git a/packages/procedures/docs/type-aliases/EthGetTransactionByBlockHashAndIndexJsonRpcRequest.md b/packages/procedures/docs/type-aliases/EthGetTransactionByBlockHashAndIndexJsonRpcRequest.md index e52d7f97aa..43d76bb061 100644 --- a/packages/procedures/docs/type-aliases/EthGetTransactionByBlockHashAndIndexJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/EthGetTransactionByBlockHashAndIndexJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_getTransactionByBlockHashAndIndex` procedure ## Defined in -[procedures/src/eth/EthJsonRpcRequest.ts:182](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L182) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:190](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L190) diff --git a/packages/procedures/docs/type-aliases/EthGetTransactionByBlockHashAndIndexJsonRpcResponse.md b/packages/procedures/docs/type-aliases/EthGetTransactionByBlockHashAndIndexJsonRpcResponse.md index 1192432aaa..868ea65fa0 100644 --- a/packages/procedures/docs/type-aliases/EthGetTransactionByBlockHashAndIndexJsonRpcResponse.md +++ b/packages/procedures/docs/type-aliases/EthGetTransactionByBlockHashAndIndexJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_getTransactionByBlockHashAndIndex` procedure ## Defined in -[procedures/src/eth/EthJsonRpcResponse.ts:182](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L182) +[packages/procedures/src/eth/EthJsonRpcResponse.ts:182](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L182) diff --git a/packages/procedures/docs/type-aliases/EthGetTransactionByBlockNumberAndIndexJsonRpcProcedure.md b/packages/procedures/docs/type-aliases/EthGetTransactionByBlockNumberAndIndexJsonRpcProcedure.md index 43b00787ef..5bd7581ce5 100644 --- a/packages/procedures/docs/type-aliases/EthGetTransactionByBlockNumberAndIndexJsonRpcProcedure.md +++ b/packages/procedures/docs/type-aliases/EthGetTransactionByBlockNumberAndIndexJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -[procedures/src/eth/EthProcedure.ts:159](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L159) +[packages/procedures/src/eth/EthProcedure.ts:159](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L159) diff --git a/packages/procedures/docs/type-aliases/EthGetTransactionByBlockNumberAndIndexJsonRpcRequest.md b/packages/procedures/docs/type-aliases/EthGetTransactionByBlockNumberAndIndexJsonRpcRequest.md index 3d48ca15be..b7fc7a23b9 100644 --- a/packages/procedures/docs/type-aliases/EthGetTransactionByBlockNumberAndIndexJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/EthGetTransactionByBlockNumberAndIndexJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_getTransactionByBlockNumberAndIndex` procedure ## Defined in -[procedures/src/eth/EthJsonRpcRequest.ts:190](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L190) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:198](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L198) diff --git a/packages/procedures/docs/type-aliases/EthGetTransactionByBlockNumberAndIndexJsonRpcResponse.md b/packages/procedures/docs/type-aliases/EthGetTransactionByBlockNumberAndIndexJsonRpcResponse.md index dd90a26ecc..ac79080da9 100644 --- a/packages/procedures/docs/type-aliases/EthGetTransactionByBlockNumberAndIndexJsonRpcResponse.md +++ b/packages/procedures/docs/type-aliases/EthGetTransactionByBlockNumberAndIndexJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_getTransactionByBlockNumberAndIndex` procedure ## Defined in -[procedures/src/eth/EthJsonRpcResponse.ts:192](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L192) +[packages/procedures/src/eth/EthJsonRpcResponse.ts:192](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L192) diff --git a/packages/procedures/docs/type-aliases/EthGetTransactionByHashJsonRpcProcedure.md b/packages/procedures/docs/type-aliases/EthGetTransactionByHashJsonRpcProcedure.md index 84f040192c..c3e9931ef6 100644 --- a/packages/procedures/docs/type-aliases/EthGetTransactionByHashJsonRpcProcedure.md +++ b/packages/procedures/docs/type-aliases/EthGetTransactionByHashJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -[procedures/src/eth/EthProcedure.ts:151](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L151) +[packages/procedures/src/eth/EthProcedure.ts:151](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L151) diff --git a/packages/procedures/docs/type-aliases/EthGetTransactionByHashJsonRpcRequest.md b/packages/procedures/docs/type-aliases/EthGetTransactionByHashJsonRpcRequest.md index 84a79a7dd1..6ccbfb2db2 100644 --- a/packages/procedures/docs/type-aliases/EthGetTransactionByHashJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/EthGetTransactionByHashJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_getTransactionByHash` procedure ## Defined in -[procedures/src/eth/EthJsonRpcRequest.ts:177](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L177) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:185](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L185) diff --git a/packages/procedures/docs/type-aliases/EthGetTransactionByHashJsonRpcResponse.md b/packages/procedures/docs/type-aliases/EthGetTransactionByHashJsonRpcResponse.md index 7d1ee27f4a..5f980d64e1 100644 --- a/packages/procedures/docs/type-aliases/EthGetTransactionByHashJsonRpcResponse.md +++ b/packages/procedures/docs/type-aliases/EthGetTransactionByHashJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_getTransactionByHash` procedure ## Defined in -[procedures/src/eth/EthJsonRpcResponse.ts:172](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L172) +[packages/procedures/src/eth/EthJsonRpcResponse.ts:172](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L172) diff --git a/packages/procedures/docs/type-aliases/EthGetTransactionCountJsonRpcProcedure.md b/packages/procedures/docs/type-aliases/EthGetTransactionCountJsonRpcProcedure.md index 700faed4d3..2bcdf3816b 100644 --- a/packages/procedures/docs/type-aliases/EthGetTransactionCountJsonRpcProcedure.md +++ b/packages/procedures/docs/type-aliases/EthGetTransactionCountJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -[procedures/src/eth/EthProcedure.ts:139](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L139) +[packages/procedures/src/eth/EthProcedure.ts:139](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L139) diff --git a/packages/procedures/docs/type-aliases/EthGetTransactionCountJsonRpcRequest.md b/packages/procedures/docs/type-aliases/EthGetTransactionCountJsonRpcRequest.md index e77b1e6218..712b653580 100644 --- a/packages/procedures/docs/type-aliases/EthGetTransactionCountJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/EthGetTransactionCountJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_getTransactionCount` procedure ## Defined in -[procedures/src/eth/EthJsonRpcRequest.ts:153](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L153) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:161](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L161) diff --git a/packages/procedures/docs/type-aliases/EthGetTransactionCountJsonRpcResponse.md b/packages/procedures/docs/type-aliases/EthGetTransactionCountJsonRpcResponse.md index 05494014fb..06f3dd2ab1 100644 --- a/packages/procedures/docs/type-aliases/EthGetTransactionCountJsonRpcResponse.md +++ b/packages/procedures/docs/type-aliases/EthGetTransactionCountJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_getTransactionCount` procedure ## Defined in -[procedures/src/eth/EthJsonRpcResponse.ts:146](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L146) +[packages/procedures/src/eth/EthJsonRpcResponse.ts:146](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L146) diff --git a/packages/procedures/docs/type-aliases/EthGetTransactionReceiptJsonRpcProcedure.md b/packages/procedures/docs/type-aliases/EthGetTransactionReceiptJsonRpcProcedure.md index 505b7aa96e..012973b910 100644 --- a/packages/procedures/docs/type-aliases/EthGetTransactionReceiptJsonRpcProcedure.md +++ b/packages/procedures/docs/type-aliases/EthGetTransactionReceiptJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -[procedures/src/eth/EthProcedure.ts:163](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L163) +[packages/procedures/src/eth/EthProcedure.ts:163](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L163) diff --git a/packages/procedures/docs/type-aliases/EthGetTransactionReceiptJsonRpcRequest.md b/packages/procedures/docs/type-aliases/EthGetTransactionReceiptJsonRpcRequest.md index 38abed8a19..fb677d593d 100644 --- a/packages/procedures/docs/type-aliases/EthGetTransactionReceiptJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/EthGetTransactionReceiptJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_getTransactionReceipt` procedure ## Defined in -[procedures/src/eth/EthJsonRpcRequest.ts:198](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L198) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:206](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L206) diff --git a/packages/procedures/docs/type-aliases/EthGetTransactionReceiptJsonRpcResponse.md b/packages/procedures/docs/type-aliases/EthGetTransactionReceiptJsonRpcResponse.md index af8a03e005..76b8eba87f 100644 --- a/packages/procedures/docs/type-aliases/EthGetTransactionReceiptJsonRpcResponse.md +++ b/packages/procedures/docs/type-aliases/EthGetTransactionReceiptJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_getTransactionReceipt` procedure ## Defined in -[procedures/src/eth/EthJsonRpcResponse.ts:202](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L202) +[packages/procedures/src/eth/EthJsonRpcResponse.ts:202](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L202) diff --git a/packages/procedures/docs/type-aliases/EthGetUncleByBlockHashAndIndexJsonRpcProcedure.md b/packages/procedures/docs/type-aliases/EthGetUncleByBlockHashAndIndexJsonRpcProcedure.md index 3352568b88..da91c2c151 100644 --- a/packages/procedures/docs/type-aliases/EthGetUncleByBlockHashAndIndexJsonRpcProcedure.md +++ b/packages/procedures/docs/type-aliases/EthGetUncleByBlockHashAndIndexJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -[procedures/src/eth/EthProcedure.ts:167](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L167) +[packages/procedures/src/eth/EthProcedure.ts:167](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L167) diff --git a/packages/procedures/docs/type-aliases/EthGetUncleByBlockHashAndIndexJsonRpcRequest.md b/packages/procedures/docs/type-aliases/EthGetUncleByBlockHashAndIndexJsonRpcRequest.md index fc369c64bb..01308ce077 100644 --- a/packages/procedures/docs/type-aliases/EthGetUncleByBlockHashAndIndexJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/EthGetUncleByBlockHashAndIndexJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_getUncleByBlockHashAndIndex` procedure ## Defined in -[procedures/src/eth/EthJsonRpcRequest.ts:203](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L203) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:211](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L211) diff --git a/packages/procedures/docs/type-aliases/EthGetUncleByBlockHashAndIndexJsonRpcResponse.md b/packages/procedures/docs/type-aliases/EthGetUncleByBlockHashAndIndexJsonRpcResponse.md index 4143a47b1f..56d3930e5f 100644 --- a/packages/procedures/docs/type-aliases/EthGetUncleByBlockHashAndIndexJsonRpcResponse.md +++ b/packages/procedures/docs/type-aliases/EthGetUncleByBlockHashAndIndexJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_getUncleByBlockHashAndIndex` procedure ## Defined in -[procedures/src/eth/EthJsonRpcResponse.ts:212](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L212) +[packages/procedures/src/eth/EthJsonRpcResponse.ts:212](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L212) diff --git a/packages/procedures/docs/type-aliases/EthGetUncleByBlockNumberAndIndexJsonRpcProcedure.md b/packages/procedures/docs/type-aliases/EthGetUncleByBlockNumberAndIndexJsonRpcProcedure.md index 1d8004c72f..a1e1448e6b 100644 --- a/packages/procedures/docs/type-aliases/EthGetUncleByBlockNumberAndIndexJsonRpcProcedure.md +++ b/packages/procedures/docs/type-aliases/EthGetUncleByBlockNumberAndIndexJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -[procedures/src/eth/EthProcedure.ts:171](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L171) +[packages/procedures/src/eth/EthProcedure.ts:171](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L171) diff --git a/packages/procedures/docs/type-aliases/EthGetUncleByBlockNumberAndIndexJsonRpcRequest.md b/packages/procedures/docs/type-aliases/EthGetUncleByBlockNumberAndIndexJsonRpcRequest.md index 291d4f1bcf..776408a9c2 100644 --- a/packages/procedures/docs/type-aliases/EthGetUncleByBlockNumberAndIndexJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/EthGetUncleByBlockNumberAndIndexJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_getUncleByBlockNumberAndIndex` procedure ## Defined in -[procedures/src/eth/EthJsonRpcRequest.ts:211](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L211) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:219](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L219) diff --git a/packages/procedures/docs/type-aliases/EthGetUncleByBlockNumberAndIndexJsonRpcResponse.md b/packages/procedures/docs/type-aliases/EthGetUncleByBlockNumberAndIndexJsonRpcResponse.md index 1cd4f0b18c..cc4d92897a 100644 --- a/packages/procedures/docs/type-aliases/EthGetUncleByBlockNumberAndIndexJsonRpcResponse.md +++ b/packages/procedures/docs/type-aliases/EthGetUncleByBlockNumberAndIndexJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_getUncleByBlockNumberAndIndex` procedure ## Defined in -[procedures/src/eth/EthJsonRpcResponse.ts:222](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L222) +[packages/procedures/src/eth/EthJsonRpcResponse.ts:222](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L222) diff --git a/packages/procedures/docs/type-aliases/EthGetUncleCountByBlockHashJsonRpcProcedure.md b/packages/procedures/docs/type-aliases/EthGetUncleCountByBlockHashJsonRpcProcedure.md index 4304a1c347..757f9cbc47 100644 --- a/packages/procedures/docs/type-aliases/EthGetUncleCountByBlockHashJsonRpcProcedure.md +++ b/packages/procedures/docs/type-aliases/EthGetUncleCountByBlockHashJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -[procedures/src/eth/EthProcedure.ts:143](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L143) +[packages/procedures/src/eth/EthProcedure.ts:143](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L143) diff --git a/packages/procedures/docs/type-aliases/EthGetUncleCountByBlockHashJsonRpcRequest.md b/packages/procedures/docs/type-aliases/EthGetUncleCountByBlockHashJsonRpcRequest.md index 60d0c00702..8925fa8883 100644 --- a/packages/procedures/docs/type-aliases/EthGetUncleCountByBlockHashJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/EthGetUncleCountByBlockHashJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_getUncleCountByBlockHash` procedure ## Defined in -[procedures/src/eth/EthJsonRpcRequest.ts:161](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L161) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:169](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L169) diff --git a/packages/procedures/docs/type-aliases/EthGetUncleCountByBlockHashJsonRpcResponse.md b/packages/procedures/docs/type-aliases/EthGetUncleCountByBlockHashJsonRpcResponse.md index b7968ac12b..9e92c06173 100644 --- a/packages/procedures/docs/type-aliases/EthGetUncleCountByBlockHashJsonRpcResponse.md +++ b/packages/procedures/docs/type-aliases/EthGetUncleCountByBlockHashJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_getUncleCountByBlockHash` procedure ## Defined in -[procedures/src/eth/EthJsonRpcResponse.ts:152](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L152) +[packages/procedures/src/eth/EthJsonRpcResponse.ts:152](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L152) diff --git a/packages/procedures/docs/type-aliases/EthGetUncleCountByBlockNumberJsonRpcProcedure.md b/packages/procedures/docs/type-aliases/EthGetUncleCountByBlockNumberJsonRpcProcedure.md index 50bbca25a9..66633d5462 100644 --- a/packages/procedures/docs/type-aliases/EthGetUncleCountByBlockNumberJsonRpcProcedure.md +++ b/packages/procedures/docs/type-aliases/EthGetUncleCountByBlockNumberJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -[procedures/src/eth/EthProcedure.ts:147](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L147) +[packages/procedures/src/eth/EthProcedure.ts:147](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L147) diff --git a/packages/procedures/docs/type-aliases/EthGetUncleCountByBlockNumberJsonRpcRequest.md b/packages/procedures/docs/type-aliases/EthGetUncleCountByBlockNumberJsonRpcRequest.md index 3dafc757d9..6cd698ba9e 100644 --- a/packages/procedures/docs/type-aliases/EthGetUncleCountByBlockNumberJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/EthGetUncleCountByBlockNumberJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_getUncleCountByBlockNumber` procedure ## Defined in -[procedures/src/eth/EthJsonRpcRequest.ts:169](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L169) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:177](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L177) diff --git a/packages/procedures/docs/type-aliases/EthGetUncleCountByBlockNumberJsonRpcResponse.md b/packages/procedures/docs/type-aliases/EthGetUncleCountByBlockNumberJsonRpcResponse.md index 1a29e8d2d9..8f9d04ae63 100644 --- a/packages/procedures/docs/type-aliases/EthGetUncleCountByBlockNumberJsonRpcResponse.md +++ b/packages/procedures/docs/type-aliases/EthGetUncleCountByBlockNumberJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_getUncleCountByBlockNumber` procedure ## Defined in -[procedures/src/eth/EthJsonRpcResponse.ts:162](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L162) +[packages/procedures/src/eth/EthJsonRpcResponse.ts:162](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L162) diff --git a/packages/procedures/docs/type-aliases/EthHashrateJsonRpcProcedure.md b/packages/procedures/docs/type-aliases/EthHashrateJsonRpcProcedure.md index 2b88a6d222..81187c984d 100644 --- a/packages/procedures/docs/type-aliases/EthHashrateJsonRpcProcedure.md +++ b/packages/procedures/docs/type-aliases/EthHashrateJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -[procedures/src/eth/EthProcedure.ts:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L99) +[packages/procedures/src/eth/EthProcedure.ts:99](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L99) diff --git a/packages/procedures/docs/type-aliases/EthHashrateJsonRpcRequest.md b/packages/procedures/docs/type-aliases/EthHashrateJsonRpcRequest.md index cd8e26ce34..b5a5da2897 100644 --- a/packages/procedures/docs/type-aliases/EthHashrateJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/EthHashrateJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_hashrate` procedure ## Defined in -[procedures/src/eth/EthJsonRpcRequest.ts:78](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L78) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:86](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L86) diff --git a/packages/procedures/docs/type-aliases/EthHashrateJsonRpcResponse.md b/packages/procedures/docs/type-aliases/EthHashrateJsonRpcResponse.md index cbdb33e3ea..5a80df947e 100644 --- a/packages/procedures/docs/type-aliases/EthHashrateJsonRpcResponse.md +++ b/packages/procedures/docs/type-aliases/EthHashrateJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_hashrate` procedure ## Defined in -[procedures/src/eth/EthJsonRpcResponse.ts:54](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L54) +[packages/procedures/src/eth/EthJsonRpcResponse.ts:54](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L54) diff --git a/packages/procedures/docs/type-aliases/EthJsonRpcRequest.md b/packages/procedures/docs/type-aliases/EthJsonRpcRequest.md index 1604c35ea7..dc9887ea5a 100644 --- a/packages/procedures/docs/type-aliases/EthJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/EthJsonRpcRequest.md @@ -10,4 +10,4 @@ ## Defined in -[procedures/src/eth/EthJsonRpcRequest.ts:288](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L288) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:296](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L296) diff --git a/packages/procedures/docs/type-aliases/EthMiningJsonRpcProcedure.md b/packages/procedures/docs/type-aliases/EthMiningJsonRpcProcedure.md index 046b5ea303..8769fc1b5d 100644 --- a/packages/procedures/docs/type-aliases/EthMiningJsonRpcProcedure.md +++ b/packages/procedures/docs/type-aliases/EthMiningJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -[procedures/src/eth/EthProcedure.ts:175](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L175) +[packages/procedures/src/eth/EthProcedure.ts:175](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L175) diff --git a/packages/procedures/docs/type-aliases/EthMiningJsonRpcRequest.md b/packages/procedures/docs/type-aliases/EthMiningJsonRpcRequest.md index 2f20abc6b1..4a3e6951a4 100644 --- a/packages/procedures/docs/type-aliases/EthMiningJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/EthMiningJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_mining` procedure ## Defined in -[procedures/src/eth/EthJsonRpcRequest.ts:219](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L219) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:227](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L227) diff --git a/packages/procedures/docs/type-aliases/EthMiningJsonRpcResponse.md b/packages/procedures/docs/type-aliases/EthMiningJsonRpcResponse.md index 540a950451..fc4d9b39b9 100644 --- a/packages/procedures/docs/type-aliases/EthMiningJsonRpcResponse.md +++ b/packages/procedures/docs/type-aliases/EthMiningJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_mining` procedure ## Defined in -[procedures/src/eth/EthJsonRpcResponse.ts:232](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L232) +[packages/procedures/src/eth/EthJsonRpcResponse.ts:232](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L232) diff --git a/packages/procedures/docs/type-aliases/EthNewBlockFilterJsonRpcProcedure.md b/packages/procedures/docs/type-aliases/EthNewBlockFilterJsonRpcProcedure.md index 4666547093..1b5f5ccdc9 100644 --- a/packages/procedures/docs/type-aliases/EthNewBlockFilterJsonRpcProcedure.md +++ b/packages/procedures/docs/type-aliases/EthNewBlockFilterJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -[procedures/src/eth/EthProcedure.ts:199](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L199) +[packages/procedures/src/eth/EthProcedure.ts:199](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L199) diff --git a/packages/procedures/docs/type-aliases/EthNewBlockFilterJsonRpcRequest.md b/packages/procedures/docs/type-aliases/EthNewBlockFilterJsonRpcRequest.md index c43438a2d8..d586dafa81 100644 --- a/packages/procedures/docs/type-aliases/EthNewBlockFilterJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/EthNewBlockFilterJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_newBlockFilter` procedure ## Defined in -[procedures/src/eth/EthJsonRpcRequest.ts:273](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L273) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:281](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L281) diff --git a/packages/procedures/docs/type-aliases/EthNewBlockFilterJsonRpcResponse.md b/packages/procedures/docs/type-aliases/EthNewBlockFilterJsonRpcResponse.md index 6858488be8..aae16b6777 100644 --- a/packages/procedures/docs/type-aliases/EthNewBlockFilterJsonRpcResponse.md +++ b/packages/procedures/docs/type-aliases/EthNewBlockFilterJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_newBlockFilter` procedure ## Defined in -[procedures/src/eth/EthJsonRpcResponse.ts:303](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L303) +[packages/procedures/src/eth/EthJsonRpcResponse.ts:303](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L303) diff --git a/packages/procedures/docs/type-aliases/EthNewFilterJsonRpcProcedure.md b/packages/procedures/docs/type-aliases/EthNewFilterJsonRpcProcedure.md index f01f4d3822..79d61bd7d4 100644 --- a/packages/procedures/docs/type-aliases/EthNewFilterJsonRpcProcedure.md +++ b/packages/procedures/docs/type-aliases/EthNewFilterJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -[procedures/src/eth/EthProcedure.ts:197](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L197) +[packages/procedures/src/eth/EthProcedure.ts:197](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L197) diff --git a/packages/procedures/docs/type-aliases/EthNewFilterJsonRpcRequest.md b/packages/procedures/docs/type-aliases/EthNewFilterJsonRpcRequest.md index 1ebdc8067d..850926db3b 100644 --- a/packages/procedures/docs/type-aliases/EthNewFilterJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/EthNewFilterJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_newFilter` procedure ## Defined in -[procedures/src/eth/EthJsonRpcRequest.ts:268](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L268) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:276](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L276) diff --git a/packages/procedures/docs/type-aliases/EthNewFilterJsonRpcResponse.md b/packages/procedures/docs/type-aliases/EthNewFilterJsonRpcResponse.md index 0187dee670..40bbc278d5 100644 --- a/packages/procedures/docs/type-aliases/EthNewFilterJsonRpcResponse.md +++ b/packages/procedures/docs/type-aliases/EthNewFilterJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_newFilter` procedure ## Defined in -[procedures/src/eth/EthJsonRpcResponse.ts:297](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L297) +[packages/procedures/src/eth/EthJsonRpcResponse.ts:297](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L297) diff --git a/packages/procedures/docs/type-aliases/EthNewPendingTransactionFilterJsonRpcProcedure.md b/packages/procedures/docs/type-aliases/EthNewPendingTransactionFilterJsonRpcProcedure.md index 783154a79f..0a6f71b188 100644 --- a/packages/procedures/docs/type-aliases/EthNewPendingTransactionFilterJsonRpcProcedure.md +++ b/packages/procedures/docs/type-aliases/EthNewPendingTransactionFilterJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -[procedures/src/eth/EthProcedure.ts:203](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L203) +[packages/procedures/src/eth/EthProcedure.ts:203](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L203) diff --git a/packages/procedures/docs/type-aliases/EthNewPendingTransactionFilterJsonRpcRequest.md b/packages/procedures/docs/type-aliases/EthNewPendingTransactionFilterJsonRpcRequest.md index 3d4cd85b43..9682e91829 100644 --- a/packages/procedures/docs/type-aliases/EthNewPendingTransactionFilterJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/EthNewPendingTransactionFilterJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_newPendingTransactionFilter` procedure ## Defined in -[procedures/src/eth/EthJsonRpcRequest.ts:278](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L278) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:286](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L286) diff --git a/packages/procedures/docs/type-aliases/EthNewPendingTransactionFilterJsonRpcResponse.md b/packages/procedures/docs/type-aliases/EthNewPendingTransactionFilterJsonRpcResponse.md index 4a022d5a1c..3bc5290145 100644 --- a/packages/procedures/docs/type-aliases/EthNewPendingTransactionFilterJsonRpcResponse.md +++ b/packages/procedures/docs/type-aliases/EthNewPendingTransactionFilterJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_newPendingTransactionFilter` procedure ## Defined in -[procedures/src/eth/EthJsonRpcResponse.ts:314](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L314) +[packages/procedures/src/eth/EthJsonRpcResponse.ts:314](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L314) diff --git a/packages/procedures/docs/type-aliases/EthProtocolVersionJsonRpcProcedure.md b/packages/procedures/docs/type-aliases/EthProtocolVersionJsonRpcProcedure.md index 96c228e126..d9b2d404be 100644 --- a/packages/procedures/docs/type-aliases/EthProtocolVersionJsonRpcProcedure.md +++ b/packages/procedures/docs/type-aliases/EthProtocolVersionJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -[procedures/src/eth/EthProcedure.ts:177](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L177) +[packages/procedures/src/eth/EthProcedure.ts:177](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L177) diff --git a/packages/procedures/docs/type-aliases/EthProtocolVersionJsonRpcRequest.md b/packages/procedures/docs/type-aliases/EthProtocolVersionJsonRpcRequest.md index 91c35db27b..8427d6f681 100644 --- a/packages/procedures/docs/type-aliases/EthProtocolVersionJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/EthProtocolVersionJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_protocolVersion` procedure ## Defined in -[procedures/src/eth/EthJsonRpcRequest.ts:224](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L224) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:232](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L232) diff --git a/packages/procedures/docs/type-aliases/EthProtocolVersionJsonRpcResponse.md b/packages/procedures/docs/type-aliases/EthProtocolVersionJsonRpcResponse.md index d3a077f4ce..cec1380f11 100644 --- a/packages/procedures/docs/type-aliases/EthProtocolVersionJsonRpcResponse.md +++ b/packages/procedures/docs/type-aliases/EthProtocolVersionJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_protocolVersion` procedure ## Defined in -[procedures/src/eth/EthJsonRpcResponse.ts:238](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L238) +[packages/procedures/src/eth/EthJsonRpcResponse.ts:238](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L238) diff --git a/packages/procedures/docs/type-aliases/EthRequestType.md b/packages/procedures/docs/type-aliases/EthRequestType.md index 629c911ef5..41a56d8572 100644 --- a/packages/procedures/docs/type-aliases/EthRequestType.md +++ b/packages/procedures/docs/type-aliases/EthRequestType.md @@ -166,4 +166,4 @@ A mapping of `eth_*` method names to their request type ## Defined in -[procedures/src/tevm-request-handler/EthRequestType.ts:45](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/tevm-request-handler/EthRequestType.ts#L45) +[packages/procedures/src/tevm-request-handler/EthRequestType.ts:45](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/tevm-request-handler/EthRequestType.ts#L45) diff --git a/packages/procedures/docs/type-aliases/EthReturnType.md b/packages/procedures/docs/type-aliases/EthReturnType.md index 88cc6053ec..e7a1ef9890 100644 --- a/packages/procedures/docs/type-aliases/EthReturnType.md +++ b/packages/procedures/docs/type-aliases/EthReturnType.md @@ -166,4 +166,4 @@ A mapping of `eth_*` method names to their return type ## Defined in -[procedures/src/tevm-request-handler/EthReturnType.ts:45](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/tevm-request-handler/EthReturnType.ts#L45) +[packages/procedures/src/tevm-request-handler/EthReturnType.ts:45](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/tevm-request-handler/EthReturnType.ts#L45) diff --git a/packages/procedures/docs/type-aliases/EthSendRawTransactionJsonRpcProcedure.md b/packages/procedures/docs/type-aliases/EthSendRawTransactionJsonRpcProcedure.md index e9e075b1e3..d1b2db3c34 100644 --- a/packages/procedures/docs/type-aliases/EthSendRawTransactionJsonRpcProcedure.md +++ b/packages/procedures/docs/type-aliases/EthSendRawTransactionJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -[procedures/src/eth/EthProcedure.ts:181](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L181) +[packages/procedures/src/eth/EthProcedure.ts:181](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L181) diff --git a/packages/procedures/docs/type-aliases/EthSendRawTransactionJsonRpcRequest.md b/packages/procedures/docs/type-aliases/EthSendRawTransactionJsonRpcRequest.md index 4be1f29458..132bfa0880 100644 --- a/packages/procedures/docs/type-aliases/EthSendRawTransactionJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/EthSendRawTransactionJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_sendRawTransaction` procedure ## Defined in -[procedures/src/eth/EthJsonRpcRequest.ts:229](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L229) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:237](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L237) diff --git a/packages/procedures/docs/type-aliases/EthSendRawTransactionJsonRpcResponse.md b/packages/procedures/docs/type-aliases/EthSendRawTransactionJsonRpcResponse.md index 12ef71fbdb..4da03cc46c 100644 --- a/packages/procedures/docs/type-aliases/EthSendRawTransactionJsonRpcResponse.md +++ b/packages/procedures/docs/type-aliases/EthSendRawTransactionJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_sendRawTransaction` procedure ## Defined in -[procedures/src/eth/EthJsonRpcResponse.ts:244](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L244) +[packages/procedures/src/eth/EthJsonRpcResponse.ts:244](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L244) diff --git a/packages/procedures/docs/type-aliases/EthSendTransactionJsonRpcProcedure.md b/packages/procedures/docs/type-aliases/EthSendTransactionJsonRpcProcedure.md index 62e700d965..eeb202b2d9 100644 --- a/packages/procedures/docs/type-aliases/EthSendTransactionJsonRpcProcedure.md +++ b/packages/procedures/docs/type-aliases/EthSendTransactionJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -[procedures/src/eth/EthProcedure.ts:185](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L185) +[packages/procedures/src/eth/EthProcedure.ts:185](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L185) diff --git a/packages/procedures/docs/type-aliases/EthSendTransactionJsonRpcRequest.md b/packages/procedures/docs/type-aliases/EthSendTransactionJsonRpcRequest.md index 461fc81699..cd8e7058ae 100644 --- a/packages/procedures/docs/type-aliases/EthSendTransactionJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/EthSendTransactionJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_sendTransaction` procedure ## Defined in -[procedures/src/eth/EthJsonRpcRequest.ts:234](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L234) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:242](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L242) diff --git a/packages/procedures/docs/type-aliases/EthSendTransactionJsonRpcResponse.md b/packages/procedures/docs/type-aliases/EthSendTransactionJsonRpcResponse.md index 121297fd92..1f46dcb28e 100644 --- a/packages/procedures/docs/type-aliases/EthSendTransactionJsonRpcResponse.md +++ b/packages/procedures/docs/type-aliases/EthSendTransactionJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_sendTransaction` procedure ## Defined in -[procedures/src/eth/EthJsonRpcResponse.ts:250](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L250) +[packages/procedures/src/eth/EthJsonRpcResponse.ts:250](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L250) diff --git a/packages/procedures/docs/type-aliases/EthSignJsonRpcProcedure.md b/packages/procedures/docs/type-aliases/EthSignJsonRpcProcedure.md index 66f680b7e5..ef8d4f85d7 100644 --- a/packages/procedures/docs/type-aliases/EthSignJsonRpcProcedure.md +++ b/packages/procedures/docs/type-aliases/EthSignJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -[procedures/src/eth/EthProcedure.ts:189](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L189) +[packages/procedures/src/eth/EthProcedure.ts:189](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L189) diff --git a/packages/procedures/docs/type-aliases/EthSignJsonRpcRequest.md b/packages/procedures/docs/type-aliases/EthSignJsonRpcRequest.md index 3b64e94e32..c870d9d0fe 100644 --- a/packages/procedures/docs/type-aliases/EthSignJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/EthSignJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_sign` procedure ## Defined in -[procedures/src/eth/EthJsonRpcRequest.ts:239](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L239) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:247](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L247) diff --git a/packages/procedures/docs/type-aliases/EthSignJsonRpcResponse.md b/packages/procedures/docs/type-aliases/EthSignJsonRpcResponse.md index 5412d15547..008cf0ef8a 100644 --- a/packages/procedures/docs/type-aliases/EthSignJsonRpcResponse.md +++ b/packages/procedures/docs/type-aliases/EthSignJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_sign` procedure ## Defined in -[procedures/src/eth/EthJsonRpcResponse.ts:256](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L256) +[packages/procedures/src/eth/EthJsonRpcResponse.ts:256](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L256) diff --git a/packages/procedures/docs/type-aliases/EthSignTransactionJsonRpcProcedure.md b/packages/procedures/docs/type-aliases/EthSignTransactionJsonRpcProcedure.md index 559a430aab..1eb3e48467 100644 --- a/packages/procedures/docs/type-aliases/EthSignTransactionJsonRpcProcedure.md +++ b/packages/procedures/docs/type-aliases/EthSignTransactionJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -[procedures/src/eth/EthProcedure.ts:191](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L191) +[packages/procedures/src/eth/EthProcedure.ts:191](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L191) diff --git a/packages/procedures/docs/type-aliases/EthSignTransactionJsonRpcRequest.md b/packages/procedures/docs/type-aliases/EthSignTransactionJsonRpcRequest.md index 762aac4d5b..844e318dc5 100644 --- a/packages/procedures/docs/type-aliases/EthSignTransactionJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/EthSignTransactionJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_signTransaction` procedure ## Defined in -[procedures/src/eth/EthJsonRpcRequest.ts:244](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L244) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:252](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L252) diff --git a/packages/procedures/docs/type-aliases/EthSignTransactionJsonRpcResponse.md b/packages/procedures/docs/type-aliases/EthSignTransactionJsonRpcResponse.md index fc103a38eb..97cbc09772 100644 --- a/packages/procedures/docs/type-aliases/EthSignTransactionJsonRpcResponse.md +++ b/packages/procedures/docs/type-aliases/EthSignTransactionJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_signTransaction` procedure ## Defined in -[procedures/src/eth/EthJsonRpcResponse.ts:262](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L262) +[packages/procedures/src/eth/EthJsonRpcResponse.ts:262](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L262) diff --git a/packages/procedures/docs/type-aliases/EthSyncingJsonRpcProcedure.md b/packages/procedures/docs/type-aliases/EthSyncingJsonRpcProcedure.md index 2c687a42fe..82cecb4b3c 100644 --- a/packages/procedures/docs/type-aliases/EthSyncingJsonRpcProcedure.md +++ b/packages/procedures/docs/type-aliases/EthSyncingJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -[procedures/src/eth/EthProcedure.ts:195](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L195) +[packages/procedures/src/eth/EthProcedure.ts:195](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L195) diff --git a/packages/procedures/docs/type-aliases/EthSyncingJsonRpcRequest.md b/packages/procedures/docs/type-aliases/EthSyncingJsonRpcRequest.md index 8afedf6b79..5c0bc31b9b 100644 --- a/packages/procedures/docs/type-aliases/EthSyncingJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/EthSyncingJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_syncing` procedure ## Defined in -[procedures/src/eth/EthJsonRpcRequest.ts:263](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L263) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:271](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L271) diff --git a/packages/procedures/docs/type-aliases/EthSyncingJsonRpcResponse.md b/packages/procedures/docs/type-aliases/EthSyncingJsonRpcResponse.md index df76f4685e..7ab23827e3 100644 --- a/packages/procedures/docs/type-aliases/EthSyncingJsonRpcResponse.md +++ b/packages/procedures/docs/type-aliases/EthSyncingJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_syncing` procedure ## Defined in -[procedures/src/eth/EthJsonRpcResponse.ts:268](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L268) +[packages/procedures/src/eth/EthJsonRpcResponse.ts:268](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L268) diff --git a/packages/procedures/docs/type-aliases/EthUninstallFilterJsonRpcProcedure.md b/packages/procedures/docs/type-aliases/EthUninstallFilterJsonRpcProcedure.md index b050a6969a..fc980719c7 100644 --- a/packages/procedures/docs/type-aliases/EthUninstallFilterJsonRpcProcedure.md +++ b/packages/procedures/docs/type-aliases/EthUninstallFilterJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -[procedures/src/eth/EthProcedure.ts:207](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L207) +[packages/procedures/src/eth/EthProcedure.ts:207](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthProcedure.ts#L207) diff --git a/packages/procedures/docs/type-aliases/EthUninstallFilterJsonRpcRequest.md b/packages/procedures/docs/type-aliases/EthUninstallFilterJsonRpcRequest.md index 9f627eedc2..8bae52164f 100644 --- a/packages/procedures/docs/type-aliases/EthUninstallFilterJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/EthUninstallFilterJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_uninstallFilter` procedure ## Defined in -[procedures/src/eth/EthJsonRpcRequest.ts:286](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L286) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:294](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L294) diff --git a/packages/procedures/docs/type-aliases/EthUninstallFilterJsonRpcResponse.md b/packages/procedures/docs/type-aliases/EthUninstallFilterJsonRpcResponse.md index c0e84b349c..f1c0e9d2ff 100644 --- a/packages/procedures/docs/type-aliases/EthUninstallFilterJsonRpcResponse.md +++ b/packages/procedures/docs/type-aliases/EthUninstallFilterJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_uninstallFilter` procedure ## Defined in -[procedures/src/eth/EthJsonRpcResponse.ts:325](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L325) +[packages/procedures/src/eth/EthJsonRpcResponse.ts:325](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcResponse.ts#L325) diff --git a/packages/procedures/docs/type-aliases/GetAccountJsonRpcProcedure.md b/packages/procedures/docs/type-aliases/GetAccountJsonRpcProcedure.md index 177aac73a7..e20e5acb87 100644 --- a/packages/procedures/docs/type-aliases/GetAccountJsonRpcProcedure.md +++ b/packages/procedures/docs/type-aliases/GetAccountJsonRpcProcedure.md @@ -20,4 +20,4 @@ GetAccount JSON-RPC tevm procedure puts an account or contract into the tevm sta ## Defined in -[procedures/src/getaccount/GetAccountJsonRpcProcedure.ts:7](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/getaccount/GetAccountJsonRpcProcedure.ts#L7) +[packages/procedures/src/getaccount/GetAccountJsonRpcProcedure.ts:7](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/getaccount/GetAccountJsonRpcProcedure.ts#L7) diff --git a/packages/procedures/docs/type-aliases/GetAccountJsonRpcRequest.md b/packages/procedures/docs/type-aliases/GetAccountJsonRpcRequest.md index 7ddefbac8a..84aa2e226a 100644 --- a/packages/procedures/docs/type-aliases/GetAccountJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/GetAccountJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `tevm_getAccount` method ## Defined in -[procedures/src/getaccount/GetAccountJsonRpcRequest.ts:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/getaccount/GetAccountJsonRpcRequest.ts#L8) +[packages/procedures/src/getaccount/GetAccountJsonRpcRequest.ts:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/getaccount/GetAccountJsonRpcRequest.ts#L8) diff --git a/packages/procedures/docs/type-aliases/GetAccountJsonRpcResponse.md b/packages/procedures/docs/type-aliases/GetAccountJsonRpcResponse.md index 8daeef8e5b..fc2f0d667b 100644 --- a/packages/procedures/docs/type-aliases/GetAccountJsonRpcResponse.md +++ b/packages/procedures/docs/type-aliases/GetAccountJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `tevm_getAccount` method ## Defined in -[procedures/src/getaccount/GetAccountJsonRpcResponse.ts:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/getaccount/GetAccountJsonRpcResponse.ts#L8) +[packages/procedures/src/getaccount/GetAccountJsonRpcResponse.ts:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/getaccount/GetAccountJsonRpcResponse.ts#L8) diff --git a/packages/procedures/docs/type-aliases/JsonRpcRequestTypeFromMethod.md b/packages/procedures/docs/type-aliases/JsonRpcRequestTypeFromMethod.md index 1b57e4890e..bd8a9ddb5d 100644 --- a/packages/procedures/docs/type-aliases/JsonRpcRequestTypeFromMethod.md +++ b/packages/procedures/docs/type-aliases/JsonRpcRequestTypeFromMethod.md @@ -10,16 +10,16 @@ Utility type to get the request type given a method name -## Type Parameters - -• **TMethod** *extends* keyof [`EthRequestType`](EthRequestType.md) \| keyof [`TevmRequestType`](TevmRequestType.md) \| keyof [`AnvilRequestType`](AnvilRequestType.md) \| keyof [`DebugRequestType`](DebugRequestType.md) - ## Example ```typescript type BlockNumberRequestType = JsonRpcRequestTypeFromMethod<'eth_blockNumber'> ``` +## Type Parameters + +• **TMethod** *extends* keyof [`EthRequestType`](EthRequestType.md) \| keyof [`TevmRequestType`](TevmRequestType.md) \| keyof [`AnvilRequestType`](AnvilRequestType.md) \| keyof [`DebugRequestType`](DebugRequestType.md) + ## Defined in -[procedures/src/tevm-request-handler/JsonRpcRequestTypeFromMethod.ts:13](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/tevm-request-handler/JsonRpcRequestTypeFromMethod.ts#L13) +[packages/procedures/src/tevm-request-handler/JsonRpcRequestTypeFromMethod.ts:13](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/tevm-request-handler/JsonRpcRequestTypeFromMethod.ts#L13) diff --git a/packages/procedures/docs/type-aliases/JsonRpcReturnTypeFromMethod.md b/packages/procedures/docs/type-aliases/JsonRpcReturnTypeFromMethod.md index 5156da20ac..207eaf8764 100644 --- a/packages/procedures/docs/type-aliases/JsonRpcReturnTypeFromMethod.md +++ b/packages/procedures/docs/type-aliases/JsonRpcReturnTypeFromMethod.md @@ -10,16 +10,16 @@ Utility type to get the return type given a method name -## Type Parameters - -• **TMethod** *extends* keyof [`EthReturnType`](EthReturnType.md) \| keyof [`TevmReturnType`](TevmReturnType.md) \| keyof [`AnvilReturnType`](AnvilReturnType.md) \| keyof [`DebugReturnType`](DebugReturnType.md) - ## Example ```typescript type BlockNumberReturnType = JsonRpcReturnTypeFromMethod<'eth_blockNumber'> ``` +## Type Parameters + +• **TMethod** *extends* keyof [`EthReturnType`](EthReturnType.md) \| keyof [`TevmReturnType`](TevmReturnType.md) \| keyof [`AnvilReturnType`](AnvilReturnType.md) \| keyof [`DebugReturnType`](DebugReturnType.md) + ## Defined in -[procedures/src/tevm-request-handler/JsonRpcReturnTypeFromMethod.ts:13](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/tevm-request-handler/JsonRpcReturnTypeFromMethod.ts#L13) +[packages/procedures/src/tevm-request-handler/JsonRpcReturnTypeFromMethod.ts:13](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/tevm-request-handler/JsonRpcReturnTypeFromMethod.ts#L13) diff --git a/packages/procedures/docs/type-aliases/JsonRpcTransaction.md b/packages/procedures/docs/type-aliases/JsonRpcTransaction.md index 3da06d25f8..42cbab6852 100644 --- a/packages/procedures/docs/type-aliases/JsonRpcTransaction.md +++ b/packages/procedures/docs/type-aliases/JsonRpcTransaction.md @@ -50,4 +50,4 @@ The integer of value sent with this transaction encoded as hexadecimal ## Defined in -[procedures/src/eth/EthJsonRpcRequest.ts:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L9) +[packages/procedures/src/eth/EthJsonRpcRequest.ts:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/eth/EthJsonRpcRequest.ts#L9) diff --git a/packages/procedures/docs/type-aliases/JsonSerializable.md b/packages/procedures/docs/type-aliases/JsonSerializable.md index 95c733fb29..4d2b6d888c 100644 --- a/packages/procedures/docs/type-aliases/JsonSerializable.md +++ b/packages/procedures/docs/type-aliases/JsonSerializable.md @@ -10,4 +10,4 @@ ## Defined in -[procedures/src/utils/SerializeToJson.ts:4](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/utils/SerializeToJson.ts#L4) +[packages/procedures/src/utils/SerializeToJson.ts:4](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/utils/SerializeToJson.ts#L4) diff --git a/packages/procedures/docs/type-aliases/JsonSerializableArray.md b/packages/procedures/docs/type-aliases/JsonSerializableArray.md index 96d0039e43..83dd37099d 100644 --- a/packages/procedures/docs/type-aliases/JsonSerializableArray.md +++ b/packages/procedures/docs/type-aliases/JsonSerializableArray.md @@ -10,4 +10,4 @@ ## Defined in -[procedures/src/utils/SerializeToJson.ts:14](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/utils/SerializeToJson.ts#L14) +[packages/procedures/src/utils/SerializeToJson.ts:14](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/utils/SerializeToJson.ts#L14) diff --git a/packages/procedures/docs/type-aliases/JsonSerializableObject.md b/packages/procedures/docs/type-aliases/JsonSerializableObject.md index 63c8c0d42a..3881141b94 100644 --- a/packages/procedures/docs/type-aliases/JsonSerializableObject.md +++ b/packages/procedures/docs/type-aliases/JsonSerializableObject.md @@ -14,4 +14,4 @@ ## Defined in -[procedures/src/utils/SerializeToJson.ts:15](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/utils/SerializeToJson.ts#L15) +[packages/procedures/src/utils/SerializeToJson.ts:15](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/utils/SerializeToJson.ts#L15) diff --git a/packages/procedures/docs/type-aliases/JsonSerializableSet.md b/packages/procedures/docs/type-aliases/JsonSerializableSet.md index e66c259abe..aa9d7eeff5 100644 --- a/packages/procedures/docs/type-aliases/JsonSerializableSet.md +++ b/packages/procedures/docs/type-aliases/JsonSerializableSet.md @@ -14,4 +14,4 @@ ## Defined in -[procedures/src/utils/SerializeToJson.ts:16](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/utils/SerializeToJson.ts#L16) +[packages/procedures/src/utils/SerializeToJson.ts:16](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/utils/SerializeToJson.ts#L16) diff --git a/packages/procedures/docs/type-aliases/LoadStateJsonRpcProcedure.md b/packages/procedures/docs/type-aliases/LoadStateJsonRpcProcedure.md index 0895edaa5d..c526fa15bd 100644 --- a/packages/procedures/docs/type-aliases/LoadStateJsonRpcProcedure.md +++ b/packages/procedures/docs/type-aliases/LoadStateJsonRpcProcedure.md @@ -20,4 +20,4 @@ jsonrpc error response if there are errors otherwise it returns a successful emp ## Defined in -[procedures/src/loadstate/LoadStateJsonRpcProcedure.ts:17](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/loadstate/LoadStateJsonRpcProcedure.ts#L17) +[packages/procedures/src/loadstate/LoadStateJsonRpcProcedure.ts:17](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/loadstate/LoadStateJsonRpcProcedure.ts#L17) diff --git a/packages/procedures/docs/type-aliases/LoadStateJsonRpcRequest.md b/packages/procedures/docs/type-aliases/LoadStateJsonRpcRequest.md index 3f8cab3258..6435bc0175 100644 --- a/packages/procedures/docs/type-aliases/LoadStateJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/LoadStateJsonRpcRequest.md @@ -12,4 +12,4 @@ The JSON-RPC request for the `tevm_loadState` method ## Defined in -[procedures/src/loadstate/LoadStateJsonRpcRequest.ts:15](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/loadstate/LoadStateJsonRpcRequest.ts#L15) +[packages/procedures/src/loadstate/LoadStateJsonRpcRequest.ts:15](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/loadstate/LoadStateJsonRpcRequest.ts#L15) diff --git a/packages/procedures/docs/type-aliases/LoadStateJsonRpcResponse.md b/packages/procedures/docs/type-aliases/LoadStateJsonRpcResponse.md index 98ee783a20..e40437bd70 100644 --- a/packages/procedures/docs/type-aliases/LoadStateJsonRpcResponse.md +++ b/packages/procedures/docs/type-aliases/LoadStateJsonRpcResponse.md @@ -12,4 +12,4 @@ Response of the `tevm_loadState` RPC method. ## Defined in -[procedures/src/loadstate/LoadStateJsonRpcResponse.ts:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/loadstate/LoadStateJsonRpcResponse.ts#L8) +[packages/procedures/src/loadstate/LoadStateJsonRpcResponse.ts:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/loadstate/LoadStateJsonRpcResponse.ts#L8) diff --git a/packages/procedures/docs/type-aliases/MineJsonRpcProcedure.md b/packages/procedures/docs/type-aliases/MineJsonRpcProcedure.md index 534362514d..043b9222bf 100644 --- a/packages/procedures/docs/type-aliases/MineJsonRpcProcedure.md +++ b/packages/procedures/docs/type-aliases/MineJsonRpcProcedure.md @@ -20,4 +20,4 @@ Mine JSON-RPC tevm procedure mines 1 or more blocks ## Defined in -[procedures/src/mine/MineJsonRpcProcedure.ts:7](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/mine/MineJsonRpcProcedure.ts#L7) +[packages/procedures/src/mine/MineJsonRpcProcedure.ts:7](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/mine/MineJsonRpcProcedure.ts#L7) diff --git a/packages/procedures/docs/type-aliases/MineJsonRpcRequest.md b/packages/procedures/docs/type-aliases/MineJsonRpcRequest.md index 960c302a06..6a2d817784 100644 --- a/packages/procedures/docs/type-aliases/MineJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/MineJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `tevm_mine` method ## Defined in -[procedures/src/mine/MineJsonRpcRequest.ts:7](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/mine/MineJsonRpcRequest.ts#L7) +[packages/procedures/src/mine/MineJsonRpcRequest.ts:7](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/mine/MineJsonRpcRequest.ts#L7) diff --git a/packages/procedures/docs/type-aliases/MineJsonRpcResponse.md b/packages/procedures/docs/type-aliases/MineJsonRpcResponse.md index 05df4b36f0..7f5741cde9 100644 --- a/packages/procedures/docs/type-aliases/MineJsonRpcResponse.md +++ b/packages/procedures/docs/type-aliases/MineJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `tevm_mine` method ## Defined in -[procedures/src/mine/MineJsonRpcResponse.ts:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/mine/MineJsonRpcResponse.ts#L9) +[packages/procedures/src/mine/MineJsonRpcResponse.ts:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/mine/MineJsonRpcResponse.ts#L9) diff --git a/packages/procedures/docs/type-aliases/ScriptJsonRpcProcedure.md b/packages/procedures/docs/type-aliases/ScriptJsonRpcProcedure.md index badcad5531..8fcffe39e5 100644 --- a/packages/procedures/docs/type-aliases/ScriptJsonRpcProcedure.md +++ b/packages/procedures/docs/type-aliases/ScriptJsonRpcProcedure.md @@ -8,6 +8,11 @@ > **ScriptJsonRpcProcedure**: (`request`) => `Promise`\<[`ScriptJsonRpcResponse`](ScriptJsonRpcResponse.md)\> +## Deprecated + +Use CallJsonRpcProcedure instead +Procedure for handling script JSON-RPC requests + ## Parameters • **request**: [`ScriptJsonRpcRequest`](ScriptJsonRpcRequest.md) @@ -16,11 +21,6 @@ `Promise`\<[`ScriptJsonRpcResponse`](ScriptJsonRpcResponse.md)\> -## Deprecated - -Use CallJsonRpcProcedure instead -Procedure for handling script JSON-RPC requests - ## Defined in -[procedures/src/script/ScriptJsonRpcProcedure.ts:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/script/ScriptJsonRpcProcedure.ts#L8) +[packages/procedures/src/script/ScriptJsonRpcProcedure.ts:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/script/ScriptJsonRpcProcedure.ts#L8) diff --git a/packages/procedures/docs/type-aliases/ScriptJsonRpcRequest.md b/packages/procedures/docs/type-aliases/ScriptJsonRpcRequest.md index 56d806ddfe..5d87f51a37 100644 --- a/packages/procedures/docs/type-aliases/ScriptJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/ScriptJsonRpcRequest.md @@ -15,4 +15,4 @@ The JSON-RPC request for the `tevm_script` method ## Defined in -[procedures/src/script/ScriptJsonRpcRequest.ts:10](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/script/ScriptJsonRpcRequest.ts#L10) +[packages/procedures/src/script/ScriptJsonRpcRequest.ts:10](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/script/ScriptJsonRpcRequest.ts#L10) diff --git a/packages/procedures/docs/type-aliases/ScriptJsonRpcResponse.md b/packages/procedures/docs/type-aliases/ScriptJsonRpcResponse.md index b79ac40353..24ca94118f 100644 --- a/packages/procedures/docs/type-aliases/ScriptJsonRpcResponse.md +++ b/packages/procedures/docs/type-aliases/ScriptJsonRpcResponse.md @@ -31,4 +31,4 @@ const respose: ScriptJsonRpcResponse = await tevm.request({ ## Defined in -[procedures/src/script/ScriptJsonRpcResponse.ts:21](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/script/ScriptJsonRpcResponse.ts#L21) +[packages/procedures/src/script/ScriptJsonRpcResponse.ts:21](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/script/ScriptJsonRpcResponse.ts#L21) diff --git a/packages/procedures/docs/type-aliases/SerializeToJson.md b/packages/procedures/docs/type-aliases/SerializeToJson.md index 835e2b2ebc..0b3304e3e0 100644 --- a/packages/procedures/docs/type-aliases/SerializeToJson.md +++ b/packages/procedures/docs/type-aliases/SerializeToJson.md @@ -14,4 +14,4 @@ ## Defined in -[procedures/src/utils/SerializeToJson.ts:22](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/utils/SerializeToJson.ts#L22) +[packages/procedures/src/utils/SerializeToJson.ts:22](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/utils/SerializeToJson.ts#L22) diff --git a/packages/procedures/docs/type-aliases/SerializedParams.md b/packages/procedures/docs/type-aliases/SerializedParams.md index e09992f55e..97f356e79c 100644 --- a/packages/procedures/docs/type-aliases/SerializedParams.md +++ b/packages/procedures/docs/type-aliases/SerializedParams.md @@ -18,4 +18,4 @@ The parameters for the `tevm_loadState` method ## Defined in -[procedures/src/loadstate/LoadStateJsonRpcRequest.ts:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/loadstate/LoadStateJsonRpcRequest.ts#L8) +[packages/procedures/src/loadstate/LoadStateJsonRpcRequest.ts:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/loadstate/LoadStateJsonRpcRequest.ts#L8) diff --git a/packages/procedures/docs/type-aliases/SetAccountJsonRpcProcedure.md b/packages/procedures/docs/type-aliases/SetAccountJsonRpcProcedure.md index 17f5c3dd9b..5a06a86e24 100644 --- a/packages/procedures/docs/type-aliases/SetAccountJsonRpcProcedure.md +++ b/packages/procedures/docs/type-aliases/SetAccountJsonRpcProcedure.md @@ -20,4 +20,4 @@ SetAccount JSON-RPC tevm procedure sets an account into the tevm state ## Defined in -[procedures/src/setaccount/SetAccountJsonRpcProcedure.ts:7](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/setaccount/SetAccountJsonRpcProcedure.ts#L7) +[packages/procedures/src/setaccount/SetAccountJsonRpcProcedure.ts:7](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/setaccount/SetAccountJsonRpcProcedure.ts#L7) diff --git a/packages/procedures/docs/type-aliases/SetAccountJsonRpcRequest.md b/packages/procedures/docs/type-aliases/SetAccountJsonRpcRequest.md index bbab7e0796..b7f94901f4 100644 --- a/packages/procedures/docs/type-aliases/SetAccountJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/SetAccountJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `tevm_setAccount` method ## Defined in -[procedures/src/setaccount/SetAccountJsonRpcRequest.ts:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/setaccount/SetAccountJsonRpcRequest.ts#L8) +[packages/procedures/src/setaccount/SetAccountJsonRpcRequest.ts:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/setaccount/SetAccountJsonRpcRequest.ts#L8) diff --git a/packages/procedures/docs/type-aliases/SetAccountJsonRpcResponse.md b/packages/procedures/docs/type-aliases/SetAccountJsonRpcResponse.md index 981a364d0f..5fad734c1a 100644 --- a/packages/procedures/docs/type-aliases/SetAccountJsonRpcResponse.md +++ b/packages/procedures/docs/type-aliases/SetAccountJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `tevm_setAccount` method ## Defined in -[procedures/src/setaccount/SetAccountJsonRpcResponse.ts:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/setaccount/SetAccountJsonRpcResponse.ts#L8) +[packages/procedures/src/setaccount/SetAccountJsonRpcResponse.ts:8](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/setaccount/SetAccountJsonRpcResponse.ts#L8) diff --git a/packages/procedures/docs/type-aliases/SetToHex.md b/packages/procedures/docs/type-aliases/SetToHex.md index 7ff92fc939..6ce9aecd47 100644 --- a/packages/procedures/docs/type-aliases/SetToHex.md +++ b/packages/procedures/docs/type-aliases/SetToHex.md @@ -14,4 +14,4 @@ ## Defined in -[procedures/src/utils/SerializeToJson.ts:20](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/utils/SerializeToJson.ts#L20) +[packages/procedures/src/utils/SerializeToJson.ts:20](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/utils/SerializeToJson.ts#L20) diff --git a/packages/procedures/docs/type-aliases/TevmJsonRpcBulkRequestHandler.md b/packages/procedures/docs/type-aliases/TevmJsonRpcBulkRequestHandler.md index 7812c42091..9bc08b2415 100644 --- a/packages/procedures/docs/type-aliases/TevmJsonRpcBulkRequestHandler.md +++ b/packages/procedures/docs/type-aliases/TevmJsonRpcBulkRequestHandler.md @@ -15,14 +15,6 @@ will be added in the future. Currently is not very generic with regard to input and output types. -## Parameters - -• **requests**: `ReadonlyArray`\<[`TevmJsonRpcRequest`](TevmJsonRpcRequest.md) \| [`EthJsonRpcRequest`](EthJsonRpcRequest.md) \| [`AnvilJsonRpcRequest`](AnvilJsonRpcRequest.md) \| [`DebugJsonRpcRequest`](DebugJsonRpcRequest.md)\> - -## Returns - -`Promise`\<[`JsonRpcReturnTypeFromMethod`](JsonRpcReturnTypeFromMethod.md)\<`any`\>[]\> - ## Example ```typescript @@ -95,6 +87,14 @@ response - [EthGasPriceJsonRpcResponse](EthGasPriceJsonRpcResponse.md) request - [EthGetBalanceJsonRpcRequest](EthGetBalanceJsonRpcRequest.md) response - [EthGetBalanceJsonRpcResponse](EthGetBalanceJsonRpcResponse.md) +## Parameters + +• **requests**: `ReadonlyArray`\<[`TevmJsonRpcRequest`](TevmJsonRpcRequest.md) \| [`EthJsonRpcRequest`](EthJsonRpcRequest.md) \| [`AnvilJsonRpcRequest`](AnvilJsonRpcRequest.md) \| [`DebugJsonRpcRequest`](DebugJsonRpcRequest.md)\> + +## Returns + +`Promise`\<[`JsonRpcReturnTypeFromMethod`](JsonRpcReturnTypeFromMethod.md)\<`any`\>[]\> + ## Defined in -[procedures/src/tevm-request-handler/TevmJsonRpcBulkRequestHandler.ts:94](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/tevm-request-handler/TevmJsonRpcBulkRequestHandler.ts#L94) +[packages/procedures/src/tevm-request-handler/TevmJsonRpcBulkRequestHandler.ts:94](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/tevm-request-handler/TevmJsonRpcBulkRequestHandler.ts#L94) diff --git a/packages/procedures/docs/type-aliases/TevmJsonRpcRequest.md b/packages/procedures/docs/type-aliases/TevmJsonRpcRequest.md index c215836e1d..789ba1134d 100644 --- a/packages/procedures/docs/type-aliases/TevmJsonRpcRequest.md +++ b/packages/procedures/docs/type-aliases/TevmJsonRpcRequest.md @@ -13,4 +13,4 @@ A Tevm JSON-RPC request ## Defined in -[procedures/src/TevmJsonRpcRequest.ts:13](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/TevmJsonRpcRequest.ts#L13) +[packages/procedures/src/TevmJsonRpcRequest.ts:13](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/TevmJsonRpcRequest.ts#L13) diff --git a/packages/procedures/docs/type-aliases/TevmJsonRpcRequestHandler.md b/packages/procedures/docs/type-aliases/TevmJsonRpcRequestHandler.md index 4e58e8fa27..01fc31a167 100644 --- a/packages/procedures/docs/type-aliases/TevmJsonRpcRequestHandler.md +++ b/packages/procedures/docs/type-aliases/TevmJsonRpcRequestHandler.md @@ -11,18 +11,6 @@ Typesafe request handler for JSON-RPC requests. Most users will want to use the higher level and more feature-rich `actions` api -## Type Parameters - -• **TRequest** *extends* [`TevmJsonRpcRequest`](TevmJsonRpcRequest.md) \| [`EthJsonRpcRequest`](EthJsonRpcRequest.md) \| [`AnvilJsonRpcRequest`](AnvilJsonRpcRequest.md) \| [`DebugJsonRpcRequest`](DebugJsonRpcRequest.md) - -## Parameters - -• **request**: `TRequest` - -## Returns - -`Promise`\<[`JsonRpcReturnTypeFromMethod`](JsonRpcReturnTypeFromMethod.md)\<`TRequest`\[`"method"`\]\>\> - ## Example ```typescript @@ -96,6 +84,18 @@ response - [EthGasPriceJsonRpcResponse](EthGasPriceJsonRpcResponse.md) request - [EthGetBalanceJsonRpcRequest](EthGetBalanceJsonRpcRequest.md) response - [EthGetBalanceJsonRpcResponse](EthGetBalanceJsonRpcResponse.md) +## Type Parameters + +• **TRequest** *extends* [`TevmJsonRpcRequest`](TevmJsonRpcRequest.md) \| [`EthJsonRpcRequest`](EthJsonRpcRequest.md) \| [`AnvilJsonRpcRequest`](AnvilJsonRpcRequest.md) \| [`DebugJsonRpcRequest`](DebugJsonRpcRequest.md) + +## Parameters + +• **request**: `TRequest` + +## Returns + +`Promise`\<[`JsonRpcReturnTypeFromMethod`](JsonRpcReturnTypeFromMethod.md)\<`TRequest`\[`"method"`\]\>\> + ## Defined in -[procedures/src/tevm-request-handler/TevmJsonRpcRequestHandler.ts:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/tevm-request-handler/TevmJsonRpcRequestHandler.ts#L90) +[packages/procedures/src/tevm-request-handler/TevmJsonRpcRequestHandler.ts:90](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/tevm-request-handler/TevmJsonRpcRequestHandler.ts#L90) diff --git a/packages/procedures/docs/type-aliases/TevmRequestType.md b/packages/procedures/docs/type-aliases/TevmRequestType.md index 7876dc32f8..8e78a71123 100644 --- a/packages/procedures/docs/type-aliases/TevmRequestType.md +++ b/packages/procedures/docs/type-aliases/TevmRequestType.md @@ -44,4 +44,4 @@ A mapping of `tevm_*` method names to their request type ## Defined in -[procedures/src/tevm-request-handler/TevmRequestType.ts:12](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/tevm-request-handler/TevmRequestType.ts#L12) +[packages/procedures/src/tevm-request-handler/TevmRequestType.ts:12](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/tevm-request-handler/TevmRequestType.ts#L12) diff --git a/packages/procedures/docs/type-aliases/TevmReturnType.md b/packages/procedures/docs/type-aliases/TevmReturnType.md index fba643c885..4f0e679e8f 100644 --- a/packages/procedures/docs/type-aliases/TevmReturnType.md +++ b/packages/procedures/docs/type-aliases/TevmReturnType.md @@ -44,4 +44,4 @@ A mapping of `tevm_*` method names to their return type ## Defined in -[procedures/src/tevm-request-handler/TevmReturnType.ts:12](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/tevm-request-handler/TevmReturnType.ts#L12) +[packages/procedures/src/tevm-request-handler/TevmReturnType.ts:12](https://github.com/evmts/tevm-monorepo/blob/main/packages/procedures/src/tevm-request-handler/TevmReturnType.ts#L12) diff --git a/packages/procedures/package.json b/packages/procedures/package.json index cfafed1d57..799c8d06ce 100644 --- a/packages/procedures/package.json +++ b/packages/procedures/package.json @@ -21,6 +21,7 @@ "contributors": [ "Will Cory " ], + "sideEffects": false, "type": "module", "exports": { "./package.json": "./package.json", @@ -87,6 +88,5 @@ }, "publishConfig": { "access": "public" - }, - "sideEffects": false + } } \ No newline at end of file diff --git a/packages/procedures/src/eth/ethGetTransactionCountProcedure.js b/packages/procedures/src/eth/ethGetTransactionCountProcedure.js index 44ef1b2be6..bdbb647931 100644 --- a/packages/procedures/src/eth/ethGetTransactionCountProcedure.js +++ b/packages/procedures/src/eth/ethGetTransactionCountProcedure.js @@ -55,7 +55,7 @@ export const ethGetTransactionCountProcedure = (node) => { return undefined } const stateCopy = await vm.stateManager.deepCopy() - stateCopy.setStateRoot(block.header.stateRoot) + await stateCopy.setStateRoot(block.header.stateRoot) const account = await stateCopy.getAccount(createAddress(address)) return account?.nonce ?? 0n })() diff --git a/packages/receipt-manager/docs/README.md b/packages/receipt-manager/docs/README.md index 89ec3db302..d16b5f73ca 100644 --- a/packages/receipt-manager/docs/README.md +++ b/packages/receipt-manager/docs/README.md @@ -36,4 +36,4 @@ Some files are adapted from [ethereumjs](https://github.com/ethereumjs/ethereumj ## License 📄 - + diff --git a/packages/receipt-manager/docs/_media/LICENSE b/packages/receipt-manager/docs/_media/LICENSE deleted file mode 100644 index b5a4fa7a69..0000000000 --- a/packages/receipt-manager/docs/_media/LICENSE +++ /dev/null @@ -1,22 +0,0 @@ -(The MIT License) - -Copyright 2020-2022 - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/packages/receipt-manager/docs/functions/createMapDb.md b/packages/receipt-manager/docs/functions/createMapDb.md index ff50474ada..5b139a63d2 100644 --- a/packages/receipt-manager/docs/functions/createMapDb.md +++ b/packages/receipt-manager/docs/functions/createMapDb.md @@ -8,8 +8,6 @@ > **createMapDb**(`options`): [`MapDb`](../type-aliases/MapDb.md) -Creates a {MapDb} which uses an in memory map as it's underlying data structure - ## Parameters • **options**: [`MetaDBManagerOptions`](../interfaces/MetaDBManagerOptions.md) diff --git a/packages/receipt-manager/package.json b/packages/receipt-manager/package.json index 63ca1ce68c..e71fb6b8a3 100644 --- a/packages/receipt-manager/package.json +++ b/packages/receipt-manager/package.json @@ -19,6 +19,7 @@ "contributors": [ "Will Cory " ], + "sideEffects": false, "type": "module", "exports": { "./package.json": "./package.json", @@ -75,6 +76,5 @@ }, "publishConfig": { "access": "public" - }, - "sideEffects": false + } } \ No newline at end of file diff --git a/packages/rlp/docs/README.md b/packages/rlp/docs/README.md index cb0df5df1f..96e78a8b82 100644 --- a/packages/rlp/docs/README.md +++ b/packages/rlp/docs/README.md @@ -36,4 +36,4 @@ Some files are adapted from [ethereumjs](https://github.com/ethereumjs/ethereumj ## License 📄 - + diff --git a/packages/rlp/docs/_media/LICENSE b/packages/rlp/docs/_media/LICENSE deleted file mode 100644 index b5a4fa7a69..0000000000 --- a/packages/rlp/docs/_media/LICENSE +++ /dev/null @@ -1,22 +0,0 @@ -(The MIT License) - -Copyright 2020-2022 - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/packages/rlp/package.json b/packages/rlp/package.json index 6a6334c088..5d1086baa2 100644 --- a/packages/rlp/package.json +++ b/packages/rlp/package.json @@ -19,6 +19,7 @@ "contributors": [ "Will Cory " ], + "sideEffects": false, "type": "module", "exports": { "./package.json": "./package.json", @@ -70,6 +71,5 @@ }, "publishConfig": { "access": "public" - }, - "sideEffects": false + } } \ No newline at end of file diff --git a/packages/server/docs/README.md b/packages/server/docs/README.md index 9745954a11..64aa5b2dcc 100644 --- a/packages/server/docs/README.md +++ b/packages/server/docs/README.md @@ -28,10 +28,10 @@ Creates a JSON RPC server for serving tevm\_ requests from an ethereumjs evm. -- [`createHttpHandler`](_media/createHttpHandler.js) Creates a generic http handler -- [`createServer`](_media/createServer.js) Creates a simple vanilla node.js server to serve TEVM json-rpc api -- [`createExpressMiddleware`](_media/createExpressMiddleware.js) Creates an express middleware to serve TEVM json-rpc api -- [`createNextApiHandler`](./src/adapters/createNextApiHandler.js.js) Creates a next.js handler for tevm. +- [`createHttpHandler`]() Creates a generic http handler +- [`createServer`]() Creates a simple vanilla node.js server to serve TEVM json-rpc api +- [`createExpressMiddleware`]() Creates an express middleware to serve TEVM json-rpc api +- [`createNextApiHandler`]() Creates a next.js handler for tevm. ## Example @@ -84,4 +84,4 @@ This works because all tevm actions are implemented both in memory and as JSON-R ## License 📄 - + diff --git a/packages/server/docs/_media/LICENSE b/packages/server/docs/_media/LICENSE deleted file mode 100644 index b5a4fa7a69..0000000000 --- a/packages/server/docs/_media/LICENSE +++ /dev/null @@ -1,22 +0,0 @@ -(The MIT License) - -Copyright 2020-2022 - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/packages/server/docs/_media/createExpressMiddleware.js b/packages/server/docs/_media/createExpressMiddleware.js deleted file mode 100644 index b02c8ab7c2..0000000000 --- a/packages/server/docs/_media/createExpressMiddleware.js +++ /dev/null @@ -1,39 +0,0 @@ -import { createHttpHandler } from '../createHttpHandler.js' - -/** - * Creates express middleware for a Tevm JSON-RPC server - * @param {import('../Client.js').Client} client - * @returns {import('express').RequestHandler} - * @example - * ```typescript - * import express from 'express' - * import { createExpressMiddleware } from 'tevm/server' - * import { createMemoryClient } from 'tevm' - * - * const tevm = createMemoryClient() - * - * const app = express() - * app.use(express.json()) - * app.use(createExpressMiddleware({ request: tevm.request })) - * app.listen(8080, () => console.log('listening on 8080')) - * ``` - * - * After creating an express server it can be interacted with using any JSON-RPC client - * including viem, ethers or the built in tevm client - * ```typescript - * import { createClient } from 'tevm/client' - * - * const client = createClient({ - * url: 'http://localhost:8080' - * }) - * - * const blockNumber = await client.eth.getBlockNumber() - * const chainId = await client.eth.getChainId() - * ``` - */ -export function createExpressMiddleware(client) { - const handler = createHttpHandler(client) - return async (req, res) => { - handler(req, res) - } -} diff --git a/packages/server/docs/_media/createHttpHandler.js b/packages/server/docs/_media/createHttpHandler.js deleted file mode 100644 index cafce58f3a..0000000000 --- a/packages/server/docs/_media/createHttpHandler.js +++ /dev/null @@ -1,76 +0,0 @@ -import { tevmSend } from '@tevm/decorators' -import { InternalError, InvalidRequestError } from '@tevm/errors' -import { InvalidJsonError } from './errors/InvalidJsonError.js' -import { ReadRequestBodyError } from './errors/ReadRequestBodyError.js' -import { getRequestBody } from './internal/getRequestBody.js' -import { handleBulkRequest } from './internal/handleBulkRequest.js' -import { handleError } from './internal/handleError.js' -import { parseRequest } from './internal/parseRequest.js' - -/** -/** -* Creates a Node.js http handler for handling JSON-RPC requests with Ethereumjs EVM -* Any unimplemented methods will be proxied to the given proxyUrl -* This handler works for any server that supports the Node.js http module -* @param {import('./Client.js').Client} client -* @returns {import('http').RequestListener} -* @throws {never} -* @example -* import { createHttpHandler } from 'tevm/server' -* import { createTevm } from 'tevm' -* import { createServer } from 'http' -* -* const PORT = 8080 -* -* const tevm = createTevm({ -* fork: { -* transport: http('https://mainnet.optimism.io')({}) -* } -* }) -* -* const server = createServer( -* createHttpHandler(tevm) -* ) -* server.listen(PORT, () => console.log({ listening: PORT })) -* -*/ -export const createHttpHandler = (client) => { - /** - * @param {import('http').IncomingMessage} req - * @param {import('http').ServerResponse} res - * @returns {Promise} - */ - return async (req, res) => { - const body = await getRequestBody(req) - if (body instanceof ReadRequestBodyError) { - return handleError(client, body, res) - } - - const parsedRequest = parseRequest(body) - if (parsedRequest instanceof InvalidJsonError || parsedRequest instanceof InvalidRequestError) { - return handleError(client, parsedRequest, res) - } - - if (Array.isArray(parsedRequest)) { - const responses = await handleBulkRequest(client, /** @type {any}*/ (parsedRequest)) - res.writeHead(200, { 'Content-Type': 'application/json' }) - res.end(JSON.stringify(responses)) - return - } - - const response = await client.transport.tevm - .extend(tevmSend()) - .send(/** @type any*/ (parsedRequest)) - .catch((e) => { - return 'code' in e ? e : new InternalError('Unexpeced error', { cause: e }) - }) - - if ('code' in response && 'message' in response) { - return handleError(client, response, res, parsedRequest) - } - - res.writeHead(200, { 'Content-Type': 'application/json' }) - res.end(JSON.stringify(response)) - return - } -} diff --git a/packages/server/docs/_media/createServer.js b/packages/server/docs/_media/createServer.js deleted file mode 100644 index 75a5bd557d..0000000000 --- a/packages/server/docs/_media/createServer.js +++ /dev/null @@ -1,34 +0,0 @@ -import { createServer as httpCreateServer } from 'node:http' -import { createHttpHandler } from './createHttpHandler.js' - -/** - * Creates a lightweight http server for handling requests - * @param {import('@tevm/memory-client').MemoryClient} client - * @param {import('http').ServerOptions} [serverOptions] - Optional options to pass to the http server - * @returns {import('http').Server} - * To use pass in the Tevm['request'] request handler - * @throws {CreateServerError} - * @example - * ```typescript - * import { createMemoryClient } from 'tevm' - * import { createServer } from 'tevm/server' - * - * const tevm = createMemoryClient() - * - * const server = createServer({ - * request: tevm.request, - * }) - * - * server.listen(8080, () => console.log('listening on 8080')) - * ``` - * To interact with the HTTP server you can create a Tevm client - * @example - * ```typescript - * import { createTevmClient } from '@tevm/client' - * - * const client = createTevmClient() - * ``` - */ -export const createServer = (client, serverOptions = {}) => { - return httpCreateServer(serverOptions, createHttpHandler(client)) -} diff --git a/packages/server/docs/classes/InvalidJsonError.md b/packages/server/docs/classes/InvalidJsonError.md index 33f318ebe2..04a601d6de 100644 --- a/packages/server/docs/classes/InvalidJsonError.md +++ b/packages/server/docs/classes/InvalidJsonError.md @@ -79,7 +79,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -93,7 +93,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -109,7 +109,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -123,7 +123,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -139,7 +139,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -171,7 +171,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -201,7 +201,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -229,7 +229,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -239,6 +239,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -249,10 +253,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from `BaseError.prepareStackTrace` @@ -301,7 +301,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -353,7 +353,7 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 #### captureStackTrace(targetObject, constructorOpt) @@ -377,7 +377,7 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@20.12.14/node\_modules/@types/node/globals.d.ts:21 +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 #### captureStackTrace(targetObject, constructorOpt) @@ -402,3 +402,27 @@ Create .stack property on a target object ##### Defined in node\_modules/.pnpm/bun-types@1.1.22/node\_modules/bun-types/globals.d.ts:1629 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +`BaseError.captureStackTrace` + +##### Defined in + +node\_modules/.pnpm/@types+node@20.12.14/node\_modules/@types/node/globals.d.ts:21 diff --git a/packages/server/docs/classes/ReadRequestBodyError.md b/packages/server/docs/classes/ReadRequestBodyError.md index beae8a7af2..628d3105eb 100644 --- a/packages/server/docs/classes/ReadRequestBodyError.md +++ b/packages/server/docs/classes/ReadRequestBodyError.md @@ -66,7 +66,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -80,7 +80,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -96,7 +96,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -110,7 +110,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -126,7 +126,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -158,7 +158,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -188,7 +188,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -216,7 +216,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -226,6 +226,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -236,10 +240,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from `BaseError.prepareStackTrace` @@ -288,7 +288,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -340,7 +340,7 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 #### captureStackTrace(targetObject, constructorOpt) @@ -364,7 +364,7 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@20.12.14/node\_modules/@types/node/globals.d.ts:21 +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 #### captureStackTrace(targetObject, constructorOpt) @@ -389,3 +389,27 @@ Create .stack property on a target object ##### Defined in node\_modules/.pnpm/bun-types@1.1.22/node\_modules/bun-types/globals.d.ts:1629 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +`BaseError.captureStackTrace` + +##### Defined in + +node\_modules/.pnpm/@types+node@20.12.14/node\_modules/@types/node/globals.d.ts:21 diff --git a/packages/server/docs/functions/createHttpHandler.md b/packages/server/docs/functions/createHttpHandler.md index 49a1631839..95b52cebfc 100644 --- a/packages/server/docs/functions/createHttpHandler.md +++ b/packages/server/docs/functions/createHttpHandler.md @@ -8,12 +8,6 @@ > **createHttpHandler**(`client`): `RequestListener`\<*typeof* `IncomingMessage`, *typeof* `ServerResponse`\> -/** -* Creates a Node.js http handler for handling JSON-RPC requests with Ethereumjs EVM -* Any unimplemented methods will be proxied to the given proxyUrl -* This handler works for any server that supports the Node.js http module -* - ## Parameters • **client**: [`Client`](../type-aliases/Client.md) @@ -26,32 +20,6 @@ * -## Throws - -* - -## Example - -```ts -* import { createHttpHandler } from 'tevm/server' -* import { createTevm } from 'tevm' -* import { createServer } from 'http' -* -* const PORT = 8080 -* -* const tevm = createTevm({ -* fork: { -* transport: http('https://mainnet.optimism.io')({}) -* } -* }) -* -* const server = createServer( -* createHttpHandler(tevm) -* ) -* server.listen(PORT, () => console.log({ listening: PORT })) -* -``` - ## Defined in [packages/server/src/createHttpHandler.js:37](https://github.com/evmts/tevm-monorepo/blob/main/packages/server/src/createHttpHandler.js#L37) diff --git a/packages/server/docs/functions/createNextApiHandler.md b/packages/server/docs/functions/createNextApiHandler.md index eaed41a01b..4f1817e2d6 100644 --- a/packages/server/docs/functions/createNextApiHandler.md +++ b/packages/server/docs/functions/createNextApiHandler.md @@ -8,8 +8,6 @@ > **createNextApiHandler**(`client`): `NextApiHandler`\<`any`\> -Creates a Next.js API handler for a Tevm JSON-RPC server - ## Parameters • **client**: [`Client`](../type-aliases/Client.md) @@ -18,16 +16,6 @@ Creates a Next.js API handler for a Tevm JSON-RPC server `NextApiHandler`\<`any`\> -## Example - -```typescript -import { createNextApiHandler } from 'tevm/server' -import { createMemoryClient } from 'tevm' - -const tevm = createMemoryClient() -export default createNextApiHandler({ request: tevm.request }) -``` - ## Defined in [packages/server/src/adapters/createNextApiHandler.js:16](https://github.com/evmts/tevm-monorepo/blob/main/packages/server/src/adapters/createNextApiHandler.js#L16) diff --git a/packages/server/docs/functions/createServer.md b/packages/server/docs/functions/createServer.md index e1eeda92ae..c24e76f6ff 100644 --- a/packages/server/docs/functions/createServer.md +++ b/packages/server/docs/functions/createServer.md @@ -8,8 +8,6 @@ > **createServer**(`client`, `serverOptions`?): `Server`\<*typeof* `IncomingMessage`, *typeof* `ServerResponse`\> -Creates a lightweight http server for handling requests - ## Parameters • **client** @@ -1275,7 +1273,7 @@ A name for the client. Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. -• **client.prepareTransactionRequest?**: \<`TRequest`, `TChainOverride`, `TAccountOverride`\>(`args`) => `Promise`\<\{ \[K in string \| number \| symbol\]: (UnionRequiredBy\ & Object, ParameterTypeToParameters\<(...)\[(...)\] extends readonly (...)\[\] ? (...)\[(...)\] : (...) \| (...) \| (...) \| (...) \| (...) \| (...)\>\> & (unknown extends TRequest\["kzg"\] ? Object : Pick\))\[K\] \}\> & \<`TRequest`, `TChainOverride`, `TAccountOverride`\>(`args`) => `Promise`\<\{ \[K in string \| number \| symbol\]: (UnionRequiredBy\ & Object, ParameterTypeToParameters\<(...)\[(...)\] extends readonly (...)\[\] ? (...)\[(...)\] : (...) \| (...) \| (...) \| (...) \| (...) \| (...)\>\> & (unknown extends TRequest\["kzg"\] ? Object : Pick\))\[K\] \}\> +• **client.prepareTransactionRequest?**: \<`request`, `chainOverride`, `accountOverride`\>(`args`) => `Promise`\<\{ \[K in string \| number \| symbol\]: (UnionRequiredBy\ & Object, ParameterTypeToParameters\<(...)\[(...)\] extends readonly (...)\[\] ? (...)\[(...)\] : (...) \| (...) \| (...) \| (...) \| (...) \| (...)\>\> & (unknown extends request\["kzg"\] ? Object : Pick\))\[K\] \}\> & \<`request`, `chainOverride`, `accountOverride`\>(`args`) => `Promise`\<\{ \[K in string \| number \| symbol\]: (UnionRequiredBy\ & Object, ParameterTypeToParameters\<(...)\[(...)\] extends readonly (...)\[\] ? (...)\[(...)\] : (...) \| (...) \| (...) \| (...) \| (...) \| (...)\>\> & (unknown extends request\["kzg"\] ? Object : Pick\))\[K\] \}\> Prepares a transaction request for signing. @@ -2731,30 +2729,6 @@ Optional options to pass to the http server To use pass in the Tevm['request'] request handler -## Throws - -## Examples - -```typescript -import { createMemoryClient } from 'tevm' -import { createServer } from 'tevm/server' - -const tevm = createMemoryClient() - -const server = createServer({ - request: tevm.request, -}) - -server.listen(8080, () => console.log('listening on 8080')) -``` -To interact with the HTTP server you can create a Tevm client - -```typescript -import { createTevmClient } from '@tevm/client' - -const client = createTevmClient() -``` - ## Defined in [packages/server/src/createServer.js:32](https://github.com/evmts/tevm-monorepo/blob/main/packages/server/src/createServer.js#L32) diff --git a/packages/server/package.json b/packages/server/package.json index 781f1c5abb..7f4e727cba 100644 --- a/packages/server/package.json +++ b/packages/server/package.json @@ -21,6 +21,7 @@ "contributors": [ "Will Cory " ], + "sideEffects": false, "type": "module", "exports": { "./package.json": "./package.json", @@ -86,6 +87,5 @@ }, "publishConfig": { "access": "public" - }, - "sideEffects": false + } } \ No newline at end of file diff --git a/packages/state/docs/README.md b/packages/state/docs/README.md index 222dee394d..488d47be2b 100644 --- a/packages/state/docs/README.md +++ b/packages/state/docs/README.md @@ -36,4 +36,4 @@ Some files are adapted from [ethereumjs](https://github.com/ethereumjs/ethereumj ## License 📄 - + diff --git a/packages/state/docs/_media/LICENSE b/packages/state/docs/_media/LICENSE deleted file mode 100644 index b5a4fa7a69..0000000000 --- a/packages/state/docs/_media/LICENSE +++ /dev/null @@ -1,22 +0,0 @@ -(The MIT License) - -Copyright 2020-2022 - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/packages/state/docs/classes/AccountCache.md b/packages/state/docs/classes/AccountCache.md index f27c8d3514..fae555094d 100644 --- a/packages/state/docs/classes/AccountCache.md +++ b/packages/state/docs/classes/AccountCache.md @@ -30,7 +30,7 @@ #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/account.d.ts:27 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/account.d.ts:27 ## Properties @@ -44,7 +44,7 @@ node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/sta #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/cache.d.ts:4 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/cache.d.ts:4 *** @@ -58,7 +58,7 @@ node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/sta #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/cache.d.ts:3 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/cache.d.ts:3 *** @@ -76,7 +76,7 @@ before. #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/account.d.ts:26 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/account.d.ts:26 *** @@ -86,7 +86,7 @@ node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/sta #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/account.d.ts:15 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/account.d.ts:15 *** @@ -96,7 +96,7 @@ node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/sta #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/account.d.ts:16 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/account.d.ts:16 *** @@ -130,7 +130,7 @@ node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/sta #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/cache.d.ts:5 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/cache.d.ts:5 ## Methods @@ -148,7 +148,7 @@ node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/sta #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/account.d.ts:28 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/account.d.ts:28 *** @@ -165,7 +165,7 @@ later on be reverted or committed. #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/account.d.ts:62 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/account.d.ts:62 *** @@ -181,7 +181,7 @@ Clears cache. #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/account.d.ts:82 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/account.d.ts:82 *** @@ -197,7 +197,7 @@ Commits to current state of cache (no effect on trie). #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/account.d.ts:57 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/account.d.ts:57 *** @@ -219,7 +219,7 @@ Address #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/account.d.ts:44 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/account.d.ts:44 *** @@ -236,7 +236,7 @@ or deleted and resetting the diff cache (at checkpoint height). #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/account.d.ts:49 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/account.d.ts:49 *** @@ -258,13 +258,13 @@ Address of account #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/account.d.ts:39 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/account.d.ts:39 *** ### put() -> **put**(`address`, `account`): `void` +> **put**(`address`, `account`, `couldBeParitalAccount`?): `void` Puts account to cache under its address. @@ -278,13 +278,15 @@ Address of account Account or undefined if account doesn't exist in the trie +• **couldBeParitalAccount?**: `boolean` + #### Returns `void` #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/account.d.ts:34 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/account.d.ts:34 *** @@ -300,7 +302,7 @@ Revert changes to cache last checkpoint (no effect on trie). #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/account.d.ts:53 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/account.d.ts:53 *** @@ -316,7 +318,7 @@ Returns the size of the cache #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/account.d.ts:67 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/account.d.ts:67 *** @@ -356,4 +358,4 @@ Returns a dict with cache stats #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/account.d.ts:72 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/account.d.ts:72 diff --git a/packages/state/docs/classes/StorageCache.md b/packages/state/docs/classes/StorageCache.md index e5c804c8bb..95f461d9b2 100644 --- a/packages/state/docs/classes/StorageCache.md +++ b/packages/state/docs/classes/StorageCache.md @@ -30,7 +30,7 @@ #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:26 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:26 ## Properties @@ -44,7 +44,7 @@ node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/sta #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/cache.d.ts:4 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/cache.d.ts:4 *** @@ -58,7 +58,7 @@ node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/sta #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/cache.d.ts:3 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/cache.d.ts:3 *** @@ -76,7 +76,7 @@ before. #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:25 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:25 *** @@ -86,7 +86,7 @@ node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/sta #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:14 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:14 *** @@ -96,7 +96,7 @@ node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/sta #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:15 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:15 *** @@ -130,7 +130,7 @@ node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/sta #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/cache.d.ts:5 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/cache.d.ts:5 ## Methods @@ -150,7 +150,7 @@ node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/sta #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:27 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:27 *** @@ -167,7 +167,7 @@ later on be reverted or committed. #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:72 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:72 *** @@ -183,7 +183,7 @@ Clears cache. #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:92 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:92 *** @@ -203,7 +203,7 @@ Deletes all storage slots for address from the cache #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:54 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:54 *** @@ -219,7 +219,7 @@ Commits to current state of cache (no effect on trie). #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:67 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:67 *** @@ -245,7 +245,7 @@ Storage key #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:49 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:49 *** @@ -269,7 +269,7 @@ The address of the `account` to return storage for #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:98 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:98 *** @@ -286,7 +286,7 @@ or deleted and resetting the diff cache (at checkpoint height). #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:59 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:59 *** @@ -316,7 +316,7 @@ Storage value or undefined #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:43 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:43 *** @@ -344,7 +344,7 @@ Storage key #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:34 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:34 *** @@ -360,7 +360,7 @@ Revert changes to cache last checkpoint (no effect on trie). #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:63 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:63 *** @@ -376,7 +376,7 @@ Returns the size of the cache #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:77 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:77 *** @@ -416,4 +416,4 @@ Returns a dict with cache stats #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:82 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:82 diff --git a/packages/state/docs/enumerations/CacheType.md b/packages/state/docs/enumerations/CacheType.md index 96ddadb21b..b39188a8b3 100644 --- a/packages/state/docs/enumerations/CacheType.md +++ b/packages/state/docs/enumerations/CacheType.md @@ -14,7 +14,7 @@ #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/types.d.ts:2 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/types.d.ts:2 *** @@ -24,4 +24,4 @@ node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/sta #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/types.d.ts:3 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/types.d.ts:3 diff --git a/packages/state/docs/functions/createBaseState.md b/packages/state/docs/functions/createBaseState.md index 047a8f3cf1..b3f886ef64 100644 --- a/packages/state/docs/functions/createBaseState.md +++ b/packages/state/docs/functions/createBaseState.md @@ -8,8 +8,6 @@ > **createBaseState**(`options`): [`BaseState`](../type-aliases/BaseState.md) -Creates the core data structure for ethereum state - ## Parameters • **options**: [`StateOptions`](../type-aliases/StateOptions.md) diff --git a/packages/state/docs/functions/deepCopy.md b/packages/state/docs/functions/deepCopy.md index 7b64c05cbf..07a9f09a8d 100644 --- a/packages/state/docs/functions/deepCopy.md +++ b/packages/state/docs/functions/deepCopy.md @@ -8,8 +8,6 @@ > **deepCopy**(`baseState`): () => `Promise`\<[`BaseState`](../type-aliases/BaseState.md)\> -Returns a new instance of the ForkStateManager with the same opts and all storage copied over - ## Parameters • **baseState**: [`BaseState`](../type-aliases/BaseState.md) diff --git a/packages/state/docs/functions/getAppliedKey.md b/packages/state/docs/functions/getAppliedKey.md index a1f25394ce..ac03780a44 100644 --- a/packages/state/docs/functions/getAppliedKey.md +++ b/packages/state/docs/functions/getAppliedKey.md @@ -18,11 +18,6 @@ `undefined` \| (`address`) => `Uint8Array` -## Deprecated - -Returns the applied key for a given address -Used for saving preimages - ## Defined in [packages/state/src/actions/getAppliedKey.js:9](https://github.com/evmts/tevm-monorepo/blob/main/packages/state/src/actions/getAppliedKey.js#L9) diff --git a/packages/state/docs/functions/getForkBlockTag.md b/packages/state/docs/functions/getForkBlockTag.md index 51c718cc71..7ae9e525ef 100644 --- a/packages/state/docs/functions/getForkBlockTag.md +++ b/packages/state/docs/functions/getForkBlockTag.md @@ -8,8 +8,6 @@ > **getForkBlockTag**(`baseState`): `undefined` \| `object` \| `object` -If this does not exist an empty `Uint8Array` is returned. - ## Parameters • **baseState**: [`BaseState`](../type-aliases/BaseState.md) diff --git a/packages/state/docs/functions/getForkClient.md b/packages/state/docs/functions/getForkClient.md index 453165a0d7..13b6444fb8 100644 --- a/packages/state/docs/functions/getForkClient.md +++ b/packages/state/docs/functions/getForkClient.md @@ -8,8 +8,6 @@ > **getForkClient**(`baseState`): `object` -Creates a viem public client for the fork - ## Parameters • **baseState**: [`BaseState`](../type-aliases/BaseState.md) @@ -92,63 +90,63 @@ Filter. CreateBlockFilterReturnType ### createContractEventFilter() -> **createContractEventFilter**: \<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>(`args`) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> +> **createContractEventFilter**: \<`abi`, `eventName`, `args`, `strict`, `fromBlock`, `toBlock`\>(`args`) => `Promise`\<`CreateContractEventFilterReturnType`\<`abi`, `eventName`, `args`, `strict`, `fromBlock`, `toBlock`\>\> #### Type Parameters -• **TAbi** *extends* `Abi` \| readonly `unknown`[] +• **abi** *extends* `Abi` \| readonly `unknown`[] -• **TEventName** *extends* `undefined` \| `string` +• **eventName** *extends* `undefined` \| `string` -• **TArgs** *extends* `undefined` \| `Record`\<`string`, `unknown`\> \| readonly `unknown`[] +• **args** *extends* `undefined` \| `Record`\<`string`, `unknown`\> \| readonly `unknown`[] -• **TStrict** *extends* `undefined` \| `boolean` = `undefined` +• **strict** *extends* `undefined` \| `boolean` = `undefined` -• **TFromBlock** *extends* `undefined` \| `bigint` \| `BlockTag` = `undefined` +• **fromBlock** *extends* `undefined` \| `bigint` \| `BlockTag` = `undefined` -• **TToBlock** *extends* `undefined` \| `bigint` \| `BlockTag` = `undefined` +• **toBlock** *extends* `undefined` \| `bigint` \| `BlockTag` = `undefined` #### Parameters -• **args**: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\> +• **args**: `CreateContractEventFilterParameters`\<`abi`, `eventName`, `args`, `strict`, `fromBlock`, `toBlock`\> CreateContractEventFilterParameters #### Returns -`Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> +`Promise`\<`CreateContractEventFilterReturnType`\<`abi`, `eventName`, `args`, `strict`, `fromBlock`, `toBlock`\>\> [`Filter`](https://viem.sh/docs/glossary/types#filter). CreateContractEventFilterReturnType ### createEventFilter() -> **createEventFilter**: \<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>(`args`?) => `Promise`\<\{ \[K in string \| number \| symbol\]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>\[K\] \}\> +> **createEventFilter**: \<`abiEvent`, `abiEvents`, `strict`, `fromBlock`, `toBlock`, `_EventName`, `_Args`\>(`args`?) => `Promise`\<\{ \[K in string \| number \| symbol\]: Filter\<"event", abiEvents, \_EventName, \_Args, strict, fromBlock, toBlock\>\[K\] \}\> #### Type Parameters -• **TAbiEvent** *extends* `undefined` \| `AbiEvent` = `undefined` +• **abiEvent** *extends* `undefined` \| `AbiEvent` = `undefined` -• **TAbiEvents** *extends* `undefined` \| readonly `unknown`[] \| readonly `AbiEvent`[] = `TAbiEvent` *extends* `AbiEvent` ? [`TAbiEvent`\<`TAbiEvent`\>] : `undefined` +• **abiEvents** *extends* `undefined` \| readonly `unknown`[] \| readonly `AbiEvent`[] = `abiEvent` *extends* `AbiEvent` ? [`abiEvent`\<`abiEvent`\>] : `undefined` -• **TStrict** *extends* `undefined` \| `boolean` = `undefined` +• **strict** *extends* `undefined` \| `boolean` = `undefined` -• **TFromBlock** *extends* `undefined` \| `bigint` \| `BlockTag` = `undefined` +• **fromBlock** *extends* `undefined` \| `bigint` \| `BlockTag` = `undefined` -• **TToBlock** *extends* `undefined` \| `bigint` \| `BlockTag` = `undefined` +• **toBlock** *extends* `undefined` \| `bigint` \| `BlockTag` = `undefined` -• **_EventName** *extends* `undefined` \| `string` = `MaybeAbiEventName`\<`TAbiEvent`\> +• **_EventName** *extends* `undefined` \| `string` = `MaybeAbiEventName`\<`abiEvent`\> • **_Args** *extends* `undefined` \| `Record`\<`string`, `unknown`\> \| readonly `unknown`[] = `undefined` #### Parameters -• **args?**: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\> +• **args?**: `CreateEventFilterParameters`\<`abiEvent`, `abiEvents`, `strict`, `fromBlock`, `toBlock`, `_EventName`, `_Args`\> CreateEventFilterParameters #### Returns -`Promise`\<\{ \[K in string \| number \| symbol\]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>\[K\] \}\> +`Promise`\<\{ \[K in string \| number \| symbol\]: Filter\<"event", abiEvents, \_EventName, \_Args, strict, fromBlock, toBlock\>\[K\] \}\> [`Filter`](https://viem.sh/docs/glossary/types#filter). CreateEventFilterReturnType @@ -176,11 +174,11 @@ CreateEventFilterParameters ### estimateContractGas() -> **estimateContractGas**: \<`TChain`, `abi`, `functionName`, `args`\>(`args`) => `Promise`\<`bigint`\> +> **estimateContractGas**: \<`chain`, `abi`, `functionName`, `args`\>(`args`) => `Promise`\<`bigint`\> #### Type Parameters -• **TChain** *extends* `undefined` \| `Chain` +• **chain** *extends* `undefined` \| `Chain` • **abi** *extends* `Abi` \| readonly `unknown`[] @@ -190,7 +188,7 @@ CreateEventFilterParameters #### Parameters -• **args**: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\> +• **args**: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `chain`\> EstimateContractGasParameters @@ -202,21 +200,21 @@ The gas estimate (in wei). EstimateContractGasReturnType ### estimateFeesPerGas() -> **estimateFeesPerGas**: \<`TChainOverride`, `TType`\>(`args`?) => `Promise`\<`EstimateFeesPerGasReturnType`\> +> **estimateFeesPerGas**: \<`chainOverride`, `type`\>(`args`?) => `Promise`\<`EstimateFeesPerGasReturnType`\<`type`\>\> #### Type Parameters -• **TChainOverride** *extends* `undefined` \| `Chain` = `undefined` +• **chainOverride** *extends* `undefined` \| `Chain` = `undefined` -• **TType** *extends* `FeeValuesType` = `"eip1559"` +• **type** *extends* `FeeValuesType` = `"eip1559"` #### Parameters -• **args?**: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`\> +• **args?**: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `chainOverride`, `type`\> #### Returns -`Promise`\<`EstimateFeesPerGasReturnType`\> +`Promise`\<`EstimateFeesPerGasReturnType`\<`type`\>\> An estimate (in wei) for the fees per gas. EstimateFeesPerGasReturnType @@ -238,17 +236,17 @@ The gas estimate (in wei). EstimateGasReturnType ### estimateMaxPriorityFeePerGas() -> **estimateMaxPriorityFeePerGas**: \<`TChainOverride`\>(`args`?) => `Promise`\<`bigint`\> +> **estimateMaxPriorityFeePerGas**: \<`chainOverride`\>(`args`?) => `Promise`\<`bigint`\> #### Type Parameters -• **TChainOverride** *extends* `undefined` \| `Chain` = `undefined` +• **chainOverride** *extends* `undefined` \| `Chain` = `undefined` #### Parameters • **args?** -• **args.chain?**: `null` \| `TChainOverride` +• **args.chain?**: `null` \| `chainOverride` #### Returns @@ -300,17 +298,17 @@ The blob base fee (in wei). GetBlobBaseFeeReturnType ### getBlock() -> **getBlock**: \<`TIncludeTransactions`, `TBlockTag`\>(`args`?) => `Promise`\<`object`\> +> **getBlock**: \<`includeTransactions`, `blockTag`\>(`args`?) => `Promise`\<`object`\> #### Type Parameters -• **TIncludeTransactions** *extends* `boolean` = `false` +• **includeTransactions** *extends* `boolean` = `false` -• **TBlockTag** *extends* `BlockTag` = `"latest"` +• **blockTag** *extends* `BlockTag` = `"latest"` #### Parameters -• **args?**: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\> +• **args?**: `GetBlockParameters`\<`includeTransactions`, `blockTag`\> GetBlockParameters @@ -364,13 +362,13 @@ Total used gas by all transactions in this block ##### hash -> **hash**: `TBlockTag` *extends* `"pending"` ? `null` : \`0x$\{string\}\` +> **hash**: `blockTag` *extends* `"pending"` ? `null` : \`0x$\{string\}\` Block hash or `null` if pending ##### logsBloom -> **logsBloom**: `TBlockTag` *extends* `"pending"` ? `null` : \`0x$\{string\}\` +> **logsBloom**: `blockTag` *extends* `"pending"` ? `null` : \`0x$\{string\}\` Logs bloom filter or `null` if pending @@ -388,13 +386,13 @@ Unique identifier for the block. ##### nonce -> **nonce**: `TBlockTag` *extends* `"pending"` ? `null` : \`0x$\{string\}\` +> **nonce**: `blockTag` *extends* `"pending"` ? `null` : \`0x$\{string\}\` Proof-of-work hash or `null` if pending ##### number -> **number**: `TBlockTag` *extends* `"pending"` ? `null` : `bigint` +> **number**: `blockTag` *extends* `"pending"` ? `null` : `bigint` Block number or `null` if pending @@ -446,7 +444,7 @@ Total difficulty of the chain until this block ##### transactions -> **transactions**: `TIncludeTransactions` *extends* `true` ? (`object` \| `object` \| `object` \| `object`)[] : \`0x$\{string\}\`[] +> **transactions**: `includeTransactions` *extends* `true` ? (`object` \| `object` \| `object` \| `object` \| `object`)[] : \`0x$\{string\}\`[] ##### transactionsRoot @@ -508,6 +506,10 @@ The block transaction count. GetBlockTransactionCountReturnType > **getBytecode**: (`args`) => `Promise`\<`GetCodeReturnType`\> +#### Deprecated + +Use `getCode` instead. + #### Parameters • **args**: `GetCodeParameters` @@ -516,10 +518,6 @@ The block transaction count. GetBlockTransactionCountReturnType `Promise`\<`GetCodeReturnType`\> -#### Deprecated - -Use `getCode` instead. - ### getChainId() > **getChainId**: () => `Promise`\<`number`\> @@ -838,59 +836,59 @@ The gas estimate (in wei). GetFeeHistoryReturnType ### getFilterChanges() -> **getFilterChanges**: \<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>(`args`) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> +> **getFilterChanges**: \<`filterType`, `abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>(`args`) => `Promise`\<`GetFilterChangesReturnType`\<`filterType`, `abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> #### Type Parameters -• **TFilterType** *extends* `FilterType` +• **filterType** *extends* `FilterType` -• **TAbi** *extends* `undefined` \| `Abi` \| readonly `unknown`[] +• **abi** *extends* `undefined` \| `Abi` \| readonly `unknown`[] -• **TEventName** *extends* `undefined` \| `string` +• **eventName** *extends* `undefined` \| `string` -• **TStrict** *extends* `undefined` \| `boolean` = `undefined` +• **strict** *extends* `undefined` \| `boolean` = `undefined` -• **TFromBlock** *extends* `undefined` \| `bigint` \| `BlockTag` = `undefined` +• **fromBlock** *extends* `undefined` \| `bigint` \| `BlockTag` = `undefined` -• **TToBlock** *extends* `undefined` \| `bigint` \| `BlockTag` = `undefined` +• **toBlock** *extends* `undefined` \| `bigint` \| `BlockTag` = `undefined` #### Parameters -• **args**: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\> +• **args**: `GetFilterChangesParameters`\<`filterType`, `abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\> GetFilterChangesParameters #### Returns -`Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> +`Promise`\<`GetFilterChangesReturnType`\<`filterType`, `abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> Logs or hashes. GetFilterChangesReturnType ### getFilterLogs() -> **getFilterLogs**: \<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>(`args`) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> +> **getFilterLogs**: \<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>(`args`) => `Promise`\<`GetFilterLogsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> #### Type Parameters -• **TAbi** *extends* `undefined` \| `Abi` \| readonly `unknown`[] +• **abi** *extends* `undefined` \| `Abi` \| readonly `unknown`[] -• **TEventName** *extends* `undefined` \| `string` +• **eventName** *extends* `undefined` \| `string` -• **TStrict** *extends* `undefined` \| `boolean` = `undefined` +• **strict** *extends* `undefined` \| `boolean` = `undefined` -• **TFromBlock** *extends* `undefined` \| `bigint` \| `BlockTag` = `undefined` +• **fromBlock** *extends* `undefined` \| `bigint` \| `BlockTag` = `undefined` -• **TToBlock** *extends* `undefined` \| `bigint` \| `BlockTag` = `undefined` +• **toBlock** *extends* `undefined` \| `bigint` \| `BlockTag` = `undefined` #### Parameters -• **args**: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\> +• **args**: `GetFilterLogsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\> GetFilterLogsParameters #### Returns -`Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> +`Promise`\<`GetFilterLogsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> A list of event logs. GetFilterLogsReturnType @@ -906,29 +904,29 @@ The gas price (in wei). GetGasPriceReturnType ### getLogs() -> **getLogs**: \<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>(`args`?) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> +> **getLogs**: \<`abiEvent`, `abiEvents`, `strict`, `fromBlock`, `toBlock`\>(`args`?) => `Promise`\<`GetLogsReturnType`\<`abiEvent`, `abiEvents`, `strict`, `fromBlock`, `toBlock`\>\> #### Type Parameters -• **TAbiEvent** *extends* `undefined` \| `AbiEvent` = `undefined` +• **abiEvent** *extends* `undefined` \| `AbiEvent` = `undefined` -• **TAbiEvents** *extends* `undefined` \| readonly `unknown`[] \| readonly `AbiEvent`[] = `TAbiEvent` *extends* `AbiEvent` ? [`TAbiEvent`\<`TAbiEvent`\>] : `undefined` +• **abiEvents** *extends* `undefined` \| readonly `unknown`[] \| readonly `AbiEvent`[] = `abiEvent` *extends* `AbiEvent` ? [`abiEvent`\<`abiEvent`\>] : `undefined` -• **TStrict** *extends* `undefined` \| `boolean` = `undefined` +• **strict** *extends* `undefined` \| `boolean` = `undefined` -• **TFromBlock** *extends* `undefined` \| `bigint` \| `BlockTag` = `undefined` +• **fromBlock** *extends* `undefined` \| `bigint` \| `BlockTag` = `undefined` -• **TToBlock** *extends* `undefined` \| `bigint` \| `BlockTag` = `undefined` +• **toBlock** *extends* `undefined` \| `bigint` \| `BlockTag` = `undefined` #### Parameters -• **args?**: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\> +• **args?**: `GetLogsParameters`\<`abiEvent`, `abiEvents`, `strict`, `fromBlock`, `toBlock`\> GetLogsParameters #### Returns -`Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> +`Promise`\<`GetLogsReturnType`\<`abiEvent`, `abiEvents`, `strict`, `fromBlock`, `toBlock`\>\> A list of event logs. GetLogsReturnType @@ -964,21 +962,21 @@ The value of the storage slot. GetStorageAtReturnType ### getTransaction() -> **getTransaction**: \<`TBlockTag`\>(`args`) => `Promise`\<`object` \| `object` \| `object` \| `object`\> +> **getTransaction**: \<`blockTag`\>(`args`) => `Promise`\<`object` \| `object` \| `object` \| `object` \| `object`\> #### Type Parameters -• **TBlockTag** *extends* `BlockTag` = `"latest"` +• **blockTag** *extends* `BlockTag` = `"latest"` #### Parameters -• **args**: `GetTransactionParameters`\<`TBlockTag`\> +• **args**: `GetTransactionParameters`\<`blockTag`\> GetTransactionParameters #### Returns -`Promise`\<`object` \| `object` \| `object` \| `object`\> +`Promise`\<`object` \| `object` \| `object` \| `object` \| `object`\> The transaction information. GetTransactionReturnType @@ -1072,25 +1070,25 @@ Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 millis ### prepareTransactionRequest() -> **prepareTransactionRequest**: \<`TRequest`, `TChainOverride`, `TAccountOverride`\>(`args`) => `Promise`\<\{ \[K in string \| number \| symbol\]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest\["kzg"\] ? Object : Pick\))\[K\] \}\> +> **prepareTransactionRequest**: \<`request`, `chainOverride`, `accountOverride`\>(`args`) => `Promise`\<\{ \[K in string \| number \| symbol\]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends request\["kzg"\] ? Object : Pick\))\[K\] \}\> #### Type Parameters -• **TRequest** *extends* `Omit`\<`object`, `"from"`\> \| `Omit`\<`object`, `"from"`\> \| `Omit`\<`object`, `"from"`\> \| `Omit`\<`object`, `"from"`\> & `object` & `object` +• **request** *extends* `Omit`\<`object`, `"from"`\> \| `Omit`\<`object`, `"from"`\> \| `Omit`\<`object`, `"from"`\> \| `Omit`\<`object`, `"from"`\> \| `Omit`\<`object`, `"from"`\> & `object` & `object` -• **TChainOverride** *extends* `undefined` \| `Chain` = `undefined` +• **chainOverride** *extends* `undefined` \| `Chain` = `undefined` -• **TAccountOverride** *extends* `undefined` \| \`0x$\{string\}\` \| `Account` = `undefined` +• **accountOverride** *extends* `undefined` \| \`0x$\{string\}\` \| `Account` = `undefined` #### Parameters -• **args**: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`\> +• **args**: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`, `request`\> PrepareTransactionRequestParameters #### Returns -`Promise`\<\{ \[K in string \| number \| symbol\]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends TRequest\["kzg"\] ? Object : Pick\))\[K\] \}\> +`Promise`\<\{ \[K in string \| number \| symbol\]: (UnionRequiredBy\ & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)\> extends true ? unknown : ExactPartial\<(...)\>\> & Object, ParameterTypeToParameters\\> & (unknown extends request\["kzg"\] ? Object : Pick\))\[K\] \}\> The transaction request. PrepareTransactionRequestReturnType @@ -1226,6 +1224,10 @@ The balance of the account at a block tag. 'latest' ``` +• **args.factory?**: \`0x$\{string\}\` + +• **args.factoryData?**: \`0x$\{string\}\` + • **args.message**: `SignableMessage` The message to be verified. @@ -1350,17 +1352,17 @@ A function that can be invoked to stop watching for new block numbers. WatchBloc ### watchBlocks() -> **watchBlocks**: \<`TIncludeTransactions`, `TBlockTag`\>(`args`) => `WatchBlocksReturnType` +> **watchBlocks**: \<`includeTransactions`, `blockTag`\>(`args`) => `WatchBlocksReturnType` #### Type Parameters -• **TIncludeTransactions** *extends* `boolean` = `false` +• **includeTransactions** *extends* `boolean` = `false` -• **TBlockTag** *extends* `BlockTag` = `"latest"` +• **blockTag** *extends* `BlockTag` = `"latest"` #### Parameters -• **args**: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`\> +• **args**: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `includeTransactions`, `blockTag`\> WatchBlocksParameters @@ -1372,19 +1374,19 @@ A function that can be invoked to stop watching for new block numbers. WatchBloc ### watchContractEvent() -> **watchContractEvent**: \<`TAbi`, `TEventName`, `TStrict`\>(`args`) => `WatchContractEventReturnType` +> **watchContractEvent**: \<`abi`, `eventName`, `strict`\>(`args`) => `WatchContractEventReturnType` #### Type Parameters -• **TAbi** *extends* `Abi` \| readonly `unknown`[] +• **abi** *extends* `Abi` \| readonly `unknown`[] -• **TEventName** *extends* `string` +• **eventName** *extends* `string` -• **TStrict** *extends* `undefined` \| `boolean` = `undefined` +• **strict** *extends* `undefined` \| `boolean` = `undefined` #### Parameters -• **args**: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`\> +• **args**: `WatchContractEventParameters`\<`abi`, `eventName`, `strict`, `Transport`\> WatchContractEventParameters @@ -1396,19 +1398,19 @@ A function that can be invoked to stop watching for new event logs. WatchContrac ### watchEvent() -> **watchEvent**: \<`TAbiEvent`, `TAbiEvents`, `TStrict`\>(`args`) => `WatchEventReturnType` +> **watchEvent**: \<`abiEvent`, `abiEvents`, `strict`\>(`args`) => `WatchEventReturnType` #### Type Parameters -• **TAbiEvent** *extends* `undefined` \| `AbiEvent` = `undefined` +• **abiEvent** *extends* `undefined` \| `AbiEvent` = `undefined` -• **TAbiEvents** *extends* `undefined` \| readonly `unknown`[] \| readonly `AbiEvent`[] = `TAbiEvent` *extends* `AbiEvent` ? [`TAbiEvent`\<`TAbiEvent`\>] : `undefined` +• **abiEvents** *extends* `undefined` \| readonly `unknown`[] \| readonly `AbiEvent`[] = `abiEvent` *extends* `AbiEvent` ? [`abiEvent`\<`abiEvent`\>] : `undefined` -• **TStrict** *extends* `undefined` \| `boolean` = `undefined` +• **strict** *extends* `undefined` \| `boolean` = `undefined` #### Parameters -• **args**: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`\> +• **args**: `WatchEventParameters`\<`abiEvent`, `abiEvents`, `strict`, `Transport`\> WatchEventParameters diff --git a/packages/state/docs/functions/shallowCopy.md b/packages/state/docs/functions/shallowCopy.md index 2b13e1eea0..c4e6841624 100644 --- a/packages/state/docs/functions/shallowCopy.md +++ b/packages/state/docs/functions/shallowCopy.md @@ -8,8 +8,6 @@ > **shallowCopy**(`baseState`): () => [`BaseState`](../type-aliases/BaseState.md) -Returns a new instance of the ForkStateManager with the same opts but no storage copied over - ## Parameters • **baseState**: [`BaseState`](../type-aliases/BaseState.md) diff --git a/packages/state/docs/interfaces/StateManager.md b/packages/state/docs/interfaces/StateManager.md index 69c671ade3..54ff985a78 100644 --- a/packages/state/docs/interfaces/StateManager.md +++ b/packages/state/docs/interfaces/StateManager.md @@ -68,7 +68,7 @@ Returns contract addresses #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:73 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:136 *** @@ -86,6 +86,30 @@ node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/di ## Methods +### checkChunkWitnessPresent()? + +> `optional` **checkChunkWitnessPresent**(`contract`, `programCounter`): `Promise`\<`boolean`\> + +#### Parameters + +• **contract**: `Address` + +• **programCounter**: `number` + +#### Returns + +`Promise`\<`boolean`\> + +#### Inherited from + +`EvmStateManagerInterface.checkChunkWitnessPresent` + +#### Defined in + +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:133 + +*** + ### checkpoint() > **checkpoint**(): `Promise`\<`void`\> @@ -100,7 +124,7 @@ node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/di #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:62 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:124 *** @@ -138,7 +162,7 @@ Resets all internal caches #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:61 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:123 *** @@ -206,7 +230,7 @@ Returns a new instance of the ForkStateManager with the same opts and all storag #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:55 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:116 *** @@ -244,7 +268,7 @@ Dumps the state of the state manager as a [TevmState](../type-aliases/TevmState. #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:77 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:140 *** @@ -270,7 +294,7 @@ node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/di #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:78 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:141 *** @@ -292,7 +316,7 @@ node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/di #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:79 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:142 *** @@ -314,7 +338,7 @@ node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/di #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:53 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:114 *** @@ -336,7 +360,7 @@ node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/di #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:70 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:132 *** @@ -358,7 +382,29 @@ node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/di #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:58 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:119 + +*** + +### getContractCodeSize()? + +> `optional` **getContractCodeSize**(`address`): `Promise`\<`number`\> + +#### Parameters + +• **address**: `Address` + +#### Returns + +`Promise`\<`number`\> + +#### Inherited from + +`EvmStateManagerInterface.getContractCodeSize` + +#### Defined in + +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:120 *** @@ -382,7 +428,7 @@ node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/di #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:59 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:121 *** @@ -406,7 +452,7 @@ node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/di #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:80 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:143 *** @@ -424,7 +470,7 @@ node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/di #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:65 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:127 *** @@ -446,7 +492,7 @@ node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/di #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:68 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:130 *** @@ -470,7 +516,7 @@ node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/di #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:56 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:117 *** @@ -494,7 +540,7 @@ node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/di #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:54 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:115 *** @@ -518,7 +564,7 @@ node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/di #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:57 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:118 *** @@ -544,7 +590,7 @@ node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/di #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:60 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:122 *** @@ -562,7 +608,7 @@ node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/di #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:64 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:126 *** @@ -611,7 +657,7 @@ THis API is considered unstable #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:66 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:128 *** @@ -633,4 +679,4 @@ node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/di #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:81 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:144 diff --git a/packages/state/package.json b/packages/state/package.json index 0e0ab1ba89..caa3d88a11 100644 --- a/packages/state/package.json +++ b/packages/state/package.json @@ -19,6 +19,7 @@ "contributors": [ "Will Cory " ], + "sideEffects": false, "type": "module", "exports": { "./package.json": "./package.json", @@ -80,6 +81,5 @@ }, "publishConfig": { "access": "public" - }, - "sideEffects": false + } } \ No newline at end of file diff --git a/packages/state/src/actions/generateCannonicalGenesis.js b/packages/state/src/actions/generateCannonicalGenesis.js index 968a0cbb88..1518014bdf 100644 --- a/packages/state/src/actions/generateCannonicalGenesis.js +++ b/packages/state/src/actions/generateCannonicalGenesis.js @@ -22,16 +22,17 @@ export const generateCanonicalGenesis = (baseState) => async (state) => { contracts: new ContractCache(), accounts: new AccountCache({ size: 100_000, - type: CacheType.ORDERED_MAP, + type: CacheType.LRU, }), storage: new StorageCache({ size: 100_000, - type: CacheType.ORDERED_MAP, + type: CacheType.LRU, }), } try { for (const [k, v] of Object.entries(/** @type {import('../state-types/TevmState.js').TevmState}*/ (state))) { const { nonce, balance, storageRoot, codeHash, storage, deployedBytecode } = v + console.log('generating', k, nonce) const account = new EthjsAccount( // replace with just the var nonce, diff --git a/packages/state/src/actions/shallowCopy.js b/packages/state/src/actions/shallowCopy.js index 616781ef5f..0e7541e519 100644 --- a/packages/state/src/actions/shallowCopy.js +++ b/packages/state/src/actions/shallowCopy.js @@ -12,11 +12,11 @@ export const shallowCopy = (baseState) => () => { newState.caches.contracts = new ContractCache() newState.caches.storage = new StorageCache({ size: 100000, - type: CacheType.ORDERED_MAP, + type: CacheType.LRU, }) newState.caches.accounts = new AccountCache({ size: 100000, - type: CacheType.ORDERED_MAP, + type: CacheType.LRU, }) return newState } diff --git a/packages/sync-storage-persister/docs/README.md b/packages/sync-storage-persister/docs/README.md index 2389f485c3..11a11a8abc 100644 --- a/packages/sync-storage-persister/docs/README.md +++ b/packages/sync-storage-persister/docs/README.md @@ -30,4 +30,4 @@ A package for creating syncronous storage persisters for tevm clients ## License 📄 - + diff --git a/packages/sync-storage-persister/docs/_media/LICENSE b/packages/sync-storage-persister/docs/_media/LICENSE deleted file mode 100644 index b5a4fa7a69..0000000000 --- a/packages/sync-storage-persister/docs/_media/LICENSE +++ /dev/null @@ -1,22 +0,0 @@ -(The MIT License) - -Copyright 2020-2022 - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/packages/sync-storage-persister/docs/functions/createSyncStoragePersister.md b/packages/sync-storage-persister/docs/functions/createSyncStoragePersister.md index 04fd34d393..27d5b0abfe 100644 --- a/packages/sync-storage-persister/docs/functions/createSyncStoragePersister.md +++ b/packages/sync-storage-persister/docs/functions/createSyncStoragePersister.md @@ -8,8 +8,6 @@ > **createSyncStoragePersister**(`options`): [`SyncStoragePersister`](../type-aliases/SyncStoragePersister.md) -Creates a syncronous storage persister to be used in tevm clients - ## Parameters • **options**: [`CreateSyncStoragePersisterOptions`](../type-aliases/CreateSyncStoragePersisterOptions.md) diff --git a/packages/sync-storage-persister/docs/type-aliases/CreateSyncStoragePersisterOptions.md b/packages/sync-storage-persister/docs/type-aliases/CreateSyncStoragePersisterOptions.md index ffdde3de47..7899a87d3d 100644 --- a/packages/sync-storage-persister/docs/type-aliases/CreateSyncStoragePersisterOptions.md +++ b/packages/sync-storage-persister/docs/type-aliases/CreateSyncStoragePersisterOptions.md @@ -18,6 +18,10 @@ Options for creating a sync storage persister. How to deserialize the data from storage. +#### Default + +`JSON.parse` + #### Parameters • **cachedString**: `string` @@ -26,10 +30,6 @@ How to deserialize the data from storage. `SerializableTevmState` -#### Default - -`JSON.parse` - ### key? > `optional` **key**: `string` @@ -42,6 +42,10 @@ The key to use when storing the cache How to serialize the data to storage. +#### Default + +`JSON.stringify` + #### Parameters • **client**: `SerializableTevmState` @@ -50,10 +54,6 @@ How to serialize the data to storage. `string` -#### Default - -`JSON.stringify` - ### storage > **storage**: [`Storage`](../interfaces/Storage.md) diff --git a/packages/sync-storage-persister/package.json b/packages/sync-storage-persister/package.json index 93ff175296..b2de2b92b2 100644 --- a/packages/sync-storage-persister/package.json +++ b/packages/sync-storage-persister/package.json @@ -19,6 +19,7 @@ "contributors": [ "Will Cory " ], + "sideEffects": false, "type": "module", "exports": { "./package.json": "./package.json", @@ -70,6 +71,5 @@ }, "publishConfig": { "access": "public" - }, - "sideEffects": false + } } \ No newline at end of file diff --git a/packages/trie/docs/README.md b/packages/trie/docs/README.md index 69b48d9004..4d18934544 100644 --- a/packages/trie/docs/README.md +++ b/packages/trie/docs/README.md @@ -36,4 +36,4 @@ Some files are adapted from [ethereumjs](https://github.com/ethereumjs/ethereumj ## License 📄 - + diff --git a/packages/trie/docs/_media/LICENSE b/packages/trie/docs/_media/LICENSE deleted file mode 100644 index b5a4fa7a69..0000000000 --- a/packages/trie/docs/_media/LICENSE +++ /dev/null @@ -1,22 +0,0 @@ -(The MIT License) - -Copyright 2020-2022 - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/packages/trie/docs/classes/Trie.md b/packages/trie/docs/classes/Trie.md index d0aaa446d2..daddf50d8e 100644 --- a/packages/trie/docs/classes/Trie.md +++ b/packages/trie/docs/classes/Trie.md @@ -30,7 +30,7 @@ Note: in most cases, the static [Trie.create](Trie.md#create) constructor should #### Defined in -node\_modules/.pnpm/@ethereumjs+trie@6.2.0/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:30 +node\_modules/.pnpm/@ethereumjs+trie@6.2.1/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:30 ## Properties @@ -42,7 +42,7 @@ Debug logging #### Defined in -node\_modules/.pnpm/@ethereumjs+trie@6.2.0/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:21 +node\_modules/.pnpm/@ethereumjs+trie@6.2.1/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:21 *** @@ -54,7 +54,7 @@ The root for an empty trie #### Defined in -node\_modules/.pnpm/@ethereumjs+trie@6.2.0/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:14 +node\_modules/.pnpm/@ethereumjs+trie@6.2.1/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:14 *** @@ -66,7 +66,7 @@ The backend DB #### Defined in -node\_modules/.pnpm/@ethereumjs+trie@6.2.0/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:16 +node\_modules/.pnpm/@ethereumjs+trie@6.2.1/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:16 *** @@ -76,7 +76,7 @@ node\_modules/.pnpm/@ethereumjs+trie@6.2.0/node\_modules/@ethereumjs/trie/dist/e #### Defined in -node\_modules/.pnpm/@ethereumjs+trie@6.2.0/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:22 +node\_modules/.pnpm/@ethereumjs+trie@6.2.1/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:22 *** @@ -86,7 +86,7 @@ node\_modules/.pnpm/@ethereumjs+trie@6.2.0/node\_modules/@ethereumjs/trie/dist/e #### Defined in -node\_modules/.pnpm/@ethereumjs+trie@6.2.0/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:17 +node\_modules/.pnpm/@ethereumjs+trie@6.2.1/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:17 *** @@ -96,7 +96,7 @@ node\_modules/.pnpm/@ethereumjs+trie@6.2.0/node\_modules/@ethereumjs/trie/dist/e #### Defined in -node\_modules/.pnpm/@ethereumjs+trie@6.2.0/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:18 +node\_modules/.pnpm/@ethereumjs+trie@6.2.1/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:18 *** @@ -106,7 +106,7 @@ node\_modules/.pnpm/@ethereumjs+trie@6.2.0/node\_modules/@ethereumjs/trie/dist/e #### Defined in -node\_modules/.pnpm/@ethereumjs+trie@6.2.0/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:12 +node\_modules/.pnpm/@ethereumjs+trie@6.2.1/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:12 *** @@ -116,7 +116,7 @@ node\_modules/.pnpm/@ethereumjs+trie@6.2.0/node\_modules/@ethereumjs/trie/dist/e #### Defined in -node\_modules/.pnpm/@ethereumjs+trie@6.2.0/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:19 +node\_modules/.pnpm/@ethereumjs+trie@6.2.1/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:19 *** @@ -134,7 +134,7 @@ node\_modules/.pnpm/@ethereumjs+trie@6.2.0/node\_modules/@ethereumjs/trie/dist/e #### Defined in -node\_modules/.pnpm/@ethereumjs+trie@6.2.0/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:23 +node\_modules/.pnpm/@ethereumjs+trie@6.2.1/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:23 *** @@ -168,7 +168,7 @@ node\_modules/.pnpm/@ethereumjs+trie@6.2.0/node\_modules/@ethereumjs/trie/dist/e #### Defined in -node\_modules/.pnpm/@ethereumjs+trie@6.2.0/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:169 +node\_modules/.pnpm/@ethereumjs+trie@6.2.1/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:169 ## Methods @@ -189,7 +189,7 @@ depending on the `useKeyHashing` option being set or not. #### Defined in -node\_modules/.pnpm/@ethereumjs+trie@6.2.0/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:277 +node\_modules/.pnpm/@ethereumjs+trie@6.2.1/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:277 *** @@ -225,7 +225,7 @@ await trie.batch(ops) #### Defined in -node\_modules/.pnpm/@ethereumjs+trie@6.2.0/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:240 +node\_modules/.pnpm/@ethereumjs+trie@6.2.1/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:240 *** @@ -245,7 +245,7 @@ Checks if a given root exists. #### Defined in -node\_modules/.pnpm/@ethereumjs+trie@6.2.0/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:130 +node\_modules/.pnpm/@ethereumjs+trie@6.2.1/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:130 *** @@ -262,7 +262,7 @@ After this is called, all changes can be reverted until `commit` is called. #### Defined in -node\_modules/.pnpm/@ethereumjs+trie@6.2.0/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:287 +node\_modules/.pnpm/@ethereumjs+trie@6.2.1/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:287 *** @@ -283,7 +283,7 @@ If not during a checkpoint phase #### Defined in -node\_modules/.pnpm/@ethereumjs+trie@6.2.0/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:293 +node\_modules/.pnpm/@ethereumjs+trie@6.2.1/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:293 *** @@ -307,7 +307,7 @@ key to create a proof for #### Defined in -node\_modules/.pnpm/@ethereumjs+trie@6.2.0/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:93 +node\_modules/.pnpm/@ethereumjs+trie@6.2.1/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:93 *** @@ -325,7 +325,7 @@ Returns a [stream](https://nodejs.org/dist/latest-v12.x/docs/api/stream.html#str #### Defined in -node\_modules/.pnpm/@ethereumjs+trie@6.2.0/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:246 +node\_modules/.pnpm/@ethereumjs+trie@6.2.1/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:246 *** @@ -345,7 +345,7 @@ node\_modules/.pnpm/@ethereumjs+trie@6.2.0/node\_modules/@ethereumjs/trie/dist/e #### Defined in -node\_modules/.pnpm/@ethereumjs+trie@6.2.0/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:122 +node\_modules/.pnpm/@ethereumjs+trie@6.2.1/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:122 *** @@ -370,7 +370,7 @@ A Promise that resolves once value is deleted. #### Defined in -node\_modules/.pnpm/@ethereumjs+trie@6.2.0/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:152 +node\_modules/.pnpm/@ethereumjs+trie@6.2.1/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:152 *** @@ -401,7 +401,7 @@ if true, throws if any nodes are missing. Used for verifying proofs. (default: f #### Defined in -node\_modules/.pnpm/@ethereumjs+trie@6.2.0/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:159 +node\_modules/.pnpm/@ethereumjs+trie@6.2.1/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:159 *** @@ -417,7 +417,7 @@ Flushes all checkpoints, restoring the initial checkpoint state. #### Defined in -node\_modules/.pnpm/@ethereumjs+trie@6.2.0/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:303 +node\_modules/.pnpm/@ethereumjs+trie@6.2.1/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:303 *** @@ -445,7 +445,7 @@ Use `updateFromProof` #### Defined in -node\_modules/.pnpm/@ethereumjs+trie@6.2.0/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:120 +node\_modules/.pnpm/@ethereumjs+trie@6.2.1/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:120 *** @@ -473,7 +473,7 @@ A Promise that resolves to `Uint8Array` if a value was found or `null` if no val #### Defined in -node\_modules/.pnpm/@ethereumjs+trie@6.2.0/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:137 +node\_modules/.pnpm/@ethereumjs+trie@6.2.1/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:137 *** @@ -489,7 +489,7 @@ Is the trie during a checkpoint phase? #### Defined in -node\_modules/.pnpm/@ethereumjs+trie@6.2.0/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:282 +node\_modules/.pnpm/@ethereumjs+trie@6.2.1/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:282 *** @@ -507,7 +507,7 @@ node\_modules/.pnpm/@ethereumjs+trie@6.2.0/node\_modules/@ethereumjs/trie/dist/e #### Defined in -node\_modules/.pnpm/@ethereumjs+trie@6.2.0/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:278 +node\_modules/.pnpm/@ethereumjs+trie@6.2.1/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:278 *** @@ -527,7 +527,7 @@ Retrieves a node from db by hash. #### Defined in -node\_modules/.pnpm/@ethereumjs+trie@6.2.0/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:193 +node\_modules/.pnpm/@ethereumjs+trie@6.2.1/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:193 *** @@ -543,7 +543,7 @@ Persists the root hash in the underlying database #### Defined in -node\_modules/.pnpm/@ethereumjs+trie@6.2.0/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:264 +node\_modules/.pnpm/@ethereumjs+trie@6.2.1/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:264 *** @@ -570,7 +570,7 @@ A Promise that resolves once value is stored. #### Defined in -node\_modules/.pnpm/@ethereumjs+trie@6.2.0/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:145 +node\_modules/.pnpm/@ethereumjs+trie@6.2.1/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:145 *** @@ -588,7 +588,7 @@ parent checkpoint as current. #### Defined in -node\_modules/.pnpm/@ethereumjs+trie@6.2.0/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:299 +node\_modules/.pnpm/@ethereumjs+trie@6.2.1/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:299 *** @@ -608,7 +608,7 @@ Gets and/or Sets the current root of the `trie` #### Defined in -node\_modules/.pnpm/@ethereumjs+trie@6.2.0/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:126 +node\_modules/.pnpm/@ethereumjs+trie@6.2.1/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:126 *** @@ -638,7 +638,7 @@ a stack of levelup operations to commit at the end of this function #### Defined in -node\_modules/.pnpm/@ethereumjs+trie@6.2.0/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:215 +node\_modules/.pnpm/@ethereumjs+trie@6.2.1/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:215 *** @@ -670,7 +670,7 @@ If true and during a checkpoint, the copy will contain the checkpointing metadat #### Defined in -node\_modules/.pnpm/@ethereumjs+trie@6.2.0/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:260 +node\_modules/.pnpm/@ethereumjs+trie@6.2.1/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:260 *** @@ -700,7 +700,7 @@ The root of the proof #### Defined in -node\_modules/.pnpm/@ethereumjs+trie@6.2.0/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:102 +node\_modules/.pnpm/@ethereumjs+trie@6.2.1/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:102 *** @@ -737,7 +737,7 @@ If proof is found to be invalid. #### Defined in -node\_modules/.pnpm/@ethereumjs+trie@6.2.0/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:112 +node\_modules/.pnpm/@ethereumjs+trie@6.2.1/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:112 *** @@ -751,7 +751,7 @@ node\_modules/.pnpm/@ethereumjs+trie@6.2.0/node\_modules/@ethereumjs/trie/dist/e #### Defined in -node\_modules/.pnpm/@ethereumjs+trie@6.2.0/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:241 +node\_modules/.pnpm/@ethereumjs+trie@6.2.1/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:241 *** @@ -798,7 +798,7 @@ a flag to indicate whether there exists more trie node in the trie #### Defined in -node\_modules/.pnpm/@ethereumjs+trie@6.2.0/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:86 +node\_modules/.pnpm/@ethereumjs+trie@6.2.1/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:86 *** @@ -822,7 +822,7 @@ Resolves when finished walking trie. #### Defined in -node\_modules/.pnpm/@ethereumjs+trie@6.2.0/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:178 +node\_modules/.pnpm/@ethereumjs+trie@6.2.1/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:178 *** @@ -846,7 +846,7 @@ Resolves when finished walking trie. #### Defined in -node\_modules/.pnpm/@ethereumjs+trie@6.2.0/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:184 +node\_modules/.pnpm/@ethereumjs+trie@6.2.1/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:184 *** @@ -872,7 +872,7 @@ Resolves when finished walking trie. #### Defined in -node\_modules/.pnpm/@ethereumjs+trie@6.2.0/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:168 +node\_modules/.pnpm/@ethereumjs+trie@6.2.1/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:168 *** @@ -890,7 +890,7 @@ node\_modules/.pnpm/@ethereumjs+trie@6.2.0/node\_modules/@ethereumjs/trie/dist/e #### Defined in -node\_modules/.pnpm/@ethereumjs+trie@6.2.0/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:121 +node\_modules/.pnpm/@ethereumjs+trie@6.2.1/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:121 *** @@ -923,7 +923,7 @@ new trie created from given proof #### Defined in -node\_modules/.pnpm/@ethereumjs+trie@6.2.0/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:39 +node\_modules/.pnpm/@ethereumjs+trie@6.2.1/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:39 *** @@ -952,7 +952,7 @@ Use `createFromProof` #### Defined in -node\_modules/.pnpm/@ethereumjs+trie@6.2.0/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:72 +node\_modules/.pnpm/@ethereumjs+trie@6.2.1/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:72 *** @@ -989,7 +989,7 @@ If proof is found to be invalid. #### Defined in -node\_modules/.pnpm/@ethereumjs+trie@6.2.0/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:50 +node\_modules/.pnpm/@ethereumjs+trie@6.2.1/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:50 *** @@ -1040,4 +1040,4 @@ a flag to indicate whether there exists more trie node in the trie #### Defined in -node\_modules/.pnpm/@ethereumjs+trie@6.2.0/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:65 +node\_modules/.pnpm/@ethereumjs+trie@6.2.1/node\_modules/@ethereumjs/trie/dist/esm/trie.d.ts:65 diff --git a/packages/trie/docs/functions/genesisStateRoot.md b/packages/trie/docs/functions/genesisStateRoot.md index 961db33361..2ee20d1939 100644 --- a/packages/trie/docs/functions/genesisStateRoot.md +++ b/packages/trie/docs/functions/genesisStateRoot.md @@ -20,4 +20,4 @@ Derives the stateRoot of the genesis block based on genesis allocations ## Defined in -node\_modules/.pnpm/@ethereumjs+trie@6.2.0/node\_modules/@ethereumjs/trie/dist/esm/util/genesisState.d.ts:5 +node\_modules/.pnpm/@ethereumjs+trie@6.2.1/node\_modules/@ethereumjs/trie/dist/esm/util/genesisState.d.ts:5 diff --git a/packages/trie/package.json b/packages/trie/package.json index d02f26b704..e66bac7f53 100644 --- a/packages/trie/package.json +++ b/packages/trie/package.json @@ -19,6 +19,7 @@ "contributors": [ "Will Cory " ], + "sideEffects": false, "type": "module", "exports": { "./package.json": "./package.json", @@ -70,6 +71,5 @@ }, "publishConfig": { "access": "public" - }, - "sideEffects": false + } } \ No newline at end of file diff --git a/packages/tx/docs/README.md b/packages/tx/docs/README.md index 3b76215666..b788dd1389 100644 --- a/packages/tx/docs/README.md +++ b/packages/tx/docs/README.md @@ -36,4 +36,4 @@ Some files are adapted from [ethereumjs](https://github.com/ethereumjs/ethereumj ## License 📄 - + diff --git a/packages/tx/docs/_media/LICENSE b/packages/tx/docs/_media/LICENSE deleted file mode 100644 index b5a4fa7a69..0000000000 --- a/packages/tx/docs/_media/LICENSE +++ /dev/null @@ -1,22 +0,0 @@ -(The MIT License) - -Copyright 2020-2022 - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/packages/tx/docs/classes/AccessListEIP2930Transaction.md b/packages/tx/docs/classes/AccessListEIP2930Transaction.md index 9f1dac30ca..0e02bd1eee 100644 --- a/packages/tx/docs/classes/AccessListEIP2930Transaction.md +++ b/packages/tx/docs/classes/AccessListEIP2930Transaction.md @@ -43,7 +43,7 @@ varying data types. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:51 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:51 ## Properties @@ -53,7 +53,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:16 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:16 *** @@ -67,7 +67,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:14 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:14 *** @@ -77,7 +77,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:15 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:15 *** @@ -95,7 +95,7 @@ for FeeMarketEIP1559Transaction objects #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:31 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:31 *** @@ -109,7 +109,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:24 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:24 *** @@ -119,7 +119,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:14 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:14 *** @@ -133,7 +133,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:18 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:18 *** @@ -147,7 +147,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:19 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:19 *** @@ -161,7 +161,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:16 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:16 *** @@ -171,7 +171,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:17 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:17 *** @@ -185,7 +185,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:15 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:15 *** @@ -199,7 +199,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:21 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:21 *** @@ -213,7 +213,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:22 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:22 *** @@ -227,7 +227,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:17 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:17 *** @@ -241,7 +241,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:25 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:25 *** @@ -255,7 +255,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:20 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:20 *** @@ -269,7 +269,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:18 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:18 ## Accessors @@ -291,7 +291,7 @@ Note: legacy txs will return tx type `0`. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:47 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:47 ## Methods @@ -312,7 +312,7 @@ tx type implementations. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:189 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:189 *** @@ -346,7 +346,7 @@ Pass true if the number also cannot equal one less the maximum value #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:168 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:168 *** @@ -386,7 +386,7 @@ Set this to `true` if the raw output of `ecsign` is used. If this is `false` (de #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:121 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:121 *** @@ -406,7 +406,7 @@ Return a compact error string representation of the object #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:129 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:129 *** @@ -426,7 +426,7 @@ The minimum amount of gas the tx must have (DataFee + TxFee + Creation Fee) #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:78 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:78 *** @@ -446,7 +446,7 @@ The amount of gas paid for the data in this tx #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:56 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:56 *** @@ -473,7 +473,7 @@ Optional baseFee of the block. Note for EIP1559 and EIP4844 this is required. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:52 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:52 *** @@ -497,7 +497,7 @@ serialized and doesn't need to be RLP encoded any more. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:105 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:105 *** @@ -525,7 +525,7 @@ const serializedMessage = tx.getMessageToSign() // use this for the HW wallet in #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:97 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:97 *** @@ -545,7 +545,7 @@ Computes a sha3-256 hash which can be used to verify the signature #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:116 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:116 *** @@ -565,7 +565,7 @@ Returns the sender's address #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:124 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:124 *** @@ -585,7 +585,7 @@ Returns the public key of the sender #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:120 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:120 *** @@ -605,7 +605,7 @@ The up front amount that an account must have for this transaction to be valid #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:60 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:60 *** @@ -627,7 +627,7 @@ an array of error strings #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:69 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:69 *** @@ -650,7 +650,7 @@ Use [AccessListEIP2930Transaction.getMessageToSign](AccessListEIP2930Transaction #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:112 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:112 *** @@ -668,7 +668,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:116 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:116 *** @@ -690,7 +690,7 @@ true if the transaction is valid, false otherwise #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:74 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:74 *** @@ -698,7 +698,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b > **raw**(): `AccessListEIP2930TxValuesArray` -Returns a Uint8Array Array of the raw Bytess of the EIP-2930 transaction, in order. +Returns a Uint8Array Array of the raw Bytes of the EIP-2930 transaction, in order. Format: `[chainId, nonce, gasPrice, gasLimit, to, value, data, accessList, signatureYParity (v), signatureR (r), signatureS (s)]` @@ -720,7 +720,7 @@ representation for external signing use [AccessListEIP2930Transaction.getMessage #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:74 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:74 *** @@ -747,7 +747,7 @@ the RLP encoding of the values. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:85 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:85 *** @@ -777,7 +777,7 @@ const signedTx = tx.sign(privateKey) #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:138 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:138 *** @@ -814,7 +814,7 @@ on all supported capabilities. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:64 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:64 *** @@ -834,7 +834,7 @@ If the tx's `to` is to the creation address #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:96 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:96 *** @@ -854,7 +854,7 @@ Returns an object with the JSON representation of the transaction #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:125 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:125 *** @@ -874,7 +874,7 @@ Determines if the signature is valid #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:120 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:120 *** @@ -896,7 +896,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:171 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:171 *** @@ -921,7 +921,7 @@ signatureYParity (v), signatureR (r), signatureS (s)])` #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:36 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:36 *** @@ -950,7 +950,7 @@ Notes: #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:29 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:29 *** @@ -975,4 +975,4 @@ signatureYParity (v), signatureR (r), signatureS (s)]` #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:43 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:43 diff --git a/packages/tx/docs/classes/BlobEIP4844Transaction.md b/packages/tx/docs/classes/BlobEIP4844Transaction.md index 276460062a..b08919f455 100644 --- a/packages/tx/docs/classes/BlobEIP4844Transaction.md +++ b/packages/tx/docs/classes/BlobEIP4844Transaction.md @@ -43,7 +43,7 @@ varying data types. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:32 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:32 ## Properties @@ -53,7 +53,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:16 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:16 *** @@ -67,7 +67,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:14 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:14 *** @@ -77,7 +77,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:15 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:15 *** @@ -95,7 +95,7 @@ for FeeMarketEIP1559Transaction objects #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:31 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:31 *** @@ -105,7 +105,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:21 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:21 *** @@ -115,7 +115,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:22 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:22 *** @@ -129,7 +129,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:24 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:24 *** @@ -139,7 +139,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:14 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:14 *** @@ -153,7 +153,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:20 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:20 *** @@ -167,7 +167,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:19 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:19 *** @@ -181,7 +181,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:16 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:16 *** @@ -191,7 +191,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:23 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:23 *** @@ -201,7 +201,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:24 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:24 *** @@ -211,7 +211,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:19 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:19 *** @@ -221,7 +221,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:18 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:18 *** @@ -231,7 +231,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:17 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:17 *** @@ -245,7 +245,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:15 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:15 *** @@ -259,7 +259,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:21 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:21 *** @@ -273,7 +273,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:22 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:22 *** @@ -287,7 +287,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:17 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:17 *** @@ -301,7 +301,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:25 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:25 *** @@ -315,7 +315,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:20 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:20 *** @@ -329,7 +329,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:18 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:18 ## Accessors @@ -351,7 +351,7 @@ Note: legacy txs will return tx type `0`. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:47 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:47 ## Methods @@ -372,7 +372,7 @@ tx type implementations. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:189 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:189 *** @@ -406,7 +406,7 @@ Pass true if the number also cannot equal one less the maximum value #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:168 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:168 *** @@ -446,7 +446,7 @@ Set this to `true` if the raw output of `ecsign` is used. If this is `false` (de #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:139 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:147 *** @@ -466,7 +466,7 @@ Return a compact error string representation of the object #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:143 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:151 *** @@ -486,7 +486,7 @@ The minimum amount of gas the tx must have (DataFee + TxFee + Creation Fee) #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:78 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:78 *** @@ -506,7 +506,7 @@ The amount of gas paid for the data in this tx #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:71 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:71 *** @@ -532,7 +532,7 @@ Base fee retrieved from block #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:38 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:38 *** @@ -556,7 +556,7 @@ serialized and doesn't need to be RLP encoded any more. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:125 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:125 *** @@ -584,7 +584,7 @@ const serializedMessage = tx.getMessageToSign() // use this for the HW wallet in #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:117 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:117 *** @@ -602,7 +602,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:133 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:133 *** @@ -622,7 +622,7 @@ Returns the sender's address #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:124 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:124 *** @@ -642,7 +642,7 @@ Returns the public key of the sender #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:137 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:137 *** @@ -668,7 +668,7 @@ The base fee of the block (will be set to 0 if not provided) #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:76 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:76 *** @@ -690,7 +690,7 @@ an array of error strings #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:69 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:69 *** @@ -713,7 +713,7 @@ Use [BlobEIP4844Transaction.getMessageToSign](BlobEIP4844Transaction.md#getmessa #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:132 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:132 *** @@ -731,7 +731,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:116 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:116 *** @@ -753,7 +753,7 @@ true if the transaction is valid, false otherwise #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:74 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:74 *** @@ -769,7 +769,7 @@ the number of blobs included with this transaction #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:154 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:162 *** @@ -799,7 +799,7 @@ representation for external signing use [BlobEIP4844Transaction.getMessageToSign #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:90 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:90 *** @@ -826,7 +826,7 @@ the RLP encoding of the values. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:101 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:101 *** @@ -842,7 +842,7 @@ the serialized form of a blob transaction in the network wrapper format (used fo #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:105 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:105 *** @@ -872,7 +872,7 @@ const signedTx = tx.sign(privateKey) #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:138 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:138 *** @@ -909,7 +909,7 @@ on all supported capabilities. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:64 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:64 *** @@ -929,7 +929,7 @@ If the tx's `to` is to the creation address #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:96 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:96 *** @@ -949,7 +949,7 @@ Returns an object with the JSON representation of the transaction #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:138 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:146 *** @@ -969,7 +969,7 @@ Determines if the signature is valid #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:120 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:120 *** @@ -991,7 +991,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:171 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:171 *** @@ -1019,7 +1019,7 @@ a BlobEIP4844Transaction #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:67 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:67 *** @@ -1044,7 +1044,7 @@ access_list, max_fee_per_data_gas, blob_versioned_hashes, y_parity, r, s])` #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:53 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:53 *** @@ -1064,7 +1064,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:33 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:33 *** @@ -1089,7 +1089,7 @@ accessList, signatureYParity, signatureR, signatureS]` #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:60 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:60 *** @@ -1118,4 +1118,33 @@ the "minimal" representation of a BlobEIP4844Transaction (i.e. transaction objec #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:46 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:46 + +*** + +### networkWrapperToJson() + +> `static` **networkWrapperToJson**(`serialized`, `opts`?): `JsonBlobTxNetworkWrapper` + +Returns the EIP 4844 transaction network wrapper in JSON format similar to toJSON, including +blobs, commitments, and proofs fields + +#### Parameters + +• **serialized**: `Uint8Array` + +a buffer representing a serialized BlobTransactionNetworkWrapper + +• **opts?**: [`TxOptions`](../interfaces/TxOptions.md) + +any TxOptions defined + +#### Returns + +`JsonBlobTxNetworkWrapper` + +JsonBlobTxNetworkWrapper with blobs, KZG commitments, and KZG proofs fields + +#### Defined in + +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:145 diff --git a/packages/tx/docs/classes/FeeMarketEIP1559Transaction.md b/packages/tx/docs/classes/FeeMarketEIP1559Transaction.md index 5da68526f7..a08a333cc5 100644 --- a/packages/tx/docs/classes/FeeMarketEIP1559Transaction.md +++ b/packages/tx/docs/classes/FeeMarketEIP1559Transaction.md @@ -47,7 +47,7 @@ varying data types. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:52 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:52 ## Properties @@ -57,7 +57,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:16 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:16 *** @@ -71,7 +71,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:14 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:14 *** @@ -81,7 +81,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:15 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:15 *** @@ -99,7 +99,7 @@ for FeeMarketEIP1559Transaction objects #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:31 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:31 *** @@ -113,7 +113,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:24 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:24 *** @@ -123,7 +123,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:14 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:14 *** @@ -137,7 +137,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:19 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:19 *** @@ -151,7 +151,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:19 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:19 *** @@ -165,7 +165,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:16 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:16 *** @@ -175,7 +175,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:18 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:18 *** @@ -185,7 +185,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:17 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:17 *** @@ -199,7 +199,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:15 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:15 *** @@ -213,7 +213,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:21 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:21 *** @@ -227,7 +227,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:22 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:22 *** @@ -241,7 +241,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:17 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:17 *** @@ -255,7 +255,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:25 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:25 *** @@ -269,7 +269,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:20 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:20 *** @@ -283,7 +283,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:18 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:18 ## Accessors @@ -305,7 +305,7 @@ Note: legacy txs will return tx type `0`. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:47 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:47 ## Methods @@ -326,7 +326,7 @@ tx type implementations. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:189 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:189 *** @@ -360,7 +360,7 @@ Pass true if the number also cannot equal one less the maximum value #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:168 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:168 *** @@ -400,7 +400,7 @@ Set this to `true` if the raw output of `ecsign` is used. If this is `false` (de #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:127 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:127 *** @@ -420,7 +420,7 @@ Return a compact error string representation of the object #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:135 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:135 *** @@ -440,7 +440,7 @@ The minimum amount of gas the tx must have (DataFee + TxFee + Creation Fee) #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:78 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:78 *** @@ -460,7 +460,7 @@ The amount of gas paid for the data in this tx #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:56 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:56 *** @@ -486,7 +486,7 @@ Base fee retrieved from block #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:61 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:61 *** @@ -510,7 +510,7 @@ serialized and doesn't need to be RLP encoded any more. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:111 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:111 *** @@ -538,7 +538,7 @@ const serializedMessage = tx.getMessageToSign() // use this for the HW wallet in #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:103 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:103 *** @@ -558,7 +558,7 @@ Computes a sha3-256 hash which can be used to verify the signature #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:122 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:122 *** @@ -578,7 +578,7 @@ Returns the sender's address #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:124 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:124 *** @@ -598,7 +598,7 @@ Returns the public key of the sender #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:126 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:126 *** @@ -624,7 +624,7 @@ The base fee of the block (will be set to 0 if not provided) #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:66 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:66 *** @@ -646,7 +646,7 @@ an array of error strings #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:69 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:69 *** @@ -669,7 +669,7 @@ Use [FeeMarketEIP1559Transaction.getMessageToSign](FeeMarketEIP1559Transaction.m #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:118 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:118 *** @@ -687,7 +687,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:116 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:116 *** @@ -709,7 +709,7 @@ true if the transaction is valid, false otherwise #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:74 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:74 *** @@ -739,7 +739,7 @@ representation for external signing use [FeeMarketEIP1559Transaction.getMessageT #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:80 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:80 *** @@ -766,7 +766,7 @@ the RLP encoding of the values. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:91 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:91 *** @@ -796,7 +796,7 @@ const signedTx = tx.sign(privateKey) #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:138 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:138 *** @@ -833,7 +833,7 @@ on all supported capabilities. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:64 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:64 *** @@ -853,7 +853,7 @@ If the tx's `to` is to the creation address #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:96 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:96 *** @@ -873,7 +873,7 @@ Returns an object with the JSON representation of the transaction #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:131 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:131 *** @@ -893,7 +893,7 @@ Determines if the signature is valid #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:120 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:120 *** @@ -915,7 +915,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:171 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:171 *** @@ -940,7 +940,7 @@ accessList, signatureYParity, signatureR, signatureS])` #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:37 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:37 *** @@ -969,7 +969,7 @@ Notes: #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:30 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:30 *** @@ -994,4 +994,4 @@ accessList, signatureYParity, signatureR, signatureS]` #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:44 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:44 diff --git a/packages/tx/docs/classes/LegacyTransaction.md b/packages/tx/docs/classes/LegacyTransaction.md index b3a95c6328..11d0ecb461 100644 --- a/packages/tx/docs/classes/LegacyTransaction.md +++ b/packages/tx/docs/classes/LegacyTransaction.md @@ -40,7 +40,7 @@ varying data types. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:42 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:42 ## Properties @@ -54,7 +54,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/l #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:14 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:14 *** @@ -72,7 +72,7 @@ for FeeMarketEIP1559Transaction objects #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:31 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:31 *** @@ -86,7 +86,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:24 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:24 *** @@ -100,7 +100,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:12 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:12 *** @@ -114,7 +114,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/l #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:19 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:19 *** @@ -128,7 +128,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:16 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:16 *** @@ -138,7 +138,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:11 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:11 *** @@ -152,7 +152,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/l #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:15 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:15 *** @@ -166,7 +166,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:21 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:21 *** @@ -180,7 +180,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:22 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:22 *** @@ -194,7 +194,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:17 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:17 *** @@ -208,7 +208,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:25 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:25 *** @@ -222,7 +222,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:20 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:20 *** @@ -236,7 +236,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:18 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:18 ## Accessors @@ -258,7 +258,7 @@ Note: legacy txs will return tx type `0`. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:47 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:47 ## Methods @@ -279,7 +279,7 @@ tx type implementations. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:189 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:189 *** @@ -313,7 +313,7 @@ Pass true if the number also cannot equal one less the maximum value #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:168 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:168 *** @@ -335,7 +335,7 @@ Validates tx's `v` value #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:118 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:118 *** @@ -375,7 +375,7 @@ Set this to `true` if the raw output of `ecsign` is used. If this is `false` (de #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:110 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:110 *** @@ -395,7 +395,7 @@ Return a compact error string representation of the object #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:122 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:122 *** @@ -415,7 +415,7 @@ The minimum amount of gas the tx must have (DataFee + TxFee + Creation Fee) #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:78 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:78 *** @@ -435,7 +435,7 @@ The amount of gas paid for the data in this tx #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:90 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:90 *** @@ -462,7 +462,7 @@ Optional baseFee of the block. Note for EIP1559 and EIP4844 this is required. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:43 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:43 *** @@ -483,7 +483,7 @@ to sign the transaction (e.g. for sending to a hardware wallet). #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:86 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:86 *** @@ -513,7 +513,7 @@ const serializedMessage = RLP.encode(message)) // use this for the HW wallet inp #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:81 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:81 *** @@ -533,7 +533,7 @@ Computes a sha3-256 hash which can be used to verify the signature #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:105 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:105 *** @@ -553,7 +553,7 @@ Returns the sender's address #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:124 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:124 *** @@ -573,7 +573,7 @@ Returns the public key of the sender #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:109 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:109 *** @@ -593,7 +593,7 @@ The up front amount that an account must have for this transaction to be valid #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:94 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:94 *** @@ -615,7 +615,7 @@ an array of error strings #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:69 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:69 *** @@ -638,7 +638,7 @@ Use Transaction.getMessageToSign to get a tx hash for the purpose of signing. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:101 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:101 *** @@ -656,7 +656,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/l #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:116 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:116 *** @@ -678,7 +678,7 @@ true if the transaction is valid, false otherwise #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:74 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:74 *** @@ -708,7 +708,7 @@ representation have a look at Transaction.getMessageToSign. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:57 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:57 *** @@ -734,7 +734,7 @@ representation for external signing use Transaction.getMessageToSign. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:67 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:67 *** @@ -764,7 +764,7 @@ const signedTx = tx.sign(privateKey) #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:138 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:138 *** @@ -801,7 +801,7 @@ on all supported capabilities. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:64 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:64 *** @@ -821,7 +821,7 @@ If the tx's `to` is to the creation address #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:96 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:96 *** @@ -841,7 +841,7 @@ Returns an object with the JSON representation of the transaction. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:114 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:114 *** @@ -861,7 +861,7 @@ Determines if the signature is valid #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:120 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:120 *** @@ -883,7 +883,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:171 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:171 *** @@ -907,7 +907,7 @@ Format: `rlp([nonce, gasPrice, gasLimit, to, value, data, v, r, s])` #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:28 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:28 *** @@ -934,7 +934,7 @@ Notes: #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:22 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:22 *** @@ -958,4 +958,4 @@ Format: `[nonce, gasPrice, gasLimit, to, value, data, v, r, s]` #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:34 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:34 diff --git a/packages/tx/docs/classes/TransactionFactory.md b/packages/tx/docs/classes/TransactionFactory.md index 2ca80f077b..09511eccaf 100644 --- a/packages/tx/docs/classes/TransactionFactory.md +++ b/packages/tx/docs/classes/TransactionFactory.md @@ -10,7 +10,7 @@ ### fromBlockBodyData() -> `static` **fromBlockBodyData**(`data`, `txOptions`?): [`FeeMarketEIP1559Transaction`](FeeMarketEIP1559Transaction.md) \| [`LegacyTransaction`](LegacyTransaction.md) \| [`AccessListEIP2930Transaction`](AccessListEIP2930Transaction.md) \| [`BlobEIP4844Transaction`](BlobEIP4844Transaction.md) +> `static` **fromBlockBodyData**(`data`, `txOptions`?): [`FeeMarketEIP1559Transaction`](FeeMarketEIP1559Transaction.md) \| [`LegacyTransaction`](LegacyTransaction.md) \| [`AccessListEIP2930Transaction`](AccessListEIP2930Transaction.md) \| [`BlobEIP4844Transaction`](BlobEIP4844Transaction.md) \| `EOACodeEIP7702Transaction` When decoding a BlockBody, in the transactions field, a field is either: A Uint8Array (a TypedTransaction - encoded as TransactionType || rlp(TransactionPayload)) @@ -29,17 +29,17 @@ The transaction options #### Returns -[`FeeMarketEIP1559Transaction`](FeeMarketEIP1559Transaction.md) \| [`LegacyTransaction`](LegacyTransaction.md) \| [`AccessListEIP2930Transaction`](AccessListEIP2930Transaction.md) \| [`BlobEIP4844Transaction`](BlobEIP4844Transaction.md) +[`FeeMarketEIP1559Transaction`](FeeMarketEIP1559Transaction.md) \| [`LegacyTransaction`](LegacyTransaction.md) \| [`AccessListEIP2930Transaction`](AccessListEIP2930Transaction.md) \| [`BlobEIP4844Transaction`](BlobEIP4844Transaction.md) \| `EOACodeEIP7702Transaction` #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/transactionFactory.d.ts:33 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/transactionFactory.d.ts:34 *** ### fromJsonRpcProvider() -> `static` **fromJsonRpcProvider**(`provider`, `txHash`, `txOptions`?): `Promise`\<[`FeeMarketEIP1559Transaction`](FeeMarketEIP1559Transaction.md) \| [`LegacyTransaction`](LegacyTransaction.md) \| [`AccessListEIP2930Transaction`](AccessListEIP2930Transaction.md) \| [`BlobEIP4844Transaction`](BlobEIP4844Transaction.md)\> +> `static` **fromJsonRpcProvider**(`provider`, `txHash`, `txOptions`?): `Promise`\<[`FeeMarketEIP1559Transaction`](FeeMarketEIP1559Transaction.md) \| [`LegacyTransaction`](LegacyTransaction.md) \| [`AccessListEIP2930Transaction`](AccessListEIP2930Transaction.md) \| [`BlobEIP4844Transaction`](BlobEIP4844Transaction.md) \| `EOACodeEIP7702Transaction`\> Method to retrieve a transaction from the provider @@ -59,13 +59,13 @@ The transaction options #### Returns -`Promise`\<[`FeeMarketEIP1559Transaction`](FeeMarketEIP1559Transaction.md) \| [`LegacyTransaction`](LegacyTransaction.md) \| [`AccessListEIP2930Transaction`](AccessListEIP2930Transaction.md) \| [`BlobEIP4844Transaction`](BlobEIP4844Transaction.md)\> +`Promise`\<[`FeeMarketEIP1559Transaction`](FeeMarketEIP1559Transaction.md) \| [`LegacyTransaction`](LegacyTransaction.md) \| [`AccessListEIP2930Transaction`](AccessListEIP2930Transaction.md) \| [`BlobEIP4844Transaction`](BlobEIP4844Transaction.md) \| `EOACodeEIP7702Transaction`\> the transaction specified by `txHash` #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/transactionFactory.d.ts:41 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/transactionFactory.d.ts:42 *** @@ -96,7 +96,7 @@ The transaction options #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/transactionFactory.d.ts:49 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/transactionFactory.d.ts:50 *** @@ -126,7 +126,7 @@ The transaction options #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/transactionFactory.d.ts:23 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/transactionFactory.d.ts:24 *** @@ -156,4 +156,4 @@ Options to pass on to the constructor of the transaction #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/transactionFactory.d.ts:16 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/transactionFactory.d.ts:17 diff --git a/packages/tx/docs/enumerations/Capability.md b/packages/tx/docs/enumerations/Capability.md index 0095024424..15a1758ff2 100644 --- a/packages/tx/docs/enumerations/Capability.md +++ b/packages/tx/docs/enumerations/Capability.md @@ -20,7 +20,7 @@ See: [1559](https://eips.ethereum.org/EIPS/eip-1559) Fee Market EIP #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:22 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:23 *** @@ -33,7 +33,7 @@ See: [155](https://eips.ethereum.org/EIPS/eip-155) Replay Attack Protection EIP #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:17 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:18 *** @@ -46,7 +46,7 @@ See: [2718](https://eips.ethereum.org/EIPS/eip-2718) Transaction Type EIP #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:27 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:28 *** @@ -59,4 +59,17 @@ See: [2930](https://eips.ethereum.org/EIPS/eip-2930) Access Lists EIP #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:32 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:33 + +*** + +### EIP7702EOACode + +> **EIP7702EOACode**: `7702` + +Tx supports setting EOA code +See [EIP-7702](https://eips.ethereum.org/EIPS/eip-7702) + +#### Defined in + +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:38 diff --git a/packages/tx/docs/enumerations/TransactionType.md b/packages/tx/docs/enumerations/TransactionType.md index dcd889a492..c8b5427511 100644 --- a/packages/tx/docs/enumerations/TransactionType.md +++ b/packages/tx/docs/enumerations/TransactionType.md @@ -16,7 +16,7 @@ Encompassing type for all transaction types. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:82 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:90 *** @@ -26,7 +26,17 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:84 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:92 + +*** + +### EOACodeEIP7702 + +> **EOACodeEIP7702**: `4` + +#### Defined in + +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:93 *** @@ -36,7 +46,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:83 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:91 *** @@ -46,4 +56,4 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:81 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:89 diff --git a/packages/tx/docs/functions/createImpersonatedTx.md b/packages/tx/docs/functions/createImpersonatedTx.md index ea00ecec1d..bf65595eda 100644 --- a/packages/tx/docs/functions/createImpersonatedTx.md +++ b/packages/tx/docs/functions/createImpersonatedTx.md @@ -8,13 +8,6 @@ > **createImpersonatedTx**(`txData`, `opts`?): [`ImpersonatedTx`](../interfaces/ImpersonatedTx.md) -Creates an impersonated tx that wraps [FeeMarketEIP1559Transaction](../classes/FeeMarketEIP1559Transaction.md). -Wraps following methods -- 'isImpersonated' -- 'hash' -- 'isSigned' -- 'getSenderAddress' - ## Parameters • **txData**: `FeeMarketEIP1559TxData` & `object` @@ -25,10 +18,6 @@ Wraps following methods [`ImpersonatedTx`](../interfaces/ImpersonatedTx.md) -## Throws - -Error if the constructor for [FeeMarketEIP1559Transaction](../classes/FeeMarketEIP1559Transaction.md) throws - ## Defined in [packages/tx/src/createImpersonatedTx.js:21](https://github.com/evmts/tevm-monorepo/blob/main/packages/tx/src/createImpersonatedTx.js#L21) diff --git a/packages/tx/docs/functions/isAccessListEIP2930Tx.md b/packages/tx/docs/functions/isAccessListEIP2930Tx.md index 4fed49d365..061827c3ce 100644 --- a/packages/tx/docs/functions/isAccessListEIP2930Tx.md +++ b/packages/tx/docs/functions/isAccessListEIP2930Tx.md @@ -18,4 +18,4 @@ ## Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:94 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:104 diff --git a/packages/tx/docs/functions/isBlobEIP4844Tx.md b/packages/tx/docs/functions/isBlobEIP4844Tx.md index 3edf6c2ca5..4eec745bc4 100644 --- a/packages/tx/docs/functions/isBlobEIP4844Tx.md +++ b/packages/tx/docs/functions/isBlobEIP4844Tx.md @@ -18,4 +18,4 @@ ## Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:96 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:106 diff --git a/packages/tx/docs/functions/isFeeMarketEIP1559Tx.md b/packages/tx/docs/functions/isFeeMarketEIP1559Tx.md index 5a1c189e9f..e038890c03 100644 --- a/packages/tx/docs/functions/isFeeMarketEIP1559Tx.md +++ b/packages/tx/docs/functions/isFeeMarketEIP1559Tx.md @@ -18,4 +18,4 @@ ## Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:95 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:105 diff --git a/packages/tx/docs/functions/isLegacyTx.md b/packages/tx/docs/functions/isLegacyTx.md index 43842cdcd3..0144849de1 100644 --- a/packages/tx/docs/functions/isLegacyTx.md +++ b/packages/tx/docs/functions/isLegacyTx.md @@ -18,4 +18,4 @@ ## Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:93 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:103 diff --git a/packages/tx/docs/interfaces/EIP1559CompatibleTx.md b/packages/tx/docs/interfaces/EIP1559CompatibleTx.md index 32c0e7c82c..a5e1e4452b 100644 --- a/packages/tx/docs/interfaces/EIP1559CompatibleTx.md +++ b/packages/tx/docs/interfaces/EIP1559CompatibleTx.md @@ -30,7 +30,7 @@ #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:138 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:149 *** @@ -44,7 +44,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:137 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:148 *** @@ -58,7 +58,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:107 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:118 *** @@ -72,7 +72,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:133 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:144 *** @@ -86,7 +86,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:98 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:109 *** @@ -100,7 +100,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:103 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:114 *** @@ -114,7 +114,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:100 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:111 *** @@ -124,7 +124,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:142 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:153 *** @@ -134,7 +134,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:141 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:152 *** @@ -148,7 +148,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:99 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:110 *** @@ -162,7 +162,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:105 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:116 *** @@ -176,7 +176,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:106 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:117 *** @@ -190,7 +190,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:101 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:112 *** @@ -204,7 +204,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:109 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:120 *** @@ -218,7 +218,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:104 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:115 *** @@ -232,7 +232,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:102 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:113 ## Methods @@ -250,7 +250,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:128 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:139 *** @@ -268,7 +268,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:110 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:121 *** @@ -286,7 +286,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:111 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:122 *** @@ -304,7 +304,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:117 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:128 *** @@ -322,7 +322,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:134 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:145 *** @@ -340,7 +340,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:119 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:130 *** @@ -358,7 +358,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:124 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:135 *** @@ -376,7 +376,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:125 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:136 *** @@ -394,7 +394,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:112 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:123 *** @@ -412,7 +412,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:120 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:131 *** @@ -430,7 +430,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:118 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:129 *** @@ -448,7 +448,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:121 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:132 *** @@ -466,7 +466,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:122 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:133 *** @@ -484,7 +484,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:114 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:125 *** @@ -502,7 +502,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:115 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:126 *** @@ -524,7 +524,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:126 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:137 *** @@ -546,7 +546,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:108 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:119 *** @@ -564,7 +564,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:113 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:124 *** @@ -582,7 +582,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:127 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:138 *** @@ -600,4 +600,4 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:123 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:134 diff --git a/packages/tx/docs/interfaces/EIP4844CompatibleTx.md b/packages/tx/docs/interfaces/EIP4844CompatibleTx.md index c8a011f8f7..a206a48686 100644 --- a/packages/tx/docs/interfaces/EIP4844CompatibleTx.md +++ b/packages/tx/docs/interfaces/EIP4844CompatibleTx.md @@ -26,7 +26,7 @@ #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:138 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:149 *** @@ -40,7 +40,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:137 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:148 *** @@ -50,7 +50,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:146 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:157 *** @@ -60,7 +60,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:147 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:158 *** @@ -74,7 +74,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:107 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:118 *** @@ -88,7 +88,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:133 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:144 *** @@ -102,7 +102,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:98 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:109 *** @@ -116,7 +116,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:103 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:114 *** @@ -130,7 +130,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:100 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:111 *** @@ -140,7 +140,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:148 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:159 *** @@ -150,7 +150,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:149 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:160 *** @@ -160,7 +160,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:145 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:156 *** @@ -174,7 +174,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:142 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:153 *** @@ -188,7 +188,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:141 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:152 *** @@ -202,7 +202,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:99 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:110 *** @@ -216,7 +216,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:105 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:116 *** @@ -230,7 +230,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:106 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:117 *** @@ -244,7 +244,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:101 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:112 *** @@ -258,7 +258,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:109 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:120 *** @@ -272,7 +272,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:104 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:115 *** @@ -286,7 +286,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:102 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:113 ## Methods @@ -304,7 +304,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:128 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:139 *** @@ -322,7 +322,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:110 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:121 *** @@ -340,7 +340,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:111 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:122 *** @@ -358,7 +358,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:117 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:128 *** @@ -376,7 +376,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:134 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:145 *** @@ -394,7 +394,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:119 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:130 *** @@ -412,7 +412,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:124 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:135 *** @@ -430,7 +430,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:125 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:136 *** @@ -448,7 +448,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:112 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:123 *** @@ -466,7 +466,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:120 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:131 *** @@ -484,7 +484,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:118 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:129 *** @@ -502,7 +502,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:121 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:132 *** @@ -520,7 +520,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:122 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:133 *** @@ -534,7 +534,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:151 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:162 *** @@ -552,7 +552,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:114 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:125 *** @@ -570,7 +570,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:115 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:126 *** @@ -584,7 +584,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:150 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:161 *** @@ -606,7 +606,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:126 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:137 *** @@ -628,7 +628,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:108 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:119 *** @@ -646,7 +646,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:113 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:124 *** @@ -664,7 +664,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:127 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:138 *** @@ -682,4 +682,4 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:123 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:134 diff --git a/packages/tx/docs/interfaces/ImpersonatedTx.md b/packages/tx/docs/interfaces/ImpersonatedTx.md index 75d63b86cf..ec4343f894 100644 --- a/packages/tx/docs/interfaces/ImpersonatedTx.md +++ b/packages/tx/docs/interfaces/ImpersonatedTx.md @@ -27,7 +27,7 @@ Typed transaction with a new gas fee market mechanism #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:16 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:16 *** @@ -41,7 +41,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:14 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:14 *** @@ -55,7 +55,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:15 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:15 *** @@ -73,7 +73,7 @@ for FeeMarketEIP1559Transaction objects #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:31 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:31 *** @@ -87,7 +87,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:24 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:24 *** @@ -101,7 +101,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:14 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:14 *** @@ -115,7 +115,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:19 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:19 *** @@ -129,7 +129,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:19 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:19 *** @@ -143,7 +143,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:16 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:16 *** @@ -167,7 +167,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:18 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:18 *** @@ -181,7 +181,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:17 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:17 *** @@ -195,7 +195,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:15 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:15 *** @@ -209,7 +209,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:21 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:21 *** @@ -223,7 +223,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:22 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:22 *** @@ -237,7 +237,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:17 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:17 *** @@ -251,7 +251,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:25 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:25 *** @@ -265,7 +265,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:20 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:20 *** @@ -279,7 +279,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:18 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:18 ## Accessors @@ -301,7 +301,7 @@ Note: legacy txs will return tx type `0`. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:47 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:47 ## Methods @@ -322,7 +322,7 @@ tx type implementations. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:189 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:189 *** @@ -356,7 +356,7 @@ Pass true if the number also cannot equal one less the maximum value #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:168 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:168 *** @@ -396,7 +396,7 @@ Set this to `true` if the raw output of `ecsign` is used. If this is `false` (de #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:127 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:127 *** @@ -416,7 +416,7 @@ Return a compact error string representation of the object #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:135 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:135 *** @@ -436,7 +436,7 @@ The minimum amount of gas the tx must have (DataFee + TxFee + Creation Fee) #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:78 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:78 *** @@ -456,7 +456,7 @@ The amount of gas paid for the data in this tx #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:56 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:56 *** @@ -482,7 +482,7 @@ Base fee retrieved from block #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:61 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:61 *** @@ -506,7 +506,7 @@ serialized and doesn't need to be RLP encoded any more. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:111 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:111 *** @@ -534,7 +534,7 @@ const serializedMessage = tx.getMessageToSign() // use this for the HW wallet in #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:103 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:103 *** @@ -554,7 +554,7 @@ Computes a sha3-256 hash which can be used to verify the signature #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:122 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:122 *** @@ -574,7 +574,7 @@ Returns the sender's address #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:124 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:124 *** @@ -594,7 +594,7 @@ Returns the public key of the sender #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:126 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:126 *** @@ -620,7 +620,7 @@ The base fee of the block (will be set to 0 if not provided) #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:66 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:66 *** @@ -642,7 +642,7 @@ an array of error strings #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:69 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:69 *** @@ -665,7 +665,7 @@ Use [FeeMarketEIP1559Transaction.getMessageToSign](../classes/FeeMarketEIP1559Tr #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:118 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:118 *** @@ -683,7 +683,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:116 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:116 *** @@ -705,7 +705,7 @@ true if the transaction is valid, false otherwise #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:74 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:74 *** @@ -735,7 +735,7 @@ representation for external signing use [FeeMarketEIP1559Transaction.getMessageT #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:80 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:80 *** @@ -762,7 +762,7 @@ the RLP encoding of the values. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:91 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:91 *** @@ -792,7 +792,7 @@ const signedTx = tx.sign(privateKey) #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:138 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:138 *** @@ -829,7 +829,7 @@ on all supported capabilities. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:64 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:64 *** @@ -849,7 +849,7 @@ If the tx's `to` is to the creation address #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:96 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:96 *** @@ -869,7 +869,7 @@ Returns an object with the JSON representation of the transaction #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:131 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:131 *** @@ -889,4 +889,4 @@ Determines if the signature is valid #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:120 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:120 diff --git a/packages/tx/docs/interfaces/JsonRpcTx.md b/packages/tx/docs/interfaces/JsonRpcTx.md index 388c92c192..25738bb43c 100644 --- a/packages/tx/docs/interfaces/JsonRpcTx.md +++ b/packages/tx/docs/interfaces/JsonRpcTx.md @@ -14,7 +14,7 @@ #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:376 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:423 *** @@ -24,7 +24,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:388 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:435 *** @@ -34,7 +34,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:368 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:415 *** @@ -44,7 +44,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:369 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:416 *** @@ -54,7 +54,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:377 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:424 *** @@ -64,7 +64,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:370 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:417 *** @@ -74,7 +74,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:371 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:418 *** @@ -84,7 +84,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:372 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:419 *** @@ -94,7 +94,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:378 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:425 *** @@ -104,7 +104,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:379 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:426 *** @@ -114,7 +114,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:387 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:434 *** @@ -124,7 +124,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:373 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:420 *** @@ -134,7 +134,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:374 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:421 *** @@ -144,7 +144,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:380 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:427 *** @@ -154,7 +154,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:385 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:432 *** @@ -164,7 +164,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:386 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:433 *** @@ -174,7 +174,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:381 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:428 *** @@ -184,7 +184,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:382 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:429 *** @@ -194,7 +194,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:375 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:422 *** @@ -204,7 +204,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:384 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:431 *** @@ -214,4 +214,4 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:383 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:430 diff --git a/packages/tx/docs/interfaces/JsonTx.md b/packages/tx/docs/interfaces/JsonTx.md index d133c7ef20..5b829e6d19 100644 --- a/packages/tx/docs/interfaces/JsonTx.md +++ b/packages/tx/docs/interfaces/JsonTx.md @@ -21,154 +21,164 @@ and not all the values are present on all tx types #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:360 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:401 + +*** + +### authorizationList? + +> `optional` **authorizationList**: `AuthorizationList` + +#### Defined in + +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:402 *** ### blobVersionedHashes? -> `optional` **blobVersionedHashes**: `string`[] +> `optional` **blobVersionedHashes**: \`0x$\{string\}\`[] #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:365 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:407 *** ### chainId? -> `optional` **chainId**: `string` +> `optional` **chainId**: \`0x$\{string\}\` #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:359 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:400 *** ### data? -> `optional` **data**: `string` +> `optional` **data**: \`0x$\{string\}\` #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:354 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:395 *** ### gasLimit? -> `optional` **gasLimit**: `string` +> `optional` **gasLimit**: \`0x$\{string\}\` #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:352 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:393 *** ### gasPrice? -> `optional` **gasPrice**: `string` +> `optional` **gasPrice**: \`0x$\{string\}\` #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:351 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:392 *** ### maxFeePerBlobGas? -> `optional` **maxFeePerBlobGas**: `string` +> `optional` **maxFeePerBlobGas**: \`0x$\{string\}\` #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:364 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:406 *** ### maxFeePerGas? -> `optional` **maxFeePerGas**: `string` +> `optional` **maxFeePerGas**: \`0x$\{string\}\` #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:363 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:405 *** ### maxPriorityFeePerGas? -> `optional` **maxPriorityFeePerGas**: `string` +> `optional` **maxPriorityFeePerGas**: \`0x$\{string\}\` #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:362 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:404 *** ### nonce? -> `optional` **nonce**: `string` +> `optional` **nonce**: \`0x$\{string\}\` #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:350 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:391 *** ### r? -> `optional` **r**: `string` +> `optional` **r**: \`0x$\{string\}\` #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:356 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:397 *** ### s? -> `optional` **s**: `string` +> `optional` **s**: \`0x$\{string\}\` #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:357 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:398 *** ### to? -> `optional` **to**: `string` +> `optional` **to**: \`0x$\{string\}\` #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:353 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:394 *** ### type? -> `optional` **type**: `string` +> `optional` **type**: \`0x$\{string\}\` #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:361 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:403 *** ### v? -> `optional` **v**: `string` +> `optional` **v**: \`0x$\{string\}\` #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:355 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:396 *** ### value? -> `optional` **value**: `string` +> `optional` **value**: \`0x$\{string\}\` #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:358 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:399 diff --git a/packages/tx/docs/interfaces/TxData.md b/packages/tx/docs/interfaces/TxData.md index ccc0f402d5..71a432cf9f 100644 --- a/packages/tx/docs/interfaces/TxData.md +++ b/packages/tx/docs/interfaces/TxData.md @@ -14,7 +14,7 @@ #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:154 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:168 *** @@ -24,7 +24,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:155 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:169 *** @@ -34,7 +34,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:156 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:170 *** @@ -44,4 +44,14 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:157 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:171 + +*** + +### 4 + +> **4**: `EOACodeEIP7702TxData` + +#### Defined in + +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:172 diff --git a/packages/tx/docs/interfaces/TxOptions.md b/packages/tx/docs/interfaces/TxOptions.md index 532e090005..b0e83e303f 100644 --- a/packages/tx/docs/interfaces/TxOptions.md +++ b/packages/tx/docs/interfaces/TxOptions.md @@ -19,7 +19,7 @@ Gas cost for initcode size analysis will still be charged. Use with caution. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:65 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:71 *** @@ -38,7 +38,7 @@ Current default hardfork: `istanbul` #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:48 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:54 *** @@ -58,4 +58,4 @@ Default: true #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:60 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:66 diff --git a/packages/tx/docs/type-aliases/AccessList.md b/packages/tx/docs/type-aliases/AccessList.md index 399941430a..492be57936 100644 --- a/packages/tx/docs/type-aliases/AccessList.md +++ b/packages/tx/docs/type-aliases/AccessList.md @@ -10,4 +10,4 @@ ## Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:51 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:51 diff --git a/packages/tx/docs/type-aliases/AccessListItem.md b/packages/tx/docs/type-aliases/AccessListItem.md index 72d548377b..4efe030cd4 100644 --- a/packages/tx/docs/type-aliases/AccessListItem.md +++ b/packages/tx/docs/type-aliases/AccessListItem.md @@ -20,4 +20,4 @@ ## Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:45 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:45 diff --git a/packages/tx/docs/type-aliases/TypedTransaction.md b/packages/tx/docs/type-aliases/TypedTransaction.md index b2a71c3b03..b2fe533528 100644 --- a/packages/tx/docs/type-aliases/TypedTransaction.md +++ b/packages/tx/docs/type-aliases/TypedTransaction.md @@ -10,4 +10,4 @@ ## Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:92 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:102 diff --git a/packages/tx/package.json b/packages/tx/package.json index aed34a5cd2..d364a8ee22 100644 --- a/packages/tx/package.json +++ b/packages/tx/package.json @@ -19,6 +19,7 @@ "contributors": [ "Will Cory " ], + "sideEffects": false, "type": "module", "exports": { "./package.json": "./package.json", @@ -73,6 +74,5 @@ }, "publishConfig": { "access": "public" - }, - "sideEffects": false + } } \ No newline at end of file diff --git a/packages/txpool/docs/README.md b/packages/txpool/docs/README.md index 9eef604c28..b561d04097 100644 --- a/packages/txpool/docs/README.md +++ b/packages/txpool/docs/README.md @@ -34,4 +34,4 @@ Manages a pool of pending tx within tevm ## License 📄 - + diff --git a/packages/txpool/docs/_media/LICENSE b/packages/txpool/docs/_media/LICENSE deleted file mode 100644 index b5a4fa7a69..0000000000 --- a/packages/txpool/docs/_media/LICENSE +++ /dev/null @@ -1,22 +0,0 @@ -(The MIT License) - -Copyright 2020-2022 - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/packages/txpool/docs/classes/TxPool.md b/packages/txpool/docs/classes/TxPool.md index b4d7067e92..cbd2827ee8 100644 --- a/packages/txpool/docs/classes/TxPool.md +++ b/packages/txpool/docs/classes/TxPool.md @@ -22,6 +22,8 @@ module:service **`Experimental`** +Create new tx pool + #### Parameters • **options**: `TxPoolOptions` @@ -146,6 +148,12 @@ The number of txs currently in the pool **`Experimental`** +Adds a tx to the pool. + +If there is a tx in the pool with the same address and +nonce it will be replaced by the new tx, if it has a sufficient gas bump. +This also verifies certain constraints, if these are not met, tx will not be added to the pool. + #### Parameters • **tx**: `TypedTransaction` \| `ImpersonatedTx` @@ -172,6 +180,12 @@ Transaction **`Experimental`** +Adds a tx to the pool without validating it. + +If there is a tx in the pool with the same address and +nonce it will be replaced by the new tx, if it has a sufficient gas bump. +This also verifies certain constraints, if these are not met, tx will not be added to the pool. + #### Parameters • **tx**: `TypedTransaction` \| `ImpersonatedTx` @@ -194,6 +208,8 @@ Transaction **`Experimental`** +Regular tx pool cleanup + #### Returns `void` @@ -210,6 +226,8 @@ Transaction **`Experimental`** +Close pool + #### Returns `void` @@ -246,6 +264,8 @@ Transaction **`Experimental`** +Returns the available txs from the pool + #### Parameters • **txHashes**: readonly `Uint8Array`[] @@ -288,6 +308,8 @@ Array with tx objects **`Experimental`** +Open pool + #### Returns `boolean` @@ -304,6 +326,8 @@ Array with tx objects **`Experimental`** +Removes the given tx from the pool + #### Parameters • **txHash**: `string` @@ -326,6 +350,8 @@ Hash of the transaction **`Experimental`** +Remove txs included in the latest blocks from the tx pool + #### Parameters • **newBlocks**: `Block`[] @@ -346,6 +372,8 @@ Hash of the transaction **`Experimental`** +Start tx processing + #### Returns `boolean` @@ -362,6 +390,8 @@ Hash of the transaction **`Experimental`** +Stop pool execution + #### Returns `boolean` @@ -378,6 +408,19 @@ Hash of the transaction **`Experimental`** +Returns eligible txs to be mined sorted by price in such a way that the +nonce orderings within a single account are maintained. + +Note, this is not as trivial as it seems from the first look as there are three +different criteria that need to be taken into account (price, nonce, account +match), which cannot be done with any plain sorting method, as certain items +cannot be compared without context. + +This method first sorts the separates the list of transactions into individual +sender accounts and sorts them by nonce. After the account nonce ordering is +satisfied, the results are merged back together by price, always comparing only +the head transaction from each account. This is done via a heap to keep it fast. + #### Parameters • **baseFee** = `{}` diff --git a/packages/txpool/package.json b/packages/txpool/package.json index f8d3008f4f..a430caf430 100644 --- a/packages/txpool/package.json +++ b/packages/txpool/package.json @@ -19,6 +19,7 @@ "contributors": [ "Will Cory " ], + "sideEffects": false, "type": "module", "exports": { "./package.json": "./package.json", @@ -78,6 +79,5 @@ }, "publishConfig": { "access": "public" - }, - "sideEffects": false + } } \ No newline at end of file diff --git a/packages/utils/package.json b/packages/utils/package.json index a30c935151..52585044ac 100644 --- a/packages/utils/package.json +++ b/packages/utils/package.json @@ -19,6 +19,7 @@ "contributors": [ "Will Cory " ], + "sideEffects": false, "type": "module", "exports": { "./package.json": "./package.json", @@ -76,6 +77,5 @@ }, "publishConfig": { "access": "public" - }, - "sideEffects": false + } } \ No newline at end of file diff --git a/packages/vm/docs/README.md b/packages/vm/docs/README.md index c4a8443dcb..24eaf6ad4f 100644 --- a/packages/vm/docs/README.md +++ b/packages/vm/docs/README.md @@ -36,4 +36,4 @@ Some files are adapted from [ethereumjs](https://github.com/ethereumjs/ethereumj ## License 📄 - + diff --git a/packages/vm/docs/_media/LICENSE b/packages/vm/docs/_media/LICENSE deleted file mode 100644 index b5a4fa7a69..0000000000 --- a/packages/vm/docs/_media/LICENSE +++ /dev/null @@ -1,22 +0,0 @@ -(The MIT License) - -Copyright 2020-2022 - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/packages/vm/docs/functions/deepCopy.md b/packages/vm/docs/functions/deepCopy.md index e7b302c98a..2812013a53 100644 --- a/packages/vm/docs/functions/deepCopy.md +++ b/packages/vm/docs/functions/deepCopy.md @@ -16,8 +16,6 @@ [`DeepCopy`](../type-aliases/DeepCopy.md) -## Throws - ## Defined in [packages/vm/src/actions/deepCopy.js:20](https://github.com/evmts/tevm-monorepo/blob/main/packages/vm/src/actions/deepCopy.js#L20) diff --git a/packages/vm/docs/functions/execHardfork.md b/packages/vm/docs/functions/execHardfork.md index 2e351869ca..ef97d40a41 100644 --- a/packages/vm/docs/functions/execHardfork.md +++ b/packages/vm/docs/functions/execHardfork.md @@ -8,13 +8,6 @@ > **execHardfork**(`hardfork`, `preMergeHf`): `string` -Returns the hardfork excluding the merge hf which has -no effect on the vm execution capabilities. - -This is particularly useful in executing/evaluating the transaction -when chain td is not available at many places to correctly set the -hardfork in for e.g. vm or txs or when the chain is not fully synced yet. - ## Parameters • **hardfork**: `string` @@ -25,8 +18,6 @@ hardfork in for e.g. vm or txs or when the chain is not fully synced yet. `string` -## Throws - ## Defined in [packages/vm/src/actions/execHardfork.js:14](https://github.com/evmts/tevm-monorepo/blob/main/packages/vm/src/actions/execHardfork.js#L14) diff --git a/packages/vm/docs/functions/txLogsBloom.md b/packages/vm/docs/functions/txLogsBloom.md index d787e1ed39..fd7a76e3ca 100644 --- a/packages/vm/docs/functions/txLogsBloom.md +++ b/packages/vm/docs/functions/txLogsBloom.md @@ -18,10 +18,72 @@ Creates a bloom filter from the logs. The logs to create the bloom filter from. -• **common**: `Common` +• **common** The common object.')} +• **common.blockExplorers?** + +Collection of block explorers + +• **common.blockExplorers.default**: `ChainBlockExplorer` + +• **common.contracts?** + +Collection of contracts + +• **common.contracts.ensRegistry?**: `ChainContract` + +• **common.contracts.ensUniversalResolver?**: `ChainContract` + +• **common.contracts.multicall3?**: `ChainContract` + +• **common.copy** + +• **common.custom?**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +• **common.ethjsCommon**: `Common` + +• **common.fees?**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +• **common.formatters?**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +• **common.id**: `number` + +ID in number form + +• **common.name**: `string` + +Human-readable name + +• **common.nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +• **common.rpcUrls** + +Collection of RPC endpoints + +• **common.rpcUrls.default**: `ChainRpcUrls` + +• **common.serializers?**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +• **common.sourceId?**: `number` + +Source Chain ID (ie. the L1 chain) + +• **common.testnet?**: `boolean` + +Flag for test networks + ## Returns `Bloom` diff --git a/packages/vm/docs/interfaces/AfterTxEvent.md b/packages/vm/docs/interfaces/AfterTxEvent.md index 2c06d48059..ec1a33c201 100644 --- a/packages/vm/docs/interfaces/AfterTxEvent.md +++ b/packages/vm/docs/interfaces/AfterTxEvent.md @@ -90,7 +90,7 @@ Address of created account during transaction, if any #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:248 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:273 *** @@ -106,7 +106,7 @@ Contains the results from running the code, if any, as described in runCode #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:252 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:277 *** diff --git a/packages/vm/docs/interfaces/BuilderOpts.md b/packages/vm/docs/interfaces/BuilderOpts.md index d8a0cc58fa..b8705900a9 100644 --- a/packages/vm/docs/interfaces/BuilderOpts.md +++ b/packages/vm/docs/interfaces/BuilderOpts.md @@ -54,7 +54,7 @@ packages/block/types/types.d.ts:59 ### common -> **common**: `Common` +> **common**: `object` A Common object defining the chain and the hardfork a block/block header belongs to. @@ -66,6 +66,118 @@ hardfork in the Common class. Current default hardfork: `merge` +#### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +##### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +#### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +#### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +#### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +#### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +#### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +#### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +##### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +#### ethjsCommon + +> **ethjsCommon**: `Common` + +#### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +#### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +#### id + +> **id**: `number` + +ID in number form + +#### name + +> **name**: `string` + +Human-readable name + +#### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +#### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +##### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +#### rpcUrls.default + +> **default**: `ChainRpcUrls` + +#### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +#### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +#### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + #### Inherited from `BlockOptions.common` diff --git a/packages/vm/docs/interfaces/RunTxResult.md b/packages/vm/docs/interfaces/RunTxResult.md index c5f0d04997..7b576dc21e 100644 --- a/packages/vm/docs/interfaces/RunTxResult.md +++ b/packages/vm/docs/interfaces/RunTxResult.md @@ -78,7 +78,7 @@ Address of created account during transaction, if any #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:248 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:273 *** @@ -94,7 +94,7 @@ Contains the results from running the code, if any, as described in runCode #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:252 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:277 *** diff --git a/packages/vm/docs/interfaces/VMOpts.md b/packages/vm/docs/interfaces/VMOpts.md index 41b4ebb392..d6f689cdbf 100644 --- a/packages/vm/docs/interfaces/VMOpts.md +++ b/packages/vm/docs/interfaces/VMOpts.md @@ -46,7 +46,7 @@ A Blockchain object for storing/retrieving blocks ### common? -> `optional` **common**: `Common` +> `optional` **common**: `object` Use a Common instance if you want to change the chain setup. @@ -68,6 +68,118 @@ Default setup if no `Common` instance is provided: - `hardfork`: `paris` - `eips`: `[]` +#### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +##### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +#### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +#### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +#### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +#### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +#### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +#### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +##### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +#### ethjsCommon + +> **ethjsCommon**: `Common` + +#### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +#### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +#### id + +> **id**: `number` + +ID in number form + +#### name + +> **name**: `string` + +Human-readable name + +#### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +#### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +##### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +#### rpcUrls.default + +> **default**: `ChainRpcUrls` + +#### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +#### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +#### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + #### Defined in [packages/vm/src/utils/VMOpts.ts:33](https://github.com/evmts/tevm-monorepo/blob/main/packages/vm/src/utils/VMOpts.ts#L33) diff --git a/packages/vm/package.json b/packages/vm/package.json index 6966381e32..818aa8af03 100644 --- a/packages/vm/package.json +++ b/packages/vm/package.json @@ -19,6 +19,7 @@ "contributors": [ "Will Cory " ], + "sideEffects": false, "type": "module", "exports": { "./package.json": "./package.json", @@ -84,6 +85,5 @@ }, "publishConfig": { "access": "public" - }, - "sideEffects": false + } } \ No newline at end of file diff --git a/tevm/bin/tevm.js b/tevm/bin/tevm.js deleted file mode 100755 index 9a7273286f..0000000000 --- a/tevm/bin/tevm.js +++ /dev/null @@ -1,83 +0,0 @@ -#!/usr/bin/env node -import { existsSync, mkdirSync, readFileSync, statSync, writeFileSync } from 'node:fs'; -import { access, mkdir, readFile, stat, writeFile } from 'node:fs/promises'; -import path from 'node:path'; -import { Command } from 'commander'; -import { bundler } from '@tevm/base-bundler'; -import { createCache } from '@tevm/bundler-cache'; -import { loadConfig } from '@tevm/config'; -import { runSync } from 'effect/Effect'; -import { glob } from 'glob'; -// @ts-expect-error -import * as solc from 'solc'; - -/** - * @typedef {import('@tevm/base-bundler').FileAccessObject} FileAccessObject - */ - -/** @type {FileAccessObject} */ -const fao = { - existsSync: existsSync, - readFile: readFile, - readFileSync: readFileSync, - writeFileSync: writeFileSync, - statSync, - stat, - mkdirSync, - mkdir, - writeFile, - exists: async (path) => { - try { - await access(path); - return true; - } catch (e) { - return false; - } - }, -}; - -/** - * Generate types from Solidity contracts. - * - * @param {string} cwd - The current working directory. - * @param {string[]} include - The glob pattern to include Solidity files. - */ -const generate = (cwd, include) => { - console.log('Generating types from contracts...', { dir: cwd, include }); - const files = glob.sync(include, { cwd }); - if (files.length === 0) { - throw new Error('No files found'); - } - files.forEach(async (file) => { - const fileName = file.split('/').at(-1); - const fileDir = file.split('/').slice(0, -1).join('/'); - const config = runSync(loadConfig(cwd)); - const solcCache = createCache(config.cacheDir, fao, cwd); - const plugin = bundler(config, console, fao, solc, solcCache); - const tsContent = await plugin.resolveTsModule(`./${file}`, cwd, false, true); - await writeFile(path.join(fileDir, `${fileName}.ts`), tsContent.code); - }); -}; - -// Initialize Commander -const program = new Command(); - -program - .name('tevm') - .description('TEVM CLI') - .version('1.0.0'); - -program - .command('gen') - .description('Generate types from Solidity contracts. If files in in .s.sol it will also compile bytecode') - .argument('', 'Glob pattern to include Solidity files') - .option('-c, --config ', 'Path to the configuration file', process.cwd()) - .action((include, options) => { - const cwd = options.config || process.cwd(); - const includePattern = include.split(','); - generate(cwd, includePattern); - }); - -// Parse the arguments -program.parse(process.argv); - diff --git a/tevm/docs/README.md b/tevm/docs/README.md index 65ff79c492..56b568943b 100644 --- a/tevm/docs/README.md +++ b/tevm/docs/README.md @@ -67,7 +67,7 @@ console.log(HelloWorld.abi); console.log(HelloWorld.bytecode); ``` -3. Initialize a [Tevm memory client](./packages/memory-client/docs/functions/createMemoryClient.md) and execute your Script using the [`tevm.script`](./packages/actions/docs/type-aliases/ScriptHandler.md) action +3. Initialize a [Tevm memory client]() and execute your Script using the [`tevm.script`]() action ```typescript import { HelloWorld } from "./HelloWorld.sol"; @@ -86,8 +86,8 @@ This is just a small subset of what Tevm offers. See [docs](https://tevm.sh/) fo Contributions are encouraged, but please open an issue before doing any major changes to make sure your change will be accepted. -See [CONTRIBUTING.md](_media/CONTRIBUTING.md) for contributing information +See [CONTRIBUTING.md]() for contributing information ## License 📄 - + diff --git a/tevm/docs/_media/CONTRIBUTING.md b/tevm/docs/_media/CONTRIBUTING.md deleted file mode 100644 index 432f799c2a..0000000000 --- a/tevm/docs/_media/CONTRIBUTING.md +++ /dev/null @@ -1,212 +0,0 @@ -## Contributing to Tevm - -## Quick start - -1. Install pnpm 9.x.x for installing node_modules - -```bash -npm i pnpm@9 --global && pnpm --version -``` - -2. Install bun - -```bash -npm i bun --global && bun --version -``` - -or run bun update if already installed - -```bash -bun update -``` - -3. Update submodules - -```bash -git submodule update --init --recursive -``` - -4. Set environment variables - -In your path must be the following environment variables for the tests - -```bash -export TEVM_RPC_URLS_MAINNET= -export TEVM_RPC_URLS_OPTIMISM= -``` - -These rpc urls are a comma seperated list of at least one RPC provider such `https://mainnet.optimism.io`. The tests will rate limit and load balance across all urls - -5. Run everything - -`bun allz` will run everything - -`bun all` will run a smaller subset of everything - -```bash -bun allz -``` - -This includes - -- linting package.json -- linting npm build -- linting unused deps -- linting source code -- generated docs -- building all .d.ts types for all packages -- building all cjs for all packages -- running all tests -- running all dev fixtures - -3. Understand the repo in [monorepo section](#monorepo) and [packages](#packages) sections - -## Secrets - -Many of the tests use alchemy. They do not require an alchemy key but not providing one can cause throttling. To provide an alchemy key set `TEVM_TEST_ALCHEMY_KEY` environment variable in your shell. - -## Nx can get slow - -Sometimes you may notice nx slowing down. When this happens try running `pnpm nx reset` and it should reset it to being fast again. - -## Monorepo - -Tevm is a monorepo using - -- [nx](https://nx.dev/concepts/mental-model) for caching and task management -- [bun](https://bun.sh/docs) for script runner and workspace node_module management -- [changesets](./.changeset/) for package versioning - -For a list of all packages, see the `workspaces` key in the root level [package.json](./package.json) - -## Packages - -Tevm is heavily broken up into small packages. To see the entire package graph use nx - -```bash -bun run nx graph -``` - -For more information the [reference docs](https://tevm.sh) are a useful resource. They are generated from the source code and link back to it - -#### Build packages - -- [@tevm/ts-plugin](./ts-plugin) is the LSP (language service protocol) plugin. It is what allows code editors such as VSCode to correctly infer types of solidity imports. -- [bundlers/\*](./bundlers) Are where all the supported bundlers live. Most are created using [@tevm/unplugin](./bundlers/unplugin) which implements a rollup plugin once to be reused in many packages including [@tevm/webpack](./bundlers/webpack) and [@tevm/vite](./bundlers/vite) and more. -- [@tevm/config](./config) is the package that loads the Tevm config - -#### Runtime packages - -- [@tevm/contract](./core) is the main entry point for all runtime functionality. - -#### Docs - -- [@tevm/docs](./docs) is the [vitepress docs site](https://tevm.sh). Its reference docs are generated via `bun generate:docs` - -#### Example apps - -Example apps are in [/examples/\*](./examples). [@tevm/example-esbuild](./examples/esbuild) has a vitest test and is the simplist app. - -## Code best practices - -#### JavaScript with jsdoc - -`@tevm` is written in javascript with jsdoc so its `esm` build does not need to be built. This means any user using modern `esm` will be using the same src code in their node_modules as what is here. - -This means all tevm packages run without being built by default and the same src code is shipped to most users - -- [src/index.js](./src/index.js) - the entrypoint to the package - -**Note** there is still 100% typesafety. TypeScript is able to typecheck via setting `checkJs: true` in the tsconfig and using jsdoc. - -#### Types - -The types are built to cache their result for end users. - -``` -bun build:types -``` - -- [tsconfig](./tsconfig.json) - @tevm/config tsconfig -- [@tevm/tsconfig](../tsconfig/base.json) - base tsconfig inherited from - -## Running tests - -``` -bun run test -``` - -`@tevm/config` has >99% test coverage. Run the tests with `bun run test` - -Note `bun test` will run bun instead of [vitest](https://vitest.dev) resulting in errors - -## Fixtures - -Fixtures in [src/fixtures](./src/fixtures/) exist both for the vitest tests and also can be loaded in watch mode. - -The best way to debug a bug or implement a new feature is to first add a new fixture to use in test or dev server - -Some fixtures are expected to error and the dev server will succeed if they do error. Which fixtures should error is configured in [scripts/runFixture.ts](./scripts/runFixture.ts) - -Fixtures run with debug logging turned on. Debug logging is added to every function along with strong error handling so most debugging tasks won't need to involve adding console.logs if you are using a fixture. - -#### Running all fixtures - -```bash -bun dev -``` - -#### Running a specific fixtures - -```bash -bun fixture basic -``` - -Valid names include any of the folder names in [src/fixtures](./fixtures). The default is basic - -#### Adding a fixture - -1. `cp -r src/fixtures/basic src/fixtures/myNewFixture` -2. update your fixture -3. Load your fixture `bun fixture myNewFixture` - -Now you can implement your feature or use your fixture to write a test. - -## Running linter - -By default the linter runs in --fix mode - -```basy -bun lint && bun format -``` - -The linter used is biome not prettier or eslint - -#### Generating docs - -Docs are generated in the `docs` folder of every package as well as the [main docs site](./docs) - -``` -bun generate:docs -``` - -Docs are generated based on the jsdoc and type errors - -#### Barrel files - -Whenever a new API is added, you will need to update a lot of barrel files. Though tedious this helps keep the packages stable from accidental breaking changes or exporting something that should be private. You will need to update the following places: - -- All the `index.js` in your package -- Possibly the top level `src/index.ts` to update the types too if -- Update the [tevm](./tevm) package (unless it's a build tool change) -- Update the [@tevm/bundler](./bundler/) package if it's a build tool api - -If you add a lot of files, there is a tool to automatically generate a barrel file in your folder in [`scripts`](./scripts/createBarrelFiles.ts) - -## Clean build - -If you ever have a `wtf` moment, consider doing a clean build. It will remove node_modules and then rebuild repo from scratch - -``` -pnpm all:clean -``` diff --git a/tevm/docs/_media/LICENSE b/tevm/docs/_media/LICENSE deleted file mode 100644 index b5a4fa7a69..0000000000 --- a/tevm/docs/_media/LICENSE +++ /dev/null @@ -1,22 +0,0 @@ -(The MIT License) - -Copyright 2020-2022 - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/tevm/docs/address/classes/Address.md b/tevm/docs/address/classes/Address.md index 7774bfa8b8..329175635d 100644 --- a/tevm/docs/address/classes/Address.md +++ b/tevm/docs/address/classes/Address.md @@ -49,7 +49,7 @@ address = createAddress('55'.repeat(20)); #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/address.d.ts:6 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/address.d.ts:7 ## Properties @@ -63,7 +63,7 @@ node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/e #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/address.d.ts:5 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/address.d.ts:6 ## Methods @@ -87,7 +87,7 @@ Is address equal to another. #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/address.d.ts:42 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/address.d.ts:43 *** @@ -108,7 +108,7 @@ by EIP-1352 #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/address.d.ts:51 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/address.d.ts:52 *** @@ -128,7 +128,7 @@ Is address zero. #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/address.d.ts:46 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/address.d.ts:47 *** @@ -148,7 +148,7 @@ Returns a new Uint8Array representation of address. #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/address.d.ts:59 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/address.d.ts:60 *** @@ -156,21 +156,19 @@ node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/e > **toString**(): \`0x$\{string\}\` -Returns the checksummed address. +Returns hex encoding of address. #### Returns \`0x$\{string\}\` -The checksummed address. - -#### Overrides +#### Inherited from [`EthjsAddress`](../../utils/classes/EthjsAddress.md).[`toString`](../../utils/classes/EthjsAddress.md#tostring) #### Defined in -packages/address/types/Address.d.ts:25 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/address.d.ts:56 *** @@ -196,7 +194,7 @@ A private key must be 256 bits wide #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/address.d.ts:25 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/address.d.ts:26 *** @@ -222,7 +220,7 @@ The two points of an uncompressed key #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/address.d.ts:20 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/address.d.ts:21 *** @@ -248,7 +246,7 @@ Hex-encoded address #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/address.d.ts:15 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/address.d.ts:16 *** @@ -278,7 +276,7 @@ The nonce of the from account #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/address.d.ts:31 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/address.d.ts:32 *** @@ -312,7 +310,7 @@ The init code of the contract being created #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/address.d.ts:38 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/address.d.ts:39 *** @@ -332,4 +330,4 @@ Returns the zero address. #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/address.d.ts:10 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/address.d.ts:11 diff --git a/tevm/docs/block/classes/Block.md b/tevm/docs/block/classes/Block.md index 8de019d786..c73d62dbd4 100644 --- a/tevm/docs/block/classes/Block.md +++ b/tevm/docs/block/classes/Block.md @@ -67,7 +67,119 @@ packages/block/types/block.d.ts:26 ### common -> `readonly` **common**: [`Common`](../../common/type-aliases/Common.md) +> `readonly` **common**: `object` + +#### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +##### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +#### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +#### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +#### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +#### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +#### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +#### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +##### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +#### ethjsCommon + +> **ethjsCommon**: `Common` + +#### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +#### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +#### id + +> **id**: `number` + +ID in number form + +#### name + +> **name**: `string` + +Human-readable name + +#### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +#### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +##### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +#### rpcUrls.default + +> **default**: `ChainRpcUrls` + +#### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +#### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +#### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks #### Defined in diff --git a/tevm/docs/block/classes/BlockHeader.md b/tevm/docs/block/classes/BlockHeader.md index 56688b2c16..6695e35a70 100644 --- a/tevm/docs/block/classes/BlockHeader.md +++ b/tevm/docs/block/classes/BlockHeader.md @@ -79,7 +79,119 @@ packages/block/types/header.d.ts:13 ### common -> `readonly` **common**: [`Common`](../../common/type-aliases/Common.md) +> `readonly` **common**: `object` + +#### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +##### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +#### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +#### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +#### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +#### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +#### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +#### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +##### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +#### ethjsCommon + +> **ethjsCommon**: `Common` + +#### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +#### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +#### id + +> **id**: `number` + +ID in number form + +#### name + +> **name**: `string` + +Human-readable name + +#### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +#### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +##### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +#### rpcUrls.default + +> **default**: `ChainRpcUrls` + +#### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +#### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +#### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks #### Defined in diff --git a/tevm/docs/block/interfaces/BlockData.md b/tevm/docs/block/interfaces/BlockData.md index 15e5634cd0..bc25a85421 100644 --- a/tevm/docs/block/interfaces/BlockData.md +++ b/tevm/docs/block/interfaces/BlockData.md @@ -46,7 +46,7 @@ packages/block/types/types.d.ts:139 ### transactions? -> `optional` **transactions**: (`LegacyTxData` \| `AccessListEIP2930TxData` \| `FeeMarketEIP1559TxData` \| `BlobEIP4844TxData`)[] +> `optional` **transactions**: (`LegacyTxData` \| `AccessListEIP2930TxData` \| `FeeMarketEIP1559TxData` \| `BlobEIP4844TxData` \| `EOACodeEIP7702TxData`)[] #### Defined in diff --git a/tevm/docs/block/interfaces/BlockOptions.md b/tevm/docs/block/interfaces/BlockOptions.md index 886e3c68da..a852115a7c 100644 --- a/tevm/docs/block/interfaces/BlockOptions.md +++ b/tevm/docs/block/interfaces/BlockOptions.md @@ -48,7 +48,7 @@ packages/block/types/types.d.ts:59 ### common -> **common**: [`Common`](../../common/type-aliases/Common.md) +> **common**: `object` A [Common](../../common/type-aliases/Common.md) object defining the chain and the hardfork a block/block header belongs to. @@ -60,6 +60,118 @@ hardfork in the [Common](../../common/type-aliases/Common.md) class. Current default hardfork: `merge` +#### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +##### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +#### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +#### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +#### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +#### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +#### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +#### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +##### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +#### ethjsCommon + +> **ethjsCommon**: `Common` + +#### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +#### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +#### id + +> **id**: `number` + +ID in number form + +#### name + +> **name**: `string` + +Human-readable name + +#### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +#### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +##### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +#### rpcUrls.default + +> **default**: `ChainRpcUrls` + +#### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +#### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +#### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + #### Defined in packages/block/types/types.d.ts:23 diff --git a/tevm/docs/block/interfaces/HeaderData.md b/tevm/docs/block/interfaces/HeaderData.md index 5f18b97b5a..130d05ec31 100644 --- a/tevm/docs/block/interfaces/HeaderData.md +++ b/tevm/docs/block/interfaces/HeaderData.md @@ -12,7 +12,7 @@ A block header's data. ### baseFeePerGas? -> `optional` **baseFeePerGas**: [`BigIntLike`](../../utils/type-aliases/BigIntLike.md) +> `optional` **baseFeePerGas**: `string` \| `number` \| `bigint` \| `Uint8Array` #### Defined in @@ -22,7 +22,7 @@ packages/block/types/types.d.ts:121 ### blobGasUsed? -> `optional` **blobGasUsed**: [`BigIntLike`](../../utils/type-aliases/BigIntLike.md) +> `optional` **blobGasUsed**: `string` \| `number` \| `bigint` \| `Uint8Array` #### Defined in @@ -32,7 +32,7 @@ packages/block/types/types.d.ts:123 ### coinbase? -> `optional` **coinbase**: [`AddressLike`](../../utils/type-aliases/AddressLike.md) +> `optional` **coinbase**: `string` \| [`EthjsAddress`](../../utils/classes/EthjsAddress.md) \| `Uint8Array` #### Defined in @@ -42,7 +42,7 @@ packages/block/types/types.d.ts:108 ### difficulty? -> `optional` **difficulty**: [`BigIntLike`](../../utils/type-aliases/BigIntLike.md) +> `optional` **difficulty**: `string` \| `number` \| `bigint` \| `Uint8Array` #### Defined in @@ -52,7 +52,7 @@ packages/block/types/types.d.ts:113 ### excessBlobGas? -> `optional` **excessBlobGas**: [`BigIntLike`](../../utils/type-aliases/BigIntLike.md) +> `optional` **excessBlobGas**: `string` \| `number` \| `bigint` \| `Uint8Array` #### Defined in @@ -62,7 +62,7 @@ packages/block/types/types.d.ts:124 ### extraData? -> `optional` **extraData**: [`BytesLike`](../../utils/type-aliases/BytesLike.md) +> `optional` **extraData**: `string` \| `number` \| `bigint` \| `Uint8Array` \| `number`[] \| `TransformabletoBytes` #### Defined in @@ -72,7 +72,7 @@ packages/block/types/types.d.ts:118 ### gasLimit? -> `optional` **gasLimit**: [`BigIntLike`](../../utils/type-aliases/BigIntLike.md) +> `optional` **gasLimit**: `string` \| `number` \| `bigint` \| `Uint8Array` #### Defined in @@ -82,7 +82,7 @@ packages/block/types/types.d.ts:115 ### gasUsed? -> `optional` **gasUsed**: [`BigIntLike`](../../utils/type-aliases/BigIntLike.md) +> `optional` **gasUsed**: `string` \| `number` \| `bigint` \| `Uint8Array` #### Defined in @@ -92,7 +92,7 @@ packages/block/types/types.d.ts:116 ### logsBloom? -> `optional` **logsBloom**: [`BytesLike`](../../utils/type-aliases/BytesLike.md) +> `optional` **logsBloom**: `string` \| `number` \| `bigint` \| `Uint8Array` \| `number`[] \| `TransformabletoBytes` #### Defined in @@ -102,7 +102,7 @@ packages/block/types/types.d.ts:112 ### mixHash? -> `optional` **mixHash**: [`BytesLike`](../../utils/type-aliases/BytesLike.md) +> `optional` **mixHash**: `string` \| `number` \| `bigint` \| `Uint8Array` \| `number`[] \| `TransformabletoBytes` #### Defined in @@ -112,7 +112,7 @@ packages/block/types/types.d.ts:119 ### nonce? -> `optional` **nonce**: [`BytesLike`](../../utils/type-aliases/BytesLike.md) +> `optional` **nonce**: `string` \| `number` \| `bigint` \| `Uint8Array` \| `number`[] \| `TransformabletoBytes` #### Defined in @@ -122,7 +122,7 @@ packages/block/types/types.d.ts:120 ### number? -> `optional` **number**: [`BigIntLike`](../../utils/type-aliases/BigIntLike.md) +> `optional` **number**: `string` \| `number` \| `bigint` \| `Uint8Array` #### Defined in @@ -132,7 +132,7 @@ packages/block/types/types.d.ts:114 ### parentBeaconBlockRoot? -> `optional` **parentBeaconBlockRoot**: [`BytesLike`](../../utils/type-aliases/BytesLike.md) +> `optional` **parentBeaconBlockRoot**: `string` \| `number` \| `bigint` \| `Uint8Array` \| `number`[] \| `TransformabletoBytes` #### Defined in @@ -142,7 +142,7 @@ packages/block/types/types.d.ts:125 ### parentHash? -> `optional` **parentHash**: [`BytesLike`](../../utils/type-aliases/BytesLike.md) +> `optional` **parentHash**: `string` \| `number` \| `bigint` \| `Uint8Array` \| `number`[] \| `TransformabletoBytes` #### Defined in @@ -152,7 +152,7 @@ packages/block/types/types.d.ts:106 ### receiptTrie? -> `optional` **receiptTrie**: [`BytesLike`](../../utils/type-aliases/BytesLike.md) +> `optional` **receiptTrie**: `string` \| `number` \| `bigint` \| `Uint8Array` \| `number`[] \| `TransformabletoBytes` #### Defined in @@ -162,7 +162,7 @@ packages/block/types/types.d.ts:111 ### requestsRoot? -> `optional` **requestsRoot**: [`BytesLike`](../../utils/type-aliases/BytesLike.md) +> `optional` **requestsRoot**: `string` \| `number` \| `bigint` \| `Uint8Array` \| `number`[] \| `TransformabletoBytes` #### Defined in @@ -172,7 +172,7 @@ packages/block/types/types.d.ts:126 ### stateRoot? -> `optional` **stateRoot**: [`BytesLike`](../../utils/type-aliases/BytesLike.md) +> `optional` **stateRoot**: `string` \| `number` \| `bigint` \| `Uint8Array` \| `number`[] \| `TransformabletoBytes` #### Defined in @@ -182,7 +182,7 @@ packages/block/types/types.d.ts:109 ### timestamp? -> `optional` **timestamp**: [`BigIntLike`](../../utils/type-aliases/BigIntLike.md) +> `optional` **timestamp**: `string` \| `number` \| `bigint` \| `Uint8Array` #### Defined in @@ -192,7 +192,7 @@ packages/block/types/types.d.ts:117 ### transactionsTrie? -> `optional` **transactionsTrie**: [`BytesLike`](../../utils/type-aliases/BytesLike.md) +> `optional` **transactionsTrie**: `string` \| `number` \| `bigint` \| `Uint8Array` \| `number`[] \| `TransformabletoBytes` #### Defined in @@ -202,7 +202,7 @@ packages/block/types/types.d.ts:110 ### uncleHash? -> `optional` **uncleHash**: [`BytesLike`](../../utils/type-aliases/BytesLike.md) +> `optional` **uncleHash**: `string` \| `number` \| `bigint` \| `Uint8Array` \| `number`[] \| `TransformabletoBytes` #### Defined in @@ -212,7 +212,7 @@ packages/block/types/types.d.ts:107 ### withdrawalsRoot? -> `optional` **withdrawalsRoot**: [`BytesLike`](../../utils/type-aliases/BytesLike.md) +> `optional` **withdrawalsRoot**: `string` \| `number` \| `bigint` \| `Uint8Array` \| `number`[] \| `TransformabletoBytes` #### Defined in diff --git a/tevm/docs/blockchain/functions/getBlockFromRpc.md b/tevm/docs/blockchain/functions/getBlockFromRpc.md index 143f6fb9c3..46ed098da7 100644 --- a/tevm/docs/blockchain/functions/getBlockFromRpc.md +++ b/tevm/docs/blockchain/functions/getBlockFromRpc.md @@ -20,7 +20,69 @@ • **\_\_namedParameters.transport.request**: `EIP1193RequestFn`\<`undefined`\> -• **common**: [`Common`](../../common/type-aliases/Common.md) +• **common** + +• **common.blockExplorers?** + +Collection of block explorers + +• **common.blockExplorers.default**: `ChainBlockExplorer` + +• **common.contracts?** + +Collection of contracts + +• **common.contracts.ensRegistry?**: `ChainContract` + +• **common.contracts.ensUniversalResolver?**: `ChainContract` + +• **common.contracts.multicall3?**: `ChainContract` + +• **common.copy** + +• **common.custom?**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +• **common.ethjsCommon**: `Common` + +• **common.fees?**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +• **common.formatters?**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +• **common.id**: `number` + +ID in number form + +• **common.name**: `string` + +Human-readable name + +• **common.nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +• **common.rpcUrls** + +Collection of RPC endpoints + +• **common.rpcUrls.default**: `ChainRpcUrls` + +• **common.serializers?**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +• **common.sourceId?**: `number` + +Source Chain ID (ie. the L1 chain) + +• **common.testnet?**: `boolean` + +Flag for test networks ## Returns diff --git a/tevm/docs/bundler/config/functions/defineConfig.md b/tevm/docs/bundler/config/functions/defineConfig.md index 4c2ae064e3..3a1a5a688c 100644 --- a/tevm/docs/bundler/config/functions/defineConfig.md +++ b/tevm/docs/bundler/config/functions/defineConfig.md @@ -30,19 +30,6 @@ Typesafe way to create an Tevm CompilerConfig `Effect`\<`never`, `DefineConfigError`, `ResolvedCompilerConfig`\> -## Example - -```ts -import { defineConfig } from '@tevm/ts-plugin' - -export default defineConfig(() => ({ - lib: ['lib'], - remappings: { - 'foo': 'foo/bar' - } -}) -``` - ## Defined in bundler-packages/config/types/defineConfig.d.ts:35 diff --git a/tevm/docs/bundler/esbuild-plugin/functions/esbuildPluginTevm.md b/tevm/docs/bundler/esbuild-plugin/functions/esbuildPluginTevm.md index ba0248e1e4..d2ce658e31 100644 --- a/tevm/docs/bundler/esbuild-plugin/functions/esbuildPluginTevm.md +++ b/tevm/docs/bundler/esbuild-plugin/functions/esbuildPluginTevm.md @@ -23,77 +23,6 @@ To configure add this plugin to your esbuild config and add the ts-plugin to you `any` -## Examples - -```typescript -import { esbuildPluginTevm } from '@tevm/esbuild-plugin' -import { build } from 'esbuild' - -build({ - entryPoints: ['src/index.js'], - outdir: 'dist', - bundle: true, - plugins: [esbuildPluginTevm()], -}) -``` - -For LSP so your editor recognizes the solidity imports correctly you must also configure tevm/ts-plugin in your tsconfig.json -The ts-plugin will provide type hints, code completion, and other features. - -```json -{ - "compilerOptions": { - "plugins": [{ "name": "tevm/ts-plugin" }] - } -} -``` - -Once the esbuild plugin and the ts-plugin are configured, you can import Solidity files in JavaScript. The compiler will -turn them into Tevm `Contract` instances. - -```typescript -// Solidity imports are automaticlaly turned into Tevm Contract objects -import { ERC20 } from '@openzeppelin/contracts/token/ERC20/ERC20.sol' -import { createTevm } from 'tevm' - -console.log(ERC20.abi) -console.log(ERC20.humanReadableAbi) -console.log(ERC20.bytecode) - -tevm.contract( - ERC20.withAddress(.read.balanceOf() -) -``` - -Under the hood the esbuild plugin is creating a virtual file for ERC20.sol called ERC20.sol.cjs that looks like this - -```typescript -import { createContract } from '@tevm/contract' - -export const ERC20 = createContract({ - name: 'ERC20', - humanReadableAbi: [ 'function balanceOf(address): uint256', ... ], - bytecode: '0x...', - deployedBytecode: '0x...', -}) -``` - -For custom configuration of the Tevm compiler add a [tevm.config.json](https://todo.todo.todo) file to your project root. - -```json -{ - foundryProject?: boolean | string | undefined, - libs: ['lib'], - remappings: {'foo': 'vendored/foo'}, - debug: true, - cacheDir: '.tevm' -} -``` - -## See - -[Tevm esbuild example](https://todo.todo.todo) - ## Defined in bundler-packages/esbuild/types/esbuildPluginTevm.d.ts:74 diff --git a/tevm/docs/bundler/functions/bundler.md b/tevm/docs/bundler/functions/bundler.md index 332a76a20a..657c0bc1a0 100644 --- a/tevm/docs/bundler/functions/bundler.md +++ b/tevm/docs/bundler/functions/bundler.md @@ -111,32 +111,6 @@ Resolves typescript representation of the solidity module Resolves typescript representation of the solidity module -## Example - -```typescript -import { bundler } from '@tevm/base-bundler-bundler' -import { createCache } from '@tevm/bundler-cache' -import { readFile, writeFile } from 'fs/promises' -import { readFileSync, writeFileSync, existsSync } from 'fs' -import { createSolc } from '@tevm/solc' -import { loadConfig } from '@tevm/config' - -const fao = { - readFile, - writeFile, - readFileSync, - writeFileSync, - existsSync, - // may need more methods -} - -const b = bundler(await loadConfig(), console, fao, await createSolc(), createCache()) - -const path = '../contracts/ERC20.sol' - -const { abi, bytecode } = await b.resolveTs(path, __dirname, true, true) -``` - ## Defined in bundler-packages/base-bundler/types/src/bundler.d.ts:41 diff --git a/tevm/docs/bundler/rollup-plugin/functions/rollupPluginTevm.md b/tevm/docs/bundler/rollup-plugin/functions/rollupPluginTevm.md index 708779d457..85f0f451f3 100644 --- a/tevm/docs/bundler/rollup-plugin/functions/rollupPluginTevm.md +++ b/tevm/docs/bundler/rollup-plugin/functions/rollupPluginTevm.md @@ -23,76 +23,6 @@ To configure add this plugin to your rollup config and add the ts-plugin to your `any` -## Examples - -```typescript -import { defineConfig } from 'rollup'; -import { rollupPluginTevm } from '@tevm/rollup'; - -export default defineConfig({ - plugins: [ - rollupPluginTevm() - ], -}); -``` - -For LSP so your editor recognizes the solidity imports correctly you must also configure tevm/ts-plugin in your tsconfig.json -The ts-plugin will provide type hints, code completion, and other features. - -```json -{ - "compilerOptions": { - "plugins": [{ "name": "tevm/ts-plugin" }] - } -} -``` - -Once the rollup plugin and the ts-plugin are configured, you can import Solidity files in JavaScript. The compiler will -turn them into Tevm `Contract` instances. - -```typescript -// Solidity imports are automaticlaly turned into Tevm Contract objects -import { ERC20 } from '@openzeppelin/contracts/token/ERC20/ERC20.sol' -import { createTevm } from 'tevm' - -console.log(ERC20.abi) -console.log(ERC20.humanReadableAbi) -console.log(ERC20.bytecode) - -tevm.contract( - ERC20.withAddress(.read.balanceOf() -) -``` - -Under the hood the rollup plugin is creating a virtual file for ERC20.sol called ERC20.sol.cjs that looks like this - -```typescript -import { createContract } from '@tevm/contract' - -export const ERC20 = createContract({ - name: 'ERC20', - humanReadableAbi: [ 'function balanceOf(address): uint256', ... ], - bytecode: '0x...', - deployedBytecode: '0x...', -}) -``` - -For custom configuration of the Tevm compiler add a [tevm.config.json](https://todo.todo.todo) file to your project root. - -```json -{ - foundryProject?: boolean | string | undefined, - libs: ['lib'], - remappings: {'foo': 'vendored/foo'}, - debug: true, - cacheDir: '.tevm' -} -``` - -## See - -[Tevm rollup example](https://todo.todo.todo) - ## Defined in bundler-packages/rollup/types/rollupPluginTevm.d.ts:73 diff --git a/tevm/docs/bundler/rspack-plugin/functions/rspackPluginTevm.md b/tevm/docs/bundler/rspack-plugin/functions/rspackPluginTevm.md index 24465b5b25..f5f91fe74f 100644 --- a/tevm/docs/bundler/rspack-plugin/functions/rspackPluginTevm.md +++ b/tevm/docs/bundler/rspack-plugin/functions/rspackPluginTevm.md @@ -23,76 +23,6 @@ To configure add this plugin to your rspack config and add the ts-plugin to your `RspackPluginInstance` -## Examples - -```typescript -import { defineConfig } from '@rsbuild/core'; -import { rspackPluginTevm } from '@tevm/rspack'; - -export default defineConfig({ - plugins: [ - rspackPluginTevm() - ], -}); -``` - -For LSP so your editor recognizes the solidity imports correctly you must also configure tevm/ts-plugin in your tsconfig.json -The ts-plugin will provide type hints, code completion, and other features. - -```json -{ - "compilerOptions": { - "plugins": [{ "name": "tevm/ts-plugin" }] - } -} -``` - -Once the rspack plugin and the ts-plugin are configured, you can import Solidity files in JavaScript. The compiler will -turn them into Tevm `Contract` instances. - -```typescript -// Solidity imports are automaticlaly turned into Tevm Contract objects -import { ERC20 } from '@openzeppelin/contracts/token/ERC20/ERC20.sol' -import { createTevm } from 'tevm' - -console.log(ERC20.abi) -console.log(ERC20.humanReadableAbi) -console.log(ERC20.bytecode) - -tevm.contract( - ERC20.withAddress(.read.balanceOf() -) -``` - -Under the hood the rspack plugin is creating a virtual file for ERC20.sol called ERC20.sol.cjs that looks like this - -```typescript -import { createContract } from '@tevm/contract' - -export const ERC20 = createContract({ - name: 'ERC20', - humanReadableAbi: [ 'function balanceOf(address): uint256', ... ], - bytecode: '0x...', - deployedBytecode: '0x...', -}) -``` - -For custom configuration of the Tevm compiler add a [tevm.config.json](https://todo.todo.todo) file to your project root. - -```json -{ - foundryProject?: boolean | string | undefined, - libs: ['lib'], - remappings: {'foo': 'vendored/foo'}, - debug: true, - cacheDir: '.tevm' -} -``` - -## See - -[Tevm rspack solid.js example](https://todo.todo.todo) - ## Defined in bundler-packages/rspack/types/rspackPluginTevm.d.ts:73 diff --git a/tevm/docs/bundler/solc/type-aliases/SolcContractOutput.md b/tevm/docs/bundler/solc/type-aliases/SolcContractOutput.md index 49dd89daff..e028ef8bf7 100644 --- a/tevm/docs/bundler/solc/type-aliases/SolcContractOutput.md +++ b/tevm/docs/bundler/solc/type-aliases/SolcContractOutput.md @@ -12,7 +12,7 @@ ### abi -> **abi**: [`Abi`](../../../index/type-aliases/Abi.md) +> **abi**: `Abi` ### devdoc diff --git a/tevm/docs/bundler/vite-plugin/functions/vitePluginTevm.md b/tevm/docs/bundler/vite-plugin/functions/vitePluginTevm.md index 6a19366062..87337f6f23 100644 --- a/tevm/docs/bundler/vite-plugin/functions/vitePluginTevm.md +++ b/tevm/docs/bundler/vite-plugin/functions/vitePluginTevm.md @@ -23,72 +23,6 @@ To configure add this plugin to your vite config and add the ts-plugin to your t `Plugin`\<`any`\> -## Examples - -```typescript -import { vitePluginTevm } from '@tevm/vite' -import { defineConfig } from 'vite' - -export default defineConfig({ - plugins: [ - vitePluginTevm() - ] -}) -``` - -For LSP so your editor recognizes the solidity imports correctly you must also configure tevm/ts-plugin in your tsconfig.json -The ts-plugin will provide type hints, code completion, and other features. - -```json -{ - "compilerOptions": { - "plugins": [{ "name": "tevm/ts-plugin" }] - } -} -``` - -Once the vite plugin and the ts-plugin are configured, you can import Solidity files in JavaScript. The compiler will -turn them into Tevm `Contract` instances. - -```typescript -// Solidity imports are automaticlaly turned into Tevm Contract objects -import { ERC20 } from '@openzeppelin/contracts/token/ERC20/ERC20.sol' -import { createTevm } from 'tevm' - -console.log(ERC20.abi) -console.log(ERC20.humanReadableAbi) -console.log(ERC20.bytecode) - -tevm.contract( - ERC20.withAddress(.read.balanceOf() -) -``` - -Under the hood the vite plugin is creating a virtual file for ERC20.sol called ERC20.sol.cjs that looks like this - -```typescript -import { createContract } from '@tevm/contract' - -export const ERC20 = createContract({ - name: 'ERC20', - humanReadableAbi: [ 'function balanceOf(address): uint256', ... ], - bytecode: '0x...', - deployedBytecode: '0x...', -}) -``` - -For custom configuration of the Tevm compiler add a [tevm.config.json](https://todo.todo.todo) file to your project root. - -```json -{ - foundryProject?: boolean | string | undefined, - libs: ['lib'], - remappings: {'foo': 'vendored/foo'}, - debug: true, - cacheDir: '.tevm' -} -``` - ## Defined in bundler-packages/vite/types/vitePluginTevm.d.ts:71 diff --git a/tevm/docs/common/README.md b/tevm/docs/common/README.md index 4d6b28d197..d9f5b179b7 100644 --- a/tevm/docs/common/README.md +++ b/tevm/docs/common/README.md @@ -31,15 +31,340 @@ ### Variables +- [abstractTestnet](variables/abstractTestnet.md) +- [acala](variables/acala.md) +- [ancient8](variables/ancient8.md) +- [ancient8Sepolia](variables/ancient8Sepolia.md) +- [anvil](variables/anvil.md) +- [apexTestnet](variables/apexTestnet.md) +- [arbitrum](variables/arbitrum.md) +- [arbitrumGoerli](variables/arbitrumGoerli.md) +- [arbitrumNova](variables/arbitrumNova.md) +- [arbitrumSepolia](variables/arbitrumSepolia.md) +- [areonNetwork](variables/areonNetwork.md) +- [areonNetworkTestnet](variables/areonNetworkTestnet.md) +- [artelaTestnet](variables/artelaTestnet.md) +- [assetChainTestnet](variables/assetChainTestnet.md) +- [astar](variables/astar.md) +- [astarZkEVM](variables/astarZkEVM.md) +- [astarZkyoto](variables/astarZkyoto.md) +- [atletaOlympia](variables/atletaOlympia.md) +- [aurora](variables/aurora.md) +- [auroraTestnet](variables/auroraTestnet.md) +- [auroria](variables/auroria.md) +- [avalanche](variables/avalanche.md) +- [avalancheFuji](variables/avalancheFuji.md) +- [b3](variables/b3.md) +- [b3Sepolia](variables/b3Sepolia.md) +- [bahamut](variables/bahamut.md) - [base](variables/base.md) +- [baseGoerli](variables/baseGoerli.md) - [baseSepolia](variables/baseSepolia.md) +- [beam](variables/beam.md) +- [beamTestnet](variables/beamTestnet.md) +- [bearNetworkChainMainnet](variables/bearNetworkChainMainnet.md) +- [bearNetworkChainTestnet](variables/bearNetworkChainTestnet.md) +- [berachainTestnet](variables/berachainTestnet.md) +- [berachainTestnetbArtio](variables/berachainTestnetbArtio.md) +- [bevmMainnet](variables/bevmMainnet.md) +- [bitTorrent](variables/bitTorrent.md) +- [bitTorrentTestnet](variables/bitTorrentTestnet.md) +- [bitkub](variables/bitkub.md) +- [bitkubTestnet](variables/bitkubTestnet.md) +- [blast](variables/blast.md) +- [blastSepolia](variables/blastSepolia.md) +- [bob](variables/bob.md) +- [bobSepolia](variables/bobSepolia.md) +- [boba](variables/boba.md) +- [bobaSepolia](variables/bobaSepolia.md) +- [botanixTestnet](variables/botanixTestnet.md) +- [bronos](variables/bronos.md) +- [bronosTestnet](variables/bronosTestnet.md) +- [bsc](variables/bsc.md) +- [bscGreenfield](variables/bscGreenfield.md) +- [bscTestnet](variables/bscTestnet.md) +- [btr](variables/btr.md) +- [btrTestnet](variables/btrTestnet.md) +- [bxn](variables/bxn.md) +- [bxnTestnet](variables/bxnTestnet.md) +- [canto](variables/canto.md) +- [celo](variables/celo.md) +- [celoAlfajores](variables/celoAlfajores.md) +- [chiliz](variables/chiliz.md) +- [chips](variables/chips.md) +- [classic](variables/classic.md) +- [confluxESpace](variables/confluxESpace.md) +- [confluxESpaceTestnet](variables/confluxESpaceTestnet.md) +- [coreDao](variables/coreDao.md) +- [crab](variables/crab.md) +- [cronos](variables/cronos.md) +- [cronosTestnet](variables/cronosTestnet.md) +- [cronoszkEVM](variables/cronoszkEVM.md) +- [cronoszkEVMTestnet](variables/cronoszkEVMTestnet.md) +- [crossbell](variables/crossbell.md) +- [curtis](variables/curtis.md) +- [cyber](variables/cyber.md) +- [cyberTestnet](variables/cyberTestnet.md) +- [darwinia](variables/darwinia.md) +- [dchain](variables/dchain.md) +- [dchainTestnet](variables/dchainTestnet.md) +- [defichainEvm](variables/defichainEvm.md) +- [defichainEvmTestnet](variables/defichainEvmTestnet.md) +- [degen](variables/degen.md) +- [dfk](variables/dfk.md) +- [dodochainTestnet](variables/dodochainTestnet.md) +- [dogechain](variables/dogechain.md) +- [dreyerxMainnet](variables/dreyerxMainnet.md) +- [dreyerxTestnet](variables/dreyerxTestnet.md) +- [edgeless](variables/edgeless.md) +- [edgelessTestnet](variables/edgelessTestnet.md) +- [edgeware](variables/edgeware.md) +- [edgewareTestnet](variables/edgewareTestnet.md) +- [ekta](variables/ekta.md) +- [ektaTestnet](variables/ektaTestnet.md) +- [eon](variables/eon.md) +- [eos](variables/eos.md) +- [eosTestnet](variables/eosTestnet.md) +- [etherlink](variables/etherlink.md) +- [etherlinkTestnet](variables/etherlinkTestnet.md) +- [evmos](variables/evmos.md) +- [evmosTestnet](variables/evmosTestnet.md) +- [fantom](variables/fantom.md) +- [fantomSonicTestnet](variables/fantomSonicTestnet.md) +- [fantomTestnet](variables/fantomTestnet.md) +- [fibo](variables/fibo.md) +- [filecoin](variables/filecoin.md) +- [filecoinCalibration](variables/filecoinCalibration.md) +- [filecoinHyperspace](variables/filecoinHyperspace.md) +- [flare](variables/flare.md) +- [flareTestnet](variables/flareTestnet.md) +- [flowMainnet](variables/flowMainnet.md) +- [flowPreviewnet](variables/flowPreviewnet.md) +- [flowTestnet](variables/flowTestnet.md) +- [fluence](variables/fluence.md) +- [fluenceStage](variables/fluenceStage.md) +- [fluenceTestnet](variables/fluenceTestnet.md) +- [forma](variables/forma.md) +- [foundry](variables/foundry.md) +- [fraxtal](variables/fraxtal.md) +- [fraxtalTestnet](variables/fraxtalTestnet.md) +- [funkiMainnet](variables/funkiMainnet.md) +- [funkiSepolia](variables/funkiSepolia.md) +- [fuse](variables/fuse.md) +- [fuseSparknet](variables/fuseSparknet.md) +- [gnosis](variables/gnosis.md) +- [gnosisChiado](variables/gnosisChiado.md) +- [gobi](variables/gobi.md) +- [goerli](variables/goerli.md) +- [gravity](variables/gravity.md) +- [ham](variables/ham.md) +- [haqqMainnet](variables/haqqMainnet.md) +- [haqqTestedge2](variables/haqqTestedge2.md) +- [hardhat](variables/hardhat.md) +- [harmonyOne](variables/harmonyOne.md) +- [hashkeyTestnet](variables/hashkeyTestnet.md) +- [hedera](variables/hedera.md) +- [hederaPreviewnet](variables/hederaPreviewnet.md) +- [hederaTestnet](variables/hederaTestnet.md) +- [holesky](variables/holesky.md) +- [immutableZkEvm](variables/immutableZkEvm.md) +- [immutableZkEvmTestnet](variables/immutableZkEvmTestnet.md) +- [inEVM](variables/inEVM.md) +- [iota](variables/iota.md) +- [iotaTestnet](variables/iotaTestnet.md) +- [iotex](variables/iotex.md) +- [iotexTestnet](variables/iotexTestnet.md) +- [jbc](variables/jbc.md) +- [jbcTestnet](variables/jbcTestnet.md) +- [kaia](variables/kaia.md) +- [kairos](variables/kairos.md) +- [kakarotSepolia](variables/kakarotSepolia.md) +- [karura](variables/karura.md) +- [kava](variables/kava.md) +- [kavaTestnet](variables/kavaTestnet.md) +- [kcc](variables/kcc.md) +- [klaytn](variables/klaytn.md) +- [klaytnBaobab](variables/klaytnBaobab.md) +- [koi](variables/koi.md) +- [kroma](variables/kroma.md) +- [kromaSepolia](variables/kromaSepolia.md) +- [l3x](variables/l3x.md) +- [l3xTestnet](variables/l3xTestnet.md) +- [lightlinkPegasus](variables/lightlinkPegasus.md) +- [lightlinkPhoenix](variables/lightlinkPhoenix.md) +- [linea](variables/linea.md) +- [lineaGoerli](variables/lineaGoerli.md) +- [lineaSepolia](variables/lineaSepolia.md) +- [lineaTestnet](variables/lineaTestnet.md) +- [lisk](variables/lisk.md) +- [liskSepolia](variables/liskSepolia.md) +- [localhost](variables/localhost.md) +- [lukso](variables/lukso.md) +- [luksoTestnet](variables/luksoTestnet.md) +- [lycan](variables/lycan.md) +- [lyra](variables/lyra.md) - [mainnet](variables/mainnet.md) +- [mandala](variables/mandala.md) +- [manta](variables/manta.md) +- [mantaSepoliaTestnet](variables/mantaSepoliaTestnet.md) +- [mantaTestnet](variables/mantaTestnet.md) +- [mantle](variables/mantle.md) +- [mantleSepoliaTestnet](variables/mantleSepoliaTestnet.md) +- [mantleTestnet](variables/mantleTestnet.md) +- [merlin](variables/merlin.md) +- [metachain](variables/metachain.md) +- [metachainIstanbul](variables/metachainIstanbul.md) +- [metalL2](variables/metalL2.md) +- [meter](variables/meter.md) +- [meterTestnet](variables/meterTestnet.md) +- [metis](variables/metis.md) +- [metisGoerli](variables/metisGoerli.md) +- [mev](variables/mev.md) +- [mevTestnet](variables/mevTestnet.md) +- [mintSepoliaTestnet](variables/mintSepoliaTestnet.md) +- [mode](variables/mode.md) +- [modeTestnet](variables/modeTestnet.md) +- [moonbaseAlpha](variables/moonbaseAlpha.md) +- [moonbeam](variables/moonbeam.md) +- [moonbeamDev](variables/moonbeamDev.md) +- [moonriver](variables/moonriver.md) +- [morphHolesky](variables/morphHolesky.md) +- [morphSepolia](variables/morphSepolia.md) +- [nautilus](variables/nautilus.md) +- [neonDevnet](variables/neonDevnet.md) +- [neonMainnet](variables/neonMainnet.md) +- [nexi](variables/nexi.md) +- [nexilix](variables/nexilix.md) +- [oasisTestnet](variables/oasisTestnet.md) +- [oasys](variables/oasys.md) +- [okc](variables/okc.md) +- [oortMainnetDev](variables/oortMainnetDev.md) +- [opBNB](variables/opBNB.md) +- [opBNBTestnet](variables/opBNBTestnet.md) - [optimism](variables/optimism.md) +- [optimismGoerli](variables/optimismGoerli.md) - [optimismSepolia](variables/optimismSepolia.md) +- [otimDevnet](variables/otimDevnet.md) +- [palm](variables/palm.md) +- [palmTestnet](variables/palmTestnet.md) +- [pgn](variables/pgn.md) +- [pgnTestnet](variables/pgnTestnet.md) +- [phoenix](variables/phoenix.md) +- [playfiAlbireo](variables/playfiAlbireo.md) +- [plinga](variables/plinga.md) +- [plumeTestnet](variables/plumeTestnet.md) +- [polygon](variables/polygon.md) +- [polygonAmoy](variables/polygonAmoy.md) +- [polygonMumbai](variables/polygonMumbai.md) +- [polygonZkEvm](variables/polygonZkEvm.md) +- [polygonZkEvmCardona](variables/polygonZkEvmCardona.md) +- [polygonZkEvmTestnet](variables/polygonZkEvmTestnet.md) +- [pulsechain](variables/pulsechain.md) +- [pulsechainV4](variables/pulsechainV4.md) +- [qMainnet](variables/qMainnet.md) +- [qTestnet](variables/qTestnet.md) +- [real](variables/real.md) +- [redbellyTestnet](variables/redbellyTestnet.md) +- [redstone](variables/redstone.md) +- [reyaNetwork](variables/reyaNetwork.md) +- [rollux](variables/rollux.md) +- [rolluxTestnet](variables/rolluxTestnet.md) +- [ronin](variables/ronin.md) +- [root](variables/root.md) +- [rootPorcini](variables/rootPorcini.md) +- [rootstock](variables/rootstock.md) +- [rootstockTestnet](variables/rootstockTestnet.md) +- [rss3](variables/rss3.md) +- [rss3Sepolia](variables/rss3Sepolia.md) +- [saigon](variables/saigon.md) +- [sapphire](variables/sapphire.md) +- [sapphireTestnet](variables/sapphireTestnet.md) +- [satoshiVM](variables/satoshiVM.md) +- [satoshiVMTestnet](variables/satoshiVMTestnet.md) +- [scroll](variables/scroll.md) +- [scrollSepolia](variables/scrollSepolia.md) +- [sei](variables/sei.md) +- [seiDevnet](variables/seiDevnet.md) +- [seiTestnet](variables/seiTestnet.md) - [sepolia](variables/sepolia.md) +- [shapeSepolia](variables/shapeSepolia.md) +- [shardeumSphinx](variables/shardeumSphinx.md) +- [shibarium](variables/shibarium.md) +- [shibariumTestnet](variables/shibariumTestnet.md) +- [shimmer](variables/shimmer.md) +- [shimmerTestnet](variables/shimmerTestnet.md) +- [skaleBlockBrawlers](variables/skaleBlockBrawlers.md) +- [skaleCalypso](variables/skaleCalypso.md) +- [skaleCalypsoTestnet](variables/skaleCalypsoTestnet.md) +- [skaleCryptoBlades](variables/skaleCryptoBlades.md) +- [skaleCryptoColosseum](variables/skaleCryptoColosseum.md) +- [skaleEuropa](variables/skaleEuropa.md) +- [skaleEuropaTestnet](variables/skaleEuropaTestnet.md) +- [skaleExorde](variables/skaleExorde.md) +- [skaleHumanProtocol](variables/skaleHumanProtocol.md) +- [skaleNebula](variables/skaleNebula.md) +- [skaleNebulaTestnet](variables/skaleNebulaTestnet.md) +- [skaleRazor](variables/skaleRazor.md) +- [skaleTitan](variables/skaleTitan.md) +- [skaleTitanTestnet](variables/skaleTitanTestnet.md) +- [sketchpad](variables/sketchpad.md) +- [soneiumMinato](variables/soneiumMinato.md) +- [songbird](variables/songbird.md) +- [songbirdTestnet](variables/songbirdTestnet.md) +- [sophonTestnet](variables/sophonTestnet.md) +- [spicy](variables/spicy.md) +- [storyTestnet](variables/storyTestnet.md) +- [stratis](variables/stratis.md) +- [syscoin](variables/syscoin.md) +- [syscoinTestnet](variables/syscoinTestnet.md) +- [taiko](variables/taiko.md) +- [taikoHekla](variables/taikoHekla.md) +- [taikoJolnir](variables/taikoJolnir.md) +- [taikoKatla](variables/taikoKatla.md) +- [taikoTestnetSepolia](variables/taikoTestnetSepolia.md) +- [taraxa](variables/taraxa.md) +- [taraxaTestnet](variables/taraxaTestnet.md) +- [telcoinTestnet](variables/telcoinTestnet.md) +- [telos](variables/telos.md) +- [telosTestnet](variables/telosTestnet.md) +- [tenet](variables/tenet.md) - [tevmDefault](variables/tevmDefault.md) +- [thaiChain](variables/thaiChain.md) +- [thunderTestnet](variables/thunderTestnet.md) +- [tron](variables/tron.md) +- [unreal](variables/unreal.md) +- [vechain](variables/vechain.md) +- [wanchain](variables/wanchain.md) +- [wanchainTestnet](variables/wanchainTestnet.md) +- [wemix](variables/wemix.md) +- [wemixTestnet](variables/wemixTestnet.md) +- [x1Testnet](variables/x1Testnet.md) +- [xLayer](variables/xLayer.md) +- [xLayerTestnet](variables/xLayerTestnet.md) +- [xai](variables/xai.md) +- [xaiTestnet](variables/xaiTestnet.md) +- [xdc](variables/xdc.md) +- [xdcTestnet](variables/xdcTestnet.md) +- [xrSepolia](variables/xrSepolia.md) +- [yooldoVerse](variables/yooldoVerse.md) +- [yooldoVerseTestnet](variables/yooldoVerseTestnet.md) +- [zetachain](variables/zetachain.md) +- [zetachainAthensTestnet](variables/zetachainAthensTestnet.md) +- [zhejiang](variables/zhejiang.md) +- [zilliqa](variables/zilliqa.md) +- [zilliqaTestnet](variables/zilliqaTestnet.md) +- [zircuitTestnet](variables/zircuitTestnet.md) +- [zkFair](variables/zkFair.md) +- [zkFairTestnet](variables/zkFairTestnet.md) +- [zkLinkNova](variables/zkLinkNova.md) +- [zkLinkNovaSepoliaTestnet](variables/zkLinkNovaSepoliaTestnet.md) +- [zksync](variables/zksync.md) +- [zksyncInMemoryNode](variables/zksyncInMemoryNode.md) +- [zksyncLocalNode](variables/zksyncLocalNode.md) +- [zksyncSepoliaTestnet](variables/zksyncSepoliaTestnet.md) - [zora](variables/zora.md) - [zoraSepolia](variables/zoraSepolia.md) +- [zoraTestnet](variables/zoraTestnet.md) ### Functions diff --git a/tevm/docs/common/enumerations/ConsensusAlgorithm.md b/tevm/docs/common/enumerations/ConsensusAlgorithm.md index 31a84c5464..dea589b3e4 100644 --- a/tevm/docs/common/enumerations/ConsensusAlgorithm.md +++ b/tevm/docs/common/enumerations/ConsensusAlgorithm.md @@ -14,7 +14,7 @@ #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/enums.d.ts:49 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/enums.d.ts:50 *** @@ -24,7 +24,7 @@ node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/di #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/enums.d.ts:48 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/enums.d.ts:49 *** @@ -34,4 +34,4 @@ node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/di #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/enums.d.ts:47 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/enums.d.ts:48 diff --git a/tevm/docs/common/enumerations/ConsensusType.md b/tevm/docs/common/enumerations/ConsensusType.md index d62991a297..7613f47374 100644 --- a/tevm/docs/common/enumerations/ConsensusType.md +++ b/tevm/docs/common/enumerations/ConsensusType.md @@ -14,7 +14,7 @@ #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/enums.d.ts:44 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/enums.d.ts:45 *** @@ -24,7 +24,7 @@ node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/di #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/enums.d.ts:42 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/enums.d.ts:43 *** @@ -34,4 +34,4 @@ node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/di #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/enums.d.ts:43 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/enums.d.ts:44 diff --git a/tevm/docs/common/interfaces/CustomCrypto.md b/tevm/docs/common/interfaces/CustomCrypto.md index b80a63d3d5..4747992830 100644 --- a/tevm/docs/common/interfaces/CustomCrypto.md +++ b/tevm/docs/common/interfaces/CustomCrypto.md @@ -26,7 +26,7 @@ #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/types.d.ts:73 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/types.d.ts:74 *** @@ -54,7 +54,7 @@ node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/di #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/types.d.ts:69 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/types.d.ts:70 *** @@ -80,7 +80,7 @@ node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/di #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/types.d.ts:66 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/types.d.ts:67 *** @@ -102,7 +102,7 @@ node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/di #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/types.d.ts:68 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/types.d.ts:69 *** @@ -122,7 +122,7 @@ Interface for providing custom cryptographic primitives in place of `ethereum-cr #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/types.d.ts:65 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/types.d.ts:66 *** @@ -132,7 +132,7 @@ node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/di #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/types.d.ts:74 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/types.d.ts:75 *** @@ -150,4 +150,4 @@ node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/di #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/types.d.ts:67 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/types.d.ts:68 diff --git a/tevm/docs/common/interfaces/EvmStateManagerInterface.md b/tevm/docs/common/interfaces/EvmStateManagerInterface.md index a812840926..e0b0bf696a 100644 --- a/tevm/docs/common/interfaces/EvmStateManagerInterface.md +++ b/tevm/docs/common/interfaces/EvmStateManagerInterface.md @@ -40,10 +40,34 @@ #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:73 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:136 ## Methods +### checkChunkWitnessPresent()? + +> `optional` **checkChunkWitnessPresent**(`contract`, `programCounter`): `Promise`\<`boolean`\> + +#### Parameters + +• **contract**: [`EthjsAddress`](../../utils/classes/EthjsAddress.md) + +• **programCounter**: `number` + +#### Returns + +`Promise`\<`boolean`\> + +#### Inherited from + +`StateManagerInterface.checkChunkWitnessPresent` + +#### Defined in + +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:133 + +*** + ### checkpoint() > **checkpoint**(): `Promise`\<`void`\> @@ -58,7 +82,7 @@ node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/di #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:62 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:124 *** @@ -80,7 +104,7 @@ node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/di #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:61 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:123 *** @@ -98,7 +122,7 @@ node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/di #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:63 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:125 *** @@ -120,7 +144,7 @@ node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/di #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:55 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:116 *** @@ -138,7 +162,7 @@ node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/di #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:77 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:140 *** @@ -160,7 +184,7 @@ node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/di #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:78 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:141 *** @@ -178,7 +202,7 @@ node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/di #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:79 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:142 *** @@ -200,7 +224,7 @@ node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/di #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:53 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:114 *** @@ -222,7 +246,7 @@ node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/di #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:70 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:132 *** @@ -244,7 +268,29 @@ node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/di #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:58 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:119 + +*** + +### getContractCodeSize()? + +> `optional` **getContractCodeSize**(`address`): `Promise`\<`number`\> + +#### Parameters + +• **address**: [`EthjsAddress`](../../utils/classes/EthjsAddress.md) + +#### Returns + +`Promise`\<`number`\> + +#### Inherited from + +`StateManagerInterface.getContractCodeSize` + +#### Defined in + +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:120 *** @@ -268,7 +314,7 @@ node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/di #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:59 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:121 *** @@ -292,7 +338,7 @@ node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/di #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:80 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:143 *** @@ -310,7 +356,7 @@ node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/di #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:65 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:127 *** @@ -332,7 +378,7 @@ node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/di #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:68 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:130 *** @@ -356,7 +402,7 @@ node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/di #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:56 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:117 *** @@ -380,7 +426,7 @@ node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/di #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:54 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:115 *** @@ -404,7 +450,7 @@ node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/di #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:57 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:118 *** @@ -430,7 +476,7 @@ node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/di #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:60 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:122 *** @@ -448,7 +494,7 @@ node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/di #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:64 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:126 *** @@ -472,7 +518,7 @@ node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/di #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:66 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:128 *** @@ -494,4 +540,4 @@ node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/di #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:81 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:144 diff --git a/tevm/docs/common/interfaces/StorageRange.md b/tevm/docs/common/interfaces/StorageRange.md index 9421202dfd..9ad40cb3e4 100644 --- a/tevm/docs/common/interfaces/StorageRange.md +++ b/tevm/docs/common/interfaces/StorageRange.md @@ -19,7 +19,7 @@ contained in `storage`. #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:28 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:28 *** @@ -38,4 +38,4 @@ so they are always `null`. #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:18 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:18 diff --git a/tevm/docs/common/type-aliases/AccountFields.md b/tevm/docs/common/type-aliases/AccountFields.md index e528d4d1a9..8a063d71fd 100644 --- a/tevm/docs/common/type-aliases/AccountFields.md +++ b/tevm/docs/common/type-aliases/AccountFields.md @@ -10,4 +10,4 @@ ## Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:30 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:30 diff --git a/tevm/docs/common/type-aliases/CliqueConfig.md b/tevm/docs/common/type-aliases/CliqueConfig.md index 4e2d729792..74b7ec0f3f 100644 --- a/tevm/docs/common/type-aliases/CliqueConfig.md +++ b/tevm/docs/common/type-aliases/CliqueConfig.md @@ -20,4 +20,4 @@ ## Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/types.d.ts:9 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/types.d.ts:9 diff --git a/tevm/docs/common/type-aliases/Common.md b/tevm/docs/common/type-aliases/Common.md index 1af604d717..86c13c51db 100644 --- a/tevm/docs/common/type-aliases/Common.md +++ b/tevm/docs/common/type-aliases/Common.md @@ -6,7 +6,7 @@ # Type Alias: Common -> **Common**: `ViemChain` & `object` +> **Common**: `Prettify`\<`ViemChain` & `object`\> Common is the main representation of chain specific configuration for tevm clients. @@ -14,20 +14,6 @@ Tevm specific chain configuration wrapping viem chain and ethereumjs commmon Common contains the common configuration set between all chains such as fee information, hardfork information, eip information, predeployed contracts, default block explorers and more. extends ethereumjs Common class with the Viem Chain type -## Type declaration - -### copy() - -> **copy**: () => [`Common`](Common.md) - -#### Returns - -[`Common`](Common.md) - -### ethjsCommon - -> **ethjsCommon**: `EthjsCommon` - ## Example ```typescript diff --git a/tevm/docs/common/type-aliases/CommonOptions.md b/tevm/docs/common/type-aliases/CommonOptions.md index fa9c5d4868..3e1e94247d 100644 --- a/tevm/docs/common/type-aliases/CommonOptions.md +++ b/tevm/docs/common/type-aliases/CommonOptions.md @@ -6,9 +6,36 @@ # Type Alias: CommonOptions -> **CommonOptions**: `object` & `ViemChain` +> **CommonOptions**: `ViemChain` & `object` -Options for creating an Tevm MemoryClient instance +## Examples + +```typescript +import { mainnet, createCommon, type CommonOptions } from 'tevm/common' + +const opts: CommonOptions = { + ...mainnet, + hardfork: 'london', +} + +const common = createCommon(opts) +``` + +You can also create a Common instance from viem chains: + +```typescript +import { mainnet } from 'viem/chains' +import { createCommon } from 'tevm/common' + +const common = createCommon({ + ...mainnet, + hardfork: 'cancun', +}) +``` + +## See + +[createCommon](https://tevm.sh/reference/tevm/common/functions/createcommon/) ## Type declaration @@ -46,32 +73,36 @@ const common = createCommon({ Eips to enable. Defaults to `[1559, 4895]` -### hardfork +#### Default -> **hardfork**: [`Hardfork`](Hardfork.md) +```ts +[1559, 4895] +``` + +### hardfork? + +> `optional` **hardfork**: [`Hardfork`](Hardfork.md) Hardfork to use. Defaults to `shanghai` -### loggingLevel +#### Default -> **loggingLevel**: `LogOptions`\[`"level"`\] +```ts +'cancun' +``` -Tevm logger instance +### loggingLevel? -## Example +> `optional` **loggingLevel**: `LogOptions`\[`"level"`\] -```typescript -import { mainnet, createCommon, type CommonOptions } from 'tevm/common' +Logging level of the Tevm logger instance -const opts: CommonOptions = { - ...mainnet, - hardfork: 'london', -} +#### Default -const common = createCommon(opts) -```` -@see [createCommon](https://tevm.sh/reference/tevm/common/functions/createcommon/) +```ts +'warn' +``` ## Defined in -packages/common/types/CommonOptions.d.ts:20 +packages/common/types/CommonOptions.d.ts:37 diff --git a/tevm/docs/common/type-aliases/Hardfork.md b/tevm/docs/common/type-aliases/Hardfork.md index 15f1c9eced..2317de9408 100644 --- a/tevm/docs/common/type-aliases/Hardfork.md +++ b/tevm/docs/common/type-aliases/Hardfork.md @@ -6,14 +6,14 @@ # Type Alias: Hardfork -> **Hardfork**: `"chainstart"` \| `"homestead"` \| `"dao"` \| `"tangerineWhistle"` \| `"spuriousDragon"` \| `"byzantium"` \| `"constantinople"` \| `"petersburg"` \| `"istanbul"` \| `"muirGlacier"` \| `"berlin"` \| `"london"` \| `"arrowGlacier"` \| `"grayGlacier"` \| `"mergeForkIdTransition"` \| `"paris"` \| `"shanghai"` \| `"cancun"` +> **Hardfork**: `"chainstart"` \| `"homestead"` \| `"dao"` \| `"tangerineWhistle"` \| `"spuriousDragon"` \| `"byzantium"` \| `"constantinople"` \| `"petersburg"` \| `"istanbul"` \| `"muirGlacier"` \| `"berlin"` \| `"london"` \| `"arrowGlacier"` \| `"grayGlacier"` \| `"mergeForkIdTransition"` \| `"paris"` \| `"shanghai"` \| `"cancun"` \| `"prague"` \| `"osaka"` Ethereum hardfork options. Default option is currently cancun. If you use older hardforks you might run into issues with EIPs not being supported. ## Example -```typesxcript +```typescript import { createCommon, mainnet } from 'tevm/common'` const hardfork: Hardfork = 'shanghai' diff --git a/tevm/docs/common/type-aliases/MockKzg.md b/tevm/docs/common/type-aliases/MockKzg.md index d2b7bd6c64..46ec3d11b2 100644 --- a/tevm/docs/common/type-aliases/MockKzg.md +++ b/tevm/docs/common/type-aliases/MockKzg.md @@ -12,6 +12,26 @@ The interface of the custom crypto for kzg implemented by `createMockKzg`` The real kzg commitmenet is over 500kb added to bundle size so this is useful alternative for smaller bundles and the default +## Example + +```typescript +import { createCommon, createMockKzg, mainnet, type MockKzg } from 'tevm/common' + +const kzg: MockKzg = createMockKzg() + +const common = createCommon({ + ...mainnet, + customCrypto: { + kzg:, + }, +}) +``` + +## See + + - [createMockKzg](https://tevm.sh/reference/tevm/common/functions/createmockkzg/) + - [createCommon](https://tevm.sh/reference/tevm/common/functions/createcommon/) + ## Type declaration ### blobToKzgCommitment() @@ -110,26 +130,6 @@ so this is useful alternative for smaller bundles and the default `boolean` -## Example - -```typescript -import { createCommon, createMockKzg, mainnet, type MockKzg } from 'tevm/common' - -const kzg: MockKzg = createMockKzg() - -const common = createCommon({ - ...mainnet, - customCrypto: { - kzg:, - }, -}) -``` - -## See - - - [createMockKzg](https://tevm.sh/reference/tevm/common/functions/createmockkzg/) - - [createCommon](https://tevm.sh/reference/tevm/common/functions/createcommon/) - ## Defined in packages/common/types/MockKzg.d.ts:21 diff --git a/tevm/docs/common/variables/abstractTestnet.md b/tevm/docs/common/variables/abstractTestnet.md new file mode 100644 index 0000000000..4ff4072353 --- /dev/null +++ b/tevm/docs/common/variables/abstractTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / abstractTestnet + +# Variable: abstractTestnet + +> `const` **abstractTestnet**: `Common` + +Creates a common configuration for the abstractTestnet chain. + +## Description + +Chain ID: 11124 +Chain Name: Abstract Testnet +Default Block Explorer: https://explorer.testnet.abs.xyz +Default RPC URL: https://api.testnet.abs.xyz + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { abstractTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: abstractTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/abstractTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/acala.md b/tevm/docs/common/variables/acala.md new file mode 100644 index 0000000000..b131b9cfdf --- /dev/null +++ b/tevm/docs/common/variables/acala.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / acala + +# Variable: acala + +> `const` **acala**: `Common` + +Creates a common configuration for the acala chain. + +## Description + +Chain ID: 787 +Chain Name: Acala +Default Block Explorer: https://blockscout.acala.network +Default RPC URL: https://eth-rpc-acala.aca-api.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { acala } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: acala, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/acala.d.ts:21 diff --git a/tevm/docs/common/variables/ancient8.md b/tevm/docs/common/variables/ancient8.md new file mode 100644 index 0000000000..c1fc9913a1 --- /dev/null +++ b/tevm/docs/common/variables/ancient8.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / ancient8 + +# Variable: ancient8 + +> `const` **ancient8**: `Common` + +Creates a common configuration for the ancient8 chain. + +## Description + +Chain ID: 888888888 +Chain Name: Ancient8 +Default Block Explorer: https://scan.ancient8.gg +Default RPC URL: https://rpc.ancient8.gg + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { ancient8 } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: ancient8, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/ancient8.d.ts:21 diff --git a/tevm/docs/common/variables/ancient8Sepolia.md b/tevm/docs/common/variables/ancient8Sepolia.md new file mode 100644 index 0000000000..2e67bd5c22 --- /dev/null +++ b/tevm/docs/common/variables/ancient8Sepolia.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / ancient8Sepolia + +# Variable: ancient8Sepolia + +> `const` **ancient8Sepolia**: `Common` + +Creates a common configuration for the ancient8Sepolia chain. + +## Description + +Chain ID: 28122024 +Chain Name: Ancient8 Testnet +Default Block Explorer: https://scanv2-testnet.ancient8.gg +Default RPC URL: https://rpcv2-testnet.ancient8.gg + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { ancient8Sepolia } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: ancient8Sepolia, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/ancient8Sepolia.d.ts:21 diff --git a/tevm/docs/common/variables/anvil.md b/tevm/docs/common/variables/anvil.md new file mode 100644 index 0000000000..8b45af15ac --- /dev/null +++ b/tevm/docs/common/variables/anvil.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / anvil + +# Variable: anvil + +> `const` **anvil**: `Common` + +Creates a common configuration for the anvil chain. + +## Description + +Chain ID: 31337 +Chain Name: Anvil +Default Block Explorer: Not specified +Default RPC URL: http://127.0.0.1:8545 + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { anvil } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: anvil, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/anvil.d.ts:21 diff --git a/tevm/docs/common/variables/apexTestnet.md b/tevm/docs/common/variables/apexTestnet.md new file mode 100644 index 0000000000..95fcad1be2 --- /dev/null +++ b/tevm/docs/common/variables/apexTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / apexTestnet + +# Variable: apexTestnet + +> `const` **apexTestnet**: `Common` + +Creates a common configuration for the apexTestnet chain. + +## Description + +Chain ID: 3993 +Chain Name: APEX Testnet +Default Block Explorer: https://exp-testnet.apexlayer.xyz +Default RPC URL: https://rpc-testnet.apexlayer.xyz + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { apexTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: apexTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/apexTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/arbitrum.md b/tevm/docs/common/variables/arbitrum.md new file mode 100644 index 0000000000..23bbab24e0 --- /dev/null +++ b/tevm/docs/common/variables/arbitrum.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / arbitrum + +# Variable: arbitrum + +> `const` **arbitrum**: `Common` + +Creates a common configuration for the arbitrum chain. + +## Description + +Chain ID: 42161 +Chain Name: Arbitrum One +Default Block Explorer: https://arbiscan.io +Default RPC URL: https://arb1.arbitrum.io/rpc + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { arbitrum } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: arbitrum, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/arbitrum.d.ts:21 diff --git a/tevm/docs/common/variables/arbitrumGoerli.md b/tevm/docs/common/variables/arbitrumGoerli.md new file mode 100644 index 0000000000..5f9e16a733 --- /dev/null +++ b/tevm/docs/common/variables/arbitrumGoerli.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / arbitrumGoerli + +# Variable: arbitrumGoerli + +> `const` **arbitrumGoerli**: `Common` + +Creates a common configuration for the arbitrumGoerli chain. + +## Description + +Chain ID: 421613 +Chain Name: Arbitrum Goerli +Default Block Explorer: https://goerli.arbiscan.io +Default RPC URL: https://goerli-rollup.arbitrum.io/rpc + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { arbitrumGoerli } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: arbitrumGoerli, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/arbitrumGoerli.d.ts:21 diff --git a/tevm/docs/common/variables/arbitrumNova.md b/tevm/docs/common/variables/arbitrumNova.md new file mode 100644 index 0000000000..a84d4bac7c --- /dev/null +++ b/tevm/docs/common/variables/arbitrumNova.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / arbitrumNova + +# Variable: arbitrumNova + +> `const` **arbitrumNova**: `Common` + +Creates a common configuration for the arbitrumNova chain. + +## Description + +Chain ID: 42170 +Chain Name: Arbitrum Nova +Default Block Explorer: https://nova.arbiscan.io +Default RPC URL: https://nova.arbitrum.io/rpc + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { arbitrumNova } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: arbitrumNova, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/arbitrumNova.d.ts:21 diff --git a/tevm/docs/common/variables/arbitrumSepolia.md b/tevm/docs/common/variables/arbitrumSepolia.md new file mode 100644 index 0000000000..fb0bb7e695 --- /dev/null +++ b/tevm/docs/common/variables/arbitrumSepolia.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / arbitrumSepolia + +# Variable: arbitrumSepolia + +> `const` **arbitrumSepolia**: `Common` + +Creates a common configuration for the arbitrumSepolia chain. + +## Description + +Chain ID: 421614 +Chain Name: Arbitrum Sepolia +Default Block Explorer: https://sepolia.arbiscan.io +Default RPC URL: https://sepolia-rollup.arbitrum.io/rpc + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { arbitrumSepolia } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: arbitrumSepolia, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/arbitrumSepolia.d.ts:21 diff --git a/tevm/docs/common/variables/areonNetwork.md b/tevm/docs/common/variables/areonNetwork.md new file mode 100644 index 0000000000..9a7d3caee6 --- /dev/null +++ b/tevm/docs/common/variables/areonNetwork.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / areonNetwork + +# Variable: areonNetwork + +> `const` **areonNetwork**: `Common` + +Creates a common configuration for the areonNetwork chain. + +## Description + +Chain ID: 463 +Chain Name: Areon Network +Default Block Explorer: https://areonscan.com +Default RPC URL: https://mainnet-rpc.areon.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { areonNetwork } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: areonNetwork, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/areonNetwork.d.ts:21 diff --git a/tevm/docs/common/variables/areonNetworkTestnet.md b/tevm/docs/common/variables/areonNetworkTestnet.md new file mode 100644 index 0000000000..8101c48561 --- /dev/null +++ b/tevm/docs/common/variables/areonNetworkTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / areonNetworkTestnet + +# Variable: areonNetworkTestnet + +> `const` **areonNetworkTestnet**: `Common` + +Creates a common configuration for the areonNetworkTestnet chain. + +## Description + +Chain ID: 462 +Chain Name: Areon Network Testnet +Default Block Explorer: https://areonscan.com +Default RPC URL: https://testnet-rpc.areon.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { areonNetworkTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: areonNetworkTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/areonNetworkTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/artelaTestnet.md b/tevm/docs/common/variables/artelaTestnet.md new file mode 100644 index 0000000000..005fde8a92 --- /dev/null +++ b/tevm/docs/common/variables/artelaTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / artelaTestnet + +# Variable: artelaTestnet + +> `const` **artelaTestnet**: `Common` + +Creates a common configuration for the artelaTestnet chain. + +## Description + +Chain ID: 11822 +Chain Name: Artela Testnet +Default Block Explorer: https://betanet-scan.artela.network +Default RPC URL: https://betanet-rpc1.artela.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { artelaTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: artelaTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/artelaTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/assetChainTestnet.md b/tevm/docs/common/variables/assetChainTestnet.md new file mode 100644 index 0000000000..873dea115b --- /dev/null +++ b/tevm/docs/common/variables/assetChainTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / assetChainTestnet + +# Variable: assetChainTestnet + +> `const` **assetChainTestnet**: `Common` + +Creates a common configuration for the assetChainTestnet chain. + +## Description + +Chain ID: 42421 +Chain Name: AssetChain Testnet +Default Block Explorer: https://scan-testnet.assetchain.org +Default RPC URL: https://enugu-rpc.assetchain.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { assetChainTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: assetChainTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/assetChainTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/astar.md b/tevm/docs/common/variables/astar.md new file mode 100644 index 0000000000..c92faa692a --- /dev/null +++ b/tevm/docs/common/variables/astar.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / astar + +# Variable: astar + +> `const` **astar**: `Common` + +Creates a common configuration for the astar chain. + +## Description + +Chain ID: 592 +Chain Name: Astar +Default Block Explorer: https://astar.subscan.io +Default RPC URL: https://astar.api.onfinality.io/public + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { astar } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: astar, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/astar.d.ts:21 diff --git a/tevm/docs/common/variables/astarZkEVM.md b/tevm/docs/common/variables/astarZkEVM.md new file mode 100644 index 0000000000..b5c58c99ae --- /dev/null +++ b/tevm/docs/common/variables/astarZkEVM.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / astarZkEVM + +# Variable: astarZkEVM + +> `const` **astarZkEVM**: `Common` + +Creates a common configuration for the astarZkEVM chain. + +## Description + +Chain ID: 3776 +Chain Name: Astar zkEVM +Default Block Explorer: https://astar-zkevm.explorer.startale.com +Default RPC URL: https://rpc.startale.com/astar-zkevm + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { astarZkEVM } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: astarZkEVM, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/astarZkEVM.d.ts:21 diff --git a/tevm/docs/common/variables/astarZkyoto.md b/tevm/docs/common/variables/astarZkyoto.md new file mode 100644 index 0000000000..ab07ab82b0 --- /dev/null +++ b/tevm/docs/common/variables/astarZkyoto.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / astarZkyoto + +# Variable: astarZkyoto + +> `const` **astarZkyoto**: `Common` + +Creates a common configuration for the astarZkyoto chain. + +## Description + +Chain ID: 6038361 +Chain Name: Astar zkEVM Testnet zKyoto +Default Block Explorer: https://zkyoto.explorer.startale.com +Default RPC URL: https://rpc.startale.com/zkyoto + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { astarZkyoto } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: astarZkyoto, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/astarZkyoto.d.ts:21 diff --git a/tevm/docs/common/variables/atletaOlympia.md b/tevm/docs/common/variables/atletaOlympia.md new file mode 100644 index 0000000000..367d350f76 --- /dev/null +++ b/tevm/docs/common/variables/atletaOlympia.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / atletaOlympia + +# Variable: atletaOlympia + +> `const` **atletaOlympia**: `Common` + +Creates a common configuration for the atletaOlympia chain. + +## Description + +Chain ID: 2340 +Chain Name: Atleta Olympia +Default Block Explorer: https://blockscout.atleta.network +Default RPC URL: https://testnet-rpc.atleta.network:9944 + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { atletaOlympia } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: atletaOlympia, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/atletaOlympia.d.ts:21 diff --git a/tevm/docs/common/variables/aurora.md b/tevm/docs/common/variables/aurora.md new file mode 100644 index 0000000000..f6507c15e5 --- /dev/null +++ b/tevm/docs/common/variables/aurora.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / aurora + +# Variable: aurora + +> `const` **aurora**: `Common` + +Creates a common configuration for the aurora chain. + +## Description + +Chain ID: 1313161554 +Chain Name: Aurora +Default Block Explorer: https://aurorascan.dev +Default RPC URL: https://mainnet.aurora.dev + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { aurora } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: aurora, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/aurora.d.ts:21 diff --git a/tevm/docs/common/variables/auroraTestnet.md b/tevm/docs/common/variables/auroraTestnet.md new file mode 100644 index 0000000000..ef09438ff7 --- /dev/null +++ b/tevm/docs/common/variables/auroraTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / auroraTestnet + +# Variable: auroraTestnet + +> `const` **auroraTestnet**: `Common` + +Creates a common configuration for the auroraTestnet chain. + +## Description + +Chain ID: 1313161555 +Chain Name: Aurora Testnet +Default Block Explorer: https://testnet.aurorascan.dev +Default RPC URL: https://testnet.aurora.dev + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { auroraTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: auroraTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/auroraTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/auroria.md b/tevm/docs/common/variables/auroria.md new file mode 100644 index 0000000000..5d10150856 --- /dev/null +++ b/tevm/docs/common/variables/auroria.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / auroria + +# Variable: auroria + +> `const` **auroria**: `Common` + +Creates a common configuration for the auroria chain. + +## Description + +Chain ID: 205205 +Chain Name: Auroria Testnet +Default Block Explorer: https://auroria.explorer.stratisevm.com +Default RPC URL: https://auroria.rpc.stratisevm.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { auroria } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: auroria, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/auroria.d.ts:21 diff --git a/tevm/docs/common/variables/avalanche.md b/tevm/docs/common/variables/avalanche.md new file mode 100644 index 0000000000..2b445e483c --- /dev/null +++ b/tevm/docs/common/variables/avalanche.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / avalanche + +# Variable: avalanche + +> `const` **avalanche**: `Common` + +Creates a common configuration for the avalanche chain. + +## Description + +Chain ID: 43114 +Chain Name: Avalanche +Default Block Explorer: https://snowtrace.io +Default RPC URL: https://api.avax.network/ext/bc/C/rpc + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { avalanche } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: avalanche, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/avalanche.d.ts:21 diff --git a/tevm/docs/common/variables/avalancheFuji.md b/tevm/docs/common/variables/avalancheFuji.md new file mode 100644 index 0000000000..0e8c03dd6c --- /dev/null +++ b/tevm/docs/common/variables/avalancheFuji.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / avalancheFuji + +# Variable: avalancheFuji + +> `const` **avalancheFuji**: `Common` + +Creates a common configuration for the avalancheFuji chain. + +## Description + +Chain ID: 43113 +Chain Name: Avalanche Fuji +Default Block Explorer: https://testnet.snowtrace.io +Default RPC URL: https://api.avax-test.network/ext/bc/C/rpc + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { avalancheFuji } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: avalancheFuji, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/avalancheFuji.d.ts:21 diff --git a/tevm/docs/common/variables/b3.md b/tevm/docs/common/variables/b3.md new file mode 100644 index 0000000000..bc6c9e01bc --- /dev/null +++ b/tevm/docs/common/variables/b3.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / b3 + +# Variable: b3 + +> `const` **b3**: `Common` + +Creates a common configuration for the b3 chain. + +## Description + +Chain ID: 8333 +Chain Name: B3 +Default Block Explorer: https://explorer.b3.fun +Default RPC URL: https://mainnet-rpc.b3.fun/http + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { b3 } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: b3, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/b3.d.ts:21 diff --git a/tevm/docs/common/variables/b3Sepolia.md b/tevm/docs/common/variables/b3Sepolia.md new file mode 100644 index 0000000000..1ee2bc4b52 --- /dev/null +++ b/tevm/docs/common/variables/b3Sepolia.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / b3Sepolia + +# Variable: b3Sepolia + +> `const` **b3Sepolia**: `Common` + +Creates a common configuration for the b3Sepolia chain. + +## Description + +Chain ID: 1993 +Chain Name: B3 Sepolia +Default Block Explorer: https://sepolia.explorer.b3.fun +Default RPC URL: https://sepolia.b3.fun/http + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { b3Sepolia } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: b3Sepolia, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/b3Sepolia.d.ts:21 diff --git a/tevm/docs/common/variables/bahamut.md b/tevm/docs/common/variables/bahamut.md new file mode 100644 index 0000000000..da8a27b98e --- /dev/null +++ b/tevm/docs/common/variables/bahamut.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / bahamut + +# Variable: bahamut + +> `const` **bahamut**: `Common` + +Creates a common configuration for the bahamut chain. + +## Description + +Chain ID: 5165 +Chain Name: Bahamut +Default Block Explorer: https://www.ftnscan.com +Default RPC URL: https://rpc1.bahamut.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { bahamut } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: bahamut, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/bahamut.d.ts:21 diff --git a/tevm/docs/common/variables/base.md b/tevm/docs/common/variables/base.md index d166d3ecaf..61cfabc349 100644 --- a/tevm/docs/common/variables/base.md +++ b/tevm/docs/common/variables/base.md @@ -8,6 +8,30 @@ > `const` **base**: `Common` +Creates a common configuration for the base chain. + +## Description + +Chain ID: 8453 +Chain Name: Base +Default Block Explorer: https://basescan.org +Default RPC URL: https://mainnet.base.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { base } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: base, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + ## Defined in -packages/common/types/presets/base.d.ts:1 +packages/common/types/presets/base.d.ts:21 diff --git a/tevm/docs/common/variables/baseGoerli.md b/tevm/docs/common/variables/baseGoerli.md new file mode 100644 index 0000000000..077bfbbc8c --- /dev/null +++ b/tevm/docs/common/variables/baseGoerli.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / baseGoerli + +# Variable: baseGoerli + +> `const` **baseGoerli**: `Common` + +Creates a common configuration for the baseGoerli chain. + +## Description + +Chain ID: 84531 +Chain Name: Base Goerli +Default Block Explorer: https://goerli.basescan.org +Default RPC URL: https://goerli.base.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { baseGoerli } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: baseGoerli, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/baseGoerli.d.ts:21 diff --git a/tevm/docs/common/variables/baseSepolia.md b/tevm/docs/common/variables/baseSepolia.md index 5e83c8e934..ac1da736f6 100644 --- a/tevm/docs/common/variables/baseSepolia.md +++ b/tevm/docs/common/variables/baseSepolia.md @@ -8,6 +8,30 @@ > `const` **baseSepolia**: `Common` +Creates a common configuration for the baseSepolia chain. + +## Description + +Chain ID: 84532 +Chain Name: Base Sepolia +Default Block Explorer: https://sepolia.basescan.org +Default RPC URL: https://sepolia.base.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { baseSepolia } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: baseSepolia, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + ## Defined in -packages/common/types/presets/baseSepolia.d.ts:1 +packages/common/types/presets/baseSepolia.d.ts:21 diff --git a/tevm/docs/common/variables/beam.md b/tevm/docs/common/variables/beam.md new file mode 100644 index 0000000000..c335464c4d --- /dev/null +++ b/tevm/docs/common/variables/beam.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / beam + +# Variable: beam + +> `const` **beam**: `Common` + +Creates a common configuration for the beam chain. + +## Description + +Chain ID: 4337 +Chain Name: Beam +Default Block Explorer: https://subnets.avax.network/beam +Default RPC URL: https://build.onbeam.com/rpc + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { beam } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: beam, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/beam.d.ts:21 diff --git a/tevm/docs/common/variables/beamTestnet.md b/tevm/docs/common/variables/beamTestnet.md new file mode 100644 index 0000000000..cd4bdc9aec --- /dev/null +++ b/tevm/docs/common/variables/beamTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / beamTestnet + +# Variable: beamTestnet + +> `const` **beamTestnet**: `Common` + +Creates a common configuration for the beamTestnet chain. + +## Description + +Chain ID: 13337 +Chain Name: Beam Testnet +Default Block Explorer: https://subnets-test.avax.network/beam +Default RPC URL: https://build.onbeam.com/rpc/testnet + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { beamTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: beamTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/beamTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/bearNetworkChainMainnet.md b/tevm/docs/common/variables/bearNetworkChainMainnet.md new file mode 100644 index 0000000000..48ea9db295 --- /dev/null +++ b/tevm/docs/common/variables/bearNetworkChainMainnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / bearNetworkChainMainnet + +# Variable: bearNetworkChainMainnet + +> `const` **bearNetworkChainMainnet**: `Common` + +Creates a common configuration for the bearNetworkChainMainnet chain. + +## Description + +Chain ID: 641230 +Chain Name: Bear Network Chain Mainnet +Default Block Explorer: https://brnkscan.bearnetwork.net +Default RPC URL: https://brnkc-mainnet.bearnetwork.net + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { bearNetworkChainMainnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: bearNetworkChainMainnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/bearNetworkChainMainnet.d.ts:21 diff --git a/tevm/docs/common/variables/bearNetworkChainTestnet.md b/tevm/docs/common/variables/bearNetworkChainTestnet.md new file mode 100644 index 0000000000..966d89a6fc --- /dev/null +++ b/tevm/docs/common/variables/bearNetworkChainTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / bearNetworkChainTestnet + +# Variable: bearNetworkChainTestnet + +> `const` **bearNetworkChainTestnet**: `Common` + +Creates a common configuration for the bearNetworkChainTestnet chain. + +## Description + +Chain ID: 751230 +Chain Name: Bear Network Chain Testnet +Default Block Explorer: https://brnktest-scan.bearnetwork.net +Default RPC URL: https://brnkc-test.bearnetwork.net + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { bearNetworkChainTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: bearNetworkChainTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/bearNetworkChainTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/berachainTestnet.md b/tevm/docs/common/variables/berachainTestnet.md new file mode 100644 index 0000000000..ca2f5ad332 --- /dev/null +++ b/tevm/docs/common/variables/berachainTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / berachainTestnet + +# Variable: berachainTestnet + +> `const` **berachainTestnet**: `Common` + +Creates a common configuration for the berachainTestnet chain. + +## Description + +Chain ID: 80085 +Chain Name: Berachain Artio +Default Block Explorer: https://artio.beratrail.io +Default RPC URL: https://artio.rpc.berachain.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { berachainTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: berachainTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/berachainTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/berachainTestnetbArtio.md b/tevm/docs/common/variables/berachainTestnetbArtio.md new file mode 100644 index 0000000000..a877150d92 --- /dev/null +++ b/tevm/docs/common/variables/berachainTestnetbArtio.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / berachainTestnetbArtio + +# Variable: berachainTestnetbArtio + +> `const` **berachainTestnetbArtio**: `Common` + +Creates a common configuration for the berachainTestnetbArtio chain. + +## Description + +Chain ID: 80084 +Chain Name: Berachain bArtio +Default Block Explorer: https://bartio.beratrail.io +Default RPC URL: https://bartio.rpc.berachain.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { berachainTestnetbArtio } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: berachainTestnetbArtio, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/berachainTestnetbArtio.d.ts:21 diff --git a/tevm/docs/common/variables/bevmMainnet.md b/tevm/docs/common/variables/bevmMainnet.md new file mode 100644 index 0000000000..e25fe4038b --- /dev/null +++ b/tevm/docs/common/variables/bevmMainnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / bevmMainnet + +# Variable: bevmMainnet + +> `const` **bevmMainnet**: `Common` + +Creates a common configuration for the bevmMainnet chain. + +## Description + +Chain ID: 11501 +Chain Name: BEVM Mainnet +Default Block Explorer: https://scan-mainnet.bevm.io +Default RPC URL: https://rpc-mainnet-1.bevm.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { bevmMainnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: bevmMainnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/bevmMainnet.d.ts:21 diff --git a/tevm/docs/common/variables/bitTorrent.md b/tevm/docs/common/variables/bitTorrent.md new file mode 100644 index 0000000000..6ae256c5c2 --- /dev/null +++ b/tevm/docs/common/variables/bitTorrent.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / bitTorrent + +# Variable: bitTorrent + +> `const` **bitTorrent**: `Common` + +Creates a common configuration for the bitTorrent chain. + +## Description + +Chain ID: 199 +Chain Name: BitTorrent +Default Block Explorer: https://bttcscan.com +Default RPC URL: https://rpc.bittorrentchain.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { bitTorrent } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: bitTorrent, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/bitTorrent.d.ts:21 diff --git a/tevm/docs/common/variables/bitTorrentTestnet.md b/tevm/docs/common/variables/bitTorrentTestnet.md new file mode 100644 index 0000000000..1e91c355c8 --- /dev/null +++ b/tevm/docs/common/variables/bitTorrentTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / bitTorrentTestnet + +# Variable: bitTorrentTestnet + +> `const` **bitTorrentTestnet**: `Common` + +Creates a common configuration for the bitTorrentTestnet chain. + +## Description + +Chain ID: 1028 +Chain Name: BitTorrent Chain Testnet +Default Block Explorer: https://testnet.bttcscan.com +Default RPC URL: https://testrpc.bittorrentchain.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { bitTorrentTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: bitTorrentTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/bitTorrentTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/bitkub.md b/tevm/docs/common/variables/bitkub.md new file mode 100644 index 0000000000..249b2f4c60 --- /dev/null +++ b/tevm/docs/common/variables/bitkub.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / bitkub + +# Variable: bitkub + +> `const` **bitkub**: `Common` + +Creates a common configuration for the bitkub chain. + +## Description + +Chain ID: 96 +Chain Name: Bitkub +Default Block Explorer: https://www.bkcscan.com +Default RPC URL: https://rpc.bitkubchain.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { bitkub } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: bitkub, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/bitkub.d.ts:21 diff --git a/tevm/docs/common/variables/bitkubTestnet.md b/tevm/docs/common/variables/bitkubTestnet.md new file mode 100644 index 0000000000..ca2e4e2257 --- /dev/null +++ b/tevm/docs/common/variables/bitkubTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / bitkubTestnet + +# Variable: bitkubTestnet + +> `const` **bitkubTestnet**: `Common` + +Creates a common configuration for the bitkubTestnet chain. + +## Description + +Chain ID: 25925 +Chain Name: Bitkub Testnet +Default Block Explorer: https://testnet.bkcscan.com +Default RPC URL: https://rpc-testnet.bitkubchain.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { bitkubTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: bitkubTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/bitkubTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/blast.md b/tevm/docs/common/variables/blast.md new file mode 100644 index 0000000000..d0f97da5c5 --- /dev/null +++ b/tevm/docs/common/variables/blast.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / blast + +# Variable: blast + +> `const` **blast**: `Common` + +Creates a common configuration for the blast chain. + +## Description + +Chain ID: 81457 +Chain Name: Blast +Default Block Explorer: https://blastscan.io +Default RPC URL: https://rpc.blast.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { blast } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: blast, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/blast.d.ts:21 diff --git a/tevm/docs/common/variables/blastSepolia.md b/tevm/docs/common/variables/blastSepolia.md new file mode 100644 index 0000000000..6cfbcb2323 --- /dev/null +++ b/tevm/docs/common/variables/blastSepolia.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / blastSepolia + +# Variable: blastSepolia + +> `const` **blastSepolia**: `Common` + +Creates a common configuration for the blastSepolia chain. + +## Description + +Chain ID: 168587773 +Chain Name: Blast Sepolia +Default Block Explorer: https://sepolia.blastscan.io +Default RPC URL: https://sepolia.blast.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { blastSepolia } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: blastSepolia, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/blastSepolia.d.ts:21 diff --git a/tevm/docs/common/variables/bob.md b/tevm/docs/common/variables/bob.md new file mode 100644 index 0000000000..82bae5b206 --- /dev/null +++ b/tevm/docs/common/variables/bob.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / bob + +# Variable: bob + +> `const` **bob**: `Common` + +Creates a common configuration for the bob chain. + +## Description + +Chain ID: 60808 +Chain Name: BOB +Default Block Explorer: https://explorer.gobob.xyz +Default RPC URL: https://rpc.gobob.xyz + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { bob } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: bob, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/bob.d.ts:21 diff --git a/tevm/docs/common/variables/bobSepolia.md b/tevm/docs/common/variables/bobSepolia.md new file mode 100644 index 0000000000..1bed4f85a8 --- /dev/null +++ b/tevm/docs/common/variables/bobSepolia.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / bobSepolia + +# Variable: bobSepolia + +> `const` **bobSepolia**: `Common` + +Creates a common configuration for the bobSepolia chain. + +## Description + +Chain ID: 808813 +Chain Name: BOB Sepolia +Default Block Explorer: https://bob-sepolia.explorer.gobob.xyz +Default RPC URL: https://bob-sepolia.rpc.gobob.xyz + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { bobSepolia } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: bobSepolia, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/bobSepolia.d.ts:21 diff --git a/tevm/docs/common/variables/boba.md b/tevm/docs/common/variables/boba.md new file mode 100644 index 0000000000..952d61b1ee --- /dev/null +++ b/tevm/docs/common/variables/boba.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / boba + +# Variable: boba + +> `const` **boba**: `Common` + +Creates a common configuration for the boba chain. + +## Description + +Chain ID: 288 +Chain Name: Boba Network +Default Block Explorer: https://bobascan.com +Default RPC URL: https://mainnet.boba.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { boba } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: boba, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/boba.d.ts:21 diff --git a/tevm/docs/common/variables/bobaSepolia.md b/tevm/docs/common/variables/bobaSepolia.md new file mode 100644 index 0000000000..e404821547 --- /dev/null +++ b/tevm/docs/common/variables/bobaSepolia.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / bobaSepolia + +# Variable: bobaSepolia + +> `const` **bobaSepolia**: `Common` + +Creates a common configuration for the bobaSepolia chain. + +## Description + +Chain ID: 28882 +Chain Name: Boba Sepolia +Default Block Explorer: https://testnet.bobascan.com +Default RPC URL: https://sepolia.boba.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { bobaSepolia } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: bobaSepolia, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/bobaSepolia.d.ts:21 diff --git a/tevm/docs/common/variables/botanixTestnet.md b/tevm/docs/common/variables/botanixTestnet.md new file mode 100644 index 0000000000..92a3b80e0d --- /dev/null +++ b/tevm/docs/common/variables/botanixTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / botanixTestnet + +# Variable: botanixTestnet + +> `const` **botanixTestnet**: `Common` + +Creates a common configuration for the botanixTestnet chain. + +## Description + +Chain ID: 3636 +Chain Name: Botanix Testnet +Default Block Explorer: https://blockscout.botanixlabs.dev +Default RPC URL: https://poa-node.botanixlabs.dev + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { botanixTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: botanixTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/botanixTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/bronos.md b/tevm/docs/common/variables/bronos.md new file mode 100644 index 0000000000..e7e262b415 --- /dev/null +++ b/tevm/docs/common/variables/bronos.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / bronos + +# Variable: bronos + +> `const` **bronos**: `Common` + +Creates a common configuration for the bronos chain. + +## Description + +Chain ID: 1039 +Chain Name: Bronos +Default Block Explorer: https://broscan.bronos.org +Default RPC URL: https://evm.bronos.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { bronos } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: bronos, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/bronos.d.ts:21 diff --git a/tevm/docs/common/variables/bronosTestnet.md b/tevm/docs/common/variables/bronosTestnet.md new file mode 100644 index 0000000000..8a5be2301d --- /dev/null +++ b/tevm/docs/common/variables/bronosTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / bronosTestnet + +# Variable: bronosTestnet + +> `const` **bronosTestnet**: `Common` + +Creates a common configuration for the bronosTestnet chain. + +## Description + +Chain ID: 1038 +Chain Name: Bronos Testnet +Default Block Explorer: https://tbroscan.bronos.org +Default RPC URL: https://evm-testnet.bronos.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { bronosTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: bronosTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/bronosTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/bsc.md b/tevm/docs/common/variables/bsc.md new file mode 100644 index 0000000000..e3b469d9a4 --- /dev/null +++ b/tevm/docs/common/variables/bsc.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / bsc + +# Variable: bsc + +> `const` **bsc**: `Common` + +Creates a common configuration for the bsc chain. + +## Description + +Chain ID: 56 +Chain Name: BNB Smart Chain +Default Block Explorer: https://bscscan.com +Default RPC URL: https://rpc.ankr.com/bsc + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { bsc } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: bsc, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/bsc.d.ts:21 diff --git a/tevm/docs/common/variables/bscGreenfield.md b/tevm/docs/common/variables/bscGreenfield.md new file mode 100644 index 0000000000..a734224ed1 --- /dev/null +++ b/tevm/docs/common/variables/bscGreenfield.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / bscGreenfield + +# Variable: bscGreenfield + +> `const` **bscGreenfield**: `Common` + +Creates a common configuration for the bscGreenfield chain. + +## Description + +Chain ID: 1017 +Chain Name: BNB Greenfield Chain +Default Block Explorer: https://greenfieldscan.com +Default RPC URL: https://greenfield-chain.bnbchain.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { bscGreenfield } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: bscGreenfield, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/bscGreenfield.d.ts:21 diff --git a/tevm/docs/common/variables/bscTestnet.md b/tevm/docs/common/variables/bscTestnet.md new file mode 100644 index 0000000000..aaaa3c07ac --- /dev/null +++ b/tevm/docs/common/variables/bscTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / bscTestnet + +# Variable: bscTestnet + +> `const` **bscTestnet**: `Common` + +Creates a common configuration for the bscTestnet chain. + +## Description + +Chain ID: 97 +Chain Name: Binance Smart Chain Testnet +Default Block Explorer: https://testnet.bscscan.com +Default RPC URL: https://data-seed-prebsc-1-s1.bnbchain.org:8545 + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { bscTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: bscTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/bscTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/btr.md b/tevm/docs/common/variables/btr.md new file mode 100644 index 0000000000..37b8f1d6e2 --- /dev/null +++ b/tevm/docs/common/variables/btr.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / btr + +# Variable: btr + +> `const` **btr**: `Common` + +Creates a common configuration for the btr chain. + +## Description + +Chain ID: 200901 +Chain Name: Bitlayer +Default Block Explorer: https://www.btrscan.com +Default RPC URL: https://rpc.bitlayer.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { btr } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: btr, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/btr.d.ts:21 diff --git a/tevm/docs/common/variables/btrTestnet.md b/tevm/docs/common/variables/btrTestnet.md new file mode 100644 index 0000000000..6f69ad9c7b --- /dev/null +++ b/tevm/docs/common/variables/btrTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / btrTestnet + +# Variable: btrTestnet + +> `const` **btrTestnet**: `Common` + +Creates a common configuration for the btrTestnet chain. + +## Description + +Chain ID: 200810 +Chain Name: Bitlayer Testnet +Default Block Explorer: https://testnet.btrscan.com +Default RPC URL: https://testnet-rpc.bitlayer.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { btrTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: btrTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/btrTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/bxn.md b/tevm/docs/common/variables/bxn.md new file mode 100644 index 0000000000..82de014c68 --- /dev/null +++ b/tevm/docs/common/variables/bxn.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / bxn + +# Variable: bxn + +> `const` **bxn**: `Common` + +Creates a common configuration for the bxn chain. + +## Description + +Chain ID: 4999 +Chain Name: BlackFort Exchange Network +Default Block Explorer: https://explorer.blackfort.network +Default RPC URL: https://mainnet.blackfort.network/rpc + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { bxn } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: bxn, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/bxn.d.ts:21 diff --git a/tevm/docs/common/variables/bxnTestnet.md b/tevm/docs/common/variables/bxnTestnet.md new file mode 100644 index 0000000000..732c13906c --- /dev/null +++ b/tevm/docs/common/variables/bxnTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / bxnTestnet + +# Variable: bxnTestnet + +> `const` **bxnTestnet**: `Common` + +Creates a common configuration for the bxnTestnet chain. + +## Description + +Chain ID: 4777 +Chain Name: BlackFort Exchange Network Testnet +Default Block Explorer: https://testnet-explorer.blackfort.network +Default RPC URL: https://testnet.blackfort.network/rpc + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { bxnTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: bxnTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/bxnTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/canto.md b/tevm/docs/common/variables/canto.md new file mode 100644 index 0000000000..20dc3d6ade --- /dev/null +++ b/tevm/docs/common/variables/canto.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / canto + +# Variable: canto + +> `const` **canto**: `Common` + +Creates a common configuration for the canto chain. + +## Description + +Chain ID: 7700 +Chain Name: Canto +Default Block Explorer: https://tuber.build +Default RPC URL: https://canto.gravitychain.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { canto } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: canto, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/canto.d.ts:21 diff --git a/tevm/docs/common/variables/celo.md b/tevm/docs/common/variables/celo.md new file mode 100644 index 0000000000..d2988c5231 --- /dev/null +++ b/tevm/docs/common/variables/celo.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / celo + +# Variable: celo + +> `const` **celo**: `Common` + +Creates a common configuration for the celo chain. + +## Description + +Chain ID: 42220 +Chain Name: Celo +Default Block Explorer: https://celoscan.io +Default RPC URL: https://forno.celo.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { celo } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: celo, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/celo.d.ts:21 diff --git a/tevm/docs/common/variables/celoAlfajores.md b/tevm/docs/common/variables/celoAlfajores.md new file mode 100644 index 0000000000..63503653b8 --- /dev/null +++ b/tevm/docs/common/variables/celoAlfajores.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / celoAlfajores + +# Variable: celoAlfajores + +> `const` **celoAlfajores**: `Common` + +Creates a common configuration for the celoAlfajores chain. + +## Description + +Chain ID: 44787 +Chain Name: Alfajores +Default Block Explorer: https://explorer.celo.org/alfajores +Default RPC URL: https://alfajores-forno.celo-testnet.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { celoAlfajores } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: celoAlfajores, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/celoAlfajores.d.ts:21 diff --git a/tevm/docs/common/variables/chiliz.md b/tevm/docs/common/variables/chiliz.md new file mode 100644 index 0000000000..011d3669f6 --- /dev/null +++ b/tevm/docs/common/variables/chiliz.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / chiliz + +# Variable: chiliz + +> `const` **chiliz**: `Common` + +Creates a common configuration for the chiliz chain. + +## Description + +Chain ID: 88888 +Chain Name: Chiliz Chain +Default Block Explorer: https://scan.chiliz.com +Default RPC URL: https://rpc.ankr.com/chiliz + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { chiliz } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: chiliz, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/chiliz.d.ts:21 diff --git a/tevm/docs/common/variables/chips.md b/tevm/docs/common/variables/chips.md new file mode 100644 index 0000000000..33c8f38028 --- /dev/null +++ b/tevm/docs/common/variables/chips.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / chips + +# Variable: chips + +> `const` **chips**: `Common` + +Creates a common configuration for the chips chain. + +## Description + +Chain ID: 2882 +Chain Name: Chips Network +Default Block Explorer: Not specified +Default RPC URL: https://node.chips.ooo/wasp/api/v1/chains/iota1pp3d3mnap3ufmgqnjsnw344sqmf5svjh26y2khnmc89sv6788y3r207a8fn/evm + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { chips } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: chips, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/chips.d.ts:21 diff --git a/tevm/docs/common/variables/classic.md b/tevm/docs/common/variables/classic.md new file mode 100644 index 0000000000..614f53b7cf --- /dev/null +++ b/tevm/docs/common/variables/classic.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / classic + +# Variable: classic + +> `const` **classic**: `Common` + +Creates a common configuration for the classic chain. + +## Description + +Chain ID: 61 +Chain Name: Ethereum Classic +Default Block Explorer: https://blockscout.com/etc/mainnet +Default RPC URL: https://etc.rivet.link + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { classic } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: classic, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/classic.d.ts:21 diff --git a/tevm/docs/common/variables/confluxESpace.md b/tevm/docs/common/variables/confluxESpace.md new file mode 100644 index 0000000000..cc7cf10d9d --- /dev/null +++ b/tevm/docs/common/variables/confluxESpace.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / confluxESpace + +# Variable: confluxESpace + +> `const` **confluxESpace**: `Common` + +Creates a common configuration for the confluxESpace chain. + +## Description + +Chain ID: 1030 +Chain Name: Conflux eSpace +Default Block Explorer: https://evm.confluxscan.io +Default RPC URL: https://evm.confluxrpc.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { confluxESpace } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: confluxESpace, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/confluxESpace.d.ts:21 diff --git a/tevm/docs/common/variables/confluxESpaceTestnet.md b/tevm/docs/common/variables/confluxESpaceTestnet.md new file mode 100644 index 0000000000..d1bb693d5d --- /dev/null +++ b/tevm/docs/common/variables/confluxESpaceTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / confluxESpaceTestnet + +# Variable: confluxESpaceTestnet + +> `const` **confluxESpaceTestnet**: `Common` + +Creates a common configuration for the confluxESpaceTestnet chain. + +## Description + +Chain ID: 71 +Chain Name: Conflux eSpace Testnet +Default Block Explorer: https://evmtestnet.confluxscan.io +Default RPC URL: https://evmtestnet.confluxrpc.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { confluxESpaceTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: confluxESpaceTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/confluxESpaceTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/coreDao.md b/tevm/docs/common/variables/coreDao.md new file mode 100644 index 0000000000..977f57bb79 --- /dev/null +++ b/tevm/docs/common/variables/coreDao.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / coreDao + +# Variable: coreDao + +> `const` **coreDao**: `Common` + +Creates a common configuration for the coreDao chain. + +## Description + +Chain ID: 1116 +Chain Name: Core Dao +Default Block Explorer: https://scan.coredao.org +Default RPC URL: https://rpc.coredao.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { coreDao } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: coreDao, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/coreDao.d.ts:21 diff --git a/tevm/docs/common/variables/crab.md b/tevm/docs/common/variables/crab.md new file mode 100644 index 0000000000..880ac5a960 --- /dev/null +++ b/tevm/docs/common/variables/crab.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / crab + +# Variable: crab + +> `const` **crab**: `Common` + +Creates a common configuration for the crab chain. + +## Description + +Chain ID: 44 +Chain Name: Crab Network +Default Block Explorer: https://crab-scan.darwinia.network +Default RPC URL: https://crab-rpc.darwinia.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { crab } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: crab, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/crab.d.ts:21 diff --git a/tevm/docs/common/variables/cronos.md b/tevm/docs/common/variables/cronos.md new file mode 100644 index 0000000000..910f2b3977 --- /dev/null +++ b/tevm/docs/common/variables/cronos.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / cronos + +# Variable: cronos + +> `const` **cronos**: `Common` + +Creates a common configuration for the cronos chain. + +## Description + +Chain ID: 25 +Chain Name: Cronos Mainnet +Default Block Explorer: https://explorer.cronos.org +Default RPC URL: https://evm.cronos.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { cronos } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: cronos, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/cronos.d.ts:21 diff --git a/tevm/docs/common/variables/cronosTestnet.md b/tevm/docs/common/variables/cronosTestnet.md new file mode 100644 index 0000000000..318d45d5ba --- /dev/null +++ b/tevm/docs/common/variables/cronosTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / cronosTestnet + +# Variable: cronosTestnet + +> `const` **cronosTestnet**: `Common` + +Creates a common configuration for the cronosTestnet chain. + +## Description + +Chain ID: 338 +Chain Name: Cronos Testnet +Default Block Explorer: https://cronos.org/explorer/testnet3 +Default RPC URL: https://evm-t3.cronos.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { cronosTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: cronosTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/cronosTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/cronoszkEVM.md b/tevm/docs/common/variables/cronoszkEVM.md new file mode 100644 index 0000000000..d72a70989e --- /dev/null +++ b/tevm/docs/common/variables/cronoszkEVM.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / cronoszkEVM + +# Variable: cronoszkEVM + +> `const` **cronoszkEVM**: `Common` + +Creates a common configuration for the cronoszkEVM chain. + +## Description + +Chain ID: 388 +Chain Name: Cronos zkEVM Mainnet +Default Block Explorer: https://explorer.zkevm.cronos.org +Default RPC URL: https://mainnet.zkevm.cronos.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { cronoszkEVM } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: cronoszkEVM, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/cronoszkEVM.d.ts:21 diff --git a/tevm/docs/common/variables/cronoszkEVMTestnet.md b/tevm/docs/common/variables/cronoszkEVMTestnet.md new file mode 100644 index 0000000000..30174ea124 --- /dev/null +++ b/tevm/docs/common/variables/cronoszkEVMTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / cronoszkEVMTestnet + +# Variable: cronoszkEVMTestnet + +> `const` **cronoszkEVMTestnet**: `Common` + +Creates a common configuration for the cronoszkEVMTestnet chain. + +## Description + +Chain ID: 282 +Chain Name: Cronos zkEVM Testnet +Default Block Explorer: https://explorer.zkevm.cronos.org/testnet +Default RPC URL: https://testnet.zkevm.cronos.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { cronoszkEVMTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: cronoszkEVMTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/cronoszkEVMTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/crossbell.md b/tevm/docs/common/variables/crossbell.md new file mode 100644 index 0000000000..8e196c9745 --- /dev/null +++ b/tevm/docs/common/variables/crossbell.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / crossbell + +# Variable: crossbell + +> `const` **crossbell**: `Common` + +Creates a common configuration for the crossbell chain. + +## Description + +Chain ID: 3737 +Chain Name: Crossbell +Default Block Explorer: https://scan.crossbell.io +Default RPC URL: https://rpc.crossbell.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { crossbell } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: crossbell, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/crossbell.d.ts:21 diff --git a/tevm/docs/common/variables/curtis.md b/tevm/docs/common/variables/curtis.md new file mode 100644 index 0000000000..14e1ba2a84 --- /dev/null +++ b/tevm/docs/common/variables/curtis.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / curtis + +# Variable: curtis + +> `const` **curtis**: `Common` + +Creates a common configuration for the curtis chain. + +## Description + +Chain ID: 33111 +Chain Name: Curtis +Default Block Explorer: https://explorer.curtis.apechain.com +Default RPC URL: https://rpc.curtis.apechain.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { curtis } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: curtis, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/curtis.d.ts:21 diff --git a/tevm/docs/common/variables/cyber.md b/tevm/docs/common/variables/cyber.md new file mode 100644 index 0000000000..6802d810d2 --- /dev/null +++ b/tevm/docs/common/variables/cyber.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / cyber + +# Variable: cyber + +> `const` **cyber**: `Common` + +Creates a common configuration for the cyber chain. + +## Description + +Chain ID: 7560 +Chain Name: Cyber +Default Block Explorer: https://cyberscan.co +Default RPC URL: https://cyber.alt.technology + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { cyber } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: cyber, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/cyber.d.ts:21 diff --git a/tevm/docs/common/variables/cyberTestnet.md b/tevm/docs/common/variables/cyberTestnet.md new file mode 100644 index 0000000000..edcd357c27 --- /dev/null +++ b/tevm/docs/common/variables/cyberTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / cyberTestnet + +# Variable: cyberTestnet + +> `const` **cyberTestnet**: `Common` + +Creates a common configuration for the cyberTestnet chain. + +## Description + +Chain ID: 111557560 +Chain Name: Cyber Testnet +Default Block Explorer: https://testnet.cyberscan.co +Default RPC URL: https://cyber-testnet.alt.technology + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { cyberTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: cyberTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/cyberTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/darwinia.md b/tevm/docs/common/variables/darwinia.md new file mode 100644 index 0000000000..44d7eff892 --- /dev/null +++ b/tevm/docs/common/variables/darwinia.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / darwinia + +# Variable: darwinia + +> `const` **darwinia**: `Common` + +Creates a common configuration for the darwinia chain. + +## Description + +Chain ID: 46 +Chain Name: Darwinia Network +Default Block Explorer: https://explorer.darwinia.network +Default RPC URL: https://rpc.darwinia.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { darwinia } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: darwinia, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/darwinia.d.ts:21 diff --git a/tevm/docs/common/variables/dchain.md b/tevm/docs/common/variables/dchain.md new file mode 100644 index 0000000000..ebed431d28 --- /dev/null +++ b/tevm/docs/common/variables/dchain.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / dchain + +# Variable: dchain + +> `const` **dchain**: `Common` + +Creates a common configuration for the dchain chain. + +## Description + +Chain ID: 2716446429837000 +Chain Name: Dchain +Default Block Explorer: https://dchain-2716446429837000-1.sagaexplorer.io +Default RPC URL: https://dchain-2716446429837000-1.jsonrpc.sagarpc.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { dchain } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: dchain, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/dchain.d.ts:21 diff --git a/tevm/docs/common/variables/dchainTestnet.md b/tevm/docs/common/variables/dchainTestnet.md new file mode 100644 index 0000000000..826ceeccef --- /dev/null +++ b/tevm/docs/common/variables/dchainTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / dchainTestnet + +# Variable: dchainTestnet + +> `const` **dchainTestnet**: `Common` + +Creates a common configuration for the dchainTestnet chain. + +## Description + +Chain ID: 2713017997578000 +Chain Name: Dchain Testnet +Default Block Explorer: https://dchaintestnet-2713017997578000-1.testnet.sagaexplorer.io +Default RPC URL: https://dchaintestnet-2713017997578000-1.jsonrpc.testnet.sagarpc.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { dchainTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: dchainTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/dchainTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/defichainEvm.md b/tevm/docs/common/variables/defichainEvm.md new file mode 100644 index 0000000000..061ceacf62 --- /dev/null +++ b/tevm/docs/common/variables/defichainEvm.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / defichainEvm + +# Variable: defichainEvm + +> `const` **defichainEvm**: `Common` + +Creates a common configuration for the defichainEvm chain. + +## Description + +Chain ID: 1130 +Chain Name: DeFiChain EVM Mainnet +Default Block Explorer: https://meta.defiscan.live +Default RPC URL: https://eth.mainnet.ocean.jellyfishsdk.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { defichainEvm } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: defichainEvm, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/defichainEvm.d.ts:21 diff --git a/tevm/docs/common/variables/defichainEvmTestnet.md b/tevm/docs/common/variables/defichainEvmTestnet.md new file mode 100644 index 0000000000..6fbc882426 --- /dev/null +++ b/tevm/docs/common/variables/defichainEvmTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / defichainEvmTestnet + +# Variable: defichainEvmTestnet + +> `const` **defichainEvmTestnet**: `Common` + +Creates a common configuration for the defichainEvmTestnet chain. + +## Description + +Chain ID: 1131 +Chain Name: DeFiChain EVM Testnet +Default Block Explorer: https://meta.defiscan.live/?network=TestNet +Default RPC URL: https://eth.testnet.ocean.jellyfishsdk.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { defichainEvmTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: defichainEvmTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/defichainEvmTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/degen.md b/tevm/docs/common/variables/degen.md new file mode 100644 index 0000000000..fb1b474177 --- /dev/null +++ b/tevm/docs/common/variables/degen.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / degen + +# Variable: degen + +> `const` **degen**: `Common` + +Creates a common configuration for the degen chain. + +## Description + +Chain ID: 666666666 +Chain Name: Degen +Default Block Explorer: https://explorer.degen.tips +Default RPC URL: https://rpc.degen.tips + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { degen } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: degen, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/degen.d.ts:21 diff --git a/tevm/docs/common/variables/dfk.md b/tevm/docs/common/variables/dfk.md new file mode 100644 index 0000000000..53c23c3c14 --- /dev/null +++ b/tevm/docs/common/variables/dfk.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / dfk + +# Variable: dfk + +> `const` **dfk**: `Common` + +Creates a common configuration for the dfk chain. + +## Description + +Chain ID: 53935 +Chain Name: DFK Chain +Default Block Explorer: https://subnets.avax.network/defi-kingdoms +Default RPC URL: https://subnets.avax.network/defi-kingdoms/dfk-chain/rpc + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { dfk } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: dfk, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/dfk.d.ts:21 diff --git a/tevm/docs/common/variables/dodochainTestnet.md b/tevm/docs/common/variables/dodochainTestnet.md new file mode 100644 index 0000000000..ef44ee73b0 --- /dev/null +++ b/tevm/docs/common/variables/dodochainTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / dodochainTestnet + +# Variable: dodochainTestnet + +> `const` **dodochainTestnet**: `Common` + +Creates a common configuration for the dodochainTestnet chain. + +## Description + +Chain ID: 53457 +Chain Name: DODOchain Testnet +Default Block Explorer: https://testnet-scan.dodochain.com +Default RPC URL: https://dodochain-testnet.alt.technology + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { dodochainTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: dodochainTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/dodochainTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/dogechain.md b/tevm/docs/common/variables/dogechain.md new file mode 100644 index 0000000000..f9c180fc0a --- /dev/null +++ b/tevm/docs/common/variables/dogechain.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / dogechain + +# Variable: dogechain + +> `const` **dogechain**: `Common` + +Creates a common configuration for the dogechain chain. + +## Description + +Chain ID: 2000 +Chain Name: Dogechain +Default Block Explorer: https://explorer.dogechain.dog +Default RPC URL: https://rpc.dogechain.dog + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { dogechain } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: dogechain, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/dogechain.d.ts:21 diff --git a/tevm/docs/common/variables/dreyerxMainnet.md b/tevm/docs/common/variables/dreyerxMainnet.md new file mode 100644 index 0000000000..28a73d0271 --- /dev/null +++ b/tevm/docs/common/variables/dreyerxMainnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / dreyerxMainnet + +# Variable: dreyerxMainnet + +> `const` **dreyerxMainnet**: `Common` + +Creates a common configuration for the dreyerxMainnet chain. + +## Description + +Chain ID: 23451 +Chain Name: DreyerX Mainnet +Default Block Explorer: https://scan.dreyerx.com +Default RPC URL: https://rpc.dreyerx.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { dreyerxMainnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: dreyerxMainnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/dreyerxMainnet.d.ts:21 diff --git a/tevm/docs/common/variables/dreyerxTestnet.md b/tevm/docs/common/variables/dreyerxTestnet.md new file mode 100644 index 0000000000..6f351fbaf0 --- /dev/null +++ b/tevm/docs/common/variables/dreyerxTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / dreyerxTestnet + +# Variable: dreyerxTestnet + +> `const` **dreyerxTestnet**: `Common` + +Creates a common configuration for the dreyerxTestnet chain. + +## Description + +Chain ID: 23452 +Chain Name: DreyerX Testnet +Default Block Explorer: https://testnet-scan.dreyerx.com +Default RPC URL: http://testnet-rpc.dreyerx.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { dreyerxTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: dreyerxTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/dreyerxTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/edgeless.md b/tevm/docs/common/variables/edgeless.md new file mode 100644 index 0000000000..cbed0120c4 --- /dev/null +++ b/tevm/docs/common/variables/edgeless.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / edgeless + +# Variable: edgeless + +> `const` **edgeless**: `Common` + +Creates a common configuration for the edgeless chain. + +## Description + +Chain ID: 2026 +Chain Name: Edgeless Network +Default Block Explorer: https://explorer.edgeless.network +Default RPC URL: https://rpc.edgeless.network/http + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { edgeless } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: edgeless, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/edgeless.d.ts:21 diff --git a/tevm/docs/common/variables/edgelessTestnet.md b/tevm/docs/common/variables/edgelessTestnet.md new file mode 100644 index 0000000000..f15bc3de89 --- /dev/null +++ b/tevm/docs/common/variables/edgelessTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / edgelessTestnet + +# Variable: edgelessTestnet + +> `const` **edgelessTestnet**: `Common` + +Creates a common configuration for the edgelessTestnet chain. + +## Description + +Chain ID: 202 +Chain Name: Edgeless Testnet +Default Block Explorer: https://testnet.explorer.edgeless.network +Default RPC URL: https://edgeless-testnet.rpc.caldera.xyz/http + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { edgelessTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: edgelessTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/edgelessTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/edgeware.md b/tevm/docs/common/variables/edgeware.md new file mode 100644 index 0000000000..1dafcb471d --- /dev/null +++ b/tevm/docs/common/variables/edgeware.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / edgeware + +# Variable: edgeware + +> `const` **edgeware**: `Common` + +Creates a common configuration for the edgeware chain. + +## Description + +Chain ID: 2021 +Chain Name: Edgeware EdgeEVM Mainnet +Default Block Explorer: https://edgscan.live +Default RPC URL: https://edgeware-evm.jelliedowl.net + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { edgeware } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: edgeware, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/edgeware.d.ts:21 diff --git a/tevm/docs/common/variables/edgewareTestnet.md b/tevm/docs/common/variables/edgewareTestnet.md new file mode 100644 index 0000000000..7578bb6ab3 --- /dev/null +++ b/tevm/docs/common/variables/edgewareTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / edgewareTestnet + +# Variable: edgewareTestnet + +> `const` **edgewareTestnet**: `Common` + +Creates a common configuration for the edgewareTestnet chain. + +## Description + +Chain ID: 2022 +Chain Name: Beresheet BereEVM Testnet +Default Block Explorer: https://testnet.edgscan.live +Default RPC URL: https://beresheet-evm.jelliedowl.net + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { edgewareTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: edgewareTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/edgewareTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/ekta.md b/tevm/docs/common/variables/ekta.md new file mode 100644 index 0000000000..e2a6b0a910 --- /dev/null +++ b/tevm/docs/common/variables/ekta.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / ekta + +# Variable: ekta + +> `const` **ekta**: `Common` + +Creates a common configuration for the ekta chain. + +## Description + +Chain ID: 1994 +Chain Name: Ekta +Default Block Explorer: https://ektascan.io +Default RPC URL: https://main.ekta.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { ekta } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: ekta, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/ekta.d.ts:21 diff --git a/tevm/docs/common/variables/ektaTestnet.md b/tevm/docs/common/variables/ektaTestnet.md new file mode 100644 index 0000000000..6bec797a2e --- /dev/null +++ b/tevm/docs/common/variables/ektaTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / ektaTestnet + +# Variable: ektaTestnet + +> `const` **ektaTestnet**: `Common` + +Creates a common configuration for the ektaTestnet chain. + +## Description + +Chain ID: 1004 +Chain Name: Ekta Testnet +Default Block Explorer: https://test.ektascan.io +Default RPC URL: https://test.ekta.io:8545 + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { ektaTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: ektaTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/ektaTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/eon.md b/tevm/docs/common/variables/eon.md new file mode 100644 index 0000000000..92e66d861c --- /dev/null +++ b/tevm/docs/common/variables/eon.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / eon + +# Variable: eon + +> `const` **eon**: `Common` + +Creates a common configuration for the eon chain. + +## Description + +Chain ID: 7332 +Chain Name: Horizen EON +Default Block Explorer: https://eon-explorer.horizenlabs.io +Default RPC URL: https://eon-rpc.horizenlabs.io/ethv1 + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { eon } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: eon, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/eon.d.ts:21 diff --git a/tevm/docs/common/variables/eos.md b/tevm/docs/common/variables/eos.md new file mode 100644 index 0000000000..9fad0bc2d6 --- /dev/null +++ b/tevm/docs/common/variables/eos.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / eos + +# Variable: eos + +> `const` **eos**: `Common` + +Creates a common configuration for the eos chain. + +## Description + +Chain ID: 17777 +Chain Name: EOS EVM +Default Block Explorer: https://explorer.evm.eosnetwork.com +Default RPC URL: https://api.evm.eosnetwork.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { eos } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: eos, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/eos.d.ts:21 diff --git a/tevm/docs/common/variables/eosTestnet.md b/tevm/docs/common/variables/eosTestnet.md new file mode 100644 index 0000000000..34adf2d604 --- /dev/null +++ b/tevm/docs/common/variables/eosTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / eosTestnet + +# Variable: eosTestnet + +> `const` **eosTestnet**: `Common` + +Creates a common configuration for the eosTestnet chain. + +## Description + +Chain ID: 15557 +Chain Name: EOS EVM Testnet +Default Block Explorer: https://explorer.testnet.evm.eosnetwork.com +Default RPC URL: https://api.testnet.evm.eosnetwork.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { eosTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: eosTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/eosTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/etherlink.md b/tevm/docs/common/variables/etherlink.md new file mode 100644 index 0000000000..a1c8760c0a --- /dev/null +++ b/tevm/docs/common/variables/etherlink.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / etherlink + +# Variable: etherlink + +> `const` **etherlink**: `Common` + +Creates a common configuration for the etherlink chain. + +## Description + +Chain ID: 42793 +Chain Name: Etherlink +Default Block Explorer: https://explorer.etherlink.com +Default RPC URL: https://node.mainnet.etherlink.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { etherlink } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: etherlink, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/etherlink.d.ts:21 diff --git a/tevm/docs/common/variables/etherlinkTestnet.md b/tevm/docs/common/variables/etherlinkTestnet.md new file mode 100644 index 0000000000..3081ec7c14 --- /dev/null +++ b/tevm/docs/common/variables/etherlinkTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / etherlinkTestnet + +# Variable: etherlinkTestnet + +> `const` **etherlinkTestnet**: `Common` + +Creates a common configuration for the etherlinkTestnet chain. + +## Description + +Chain ID: 128123 +Chain Name: Etherlink Testnet +Default Block Explorer: https://testnet-explorer.etherlink.com +Default RPC URL: https://node.ghostnet.etherlink.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { etherlinkTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: etherlinkTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/etherlinkTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/evmos.md b/tevm/docs/common/variables/evmos.md new file mode 100644 index 0000000000..f0131da0e4 --- /dev/null +++ b/tevm/docs/common/variables/evmos.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / evmos + +# Variable: evmos + +> `const` **evmos**: `Common` + +Creates a common configuration for the evmos chain. + +## Description + +Chain ID: 9001 +Chain Name: Evmos +Default Block Explorer: https://escan.live +Default RPC URL: https://eth.bd.evmos.org:8545 + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { evmos } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: evmos, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/evmos.d.ts:21 diff --git a/tevm/docs/common/variables/evmosTestnet.md b/tevm/docs/common/variables/evmosTestnet.md new file mode 100644 index 0000000000..386e390b5d --- /dev/null +++ b/tevm/docs/common/variables/evmosTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / evmosTestnet + +# Variable: evmosTestnet + +> `const` **evmosTestnet**: `Common` + +Creates a common configuration for the evmosTestnet chain. + +## Description + +Chain ID: 9000 +Chain Name: Evmos Testnet +Default Block Explorer: https://evm.evmos.dev/ +Default RPC URL: https://eth.bd.evmos.dev:8545 + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { evmosTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: evmosTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/evmosTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/fantom.md b/tevm/docs/common/variables/fantom.md new file mode 100644 index 0000000000..4573da13c0 --- /dev/null +++ b/tevm/docs/common/variables/fantom.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / fantom + +# Variable: fantom + +> `const` **fantom**: `Common` + +Creates a common configuration for the fantom chain. + +## Description + +Chain ID: 250 +Chain Name: Fantom +Default Block Explorer: https://ftmscan.com +Default RPC URL: https://rpc.ankr.com/fantom + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { fantom } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: fantom, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/fantom.d.ts:21 diff --git a/tevm/docs/common/variables/fantomSonicTestnet.md b/tevm/docs/common/variables/fantomSonicTestnet.md new file mode 100644 index 0000000000..f3a806df4d --- /dev/null +++ b/tevm/docs/common/variables/fantomSonicTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / fantomSonicTestnet + +# Variable: fantomSonicTestnet + +> `const` **fantomSonicTestnet**: `Common` + +Creates a common configuration for the fantomSonicTestnet chain. + +## Description + +Chain ID: 64240 +Chain Name: Fantom Sonic Open Testnet +Default Block Explorer: https://public-sonic.fantom.network +Default RPC URL: https://rpcapi.sonic.fantom.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { fantomSonicTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: fantomSonicTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/fantomSonicTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/fantomTestnet.md b/tevm/docs/common/variables/fantomTestnet.md new file mode 100644 index 0000000000..0639d8188a --- /dev/null +++ b/tevm/docs/common/variables/fantomTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / fantomTestnet + +# Variable: fantomTestnet + +> `const` **fantomTestnet**: `Common` + +Creates a common configuration for the fantomTestnet chain. + +## Description + +Chain ID: 4002 +Chain Name: Fantom Testnet +Default Block Explorer: https://testnet.ftmscan.com +Default RPC URL: https://rpc.testnet.fantom.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { fantomTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: fantomTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/fantomTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/fibo.md b/tevm/docs/common/variables/fibo.md new file mode 100644 index 0000000000..bb27e7da79 --- /dev/null +++ b/tevm/docs/common/variables/fibo.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / fibo + +# Variable: fibo + +> `const` **fibo**: `Common` + +Creates a common configuration for the fibo chain. + +## Description + +Chain ID: 12306 +Chain Name: Fibo Chain +Default Block Explorer: https://scan.fibochain.org +Default RPC URL: https://network.hzroc.art + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { fibo } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: fibo, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/fibo.d.ts:21 diff --git a/tevm/docs/common/variables/filecoin.md b/tevm/docs/common/variables/filecoin.md new file mode 100644 index 0000000000..7396b93e4a --- /dev/null +++ b/tevm/docs/common/variables/filecoin.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / filecoin + +# Variable: filecoin + +> `const` **filecoin**: `Common` + +Creates a common configuration for the filecoin chain. + +## Description + +Chain ID: 314 +Chain Name: Filecoin Mainnet +Default Block Explorer: https://filfox.info/en +Default RPC URL: https://api.node.glif.io/rpc/v1 + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { filecoin } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: filecoin, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/filecoin.d.ts:21 diff --git a/tevm/docs/common/variables/filecoinCalibration.md b/tevm/docs/common/variables/filecoinCalibration.md new file mode 100644 index 0000000000..fff6510345 --- /dev/null +++ b/tevm/docs/common/variables/filecoinCalibration.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / filecoinCalibration + +# Variable: filecoinCalibration + +> `const` **filecoinCalibration**: `Common` + +Creates a common configuration for the filecoinCalibration chain. + +## Description + +Chain ID: 314159 +Chain Name: Filecoin Calibration +Default Block Explorer: https://calibration.filscan.io +Default RPC URL: https://api.calibration.node.glif.io/rpc/v1 + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { filecoinCalibration } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: filecoinCalibration, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/filecoinCalibration.d.ts:21 diff --git a/tevm/docs/common/variables/filecoinHyperspace.md b/tevm/docs/common/variables/filecoinHyperspace.md new file mode 100644 index 0000000000..b03b4a8d1a --- /dev/null +++ b/tevm/docs/common/variables/filecoinHyperspace.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / filecoinHyperspace + +# Variable: filecoinHyperspace + +> `const` **filecoinHyperspace**: `Common` + +Creates a common configuration for the filecoinHyperspace chain. + +## Description + +Chain ID: 3141 +Chain Name: Filecoin Hyperspace +Default Block Explorer: https://hyperspace.filfox.info/en +Default RPC URL: https://api.hyperspace.node.glif.io/rpc/v1 + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { filecoinHyperspace } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: filecoinHyperspace, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/filecoinHyperspace.d.ts:21 diff --git a/tevm/docs/common/variables/flare.md b/tevm/docs/common/variables/flare.md new file mode 100644 index 0000000000..559e7dd8ca --- /dev/null +++ b/tevm/docs/common/variables/flare.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / flare + +# Variable: flare + +> `const` **flare**: `Common` + +Creates a common configuration for the flare chain. + +## Description + +Chain ID: 14 +Chain Name: Flare Mainnet +Default Block Explorer: https://flare-explorer.flare.network +Default RPC URL: https://flare-api.flare.network/ext/C/rpc + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { flare } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: flare, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/flare.d.ts:21 diff --git a/tevm/docs/common/variables/flareTestnet.md b/tevm/docs/common/variables/flareTestnet.md new file mode 100644 index 0000000000..3bd0515b12 --- /dev/null +++ b/tevm/docs/common/variables/flareTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / flareTestnet + +# Variable: flareTestnet + +> `const` **flareTestnet**: `Common` + +Creates a common configuration for the flareTestnet chain. + +## Description + +Chain ID: 114 +Chain Name: Coston2 +Default Block Explorer: https://coston2-explorer.flare.network +Default RPC URL: https://coston2-api.flare.network/ext/C/rpc + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { flareTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: flareTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/flareTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/flowMainnet.md b/tevm/docs/common/variables/flowMainnet.md new file mode 100644 index 0000000000..fd2c321ac5 --- /dev/null +++ b/tevm/docs/common/variables/flowMainnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / flowMainnet + +# Variable: flowMainnet + +> `const` **flowMainnet**: `Common` + +Creates a common configuration for the flowMainnet chain. + +## Description + +Chain ID: 747 +Chain Name: FlowEVM Mainnet +Default Block Explorer: https://flowdiver.io +Default RPC URL: https://mainnet.evm.nodes.onflow.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { flowMainnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: flowMainnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/flowMainnet.d.ts:21 diff --git a/tevm/docs/common/variables/flowPreviewnet.md b/tevm/docs/common/variables/flowPreviewnet.md new file mode 100644 index 0000000000..817ecb8a14 --- /dev/null +++ b/tevm/docs/common/variables/flowPreviewnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / flowPreviewnet + +# Variable: flowPreviewnet + +> `const` **flowPreviewnet**: `Common` + +Creates a common configuration for the flowPreviewnet chain. + +## Description + +Chain ID: 646 +Chain Name: FlowEVM Previewnet +Default Block Explorer: https://previewnet.flowdiver.io +Default RPC URL: https://previewnet.evm.nodes.onflow.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { flowPreviewnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: flowPreviewnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/flowPreviewnet.d.ts:21 diff --git a/tevm/docs/common/variables/flowTestnet.md b/tevm/docs/common/variables/flowTestnet.md new file mode 100644 index 0000000000..7752a10c98 --- /dev/null +++ b/tevm/docs/common/variables/flowTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / flowTestnet + +# Variable: flowTestnet + +> `const` **flowTestnet**: `Common` + +Creates a common configuration for the flowTestnet chain. + +## Description + +Chain ID: 545 +Chain Name: FlowEVM Testnet +Default Block Explorer: https://testnet.flowdiver.io +Default RPC URL: https://testnet.evm.nodes.onflow.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { flowTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: flowTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/flowTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/fluence.md b/tevm/docs/common/variables/fluence.md new file mode 100644 index 0000000000..cc147b8f3e --- /dev/null +++ b/tevm/docs/common/variables/fluence.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / fluence + +# Variable: fluence + +> `const` **fluence**: `Common` + +Creates a common configuration for the fluence chain. + +## Description + +Chain ID: 9999999 +Chain Name: Fluence +Default Block Explorer: https://blockscout.mainnet.fluence.dev +Default RPC URL: https://rpc.mainnet.fluence.dev + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { fluence } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: fluence, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/fluence.d.ts:21 diff --git a/tevm/docs/common/variables/fluenceStage.md b/tevm/docs/common/variables/fluenceStage.md new file mode 100644 index 0000000000..f50e9e1985 --- /dev/null +++ b/tevm/docs/common/variables/fluenceStage.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / fluenceStage + +# Variable: fluenceStage + +> `const` **fluenceStage**: `Common` + +Creates a common configuration for the fluenceStage chain. + +## Description + +Chain ID: 123420000220 +Chain Name: Fluence Stage +Default Block Explorer: https://blockscout.stage.fluence.dev +Default RPC URL: https://rpc.stage.fluence.dev + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { fluenceStage } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: fluenceStage, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/fluenceStage.d.ts:21 diff --git a/tevm/docs/common/variables/fluenceTestnet.md b/tevm/docs/common/variables/fluenceTestnet.md new file mode 100644 index 0000000000..b31107c398 --- /dev/null +++ b/tevm/docs/common/variables/fluenceTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / fluenceTestnet + +# Variable: fluenceTestnet + +> `const` **fluenceTestnet**: `Common` + +Creates a common configuration for the fluenceTestnet chain. + +## Description + +Chain ID: 52164803 +Chain Name: Fluence Testnet +Default Block Explorer: https://blockscout.testnet.fluence.dev +Default RPC URL: https://rpc.testnet.fluence.dev + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { fluenceTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: fluenceTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/fluenceTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/forma.md b/tevm/docs/common/variables/forma.md new file mode 100644 index 0000000000..471067348c --- /dev/null +++ b/tevm/docs/common/variables/forma.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / forma + +# Variable: forma + +> `const` **forma**: `Common` + +Creates a common configuration for the forma chain. + +## Description + +Chain ID: 984122 +Chain Name: Forma +Default Block Explorer: https://explorer.forma.art +Default RPC URL: https://rpc.forma.art + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { forma } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: forma, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/forma.d.ts:21 diff --git a/tevm/docs/common/variables/foundry.md b/tevm/docs/common/variables/foundry.md new file mode 100644 index 0000000000..3c9fa200e8 --- /dev/null +++ b/tevm/docs/common/variables/foundry.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / foundry + +# Variable: foundry + +> `const` **foundry**: `Common` + +Creates a common configuration for the foundry chain. + +## Description + +Chain ID: 31337 +Chain Name: Foundry +Default Block Explorer: Not specified +Default RPC URL: http://127.0.0.1:8545 + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { foundry } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: foundry, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/foundry.d.ts:21 diff --git a/tevm/docs/common/variables/fraxtal.md b/tevm/docs/common/variables/fraxtal.md new file mode 100644 index 0000000000..66393e218c --- /dev/null +++ b/tevm/docs/common/variables/fraxtal.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / fraxtal + +# Variable: fraxtal + +> `const` **fraxtal**: `Common` + +Creates a common configuration for the fraxtal chain. + +## Description + +Chain ID: 252 +Chain Name: Fraxtal +Default Block Explorer: https://fraxscan.com +Default RPC URL: https://rpc.frax.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { fraxtal } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: fraxtal, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/fraxtal.d.ts:21 diff --git a/tevm/docs/common/variables/fraxtalTestnet.md b/tevm/docs/common/variables/fraxtalTestnet.md new file mode 100644 index 0000000000..40e16020d0 --- /dev/null +++ b/tevm/docs/common/variables/fraxtalTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / fraxtalTestnet + +# Variable: fraxtalTestnet + +> `const` **fraxtalTestnet**: `Common` + +Creates a common configuration for the fraxtalTestnet chain. + +## Description + +Chain ID: 2522 +Chain Name: Fraxtal Testnet +Default Block Explorer: https://holesky.fraxscan.com +Default RPC URL: https://rpc.testnet.frax.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { fraxtalTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: fraxtalTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/fraxtalTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/funkiMainnet.md b/tevm/docs/common/variables/funkiMainnet.md new file mode 100644 index 0000000000..2a012935b8 --- /dev/null +++ b/tevm/docs/common/variables/funkiMainnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / funkiMainnet + +# Variable: funkiMainnet + +> `const` **funkiMainnet**: `Common` + +Creates a common configuration for the funkiMainnet chain. + +## Description + +Chain ID: 33979 +Chain Name: Funki +Default Block Explorer: https://funkiscan.io +Default RPC URL: https://rpc-mainnet.funkichain.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { funkiMainnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: funkiMainnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/funkiMainnet.d.ts:21 diff --git a/tevm/docs/common/variables/funkiSepolia.md b/tevm/docs/common/variables/funkiSepolia.md new file mode 100644 index 0000000000..b4b75fac0d --- /dev/null +++ b/tevm/docs/common/variables/funkiSepolia.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / funkiSepolia + +# Variable: funkiSepolia + +> `const` **funkiSepolia**: `Common` + +Creates a common configuration for the funkiSepolia chain. + +## Description + +Chain ID: 3397901 +Chain Name: Funki Sepolia Sandbox +Default Block Explorer: https://sepolia-sandbox.funkichain.com/ +Default RPC URL: https://funki-testnet.alt.technology + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { funkiSepolia } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: funkiSepolia, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/funkiSepolia.d.ts:21 diff --git a/tevm/docs/common/variables/fuse.md b/tevm/docs/common/variables/fuse.md new file mode 100644 index 0000000000..d6eb51e12d --- /dev/null +++ b/tevm/docs/common/variables/fuse.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / fuse + +# Variable: fuse + +> `const` **fuse**: `Common` + +Creates a common configuration for the fuse chain. + +## Description + +Chain ID: 122 +Chain Name: Fuse +Default Block Explorer: https://explorer.fuse.io +Default RPC URL: https://rpc.fuse.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { fuse } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: fuse, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/fuse.d.ts:21 diff --git a/tevm/docs/common/variables/fuseSparknet.md b/tevm/docs/common/variables/fuseSparknet.md new file mode 100644 index 0000000000..480015a9ee --- /dev/null +++ b/tevm/docs/common/variables/fuseSparknet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / fuseSparknet + +# Variable: fuseSparknet + +> `const` **fuseSparknet**: `Common` + +Creates a common configuration for the fuseSparknet chain. + +## Description + +Chain ID: 123 +Chain Name: Fuse Sparknet +Default Block Explorer: https://explorer.fusespark.io +Default RPC URL: https://rpc.fusespark.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { fuseSparknet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: fuseSparknet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/fuseSparknet.d.ts:21 diff --git a/tevm/docs/common/variables/gnosis.md b/tevm/docs/common/variables/gnosis.md new file mode 100644 index 0000000000..5bc9152e59 --- /dev/null +++ b/tevm/docs/common/variables/gnosis.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / gnosis + +# Variable: gnosis + +> `const` **gnosis**: `Common` + +Creates a common configuration for the gnosis chain. + +## Description + +Chain ID: 100 +Chain Name: Gnosis +Default Block Explorer: https://gnosisscan.io +Default RPC URL: https://rpc.gnosischain.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { gnosis } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: gnosis, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/gnosis.d.ts:21 diff --git a/tevm/docs/common/variables/gnosisChiado.md b/tevm/docs/common/variables/gnosisChiado.md new file mode 100644 index 0000000000..e0aa1b2c05 --- /dev/null +++ b/tevm/docs/common/variables/gnosisChiado.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / gnosisChiado + +# Variable: gnosisChiado + +> `const` **gnosisChiado**: `Common` + +Creates a common configuration for the gnosisChiado chain. + +## Description + +Chain ID: 10200 +Chain Name: Gnosis Chiado +Default Block Explorer: https://blockscout.chiadochain.net +Default RPC URL: https://rpc.chiadochain.net + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { gnosisChiado } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: gnosisChiado, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/gnosisChiado.d.ts:21 diff --git a/tevm/docs/common/variables/gobi.md b/tevm/docs/common/variables/gobi.md new file mode 100644 index 0000000000..1aa8216b60 --- /dev/null +++ b/tevm/docs/common/variables/gobi.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / gobi + +# Variable: gobi + +> `const` **gobi**: `Common` + +Creates a common configuration for the gobi chain. + +## Description + +Chain ID: 1663 +Chain Name: Horizen Gobi Testnet +Default Block Explorer: https://gobi-explorer.horizen.io +Default RPC URL: https://gobi-testnet.horizenlabs.io/ethv1 + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { gobi } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: gobi, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/gobi.d.ts:21 diff --git a/tevm/docs/common/variables/goerli.md b/tevm/docs/common/variables/goerli.md new file mode 100644 index 0000000000..67071de13f --- /dev/null +++ b/tevm/docs/common/variables/goerli.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / goerli + +# Variable: goerli + +> `const` **goerli**: `Common` + +Creates a common configuration for the goerli chain. + +## Description + +Chain ID: 5 +Chain Name: Goerli +Default Block Explorer: https://goerli.etherscan.io +Default RPC URL: https://rpc.ankr.com/eth_goerli + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { goerli } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: goerli, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/goerli.d.ts:21 diff --git a/tevm/docs/common/variables/gravity.md b/tevm/docs/common/variables/gravity.md new file mode 100644 index 0000000000..8a334ec8c3 --- /dev/null +++ b/tevm/docs/common/variables/gravity.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / gravity + +# Variable: gravity + +> `const` **gravity**: `Common` + +Creates a common configuration for the gravity chain. + +## Description + +Chain ID: 1625 +Chain Name: Gravity Alpha Mainnet +Default Block Explorer: https://explorer.gravity.xyz +Default RPC URL: https://rpc.gravity.xyz + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { gravity } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: gravity, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/gravity.d.ts:21 diff --git a/tevm/docs/common/variables/ham.md b/tevm/docs/common/variables/ham.md new file mode 100644 index 0000000000..444c3c8482 --- /dev/null +++ b/tevm/docs/common/variables/ham.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / ham + +# Variable: ham + +> `const` **ham**: `Common` + +Creates a common configuration for the ham chain. + +## Description + +Chain ID: 5112 +Chain Name: Ham +Default Block Explorer: https://explorer.ham.fun +Default RPC URL: https://rpc.ham.fun + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { ham } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: ham, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/ham.d.ts:21 diff --git a/tevm/docs/common/variables/haqqMainnet.md b/tevm/docs/common/variables/haqqMainnet.md new file mode 100644 index 0000000000..24ba25f3b2 --- /dev/null +++ b/tevm/docs/common/variables/haqqMainnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / haqqMainnet + +# Variable: haqqMainnet + +> `const` **haqqMainnet**: `Common` + +Creates a common configuration for the haqqMainnet chain. + +## Description + +Chain ID: 11235 +Chain Name: HAQQ Mainnet +Default Block Explorer: https://explorer.haqq.network +Default RPC URL: https://rpc.eth.haqq.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { haqqMainnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: haqqMainnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/haqqMainnet.d.ts:21 diff --git a/tevm/docs/common/variables/haqqTestedge2.md b/tevm/docs/common/variables/haqqTestedge2.md new file mode 100644 index 0000000000..98ba6e5752 --- /dev/null +++ b/tevm/docs/common/variables/haqqTestedge2.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / haqqTestedge2 + +# Variable: haqqTestedge2 + +> `const` **haqqTestedge2**: `Common` + +Creates a common configuration for the haqqTestedge2 chain. + +## Description + +Chain ID: 54211 +Chain Name: HAQQ Testedge 2 +Default Block Explorer: https://explorer.testedge2.haqq.network +Default RPC URL: https://rpc.eth.testedge2.haqq.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { haqqTestedge2 } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: haqqTestedge2, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/haqqTestedge2.d.ts:21 diff --git a/tevm/docs/common/variables/hardhat.md b/tevm/docs/common/variables/hardhat.md new file mode 100644 index 0000000000..2a1a9ccb5d --- /dev/null +++ b/tevm/docs/common/variables/hardhat.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / hardhat + +# Variable: hardhat + +> `const` **hardhat**: `Common` + +Creates a common configuration for the hardhat chain. + +## Description + +Chain ID: 31337 +Chain Name: Hardhat +Default Block Explorer: Not specified +Default RPC URL: http://127.0.0.1:8545 + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { hardhat } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: hardhat, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/hardhat.d.ts:21 diff --git a/tevm/docs/common/variables/harmonyOne.md b/tevm/docs/common/variables/harmonyOne.md new file mode 100644 index 0000000000..dcea2eb9f0 --- /dev/null +++ b/tevm/docs/common/variables/harmonyOne.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / harmonyOne + +# Variable: harmonyOne + +> `const` **harmonyOne**: `Common` + +Creates a common configuration for the harmonyOne chain. + +## Description + +Chain ID: 1666600000 +Chain Name: Harmony One +Default Block Explorer: https://explorer.harmony.one +Default RPC URL: https://rpc.ankr.com/harmony + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { harmonyOne } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: harmonyOne, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/harmonyOne.d.ts:21 diff --git a/tevm/docs/common/variables/hashkeyTestnet.md b/tevm/docs/common/variables/hashkeyTestnet.md new file mode 100644 index 0000000000..5d06792a6c --- /dev/null +++ b/tevm/docs/common/variables/hashkeyTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / hashkeyTestnet + +# Variable: hashkeyTestnet + +> `const` **hashkeyTestnet**: `Common` + +Creates a common configuration for the hashkeyTestnet chain. + +## Description + +Chain ID: 133 +Chain Name: HashKey Chain Testnet +Default Block Explorer: https://hashkeychain-testnet-explorer.alt.technology +Default RPC URL: https://hashkeychain-testnet.alt.technology + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { hashkeyTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: hashkeyTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/hashkeyTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/hedera.md b/tevm/docs/common/variables/hedera.md new file mode 100644 index 0000000000..d938871ca6 --- /dev/null +++ b/tevm/docs/common/variables/hedera.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / hedera + +# Variable: hedera + +> `const` **hedera**: `Common` + +Creates a common configuration for the hedera chain. + +## Description + +Chain ID: 295 +Chain Name: Hedera Mainnet +Default Block Explorer: https://hashscan.io/mainnet +Default RPC URL: https://mainnet.hashio.io/api + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { hedera } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: hedera, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/hedera.d.ts:21 diff --git a/tevm/docs/common/variables/hederaPreviewnet.md b/tevm/docs/common/variables/hederaPreviewnet.md new file mode 100644 index 0000000000..a1de4c7496 --- /dev/null +++ b/tevm/docs/common/variables/hederaPreviewnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / hederaPreviewnet + +# Variable: hederaPreviewnet + +> `const` **hederaPreviewnet**: `Common` + +Creates a common configuration for the hederaPreviewnet chain. + +## Description + +Chain ID: 297 +Chain Name: Hedera Previewnet +Default Block Explorer: https://hashscan.io/previewnet +Default RPC URL: https://previewnet.hashio.io/api + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { hederaPreviewnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: hederaPreviewnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/hederaPreviewnet.d.ts:21 diff --git a/tevm/docs/common/variables/hederaTestnet.md b/tevm/docs/common/variables/hederaTestnet.md new file mode 100644 index 0000000000..cf05a39dd0 --- /dev/null +++ b/tevm/docs/common/variables/hederaTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / hederaTestnet + +# Variable: hederaTestnet + +> `const` **hederaTestnet**: `Common` + +Creates a common configuration for the hederaTestnet chain. + +## Description + +Chain ID: 296 +Chain Name: Hedera Testnet +Default Block Explorer: https://hashscan.io/testnet +Default RPC URL: https://testnet.hashio.io/api + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { hederaTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: hederaTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/hederaTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/holesky.md b/tevm/docs/common/variables/holesky.md new file mode 100644 index 0000000000..50629ae6ac --- /dev/null +++ b/tevm/docs/common/variables/holesky.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / holesky + +# Variable: holesky + +> `const` **holesky**: `Common` + +Creates a common configuration for the holesky chain. + +## Description + +Chain ID: 17000 +Chain Name: Holesky +Default Block Explorer: https://holesky.etherscan.io +Default RPC URL: https://ethereum-holesky-rpc.publicnode.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { holesky } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: holesky, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/holesky.d.ts:21 diff --git a/tevm/docs/common/variables/immutableZkEvm.md b/tevm/docs/common/variables/immutableZkEvm.md new file mode 100644 index 0000000000..61078eba26 --- /dev/null +++ b/tevm/docs/common/variables/immutableZkEvm.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / immutableZkEvm + +# Variable: immutableZkEvm + +> `const` **immutableZkEvm**: `Common` + +Creates a common configuration for the immutableZkEvm chain. + +## Description + +Chain ID: 13371 +Chain Name: Immutable zkEVM +Default Block Explorer: https://explorer.immutable.com +Default RPC URL: https://rpc.immutable.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { immutableZkEvm } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: immutableZkEvm, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/immutableZkEvm.d.ts:21 diff --git a/tevm/docs/common/variables/immutableZkEvmTestnet.md b/tevm/docs/common/variables/immutableZkEvmTestnet.md new file mode 100644 index 0000000000..905607a267 --- /dev/null +++ b/tevm/docs/common/variables/immutableZkEvmTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / immutableZkEvmTestnet + +# Variable: immutableZkEvmTestnet + +> `const` **immutableZkEvmTestnet**: `Common` + +Creates a common configuration for the immutableZkEvmTestnet chain. + +## Description + +Chain ID: 13473 +Chain Name: Immutable zkEVM Testnet +Default Block Explorer: https://explorer.testnet.immutable.com/ +Default RPC URL: https://rpc.testnet.immutable.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { immutableZkEvmTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: immutableZkEvmTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/immutableZkEvmTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/inEVM.md b/tevm/docs/common/variables/inEVM.md new file mode 100644 index 0000000000..f1243dbcb7 --- /dev/null +++ b/tevm/docs/common/variables/inEVM.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / inEVM + +# Variable: inEVM + +> `const` **inEVM**: `Common` + +Creates a common configuration for the inEVM chain. + +## Description + +Chain ID: 2525 +Chain Name: inEVM Mainnet +Default Block Explorer: https://inevm.calderaexplorer.xyz +Default RPC URL: https://mainnet.rpc.inevm.com/http + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { inEVM } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: inEVM, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/inEVM.d.ts:21 diff --git a/tevm/docs/common/variables/iota.md b/tevm/docs/common/variables/iota.md new file mode 100644 index 0000000000..94d5c162b6 --- /dev/null +++ b/tevm/docs/common/variables/iota.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / iota + +# Variable: iota + +> `const` **iota**: `Common` + +Creates a common configuration for the iota chain. + +## Description + +Chain ID: 8822 +Chain Name: IOTA EVM +Default Block Explorer: https://explorer.evm.iota.org +Default RPC URL: https://json-rpc.evm.iotaledger.net + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { iota } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: iota, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/iota.d.ts:21 diff --git a/tevm/docs/common/variables/iotaTestnet.md b/tevm/docs/common/variables/iotaTestnet.md new file mode 100644 index 0000000000..3a94ed7a12 --- /dev/null +++ b/tevm/docs/common/variables/iotaTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / iotaTestnet + +# Variable: iotaTestnet + +> `const` **iotaTestnet**: `Common` + +Creates a common configuration for the iotaTestnet chain. + +## Description + +Chain ID: 1075 +Chain Name: IOTA EVM Testnet +Default Block Explorer: https://explorer.evm.testnet.iotaledger.net +Default RPC URL: https://json-rpc.evm.testnet.iotaledger.net + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { iotaTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: iotaTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/iotaTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/iotex.md b/tevm/docs/common/variables/iotex.md new file mode 100644 index 0000000000..1d9f16fcf4 --- /dev/null +++ b/tevm/docs/common/variables/iotex.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / iotex + +# Variable: iotex + +> `const` **iotex**: `Common` + +Creates a common configuration for the iotex chain. + +## Description + +Chain ID: 4689 +Chain Name: IoTeX +Default Block Explorer: https://iotexscan.io +Default RPC URL: https://babel-api.mainnet.iotex.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { iotex } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: iotex, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/iotex.d.ts:21 diff --git a/tevm/docs/common/variables/iotexTestnet.md b/tevm/docs/common/variables/iotexTestnet.md new file mode 100644 index 0000000000..c1b5a45583 --- /dev/null +++ b/tevm/docs/common/variables/iotexTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / iotexTestnet + +# Variable: iotexTestnet + +> `const` **iotexTestnet**: `Common` + +Creates a common configuration for the iotexTestnet chain. + +## Description + +Chain ID: 4690 +Chain Name: IoTeX Testnet +Default Block Explorer: https://testnet.iotexscan.io +Default RPC URL: https://babel-api.testnet.iotex.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { iotexTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: iotexTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/iotexTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/jbc.md b/tevm/docs/common/variables/jbc.md new file mode 100644 index 0000000000..d7585c8ed8 --- /dev/null +++ b/tevm/docs/common/variables/jbc.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / jbc + +# Variable: jbc + +> `const` **jbc**: `Common` + +Creates a common configuration for the jbc chain. + +## Description + +Chain ID: 8899 +Chain Name: JIBCHAIN L1 +Default Block Explorer: https://exp-l1.jibchain.net +Default RPC URL: https://rpc-l1.jibchain.net + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { jbc } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: jbc, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/jbc.d.ts:21 diff --git a/tevm/docs/common/variables/jbcTestnet.md b/tevm/docs/common/variables/jbcTestnet.md new file mode 100644 index 0000000000..e50caff5c8 --- /dev/null +++ b/tevm/docs/common/variables/jbcTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / jbcTestnet + +# Variable: jbcTestnet + +> `const` **jbcTestnet**: `Common` + +Creates a common configuration for the jbcTestnet chain. + +## Description + +Chain ID: 88991 +Chain Name: Jibchain Testnet +Default Block Explorer: https://exp.testnet.jibchain.net +Default RPC URL: https://rpc.testnet.jibchain.net + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { jbcTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: jbcTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/jbcTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/kaia.md b/tevm/docs/common/variables/kaia.md new file mode 100644 index 0000000000..e866569c3a --- /dev/null +++ b/tevm/docs/common/variables/kaia.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / kaia + +# Variable: kaia + +> `const` **kaia**: `Common` + +Creates a common configuration for the kaia chain. + +## Description + +Chain ID: 8217 +Chain Name: Kaia +Default Block Explorer: https://kaiascope.com +Default RPC URL: https://public-en.node.kaia.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { kaia } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: kaia, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/kaia.d.ts:21 diff --git a/tevm/docs/common/variables/kairos.md b/tevm/docs/common/variables/kairos.md new file mode 100644 index 0000000000..cd2cbd3377 --- /dev/null +++ b/tevm/docs/common/variables/kairos.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / kairos + +# Variable: kairos + +> `const` **kairos**: `Common` + +Creates a common configuration for the kairos chain. + +## Description + +Chain ID: 1001 +Chain Name: Kairos Testnet +Default Block Explorer: https://kairos.kaiascope.com +Default RPC URL: https://public-en-kairos.node.kaia.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { kairos } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: kairos, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/kairos.d.ts:21 diff --git a/tevm/docs/common/variables/kakarotSepolia.md b/tevm/docs/common/variables/kakarotSepolia.md new file mode 100644 index 0000000000..d65e317aac --- /dev/null +++ b/tevm/docs/common/variables/kakarotSepolia.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / kakarotSepolia + +# Variable: kakarotSepolia + +> `const` **kakarotSepolia**: `Common` + +Creates a common configuration for the kakarotSepolia chain. + +## Description + +Chain ID: 1802203764 +Chain Name: Kakarot Sepolia +Default Block Explorer: https://sepolia.kakarotscan.org +Default RPC URL: https://sepolia-rpc.kakarot.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { kakarotSepolia } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: kakarotSepolia, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/kakarotSepolia.d.ts:21 diff --git a/tevm/docs/common/variables/karura.md b/tevm/docs/common/variables/karura.md new file mode 100644 index 0000000000..b212eb6d1c --- /dev/null +++ b/tevm/docs/common/variables/karura.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / karura + +# Variable: karura + +> `const` **karura**: `Common` + +Creates a common configuration for the karura chain. + +## Description + +Chain ID: 686 +Chain Name: Karura +Default Block Explorer: https://blockscout.karura.network +Default RPC URL: https://eth-rpc-karura.aca-api.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { karura } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: karura, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/karura.d.ts:21 diff --git a/tevm/docs/common/variables/kava.md b/tevm/docs/common/variables/kava.md new file mode 100644 index 0000000000..eaeae80ee3 --- /dev/null +++ b/tevm/docs/common/variables/kava.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / kava + +# Variable: kava + +> `const` **kava**: `Common` + +Creates a common configuration for the kava chain. + +## Description + +Chain ID: 2222 +Chain Name: Kava EVM +Default Block Explorer: https://kavascan.com +Default RPC URL: https://evm.kava.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { kava } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: kava, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/kava.d.ts:21 diff --git a/tevm/docs/common/variables/kavaTestnet.md b/tevm/docs/common/variables/kavaTestnet.md new file mode 100644 index 0000000000..55f94e80c2 --- /dev/null +++ b/tevm/docs/common/variables/kavaTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / kavaTestnet + +# Variable: kavaTestnet + +> `const` **kavaTestnet**: `Common` + +Creates a common configuration for the kavaTestnet chain. + +## Description + +Chain ID: 2221 +Chain Name: Kava EVM Testnet +Default Block Explorer: https://testnet.kavascan.com/ +Default RPC URL: https://evm.testnet.kava.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { kavaTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: kavaTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/kavaTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/kcc.md b/tevm/docs/common/variables/kcc.md new file mode 100644 index 0000000000..d7de1d21e1 --- /dev/null +++ b/tevm/docs/common/variables/kcc.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / kcc + +# Variable: kcc + +> `const` **kcc**: `Common` + +Creates a common configuration for the kcc chain. + +## Description + +Chain ID: 321 +Chain Name: KCC Mainnet +Default Block Explorer: https://explorer.kcc.io +Default RPC URL: https://kcc-rpc.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { kcc } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: kcc, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/kcc.d.ts:21 diff --git a/tevm/docs/common/variables/klaytn.md b/tevm/docs/common/variables/klaytn.md new file mode 100644 index 0000000000..ee1707c3f2 --- /dev/null +++ b/tevm/docs/common/variables/klaytn.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / klaytn + +# Variable: klaytn + +> `const` **klaytn**: `Common` + +Creates a common configuration for the klaytn chain. + +## Description + +Chain ID: 8217 +Chain Name: Klaytn +Default Block Explorer: https://scope.klaytn.com +Default RPC URL: https://public-en-cypress.klaytn.net + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { klaytn } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: klaytn, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/klaytn.d.ts:21 diff --git a/tevm/docs/common/variables/klaytnBaobab.md b/tevm/docs/common/variables/klaytnBaobab.md new file mode 100644 index 0000000000..b2f6a0040f --- /dev/null +++ b/tevm/docs/common/variables/klaytnBaobab.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / klaytnBaobab + +# Variable: klaytnBaobab + +> `const` **klaytnBaobab**: `Common` + +Creates a common configuration for the klaytnBaobab chain. + +## Description + +Chain ID: 1001 +Chain Name: Klaytn Baobab Testnet +Default Block Explorer: https://baobab.klaytnscope.com +Default RPC URL: https://public-en-baobab.klaytn.net + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { klaytnBaobab } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: klaytnBaobab, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/klaytnBaobab.d.ts:21 diff --git a/tevm/docs/common/variables/koi.md b/tevm/docs/common/variables/koi.md new file mode 100644 index 0000000000..72b6a48668 --- /dev/null +++ b/tevm/docs/common/variables/koi.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / koi + +# Variable: koi + +> `const` **koi**: `Common` + +Creates a common configuration for the koi chain. + +## Description + +Chain ID: 701 +Chain Name: Koi Network +Default Block Explorer: https://koi-scan.darwinia.network +Default RPC URL: https://koi-rpc.darwinia.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { koi } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: koi, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/koi.d.ts:21 diff --git a/tevm/docs/common/variables/kroma.md b/tevm/docs/common/variables/kroma.md new file mode 100644 index 0000000000..2bb2b96e24 --- /dev/null +++ b/tevm/docs/common/variables/kroma.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / kroma + +# Variable: kroma + +> `const` **kroma**: `Common` + +Creates a common configuration for the kroma chain. + +## Description + +Chain ID: 255 +Chain Name: Kroma +Default Block Explorer: https://blockscout.kroma.network +Default RPC URL: https://api.kroma.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { kroma } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: kroma, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/kroma.d.ts:21 diff --git a/tevm/docs/common/variables/kromaSepolia.md b/tevm/docs/common/variables/kromaSepolia.md new file mode 100644 index 0000000000..6be69bf940 --- /dev/null +++ b/tevm/docs/common/variables/kromaSepolia.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / kromaSepolia + +# Variable: kromaSepolia + +> `const` **kromaSepolia**: `Common` + +Creates a common configuration for the kromaSepolia chain. + +## Description + +Chain ID: 2358 +Chain Name: Kroma Sepolia +Default Block Explorer: https://blockscout.sepolia.kroma.network +Default RPC URL: https://api.sepolia.kroma.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { kromaSepolia } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: kromaSepolia, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/kromaSepolia.d.ts:21 diff --git a/tevm/docs/common/variables/l3x.md b/tevm/docs/common/variables/l3x.md new file mode 100644 index 0000000000..9d5ebdf6f8 --- /dev/null +++ b/tevm/docs/common/variables/l3x.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / l3x + +# Variable: l3x + +> `const` **l3x**: `Common` + +Creates a common configuration for the l3x chain. + +## Description + +Chain ID: 12324 +Chain Name: L3X Protocol +Default Block Explorer: https://explorer.l3x.com +Default RPC URL: https://rpc-mainnet.l3x.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { l3x } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: l3x, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/l3x.d.ts:21 diff --git a/tevm/docs/common/variables/l3xTestnet.md b/tevm/docs/common/variables/l3xTestnet.md new file mode 100644 index 0000000000..309d2ea22a --- /dev/null +++ b/tevm/docs/common/variables/l3xTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / l3xTestnet + +# Variable: l3xTestnet + +> `const` **l3xTestnet**: `Common` + +Creates a common configuration for the l3xTestnet chain. + +## Description + +Chain ID: 12325 +Chain Name: L3X Protocol Testnet +Default Block Explorer: https://explorer-testnet.l3x.com +Default RPC URL: https://rpc-testnet.l3x.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { l3xTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: l3xTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/l3xTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/lightlinkPegasus.md b/tevm/docs/common/variables/lightlinkPegasus.md new file mode 100644 index 0000000000..e8e38014a2 --- /dev/null +++ b/tevm/docs/common/variables/lightlinkPegasus.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / lightlinkPegasus + +# Variable: lightlinkPegasus + +> `const` **lightlinkPegasus**: `Common` + +Creates a common configuration for the lightlinkPegasus chain. + +## Description + +Chain ID: 1891 +Chain Name: LightLink Pegasus Testnet +Default Block Explorer: https://pegasus.lightlink.io +Default RPC URL: https://replicator.pegasus.lightlink.io/rpc/v1 + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { lightlinkPegasus } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: lightlinkPegasus, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/lightlinkPegasus.d.ts:21 diff --git a/tevm/docs/common/variables/lightlinkPhoenix.md b/tevm/docs/common/variables/lightlinkPhoenix.md new file mode 100644 index 0000000000..f605831645 --- /dev/null +++ b/tevm/docs/common/variables/lightlinkPhoenix.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / lightlinkPhoenix + +# Variable: lightlinkPhoenix + +> `const` **lightlinkPhoenix**: `Common` + +Creates a common configuration for the lightlinkPhoenix chain. + +## Description + +Chain ID: 1890 +Chain Name: LightLink Phoenix Mainnet +Default Block Explorer: https://phoenix.lightlink.io +Default RPC URL: https://replicator.phoenix.lightlink.io/rpc/v1 + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { lightlinkPhoenix } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: lightlinkPhoenix, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/lightlinkPhoenix.d.ts:21 diff --git a/tevm/docs/common/variables/linea.md b/tevm/docs/common/variables/linea.md new file mode 100644 index 0000000000..3038701693 --- /dev/null +++ b/tevm/docs/common/variables/linea.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / linea + +# Variable: linea + +> `const` **linea**: `Common` + +Creates a common configuration for the linea chain. + +## Description + +Chain ID: 59144 +Chain Name: Linea Mainnet +Default Block Explorer: https://lineascan.build +Default RPC URL: https://rpc.linea.build + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { linea } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: linea, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/linea.d.ts:21 diff --git a/tevm/docs/common/variables/lineaGoerli.md b/tevm/docs/common/variables/lineaGoerli.md new file mode 100644 index 0000000000..d5ec8ecfa8 --- /dev/null +++ b/tevm/docs/common/variables/lineaGoerli.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / lineaGoerli + +# Variable: lineaGoerli + +> `const` **lineaGoerli**: `Common` + +Creates a common configuration for the lineaGoerli chain. + +## Description + +Chain ID: 59140 +Chain Name: Linea Goerli Testnet +Default Block Explorer: https://goerli.lineascan.build +Default RPC URL: https://rpc.goerli.linea.build + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { lineaGoerli } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: lineaGoerli, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/lineaGoerli.d.ts:21 diff --git a/tevm/docs/common/variables/lineaSepolia.md b/tevm/docs/common/variables/lineaSepolia.md new file mode 100644 index 0000000000..1661c4dfd3 --- /dev/null +++ b/tevm/docs/common/variables/lineaSepolia.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / lineaSepolia + +# Variable: lineaSepolia + +> `const` **lineaSepolia**: `Common` + +Creates a common configuration for the lineaSepolia chain. + +## Description + +Chain ID: 59141 +Chain Name: Linea Sepolia Testnet +Default Block Explorer: https://sepolia.lineascan.build +Default RPC URL: https://rpc.sepolia.linea.build + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { lineaSepolia } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: lineaSepolia, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/lineaSepolia.d.ts:21 diff --git a/tevm/docs/common/variables/lineaTestnet.md b/tevm/docs/common/variables/lineaTestnet.md new file mode 100644 index 0000000000..c19ba60a4e --- /dev/null +++ b/tevm/docs/common/variables/lineaTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / lineaTestnet + +# Variable: lineaTestnet + +> `const` **lineaTestnet**: `Common` + +Creates a common configuration for the lineaTestnet chain. + +## Description + +Chain ID: 59140 +Chain Name: Linea Goerli Testnet +Default Block Explorer: https://goerli.lineascan.build +Default RPC URL: https://rpc.goerli.linea.build + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { lineaTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: lineaTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/lineaTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/lisk.md b/tevm/docs/common/variables/lisk.md new file mode 100644 index 0000000000..52a7b78004 --- /dev/null +++ b/tevm/docs/common/variables/lisk.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / lisk + +# Variable: lisk + +> `const` **lisk**: `Common` + +Creates a common configuration for the lisk chain. + +## Description + +Chain ID: 1135 +Chain Name: Lisk +Default Block Explorer: https://blockscout.lisk.com +Default RPC URL: https://rpc.api.lisk.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { lisk } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: lisk, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/lisk.d.ts:21 diff --git a/tevm/docs/common/variables/liskSepolia.md b/tevm/docs/common/variables/liskSepolia.md new file mode 100644 index 0000000000..a8555fc773 --- /dev/null +++ b/tevm/docs/common/variables/liskSepolia.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / liskSepolia + +# Variable: liskSepolia + +> `const` **liskSepolia**: `Common` + +Creates a common configuration for the liskSepolia chain. + +## Description + +Chain ID: 4202 +Chain Name: Lisk Sepolia +Default Block Explorer: https://sepolia-blockscout.lisk.com +Default RPC URL: https://rpc.sepolia-api.lisk.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { liskSepolia } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: liskSepolia, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/liskSepolia.d.ts:21 diff --git a/tevm/docs/common/variables/localhost.md b/tevm/docs/common/variables/localhost.md new file mode 100644 index 0000000000..ed410fe637 --- /dev/null +++ b/tevm/docs/common/variables/localhost.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / localhost + +# Variable: localhost + +> `const` **localhost**: `Common` + +Creates a common configuration for the localhost chain. + +## Description + +Chain ID: 1337 +Chain Name: Localhost +Default Block Explorer: Not specified +Default RPC URL: http://127.0.0.1:8545 + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { localhost } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: localhost, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/localhost.d.ts:21 diff --git a/tevm/docs/common/variables/lukso.md b/tevm/docs/common/variables/lukso.md new file mode 100644 index 0000000000..506a1cc989 --- /dev/null +++ b/tevm/docs/common/variables/lukso.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / lukso + +# Variable: lukso + +> `const` **lukso**: `Common` + +Creates a common configuration for the lukso chain. + +## Description + +Chain ID: 42 +Chain Name: LUKSO +Default Block Explorer: https://explorer.execution.mainnet.lukso.network +Default RPC URL: https://rpc.mainnet.lukso.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { lukso } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: lukso, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/lukso.d.ts:21 diff --git a/tevm/docs/common/variables/luksoTestnet.md b/tevm/docs/common/variables/luksoTestnet.md new file mode 100644 index 0000000000..dc6ea87ffd --- /dev/null +++ b/tevm/docs/common/variables/luksoTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / luksoTestnet + +# Variable: luksoTestnet + +> `const` **luksoTestnet**: `Common` + +Creates a common configuration for the luksoTestnet chain. + +## Description + +Chain ID: 4201 +Chain Name: LUKSO Testnet +Default Block Explorer: https://explorer.execution.testnet.lukso.network +Default RPC URL: https://rpc.testnet.lukso.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { luksoTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: luksoTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/luksoTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/lycan.md b/tevm/docs/common/variables/lycan.md new file mode 100644 index 0000000000..cb34ea6769 --- /dev/null +++ b/tevm/docs/common/variables/lycan.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / lycan + +# Variable: lycan + +> `const` **lycan**: `Common` + +Creates a common configuration for the lycan chain. + +## Description + +Chain ID: 721 +Chain Name: Lycan +Default Block Explorer: https://explorer.lycanchain.com +Default RPC URL: https://rpc.lycanchain.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { lycan } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: lycan, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/lycan.d.ts:21 diff --git a/tevm/docs/common/variables/lyra.md b/tevm/docs/common/variables/lyra.md new file mode 100644 index 0000000000..748c02693b --- /dev/null +++ b/tevm/docs/common/variables/lyra.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / lyra + +# Variable: lyra + +> `const` **lyra**: `Common` + +Creates a common configuration for the lyra chain. + +## Description + +Chain ID: 957 +Chain Name: Lyra Chain +Default Block Explorer: https://explorer.lyra.finance +Default RPC URL: https://rpc.lyra.finance + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { lyra } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: lyra, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/lyra.d.ts:21 diff --git a/tevm/docs/common/variables/mainnet.md b/tevm/docs/common/variables/mainnet.md index 567212b55f..652cffd95b 100644 --- a/tevm/docs/common/variables/mainnet.md +++ b/tevm/docs/common/variables/mainnet.md @@ -8,6 +8,30 @@ > `const` **mainnet**: `Common` +Creates a common configuration for the mainnet chain. + +## Description + +Chain ID: 1 +Chain Name: Ethereum +Default Block Explorer: https://etherscan.io +Default RPC URL: https://cloudflare-eth.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { mainnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: mainnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + ## Defined in -packages/common/types/presets/mainnet.d.ts:1 +packages/common/types/presets/mainnet.d.ts:21 diff --git a/tevm/docs/common/variables/mandala.md b/tevm/docs/common/variables/mandala.md new file mode 100644 index 0000000000..e8be36cee8 --- /dev/null +++ b/tevm/docs/common/variables/mandala.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / mandala + +# Variable: mandala + +> `const` **mandala**: `Common` + +Creates a common configuration for the mandala chain. + +## Description + +Chain ID: 595 +Chain Name: Mandala TC9 +Default Block Explorer: https://blockscout.mandala.aca-staging.network +Default RPC URL: https://eth-rpc-tc9.aca-staging.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { mandala } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: mandala, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/mandala.d.ts:21 diff --git a/tevm/docs/common/variables/manta.md b/tevm/docs/common/variables/manta.md new file mode 100644 index 0000000000..f774dd73f3 --- /dev/null +++ b/tevm/docs/common/variables/manta.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / manta + +# Variable: manta + +> `const` **manta**: `Common` + +Creates a common configuration for the manta chain. + +## Description + +Chain ID: 169 +Chain Name: Manta Pacific Mainnet +Default Block Explorer: https://pacific-explorer.manta.network +Default RPC URL: https://pacific-rpc.manta.network/http + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { manta } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: manta, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/manta.d.ts:21 diff --git a/tevm/docs/common/variables/mantaSepoliaTestnet.md b/tevm/docs/common/variables/mantaSepoliaTestnet.md new file mode 100644 index 0000000000..a06ffb8b9b --- /dev/null +++ b/tevm/docs/common/variables/mantaSepoliaTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / mantaSepoliaTestnet + +# Variable: mantaSepoliaTestnet + +> `const` **mantaSepoliaTestnet**: `Common` + +Creates a common configuration for the mantaSepoliaTestnet chain. + +## Description + +Chain ID: 3441006 +Chain Name: Manta Pacific Sepolia Testnet +Default Block Explorer: https://pacific-explorer.sepolia-testnet.manta.network +Default RPC URL: https://pacific-rpc.sepolia-testnet.manta.network/http + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { mantaSepoliaTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: mantaSepoliaTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/mantaSepoliaTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/mantaTestnet.md b/tevm/docs/common/variables/mantaTestnet.md new file mode 100644 index 0000000000..d32d270ac0 --- /dev/null +++ b/tevm/docs/common/variables/mantaTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / mantaTestnet + +# Variable: mantaTestnet + +> `const` **mantaTestnet**: `Common` + +Creates a common configuration for the mantaTestnet chain. + +## Description + +Chain ID: 3441005 +Chain Name: Manta Pacific Testnet +Default Block Explorer: https://pacific-explorer.testnet.manta.network +Default RPC URL: https://manta-testnet.calderachain.xyz/http + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { mantaTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: mantaTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/mantaTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/mantle.md b/tevm/docs/common/variables/mantle.md new file mode 100644 index 0000000000..7ccb6c781c --- /dev/null +++ b/tevm/docs/common/variables/mantle.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / mantle + +# Variable: mantle + +> `const` **mantle**: `Common` + +Creates a common configuration for the mantle chain. + +## Description + +Chain ID: 5000 +Chain Name: Mantle +Default Block Explorer: https://mantlescan.xyz/ +Default RPC URL: https://rpc.mantle.xyz + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { mantle } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: mantle, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/mantle.d.ts:21 diff --git a/tevm/docs/common/variables/mantleSepoliaTestnet.md b/tevm/docs/common/variables/mantleSepoliaTestnet.md new file mode 100644 index 0000000000..c70ddd69a0 --- /dev/null +++ b/tevm/docs/common/variables/mantleSepoliaTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / mantleSepoliaTestnet + +# Variable: mantleSepoliaTestnet + +> `const` **mantleSepoliaTestnet**: `Common` + +Creates a common configuration for the mantleSepoliaTestnet chain. + +## Description + +Chain ID: 5003 +Chain Name: Mantle Sepolia Testnet +Default Block Explorer: https://explorer.sepolia.mantle.xyz/ +Default RPC URL: https://rpc.sepolia.mantle.xyz + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { mantleSepoliaTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: mantleSepoliaTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/mantleSepoliaTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/mantleTestnet.md b/tevm/docs/common/variables/mantleTestnet.md new file mode 100644 index 0000000000..ee660fd231 --- /dev/null +++ b/tevm/docs/common/variables/mantleTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / mantleTestnet + +# Variable: mantleTestnet + +> `const` **mantleTestnet**: `Common` + +Creates a common configuration for the mantleTestnet chain. + +## Description + +Chain ID: 5001 +Chain Name: Mantle Testnet +Default Block Explorer: https://explorer.testnet.mantle.xyz +Default RPC URL: https://rpc.testnet.mantle.xyz + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { mantleTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: mantleTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/mantleTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/merlin.md b/tevm/docs/common/variables/merlin.md new file mode 100644 index 0000000000..1bcc679dfe --- /dev/null +++ b/tevm/docs/common/variables/merlin.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / merlin + +# Variable: merlin + +> `const` **merlin**: `Common` + +Creates a common configuration for the merlin chain. + +## Description + +Chain ID: 4200 +Chain Name: Merlin +Default Block Explorer: https://scan.merlinchain.io +Default RPC URL: https://rpc.merlinchain.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { merlin } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: merlin, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/merlin.d.ts:21 diff --git a/tevm/docs/common/variables/metachain.md b/tevm/docs/common/variables/metachain.md new file mode 100644 index 0000000000..7d27306af9 --- /dev/null +++ b/tevm/docs/common/variables/metachain.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / metachain + +# Variable: metachain + +> `const` **metachain**: `Common` + +Creates a common configuration for the metachain chain. + +## Description + +Chain ID: 571 +Chain Name: MetaChain Mainnet +Default Block Explorer: https://explorer.metatime.com +Default RPC URL: https://rpc.metatime.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { metachain } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: metachain, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/metachain.d.ts:21 diff --git a/tevm/docs/common/variables/metachainIstanbul.md b/tevm/docs/common/variables/metachainIstanbul.md new file mode 100644 index 0000000000..4b5ed24be3 --- /dev/null +++ b/tevm/docs/common/variables/metachainIstanbul.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / metachainIstanbul + +# Variable: metachainIstanbul + +> `const` **metachainIstanbul**: `Common` + +Creates a common configuration for the metachainIstanbul chain. + +## Description + +Chain ID: 1453 +Chain Name: MetaChain Istanbul +Default Block Explorer: https://istanbul-explorer.metachain.dev +Default RPC URL: https://istanbul-rpc.metachain.dev + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { metachainIstanbul } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: metachainIstanbul, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/metachainIstanbul.d.ts:21 diff --git a/tevm/docs/common/variables/metalL2.md b/tevm/docs/common/variables/metalL2.md new file mode 100644 index 0000000000..9de30de749 --- /dev/null +++ b/tevm/docs/common/variables/metalL2.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / metalL2 + +# Variable: metalL2 + +> `const` **metalL2**: `Common` + +Creates a common configuration for the metalL2 chain. + +## Description + +Chain ID: 1750 +Chain Name: Metal L2 +Default Block Explorer: https://explorer.metall2.com +Default RPC URL: https://rpc.metall2.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { metalL2 } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: metalL2, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/metalL2.d.ts:21 diff --git a/tevm/docs/common/variables/meter.md b/tevm/docs/common/variables/meter.md new file mode 100644 index 0000000000..d3caf99822 --- /dev/null +++ b/tevm/docs/common/variables/meter.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / meter + +# Variable: meter + +> `const` **meter**: `Common` + +Creates a common configuration for the meter chain. + +## Description + +Chain ID: 82 +Chain Name: Meter +Default Block Explorer: https://scan.meter.io +Default RPC URL: https://rpc.meter.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { meter } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: meter, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/meter.d.ts:21 diff --git a/tevm/docs/common/variables/meterTestnet.md b/tevm/docs/common/variables/meterTestnet.md new file mode 100644 index 0000000000..cd861e742f --- /dev/null +++ b/tevm/docs/common/variables/meterTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / meterTestnet + +# Variable: meterTestnet + +> `const` **meterTestnet**: `Common` + +Creates a common configuration for the meterTestnet chain. + +## Description + +Chain ID: 83 +Chain Name: Meter Testnet +Default Block Explorer: https://scan-warringstakes.meter.io +Default RPC URL: https://rpctest.meter.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { meterTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: meterTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/meterTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/metis.md b/tevm/docs/common/variables/metis.md new file mode 100644 index 0000000000..a09dafa1ab --- /dev/null +++ b/tevm/docs/common/variables/metis.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / metis + +# Variable: metis + +> `const` **metis**: `Common` + +Creates a common configuration for the metis chain. + +## Description + +Chain ID: 1088 +Chain Name: Metis +Default Block Explorer: https://explorer.metis.io +Default RPC URL: https://andromeda.metis.io/?owner=1088 + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { metis } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: metis, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/metis.d.ts:21 diff --git a/tevm/docs/common/variables/metisGoerli.md b/tevm/docs/common/variables/metisGoerli.md new file mode 100644 index 0000000000..ba524b0903 --- /dev/null +++ b/tevm/docs/common/variables/metisGoerli.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / metisGoerli + +# Variable: metisGoerli + +> `const` **metisGoerli**: `Common` + +Creates a common configuration for the metisGoerli chain. + +## Description + +Chain ID: 599 +Chain Name: Metis Goerli +Default Block Explorer: https://goerli.explorer.metisdevops.link +Default RPC URL: https://goerli.gateway.metisdevops.link + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { metisGoerli } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: metisGoerli, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/metisGoerli.d.ts:21 diff --git a/tevm/docs/common/variables/mev.md b/tevm/docs/common/variables/mev.md new file mode 100644 index 0000000000..788547159e --- /dev/null +++ b/tevm/docs/common/variables/mev.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / mev + +# Variable: mev + +> `const` **mev**: `Common` + +Creates a common configuration for the mev chain. + +## Description + +Chain ID: 7518 +Chain Name: MEVerse Chain Mainnet +Default Block Explorer: https://www.meversescan.io +Default RPC URL: https://rpc.meversemainnet.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { mev } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: mev, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/mev.d.ts:21 diff --git a/tevm/docs/common/variables/mevTestnet.md b/tevm/docs/common/variables/mevTestnet.md new file mode 100644 index 0000000000..378235c4bc --- /dev/null +++ b/tevm/docs/common/variables/mevTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / mevTestnet + +# Variable: mevTestnet + +> `const` **mevTestnet**: `Common` + +Creates a common configuration for the mevTestnet chain. + +## Description + +Chain ID: 4759 +Chain Name: MEVerse Chain Testnet +Default Block Explorer: https://testnet.meversescan.io/ +Default RPC URL: https://rpc.meversetestnet.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { mevTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: mevTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/mevTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/mintSepoliaTestnet.md b/tevm/docs/common/variables/mintSepoliaTestnet.md new file mode 100644 index 0000000000..ef061038c7 --- /dev/null +++ b/tevm/docs/common/variables/mintSepoliaTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / mintSepoliaTestnet + +# Variable: mintSepoliaTestnet + +> `const` **mintSepoliaTestnet**: `Common` + +Creates a common configuration for the mintSepoliaTestnet chain. + +## Description + +Chain ID: 1686 +Chain Name: Mint Sepolia Testnet +Default Block Explorer: https://testnet-explorer.mintchain.io +Default RPC URL: https://testnet-rpc.mintchain.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { mintSepoliaTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: mintSepoliaTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/mintSepoliaTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/mode.md b/tevm/docs/common/variables/mode.md new file mode 100644 index 0000000000..6c23a6a7b6 --- /dev/null +++ b/tevm/docs/common/variables/mode.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / mode + +# Variable: mode + +> `const` **mode**: `Common` + +Creates a common configuration for the mode chain. + +## Description + +Chain ID: 34443 +Chain Name: Mode Mainnet +Default Block Explorer: https://modescan.io +Default RPC URL: https://mainnet.mode.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { mode } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: mode, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/mode.d.ts:21 diff --git a/tevm/docs/common/variables/modeTestnet.md b/tevm/docs/common/variables/modeTestnet.md new file mode 100644 index 0000000000..23fbd536f9 --- /dev/null +++ b/tevm/docs/common/variables/modeTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / modeTestnet + +# Variable: modeTestnet + +> `const` **modeTestnet**: `Common` + +Creates a common configuration for the modeTestnet chain. + +## Description + +Chain ID: 919 +Chain Name: Mode Testnet +Default Block Explorer: https://sepolia.explorer.mode.network +Default RPC URL: https://sepolia.mode.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { modeTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: modeTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/modeTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/moonbaseAlpha.md b/tevm/docs/common/variables/moonbaseAlpha.md new file mode 100644 index 0000000000..a049e57762 --- /dev/null +++ b/tevm/docs/common/variables/moonbaseAlpha.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / moonbaseAlpha + +# Variable: moonbaseAlpha + +> `const` **moonbaseAlpha**: `Common` + +Creates a common configuration for the moonbaseAlpha chain. + +## Description + +Chain ID: 1287 +Chain Name: Moonbase Alpha +Default Block Explorer: https://moonbase.moonscan.io +Default RPC URL: https://rpc.api.moonbase.moonbeam.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { moonbaseAlpha } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: moonbaseAlpha, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/moonbaseAlpha.d.ts:21 diff --git a/tevm/docs/common/variables/moonbeam.md b/tevm/docs/common/variables/moonbeam.md new file mode 100644 index 0000000000..84aa735218 --- /dev/null +++ b/tevm/docs/common/variables/moonbeam.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / moonbeam + +# Variable: moonbeam + +> `const` **moonbeam**: `Common` + +Creates a common configuration for the moonbeam chain. + +## Description + +Chain ID: 1284 +Chain Name: Moonbeam +Default Block Explorer: https://moonscan.io +Default RPC URL: https://moonbeam.public.blastapi.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { moonbeam } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: moonbeam, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/moonbeam.d.ts:21 diff --git a/tevm/docs/common/variables/moonbeamDev.md b/tevm/docs/common/variables/moonbeamDev.md new file mode 100644 index 0000000000..2a3a2fddff --- /dev/null +++ b/tevm/docs/common/variables/moonbeamDev.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / moonbeamDev + +# Variable: moonbeamDev + +> `const` **moonbeamDev**: `Common` + +Creates a common configuration for the moonbeamDev chain. + +## Description + +Chain ID: 1281 +Chain Name: Moonbeam Development Node +Default Block Explorer: Not specified +Default RPC URL: http://127.0.0.1:9944 + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { moonbeamDev } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: moonbeamDev, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/moonbeamDev.d.ts:21 diff --git a/tevm/docs/common/variables/moonriver.md b/tevm/docs/common/variables/moonriver.md new file mode 100644 index 0000000000..703b80b5af --- /dev/null +++ b/tevm/docs/common/variables/moonriver.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / moonriver + +# Variable: moonriver + +> `const` **moonriver**: `Common` + +Creates a common configuration for the moonriver chain. + +## Description + +Chain ID: 1285 +Chain Name: Moonriver +Default Block Explorer: https://moonriver.moonscan.io +Default RPC URL: https://moonriver.public.blastapi.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { moonriver } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: moonriver, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/moonriver.d.ts:21 diff --git a/tevm/docs/common/variables/morphHolesky.md b/tevm/docs/common/variables/morphHolesky.md new file mode 100644 index 0000000000..d552ad8187 --- /dev/null +++ b/tevm/docs/common/variables/morphHolesky.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / morphHolesky + +# Variable: morphHolesky + +> `const` **morphHolesky**: `Common` + +Creates a common configuration for the morphHolesky chain. + +## Description + +Chain ID: 2810 +Chain Name: Morph Holesky +Default Block Explorer: https://explorer-holesky.morphl2.io +Default RPC URL: https://rpc-quicknode-holesky.morphl2.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { morphHolesky } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: morphHolesky, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/morphHolesky.d.ts:21 diff --git a/tevm/docs/common/variables/morphSepolia.md b/tevm/docs/common/variables/morphSepolia.md new file mode 100644 index 0000000000..136219c5f5 --- /dev/null +++ b/tevm/docs/common/variables/morphSepolia.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / morphSepolia + +# Variable: morphSepolia + +> `const` **morphSepolia**: `Common` + +Creates a common configuration for the morphSepolia chain. + +## Description + +Chain ID: 2710 +Chain Name: Morph Sepolia +Default Block Explorer: https://explorer-testnet.morphl2.io +Default RPC URL: https://rpc-testnet.morphl2.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { morphSepolia } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: morphSepolia, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/morphSepolia.d.ts:21 diff --git a/tevm/docs/common/variables/nautilus.md b/tevm/docs/common/variables/nautilus.md new file mode 100644 index 0000000000..6bfe420c57 --- /dev/null +++ b/tevm/docs/common/variables/nautilus.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / nautilus + +# Variable: nautilus + +> `const` **nautilus**: `Common` + +Creates a common configuration for the nautilus chain. + +## Description + +Chain ID: 22222 +Chain Name: Nautilus Mainnet +Default Block Explorer: https://nautscan.com +Default RPC URL: https://api.nautilus.nautchain.xyz + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { nautilus } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: nautilus, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/nautilus.d.ts:21 diff --git a/tevm/docs/common/variables/neonDevnet.md b/tevm/docs/common/variables/neonDevnet.md new file mode 100644 index 0000000000..e7a57428e9 --- /dev/null +++ b/tevm/docs/common/variables/neonDevnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / neonDevnet + +# Variable: neonDevnet + +> `const` **neonDevnet**: `Common` + +Creates a common configuration for the neonDevnet chain. + +## Description + +Chain ID: 245022926 +Chain Name: Neon EVM DevNet +Default Block Explorer: https://devnet.neonscan.org +Default RPC URL: https://devnet.neonevm.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { neonDevnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: neonDevnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/neonDevnet.d.ts:21 diff --git a/tevm/docs/common/variables/neonMainnet.md b/tevm/docs/common/variables/neonMainnet.md new file mode 100644 index 0000000000..be91436f60 --- /dev/null +++ b/tevm/docs/common/variables/neonMainnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / neonMainnet + +# Variable: neonMainnet + +> `const` **neonMainnet**: `Common` + +Creates a common configuration for the neonMainnet chain. + +## Description + +Chain ID: 245022934 +Chain Name: Neon EVM MainNet +Default Block Explorer: https://neonscan.org +Default RPC URL: https://neon-proxy-mainnet.solana.p2p.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { neonMainnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: neonMainnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/neonMainnet.d.ts:21 diff --git a/tevm/docs/common/variables/nexi.md b/tevm/docs/common/variables/nexi.md new file mode 100644 index 0000000000..45df5627e7 --- /dev/null +++ b/tevm/docs/common/variables/nexi.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / nexi + +# Variable: nexi + +> `const` **nexi**: `Common` + +Creates a common configuration for the nexi chain. + +## Description + +Chain ID: 4242 +Chain Name: Nexi +Default Block Explorer: https://www.nexiscan.com +Default RPC URL: https://rpc.chain.nexi.technology + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { nexi } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: nexi, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/nexi.d.ts:21 diff --git a/tevm/docs/common/variables/nexilix.md b/tevm/docs/common/variables/nexilix.md new file mode 100644 index 0000000000..86f5640b23 --- /dev/null +++ b/tevm/docs/common/variables/nexilix.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / nexilix + +# Variable: nexilix + +> `const` **nexilix**: `Common` + +Creates a common configuration for the nexilix chain. + +## Description + +Chain ID: 240 +Chain Name: Nexilix Smart Chain +Default Block Explorer: https://scan.nexilix.com +Default RPC URL: https://rpcurl.pos.nexilix.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { nexilix } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: nexilix, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/nexilix.d.ts:21 diff --git a/tevm/docs/common/variables/oasisTestnet.md b/tevm/docs/common/variables/oasisTestnet.md new file mode 100644 index 0000000000..8956c35c31 --- /dev/null +++ b/tevm/docs/common/variables/oasisTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / oasisTestnet + +# Variable: oasisTestnet + +> `const` **oasisTestnet**: `Common` + +Creates a common configuration for the oasisTestnet chain. + +## Description + +Chain ID: 4090 +Chain Name: Oasis Testnet +Default Block Explorer: https://oasis.ftnscan.com +Default RPC URL: https://rpc1.oasis.bahamutchain.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { oasisTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: oasisTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/oasisTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/oasys.md b/tevm/docs/common/variables/oasys.md new file mode 100644 index 0000000000..de553ad2ff --- /dev/null +++ b/tevm/docs/common/variables/oasys.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / oasys + +# Variable: oasys + +> `const` **oasys**: `Common` + +Creates a common configuration for the oasys chain. + +## Description + +Chain ID: 248 +Chain Name: Oasys +Default Block Explorer: https://scan.oasys.games +Default RPC URL: https://rpc.mainnet.oasys.games + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { oasys } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: oasys, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/oasys.d.ts:21 diff --git a/tevm/docs/common/variables/okc.md b/tevm/docs/common/variables/okc.md new file mode 100644 index 0000000000..9cdb439127 --- /dev/null +++ b/tevm/docs/common/variables/okc.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / okc + +# Variable: okc + +> `const` **okc**: `Common` + +Creates a common configuration for the okc chain. + +## Description + +Chain ID: 66 +Chain Name: OKC +Default Block Explorer: https://www.oklink.com/okc +Default RPC URL: https://exchainrpc.okex.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { okc } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: okc, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/okc.d.ts:21 diff --git a/tevm/docs/common/variables/oortMainnetDev.md b/tevm/docs/common/variables/oortMainnetDev.md new file mode 100644 index 0000000000..2fc32047f7 --- /dev/null +++ b/tevm/docs/common/variables/oortMainnetDev.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / oortMainnetDev + +# Variable: oortMainnetDev + +> `const` **oortMainnetDev**: `Common` + +Creates a common configuration for the oortMainnetDev chain. + +## Description + +Chain ID: 9700 +Chain Name: OORT MainnetDev +Default Block Explorer: https://dev-scan.oortech.com +Default RPC URL: https://dev-rpc.oortech.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { oortMainnetDev } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: oortMainnetDev, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/oortMainnetDev.d.ts:21 diff --git a/tevm/docs/common/variables/opBNB.md b/tevm/docs/common/variables/opBNB.md new file mode 100644 index 0000000000..06965259c8 --- /dev/null +++ b/tevm/docs/common/variables/opBNB.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / opBNB + +# Variable: opBNB + +> `const` **opBNB**: `Common` + +Creates a common configuration for the opBNB chain. + +## Description + +Chain ID: 204 +Chain Name: opBNB +Default Block Explorer: https://mainnet.opbnbscan.com +Default RPC URL: https://opbnb-mainnet-rpc.bnbchain.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { opBNB } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: opBNB, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/opBNB.d.ts:21 diff --git a/tevm/docs/common/variables/opBNBTestnet.md b/tevm/docs/common/variables/opBNBTestnet.md new file mode 100644 index 0000000000..80338b0008 --- /dev/null +++ b/tevm/docs/common/variables/opBNBTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / opBNBTestnet + +# Variable: opBNBTestnet + +> `const` **opBNBTestnet**: `Common` + +Creates a common configuration for the opBNBTestnet chain. + +## Description + +Chain ID: 5611 +Chain Name: opBNB Testnet +Default Block Explorer: https://testnet.opbnbscan.com +Default RPC URL: https://opbnb-testnet-rpc.bnbchain.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { opBNBTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: opBNBTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/opBNBTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/optimism.md b/tevm/docs/common/variables/optimism.md index 1aa9e15a1e..527e9d7d83 100644 --- a/tevm/docs/common/variables/optimism.md +++ b/tevm/docs/common/variables/optimism.md @@ -8,6 +8,30 @@ > `const` **optimism**: `Common` +Creates a common configuration for the optimism chain. + +## Description + +Chain ID: 10 +Chain Name: OP Mainnet +Default Block Explorer: https://optimistic.etherscan.io +Default RPC URL: https://mainnet.optimism.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { optimism } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: optimism, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + ## Defined in -packages/common/types/presets/optimism.d.ts:1 +packages/common/types/presets/optimism.d.ts:21 diff --git a/tevm/docs/common/variables/optimismGoerli.md b/tevm/docs/common/variables/optimismGoerli.md new file mode 100644 index 0000000000..e84d4384c8 --- /dev/null +++ b/tevm/docs/common/variables/optimismGoerli.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / optimismGoerli + +# Variable: optimismGoerli + +> `const` **optimismGoerli**: `Common` + +Creates a common configuration for the optimismGoerli chain. + +## Description + +Chain ID: 420 +Chain Name: Optimism Goerli +Default Block Explorer: https://goerli-optimism.etherscan.io +Default RPC URL: https://goerli.optimism.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { optimismGoerli } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: optimismGoerli, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/optimismGoerli.d.ts:21 diff --git a/tevm/docs/common/variables/optimismSepolia.md b/tevm/docs/common/variables/optimismSepolia.md index 82c8154cdd..1d5816aa84 100644 --- a/tevm/docs/common/variables/optimismSepolia.md +++ b/tevm/docs/common/variables/optimismSepolia.md @@ -8,6 +8,30 @@ > `const` **optimismSepolia**: `Common` +Creates a common configuration for the optimismSepolia chain. + +## Description + +Chain ID: 11155420 +Chain Name: OP Sepolia +Default Block Explorer: https://optimism-sepolia.blockscout.com +Default RPC URL: https://sepolia.optimism.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { optimismSepolia } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: optimismSepolia, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + ## Defined in -packages/common/types/presets/optimismSepolia.d.ts:1 +packages/common/types/presets/optimismSepolia.d.ts:21 diff --git a/tevm/docs/common/variables/otimDevnet.md b/tevm/docs/common/variables/otimDevnet.md new file mode 100644 index 0000000000..7a00425df0 --- /dev/null +++ b/tevm/docs/common/variables/otimDevnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / otimDevnet + +# Variable: otimDevnet + +> `const` **otimDevnet**: `Common` + +Creates a common configuration for the otimDevnet chain. + +## Description + +Chain ID: 41144114 +Chain Name: Otim Devnet +Default Block Explorer: Not specified +Default RPC URL: http://devnet.otim.xyz + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { otimDevnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: otimDevnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/otimDevnet.d.ts:21 diff --git a/tevm/docs/common/variables/palm.md b/tevm/docs/common/variables/palm.md new file mode 100644 index 0000000000..db1749e443 --- /dev/null +++ b/tevm/docs/common/variables/palm.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / palm + +# Variable: palm + +> `const` **palm**: `Common` + +Creates a common configuration for the palm chain. + +## Description + +Chain ID: 11297108109 +Chain Name: Palm +Default Block Explorer: https://palm.chainlens.com +Default RPC URL: https://palm-mainnet.public.blastapi.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { palm } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: palm, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/palm.d.ts:21 diff --git a/tevm/docs/common/variables/palmTestnet.md b/tevm/docs/common/variables/palmTestnet.md new file mode 100644 index 0000000000..a8377f01d5 --- /dev/null +++ b/tevm/docs/common/variables/palmTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / palmTestnet + +# Variable: palmTestnet + +> `const` **palmTestnet**: `Common` + +Creates a common configuration for the palmTestnet chain. + +## Description + +Chain ID: 11297108099 +Chain Name: Palm Testnet +Default Block Explorer: https://palm.chainlens.com +Default RPC URL: https://palm-mainnet.public.blastapi.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { palmTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: palmTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/palmTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/pgn.md b/tevm/docs/common/variables/pgn.md new file mode 100644 index 0000000000..3eb6e67a97 --- /dev/null +++ b/tevm/docs/common/variables/pgn.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / pgn + +# Variable: pgn + +> `const` **pgn**: `Common` + +Creates a common configuration for the pgn chain. + +## Description + +Chain ID: 424 +Chain Name: PGN +Default Block Explorer: https://explorer.publicgoods.network +Default RPC URL: https://rpc.publicgoods.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { pgn } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: pgn, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/pgn.d.ts:21 diff --git a/tevm/docs/common/variables/pgnTestnet.md b/tevm/docs/common/variables/pgnTestnet.md new file mode 100644 index 0000000000..d273d8f4ac --- /dev/null +++ b/tevm/docs/common/variables/pgnTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / pgnTestnet + +# Variable: pgnTestnet + +> `const` **pgnTestnet**: `Common` + +Creates a common configuration for the pgnTestnet chain. + +## Description + +Chain ID: 58008 +Chain Name: PGN +Default Block Explorer: https://explorer.sepolia.publicgoods.network +Default RPC URL: https://sepolia.publicgoods.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { pgnTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: pgnTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/pgnTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/phoenix.md b/tevm/docs/common/variables/phoenix.md new file mode 100644 index 0000000000..e219491d8a --- /dev/null +++ b/tevm/docs/common/variables/phoenix.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / phoenix + +# Variable: phoenix + +> `const` **phoenix**: `Common` + +Creates a common configuration for the phoenix chain. + +## Description + +Chain ID: 13381 +Chain Name: Phoenix Blockchain +Default Block Explorer: https://phoenixplorer.com +Default RPC URL: https://rpc.phoenixplorer.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { phoenix } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: phoenix, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/phoenix.d.ts:21 diff --git a/tevm/docs/common/variables/playfiAlbireo.md b/tevm/docs/common/variables/playfiAlbireo.md new file mode 100644 index 0000000000..a060a877ca --- /dev/null +++ b/tevm/docs/common/variables/playfiAlbireo.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / playfiAlbireo + +# Variable: playfiAlbireo + +> `const` **playfiAlbireo**: `Common` + +Creates a common configuration for the playfiAlbireo chain. + +## Description + +Chain ID: 1612127 +Chain Name: PlayFi Albireo Testnet +Default Block Explorer: https://albireo-explorer.playfi.ai +Default RPC URL: https://albireo-rpc.playfi.ai + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { playfiAlbireo } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: playfiAlbireo, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/playfiAlbireo.d.ts:21 diff --git a/tevm/docs/common/variables/plinga.md b/tevm/docs/common/variables/plinga.md new file mode 100644 index 0000000000..3ad4d0acd7 --- /dev/null +++ b/tevm/docs/common/variables/plinga.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / plinga + +# Variable: plinga + +> `const` **plinga**: `Common` + +Creates a common configuration for the plinga chain. + +## Description + +Chain ID: 242 +Chain Name: Plinga +Default Block Explorer: https://www.plgscan.com +Default RPC URL: https://rpcurl.mainnet.plgchain.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { plinga } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: plinga, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/plinga.d.ts:21 diff --git a/tevm/docs/common/variables/plumeTestnet.md b/tevm/docs/common/variables/plumeTestnet.md new file mode 100644 index 0000000000..21877768c5 --- /dev/null +++ b/tevm/docs/common/variables/plumeTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / plumeTestnet + +# Variable: plumeTestnet + +> `const` **plumeTestnet**: `Common` + +Creates a common configuration for the plumeTestnet chain. + +## Description + +Chain ID: 161221135 +Chain Name: Plume Testnet +Default Block Explorer: https://testnet-explorer.plumenetwork.xyz +Default RPC URL: https://testnet-rpc.plumenetwork.xyz/http + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { plumeTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: plumeTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/plumeTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/polygon.md b/tevm/docs/common/variables/polygon.md new file mode 100644 index 0000000000..281e2b0c43 --- /dev/null +++ b/tevm/docs/common/variables/polygon.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / polygon + +# Variable: polygon + +> `const` **polygon**: `Common` + +Creates a common configuration for the polygon chain. + +## Description + +Chain ID: 137 +Chain Name: Polygon +Default Block Explorer: https://polygonscan.com +Default RPC URL: https://polygon-rpc.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { polygon } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: polygon, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/polygon.d.ts:21 diff --git a/tevm/docs/common/variables/polygonAmoy.md b/tevm/docs/common/variables/polygonAmoy.md new file mode 100644 index 0000000000..aee5bbb771 --- /dev/null +++ b/tevm/docs/common/variables/polygonAmoy.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / polygonAmoy + +# Variable: polygonAmoy + +> `const` **polygonAmoy**: `Common` + +Creates a common configuration for the polygonAmoy chain. + +## Description + +Chain ID: 80002 +Chain Name: Polygon Amoy +Default Block Explorer: https://amoy.polygonscan.com +Default RPC URL: https://rpc-amoy.polygon.technology + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { polygonAmoy } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: polygonAmoy, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/polygonAmoy.d.ts:21 diff --git a/tevm/docs/common/variables/polygonMumbai.md b/tevm/docs/common/variables/polygonMumbai.md new file mode 100644 index 0000000000..0dbfef5ab0 --- /dev/null +++ b/tevm/docs/common/variables/polygonMumbai.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / polygonMumbai + +# Variable: polygonMumbai + +> `const` **polygonMumbai**: `Common` + +Creates a common configuration for the polygonMumbai chain. + +## Description + +Chain ID: 80001 +Chain Name: Polygon Mumbai +Default Block Explorer: https://mumbai.polygonscan.com +Default RPC URL: https://rpc.ankr.com/polygon_mumbai + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { polygonMumbai } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: polygonMumbai, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/polygonMumbai.d.ts:21 diff --git a/tevm/docs/common/variables/polygonZkEvm.md b/tevm/docs/common/variables/polygonZkEvm.md new file mode 100644 index 0000000000..7cb384f2bb --- /dev/null +++ b/tevm/docs/common/variables/polygonZkEvm.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / polygonZkEvm + +# Variable: polygonZkEvm + +> `const` **polygonZkEvm**: `Common` + +Creates a common configuration for the polygonZkEvm chain. + +## Description + +Chain ID: 1101 +Chain Name: Polygon zkEVM +Default Block Explorer: https://zkevm.polygonscan.com +Default RPC URL: https://zkevm-rpc.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { polygonZkEvm } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: polygonZkEvm, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/polygonZkEvm.d.ts:21 diff --git a/tevm/docs/common/variables/polygonZkEvmCardona.md b/tevm/docs/common/variables/polygonZkEvmCardona.md new file mode 100644 index 0000000000..4c6fd1d77a --- /dev/null +++ b/tevm/docs/common/variables/polygonZkEvmCardona.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / polygonZkEvmCardona + +# Variable: polygonZkEvmCardona + +> `const` **polygonZkEvmCardona**: `Common` + +Creates a common configuration for the polygonZkEvmCardona chain. + +## Description + +Chain ID: 2442 +Chain Name: Polygon zkEVM Cardona +Default Block Explorer: https://cardona-zkevm.polygonscan.com +Default RPC URL: https://rpc.cardona.zkevm-rpc.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { polygonZkEvmCardona } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: polygonZkEvmCardona, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/polygonZkEvmCardona.d.ts:21 diff --git a/tevm/docs/common/variables/polygonZkEvmTestnet.md b/tevm/docs/common/variables/polygonZkEvmTestnet.md new file mode 100644 index 0000000000..7d6b72c726 --- /dev/null +++ b/tevm/docs/common/variables/polygonZkEvmTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / polygonZkEvmTestnet + +# Variable: polygonZkEvmTestnet + +> `const` **polygonZkEvmTestnet**: `Common` + +Creates a common configuration for the polygonZkEvmTestnet chain. + +## Description + +Chain ID: 1442 +Chain Name: Polygon zkEVM Testnet +Default Block Explorer: https://testnet-zkevm.polygonscan.com +Default RPC URL: https://rpc.public.zkevm-test.net + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { polygonZkEvmTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: polygonZkEvmTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/polygonZkEvmTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/pulsechain.md b/tevm/docs/common/variables/pulsechain.md new file mode 100644 index 0000000000..2016f44f37 --- /dev/null +++ b/tevm/docs/common/variables/pulsechain.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / pulsechain + +# Variable: pulsechain + +> `const` **pulsechain**: `Common` + +Creates a common configuration for the pulsechain chain. + +## Description + +Chain ID: 369 +Chain Name: PulseChain +Default Block Explorer: https://scan.pulsechain.com +Default RPC URL: https://rpc.pulsechain.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { pulsechain } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: pulsechain, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/pulsechain.d.ts:21 diff --git a/tevm/docs/common/variables/pulsechainV4.md b/tevm/docs/common/variables/pulsechainV4.md new file mode 100644 index 0000000000..8e1f00d858 --- /dev/null +++ b/tevm/docs/common/variables/pulsechainV4.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / pulsechainV4 + +# Variable: pulsechainV4 + +> `const` **pulsechainV4**: `Common` + +Creates a common configuration for the pulsechainV4 chain. + +## Description + +Chain ID: 943 +Chain Name: PulseChain V4 +Default Block Explorer: https://scan.v4.testnet.pulsechain.com +Default RPC URL: https://rpc.v4.testnet.pulsechain.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { pulsechainV4 } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: pulsechainV4, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/pulsechainV4.d.ts:21 diff --git a/tevm/docs/common/variables/qMainnet.md b/tevm/docs/common/variables/qMainnet.md new file mode 100644 index 0000000000..2e651f6d2f --- /dev/null +++ b/tevm/docs/common/variables/qMainnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / qMainnet + +# Variable: qMainnet + +> `const` **qMainnet**: `Common` + +Creates a common configuration for the qMainnet chain. + +## Description + +Chain ID: 35441 +Chain Name: Q Mainnet +Default Block Explorer: https://explorer.q.org +Default RPC URL: https://rpc.q.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { qMainnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: qMainnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/qMainnet.d.ts:21 diff --git a/tevm/docs/common/variables/qTestnet.md b/tevm/docs/common/variables/qTestnet.md new file mode 100644 index 0000000000..91bfd8cf70 --- /dev/null +++ b/tevm/docs/common/variables/qTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / qTestnet + +# Variable: qTestnet + +> `const` **qTestnet**: `Common` + +Creates a common configuration for the qTestnet chain. + +## Description + +Chain ID: 35443 +Chain Name: Q Testnet +Default Block Explorer: https://explorer.qtestnet.org +Default RPC URL: https://rpc.qtestnet.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { qTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: qTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/qTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/real.md b/tevm/docs/common/variables/real.md new file mode 100644 index 0000000000..c9506861c5 --- /dev/null +++ b/tevm/docs/common/variables/real.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / real + +# Variable: real + +> `const` **real**: `Common` + +Creates a common configuration for the real chain. + +## Description + +Chain ID: 111188 +Chain Name: re.al +Default Block Explorer: https://explorer.re.al +Default RPC URL: https://real.drpc.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { real } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: real, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/real.d.ts:21 diff --git a/tevm/docs/common/variables/redbellyTestnet.md b/tevm/docs/common/variables/redbellyTestnet.md new file mode 100644 index 0000000000..d5c486a9d4 --- /dev/null +++ b/tevm/docs/common/variables/redbellyTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / redbellyTestnet + +# Variable: redbellyTestnet + +> `const` **redbellyTestnet**: `Common` + +Creates a common configuration for the redbellyTestnet chain. + +## Description + +Chain ID: 153 +Chain Name: Redbelly Network Testnet +Default Block Explorer: https://explorer.testnet.redbelly.network +Default RPC URL: https://governors.testnet.redbelly.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { redbellyTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: redbellyTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/redbellyTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/redstone.md b/tevm/docs/common/variables/redstone.md new file mode 100644 index 0000000000..5e8cb57d31 --- /dev/null +++ b/tevm/docs/common/variables/redstone.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / redstone + +# Variable: redstone + +> `const` **redstone**: `Common` + +Creates a common configuration for the redstone chain. + +## Description + +Chain ID: 690 +Chain Name: Redstone +Default Block Explorer: https://explorer.redstone.xyz +Default RPC URL: https://rpc.redstonechain.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { redstone } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: redstone, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/redstone.d.ts:21 diff --git a/tevm/docs/common/variables/reyaNetwork.md b/tevm/docs/common/variables/reyaNetwork.md new file mode 100644 index 0000000000..eba31f39d1 --- /dev/null +++ b/tevm/docs/common/variables/reyaNetwork.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / reyaNetwork + +# Variable: reyaNetwork + +> `const` **reyaNetwork**: `Common` + +Creates a common configuration for the reyaNetwork chain. + +## Description + +Chain ID: 1729 +Chain Name: Reya Network +Default Block Explorer: https://explorer.reya.network +Default RPC URL: https://rpc.reya.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { reyaNetwork } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: reyaNetwork, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/reyaNetwork.d.ts:21 diff --git a/tevm/docs/common/variables/rollux.md b/tevm/docs/common/variables/rollux.md new file mode 100644 index 0000000000..3eb03270a0 --- /dev/null +++ b/tevm/docs/common/variables/rollux.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / rollux + +# Variable: rollux + +> `const` **rollux**: `Common` + +Creates a common configuration for the rollux chain. + +## Description + +Chain ID: 570 +Chain Name: Rollux Mainnet +Default Block Explorer: https://explorer.rollux.com +Default RPC URL: https://rpc.rollux.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { rollux } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: rollux, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/rollux.d.ts:21 diff --git a/tevm/docs/common/variables/rolluxTestnet.md b/tevm/docs/common/variables/rolluxTestnet.md new file mode 100644 index 0000000000..548339400e --- /dev/null +++ b/tevm/docs/common/variables/rolluxTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / rolluxTestnet + +# Variable: rolluxTestnet + +> `const` **rolluxTestnet**: `Common` + +Creates a common configuration for the rolluxTestnet chain. + +## Description + +Chain ID: 57000 +Chain Name: Rollux Testnet +Default Block Explorer: https://rollux.tanenbaum.io +Default RPC URL: https://rpc-tanenbaum.rollux.com/ + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { rolluxTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: rolluxTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/rolluxTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/ronin.md b/tevm/docs/common/variables/ronin.md new file mode 100644 index 0000000000..af9fc2dedf --- /dev/null +++ b/tevm/docs/common/variables/ronin.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / ronin + +# Variable: ronin + +> `const` **ronin**: `Common` + +Creates a common configuration for the ronin chain. + +## Description + +Chain ID: 2020 +Chain Name: Ronin +Default Block Explorer: https://app.roninchain.com +Default RPC URL: https://api.roninchain.com/rpc + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { ronin } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: ronin, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/ronin.d.ts:21 diff --git a/tevm/docs/common/variables/root.md b/tevm/docs/common/variables/root.md new file mode 100644 index 0000000000..8df57386bf --- /dev/null +++ b/tevm/docs/common/variables/root.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / root + +# Variable: root + +> `const` **root**: `Common` + +Creates a common configuration for the root chain. + +## Description + +Chain ID: 7668 +Chain Name: The Root Network +Default Block Explorer: https://rootscan.io +Default RPC URL: https://root.rootnet.live/archive + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { root } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: root, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/root.d.ts:21 diff --git a/tevm/docs/common/variables/rootPorcini.md b/tevm/docs/common/variables/rootPorcini.md new file mode 100644 index 0000000000..04e68f88ce --- /dev/null +++ b/tevm/docs/common/variables/rootPorcini.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / rootPorcini + +# Variable: rootPorcini + +> `const` **rootPorcini**: `Common` + +Creates a common configuration for the rootPorcini chain. + +## Description + +Chain ID: 7672 +Chain Name: The Root Network - Porcini +Default Block Explorer: https://porcini.rootscan.io +Default RPC URL: https://porcini.rootnet.app/archive + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { rootPorcini } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: rootPorcini, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/rootPorcini.d.ts:21 diff --git a/tevm/docs/common/variables/rootstock.md b/tevm/docs/common/variables/rootstock.md new file mode 100644 index 0000000000..f4b395ca26 --- /dev/null +++ b/tevm/docs/common/variables/rootstock.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / rootstock + +# Variable: rootstock + +> `const` **rootstock**: `Common` + +Creates a common configuration for the rootstock chain. + +## Description + +Chain ID: 30 +Chain Name: Rootstock Mainnet +Default Block Explorer: https://explorer.rsk.co +Default RPC URL: https://public-node.rsk.co + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { rootstock } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: rootstock, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/rootstock.d.ts:21 diff --git a/tevm/docs/common/variables/rootstockTestnet.md b/tevm/docs/common/variables/rootstockTestnet.md new file mode 100644 index 0000000000..db5944ed27 --- /dev/null +++ b/tevm/docs/common/variables/rootstockTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / rootstockTestnet + +# Variable: rootstockTestnet + +> `const` **rootstockTestnet**: `Common` + +Creates a common configuration for the rootstockTestnet chain. + +## Description + +Chain ID: 31 +Chain Name: Rootstock Testnet +Default Block Explorer: https://explorer.testnet.rootstock.io +Default RPC URL: https://public-node.testnet.rsk.co + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { rootstockTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: rootstockTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/rootstockTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/rss3.md b/tevm/docs/common/variables/rss3.md new file mode 100644 index 0000000000..4d59e67073 --- /dev/null +++ b/tevm/docs/common/variables/rss3.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / rss3 + +# Variable: rss3 + +> `const` **rss3**: `Common` + +Creates a common configuration for the rss3 chain. + +## Description + +Chain ID: 12553 +Chain Name: RSS3 VSL Mainnet +Default Block Explorer: https://scan.rss3.io +Default RPC URL: https://rpc.rss3.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { rss3 } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: rss3, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/rss3.d.ts:21 diff --git a/tevm/docs/common/variables/rss3Sepolia.md b/tevm/docs/common/variables/rss3Sepolia.md new file mode 100644 index 0000000000..cb6dbfb4dc --- /dev/null +++ b/tevm/docs/common/variables/rss3Sepolia.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / rss3Sepolia + +# Variable: rss3Sepolia + +> `const` **rss3Sepolia**: `Common` + +Creates a common configuration for the rss3Sepolia chain. + +## Description + +Chain ID: 2331 +Chain Name: RSS3 VSL Sepolia Testnet +Default Block Explorer: https://scan.testnet.rss3.io +Default RPC URL: https://rpc.testnet.rss3.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { rss3Sepolia } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: rss3Sepolia, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/rss3Sepolia.d.ts:21 diff --git a/tevm/docs/common/variables/saigon.md b/tevm/docs/common/variables/saigon.md new file mode 100644 index 0000000000..995aeab29b --- /dev/null +++ b/tevm/docs/common/variables/saigon.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / saigon + +# Variable: saigon + +> `const` **saigon**: `Common` + +Creates a common configuration for the saigon chain. + +## Description + +Chain ID: 2021 +Chain Name: Saigon Testnet +Default Block Explorer: https://saigon-app.roninchain.com +Default RPC URL: https://saigon-testnet.roninchain.com/rpc + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { saigon } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: saigon, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/saigon.d.ts:21 diff --git a/tevm/docs/common/variables/sapphire.md b/tevm/docs/common/variables/sapphire.md new file mode 100644 index 0000000000..88916d281e --- /dev/null +++ b/tevm/docs/common/variables/sapphire.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / sapphire + +# Variable: sapphire + +> `const` **sapphire**: `Common` + +Creates a common configuration for the sapphire chain. + +## Description + +Chain ID: 23294 +Chain Name: Oasis Sapphire +Default Block Explorer: https://explorer.oasis.io/mainnet/sapphire +Default RPC URL: https://sapphire.oasis.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { sapphire } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: sapphire, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/sapphire.d.ts:21 diff --git a/tevm/docs/common/variables/sapphireTestnet.md b/tevm/docs/common/variables/sapphireTestnet.md new file mode 100644 index 0000000000..411956b911 --- /dev/null +++ b/tevm/docs/common/variables/sapphireTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / sapphireTestnet + +# Variable: sapphireTestnet + +> `const` **sapphireTestnet**: `Common` + +Creates a common configuration for the sapphireTestnet chain. + +## Description + +Chain ID: 23295 +Chain Name: Oasis Sapphire Testnet +Default Block Explorer: https://explorer.oasis.io/testnet/sapphire +Default RPC URL: https://testnet.sapphire.oasis.dev + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { sapphireTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: sapphireTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/sapphireTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/satoshiVM.md b/tevm/docs/common/variables/satoshiVM.md new file mode 100644 index 0000000000..6500234972 --- /dev/null +++ b/tevm/docs/common/variables/satoshiVM.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / satoshiVM + +# Variable: satoshiVM + +> `const` **satoshiVM**: `Common` + +Creates a common configuration for the satoshiVM chain. + +## Description + +Chain ID: 3109 +Chain Name: SatoshiVM Alpha Mainnet +Default Block Explorer: https://svmscan.io +Default RPC URL: https://alpha-rpc-node-http.svmscan.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { satoshiVM } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: satoshiVM, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/satoshiVM.d.ts:21 diff --git a/tevm/docs/common/variables/satoshiVMTestnet.md b/tevm/docs/common/variables/satoshiVMTestnet.md new file mode 100644 index 0000000000..7913f4c30e --- /dev/null +++ b/tevm/docs/common/variables/satoshiVMTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / satoshiVMTestnet + +# Variable: satoshiVMTestnet + +> `const` **satoshiVMTestnet**: `Common` + +Creates a common configuration for the satoshiVMTestnet chain. + +## Description + +Chain ID: 3110 +Chain Name: SatoshiVM Testnet +Default Block Explorer: https://testnet.svmscan.io +Default RPC URL: https://test-rpc-node-http.svmscan.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { satoshiVMTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: satoshiVMTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/satoshiVMTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/scroll.md b/tevm/docs/common/variables/scroll.md new file mode 100644 index 0000000000..cbd05bfb17 --- /dev/null +++ b/tevm/docs/common/variables/scroll.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / scroll + +# Variable: scroll + +> `const` **scroll**: `Common` + +Creates a common configuration for the scroll chain. + +## Description + +Chain ID: 534352 +Chain Name: Scroll +Default Block Explorer: https://scrollscan.com +Default RPC URL: https://rpc.scroll.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { scroll } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: scroll, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/scroll.d.ts:21 diff --git a/tevm/docs/common/variables/scrollSepolia.md b/tevm/docs/common/variables/scrollSepolia.md new file mode 100644 index 0000000000..de94b691e0 --- /dev/null +++ b/tevm/docs/common/variables/scrollSepolia.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / scrollSepolia + +# Variable: scrollSepolia + +> `const` **scrollSepolia**: `Common` + +Creates a common configuration for the scrollSepolia chain. + +## Description + +Chain ID: 534351 +Chain Name: Scroll Sepolia +Default Block Explorer: https://sepolia.scrollscan.com +Default RPC URL: https://sepolia-rpc.scroll.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { scrollSepolia } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: scrollSepolia, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/scrollSepolia.d.ts:21 diff --git a/tevm/docs/common/variables/sei.md b/tevm/docs/common/variables/sei.md new file mode 100644 index 0000000000..138cadf9f7 --- /dev/null +++ b/tevm/docs/common/variables/sei.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / sei + +# Variable: sei + +> `const` **sei**: `Common` + +Creates a common configuration for the sei chain. + +## Description + +Chain ID: 1329 +Chain Name: Sei Network +Default Block Explorer: https://seitrace.com +Default RPC URL: https://evm-rpc.sei-apis.com/ + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { sei } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: sei, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/sei.d.ts:21 diff --git a/tevm/docs/common/variables/seiDevnet.md b/tevm/docs/common/variables/seiDevnet.md new file mode 100644 index 0000000000..015434f67f --- /dev/null +++ b/tevm/docs/common/variables/seiDevnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / seiDevnet + +# Variable: seiDevnet + +> `const` **seiDevnet**: `Common` + +Creates a common configuration for the seiDevnet chain. + +## Description + +Chain ID: 713715 +Chain Name: Sei Devnet +Default Block Explorer: https://seitrace.com +Default RPC URL: https://evm-rpc-arctic-1.sei-apis.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { seiDevnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: seiDevnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/seiDevnet.d.ts:21 diff --git a/tevm/docs/common/variables/seiTestnet.md b/tevm/docs/common/variables/seiTestnet.md new file mode 100644 index 0000000000..af186a780c --- /dev/null +++ b/tevm/docs/common/variables/seiTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / seiTestnet + +# Variable: seiTestnet + +> `const` **seiTestnet**: `Common` + +Creates a common configuration for the seiTestnet chain. + +## Description + +Chain ID: 1328 +Chain Name: Sei Testnet +Default Block Explorer: https://seitrace.com +Default RPC URL: https://evm-rpc-testnet.sei-apis.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { seiTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: seiTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/seiTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/sepolia.md b/tevm/docs/common/variables/sepolia.md index 204588d357..effb1cd035 100644 --- a/tevm/docs/common/variables/sepolia.md +++ b/tevm/docs/common/variables/sepolia.md @@ -8,6 +8,30 @@ > `const` **sepolia**: `Common` +Creates a common configuration for the sepolia chain. + +## Description + +Chain ID: 11155111 +Chain Name: Sepolia +Default Block Explorer: https://sepolia.etherscan.io +Default RPC URL: https://rpc.sepolia.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { sepolia } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: sepolia, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + ## Defined in -packages/common/types/presets/sepolia.d.ts:1 +packages/common/types/presets/sepolia.d.ts:21 diff --git a/tevm/docs/common/variables/shapeSepolia.md b/tevm/docs/common/variables/shapeSepolia.md new file mode 100644 index 0000000000..04021c1141 --- /dev/null +++ b/tevm/docs/common/variables/shapeSepolia.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / shapeSepolia + +# Variable: shapeSepolia + +> `const` **shapeSepolia**: `Common` + +Creates a common configuration for the shapeSepolia chain. + +## Description + +Chain ID: 11011 +Chain Name: Shape Sepolia Testnet +Default Block Explorer: https://shape-sepolia-explorer.alchemy.com +Default RPC URL: https://sepolia.shape.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { shapeSepolia } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: shapeSepolia, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/shapeSepolia.d.ts:21 diff --git a/tevm/docs/common/variables/shardeumSphinx.md b/tevm/docs/common/variables/shardeumSphinx.md new file mode 100644 index 0000000000..59ed3a04ff --- /dev/null +++ b/tevm/docs/common/variables/shardeumSphinx.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / shardeumSphinx + +# Variable: shardeumSphinx + +> `const` **shardeumSphinx**: `Common` + +Creates a common configuration for the shardeumSphinx chain. + +## Description + +Chain ID: 8082 +Chain Name: Shardeum Sphinx +Default Block Explorer: https://explorer-sphinx.shardeum.org +Default RPC URL: https://sphinx.shardeum.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { shardeumSphinx } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: shardeumSphinx, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/shardeumSphinx.d.ts:21 diff --git a/tevm/docs/common/variables/shibarium.md b/tevm/docs/common/variables/shibarium.md new file mode 100644 index 0000000000..75aadcdbaa --- /dev/null +++ b/tevm/docs/common/variables/shibarium.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / shibarium + +# Variable: shibarium + +> `const` **shibarium**: `Common` + +Creates a common configuration for the shibarium chain. + +## Description + +Chain ID: 109 +Chain Name: Shibarium +Default Block Explorer: https://shibariumscan.io +Default RPC URL: https://rpc.shibrpc.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { shibarium } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: shibarium, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/shibarium.d.ts:21 diff --git a/tevm/docs/common/variables/shibariumTestnet.md b/tevm/docs/common/variables/shibariumTestnet.md new file mode 100644 index 0000000000..42c6a21719 --- /dev/null +++ b/tevm/docs/common/variables/shibariumTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / shibariumTestnet + +# Variable: shibariumTestnet + +> `const` **shibariumTestnet**: `Common` + +Creates a common configuration for the shibariumTestnet chain. + +## Description + +Chain ID: 157 +Chain Name: Puppynet Shibarium +Default Block Explorer: https://puppyscan.shib.io +Default RPC URL: https://puppynet.shibrpc.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { shibariumTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: shibariumTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/shibariumTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/shimmer.md b/tevm/docs/common/variables/shimmer.md new file mode 100644 index 0000000000..4e0a6c7ba3 --- /dev/null +++ b/tevm/docs/common/variables/shimmer.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / shimmer + +# Variable: shimmer + +> `const` **shimmer**: `Common` + +Creates a common configuration for the shimmer chain. + +## Description + +Chain ID: 148 +Chain Name: Shimmer +Default Block Explorer: https://explorer.evm.shimmer.network +Default RPC URL: https://json-rpc.evm.shimmer.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { shimmer } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: shimmer, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/shimmer.d.ts:21 diff --git a/tevm/docs/common/variables/shimmerTestnet.md b/tevm/docs/common/variables/shimmerTestnet.md new file mode 100644 index 0000000000..a81f7eadf1 --- /dev/null +++ b/tevm/docs/common/variables/shimmerTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / shimmerTestnet + +# Variable: shimmerTestnet + +> `const` **shimmerTestnet**: `Common` + +Creates a common configuration for the shimmerTestnet chain. + +## Description + +Chain ID: 1073 +Chain Name: Shimmer Testnet +Default Block Explorer: https://explorer.evm.testnet.shimmer.network +Default RPC URL: https://json-rpc.evm.testnet.shimmer.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { shimmerTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: shimmerTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/shimmerTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/skaleBlockBrawlers.md b/tevm/docs/common/variables/skaleBlockBrawlers.md new file mode 100644 index 0000000000..530d1cb5f8 --- /dev/null +++ b/tevm/docs/common/variables/skaleBlockBrawlers.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / skaleBlockBrawlers + +# Variable: skaleBlockBrawlers + +> `const` **skaleBlockBrawlers**: `Common` + +Creates a common configuration for the skaleBlockBrawlers chain. + +## Description + +Chain ID: 391845894 +Chain Name: SKALE | Block Brawlers +Default Block Explorer: https://frayed-decent-antares.explorer.mainnet.skalenodes.com +Default RPC URL: https://mainnet.skalenodes.com/v1/frayed-decent-antares + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { skaleBlockBrawlers } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: skaleBlockBrawlers, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/skaleBlockBrawlers.d.ts:21 diff --git a/tevm/docs/common/variables/skaleCalypso.md b/tevm/docs/common/variables/skaleCalypso.md new file mode 100644 index 0000000000..9801c628cc --- /dev/null +++ b/tevm/docs/common/variables/skaleCalypso.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / skaleCalypso + +# Variable: skaleCalypso + +> `const` **skaleCalypso**: `Common` + +Creates a common configuration for the skaleCalypso chain. + +## Description + +Chain ID: 1564830818 +Chain Name: SKALE | Calypso NFT Hub +Default Block Explorer: https://honorable-steel-rasalhague.explorer.mainnet.skalenodes.com +Default RPC URL: https://mainnet.skalenodes.com/v1/honorable-steel-rasalhague + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { skaleCalypso } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: skaleCalypso, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/skaleCalypso.d.ts:21 diff --git a/tevm/docs/common/variables/skaleCalypsoTestnet.md b/tevm/docs/common/variables/skaleCalypsoTestnet.md new file mode 100644 index 0000000000..53ec2deee0 --- /dev/null +++ b/tevm/docs/common/variables/skaleCalypsoTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / skaleCalypsoTestnet + +# Variable: skaleCalypsoTestnet + +> `const` **skaleCalypsoTestnet**: `Common` + +Creates a common configuration for the skaleCalypsoTestnet chain. + +## Description + +Chain ID: 974399131 +Chain Name: SKALE Calypso Testnet +Default Block Explorer: https://giant-half-dual-testnet.explorer.testnet.skalenodes.com +Default RPC URL: https://testnet.skalenodes.com/v1/giant-half-dual-testnet + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { skaleCalypsoTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: skaleCalypsoTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/skaleCalypsoTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/skaleCryptoBlades.md b/tevm/docs/common/variables/skaleCryptoBlades.md new file mode 100644 index 0000000000..6ade0f1143 --- /dev/null +++ b/tevm/docs/common/variables/skaleCryptoBlades.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / skaleCryptoBlades + +# Variable: skaleCryptoBlades + +> `const` **skaleCryptoBlades**: `Common` + +Creates a common configuration for the skaleCryptoBlades chain. + +## Description + +Chain ID: 1026062157 +Chain Name: SKALE | CryptoBlades +Default Block Explorer: https://affectionate-immediate-pollux.explorer.mainnet.skalenodes.com +Default RPC URL: https://mainnet.skalenodes.com/v1/affectionate-immediate-pollux + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { skaleCryptoBlades } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: skaleCryptoBlades, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/skaleCryptoBlades.d.ts:21 diff --git a/tevm/docs/common/variables/skaleCryptoColosseum.md b/tevm/docs/common/variables/skaleCryptoColosseum.md new file mode 100644 index 0000000000..a70b8fcfd6 --- /dev/null +++ b/tevm/docs/common/variables/skaleCryptoColosseum.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / skaleCryptoColosseum + +# Variable: skaleCryptoColosseum + +> `const` **skaleCryptoColosseum**: `Common` + +Creates a common configuration for the skaleCryptoColosseum chain. + +## Description + +Chain ID: 1032942172 +Chain Name: SKALE | Crypto Colosseum +Default Block Explorer: https://haunting-devoted-deneb.explorer.mainnet.skalenodes.com +Default RPC URL: https://mainnet.skalenodes.com/v1/haunting-devoted-deneb + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { skaleCryptoColosseum } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: skaleCryptoColosseum, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/skaleCryptoColosseum.d.ts:21 diff --git a/tevm/docs/common/variables/skaleEuropa.md b/tevm/docs/common/variables/skaleEuropa.md new file mode 100644 index 0000000000..3e2baf59dc --- /dev/null +++ b/tevm/docs/common/variables/skaleEuropa.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / skaleEuropa + +# Variable: skaleEuropa + +> `const` **skaleEuropa**: `Common` + +Creates a common configuration for the skaleEuropa chain. + +## Description + +Chain ID: 2046399126 +Chain Name: SKALE | Europa Liquidity Hub +Default Block Explorer: https://elated-tan-skat.explorer.mainnet.skalenodes.com +Default RPC URL: https://mainnet.skalenodes.com/v1/elated-tan-skat + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { skaleEuropa } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: skaleEuropa, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/skaleEuropa.d.ts:21 diff --git a/tevm/docs/common/variables/skaleEuropaTestnet.md b/tevm/docs/common/variables/skaleEuropaTestnet.md new file mode 100644 index 0000000000..0a7b57b7d9 --- /dev/null +++ b/tevm/docs/common/variables/skaleEuropaTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / skaleEuropaTestnet + +# Variable: skaleEuropaTestnet + +> `const` **skaleEuropaTestnet**: `Common` + +Creates a common configuration for the skaleEuropaTestnet chain. + +## Description + +Chain ID: 1444673419 +Chain Name: SKALE Europa Testnet +Default Block Explorer: https://juicy-low-small-testnet.explorer.testnet.skalenodes.com +Default RPC URL: https://testnet.skalenodes.com/v1/juicy-low-small-testnet + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { skaleEuropaTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: skaleEuropaTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/skaleEuropaTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/skaleExorde.md b/tevm/docs/common/variables/skaleExorde.md new file mode 100644 index 0000000000..c768fe3662 --- /dev/null +++ b/tevm/docs/common/variables/skaleExorde.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / skaleExorde + +# Variable: skaleExorde + +> `const` **skaleExorde**: `Common` + +Creates a common configuration for the skaleExorde chain. + +## Description + +Chain ID: 2139927552 +Chain Name: SKALE | Exorde +Default Block Explorer: https://light-vast-diphda.explorer.mainnet.skalenodes.com +Default RPC URL: https://mainnet.skalenodes.com/v1/light-vast-diphda + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { skaleExorde } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: skaleExorde, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/skaleExorde.d.ts:21 diff --git a/tevm/docs/common/variables/skaleHumanProtocol.md b/tevm/docs/common/variables/skaleHumanProtocol.md new file mode 100644 index 0000000000..c0d1a08572 --- /dev/null +++ b/tevm/docs/common/variables/skaleHumanProtocol.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / skaleHumanProtocol + +# Variable: skaleHumanProtocol + +> `const` **skaleHumanProtocol**: `Common` + +Creates a common configuration for the skaleHumanProtocol chain. + +## Description + +Chain ID: 1273227453 +Chain Name: SKALE | Human Protocol +Default Block Explorer: https://wan-red-ain.explorer.mainnet.skalenodes.com +Default RPC URL: https://mainnet.skalenodes.com/v1/wan-red-ain + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { skaleHumanProtocol } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: skaleHumanProtocol, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/skaleHumanProtocol.d.ts:21 diff --git a/tevm/docs/common/variables/skaleNebula.md b/tevm/docs/common/variables/skaleNebula.md new file mode 100644 index 0000000000..86fb0a036d --- /dev/null +++ b/tevm/docs/common/variables/skaleNebula.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / skaleNebula + +# Variable: skaleNebula + +> `const` **skaleNebula**: `Common` + +Creates a common configuration for the skaleNebula chain. + +## Description + +Chain ID: 1482601649 +Chain Name: SKALE | Nebula Gaming Hub +Default Block Explorer: https://green-giddy-denebola.explorer.mainnet.skalenodes.com +Default RPC URL: https://mainnet.skalenodes.com/v1/green-giddy-denebola + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { skaleNebula } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: skaleNebula, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/skaleNebula.d.ts:21 diff --git a/tevm/docs/common/variables/skaleNebulaTestnet.md b/tevm/docs/common/variables/skaleNebulaTestnet.md new file mode 100644 index 0000000000..ce246be527 --- /dev/null +++ b/tevm/docs/common/variables/skaleNebulaTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / skaleNebulaTestnet + +# Variable: skaleNebulaTestnet + +> `const` **skaleNebulaTestnet**: `Common` + +Creates a common configuration for the skaleNebulaTestnet chain. + +## Description + +Chain ID: 37084624 +Chain Name: SKALE Nebula Testnet +Default Block Explorer: https://lanky-ill-funny-testnet.explorer.testnet.skalenodes.com +Default RPC URL: https://testnet.skalenodes.com/v1/lanky-ill-funny-testnet + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { skaleNebulaTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: skaleNebulaTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/skaleNebulaTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/skaleRazor.md b/tevm/docs/common/variables/skaleRazor.md new file mode 100644 index 0000000000..dd7c544dd6 --- /dev/null +++ b/tevm/docs/common/variables/skaleRazor.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / skaleRazor + +# Variable: skaleRazor + +> `const` **skaleRazor**: `Common` + +Creates a common configuration for the skaleRazor chain. + +## Description + +Chain ID: 278611351 +Chain Name: SKALE | Razor Network +Default Block Explorer: https://turbulent-unique-scheat.explorer.mainnet.skalenodes.com +Default RPC URL: https://mainnet.skalenodes.com/v1/turbulent-unique-scheat + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { skaleRazor } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: skaleRazor, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/skaleRazor.d.ts:21 diff --git a/tevm/docs/common/variables/skaleTitan.md b/tevm/docs/common/variables/skaleTitan.md new file mode 100644 index 0000000000..b70d81d9af --- /dev/null +++ b/tevm/docs/common/variables/skaleTitan.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / skaleTitan + +# Variable: skaleTitan + +> `const` **skaleTitan**: `Common` + +Creates a common configuration for the skaleTitan chain. + +## Description + +Chain ID: 1350216234 +Chain Name: SKALE | Titan Community Hub +Default Block Explorer: https://parallel-stormy-spica.explorer.mainnet.skalenodes.com +Default RPC URL: https://mainnet.skalenodes.com/v1/parallel-stormy-spica + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { skaleTitan } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: skaleTitan, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/skaleTitan.d.ts:21 diff --git a/tevm/docs/common/variables/skaleTitanTestnet.md b/tevm/docs/common/variables/skaleTitanTestnet.md new file mode 100644 index 0000000000..8f4bef013c --- /dev/null +++ b/tevm/docs/common/variables/skaleTitanTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / skaleTitanTestnet + +# Variable: skaleTitanTestnet + +> `const` **skaleTitanTestnet**: `Common` + +Creates a common configuration for the skaleTitanTestnet chain. + +## Description + +Chain ID: 1020352220 +Chain Name: SKALE Titan Hub +Default Block Explorer: https://aware-fake-trim-testnet.explorer.testnet.skalenodes.com +Default RPC URL: https://testnet.skalenodes.com/v1/aware-fake-trim-testnet + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { skaleTitanTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: skaleTitanTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/skaleTitanTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/sketchpad.md b/tevm/docs/common/variables/sketchpad.md new file mode 100644 index 0000000000..f1120a1326 --- /dev/null +++ b/tevm/docs/common/variables/sketchpad.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / sketchpad + +# Variable: sketchpad + +> `const` **sketchpad**: `Common` + +Creates a common configuration for the sketchpad chain. + +## Description + +Chain ID: 984123 +Chain Name: Forma Sketchpad +Default Block Explorer: https://explorer.sketchpad-1.forma.art +Default RPC URL: https://rpc.sketchpad-1.forma.art + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { sketchpad } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: sketchpad, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/sketchpad.d.ts:21 diff --git a/tevm/docs/common/variables/soneiumMinato.md b/tevm/docs/common/variables/soneiumMinato.md new file mode 100644 index 0000000000..217967f9de --- /dev/null +++ b/tevm/docs/common/variables/soneiumMinato.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / soneiumMinato + +# Variable: soneiumMinato + +> `const` **soneiumMinato**: `Common` + +Creates a common configuration for the soneiumMinato chain. + +## Description + +Chain ID: 1946 +Chain Name: Soneium Minato +Default Block Explorer: https://explorer-testnet.soneium.org +Default RPC URL: https://rpc.minato.soneium.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { soneiumMinato } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: soneiumMinato, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/soneiumMinato.d.ts:21 diff --git a/tevm/docs/common/variables/songbird.md b/tevm/docs/common/variables/songbird.md new file mode 100644 index 0000000000..18b0d52e85 --- /dev/null +++ b/tevm/docs/common/variables/songbird.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / songbird + +# Variable: songbird + +> `const` **songbird**: `Common` + +Creates a common configuration for the songbird chain. + +## Description + +Chain ID: 19 +Chain Name: Songbird Mainnet +Default Block Explorer: https://songbird-explorer.flare.network +Default RPC URL: https://songbird-api.flare.network/ext/C/rpc + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { songbird } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: songbird, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/songbird.d.ts:21 diff --git a/tevm/docs/common/variables/songbirdTestnet.md b/tevm/docs/common/variables/songbirdTestnet.md new file mode 100644 index 0000000000..55f0f40a3c --- /dev/null +++ b/tevm/docs/common/variables/songbirdTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / songbirdTestnet + +# Variable: songbirdTestnet + +> `const` **songbirdTestnet**: `Common` + +Creates a common configuration for the songbirdTestnet chain. + +## Description + +Chain ID: 16 +Chain Name: Coston +Default Block Explorer: https://coston-explorer.flare.network +Default RPC URL: https://coston-api.flare.network/ext/C/rpc + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { songbirdTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: songbirdTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/songbirdTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/sophonTestnet.md b/tevm/docs/common/variables/sophonTestnet.md new file mode 100644 index 0000000000..a2021cea79 --- /dev/null +++ b/tevm/docs/common/variables/sophonTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / sophonTestnet + +# Variable: sophonTestnet + +> `const` **sophonTestnet**: `Common` + +Creates a common configuration for the sophonTestnet chain. + +## Description + +Chain ID: 531050104 +Chain Name: Sophon Testnet +Default Block Explorer: https://explorer.testnet.sophon.xyz +Default RPC URL: https://rpc.testnet.sophon.xyz + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { sophonTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: sophonTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/sophonTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/spicy.md b/tevm/docs/common/variables/spicy.md new file mode 100644 index 0000000000..55d5ba158d --- /dev/null +++ b/tevm/docs/common/variables/spicy.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / spicy + +# Variable: spicy + +> `const` **spicy**: `Common` + +Creates a common configuration for the spicy chain. + +## Description + +Chain ID: 88882 +Chain Name: Chiliz Spicy Testnet +Default Block Explorer: http://spicy-explorer.chiliz.com +Default RPC URL: https://spicy-rpc.chiliz.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { spicy } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: spicy, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/spicy.d.ts:21 diff --git a/tevm/docs/common/variables/storyTestnet.md b/tevm/docs/common/variables/storyTestnet.md new file mode 100644 index 0000000000..6679b88477 --- /dev/null +++ b/tevm/docs/common/variables/storyTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / storyTestnet + +# Variable: storyTestnet + +> `const` **storyTestnet**: `Common` + +Creates a common configuration for the storyTestnet chain. + +## Description + +Chain ID: 1513 +Chain Name: Story Testnet +Default Block Explorer: https://testnet.storyscan.xyz +Default RPC URL: https://testnet.storyrpc.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { storyTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: storyTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/storyTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/stratis.md b/tevm/docs/common/variables/stratis.md new file mode 100644 index 0000000000..2335090367 --- /dev/null +++ b/tevm/docs/common/variables/stratis.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / stratis + +# Variable: stratis + +> `const` **stratis**: `Common` + +Creates a common configuration for the stratis chain. + +## Description + +Chain ID: 105105 +Chain Name: Stratis Mainnet +Default Block Explorer: https://explorer.stratisevm.com +Default RPC URL: https://rpc.stratisevm.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { stratis } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: stratis, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/stratis.d.ts:21 diff --git a/tevm/docs/common/variables/syscoin.md b/tevm/docs/common/variables/syscoin.md new file mode 100644 index 0000000000..5bb849190e --- /dev/null +++ b/tevm/docs/common/variables/syscoin.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / syscoin + +# Variable: syscoin + +> `const` **syscoin**: `Common` + +Creates a common configuration for the syscoin chain. + +## Description + +Chain ID: 57 +Chain Name: Syscoin Mainnet +Default Block Explorer: https://explorer.syscoin.org +Default RPC URL: https://rpc.syscoin.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { syscoin } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: syscoin, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/syscoin.d.ts:21 diff --git a/tevm/docs/common/variables/syscoinTestnet.md b/tevm/docs/common/variables/syscoinTestnet.md new file mode 100644 index 0000000000..fae4785969 --- /dev/null +++ b/tevm/docs/common/variables/syscoinTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / syscoinTestnet + +# Variable: syscoinTestnet + +> `const` **syscoinTestnet**: `Common` + +Creates a common configuration for the syscoinTestnet chain. + +## Description + +Chain ID: 5700 +Chain Name: Syscoin Tanenbaum Testnet +Default Block Explorer: https://tanenbaum.io +Default RPC URL: https://rpc.tanenbaum.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { syscoinTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: syscoinTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/syscoinTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/taiko.md b/tevm/docs/common/variables/taiko.md new file mode 100644 index 0000000000..7b4bf03f1a --- /dev/null +++ b/tevm/docs/common/variables/taiko.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / taiko + +# Variable: taiko + +> `const` **taiko**: `Common` + +Creates a common configuration for the taiko chain. + +## Description + +Chain ID: 167000 +Chain Name: Taiko Mainnet +Default Block Explorer: https://taikoscan.io +Default RPC URL: https://rpc.mainnet.taiko.xyz + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { taiko } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: taiko, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/taiko.d.ts:21 diff --git a/tevm/docs/common/variables/taikoHekla.md b/tevm/docs/common/variables/taikoHekla.md new file mode 100644 index 0000000000..41298051cf --- /dev/null +++ b/tevm/docs/common/variables/taikoHekla.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / taikoHekla + +# Variable: taikoHekla + +> `const` **taikoHekla**: `Common` + +Creates a common configuration for the taikoHekla chain. + +## Description + +Chain ID: 167009 +Chain Name: Taiko Hekla L2 +Default Block Explorer: https://hekla.taikoscan.network +Default RPC URL: https://rpc.hekla.taiko.xyz + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { taikoHekla } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: taikoHekla, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/taikoHekla.d.ts:21 diff --git a/tevm/docs/common/variables/taikoJolnir.md b/tevm/docs/common/variables/taikoJolnir.md new file mode 100644 index 0000000000..10bc166667 --- /dev/null +++ b/tevm/docs/common/variables/taikoJolnir.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / taikoJolnir + +# Variable: taikoJolnir + +> `const` **taikoJolnir**: `Common` + +Creates a common configuration for the taikoJolnir chain. + +## Description + +Chain ID: 167007 +Chain Name: Taiko Jolnir (Alpha-5 Testnet) +Default Block Explorer: https://explorer.jolnir.taiko.xyz +Default RPC URL: https://rpc.jolnir.taiko.xyz + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { taikoJolnir } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: taikoJolnir, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/taikoJolnir.d.ts:21 diff --git a/tevm/docs/common/variables/taikoKatla.md b/tevm/docs/common/variables/taikoKatla.md new file mode 100644 index 0000000000..6c6779f146 --- /dev/null +++ b/tevm/docs/common/variables/taikoKatla.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / taikoKatla + +# Variable: taikoKatla + +> `const` **taikoKatla**: `Common` + +Creates a common configuration for the taikoKatla chain. + +## Description + +Chain ID: 167008 +Chain Name: Taiko Katla (Alpha-6 Testnet) +Default Block Explorer: https://explorer.katla.taiko.xyz +Default RPC URL: https://rpc.katla.taiko.xyz + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { taikoKatla } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: taikoKatla, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/taikoKatla.d.ts:21 diff --git a/tevm/docs/common/variables/taikoTestnetSepolia.md b/tevm/docs/common/variables/taikoTestnetSepolia.md new file mode 100644 index 0000000000..1cd6eca141 --- /dev/null +++ b/tevm/docs/common/variables/taikoTestnetSepolia.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / taikoTestnetSepolia + +# Variable: taikoTestnetSepolia + +> `const` **taikoTestnetSepolia**: `Common` + +Creates a common configuration for the taikoTestnetSepolia chain. + +## Description + +Chain ID: 167005 +Chain Name: Taiko (Alpha-3 Testnet) +Default Block Explorer: https://explorer.test.taiko.xyz +Default RPC URL: https://rpc.test.taiko.xyz + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { taikoTestnetSepolia } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: taikoTestnetSepolia, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/taikoTestnetSepolia.d.ts:21 diff --git a/tevm/docs/common/variables/taraxa.md b/tevm/docs/common/variables/taraxa.md new file mode 100644 index 0000000000..4ca7c92e66 --- /dev/null +++ b/tevm/docs/common/variables/taraxa.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / taraxa + +# Variable: taraxa + +> `const` **taraxa**: `Common` + +Creates a common configuration for the taraxa chain. + +## Description + +Chain ID: 841 +Chain Name: Taraxa Mainnet +Default Block Explorer: https://explorer.mainnet.taraxa.io +Default RPC URL: https://rpc.mainnet.taraxa.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { taraxa } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: taraxa, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/taraxa.d.ts:21 diff --git a/tevm/docs/common/variables/taraxaTestnet.md b/tevm/docs/common/variables/taraxaTestnet.md new file mode 100644 index 0000000000..f38e1fef79 --- /dev/null +++ b/tevm/docs/common/variables/taraxaTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / taraxaTestnet + +# Variable: taraxaTestnet + +> `const` **taraxaTestnet**: `Common` + +Creates a common configuration for the taraxaTestnet chain. + +## Description + +Chain ID: 842 +Chain Name: Taraxa Testnet +Default Block Explorer: https://explorer.testnet.taraxa.io +Default RPC URL: https://rpc.testnet.taraxa.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { taraxaTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: taraxaTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/taraxaTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/telcoinTestnet.md b/tevm/docs/common/variables/telcoinTestnet.md new file mode 100644 index 0000000000..9e8572431e --- /dev/null +++ b/tevm/docs/common/variables/telcoinTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / telcoinTestnet + +# Variable: telcoinTestnet + +> `const` **telcoinTestnet**: `Common` + +Creates a common configuration for the telcoinTestnet chain. + +## Description + +Chain ID: 2017 +Chain Name: Telcoin Adiri Testnet +Default Block Explorer: https://telscan.io +Default RPC URL: https://rpc.telcoin.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { telcoinTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: telcoinTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/telcoinTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/telos.md b/tevm/docs/common/variables/telos.md new file mode 100644 index 0000000000..9d0ced6695 --- /dev/null +++ b/tevm/docs/common/variables/telos.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / telos + +# Variable: telos + +> `const` **telos**: `Common` + +Creates a common configuration for the telos chain. + +## Description + +Chain ID: 40 +Chain Name: Telos +Default Block Explorer: https://www.teloscan.io/ +Default RPC URL: https://mainnet.telos.net/evm + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { telos } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: telos, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/telos.d.ts:21 diff --git a/tevm/docs/common/variables/telosTestnet.md b/tevm/docs/common/variables/telosTestnet.md new file mode 100644 index 0000000000..bee4c8e86d --- /dev/null +++ b/tevm/docs/common/variables/telosTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / telosTestnet + +# Variable: telosTestnet + +> `const` **telosTestnet**: `Common` + +Creates a common configuration for the telosTestnet chain. + +## Description + +Chain ID: 41 +Chain Name: Telos +Default Block Explorer: https://testnet.teloscan.io/ +Default RPC URL: https://testnet.telos.net/evm + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { telosTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: telosTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/telosTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/tenet.md b/tevm/docs/common/variables/tenet.md new file mode 100644 index 0000000000..a4e1153880 --- /dev/null +++ b/tevm/docs/common/variables/tenet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / tenet + +# Variable: tenet + +> `const` **tenet**: `Common` + +Creates a common configuration for the tenet chain. + +## Description + +Chain ID: 1559 +Chain Name: Tenet +Default Block Explorer: https://tenetscan.io +Default RPC URL: https://rpc.tenet.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { tenet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: tenet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/tenet.d.ts:21 diff --git a/tevm/docs/common/variables/tevmDefault.md b/tevm/docs/common/variables/tevmDefault.md index 4d34fd8f9e..cdae05dba1 100644 --- a/tevm/docs/common/variables/tevmDefault.md +++ b/tevm/docs/common/variables/tevmDefault.md @@ -6,10 +6,120 @@ # Variable: tevmDefault -> `const` **tevmDefault**: `Common` +> `const` **tevmDefault**: `object` The default chain if no fork url is passed +## Type declaration + +### blockExplorers? + +> `optional` **blockExplorers**: `object` + +#### Index Signature + + \[`key`: `string`\]: `object` + +### blockExplorers.default + +> **default**: `object` + +### blockExplorers.default.apiUrl? + +> `optional` **apiUrl**: `string` + +### blockExplorers.default.name + +> **name**: `string` + +### blockExplorers.default.url + +> **url**: `string` + +### contracts? + +> `optional` **contracts**: `Prettify` + +### copy() + +> **copy**: () => `Common` + +#### Returns + +`Common` + +### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +### ethjsCommon + +> **ethjsCommon**: `Common` + +### fees? + +> `optional` **fees**: `ChainFees` + +### formatters? + +> `optional` **formatters**: `ChainFormatters` + +### id + +> **id**: `number` + +### name + +> **name**: `string` + +### nativeCurrency + +> **nativeCurrency**: `object` + +### nativeCurrency.decimals + +> **decimals**: `number` + +### nativeCurrency.name + +> **name**: `string` + +### nativeCurrency.symbol + +> **symbol**: `string` + +### rpcUrls + +> **rpcUrls**: `object` + +#### Index Signature + + \[`key`: `string`\]: `object` + +### rpcUrls.default + +> **default**: `object` + +### rpcUrls.default.http + +> **http**: readonly `string`[] + +### rpcUrls.default.webSocket? + +> `optional` **webSocket**: readonly `string`[] + +### serializers? + +> `optional` **serializers**: `ChainSerializers` + +### sourceId? + +> `optional` **sourceId**: `number` + +### testnet? + +> `optional` **testnet**: `boolean` + ## Defined in packages/common/types/presets/tevmDefault.d.ts:4 diff --git a/tevm/docs/common/variables/thaiChain.md b/tevm/docs/common/variables/thaiChain.md new file mode 100644 index 0000000000..6611322cdb --- /dev/null +++ b/tevm/docs/common/variables/thaiChain.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / thaiChain + +# Variable: thaiChain + +> `const` **thaiChain**: `Common` + +Creates a common configuration for the thaiChain chain. + +## Description + +Chain ID: 7 +Chain Name: ThaiChain +Default Block Explorer: https://exp.thaichain.org +Default RPC URL: https://rpc.thaichain.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { thaiChain } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: thaiChain, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/thaiChain.d.ts:21 diff --git a/tevm/docs/common/variables/thunderTestnet.md b/tevm/docs/common/variables/thunderTestnet.md new file mode 100644 index 0000000000..00502dddd3 --- /dev/null +++ b/tevm/docs/common/variables/thunderTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / thunderTestnet + +# Variable: thunderTestnet + +> `const` **thunderTestnet**: `Common` + +Creates a common configuration for the thunderTestnet chain. + +## Description + +Chain ID: 997 +Chain Name: 5ireChain Thunder Testnet +Default Block Explorer: https://explorer.5ire.network +Default RPC URL: https://rpc-testnet.5ire.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { thunderTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: thunderTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/thunderTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/tron.md b/tevm/docs/common/variables/tron.md new file mode 100644 index 0000000000..8356a01e06 --- /dev/null +++ b/tevm/docs/common/variables/tron.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / tron + +# Variable: tron + +> `const` **tron**: `Common` + +Creates a common configuration for the tron chain. + +## Description + +Chain ID: 728126428 +Chain Name: Tron +Default Block Explorer: https://tronscan.org +Default RPC URL: https://api.trongrid.io/jsonrpc + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { tron } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: tron, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/tron.d.ts:21 diff --git a/tevm/docs/common/variables/unreal.md b/tevm/docs/common/variables/unreal.md new file mode 100644 index 0000000000..c61edcaacb --- /dev/null +++ b/tevm/docs/common/variables/unreal.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / unreal + +# Variable: unreal + +> `const` **unreal**: `Common` + +Creates a common configuration for the unreal chain. + +## Description + +Chain ID: 18233 +Chain Name: Unreal +Default Block Explorer: https://unreal.blockscout.com +Default RPC URL: https://rpc.unreal-orbit.gelato.digital + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { unreal } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: unreal, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/unreal.d.ts:21 diff --git a/tevm/docs/common/variables/vechain.md b/tevm/docs/common/variables/vechain.md new file mode 100644 index 0000000000..dce5e79d14 --- /dev/null +++ b/tevm/docs/common/variables/vechain.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / vechain + +# Variable: vechain + +> `const` **vechain**: `Common` + +Creates a common configuration for the vechain chain. + +## Description + +Chain ID: 100009 +Chain Name: Vechain +Default Block Explorer: https://explore.vechain.org +Default RPC URL: https://mainnet.vechain.org + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { vechain } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: vechain, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/vechain.d.ts:21 diff --git a/tevm/docs/common/variables/wanchain.md b/tevm/docs/common/variables/wanchain.md new file mode 100644 index 0000000000..b2b4a06494 --- /dev/null +++ b/tevm/docs/common/variables/wanchain.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / wanchain + +# Variable: wanchain + +> `const` **wanchain**: `Common` + +Creates a common configuration for the wanchain chain. + +## Description + +Chain ID: 888 +Chain Name: Wanchain +Default Block Explorer: https://wanscan.org +Default RPC URL: https://gwan-ssl.wandevs.org:56891 + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { wanchain } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: wanchain, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/wanchain.d.ts:21 diff --git a/tevm/docs/common/variables/wanchainTestnet.md b/tevm/docs/common/variables/wanchainTestnet.md new file mode 100644 index 0000000000..1161f5ec88 --- /dev/null +++ b/tevm/docs/common/variables/wanchainTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / wanchainTestnet + +# Variable: wanchainTestnet + +> `const` **wanchainTestnet**: `Common` + +Creates a common configuration for the wanchainTestnet chain. + +## Description + +Chain ID: 999 +Chain Name: Wanchain Testnet +Default Block Explorer: https://wanscan.org +Default RPC URL: https://gwan-ssl.wandevs.org:46891 + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { wanchainTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: wanchainTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/wanchainTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/wemix.md b/tevm/docs/common/variables/wemix.md new file mode 100644 index 0000000000..36d872dbcb --- /dev/null +++ b/tevm/docs/common/variables/wemix.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / wemix + +# Variable: wemix + +> `const` **wemix**: `Common` + +Creates a common configuration for the wemix chain. + +## Description + +Chain ID: 1111 +Chain Name: WEMIX +Default Block Explorer: https://explorer.wemix.com +Default RPC URL: https://api.wemix.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { wemix } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: wemix, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/wemix.d.ts:21 diff --git a/tevm/docs/common/variables/wemixTestnet.md b/tevm/docs/common/variables/wemixTestnet.md new file mode 100644 index 0000000000..dea61589f2 --- /dev/null +++ b/tevm/docs/common/variables/wemixTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / wemixTestnet + +# Variable: wemixTestnet + +> `const` **wemixTestnet**: `Common` + +Creates a common configuration for the wemixTestnet chain. + +## Description + +Chain ID: 1112 +Chain Name: WEMIX Testnet +Default Block Explorer: https://testnet.wemixscan.com +Default RPC URL: https://api.test.wemix.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { wemixTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: wemixTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/wemixTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/x1Testnet.md b/tevm/docs/common/variables/x1Testnet.md new file mode 100644 index 0000000000..63630c927e --- /dev/null +++ b/tevm/docs/common/variables/x1Testnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / x1Testnet + +# Variable: x1Testnet + +> `const` **x1Testnet**: `Common` + +Creates a common configuration for the x1Testnet chain. + +## Description + +Chain ID: 195 +Chain Name: X1 Testnet +Default Block Explorer: https://www.oklink.com/xlayer-test +Default RPC URL: https://xlayertestrpc.okx.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { x1Testnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: x1Testnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/x1Testnet.d.ts:21 diff --git a/tevm/docs/common/variables/xLayer.md b/tevm/docs/common/variables/xLayer.md new file mode 100644 index 0000000000..47af3a0f6b --- /dev/null +++ b/tevm/docs/common/variables/xLayer.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / xLayer + +# Variable: xLayer + +> `const` **xLayer**: `Common` + +Creates a common configuration for the xLayer chain. + +## Description + +Chain ID: 196 +Chain Name: X Layer Mainnet +Default Block Explorer: https://www.oklink.com/xlayer +Default RPC URL: https://rpc.xlayer.tech + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { xLayer } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: xLayer, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/xLayer.d.ts:21 diff --git a/tevm/docs/common/variables/xLayerTestnet.md b/tevm/docs/common/variables/xLayerTestnet.md new file mode 100644 index 0000000000..8707b169b0 --- /dev/null +++ b/tevm/docs/common/variables/xLayerTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / xLayerTestnet + +# Variable: xLayerTestnet + +> `const` **xLayerTestnet**: `Common` + +Creates a common configuration for the xLayerTestnet chain. + +## Description + +Chain ID: 195 +Chain Name: X1 Testnet +Default Block Explorer: https://www.oklink.com/xlayer-test +Default RPC URL: https://xlayertestrpc.okx.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { xLayerTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: xLayerTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/xLayerTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/xai.md b/tevm/docs/common/variables/xai.md new file mode 100644 index 0000000000..82200f4f67 --- /dev/null +++ b/tevm/docs/common/variables/xai.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / xai + +# Variable: xai + +> `const` **xai**: `Common` + +Creates a common configuration for the xai chain. + +## Description + +Chain ID: 660279 +Chain Name: Xai Mainnet +Default Block Explorer: https://explorer.xai-chain.net +Default RPC URL: https://xai-chain.net/rpc + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { xai } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: xai, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/xai.d.ts:21 diff --git a/tevm/docs/common/variables/xaiTestnet.md b/tevm/docs/common/variables/xaiTestnet.md new file mode 100644 index 0000000000..5470db3a14 --- /dev/null +++ b/tevm/docs/common/variables/xaiTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / xaiTestnet + +# Variable: xaiTestnet + +> `const` **xaiTestnet**: `Common` + +Creates a common configuration for the xaiTestnet chain. + +## Description + +Chain ID: 37714555429 +Chain Name: Xai Testnet +Default Block Explorer: https://testnet-explorer-v2.xai-chain.net +Default RPC URL: https://testnet-v2.xai-chain.net/rpc + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { xaiTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: xaiTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/xaiTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/xdc.md b/tevm/docs/common/variables/xdc.md new file mode 100644 index 0000000000..fbc545b117 --- /dev/null +++ b/tevm/docs/common/variables/xdc.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / xdc + +# Variable: xdc + +> `const` **xdc**: `Common` + +Creates a common configuration for the xdc chain. + +## Description + +Chain ID: 50 +Chain Name: XinFin Network +Default Block Explorer: https://xdc.blocksscan.io +Default RPC URL: https://rpc.xinfin.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { xdc } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: xdc, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/xdc.d.ts:21 diff --git a/tevm/docs/common/variables/xdcTestnet.md b/tevm/docs/common/variables/xdcTestnet.md new file mode 100644 index 0000000000..badc5ffd52 --- /dev/null +++ b/tevm/docs/common/variables/xdcTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / xdcTestnet + +# Variable: xdcTestnet + +> `const` **xdcTestnet**: `Common` + +Creates a common configuration for the xdcTestnet chain. + +## Description + +Chain ID: 51 +Chain Name: Apothem Network +Default Block Explorer: https://apothem.blocksscan.io +Default RPC URL: https://erpc.apothem.network + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { xdcTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: xdcTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/xdcTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/xrSepolia.md b/tevm/docs/common/variables/xrSepolia.md new file mode 100644 index 0000000000..e72138f825 --- /dev/null +++ b/tevm/docs/common/variables/xrSepolia.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / xrSepolia + +# Variable: xrSepolia + +> `const` **xrSepolia**: `Common` + +Creates a common configuration for the xrSepolia chain. + +## Description + +Chain ID: 2730 +Chain Name: XR Sepolia +Default Block Explorer: https://xr-sepolia-testnet.explorer.caldera.xyz +Default RPC URL: https://xr-sepolia-testnet.rpc.caldera.xyz/http + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { xrSepolia } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: xrSepolia, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/xrSepolia.d.ts:21 diff --git a/tevm/docs/common/variables/yooldoVerse.md b/tevm/docs/common/variables/yooldoVerse.md new file mode 100644 index 0000000000..5550ef566b --- /dev/null +++ b/tevm/docs/common/variables/yooldoVerse.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / yooldoVerse + +# Variable: yooldoVerse + +> `const` **yooldoVerse**: `Common` + +Creates a common configuration for the yooldoVerse chain. + +## Description + +Chain ID: 50005 +Chain Name: Yooldo Verse +Default Block Explorer: https://explorer.yooldo-verse.xyz +Default RPC URL: https://rpc.yooldo-verse.xyz + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { yooldoVerse } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: yooldoVerse, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/yooldoVerse.d.ts:21 diff --git a/tevm/docs/common/variables/yooldoVerseTestnet.md b/tevm/docs/common/variables/yooldoVerseTestnet.md new file mode 100644 index 0000000000..c4d380888e --- /dev/null +++ b/tevm/docs/common/variables/yooldoVerseTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / yooldoVerseTestnet + +# Variable: yooldoVerseTestnet + +> `const` **yooldoVerseTestnet**: `Common` + +Creates a common configuration for the yooldoVerseTestnet chain. + +## Description + +Chain ID: 50006 +Chain Name: Yooldo Verse Testnet +Default Block Explorer: https://explorer.testnet.yooldo-verse.xyz +Default RPC URL: https://rpc.testnet.yooldo-verse.xyz + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { yooldoVerseTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: yooldoVerseTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/yooldoVerseTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/zetachain.md b/tevm/docs/common/variables/zetachain.md new file mode 100644 index 0000000000..40b0d892ad --- /dev/null +++ b/tevm/docs/common/variables/zetachain.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / zetachain + +# Variable: zetachain + +> `const` **zetachain**: `Common` + +Creates a common configuration for the zetachain chain. + +## Description + +Chain ID: 7000 +Chain Name: ZetaChain +Default Block Explorer: https://explorer.zetachain.com +Default RPC URL: https://zetachain-evm.blockpi.network/v1/rpc/public + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { zetachain } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: zetachain, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/zetachain.d.ts:21 diff --git a/tevm/docs/common/variables/zetachainAthensTestnet.md b/tevm/docs/common/variables/zetachainAthensTestnet.md new file mode 100644 index 0000000000..64d2c222f2 --- /dev/null +++ b/tevm/docs/common/variables/zetachainAthensTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / zetachainAthensTestnet + +# Variable: zetachainAthensTestnet + +> `const` **zetachainAthensTestnet**: `Common` + +Creates a common configuration for the zetachainAthensTestnet chain. + +## Description + +Chain ID: 7001 +Chain Name: ZetaChain Athens Testnet +Default Block Explorer: https://athens.explorer.zetachain.com +Default RPC URL: https://zetachain-athens-evm.blockpi.network/v1/rpc/public + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { zetachainAthensTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: zetachainAthensTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/zetachainAthensTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/zhejiang.md b/tevm/docs/common/variables/zhejiang.md new file mode 100644 index 0000000000..bc7dc02510 --- /dev/null +++ b/tevm/docs/common/variables/zhejiang.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / zhejiang + +# Variable: zhejiang + +> `const` **zhejiang**: `Common` + +Creates a common configuration for the zhejiang chain. + +## Description + +Chain ID: 1337803 +Chain Name: Zhejiang +Default Block Explorer: https://zhejiang.beaconcha.in +Default RPC URL: https://rpc.zhejiang.ethpandaops.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { zhejiang } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: zhejiang, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/zhejiang.d.ts:21 diff --git a/tevm/docs/common/variables/zilliqa.md b/tevm/docs/common/variables/zilliqa.md new file mode 100644 index 0000000000..b6619c5905 --- /dev/null +++ b/tevm/docs/common/variables/zilliqa.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / zilliqa + +# Variable: zilliqa + +> `const` **zilliqa**: `Common` + +Creates a common configuration for the zilliqa chain. + +## Description + +Chain ID: 32769 +Chain Name: Zilliqa +Default Block Explorer: https://evmx.zilliqa.com +Default RPC URL: https://api.zilliqa.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { zilliqa } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: zilliqa, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/zilliqa.d.ts:21 diff --git a/tevm/docs/common/variables/zilliqaTestnet.md b/tevm/docs/common/variables/zilliqaTestnet.md new file mode 100644 index 0000000000..6ea0859b2d --- /dev/null +++ b/tevm/docs/common/variables/zilliqaTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / zilliqaTestnet + +# Variable: zilliqaTestnet + +> `const` **zilliqaTestnet**: `Common` + +Creates a common configuration for the zilliqaTestnet chain. + +## Description + +Chain ID: 33101 +Chain Name: Zilliqa Testnet +Default Block Explorer: https://evmx.testnet.zilliqa.com +Default RPC URL: https://dev-api.zilliqa.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { zilliqaTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: zilliqaTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/zilliqaTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/zircuitTestnet.md b/tevm/docs/common/variables/zircuitTestnet.md new file mode 100644 index 0000000000..b39a389d2a --- /dev/null +++ b/tevm/docs/common/variables/zircuitTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / zircuitTestnet + +# Variable: zircuitTestnet + +> `const` **zircuitTestnet**: `Common` + +Creates a common configuration for the zircuitTestnet chain. + +## Description + +Chain ID: 48899 +Chain Name: Zircuit Testnet +Default Block Explorer: https://explorer.zircuit.com +Default RPC URL: https://zircuit1.p2pify.com + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { zircuitTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: zircuitTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/zircuitTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/zkFair.md b/tevm/docs/common/variables/zkFair.md new file mode 100644 index 0000000000..cd4ea140b2 --- /dev/null +++ b/tevm/docs/common/variables/zkFair.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / zkFair + +# Variable: zkFair + +> `const` **zkFair**: `Common` + +Creates a common configuration for the zkFair chain. + +## Description + +Chain ID: 42766 +Chain Name: ZKFair Mainnet +Default Block Explorer: https://scan.zkfair.io +Default RPC URL: https://rpc.zkfair.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { zkFair } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: zkFair, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/zkFair.d.ts:21 diff --git a/tevm/docs/common/variables/zkFairTestnet.md b/tevm/docs/common/variables/zkFairTestnet.md new file mode 100644 index 0000000000..d792b9e625 --- /dev/null +++ b/tevm/docs/common/variables/zkFairTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / zkFairTestnet + +# Variable: zkFairTestnet + +> `const` **zkFairTestnet**: `Common` + +Creates a common configuration for the zkFairTestnet chain. + +## Description + +Chain ID: 43851 +Chain Name: ZKFair Testnet +Default Block Explorer: https://testnet-scan.zkfair.io +Default RPC URL: https://testnet-rpc.zkfair.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { zkFairTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: zkFairTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/zkFairTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/zkLinkNova.md b/tevm/docs/common/variables/zkLinkNova.md new file mode 100644 index 0000000000..6eeca0b5d7 --- /dev/null +++ b/tevm/docs/common/variables/zkLinkNova.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / zkLinkNova + +# Variable: zkLinkNova + +> `const` **zkLinkNova**: `Common` + +Creates a common configuration for the zkLinkNova chain. + +## Description + +Chain ID: 810180 +Chain Name: zkLink Nova +Default Block Explorer: https://explorer.zklink.io +Default RPC URL: https://rpc.zklink.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { zkLinkNova } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: zkLinkNova, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/zkLinkNova.d.ts:21 diff --git a/tevm/docs/common/variables/zkLinkNovaSepoliaTestnet.md b/tevm/docs/common/variables/zkLinkNovaSepoliaTestnet.md new file mode 100644 index 0000000000..be777f6bed --- /dev/null +++ b/tevm/docs/common/variables/zkLinkNovaSepoliaTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / zkLinkNovaSepoliaTestnet + +# Variable: zkLinkNovaSepoliaTestnet + +> `const` **zkLinkNovaSepoliaTestnet**: `Common` + +Creates a common configuration for the zkLinkNovaSepoliaTestnet chain. + +## Description + +Chain ID: 810181 +Chain Name: zkLink Nova Sepolia Testnet +Default Block Explorer: https://sepolia.explorer.zklink.io +Default RPC URL: https://sepolia.rpc.zklink.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { zkLinkNovaSepoliaTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: zkLinkNovaSepoliaTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/zkLinkNovaSepoliaTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/zksync.md b/tevm/docs/common/variables/zksync.md new file mode 100644 index 0000000000..0a07f558ef --- /dev/null +++ b/tevm/docs/common/variables/zksync.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / zksync + +# Variable: zksync + +> `const` **zksync**: `Common` + +Creates a common configuration for the zksync chain. + +## Description + +Chain ID: 324 +Chain Name: ZKsync Era +Default Block Explorer: https://era.zksync.network/ +Default RPC URL: https://mainnet.era.zksync.io + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { zksync } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: zksync, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/zksync.d.ts:21 diff --git a/tevm/docs/common/variables/zksyncInMemoryNode.md b/tevm/docs/common/variables/zksyncInMemoryNode.md new file mode 100644 index 0000000000..f202d8b834 --- /dev/null +++ b/tevm/docs/common/variables/zksyncInMemoryNode.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / zksyncInMemoryNode + +# Variable: zksyncInMemoryNode + +> `const` **zksyncInMemoryNode**: `Common` + +Creates a common configuration for the zksyncInMemoryNode chain. + +## Description + +Chain ID: 260 +Chain Name: ZKsync InMemory Node +Default Block Explorer: Not specified +Default RPC URL: http://localhost:8011 + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { zksyncInMemoryNode } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: zksyncInMemoryNode, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/zksyncInMemoryNode.d.ts:21 diff --git a/tevm/docs/common/variables/zksyncLocalNode.md b/tevm/docs/common/variables/zksyncLocalNode.md new file mode 100644 index 0000000000..87a6ad3de1 --- /dev/null +++ b/tevm/docs/common/variables/zksyncLocalNode.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / zksyncLocalNode + +# Variable: zksyncLocalNode + +> `const` **zksyncLocalNode**: `Common` + +Creates a common configuration for the zksyncLocalNode chain. + +## Description + +Chain ID: 270 +Chain Name: ZKsync CLI Local Node +Default Block Explorer: Not specified +Default RPC URL: http://localhost:3050 + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { zksyncLocalNode } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: zksyncLocalNode, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/zksyncLocalNode.d.ts:21 diff --git a/tevm/docs/common/variables/zksyncSepoliaTestnet.md b/tevm/docs/common/variables/zksyncSepoliaTestnet.md new file mode 100644 index 0000000000..eb72194b1b --- /dev/null +++ b/tevm/docs/common/variables/zksyncSepoliaTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / zksyncSepoliaTestnet + +# Variable: zksyncSepoliaTestnet + +> `const` **zksyncSepoliaTestnet**: `Common` + +Creates a common configuration for the zksyncSepoliaTestnet chain. + +## Description + +Chain ID: 300 +Chain Name: ZKsync Sepolia Testnet +Default Block Explorer: https://sepolia-era.zksync.network/ +Default RPC URL: https://sepolia.era.zksync.dev + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { zksyncSepoliaTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: zksyncSepoliaTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/zksyncSepoliaTestnet.d.ts:21 diff --git a/tevm/docs/common/variables/zora.md b/tevm/docs/common/variables/zora.md index a4086a37f7..457afc561d 100644 --- a/tevm/docs/common/variables/zora.md +++ b/tevm/docs/common/variables/zora.md @@ -8,6 +8,30 @@ > `const` **zora**: `Common` +Creates a common configuration for the zora chain. + +## Description + +Chain ID: 7777777 +Chain Name: Zora +Default Block Explorer: https://explorer.zora.energy +Default RPC URL: https://rpc.zora.energy + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { zora } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: zora, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + ## Defined in -packages/common/types/presets/zora.d.ts:1 +packages/common/types/presets/zora.d.ts:21 diff --git a/tevm/docs/common/variables/zoraSepolia.md b/tevm/docs/common/variables/zoraSepolia.md index 16d58bc93f..71ef07143d 100644 --- a/tevm/docs/common/variables/zoraSepolia.md +++ b/tevm/docs/common/variables/zoraSepolia.md @@ -8,6 +8,30 @@ > `const` **zoraSepolia**: `Common` +Creates a common configuration for the zoraSepolia chain. + +## Description + +Chain ID: 999999999 +Chain Name: Zora Sepolia +Default Block Explorer: https://sepolia.explorer.zora.energy/ +Default RPC URL: https://sepolia.rpc.zora.energy + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { zoraSepolia } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: zoraSepolia, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + ## Defined in -packages/common/types/presets/zoraSepolia.d.ts:1 +packages/common/types/presets/zoraSepolia.d.ts:21 diff --git a/tevm/docs/common/variables/zoraTestnet.md b/tevm/docs/common/variables/zoraTestnet.md new file mode 100644 index 0000000000..66ef36ade8 --- /dev/null +++ b/tevm/docs/common/variables/zoraTestnet.md @@ -0,0 +1,37 @@ +[**tevm**](../../README.md) • **Docs** + +*** + +[tevm](../../modules.md) / [common](../README.md) / zoraTestnet + +# Variable: zoraTestnet + +> `const` **zoraTestnet**: `Common` + +Creates a common configuration for the zoraTestnet chain. + +## Description + +Chain ID: 999 +Chain Name: Zora Goerli Testnet +Default Block Explorer: https://testnet.explorer.zora.energy +Default RPC URL: https://testnet.rpc.zora.energy + +## Example + +```ts +import { createMemoryClient } from 'tevm' +import { zoraTestnet } from 'tevm/common' +import { http } from 'tevm' + +const client = createMemoryClient({ + common: zoraTestnet, + fork: { + transport: http({ url: 'https://example.com' })({}) + }, +}) +``` + +## Defined in + +packages/common/types/presets/zoraTestnet.d.ts:21 diff --git a/tevm/docs/contract/README.md b/tevm/docs/contract/README.md index db404f4e57..9fb800f40f 100644 --- a/tevm/docs/contract/README.md +++ b/tevm/docs/contract/README.md @@ -34,18 +34,6 @@ Re-exports [CreateContractParams](../index/type-aliases/CreateContractParams.md) *** -### CreateScript - -Re-exports [CreateScript](../index/type-aliases/CreateScript.md) - -*** - -### DeployArgs - -Re-exports [DeployArgs](../index/type-aliases/DeployArgs.md) - -*** - ### EventActionCreator Re-exports [EventActionCreator](../index/type-aliases/EventActionCreator.md) diff --git a/tevm/docs/contract/type-aliases/CreateContractFn.md b/tevm/docs/contract/type-aliases/CreateContractFn.md index ca8d2e3bdf..e616e34806 100644 --- a/tevm/docs/contract/type-aliases/CreateContractFn.md +++ b/tevm/docs/contract/type-aliases/CreateContractFn.md @@ -8,23 +8,96 @@ > **CreateContractFn**: \<`TName`, `TAbi`, `TAddress`, `TBytecode`, `TDeployedBytecode`, `TCode`, `THumanReadableAbi`\>(`{ name, humanReadableAbi, bytecode, deployedBytecode, code, }`) => [`Contract`](../../index/type-aliases/Contract.md)\<`TName`, `THumanReadableAbi`, `TAddress`, `TBytecode`, `TDeployedBytecode`, `TCode`\> -Type of `createContract` factory function -Creates a tevm Contract instance from human readable abi +Type of `createContract` factory function. +Creates a tevm Contract instance from a human readable ABI or JSON ABI. + +## Examples + +Using a human readable ABI: +```typescript +import { type Contract, createContract } from 'tevm/contract' + +const contract: Contract = createContract({ + name: 'ERC20', + humanReadableAbi: [ + 'function balanceOf(address owner) view returns (uint256)', + 'function transfer(address to, uint256 amount) returns (bool)', + 'event Transfer(address indexed from, address indexed to, uint256 value)', + ], +}) +``` + +Using a JSON ABI (needs to be formatted): +```typescript +import { type Contract, createContract } from 'tevm/contract' +import { formatAbi } from '@tevm/utils' + +const jsonAbi = [ + { + "inputs": [{"name": "owner", "type": "address"}], + "name": "balanceOf", + "outputs": [{"type": "uint256"}], + "stateMutability": "view", + "type": "function" + }, + { + "inputs": [ + {"name": "to", "type": "address"}, + {"name": "amount", "type": "uint256"} + ], + "name": "transfer", + "outputs": [{"type": "bool"}], + "stateMutability": "nonpayable", + "type": "function" + }, + { + "anonymous": false, + "inputs": [ + {"indexed": true, "name": "from", "type": "address"}, + {"indexed": true, "name": "to", "type": "address"}, + {"indexed": false, "name": "value", "type": "uint256"} + ], + "name": "Transfer", + "type": "event" + } +] + +const contract = createContract({ + name: 'ERC20', + abi: formatAbi(jsonAbi), + address: '0x6B175474E89094C44Da98b954EedeAC495271d0F', // DAI token address on Ethereum mainnet + bytecode: '0x60806040526000805534801561001457600080fd5b50610771806100246000396000f3fe', // Example bytecode (truncated) + deployedBytecode: '0x608060405234801561001057600080fd5b50600436106100885760003560e01c806370a082311161005b57806370a08231146101bc', // Example deployed bytecode (truncated) + code: '0x608060405234801561001057600080fd5b50600436106100885760003560e01c806370a082311161005b57806370a08231146101bc', // Example runtime code (truncated) +}) +``` ## Type Parameters • **TName** *extends* `string` +The name of the contract + • **TAbi** *extends* readonly `string`[] \| [`Abi`](../../index/type-aliases/Abi.md) +The ABI type (either string[] for human readable or Abi for JSON) + • **TAddress** *extends* `undefined` \| [`Address`](../../index/type-aliases/Address.md) = `undefined` +The contract address type (optional) + • **TBytecode** *extends* `undefined` \| [`Hex`](../../index/type-aliases/Hex.md) = `undefined` +The contract bytecode type (optional) + • **TDeployedBytecode** *extends* `undefined` \| [`Hex`](../../index/type-aliases/Hex.md) = `undefined` +The deployed bytecode type (optional) + • **TCode** *extends* `undefined` \| [`Hex`](../../index/type-aliases/Hex.md) = `undefined` +The runtime bytecode type (optional) + • **THumanReadableAbi** *extends* readonly `string`[] = `TAbi` *extends* readonly `string`[] ? `TAbi` : `TAbi` *extends* [`Abi`](../../index/type-aliases/Abi.md) ? [`FormatAbi`](../../index/type-aliases/FormatAbi.md)\<`TAbi`\> : `never` ## Parameters @@ -35,32 +108,6 @@ Creates a tevm Contract instance from human readable abi [`Contract`](../../index/type-aliases/Contract.md)\<`TName`, `THumanReadableAbi`, `TAddress`, `TBytecode`, `TDeployedBytecode`, `TCode`\> -## Examples - -```typescript -import { type Contract, createContract} from 'tevm/contract' - -const contract: Contract = createContract({ - name: 'MyContract', - abi: [ - ... - ], -}) -``` - -To use a json abi first pass it into `formatAbi` to turn it into human readable - -```typescript -import { type Contract, createContract} from 'tevm/contract' - -const contract = createContract({ - name: 'MyContract', - abi: [ - ... - ], -}) -``` - ## Defined in -packages/contract/types/CreateContractFn.d.ts:32 +packages/contract/types/CreateContractFn.d.ts:76 diff --git a/tevm/docs/contract/type-aliases/MaybeExtractEventArgsFromAbi.md b/tevm/docs/contract/type-aliases/MaybeExtractEventArgsFromAbi.md index a8dbebd50c..173948b221 100644 --- a/tevm/docs/contract/type-aliases/MaybeExtractEventArgsFromAbi.md +++ b/tevm/docs/contract/type-aliases/MaybeExtractEventArgsFromAbi.md @@ -8,14 +8,18 @@ > **MaybeExtractEventArgsFromAbi**\<`TAbi`, `TEventName`\>: `Exclude`\<`TAbi` *extends* [`Abi`](../../index/type-aliases/Abi.md) \| readonly `unknown`[] ? `TEventName` *extends* `string` ? [`GetEventArgs`](../../index/type-aliases/GetEventArgs.md)\<`TAbi`, `TEventName`\> : `undefined` : `undefined`, readonly `unknown`[] \| `Record`\<`string`, `unknown`\>\> -Adapted from viem. This is a helper type to extract the event args from an abi +Extracts event arguments from an ABI. ## Type Parameters • **TAbi** *extends* [`Abi`](../../index/type-aliases/Abi.md) \| readonly `unknown`[] \| `undefined` +The ABI type, can be an Abi, readonly unknown[], or undefined. + • **TEventName** *extends* `string` \| `undefined` +The name of the event, can be a string or undefined. + ## Defined in -packages/contract/types/event/EventActionCreator.d.ts:5 +packages/contract/types/event/EventActionCreator.d.ts:7 diff --git a/tevm/docs/contract/type-aliases/ValueOf.md b/tevm/docs/contract/type-aliases/ValueOf.md index 403e19e267..618a5f2fe0 100644 --- a/tevm/docs/contract/type-aliases/ValueOf.md +++ b/tevm/docs/contract/type-aliases/ValueOf.md @@ -8,10 +8,14 @@ > **ValueOf**\<`T`\>: `T`\[keyof `T`\] +Utility type to get the value type of an object. + ## Type Parameters • **T** +The object type. + ## Defined in -packages/contract/types/event/EventActionCreator.d.ts:6 +packages/contract/types/event/EventActionCreator.d.ts:12 diff --git a/tevm/docs/contract/variables/ERC20.md b/tevm/docs/contract/variables/ERC20.md index f9d2a76acd..4d0524f7ce 100644 --- a/tevm/docs/contract/variables/ERC20.md +++ b/tevm/docs/contract/variables/ERC20.md @@ -8,8 +8,38 @@ > `const` **ERC20**: `Contract` -Bytecode and ABI for the ERC20 contract from open zeppelin. +Bytecode and ABI for the ERC20 contract from OpenZeppelin. +This constant represents a standard ERC20 token implementation. + +## Examples + +Using the ERC20 contract in a deployment script: +```typescript +import { ERC20 } from 'tevm/contract' + +// Deploy the ERC20 contract +const deployedERC20 = await tevm.deployContract(ERC20.deploy('MyToken', 'MTK')) +console.log('ERC20 deployed at:', deployedERC20.address) + +// Interact with the deployed contract +const balance = await tevm.contract(ERC20.read.balanceOf(deployedERC20.address, '0x1234...')) +console.log('Balance:', balance) +``` + +Using the ERC20 contract with an existing deployment: +```typescript +import { ERC20 } from 'tevm/contract' + +const existingERC20 = ERC20.withAddress('0x1234...') + +// Read token name +const name = await tevm.contract(existingERC20.read.name()) +console.log('Token name:', name) + +// Transfer tokens +await tevm.contract(existingERC20.write.transfer('0x5678...', 1000n)) +``` ## Defined in -packages/contract/types/contract-lib/ERC20.d.ts:4 +packages/contract/types/contract-lib/ERC20.d.ts:34 diff --git a/tevm/docs/contract/variables/ERC721.md b/tevm/docs/contract/variables/ERC721.md index 3a1bfa24b9..2ca34f363f 100644 --- a/tevm/docs/contract/variables/ERC721.md +++ b/tevm/docs/contract/variables/ERC721.md @@ -8,8 +8,39 @@ > `const` **ERC721**: `Contract` -Bytecode and ABI for the ERC721 contract from open zeppelin. +Bytecode and ABI for the ERC721 contract from OpenZeppelin. +This constant represents a standard ERC721 token implementation for non-fungible tokens (NFTs). +For more details, see the [OpenZeppelin ERC721 documentation](https://docs.openzeppelin.com/contracts/4.x/erc721). + +## Examples + +Using the ERC721 contract in a deployment script: +```typescript +import { ERC721 } from 'tevm/contract' + +// Deploy the ERC721 contract +const deployedERC721 = await tevm.deployContract(ERC721.deploy('MyNFT', 'MNFT')) +console.log('ERC721 deployed at:', deployedERC721.address) + +// Interact with the deployed contract +const owner = await tevm.contract(ERC721.read.ownerOf(deployedERC721.address, 1n)) +console.log('Owner of token 1:', owner) +``` + +Using the ERC721 contract with an existing deployment: +```typescript +import { ERC721 } from 'tevm/contract' + +const existingERC721 = ERC721.withAddress('0x1234...') + +// Read token name +const name = await tevm.contract(existingERC721.read.name()) +console.log('Token name:', name) + +// Transfer token +await tevm.contract(existingERC721.write.transferFrom('0xabcd...', '0x5678...', 1n)) +``` ## Defined in -packages/contract/types/contract-lib/ERC721.d.ts:4 +packages/contract/types/contract-lib/ERC721.d.ts:36 diff --git a/tevm/docs/contract/variables/SimpleContract.md b/tevm/docs/contract/variables/SimpleContract.md index 7bd80f72b5..d8c63cedb5 100644 --- a/tevm/docs/contract/variables/SimpleContract.md +++ b/tevm/docs/contract/variables/SimpleContract.md @@ -8,6 +8,39 @@ > `const` **SimpleContract**: `Contract` +Bytecode and ABI for a simple contract with a single state variable. +This constant represents a basic contract that can get and set a uint256 value. + +## Examples + +Using the SimpleContract in a deployment script: +```typescript +import { SimpleContract } from 'tevm/contract' + +// Deploy the SimpleContract with an initial value +const deployedSimpleContract = await tevm.deployContract(SimpleContract.deploy(42n)) +console.log('SimpleContract deployed at:', deployedSimpleContract.address) + +// Interact with the deployed contract +const value = await tevm.contract(SimpleContract.read.get()) +console.log('Current value:', value) +``` + +Using the SimpleContract with an existing deployment: +```typescript +import { SimpleContract } from 'tevm/contract' + +const existingSimpleContract = SimpleContract.withAddress('0x1234...') + +// Read current value +const currentValue = await tevm.contract(existingSimpleContract.read.get()) +console.log('Current value:', currentValue) + +// Set a new value +await tevm.contract(existingSimpleContract.write.set(100n)) +console.log('New value set') +``` + ## Defined in -packages/contract/types/contract-lib/SimpleContract.s.sol.d.ts:1 +packages/contract/types/contract-lib/SimpleContract.s.sol.d.ts:36 diff --git a/tevm/docs/errors/README.md b/tevm/docs/errors/README.md index 3f6d03d11b..f9e48c1d06 100644 --- a/tevm/docs/errors/README.md +++ b/tevm/docs/errors/README.md @@ -12,9 +12,7 @@ - [AccountLockedError](classes/AccountLockedError.md) - [AccountNotFoundError](classes/AccountNotFoundError.md) -- [AuthCallNonZeroValueExtError](classes/AuthCallNonZeroValueExtError.md) - [AuthCallUnsetError](classes/AuthCallUnsetError.md) -- [AuthInvalidSError](classes/AuthInvalidSError.md) - [BLS12381FpNotInFieldError](classes/BLS12381FpNotInFieldError.md) - [BLS12381InputEmptyError](classes/BLS12381InputEmptyError.md) - [BLS12381InvalidInputLengthError](classes/BLS12381InvalidInputLengthError.md) @@ -131,9 +129,7 @@ ### Type Aliases - [AccountLockedErrorParameters](type-aliases/AccountLockedErrorParameters.md) -- [AuthCallNonZeroValueExtErrorParameters](type-aliases/AuthCallNonZeroValueExtErrorParameters.md) - [AuthCallUnsetErrorParameters](type-aliases/AuthCallUnsetErrorParameters.md) -- [AuthInvalidSErrorParameters](type-aliases/AuthInvalidSErrorParameters.md) - [BLS12381FpNotInFieldErrorParameters](type-aliases/BLS12381FpNotInFieldErrorParameters.md) - [BLS12381InputEmptyErrorParameters](type-aliases/BLS12381InputEmptyErrorParameters.md) - [BLS12381InvalidInputLengthErrorParameters](type-aliases/BLS12381InvalidInputLengthErrorParameters.md) diff --git a/tevm/docs/errors/classes/AccountLockedError.md b/tevm/docs/errors/classes/AccountLockedError.md index cf23238fda..11cf1664c0 100644 --- a/tevm/docs/errors/classes/AccountLockedError.md +++ b/tevm/docs/errors/classes/AccountLockedError.md @@ -10,17 +10,25 @@ Represents an error that occurs when an account is locked. This error is typically encountered when an operation is attempted on an account that has been locked for security reasons. This might happen if the account has -been temporarily disabled or if additional authentication is required. +been temporarily disabled, if additional authentication is required, or if the +account's private key is not available to the node. + +The error code -32005 is a non-standard extension used by some Ethereum clients to +indicate this specific condition. ## Example ```ts try { - // Some operation that can throw an AccountLockedError + await client.sendTransaction({ + from: '0x1234567890123456789012345678901234567890', + to: '0x0987654321098765432109876543210987654321', + value: '0x1' + }) } catch (error) { if (error instanceof AccountLockedError) { - console.error(error.message); - // Handle the account locked error + console.error('Account locked:', error.message); + console.log('Unlock the account or use a different account for this transaction'); } } ``` @@ -69,7 +77,7 @@ The tag for the error. #### Defined in -packages/errors/types/ethereum/AccountLockedError.d.ts:47 +packages/errors/types/ethereum/AccountLockedError.d.ts:55 ## Properties @@ -85,7 +93,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -99,7 +107,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -107,7 +115,7 @@ packages/errors/types/ethereum/BaseError.d.ts:64 > **code**: `number` -Error code, analogous to the code in JSON RPC error. +Error code (-32005), a non-standard extension for this specific error. #### Inherited from @@ -115,7 +123,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -129,7 +137,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -145,7 +153,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -177,7 +185,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -207,7 +215,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -235,7 +243,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -245,6 +253,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -255,10 +267,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`BaseError`](BaseError.md).[`prepareStackTrace`](BaseError.md#preparestacktrace) @@ -307,7 +315,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -359,4 +367,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`BaseError`](BaseError.md).[`captureStackTrace`](BaseError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/AccountNotFoundError.md b/tevm/docs/errors/classes/AccountNotFoundError.md index a9b02a3adc..a9474692b8 100644 --- a/tevm/docs/errors/classes/AccountNotFoundError.md +++ b/tevm/docs/errors/classes/AccountNotFoundError.md @@ -83,7 +83,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -97,7 +97,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -113,7 +113,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -127,7 +127,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -143,7 +143,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -175,7 +175,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -205,7 +205,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -233,7 +233,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -243,6 +243,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -253,10 +257,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`ResourceNotFoundError`](ResourceNotFoundError.md).[`prepareStackTrace`](ResourceNotFoundError.md#preparestacktrace) @@ -305,7 +305,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -357,4 +357,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`ResourceNotFoundError`](ResourceNotFoundError.md).[`captureStackTrace`](ResourceNotFoundError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/AuthCallNonZeroValueExtError.md b/tevm/docs/errors/classes/AuthCallNonZeroValueExtError.md deleted file mode 100644 index 16f2abcf90..0000000000 --- a/tevm/docs/errors/classes/AuthCallNonZeroValueExtError.md +++ /dev/null @@ -1,396 +0,0 @@ -[**tevm**](../../README.md) • **Docs** - -*** - -[tevm](../../modules.md) / [errors](../README.md) / AuthCallNonZeroValueExtError - -# Class: AuthCallNonZeroValueExtError - -Represents an EIP-3074 specific error that occurs when attempting to execute AUTHCALL with nonzero external value. - -AuthCallNonZeroValueExt errors can occur due to: -- Attempting to execute an AUTHCALL with a nonzero external value, which is not allowed. - -To debug an AuthCallNonZeroValueExt error: -1. **Review Authorization Logic**: Ensure that AUTHCALL is not executed with a nonzero external value. -2. **Use TEVM Tracing**: Utilize TEVM tracing to step through the contract execution and identify where the AUTHCALL is attempted with nonzero external value. - -## Example - -```typescript -import { AuthCallNonZeroValueExtError } from '@tevm/errors' -try { - // Some operation that can throw an AuthCallNonZeroValueExtError -} catch (error) { - if (error instanceof AuthCallNonZeroValueExtError) { - console.error(error.message); - // Handle the AuthCallNonZeroValueExt error - } -} -``` - -## Param - -A human-readable error message. - -## Param - -Additional parameters for the BaseError. - -## Extends - -- [`ExecutionError`](ExecutionError.md) - -## Constructors - -### new AuthCallNonZeroValueExtError() - -> **new AuthCallNonZeroValueExtError**(`message`?, `args`?, `tag`?): [`AuthCallNonZeroValueExtError`](AuthCallNonZeroValueExtError.md) - -Constructs an AuthCallNonZeroValueExtError. -Represents an EIP-3074 specific error that occurs when attempting to execute AUTHCALL with nonzero external value. - -AuthCallNonZeroValueExt errors can occur due to: -- Attempting to execute an AUTHCALL with a nonzero external value, which is not allowed. - -To debug an AuthCallNonZeroValueExt error: -1. **Review Authorization Logic**: Ensure that AUTHCALL is not executed with a nonzero external value. -2. **Use TEVM Tracing**: Utilize TEVM tracing to step through the contract execution and identify where the AUTHCALL is attempted with nonzero external value. - -#### Parameters - -• **message?**: `string` - -Human-readable error message. - -• **args?**: [`AuthCallNonZeroValueExtErrorParameters`](../type-aliases/AuthCallNonZeroValueExtErrorParameters.md) - -Additional parameters for the BaseError. - -• **tag?**: `string` - -The tag for the error. - -#### Returns - -[`AuthCallNonZeroValueExtError`](AuthCallNonZeroValueExtError.md) - -#### Overrides - -[`ExecutionError`](ExecutionError.md).[`constructor`](ExecutionError.md#constructors) - -#### Defined in - -packages/errors/types/ethereum/ethereumjs/AuthCallNonZeroValueExtError.d.ts:62 - -## Properties - -### \_tag - -> **\_tag**: `string` - -Same as name, used internally. - -#### Inherited from - -[`ExecutionError`](ExecutionError.md).[`_tag`](ExecutionError.md#_tag) - -#### Defined in - -packages/errors/types/ethereum/BaseError.d.ts:39 - -*** - -### cause - -> **cause**: `any` - -#### Inherited from - -[`ExecutionError`](ExecutionError.md).[`cause`](ExecutionError.md#cause) - -#### Defined in - -packages/errors/types/ethereum/BaseError.d.ts:64 - -*** - -### code - -> **code**: `number` - -Error code, analogous to the code in JSON RPC error. - -#### Inherited from - -[`ExecutionError`](ExecutionError.md).[`code`](ExecutionError.md#code) - -#### Defined in - -packages/errors/types/ethereum/BaseError.d.ts:63 - -*** - -### details - -> **details**: `string` - -#### Inherited from - -[`ExecutionError`](ExecutionError.md).[`details`](ExecutionError.md#details) - -#### Defined in - -packages/errors/types/ethereum/BaseError.d.ts:43 - -*** - -### docsPath - -> **docsPath**: `undefined` \| `string` - -Path to the documentation for this error. - -#### Inherited from - -[`ExecutionError`](ExecutionError.md).[`docsPath`](ExecutionError.md#docspath) - -#### Defined in - -packages/errors/types/ethereum/BaseError.d.ts:47 - -*** - -### message - -> **message**: `string` - -Human-readable error message. - -#### Inherited from - -[`ExecutionError`](ExecutionError.md).[`message`](ExecutionError.md#message) - -#### Defined in - -node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1077 - -*** - -### meta - -> **meta**: `undefined` \| `object` - -Optional object containing additional information about the error. - -#### Defined in - -packages/errors/types/ethereum/ethereumjs/AuthCallNonZeroValueExtError.d.ts:66 - -*** - -### metaMessages - -> **metaMessages**: `undefined` \| `string`[] - -Additional meta messages for more context. - -#### Inherited from - -[`ExecutionError`](ExecutionError.md).[`metaMessages`](ExecutionError.md#metamessages) - -#### Defined in - -packages/errors/types/ethereum/BaseError.d.ts:51 - -*** - -### name - -> **name**: `string` - -The name of the error, used to discriminate errors. - -#### Inherited from - -[`ExecutionError`](ExecutionError.md).[`name`](ExecutionError.md#name) - -#### Defined in - -node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1076 - -*** - -### shortMessage - -> **shortMessage**: `string` - -#### Inherited from - -[`ExecutionError`](ExecutionError.md).[`shortMessage`](ExecutionError.md#shortmessage) - -#### Defined in - -packages/errors/types/ethereum/BaseError.d.ts:55 - -*** - -### stack? - -> `optional` **stack**: `string` - -#### Inherited from - -[`ExecutionError`](ExecutionError.md).[`stack`](ExecutionError.md#stack) - -#### Defined in - -node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1078 - -*** - -### version - -> **version**: `string` - -#### Inherited from - -[`ExecutionError`](ExecutionError.md).[`version`](ExecutionError.md#version) - -#### Defined in - -packages/errors/types/ethereum/BaseError.d.ts:59 - -*** - -### EVMErrorMessage - -> `static` **EVMErrorMessage**: [`EvmErrorMessage`](../../evm/enumerations/EvmErrorMessage.md) - -#### Defined in - -packages/errors/types/ethereum/ethereumjs/AuthCallNonZeroValueExtError.d.ts:46 - -*** - -### prepareStackTrace()? - -> `static` `optional` **prepareStackTrace**: (`err`, `stackTraces`) => `any` - -Optional override for formatting stack traces - -#### Parameters - -• **err**: `Error` - -• **stackTraces**: `CallSite`[] - -#### Returns - -`any` - -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - -#### Inherited from - -[`ExecutionError`](ExecutionError.md).[`prepareStackTrace`](ExecutionError.md#preparestacktrace) - -#### Defined in - -node\_modules/.pnpm/@types+node@20.14.8/node\_modules/@types/node/globals.d.ts:28 - -*** - -### stackTraceLimit - -> `static` **stackTraceLimit**: `number` - -#### Inherited from - -[`ExecutionError`](ExecutionError.md).[`stackTraceLimit`](ExecutionError.md#stacktracelimit) - -#### Defined in - -node\_modules/.pnpm/@types+node@20.14.8/node\_modules/@types/node/globals.d.ts:30 - -## Methods - -### walk() - -> **walk**(`fn`?): `unknown` - -Walks through the error chain. - -#### Parameters - -• **fn?**: `Function` - -A function to execute on each error in the chain. - -#### Returns - -`unknown` - -The first error that matches the function, or the original error. - -#### Inherited from - -[`ExecutionError`](ExecutionError.md).[`walk`](ExecutionError.md#walk) - -#### Defined in - -packages/errors/types/ethereum/BaseError.d.ts:70 - -*** - -### captureStackTrace() - -#### captureStackTrace(targetObject, constructorOpt) - -> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` - -Create .stack property on a target object - -##### Parameters - -• **targetObject**: `object` - -• **constructorOpt?**: `Function` - -##### Returns - -`void` - -##### Inherited from - -[`ExecutionError`](ExecutionError.md).[`captureStackTrace`](ExecutionError.md#capturestacktrace) - -##### Defined in - -node\_modules/.pnpm/@types+node@20.14.8/node\_modules/@types/node/globals.d.ts:21 - -#### captureStackTrace(targetObject, constructorOpt) - -> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` - -Create .stack property on a target object - -##### Parameters - -• **targetObject**: `object` - -• **constructorOpt?**: `Function` - -##### Returns - -`void` - -##### Inherited from - -[`ExecutionError`](ExecutionError.md).[`captureStackTrace`](ExecutionError.md#capturestacktrace) - -##### Defined in - -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 diff --git a/tevm/docs/errors/classes/AuthCallUnsetError.md b/tevm/docs/errors/classes/AuthCallUnsetError.md index 2656d4bb19..98c4013ce6 100644 --- a/tevm/docs/errors/classes/AuthCallUnsetError.md +++ b/tevm/docs/errors/classes/AuthCallUnsetError.md @@ -97,7 +97,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -111,7 +111,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -127,7 +127,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -141,7 +141,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -157,7 +157,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -201,7 +201,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -231,7 +231,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -259,7 +259,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -279,6 +279,10 @@ packages/errors/types/ethereum/ethereumjs/AuthCallUnsetError.d.ts:46 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -289,10 +293,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`ExecutionError`](ExecutionError.md).[`prepareStackTrace`](ExecutionError.md#preparestacktrace) @@ -341,7 +341,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -393,4 +393,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`ExecutionError`](ExecutionError.md).[`captureStackTrace`](ExecutionError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/AuthInvalidSError.md b/tevm/docs/errors/classes/AuthInvalidSError.md deleted file mode 100644 index d321498366..0000000000 --- a/tevm/docs/errors/classes/AuthInvalidSError.md +++ /dev/null @@ -1,396 +0,0 @@ -[**tevm**](../../README.md) • **Docs** - -*** - -[tevm](../../modules.md) / [errors](../README.md) / AuthInvalidSError - -# Class: AuthInvalidSError - -Represents an EIP-3074 specific error that occurs when an invalid signature with s-values greater than secp256k1n/2 is encountered. - -AuthInvalidS errors can occur due to: -- Providing a signature with an s-value greater than secp256k1n/2, which is considered invalid. - -To debug an AuthInvalidS error: -1. **Review Signature Logic**: Ensure that the signature provided adheres to the secp256k1 standards. -2. **Use TEVM Tracing**: Utilize TEVM tracing to step through the contract execution and identify where the invalid signature is encountered. - -## Example - -```typescript -import { AuthInvalidSError } from '@tevm/errors' -try { - // Some operation that can throw an AuthInvalidSError -} catch (error) { - if (error instanceof AuthInvalidSError) { - console.error(error.message); - // Handle the AuthInvalidS error - } -} -``` - -## Param - -A human-readable error message. - -## Param - -Additional parameters for the BaseError. - -## Extends - -- [`ExecutionError`](ExecutionError.md) - -## Constructors - -### new AuthInvalidSError() - -> **new AuthInvalidSError**(`message`?, `args`?, `tag`?): [`AuthInvalidSError`](AuthInvalidSError.md) - -Constructs an AuthInvalidSError. -Represents an EIP-3074 specific error that occurs when an invalid signature with s-values greater than secp256k1n/2 is encountered. - -AuthInvalidS errors can occur due to: -- Providing a signature with an s-value greater than secp256k1n/2, which is considered invalid. - -To debug an AuthInvalidS error: -1. **Review Signature Logic**: Ensure that the signature provided adheres to the secp256k1 standards. -2. **Use TEVM Tracing**: Utilize TEVM tracing to step through the contract execution and identify where the invalid signature is encountered. - -#### Parameters - -• **message?**: `string` - -Human-readable error message. - -• **args?**: [`AuthInvalidSErrorParameters`](../type-aliases/AuthInvalidSErrorParameters.md) - -Additional parameters for the BaseError. - -• **tag?**: `string` - -Tag for the error. - -#### Returns - -[`AuthInvalidSError`](AuthInvalidSError.md) - -#### Overrides - -[`ExecutionError`](ExecutionError.md).[`constructor`](ExecutionError.md#constructors) - -#### Defined in - -packages/errors/types/ethereum/ethereumjs/AuthInvalidSError.d.ts:62 - -## Properties - -### \_tag - -> **\_tag**: `string` - -Same as name, used internally. - -#### Inherited from - -[`ExecutionError`](ExecutionError.md).[`_tag`](ExecutionError.md#_tag) - -#### Defined in - -packages/errors/types/ethereum/BaseError.d.ts:39 - -*** - -### cause - -> **cause**: `any` - -#### Inherited from - -[`ExecutionError`](ExecutionError.md).[`cause`](ExecutionError.md#cause) - -#### Defined in - -packages/errors/types/ethereum/BaseError.d.ts:64 - -*** - -### code - -> **code**: `number` - -Error code, analogous to the code in JSON RPC error. - -#### Inherited from - -[`ExecutionError`](ExecutionError.md).[`code`](ExecutionError.md#code) - -#### Defined in - -packages/errors/types/ethereum/BaseError.d.ts:63 - -*** - -### details - -> **details**: `string` - -#### Inherited from - -[`ExecutionError`](ExecutionError.md).[`details`](ExecutionError.md#details) - -#### Defined in - -packages/errors/types/ethereum/BaseError.d.ts:43 - -*** - -### docsPath - -> **docsPath**: `undefined` \| `string` - -Path to the documentation for this error. - -#### Inherited from - -[`ExecutionError`](ExecutionError.md).[`docsPath`](ExecutionError.md#docspath) - -#### Defined in - -packages/errors/types/ethereum/BaseError.d.ts:47 - -*** - -### message - -> **message**: `string` - -Human-readable error message. - -#### Inherited from - -[`ExecutionError`](ExecutionError.md).[`message`](ExecutionError.md#message) - -#### Defined in - -node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1077 - -*** - -### meta - -> **meta**: `undefined` \| `object` - -Optional object containing additional information about the error. - -#### Defined in - -packages/errors/types/ethereum/ethereumjs/AuthInvalidSError.d.ts:66 - -*** - -### metaMessages - -> **metaMessages**: `undefined` \| `string`[] - -Additional meta messages for more context. - -#### Inherited from - -[`ExecutionError`](ExecutionError.md).[`metaMessages`](ExecutionError.md#metamessages) - -#### Defined in - -packages/errors/types/ethereum/BaseError.d.ts:51 - -*** - -### name - -> **name**: `string` - -The name of the error, used to discriminate errors. - -#### Inherited from - -[`ExecutionError`](ExecutionError.md).[`name`](ExecutionError.md#name) - -#### Defined in - -node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1076 - -*** - -### shortMessage - -> **shortMessage**: `string` - -#### Inherited from - -[`ExecutionError`](ExecutionError.md).[`shortMessage`](ExecutionError.md#shortmessage) - -#### Defined in - -packages/errors/types/ethereum/BaseError.d.ts:55 - -*** - -### stack? - -> `optional` **stack**: `string` - -#### Inherited from - -[`ExecutionError`](ExecutionError.md).[`stack`](ExecutionError.md#stack) - -#### Defined in - -node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1078 - -*** - -### version - -> **version**: `string` - -#### Inherited from - -[`ExecutionError`](ExecutionError.md).[`version`](ExecutionError.md#version) - -#### Defined in - -packages/errors/types/ethereum/BaseError.d.ts:59 - -*** - -### EVMErrorMessage - -> `static` **EVMErrorMessage**: [`EvmErrorMessage`](../../evm/enumerations/EvmErrorMessage.md) - -#### Defined in - -packages/errors/types/ethereum/ethereumjs/AuthInvalidSError.d.ts:46 - -*** - -### prepareStackTrace()? - -> `static` `optional` **prepareStackTrace**: (`err`, `stackTraces`) => `any` - -Optional override for formatting stack traces - -#### Parameters - -• **err**: `Error` - -• **stackTraces**: `CallSite`[] - -#### Returns - -`any` - -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - -#### Inherited from - -[`ExecutionError`](ExecutionError.md).[`prepareStackTrace`](ExecutionError.md#preparestacktrace) - -#### Defined in - -node\_modules/.pnpm/@types+node@20.14.8/node\_modules/@types/node/globals.d.ts:28 - -*** - -### stackTraceLimit - -> `static` **stackTraceLimit**: `number` - -#### Inherited from - -[`ExecutionError`](ExecutionError.md).[`stackTraceLimit`](ExecutionError.md#stacktracelimit) - -#### Defined in - -node\_modules/.pnpm/@types+node@20.14.8/node\_modules/@types/node/globals.d.ts:30 - -## Methods - -### walk() - -> **walk**(`fn`?): `unknown` - -Walks through the error chain. - -#### Parameters - -• **fn?**: `Function` - -A function to execute on each error in the chain. - -#### Returns - -`unknown` - -The first error that matches the function, or the original error. - -#### Inherited from - -[`ExecutionError`](ExecutionError.md).[`walk`](ExecutionError.md#walk) - -#### Defined in - -packages/errors/types/ethereum/BaseError.d.ts:70 - -*** - -### captureStackTrace() - -#### captureStackTrace(targetObject, constructorOpt) - -> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` - -Create .stack property on a target object - -##### Parameters - -• **targetObject**: `object` - -• **constructorOpt?**: `Function` - -##### Returns - -`void` - -##### Inherited from - -[`ExecutionError`](ExecutionError.md).[`captureStackTrace`](ExecutionError.md#capturestacktrace) - -##### Defined in - -node\_modules/.pnpm/@types+node@20.14.8/node\_modules/@types/node/globals.d.ts:21 - -#### captureStackTrace(targetObject, constructorOpt) - -> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` - -Create .stack property on a target object - -##### Parameters - -• **targetObject**: `object` - -• **constructorOpt?**: `Function` - -##### Returns - -`void` - -##### Inherited from - -[`ExecutionError`](ExecutionError.md).[`captureStackTrace`](ExecutionError.md#capturestacktrace) - -##### Defined in - -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 diff --git a/tevm/docs/errors/classes/BLS12381FpNotInFieldError.md b/tevm/docs/errors/classes/BLS12381FpNotInFieldError.md index a593a9f914..c9334f7ade 100644 --- a/tevm/docs/errors/classes/BLS12381FpNotInFieldError.md +++ b/tevm/docs/errors/classes/BLS12381FpNotInFieldError.md @@ -89,7 +89,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -103,7 +103,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -119,7 +119,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -133,7 +133,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -149,7 +149,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -193,7 +193,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -223,7 +223,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -251,7 +251,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -271,6 +271,10 @@ packages/errors/types/ethereum/ethereumjs/BLS12381FpNotInFieldError.d.ts:42 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -281,10 +285,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`ExecutionError`](ExecutionError.md).[`prepareStackTrace`](ExecutionError.md#preparestacktrace) @@ -333,7 +333,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -385,4 +385,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`ExecutionError`](ExecutionError.md).[`captureStackTrace`](ExecutionError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/BLS12381InputEmptyError.md b/tevm/docs/errors/classes/BLS12381InputEmptyError.md index a1d4dfa934..199f3a4b96 100644 --- a/tevm/docs/errors/classes/BLS12381InputEmptyError.md +++ b/tevm/docs/errors/classes/BLS12381InputEmptyError.md @@ -89,7 +89,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -103,7 +103,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -119,7 +119,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -133,7 +133,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -149,7 +149,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -181,7 +181,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -211,7 +211,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -239,7 +239,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -259,6 +259,10 @@ packages/errors/types/ethereum/ethereumjs/BLS12381InputEmptyError.d.ts:42 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -269,10 +273,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`ExecutionError`](ExecutionError.md).[`prepareStackTrace`](ExecutionError.md#preparestacktrace) @@ -321,7 +321,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -373,4 +373,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`ExecutionError`](ExecutionError.md).[`captureStackTrace`](ExecutionError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/BLS12381InvalidInputLengthError.md b/tevm/docs/errors/classes/BLS12381InvalidInputLengthError.md index 7a373679df..339e06723e 100644 --- a/tevm/docs/errors/classes/BLS12381InvalidInputLengthError.md +++ b/tevm/docs/errors/classes/BLS12381InvalidInputLengthError.md @@ -89,7 +89,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -103,7 +103,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -119,7 +119,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -133,7 +133,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -149,7 +149,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -181,7 +181,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -211,7 +211,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -239,7 +239,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -259,6 +259,10 @@ packages/errors/types/ethereum/ethereumjs/BLS12381InvalidInputLengthError.d.ts:4 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -269,10 +273,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`ExecutionError`](ExecutionError.md).[`prepareStackTrace`](ExecutionError.md#preparestacktrace) @@ -321,7 +321,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -373,4 +373,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`ExecutionError`](ExecutionError.md).[`captureStackTrace`](ExecutionError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/BLS12381PointNotOnCurveError.md b/tevm/docs/errors/classes/BLS12381PointNotOnCurveError.md index f64b1d7d63..8cad0887b8 100644 --- a/tevm/docs/errors/classes/BLS12381PointNotOnCurveError.md +++ b/tevm/docs/errors/classes/BLS12381PointNotOnCurveError.md @@ -89,7 +89,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -103,7 +103,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -119,7 +119,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -133,7 +133,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -149,7 +149,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -181,7 +181,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -211,7 +211,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -239,7 +239,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -259,6 +259,10 @@ packages/errors/types/ethereum/ethereumjs/BLS12381PointNotOnCurveError.d.ts:42 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -269,10 +273,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`ExecutionError`](ExecutionError.md).[`prepareStackTrace`](ExecutionError.md#preparestacktrace) @@ -321,7 +321,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -373,4 +373,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`ExecutionError`](ExecutionError.md).[`captureStackTrace`](ExecutionError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/BaseError.md b/tevm/docs/errors/classes/BaseError.md index 33f7702afa..400e74c0e5 100644 --- a/tevm/docs/errors/classes/BaseError.md +++ b/tevm/docs/errors/classes/BaseError.md @@ -9,10 +9,10 @@ Base class for custom errors in TEVM. This class is abstract and should be extended by other error classes. -## Implements - ## Abstract +## Implements + ## Extends - `Error` @@ -93,7 +93,7 @@ Error code analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:35 +packages/errors/types/ethereum/BaseError.d.ts:36 ## Properties @@ -107,7 +107,7 @@ packages/errors/types/ethereum/BaseError.d.ts:35 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -121,7 +121,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -135,7 +135,7 @@ packages/errors/types/ethereum/BaseError.d.ts:64 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -149,7 +149,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -163,7 +163,7 @@ packages/errors/types/ethereum/BaseError.d.ts:43 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -191,7 +191,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -223,7 +223,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -251,7 +251,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -261,6 +261,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -271,10 +275,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from `Error.prepareStackTrace` @@ -323,7 +323,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -375,4 +375,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +`Error.captureStackTrace` + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/BlockGasLimitExceededError.md b/tevm/docs/errors/classes/BlockGasLimitExceededError.md index d4b63cc2be..6ea02af5cc 100644 --- a/tevm/docs/errors/classes/BlockGasLimitExceededError.md +++ b/tevm/docs/errors/classes/BlockGasLimitExceededError.md @@ -8,17 +8,24 @@ Represents an error that occurs when the block gas limit has been exceeded. -This error is typically encountered when a transaction or set of transactions exceed the gas limit for a block. +This error is typically encountered when a transaction or set of transactions in a block +consume more gas than the block's gas limit allows. Each block in Ethereum has a maximum +amount of gas that can be used by all transactions within it. + +The error code -32006 is a non-standard extension used by some Ethereum clients to +indicate this specific condition. ## Example ```ts try { - // Some operation that can throw a BlockGasLimitExceededError + const result = await client.sendTransaction({ + // ... transaction details + }) } catch (error) { if (error instanceof BlockGasLimitExceededError) { - console.error(error.message); - // Handle the block gas limit exceeded error + console.error('Block gas limit exceeded:', error.message); + console.log('Consider splitting the transaction or waiting for a block with more available gas'); } } ``` @@ -67,7 +74,7 @@ The tag for the error. #### Defined in -packages/errors/types/ethereum/BlockGasLimitExceededError.d.ts:45 +packages/errors/types/ethereum/BlockGasLimitExceededError.d.ts:52 ## Properties @@ -83,7 +90,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BlockGasLimitExceededError.d.ts:54 +packages/errors/types/ethereum/BlockGasLimitExceededError.d.ts:61 *** @@ -97,7 +104,7 @@ packages/errors/types/ethereum/BlockGasLimitExceededError.d.ts:54 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -105,7 +112,7 @@ packages/errors/types/ethereum/BaseError.d.ts:64 > **code**: `number` -Error code, analogous to the code in JSON RPC error. +Error code (-32006), a non-standard extension for this specific error. #### Inherited from @@ -113,7 +120,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -127,7 +134,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -143,7 +150,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -171,7 +178,7 @@ Optional object containing additional information about the error. #### Defined in -packages/errors/types/ethereum/BlockGasLimitExceededError.d.ts:49 +packages/errors/types/ethereum/BlockGasLimitExceededError.d.ts:56 *** @@ -187,7 +194,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -203,7 +210,7 @@ The name of the error, used to discriminate errors. #### Defined in -packages/errors/types/ethereum/BlockGasLimitExceededError.d.ts:59 +packages/errors/types/ethereum/BlockGasLimitExceededError.d.ts:66 *** @@ -217,7 +224,7 @@ packages/errors/types/ethereum/BlockGasLimitExceededError.d.ts:59 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -245,7 +252,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -255,6 +262,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -265,10 +276,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`BaseError`](BaseError.md).[`prepareStackTrace`](BaseError.md#preparestacktrace) @@ -317,7 +324,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -369,4 +376,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`BaseError`](BaseError.md).[`captureStackTrace`](BaseError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/ChainIdMismatchError.md b/tevm/docs/errors/classes/ChainIdMismatchError.md index e4e12220b9..a741d67aa6 100644 --- a/tevm/docs/errors/classes/ChainIdMismatchError.md +++ b/tevm/docs/errors/classes/ChainIdMismatchError.md @@ -83,7 +83,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -97,7 +97,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -113,7 +113,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -127,7 +127,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -143,7 +143,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -175,7 +175,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -205,7 +205,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -233,7 +233,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -243,6 +243,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -253,10 +257,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`BaseError`](BaseError.md).[`prepareStackTrace`](BaseError.md#preparestacktrace) @@ -305,7 +305,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -357,4 +357,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`BaseError`](BaseError.md).[`captureStackTrace`](BaseError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/CodeSizeExceedsMaximumError.md b/tevm/docs/errors/classes/CodeSizeExceedsMaximumError.md index 9ef39490c6..af42f1adea 100644 --- a/tevm/docs/errors/classes/CodeSizeExceedsMaximumError.md +++ b/tevm/docs/errors/classes/CodeSizeExceedsMaximumError.md @@ -119,7 +119,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -133,7 +133,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -149,7 +149,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -163,7 +163,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -179,7 +179,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -211,7 +211,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -241,7 +241,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -269,7 +269,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -289,6 +289,10 @@ packages/errors/types/ethereum/ethereumjs/CodeSizeExceedsMaximumError.d.ts:57 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -299,10 +303,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`GasLimitExceededError`](GasLimitExceededError.md).[`prepareStackTrace`](GasLimitExceededError.md#preparestacktrace) @@ -351,7 +351,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -403,4 +403,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`GasLimitExceededError`](GasLimitExceededError.md).[`captureStackTrace`](GasLimitExceededError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/CodeStoreOutOfGasError.md b/tevm/docs/errors/classes/CodeStoreOutOfGasError.md index beaaa7a17b..e6857c2d64 100644 --- a/tevm/docs/errors/classes/CodeStoreOutOfGasError.md +++ b/tevm/docs/errors/classes/CodeStoreOutOfGasError.md @@ -108,7 +108,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -122,7 +122,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -138,7 +138,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -152,7 +152,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -168,7 +168,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -200,7 +200,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -230,7 +230,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -258,7 +258,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -278,6 +278,10 @@ packages/errors/types/ethereum/ethereumjs/CodeStoreOutOfGasError.d.ts:55 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -288,10 +292,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`GasLimitExceededError`](GasLimitExceededError.md).[`prepareStackTrace`](GasLimitExceededError.md#preparestacktrace) @@ -340,7 +340,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -392,4 +392,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`GasLimitExceededError`](GasLimitExceededError.md).[`captureStackTrace`](GasLimitExceededError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/CommonMismatchError.md b/tevm/docs/errors/classes/CommonMismatchError.md index 3d1c68efb6..8380a73a2a 100644 --- a/tevm/docs/errors/classes/CommonMismatchError.md +++ b/tevm/docs/errors/classes/CommonMismatchError.md @@ -10,29 +10,29 @@ Represents an error that occurs when the Common for a given block does not match Common mismatch errors can occur due to: - Discrepancies between the Common configurations for a block and the VM. +- Attempting to use features from a different hardfork than what's configured. ## Example ```typescript import { CommonMismatchError } from '@tevm/errors' +import { createMemoryClient } from '@tevm/memory-client' +import { Hardfork } from '@tevm/common' + +const client = createMemoryClient({ hardfork: Hardfork.Shanghai }) + try { - // Some operation that can throw a CommonMismatchError + await client.setChain({ hardfork: Hardfork.London }) + // This might throw a CommonMismatchError if the operation is incompatible } catch (error) { if (error instanceof CommonMismatchError) { - console.error(error.message); - // Handle the common mismatch error + console.error('Common mismatch:', error.message) + console.log('Documentation:', error.docsLink) + // Handle the common mismatch error, possibly by updating the client configuration } } ``` -## Param - -A human-readable error message. - -## Param - -Additional parameters for the BaseError. - ## Extends - [`ExecutionError`](ExecutionError.md) @@ -41,7 +41,7 @@ Additional parameters for the BaseError. ### new CommonMismatchError() -> **new CommonMismatchError**(`message`?, `args`?, `tag`?): [`CommonMismatchError`](CommonMismatchError.md) +> **new CommonMismatchError**(`message`?, `args`?): [`CommonMismatchError`](CommonMismatchError.md) Constructs a CommonMismatchError. @@ -53,11 +53,7 @@ Human-readable error message. • **args?**: [`CommonMismatchErrorParameters`](../type-aliases/CommonMismatchErrorParameters.md) -Additional parameters for the BaseError. - -• **tag?**: `string` - -The tag for the error. +Additional parameters for the error. #### Returns @@ -69,7 +65,7 @@ The tag for the error. #### Defined in -packages/errors/types/common/CommonMismatchError.d.ts:49 +packages/errors/types/common/CommonMismatchError.d.ts:48 ## Properties @@ -77,15 +73,13 @@ packages/errors/types/common/CommonMismatchError.d.ts:49 > **\_tag**: `string` -Same as name, used internally. - #### Inherited from [`ExecutionError`](ExecutionError.md).[`_tag`](ExecutionError.md#_tag) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -99,7 +93,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -107,15 +101,13 @@ packages/errors/types/ethereum/BaseError.d.ts:64 > **code**: `number` -Error code, analogous to the code in JSON RPC error. - #### Inherited from [`ExecutionError`](ExecutionError.md).[`code`](ExecutionError.md#code) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -129,7 +121,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -137,15 +129,13 @@ packages/errors/types/ethereum/BaseError.d.ts:43 > **docsPath**: `undefined` \| `string` -Path to the documentation for this error. - #### Inherited from [`ExecutionError`](ExecutionError.md).[`docsPath`](ExecutionError.md#docspath) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -169,15 +159,13 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 > **metaMessages**: `undefined` \| `string`[] -Additional meta messages for more context. - #### Inherited from [`ExecutionError`](ExecutionError.md).[`metaMessages`](ExecutionError.md#metamessages) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -207,7 +195,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -235,7 +223,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -245,6 +233,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -255,10 +247,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`ExecutionError`](ExecutionError.md).[`prepareStackTrace`](ExecutionError.md#preparestacktrace) @@ -307,7 +295,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -359,4 +347,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`ExecutionError`](ExecutionError.md).[`captureStackTrace`](ExecutionError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/ContractExecutionFailedError.md b/tevm/docs/errors/classes/ContractExecutionFailedError.md index a3ebd61d9a..fe6604b595 100644 --- a/tevm/docs/errors/classes/ContractExecutionFailedError.md +++ b/tevm/docs/errors/classes/ContractExecutionFailedError.md @@ -6,19 +6,27 @@ # Class: ContractExecutionFailedError -Represents an error that occurs when the execution of a contract fails. +Represents an error that occurs when the execution of a smart contract fails. -This error is typically encountered when a smart contract fails to execute properly. +This error is typically encountered when a smart contract's execution reverts or +encounters an exception during its operation. It can be due to various reasons such as +failing assertions, out-of-gas errors, or other contract-specific logic failures. + +The error code -32004 is a non-standard extension used by some Ethereum clients to +indicate a contract execution failure. ## Example ```ts try { - // Some operation that can throw a ContractExecutionFailedError + const result = await client.call({ + to: '0x742d35Cc6634C0532925a3b844Bc454e4438f44e', + data: '0x...' // encoded function call + }) } catch (error) { if (error instanceof ContractExecutionFailedError) { - console.error(error.message); - // Handle the contract execution failed error + console.error('Contract execution failed:', error.message); + console.log('Check the contract logic or input parameters'); } } ``` @@ -55,7 +63,7 @@ Additional parameters for the BaseError. • **tag?**: `string` -The tag for the error.} +The tag for the error. #### Returns @@ -67,7 +75,7 @@ The tag for the error.} #### Defined in -packages/errors/types/ethereum/ContractExecutionFailedError.d.ts:45 +packages/errors/types/ethereum/ContractExecutionFailedError.d.ts:53 ## Properties @@ -83,7 +91,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -97,7 +105,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -105,7 +113,7 @@ packages/errors/types/ethereum/BaseError.d.ts:64 > **code**: `number` -Error code, analogous to the code in JSON RPC error. +Error code (-32004), a non-standard extension for this specific error. #### Inherited from @@ -113,7 +121,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -127,7 +135,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -143,7 +151,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -175,7 +183,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -205,7 +213,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -233,7 +241,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -243,6 +251,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -253,10 +265,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`BaseError`](BaseError.md).[`prepareStackTrace`](BaseError.md#preparestacktrace) @@ -305,7 +313,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -357,4 +365,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`BaseError`](BaseError.md).[`captureStackTrace`](BaseError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/CreateCollisionError.md b/tevm/docs/errors/classes/CreateCollisionError.md index 860b1d5842..c9a7373db5 100644 --- a/tevm/docs/errors/classes/CreateCollisionError.md +++ b/tevm/docs/errors/classes/CreateCollisionError.md @@ -99,7 +99,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -113,7 +113,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -129,7 +129,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -143,7 +143,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -159,7 +159,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -191,7 +191,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -221,7 +221,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -249,7 +249,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -269,6 +269,10 @@ packages/errors/types/ethereum/ethereumjs/CreateCollisionError.d.ts:47 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -279,10 +283,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`ExecutionError`](ExecutionError.md).[`prepareStackTrace`](ExecutionError.md#preparestacktrace) @@ -331,7 +331,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -383,4 +383,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`ExecutionError`](ExecutionError.md).[`captureStackTrace`](ExecutionError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/DecodeFunctionDataError.md b/tevm/docs/errors/classes/DecodeFunctionDataError.md index 84b5e46203..862194eb95 100644 --- a/tevm/docs/errors/classes/DecodeFunctionDataError.md +++ b/tevm/docs/errors/classes/DecodeFunctionDataError.md @@ -11,23 +11,25 @@ Not expected to be thrown unless ABI is incorrect. ## Example -```ts -const {errors} = await tevm.call({address: '0x1234'}) -errors.forEach(error => { - if (error.name === 'DecodeFunctionDataError') { - console.log(error.message) +```javascript +import { DecodeFunctionDataError } from '@tevm/errors' +import { createMemoryClient } from '@tevm/memory-client' + +const client = createMemoryClient() + +try { + const result = await client.call({ + to: '0x1234567890123456789012345678901234567890', + data: '0x...' // Invalid or mismatched function data + }) +} catch (error) { + if (error instanceof DecodeFunctionDataError) { + console.error('Decode function data error:', error.message) + console.log('Documentation:', error.docsLink) } -}) +} ``` -## Param - -A human-readable error message. - -## Param - -Optional object containing additional information about the error. - ## Extends - [`InvalidParamsError`](InvalidParamsError.md) @@ -36,7 +38,7 @@ Optional object containing additional information about the error. ### new DecodeFunctionDataError() -> **new DecodeFunctionDataError**(`message`, `meta`?, `tag`?): [`DecodeFunctionDataError`](DecodeFunctionDataError.md) +> **new DecodeFunctionDataError**(`message`, `args`?): [`DecodeFunctionDataError`](DecodeFunctionDataError.md) Constructs a DecodeFunctionDataError. @@ -46,13 +48,9 @@ Constructs a DecodeFunctionDataError. Human-readable error message. -• **meta?**: `object` - -Optional object containing additional information about the error. - -• **tag?**: `string` +• **args?**: `DecodeFunctionDataErrorParameters` -The tag for the error. +Additional parameters for the DecodeFunctionDataError. #### Returns @@ -64,7 +62,7 @@ The tag for the error. #### Defined in -packages/errors/types/utils/DecodeFunctionDataError.d.ts:31 +packages/errors/types/utils/DecodeFunctionDataError.d.ts:45 ## Properties @@ -72,15 +70,13 @@ packages/errors/types/utils/DecodeFunctionDataError.d.ts:31 > **\_tag**: `string` -Same as name, used internally. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`_tag`](InvalidParamsError.md#_tag) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -94,7 +90,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -102,15 +98,13 @@ packages/errors/types/ethereum/BaseError.d.ts:64 > **code**: `number` -Error code, analogous to the code in JSON RPC error. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`code`](InvalidParamsError.md#code) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -124,7 +118,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -132,15 +126,13 @@ packages/errors/types/ethereum/BaseError.d.ts:43 > **docsPath**: `undefined` \| `string` -Path to the documentation for this error. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`docsPath`](InvalidParamsError.md#docspath) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -164,15 +156,13 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 > **metaMessages**: `undefined` \| `string`[] -Additional meta messages for more context. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`metaMessages`](InvalidParamsError.md#metamessages) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -202,7 +192,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -230,7 +220,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -240,6 +230,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -250,10 +244,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`prepareStackTrace`](InvalidParamsError.md#preparestacktrace) @@ -302,7 +292,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -354,4 +344,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`InvalidParamsError`](InvalidParamsError.md).[`captureStackTrace`](InvalidParamsError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/DefensiveNullCheckError.md b/tevm/docs/errors/classes/DefensiveNullCheckError.md index 5fc600c6b1..1d6d421f6a 100644 --- a/tevm/docs/errors/classes/DefensiveNullCheckError.md +++ b/tevm/docs/errors/classes/DefensiveNullCheckError.md @@ -7,36 +7,31 @@ # Class: DefensiveNullCheckError Represents an error that occurs when a defensive null check is tripped. -This error should never be thrown and indicates a bug in the Tevm VM if it is Thrown - -Defensive null check errors can occur due to: -- Checking what should be an impossible null value, indicating a bug in TEVM. - -To handle this error take the following steps: -- ensure you did not modify the tevm VM in any unsupported way. -- Open an issue with a minimal reproducable example +This error should never be thrown and indicates a bug in the Tevm VM if it is thrown. ## Example -```typescript +```javascript import { DefensiveNullCheckError } from '@tevm/errors' -function assertNotNull(value: T | null): T { - const name = 'bob' - const firstLetter = name[0] - if (firstLetter === undefined) { - throw new DefensiveNullCheckError('Null value encountered in assertNotNull') + +function assertNotNull(value, message) { + if (value === null || value === undefined) { + throw new DefensiveNullCheckError(message) } return value } -``` - -## Param - -A human-readable error message. - -## Param -Additional parameters for the BaseError. +try { + const result = someFunction() + assertNotNull(result, 'Result should not be null') +} catch (error) { + if (error instanceof DefensiveNullCheckError) { + console.error('Unexpected null value:', error.message) + // This indicates a bug in the Tevm VM + reportBugToTevmRepository(error) + } +} +``` ## Extends @@ -46,7 +41,7 @@ Additional parameters for the BaseError. ### new DefensiveNullCheckError() -> **new DefensiveNullCheckError**(`message`?, `args`?, `tag`?): [`DefensiveNullCheckError`](DefensiveNullCheckError.md) +> **new DefensiveNullCheckError**(`message`?, `args`?): [`DefensiveNullCheckError`](DefensiveNullCheckError.md) Constructs a DefensiveNullCheckError. @@ -58,11 +53,7 @@ Human-readable error message. • **args?**: [`DefensiveNullCheckErrorParameters`](../type-aliases/DefensiveNullCheckErrorParameters.md) -Additional parameters for the BaseError. - -• **tag?**: `string` - -The tag for the error. +Additional parameters for the error. #### Returns @@ -74,7 +65,7 @@ The tag for the error. #### Defined in -packages/errors/types/defensive/DefensiveNullCheckError.d.ts:54 +packages/errors/types/defensive/DefensiveNullCheckError.d.ts:48 ## Properties @@ -82,15 +73,13 @@ packages/errors/types/defensive/DefensiveNullCheckError.d.ts:54 > **\_tag**: `string` -Same as name, used internally. - #### Inherited from [`InternalError`](InternalError.md).[`_tag`](InternalError.md#_tag) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -104,7 +93,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -112,15 +101,13 @@ packages/errors/types/ethereum/BaseError.d.ts:64 > **code**: `number` -Error code, analogous to the code in JSON RPC error. - #### Inherited from [`InternalError`](InternalError.md).[`code`](InternalError.md#code) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -134,7 +121,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -142,15 +129,13 @@ packages/errors/types/ethereum/BaseError.d.ts:43 > **docsPath**: `undefined` \| `string` -Path to the documentation for this error. - #### Inherited from [`InternalError`](InternalError.md).[`docsPath`](InternalError.md#docspath) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -182,7 +167,7 @@ Optional object containing additional information about the error. #### Defined in -packages/errors/types/ethereum/InternalErrorError.d.ts:49 +packages/errors/types/ethereum/InternalErrorError.d.ts:53 *** @@ -190,15 +175,13 @@ packages/errors/types/ethereum/InternalErrorError.d.ts:49 > **metaMessages**: `undefined` \| `string`[] -Additional meta messages for more context. - #### Inherited from [`InternalError`](InternalError.md).[`metaMessages`](InternalError.md#metamessages) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -228,7 +211,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -256,7 +239,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -266,6 +249,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -276,10 +263,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`InternalError`](InternalError.md).[`prepareStackTrace`](InternalError.md#preparestacktrace) @@ -328,7 +311,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -380,4 +363,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`InternalError`](InternalError.md).[`captureStackTrace`](InternalError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/EipNotEnabledError.md b/tevm/docs/errors/classes/EipNotEnabledError.md index c93b6acccf..bee31590a3 100644 --- a/tevm/docs/errors/classes/EipNotEnabledError.md +++ b/tevm/docs/errors/classes/EipNotEnabledError.md @@ -11,30 +11,31 @@ Represents an error that occurs when an EIP (Ethereum Improvement Proposal) is n EIP not enabled errors can occur due to: - Attempting to use features or operations that require a specific EIP which is not enabled in the VM. -EIPs can be set on common and passed into createMemoryClient - ## Example ```typescript import { EipNotEnabledError } from '@tevm/errors' +import { createMemoryClient } from '@tevm/memory-client' +import { Hardfork } from '@tevm/common' + +const client = createMemoryClient({ hardfork: Hardfork.London }) + try { - // Some operation that can throw an EipNotEnabledError + // Attempt an operation that requires an EIP not enabled in London + await client.call({ + to: '0x...', + data: '0x...', + // Assuming this operation requires a post-London EIP + }) } catch (error) { if (error instanceof EipNotEnabledError) { - console.error(error.message); - // Handle the EIP not enabled error + console.error('EIP not enabled:', error.message) + console.log('Documentation:', error.docsLink) + // Handle the error, possibly by updating the client to a newer hardfork } } ``` -## Param - -A human-readable error message. - -## Param - -Additional parameters for the BaseError. - ## Extends - [`ExecutionError`](ExecutionError.md) @@ -43,7 +44,7 @@ Additional parameters for the BaseError. ### new EipNotEnabledError() -> **new EipNotEnabledError**(`message`?, `args`?, `tag`?): [`EipNotEnabledError`](EipNotEnabledError.md) +> **new EipNotEnabledError**(`message`?, `args`?): [`EipNotEnabledError`](EipNotEnabledError.md) Constructs an EipNotEnabledError. @@ -55,11 +56,7 @@ Human-readable error message. • **args?**: [`EipNotEnabledErrorParameters`](../type-aliases/EipNotEnabledErrorParameters.md) -Additional parameters for the BaseError. - -• **tag?**: `string` - -The tag for the error. +Additional parameters for the error. #### Returns @@ -79,15 +76,13 @@ packages/errors/types/common/EipNotEnabledError.d.ts:51 > **\_tag**: `string` -Same as name, used internally. - #### Inherited from [`ExecutionError`](ExecutionError.md).[`_tag`](ExecutionError.md#_tag) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -101,7 +96,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -109,15 +104,13 @@ packages/errors/types/ethereum/BaseError.d.ts:64 > **code**: `number` -Error code, analogous to the code in JSON RPC error. - #### Inherited from [`ExecutionError`](ExecutionError.md).[`code`](ExecutionError.md#code) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -131,7 +124,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -139,15 +132,13 @@ packages/errors/types/ethereum/BaseError.d.ts:43 > **docsPath**: `undefined` \| `string` -Path to the documentation for this error. - #### Inherited from [`ExecutionError`](ExecutionError.md).[`docsPath`](ExecutionError.md#docspath) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -171,15 +162,13 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 > **metaMessages**: `undefined` \| `string`[] -Additional meta messages for more context. - #### Inherited from [`ExecutionError`](ExecutionError.md).[`metaMessages`](ExecutionError.md#metamessages) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -209,7 +198,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -237,7 +226,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -247,6 +236,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -257,10 +250,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`ExecutionError`](ExecutionError.md).[`prepareStackTrace`](ExecutionError.md#preparestacktrace) @@ -309,7 +298,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -361,4 +350,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`ExecutionError`](ExecutionError.md).[`captureStackTrace`](ExecutionError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/EncodeFunctionReturnDataError.md b/tevm/docs/errors/classes/EncodeFunctionReturnDataError.md index 218b3013ff..98c1bd7123 100644 --- a/tevm/docs/errors/classes/EncodeFunctionReturnDataError.md +++ b/tevm/docs/errors/classes/EncodeFunctionReturnDataError.md @@ -6,31 +6,33 @@ # Class: EncodeFunctionReturnDataError -Represents an error that occurs when encoding function data fails. +Represents an error that occurs when encoding function return data fails. Not expected to be thrown because the initial validation should have caught any errors and thrown more specific errors. ## Example -```ts +```javascript +import { EncodeFunctionReturnDataError } from '@tevm/errors' +import { createMemoryClient } from '@tevm/memory-client' + +const client = createMemoryClient() + try { - // Some operation that can throw an EncodeFunctionReturnDataError + const result = await client.contract({ + address: '0x1234567890123456789012345678901234567890', + abi: [...], + functionName: 'someFunction', + }) + // Assume some internal error occurs during encoding of the return data } catch (error) { if (error instanceof EncodeFunctionReturnDataError) { - console.error(error.message); - // Handle the encode function return data error + console.error('Encode function return data error:', error.message) + console.log('Documentation:', error.docsLink) } } ``` -## Param - -A human-readable error message. - -## Param - -Optional object containing additional information about the error. - ## Extends - [`InvalidParamsError`](InvalidParamsError.md) @@ -39,7 +41,7 @@ Optional object containing additional information about the error. ### new EncodeFunctionReturnDataError() -> **new EncodeFunctionReturnDataError**(`message`, `meta`?, `tag`?): [`EncodeFunctionReturnDataError`](EncodeFunctionReturnDataError.md) +> **new EncodeFunctionReturnDataError**(`message`, `args`?): [`EncodeFunctionReturnDataError`](EncodeFunctionReturnDataError.md) Constructs an EncodeFunctionReturnDataError. @@ -49,13 +51,9 @@ Constructs an EncodeFunctionReturnDataError. Human-readable error message. -• **meta?**: `object` +• **args?**: `EncodeFunctionReturnDataErrorParameters` -Optional object containing additional information about the error. - -• **tag?**: `string` - -The tag for the error. +Additional parameters for the EncodeFunctionReturnDataError. #### Returns @@ -67,7 +65,7 @@ The tag for the error. #### Defined in -packages/errors/types/utils/EncodeFunctionReturnDataError.d.ts:34 +packages/errors/types/utils/EncodeFunctionReturnDataError.d.ts:48 ## Properties @@ -75,15 +73,13 @@ packages/errors/types/utils/EncodeFunctionReturnDataError.d.ts:34 > **\_tag**: `string` -Same as name, used internally. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`_tag`](InvalidParamsError.md#_tag) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -97,7 +93,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -105,15 +101,13 @@ packages/errors/types/ethereum/BaseError.d.ts:64 > **code**: `number` -Error code, analogous to the code in JSON RPC error. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`code`](InvalidParamsError.md#code) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -127,7 +121,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -135,15 +129,13 @@ packages/errors/types/ethereum/BaseError.d.ts:43 > **docsPath**: `undefined` \| `string` -Path to the documentation for this error. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`docsPath`](InvalidParamsError.md#docspath) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -167,15 +159,13 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 > **metaMessages**: `undefined` \| `string`[] -Additional meta messages for more context. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`metaMessages`](InvalidParamsError.md#metamessages) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -205,7 +195,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -233,7 +223,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -243,6 +233,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -253,10 +247,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`prepareStackTrace`](InvalidParamsError.md#preparestacktrace) @@ -305,7 +295,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -357,4 +347,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`InvalidParamsError`](InvalidParamsError.md).[`captureStackTrace`](InvalidParamsError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/EvmRevertError.md b/tevm/docs/errors/classes/EvmRevertError.md index 1edcf1726b..915de0995c 100644 --- a/tevm/docs/errors/classes/EvmRevertError.md +++ b/tevm/docs/errors/classes/EvmRevertError.md @@ -109,7 +109,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -123,7 +123,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -139,7 +139,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -153,7 +153,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -169,7 +169,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -201,7 +201,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -231,7 +231,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -259,7 +259,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -279,6 +279,10 @@ packages/errors/types/ethereum/ethereumjs/EvmRevertError.d.ts:52 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -289,10 +293,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`RevertError`](RevertError.md).[`prepareStackTrace`](RevertError.md#preparestacktrace) @@ -341,7 +341,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -393,4 +393,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`RevertError`](RevertError.md).[`captureStackTrace`](RevertError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/ExecutionError.md b/tevm/docs/errors/classes/ExecutionError.md index 63d65c829f..5c5d03f7fd 100644 --- a/tevm/docs/errors/classes/ExecutionError.md +++ b/tevm/docs/errors/classes/ExecutionError.md @@ -41,7 +41,6 @@ Additional parameters for the BaseError. - [`StopError`](StopError.md) - [`OutOfRangeError`](OutOfRangeError.md) - [`InvalidJumpError`](InvalidJumpError.md) -- [`AuthInvalidSError`](AuthInvalidSError.md) - [`InvalidProofError`](InvalidProofError.md) - [`AuthCallUnsetError`](AuthCallUnsetError.md) - [`StackOverflowError`](StackOverflowError.md) @@ -61,7 +60,6 @@ Additional parameters for the BaseError. - [`BLS12381FpNotInFieldError`](BLS12381FpNotInFieldError.md) - [`InitcodeSizeViolationError`](InitcodeSizeViolationError.md) - [`InvalidBytecodeResultError`](InvalidBytecodeResultError.md) -- [`AuthCallNonZeroValueExtError`](AuthCallNonZeroValueExtError.md) - [`BLS12381PointNotOnCurveError`](BLS12381PointNotOnCurveError.md) - [`BLS12381InvalidInputLengthError`](BLS12381InvalidInputLengthError.md) - [`ValueOverflowError`](ValueOverflowError.md) @@ -116,7 +114,7 @@ More discriminated version of name. Can be used to discriminate between errors w #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -130,7 +128,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -146,7 +144,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -160,7 +158,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -176,7 +174,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -208,7 +206,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -238,7 +236,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -266,7 +264,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -276,6 +274,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -286,10 +288,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`BaseError`](BaseError.md).[`prepareStackTrace`](BaseError.md#preparestacktrace) @@ -338,7 +336,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -390,4 +388,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`BaseError`](BaseError.md).[`captureStackTrace`](BaseError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/ForkError.md b/tevm/docs/errors/classes/ForkError.md index 2d941239ac..8b7ba3eeb9 100644 --- a/tevm/docs/errors/classes/ForkError.md +++ b/tevm/docs/errors/classes/ForkError.md @@ -8,45 +8,32 @@ Represents an error thrown when attempting to fetch a resource from a Forked transport. If the underlying JSON-RPC call has an error code, the error code will be proxied to the ForkError. -Most tevm methods return these errors as values if `throwOnFail` is set to `false` and a forkUrl is provided ## Example +```javascript +import { ForkError } from '@tevm/errors' +import { createMemoryClient } from '@tevm/memory-client' +import { http } from '@tevm/jsonrpc' + +const client = createMemoryClient({ + fork: { + url: 'https://mainnet.example.com' + } +}) + try { - // Some operation that can throw an ForkError + await client.getBalance('0x...') } catch (error) { if (error instanceof ForkError) { - console.error(error.message); - // Handle the account locked error + console.error('Fork error:', error.message) + console.log('Error code:', error.code) + console.log('Documentation:', error.docsLink) + // Handle the fork error, e.g., by retrying or using a different RPC endpoint } } - -To debug this error check to see if there might be a misconfiguration or rate limit of the -fork transport. - -If the issue is a rate limit consider using the `rateLimit` transport options to limit how many -requests tevm are made. -```typescript -import { rateLimit, http } from "@tevm/jsonrpc" -import { createMemoryClient } from "@tevm/memory-client" - -const client = createMemoryClient({ - fork: { - transport: rateLimit( - http('https://mainnet.optimism.io'), { browser: false, requestsPerSecond: 25 } - ) - ) -}} ``` -## Param - -A human-readable error message. - -## Param - -Additional parameters for the BaseError. - ## Extends - [`BaseError`](BaseError.md) @@ -55,9 +42,9 @@ Additional parameters for the BaseError. ### new ForkError() -> **new ForkError**(`message`, `args`, `tag`?): [`ForkError`](ForkError.md) +> **new ForkError**(`message`, `args`): [`ForkError`](ForkError.md) -Constructs an ForkError. +Constructs a ForkError. #### Parameters @@ -67,9 +54,7 @@ Human-readable error message. • **args**: [`ForkErrorParameters`](../type-aliases/ForkErrorParameters.md) -Additional parameters for the BaseError. - -• **tag?**: `string` +Additional parameters for the error. #### Returns @@ -81,7 +66,7 @@ Additional parameters for the BaseError. #### Defined in -packages/errors/types/fork/ForkError.d.ts:62 +packages/errors/types/fork/ForkError.d.ts:49 ## Properties @@ -89,15 +74,13 @@ packages/errors/types/fork/ForkError.d.ts:62 > **\_tag**: `string` -Same as name, used internally. - #### Inherited from [`BaseError`](BaseError.md).[`_tag`](BaseError.md#_tag) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -111,7 +94,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -119,15 +102,13 @@ packages/errors/types/ethereum/BaseError.d.ts:64 > **code**: `number` -Error code, analogous to the code in JSON RPC error. - #### Inherited from [`BaseError`](BaseError.md).[`code`](BaseError.md#code) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -141,7 +122,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -149,15 +130,13 @@ packages/errors/types/ethereum/BaseError.d.ts:43 > **docsPath**: `undefined` \| `string` -Path to the documentation for this error. - #### Inherited from [`BaseError`](BaseError.md).[`docsPath`](BaseError.md#docspath) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -165,8 +144,6 @@ packages/errors/types/ethereum/BaseError.d.ts:47 > **message**: `string` -Human-readable error message. - #### Inherited from [`BaseError`](BaseError.md).[`message`](BaseError.md#message) @@ -181,15 +158,13 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 > **metaMessages**: `undefined` \| `string`[] -Additional meta messages for more context. - #### Inherited from [`BaseError`](BaseError.md).[`metaMessages`](BaseError.md#metamessages) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -197,8 +172,6 @@ packages/errors/types/ethereum/BaseError.d.ts:51 > **name**: `string` -The name of the error, used to discriminate errors. - #### Inherited from [`BaseError`](BaseError.md).[`name`](BaseError.md#name) @@ -219,7 +192,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -247,7 +220,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -257,6 +230,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -267,10 +244,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`BaseError`](BaseError.md).[`prepareStackTrace`](BaseError.md#preparestacktrace) @@ -319,7 +292,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -371,4 +344,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`BaseError`](BaseError.md).[`captureStackTrace`](BaseError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/GasLimitExceededError.md b/tevm/docs/errors/classes/GasLimitExceededError.md index f4aa634ead..1a752d8ad4 100644 --- a/tevm/docs/errors/classes/GasLimitExceededError.md +++ b/tevm/docs/errors/classes/GasLimitExceededError.md @@ -87,7 +87,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -101,7 +101,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -117,7 +117,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -131,7 +131,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -147,7 +147,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -179,7 +179,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -209,7 +209,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -237,7 +237,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -247,6 +247,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -257,10 +261,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`BaseError`](BaseError.md).[`prepareStackTrace`](BaseError.md#preparestacktrace) @@ -309,7 +309,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -361,4 +361,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`BaseError`](BaseError.md).[`captureStackTrace`](BaseError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/InitcodeSizeViolationError.md b/tevm/docs/errors/classes/InitcodeSizeViolationError.md index bebc8e1a18..d3de0217ac 100644 --- a/tevm/docs/errors/classes/InitcodeSizeViolationError.md +++ b/tevm/docs/errors/classes/InitcodeSizeViolationError.md @@ -99,7 +99,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -113,7 +113,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -129,7 +129,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -143,7 +143,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -159,7 +159,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -191,7 +191,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -221,7 +221,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -249,7 +249,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -269,6 +269,10 @@ packages/errors/types/ethereum/ethereumjs/InitcodeSizeViolationError.d.ts:47 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -279,10 +283,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`ExecutionError`](ExecutionError.md).[`prepareStackTrace`](ExecutionError.md#preparestacktrace) @@ -331,7 +331,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -383,4 +383,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`ExecutionError`](ExecutionError.md).[`captureStackTrace`](ExecutionError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/InsufficientBalanceError.md b/tevm/docs/errors/classes/InsufficientBalanceError.md index 55b299bc55..9e5ee2400e 100644 --- a/tevm/docs/errors/classes/InsufficientBalanceError.md +++ b/tevm/docs/errors/classes/InsufficientBalanceError.md @@ -101,7 +101,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -115,7 +115,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -131,7 +131,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -145,7 +145,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -161,7 +161,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -193,7 +193,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -223,7 +223,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -251,7 +251,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -271,6 +271,10 @@ packages/errors/types/ethereum/ethereumjs/InsufficientBalanceError.d.ts:48 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -281,10 +285,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`ExecutionError`](ExecutionError.md).[`prepareStackTrace`](ExecutionError.md#preparestacktrace) @@ -333,7 +333,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -385,4 +385,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`ExecutionError`](ExecutionError.md).[`captureStackTrace`](ExecutionError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/InsufficientFundsError.md b/tevm/docs/errors/classes/InsufficientFundsError.md index c121814d14..b3d0af651b 100644 --- a/tevm/docs/errors/classes/InsufficientFundsError.md +++ b/tevm/docs/errors/classes/InsufficientFundsError.md @@ -83,7 +83,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -97,7 +97,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -113,7 +113,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -127,7 +127,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -143,7 +143,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -175,7 +175,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -205,7 +205,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -233,7 +233,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -243,6 +243,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -253,10 +257,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`BaseError`](BaseError.md).[`prepareStackTrace`](BaseError.md#preparestacktrace) @@ -305,7 +305,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -357,4 +357,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`BaseError`](BaseError.md).[`captureStackTrace`](BaseError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/InsufficientPermissionsError.md b/tevm/docs/errors/classes/InsufficientPermissionsError.md index e46572a98b..72b194565d 100644 --- a/tevm/docs/errors/classes/InsufficientPermissionsError.md +++ b/tevm/docs/errors/classes/InsufficientPermissionsError.md @@ -83,7 +83,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -97,7 +97,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -113,7 +113,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -127,7 +127,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -143,7 +143,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -175,7 +175,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -205,7 +205,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -233,7 +233,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -243,6 +243,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -253,10 +257,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`BaseError`](BaseError.md).[`prepareStackTrace`](BaseError.md#preparestacktrace) @@ -305,7 +305,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -357,4 +357,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`BaseError`](BaseError.md).[`captureStackTrace`](BaseError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/InternalError.md b/tevm/docs/errors/classes/InternalError.md index 5764102c9f..f7a5cbebe9 100644 --- a/tevm/docs/errors/classes/InternalError.md +++ b/tevm/docs/errors/classes/InternalError.md @@ -8,17 +8,24 @@ Represents an internal JSON-RPC error. -This error is typically encountered when there is an internal error on the server. +This error is typically encountered when there is an unexpected internal error on the server. +It's a catch-all for errors that don't fall into more specific categories and usually indicates +a problem with the Ethereum node or the JSON-RPC server itself, rather than with the request. + +The error code -32603 is a standard JSON-RPC error code for internal errors. ## Example ```ts try { - // Some operation that can throw an InternalError + await client.call({ + to: '0x742d35Cc6634C0532925a3b844Bc454e4438f44e', + data: '0x...' // some method call + }) } catch (error) { if (error instanceof InternalError) { - console.error(error.message); - // Handle the internal error + console.error('Internal error:', error.message); + console.log('This is likely a problem with the Ethereum node. Try again later or contact the node operator.'); } } ``` @@ -74,7 +81,7 @@ The tag for the error. #### Defined in -packages/errors/types/ethereum/InternalErrorError.d.ts:45 +packages/errors/types/ethereum/InternalErrorError.d.ts:52 ## Properties @@ -90,7 +97,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -104,7 +111,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -112,7 +119,7 @@ packages/errors/types/ethereum/BaseError.d.ts:64 > **code**: `number` -Error code, analogous to the code in JSON RPC error. +Error code (-32603), standard JSON-RPC error code for internal errors. #### Inherited from @@ -120,7 +127,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -134,7 +141,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -150,7 +157,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -178,7 +185,7 @@ Optional object containing additional information about the error. #### Defined in -packages/errors/types/ethereum/InternalErrorError.d.ts:49 +packages/errors/types/ethereum/InternalErrorError.d.ts:53 *** @@ -194,7 +201,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -224,7 +231,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -252,7 +259,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -262,6 +269,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -272,10 +283,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`BaseError`](BaseError.md).[`prepareStackTrace`](BaseError.md#preparestacktrace) @@ -324,7 +331,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -376,4 +383,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`BaseError`](BaseError.md).[`captureStackTrace`](BaseError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/InternalEvmError.md b/tevm/docs/errors/classes/InternalEvmError.md index df47952e13..face0ed14b 100644 --- a/tevm/docs/errors/classes/InternalEvmError.md +++ b/tevm/docs/errors/classes/InternalEvmError.md @@ -97,7 +97,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -111,7 +111,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -127,7 +127,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -141,7 +141,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -157,7 +157,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -189,7 +189,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -219,7 +219,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -247,7 +247,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -267,6 +267,10 @@ packages/errors/types/ethereum/ethereumjs/InternalEvmError.d.ts:46 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -277,10 +281,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`BaseError`](BaseError.md).[`prepareStackTrace`](BaseError.md#preparestacktrace) @@ -329,7 +329,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -381,4 +381,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`BaseError`](BaseError.md).[`captureStackTrace`](BaseError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/InternalRpcError.md b/tevm/docs/errors/classes/InternalRpcError.md index 1d432e9cbc..d9ddfc0a15 100644 --- a/tevm/docs/errors/classes/InternalRpcError.md +++ b/tevm/docs/errors/classes/InternalRpcError.md @@ -30,7 +30,7 @@ #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:107 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:103 ## Properties @@ -58,7 +58,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es2022.err #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:20 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:20 *** @@ -72,7 +72,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:17 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:19 *** @@ -86,7 +86,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:18 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:20 *** @@ -114,7 +114,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:19 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:21 *** @@ -122,13 +122,13 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid > **name**: `string` -#### Overrides +#### Inherited from `RpcError.name` #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:105 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:24 *** @@ -142,7 +142,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:20 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:22 *** @@ -170,7 +170,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:22 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:23 *** @@ -180,7 +180,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:106 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:102 *** @@ -190,6 +190,10 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -200,10 +204,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from `RpcError.prepareStackTrace` @@ -244,7 +244,7 @@ node\_modules/.pnpm/@types+node@20.14.8/node\_modules/@types/node/globals.d.ts:3 ##### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:24 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:26 #### walk(fn) @@ -264,7 +264,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid ##### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:25 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:27 *** @@ -316,4 +316,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +`RpcError.captureStackTrace` + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/InvalidAbiError.md b/tevm/docs/errors/classes/InvalidAbiError.md index ff4ccee6a0..ea2c4047f1 100644 --- a/tevm/docs/errors/classes/InvalidAbiError.md +++ b/tevm/docs/errors/classes/InvalidAbiError.md @@ -6,31 +6,32 @@ # Class: InvalidAbiError -Represents an error that occurs when the ABI shape is invalid. +Represents an error that occurs when the ABI is invalid. -This error is typically encountered when the ABI provided for a contract is malformed or does not conform to the expected structure. +This error is typically encountered when a contract interaction or ABI-related operation receives an invalid or malformed ABI. ## Example -```ts +```javascript +import { InvalidAbiError } from '@tevm/errors' +import { createMemoryClient } from '@tevm/memory-client' + +const client = createMemoryClient() + try { - // Some operation that can throw an InvalidAbiError + await client.contract({ + abi: 'invalid_abi', // This should be a valid ABI array + address: '0x...', + functionName: 'someFunction', + }) } catch (error) { if (error instanceof InvalidAbiError) { - console.error(error.message); - // Handle the invalid ABI error + console.error('Invalid ABI:', error.message) + console.log('Documentation:', error.docsLink) } } ``` -## Param - -A human-readable error message. - -## Param - -Additional parameters for the InvalidParamsError. - ## Extends - [`InvalidParamsError`](InvalidParamsError.md) @@ -39,9 +40,9 @@ Additional parameters for the InvalidParamsError. ### new InvalidAbiError() -> **new InvalidAbiError**(`message`, `args`?, `tag`?): [`InvalidAbiError`](InvalidAbiError.md) +> **new InvalidAbiError**(`message`, `args`?): [`InvalidAbiError`](InvalidAbiError.md) -Constructs an InvalidParamsError. +Constructs an InvalidAbiError. #### Parameters @@ -49,25 +50,21 @@ Constructs an InvalidParamsError. Human-readable error message. -• **args?**: [`InvalidParamsErrorParameters`](../type-aliases/InvalidParamsErrorParameters.md) +• **args?**: [`InvalidAbiErrorParameters`](../type-aliases/InvalidAbiErrorParameters.md) -Additional parameters for the BaseError. - -• **tag?**: `string` - -The tag for the error. +Additional parameters for the InvalidAbiError. #### Returns [`InvalidAbiError`](InvalidAbiError.md) -#### Inherited from +#### Overrides [`InvalidParamsError`](InvalidParamsError.md).[`constructor`](InvalidParamsError.md#constructors) #### Defined in -packages/errors/types/ethereum/InvalidParamsError.d.ts:45 +packages/errors/types/input/InvalidAbiError.d.ts:47 ## Properties @@ -75,15 +72,13 @@ packages/errors/types/ethereum/InvalidParamsError.d.ts:45 > **\_tag**: `string` -Same as name, used internally. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`_tag`](InvalidParamsError.md#_tag) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -97,7 +92,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -105,15 +100,13 @@ packages/errors/types/ethereum/BaseError.d.ts:64 > **code**: `number` -Error code, analogous to the code in JSON RPC error. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`code`](InvalidParamsError.md#code) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -127,7 +120,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -135,15 +128,13 @@ packages/errors/types/ethereum/BaseError.d.ts:43 > **docsPath**: `undefined` \| `string` -Path to the documentation for this error. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`docsPath`](InvalidParamsError.md#docspath) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -167,15 +158,13 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 > **metaMessages**: `undefined` \| `string`[] -Additional meta messages for more context. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`metaMessages`](InvalidParamsError.md#metamessages) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -205,7 +194,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -233,7 +222,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -243,6 +232,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -253,10 +246,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`prepareStackTrace`](InvalidParamsError.md#preparestacktrace) @@ -305,7 +294,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -357,4 +346,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`InvalidParamsError`](InvalidParamsError.md).[`captureStackTrace`](InvalidParamsError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/InvalidAddressError.md b/tevm/docs/errors/classes/InvalidAddressError.md index a9ba5d2b48..bced7ac166 100644 --- a/tevm/docs/errors/classes/InvalidAddressError.md +++ b/tevm/docs/errors/classes/InvalidAddressError.md @@ -83,7 +83,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -97,7 +97,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -113,7 +113,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -127,7 +127,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -143,7 +143,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -175,7 +175,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -205,7 +205,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -233,7 +233,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -243,6 +243,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -253,10 +257,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`BaseError`](BaseError.md).[`prepareStackTrace`](BaseError.md#preparestacktrace) @@ -305,7 +305,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -357,4 +357,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`BaseError`](BaseError.md).[`captureStackTrace`](BaseError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/InvalidArgsError.md b/tevm/docs/errors/classes/InvalidArgsError.md index 175194224e..57b0a650ea 100644 --- a/tevm/docs/errors/classes/InvalidArgsError.md +++ b/tevm/docs/errors/classes/InvalidArgsError.md @@ -6,31 +6,33 @@ # Class: InvalidArgsError -Represents an error that occurs when arguments provided to a contract or script call are invalid. +Represents an error that occurs when the arguments provided to a function or method are invalid. -This error is typically encountered when the arguments provided do not match the expected types or structure required by the contract or script. +This error is typically encountered when a function receives arguments that don't match the expected types or format. ## Example -```ts +```javascript +import { InvalidArgsError } from '@tevm/errors' +import { createMemoryClient } from '@tevm/memory-client' + +const client = createMemoryClient() + try { - // Some operation that can throw an InvalidArgsError + await client.contract({ + address: '0x...', + functionName: 'transfer', + args: ['not_an_address', 'not_a_number'], // Invalid args + abi: [...], + }) } catch (error) { if (error instanceof InvalidArgsError) { - console.error(error.message); - // Handle the invalid arguments error + console.error('Invalid arguments:', error.message) + console.log('Documentation:', error.docsLink) } } ``` -## Param - -A human-readable error message. - -## Param - -Additional parameters for the InvalidParamsError. - ## Extends - [`InvalidParamsError`](InvalidParamsError.md) @@ -39,9 +41,9 @@ Additional parameters for the InvalidParamsError. ### new InvalidArgsError() -> **new InvalidArgsError**(`message`, `args`?, `tag`?): [`InvalidArgsError`](InvalidArgsError.md) +> **new InvalidArgsError**(`message`, `args`?): [`InvalidArgsError`](InvalidArgsError.md) -Constructs an InvalidParamsError. +Constructs an InvalidArgsError. #### Parameters @@ -49,25 +51,21 @@ Constructs an InvalidParamsError. Human-readable error message. -• **args?**: [`InvalidParamsErrorParameters`](../type-aliases/InvalidParamsErrorParameters.md) +• **args?**: [`InvalidArgsErrorParameters`](../type-aliases/InvalidArgsErrorParameters.md) -Additional parameters for the BaseError. - -• **tag?**: `string` - -The tag for the error. +Additional parameters for the InvalidArgsError. #### Returns [`InvalidArgsError`](InvalidArgsError.md) -#### Inherited from +#### Overrides [`InvalidParamsError`](InvalidParamsError.md).[`constructor`](InvalidParamsError.md#constructors) #### Defined in -packages/errors/types/ethereum/InvalidParamsError.d.ts:45 +packages/errors/types/input/InvalidArgsError.d.ts:48 ## Properties @@ -75,15 +73,13 @@ packages/errors/types/ethereum/InvalidParamsError.d.ts:45 > **\_tag**: `string` -Same as name, used internally. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`_tag`](InvalidParamsError.md#_tag) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -97,7 +93,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -105,15 +101,13 @@ packages/errors/types/ethereum/BaseError.d.ts:64 > **code**: `number` -Error code, analogous to the code in JSON RPC error. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`code`](InvalidParamsError.md#code) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -127,7 +121,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -135,15 +129,13 @@ packages/errors/types/ethereum/BaseError.d.ts:43 > **docsPath**: `undefined` \| `string` -Path to the documentation for this error. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`docsPath`](InvalidParamsError.md#docspath) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -167,15 +159,13 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 > **metaMessages**: `undefined` \| `string`[] -Additional meta messages for more context. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`metaMessages`](InvalidParamsError.md#metamessages) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -205,7 +195,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -233,7 +223,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -243,6 +233,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -253,10 +247,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`prepareStackTrace`](InvalidParamsError.md#preparestacktrace) @@ -305,7 +295,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -357,4 +347,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`InvalidParamsError`](InvalidParamsError.md).[`captureStackTrace`](InvalidParamsError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/InvalidBalanceError.md b/tevm/docs/errors/classes/InvalidBalanceError.md index 09b380831b..c6017f523b 100644 --- a/tevm/docs/errors/classes/InvalidBalanceError.md +++ b/tevm/docs/errors/classes/InvalidBalanceError.md @@ -6,31 +6,31 @@ # Class: InvalidBalanceError -Represents an error that occurs when the balance parameter is invalid. +Represents an error that occurs when an account balance is invalid. -This error is typically encountered when a transaction or operation references a balance that is malformed or does not conform to the expected structure. +This error is typically encountered when setting or manipulating account balances with invalid values. ## Example -```ts +```javascript +import { InvalidBalanceError } from '@tevm/errors' +import { createMemoryClient } from '@tevm/memory-client' + +const client = createMemoryClient() + try { - // Some operation that can throw an InvalidBalanceError + await client.setAccount({ + address: '0x...', + balance: -1000n, // Invalid negative balance + }) } catch (error) { if (error instanceof InvalidBalanceError) { - console.error(error.message); - // Handle the invalid balance error + console.error('Invalid balance:', error.message) + console.log('Documentation:', error.docsLink) } } ``` -## Param - -A human-readable error message. - -## Param - -Additional parameters for the InvalidParamsError. - ## Extends - [`InvalidParamsError`](InvalidParamsError.md) @@ -39,9 +39,9 @@ Additional parameters for the InvalidParamsError. ### new InvalidBalanceError() -> **new InvalidBalanceError**(`message`, `args`?, `tag`?): [`InvalidBalanceError`](InvalidBalanceError.md) +> **new InvalidBalanceError**(`message`, `args`?): [`InvalidBalanceError`](InvalidBalanceError.md) -Constructs an InvalidParamsError. +Constructs an InvalidBalanceError. #### Parameters @@ -49,25 +49,21 @@ Constructs an InvalidParamsError. Human-readable error message. -• **args?**: [`InvalidParamsErrorParameters`](../type-aliases/InvalidParamsErrorParameters.md) +• **args?**: [`InvalidBalanceErrorParameters`](../type-aliases/InvalidBalanceErrorParameters.md) -Additional parameters for the BaseError. - -• **tag?**: `string` - -The tag for the error. +Additional parameters for the InvalidBalanceError. #### Returns [`InvalidBalanceError`](InvalidBalanceError.md) -#### Inherited from +#### Overrides [`InvalidParamsError`](InvalidParamsError.md).[`constructor`](InvalidParamsError.md#constructors) #### Defined in -packages/errors/types/ethereum/InvalidParamsError.d.ts:45 +packages/errors/types/input/InvalidBalanceError.d.ts:46 ## Properties @@ -75,15 +71,13 @@ packages/errors/types/ethereum/InvalidParamsError.d.ts:45 > **\_tag**: `string` -Same as name, used internally. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`_tag`](InvalidParamsError.md#_tag) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -97,7 +91,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -105,15 +99,13 @@ packages/errors/types/ethereum/BaseError.d.ts:64 > **code**: `number` -Error code, analogous to the code in JSON RPC error. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`code`](InvalidParamsError.md#code) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -127,7 +119,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -135,15 +127,13 @@ packages/errors/types/ethereum/BaseError.d.ts:43 > **docsPath**: `undefined` \| `string` -Path to the documentation for this error. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`docsPath`](InvalidParamsError.md#docspath) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -167,15 +157,13 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 > **metaMessages**: `undefined` \| `string`[] -Additional meta messages for more context. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`metaMessages`](InvalidParamsError.md#metamessages) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -205,7 +193,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -233,7 +221,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -243,6 +231,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -253,10 +245,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`prepareStackTrace`](InvalidParamsError.md#preparestacktrace) @@ -305,7 +293,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -357,4 +345,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`InvalidParamsError`](InvalidParamsError.md).[`captureStackTrace`](InvalidParamsError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/InvalidBeginSubError.md b/tevm/docs/errors/classes/InvalidBeginSubError.md index 17eef4175a..f426ea9fc4 100644 --- a/tevm/docs/errors/classes/InvalidBeginSubError.md +++ b/tevm/docs/errors/classes/InvalidBeginSubError.md @@ -99,7 +99,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -113,7 +113,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -129,7 +129,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -143,7 +143,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -159,7 +159,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -191,7 +191,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -221,7 +221,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -249,7 +249,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -269,6 +269,10 @@ packages/errors/types/ethereum/ethereumjs/InvalidBeginSubError.d.ts:47 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -279,10 +283,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`ExecutionError`](ExecutionError.md).[`prepareStackTrace`](ExecutionError.md#preparestacktrace) @@ -331,7 +331,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -383,4 +383,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`ExecutionError`](ExecutionError.md).[`captureStackTrace`](ExecutionError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/InvalidBlobVersionedHashesError.md b/tevm/docs/errors/classes/InvalidBlobVersionedHashesError.md index 0f03fb04a9..ef6d94a261 100644 --- a/tevm/docs/errors/classes/InvalidBlobVersionedHashesError.md +++ b/tevm/docs/errors/classes/InvalidBlobVersionedHashesError.md @@ -12,25 +12,25 @@ This error is typically encountered when a transaction or operation references a ## Example -```ts +```javascript +import { InvalidBlobVersionedHashesError } from '@tevm/errors' +import { createMemoryClient } from '@tevm/memory-client' + +const client = createMemoryClient() + try { - // Some operation that can throw an InvalidBlobVersionedHashesError + await client.sendTransaction({ + // ... other transaction parameters + blobVersionedHashes: ['invalid_hash'], // This should be a valid versioned hash + }) } catch (error) { if (error instanceof InvalidBlobVersionedHashesError) { - console.error(error.message); - // Handle the invalid blobVersionedHashes error + console.error('Invalid blob versioned hashes:', error.message) + console.log('Documentation:', error.docsLink) } } ``` -## Param - -A human-readable error message. - -## Param - -Additional parameters for the InvalidParamsError. - ## Extends - [`InvalidParamsError`](InvalidParamsError.md) @@ -39,9 +39,9 @@ Additional parameters for the InvalidParamsError. ### new InvalidBlobVersionedHashesError() -> **new InvalidBlobVersionedHashesError**(`message`, `args`?, `tag`?): [`InvalidBlobVersionedHashesError`](InvalidBlobVersionedHashesError.md) +> **new InvalidBlobVersionedHashesError**(`message`, `args`?): [`InvalidBlobVersionedHashesError`](InvalidBlobVersionedHashesError.md) -Constructs an InvalidParamsError. +Constructs an InvalidBlobVersionedHashesError. #### Parameters @@ -49,25 +49,21 @@ Constructs an InvalidParamsError. Human-readable error message. -• **args?**: [`InvalidParamsErrorParameters`](../type-aliases/InvalidParamsErrorParameters.md) +• **args?**: [`InvalidBlobVersionedHashesErrorParameters`](../type-aliases/InvalidBlobVersionedHashesErrorParameters.md) -Additional parameters for the BaseError. - -• **tag?**: `string` - -The tag for the error. +Additional parameters for the InvalidBlobVersionedHashesError. #### Returns [`InvalidBlobVersionedHashesError`](InvalidBlobVersionedHashesError.md) -#### Inherited from +#### Overrides [`InvalidParamsError`](InvalidParamsError.md).[`constructor`](InvalidParamsError.md#constructors) #### Defined in -packages/errors/types/ethereum/InvalidParamsError.d.ts:45 +packages/errors/types/input/InvalidBlobVersionedHashesError.d.ts:46 ## Properties @@ -75,15 +71,13 @@ packages/errors/types/ethereum/InvalidParamsError.d.ts:45 > **\_tag**: `string` -Same as name, used internally. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`_tag`](InvalidParamsError.md#_tag) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -97,7 +91,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -105,15 +99,13 @@ packages/errors/types/ethereum/BaseError.d.ts:64 > **code**: `number` -Error code, analogous to the code in JSON RPC error. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`code`](InvalidParamsError.md#code) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -127,7 +119,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -135,15 +127,13 @@ packages/errors/types/ethereum/BaseError.d.ts:43 > **docsPath**: `undefined` \| `string` -Path to the documentation for this error. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`docsPath`](InvalidParamsError.md#docspath) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -167,15 +157,13 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 > **metaMessages**: `undefined` \| `string`[] -Additional meta messages for more context. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`metaMessages`](InvalidParamsError.md#metamessages) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -205,7 +193,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -233,7 +221,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -243,6 +231,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -253,10 +245,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`prepareStackTrace`](InvalidParamsError.md#preparestacktrace) @@ -305,7 +293,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -357,4 +345,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`InvalidParamsError`](InvalidParamsError.md).[`captureStackTrace`](InvalidParamsError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/InvalidBlockError.md b/tevm/docs/errors/classes/InvalidBlockError.md index 70841f8b88..63fb34ba26 100644 --- a/tevm/docs/errors/classes/InvalidBlockError.md +++ b/tevm/docs/errors/classes/InvalidBlockError.md @@ -85,7 +85,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -99,7 +99,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -115,7 +115,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -129,7 +129,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -145,7 +145,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -177,7 +177,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -207,7 +207,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -235,7 +235,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -245,6 +245,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -255,10 +259,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`prepareStackTrace`](InvalidParamsError.md#preparestacktrace) @@ -307,7 +307,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -359,4 +359,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`InvalidParamsError`](InvalidParamsError.md).[`captureStackTrace`](InvalidParamsError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/InvalidBytecodeError.md b/tevm/docs/errors/classes/InvalidBytecodeError.md index f95e22b976..e1d23af0e9 100644 --- a/tevm/docs/errors/classes/InvalidBytecodeError.md +++ b/tevm/docs/errors/classes/InvalidBytecodeError.md @@ -83,7 +83,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -97,7 +97,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -113,7 +113,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -127,7 +127,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -143,7 +143,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -175,7 +175,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -205,7 +205,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -233,7 +233,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -243,6 +243,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -253,10 +257,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`prepareStackTrace`](InvalidParamsError.md#preparestacktrace) @@ -305,7 +305,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -357,4 +357,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`InvalidParamsError`](InvalidParamsError.md).[`captureStackTrace`](InvalidParamsError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/InvalidBytecodeResultError.md b/tevm/docs/errors/classes/InvalidBytecodeResultError.md index 1966de50a5..743d8f5f33 100644 --- a/tevm/docs/errors/classes/InvalidBytecodeResultError.md +++ b/tevm/docs/errors/classes/InvalidBytecodeResultError.md @@ -99,7 +99,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -113,7 +113,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -129,7 +129,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -143,7 +143,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -159,7 +159,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -191,7 +191,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -221,7 +221,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -249,7 +249,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -269,6 +269,10 @@ packages/errors/types/ethereum/ethereumjs/InvalidBytecodeResultError.d.ts:47 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -279,10 +283,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`ExecutionError`](ExecutionError.md).[`prepareStackTrace`](ExecutionError.md#preparestacktrace) @@ -331,7 +331,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -383,4 +383,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`ExecutionError`](ExecutionError.md).[`captureStackTrace`](ExecutionError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/InvalidBytesSizeError.md b/tevm/docs/errors/classes/InvalidBytesSizeError.md index e3ec73139e..239899e6e3 100644 --- a/tevm/docs/errors/classes/InvalidBytesSizeError.md +++ b/tevm/docs/errors/classes/InvalidBytesSizeError.md @@ -10,34 +10,28 @@ Represents an error that occurs when the size of the bytes does not match the ex ## Example -```typescript +```javascript import { InvalidBytesSizeError } from '@tevm/errors' +import { hexToBytes } from '@tevm/utils' + +function requireBytes32(value) { + const bytes = hexToBytes(value) + if (bytes.length !== 32) { + throw new InvalidBytesSizeError(bytes.length, 32) + } + return bytes +} + try { - // Some operation that can throw an InvalidBytesSizeError + requireBytes32('0x1234') // This will throw an InvalidBytesSizeError } catch (error) { if (error instanceof InvalidBytesSizeError) { - console.error(error.message); - // Handle the invalid bytes size error + console.error(`Invalid bytes size: ${error.message}`) + console.log(`Actual size: ${error.size}, Expected size: ${error.expectedSize}`) } } ``` -## Param - -The actual size of the bytes. - -## Param - -The expected size of the bytes. - -## Param - -A human-readable error message. - -## Param - -Additional parameters for the BaseError. - ## Extends - [`InternalError`](InternalError.md) @@ -46,7 +40,7 @@ Additional parameters for the BaseError. ### new InvalidBytesSizeError() -> **new InvalidBytesSizeError**(`size`, `expectedSize`, `message`?, `args`?, `tag`?): [`InvalidBytesSizeError`](InvalidBytesSizeError.md) +> **new InvalidBytesSizeError**(`size`, `expectedSize`, `message`?, `args`?): [`InvalidBytesSizeError`](InvalidBytesSizeError.md) Constructs an InvalidBytesSizeError. @@ -66,11 +60,7 @@ Human-readable error message. • **args?**: [`InvalidBytesSizeErrorParameters`](../type-aliases/InvalidBytesSizeErrorParameters.md) -Additional parameters for the BaseError. - -• **tag?**: `string` - -The tag for the error.} +Additional parameters for the error. #### Returns @@ -82,7 +72,7 @@ The tag for the error.} #### Defined in -packages/errors/types/data/InvalidByteSizeError.d.ts:52 +packages/errors/types/data/InvalidByteSizeError.d.ts:49 ## Properties @@ -90,15 +80,13 @@ packages/errors/types/data/InvalidByteSizeError.d.ts:52 > **\_tag**: `string` -Same as name, used internally. - #### Inherited from [`InternalError`](InternalError.md).[`_tag`](InternalError.md#_tag) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -112,7 +100,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -120,15 +108,13 @@ packages/errors/types/ethereum/BaseError.d.ts:64 > **code**: `number` -Error code, analogous to the code in JSON RPC error. - #### Inherited from [`InternalError`](InternalError.md).[`code`](InternalError.md#code) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -142,7 +128,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -150,15 +136,25 @@ packages/errors/types/ethereum/BaseError.d.ts:43 > **docsPath**: `undefined` \| `string` -Path to the documentation for this error. - #### Inherited from [`InternalError`](InternalError.md).[`docsPath`](InternalError.md#docspath) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 + +*** + +### expectedSize + +> **expectedSize**: `number` + +The expected size of the bytes. + +#### Defined in + +packages/errors/types/data/InvalidByteSizeError.d.ts:59 *** @@ -190,7 +186,7 @@ Optional object containing additional information about the error. #### Defined in -packages/errors/types/ethereum/InternalErrorError.d.ts:49 +packages/errors/types/ethereum/InternalErrorError.d.ts:53 *** @@ -198,15 +194,13 @@ packages/errors/types/ethereum/InternalErrorError.d.ts:49 > **metaMessages**: `undefined` \| `string`[] -Additional meta messages for more context. - #### Inherited from [`InternalError`](InternalError.md).[`metaMessages`](InternalError.md#metamessages) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -236,7 +230,19 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 + +*** + +### size + +> **size**: `number` + +The actual size of the bytes. + +#### Defined in + +packages/errors/types/data/InvalidByteSizeError.d.ts:54 *** @@ -264,7 +270,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -274,6 +280,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -284,10 +294,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`InternalError`](InternalError.md).[`prepareStackTrace`](InternalError.md#preparestacktrace) @@ -336,7 +342,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -388,4 +394,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`InternalError`](InternalError.md).[`captureStackTrace`](InternalError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/InvalidCallerError.md b/tevm/docs/errors/classes/InvalidCallerError.md index ecb274ad9d..1510e1346e 100644 --- a/tevm/docs/errors/classes/InvalidCallerError.md +++ b/tevm/docs/errors/classes/InvalidCallerError.md @@ -83,7 +83,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -97,7 +97,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -113,7 +113,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -127,7 +127,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -143,7 +143,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -175,7 +175,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -205,7 +205,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -233,7 +233,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -243,6 +243,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -253,10 +257,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`prepareStackTrace`](InvalidParamsError.md#preparestacktrace) @@ -305,7 +305,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -357,4 +357,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`InvalidParamsError`](InvalidParamsError.md).[`captureStackTrace`](InvalidParamsError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/InvalidCommitmentError.md b/tevm/docs/errors/classes/InvalidCommitmentError.md index cfb92ddf6f..763428a12d 100644 --- a/tevm/docs/errors/classes/InvalidCommitmentError.md +++ b/tevm/docs/errors/classes/InvalidCommitmentError.md @@ -67,6 +67,10 @@ The tag for the error. [`InvalidCommitmentError`](InvalidCommitmentError.md) +#### Overrides + +[`ExecutionError`](ExecutionError.md).[`constructor`](ExecutionError.md#constructors) + #### Example ```typescript @@ -81,10 +85,6 @@ try { } ``` -#### Overrides - -[`ExecutionError`](ExecutionError.md).[`constructor`](ExecutionError.md#constructors) - #### Defined in packages/errors/types/ethereum/ethereumjs/InvalidCommitmentError.d.ts:67 @@ -103,7 +103,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -117,7 +117,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -133,7 +133,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -147,7 +147,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -163,7 +163,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -195,7 +195,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -225,7 +225,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -253,7 +253,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -273,6 +273,10 @@ packages/errors/types/ethereum/ethereumjs/InvalidCommitmentError.d.ts:42 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -283,10 +287,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`ExecutionError`](ExecutionError.md).[`prepareStackTrace`](ExecutionError.md#preparestacktrace) @@ -335,7 +335,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -387,4 +387,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`ExecutionError`](ExecutionError.md).[`captureStackTrace`](ExecutionError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/InvalidDataError.md b/tevm/docs/errors/classes/InvalidDataError.md index ee780b500f..357c8c5f4a 100644 --- a/tevm/docs/errors/classes/InvalidDataError.md +++ b/tevm/docs/errors/classes/InvalidDataError.md @@ -6,31 +6,32 @@ # Class: InvalidDataError -Represents an error that occurs when the data parameter is invalid. +Represents an error that occurs when the data provided is invalid. -This error is typically encountered when a transaction or operation references a data parameter that is invalid or does not conform to the expected structure. +This error is typically encountered when an operation receives invalid or malformed data. ## Example -```ts +```javascript +import { InvalidDataError } from '@tevm/errors' +import { createMemoryClient } from '@tevm/memory-client' + +const client = createMemoryClient() + try { - // Some operation that can throw an InvalidDataError + await client.sendTransaction({ + from: '0x1234567890123456789012345678901234567890', + to: '0x0987654321098765432109876543210987654321', + data: 'not_valid_hex_data', // Should be a valid hex string + }) } catch (error) { if (error instanceof InvalidDataError) { - console.error(error.message); - // Handle the invalid data error + console.error('Invalid data:', error.message) + console.log('Documentation:', error.docsLink) } } ``` -## Param - -A human-readable error message. - -## Param - -Additional parameters for the InvalidDataError. - ## Extends - [`InvalidParamsError`](InvalidParamsError.md) @@ -39,9 +40,9 @@ Additional parameters for the InvalidDataError. ### new InvalidDataError() -> **new InvalidDataError**(`message`, `args`?, `tag`?): [`InvalidDataError`](InvalidDataError.md) +> **new InvalidDataError**(`message`, `args`?): [`InvalidDataError`](InvalidDataError.md) -Constructs an InvalidParamsError. +Constructs an InvalidDataError. #### Parameters @@ -49,25 +50,21 @@ Constructs an InvalidParamsError. Human-readable error message. -• **args?**: [`InvalidParamsErrorParameters`](../type-aliases/InvalidParamsErrorParameters.md) - -Additional parameters for the BaseError. - -• **tag?**: `string` +• **args?**: [`InvalidDataErrorParameters`](../type-aliases/InvalidDataErrorParameters.md) -The tag for the error. +Additional parameters for the InvalidDataError. #### Returns [`InvalidDataError`](InvalidDataError.md) -#### Inherited from +#### Overrides [`InvalidParamsError`](InvalidParamsError.md).[`constructor`](InvalidParamsError.md#constructors) #### Defined in -packages/errors/types/ethereum/InvalidParamsError.d.ts:45 +packages/errors/types/input/InvalidDataError.d.ts:47 ## Properties @@ -75,15 +72,13 @@ packages/errors/types/ethereum/InvalidParamsError.d.ts:45 > **\_tag**: `string` -Same as name, used internally. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`_tag`](InvalidParamsError.md#_tag) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -97,7 +92,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -105,15 +100,13 @@ packages/errors/types/ethereum/BaseError.d.ts:64 > **code**: `number` -Error code, analogous to the code in JSON RPC error. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`code`](InvalidParamsError.md#code) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -127,7 +120,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -135,15 +128,13 @@ packages/errors/types/ethereum/BaseError.d.ts:43 > **docsPath**: `undefined` \| `string` -Path to the documentation for this error. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`docsPath`](InvalidParamsError.md#docspath) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -167,15 +158,13 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 > **metaMessages**: `undefined` \| `string`[] -Additional meta messages for more context. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`metaMessages`](InvalidParamsError.md#metamessages) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -205,7 +194,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -233,7 +222,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -243,6 +232,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -253,10 +246,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`prepareStackTrace`](InvalidParamsError.md#preparestacktrace) @@ -305,7 +294,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -357,4 +346,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`InvalidParamsError`](InvalidParamsError.md).[`captureStackTrace`](InvalidParamsError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/InvalidDeployedBytecodeError.md b/tevm/docs/errors/classes/InvalidDeployedBytecodeError.md index 49e059d9d3..43c26629cb 100644 --- a/tevm/docs/errors/classes/InvalidDeployedBytecodeError.md +++ b/tevm/docs/errors/classes/InvalidDeployedBytecodeError.md @@ -12,25 +12,25 @@ This error is typically encountered when a transaction or operation references a ## Example -```ts +```javascript +import { InvalidDeployedBytecodeError } from '@tevm/errors' +import { createMemoryClient } from '@tevm/memory-client' + +const client = createMemoryClient() + try { - // Some operation that can throw an InvalidDeployedBytecodeError + await client.setAccount({ + address: '0x...', + deployedBytecode: 'invalid', // This should be valid bytecode + }) } catch (error) { if (error instanceof InvalidDeployedBytecodeError) { - console.error(error.message); - // Handle the invalid deployedBytecode error + console.error('Invalid deployed bytecode:', error.message) + console.log('Documentation:', error.docsLink) } } ``` -## Param - -A human-readable error message. - -## Param - -Additional parameters for the InvalidDeployedBytecodeError. - ## Extends - [`InvalidParamsError`](InvalidParamsError.md) @@ -39,9 +39,9 @@ Additional parameters for the InvalidDeployedBytecodeError. ### new InvalidDeployedBytecodeError() -> **new InvalidDeployedBytecodeError**(`message`, `args`?, `tag`?): [`InvalidDeployedBytecodeError`](InvalidDeployedBytecodeError.md) +> **new InvalidDeployedBytecodeError**(`message`, `args`?): [`InvalidDeployedBytecodeError`](InvalidDeployedBytecodeError.md) -Constructs an InvalidParamsError. +Constructs an InvalidDeployedBytecodeError. #### Parameters @@ -49,25 +49,21 @@ Constructs an InvalidParamsError. Human-readable error message. -• **args?**: [`InvalidParamsErrorParameters`](../type-aliases/InvalidParamsErrorParameters.md) - -Additional parameters for the BaseError. - -• **tag?**: `string` +• **args?**: [`InvalidDeployedBytecodeErrorParameters`](../type-aliases/InvalidDeployedBytecodeErrorParameters.md) -The tag for the error. +Additional parameters for the InvalidDeployedBytecodeError. #### Returns [`InvalidDeployedBytecodeError`](InvalidDeployedBytecodeError.md) -#### Inherited from +#### Overrides [`InvalidParamsError`](InvalidParamsError.md).[`constructor`](InvalidParamsError.md#constructors) #### Defined in -packages/errors/types/ethereum/InvalidParamsError.d.ts:45 +packages/errors/types/input/InvalidDeployedBytecodeError.d.ts:46 ## Properties @@ -75,15 +71,13 @@ packages/errors/types/ethereum/InvalidParamsError.d.ts:45 > **\_tag**: `string` -Same as name, used internally. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`_tag`](InvalidParamsError.md#_tag) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -97,7 +91,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -105,15 +99,13 @@ packages/errors/types/ethereum/BaseError.d.ts:64 > **code**: `number` -Error code, analogous to the code in JSON RPC error. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`code`](InvalidParamsError.md#code) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -127,7 +119,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -135,15 +127,13 @@ packages/errors/types/ethereum/BaseError.d.ts:43 > **docsPath**: `undefined` \| `string` -Path to the documentation for this error. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`docsPath`](InvalidParamsError.md#docspath) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -167,15 +157,13 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 > **metaMessages**: `undefined` \| `string`[] -Additional meta messages for more context. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`metaMessages`](InvalidParamsError.md#metamessages) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -205,7 +193,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -233,7 +221,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -243,6 +231,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -253,10 +245,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`prepareStackTrace`](InvalidParamsError.md#preparestacktrace) @@ -305,7 +293,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -357,4 +345,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`InvalidParamsError`](InvalidParamsError.md).[`captureStackTrace`](InvalidParamsError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/InvalidDepthError.md b/tevm/docs/errors/classes/InvalidDepthError.md index 67f83d1b84..dad14ad16e 100644 --- a/tevm/docs/errors/classes/InvalidDepthError.md +++ b/tevm/docs/errors/classes/InvalidDepthError.md @@ -83,7 +83,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -97,7 +97,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -113,7 +113,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -127,7 +127,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -143,7 +143,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -175,7 +175,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -205,7 +205,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -233,7 +233,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -243,6 +243,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -253,10 +257,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`prepareStackTrace`](InvalidParamsError.md#preparestacktrace) @@ -305,7 +305,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -357,4 +357,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`InvalidParamsError`](InvalidParamsError.md).[`captureStackTrace`](InvalidParamsError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/InvalidEofFormatError.md b/tevm/docs/errors/classes/InvalidEofFormatError.md index 367b570ecf..1156589678 100644 --- a/tevm/docs/errors/classes/InvalidEofFormatError.md +++ b/tevm/docs/errors/classes/InvalidEofFormatError.md @@ -103,7 +103,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -117,7 +117,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -133,7 +133,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -147,7 +147,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -163,7 +163,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -195,7 +195,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -225,7 +225,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -253,7 +253,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -273,6 +273,10 @@ packages/errors/types/ethereum/ethereumjs/InvalidEofFormatError.d.ts:49 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -283,10 +287,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`ExecutionError`](ExecutionError.md).[`prepareStackTrace`](ExecutionError.md#preparestacktrace) @@ -335,7 +335,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -387,4 +387,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`ExecutionError`](ExecutionError.md).[`captureStackTrace`](ExecutionError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/InvalidFunctionNameError.md b/tevm/docs/errors/classes/InvalidFunctionNameError.md index 2261f08d3f..16317c2eeb 100644 --- a/tevm/docs/errors/classes/InvalidFunctionNameError.md +++ b/tevm/docs/errors/classes/InvalidFunctionNameError.md @@ -8,29 +8,30 @@ Represents an error that occurs when the function name is invalid. -This error is typically encountered when a transaction or operation references a function name that is invalid or does not conform to the expected structure. +This error is typically encountered when trying to call a contract function with an invalid or non-existent function name. ## Example -```ts +```javascript +import { InvalidFunctionNameError } from '@tevm/errors' +import { createMemoryClient } from '@tevm/memory-client' + +const client = createMemoryClient() + try { - // Some operation that can throw an InvalidFunctionNameError + await client.contract({ + address: '0x1234567890123456789012345678901234567890', + abi: [...], + functionName: 'nonExistentFunction', + }) } catch (error) { if (error instanceof InvalidFunctionNameError) { - console.error(error.message); - // Handle the invalid function name error + console.error('Invalid function name:', error.message) + console.log('Documentation:', error.docsLink) } } ``` -## Param - -A human-readable error message. - -## Param - -Additional parameters for the InvalidFunctionNameError. - ## Extends - [`InvalidParamsError`](InvalidParamsError.md) @@ -39,9 +40,9 @@ Additional parameters for the InvalidFunctionNameError. ### new InvalidFunctionNameError() -> **new InvalidFunctionNameError**(`message`, `args`?, `tag`?): [`InvalidFunctionNameError`](InvalidFunctionNameError.md) +> **new InvalidFunctionNameError**(`message`, `args`?): [`InvalidFunctionNameError`](InvalidFunctionNameError.md) -Constructs an InvalidParamsError. +Constructs an InvalidFunctionNameError. #### Parameters @@ -49,25 +50,21 @@ Constructs an InvalidParamsError. Human-readable error message. -• **args?**: [`InvalidParamsErrorParameters`](../type-aliases/InvalidParamsErrorParameters.md) - -Additional parameters for the BaseError. - -• **tag?**: `string` +• **args?**: [`InvalidFunctionNameErrorParameters`](../type-aliases/InvalidFunctionNameErrorParameters.md) -The tag for the error. +Additional parameters for the InvalidFunctionNameError. #### Returns [`InvalidFunctionNameError`](InvalidFunctionNameError.md) -#### Inherited from +#### Overrides [`InvalidParamsError`](InvalidParamsError.md).[`constructor`](InvalidParamsError.md#constructors) #### Defined in -packages/errors/types/ethereum/InvalidParamsError.d.ts:45 +packages/errors/types/input/InvalidFunctionNameError.d.ts:47 ## Properties @@ -75,15 +72,13 @@ packages/errors/types/ethereum/InvalidParamsError.d.ts:45 > **\_tag**: `string` -Same as name, used internally. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`_tag`](InvalidParamsError.md#_tag) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -97,7 +92,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -105,15 +100,13 @@ packages/errors/types/ethereum/BaseError.d.ts:64 > **code**: `number` -Error code, analogous to the code in JSON RPC error. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`code`](InvalidParamsError.md#code) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -127,7 +120,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -135,15 +128,13 @@ packages/errors/types/ethereum/BaseError.d.ts:43 > **docsPath**: `undefined` \| `string` -Path to the documentation for this error. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`docsPath`](InvalidParamsError.md#docspath) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -167,15 +158,13 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 > **metaMessages**: `undefined` \| `string`[] -Additional meta messages for more context. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`metaMessages`](InvalidParamsError.md#metamessages) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -205,7 +194,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -233,7 +222,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -243,6 +232,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -253,10 +246,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`prepareStackTrace`](InvalidParamsError.md#preparestacktrace) @@ -305,7 +294,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -357,4 +346,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`InvalidParamsError`](InvalidParamsError.md).[`captureStackTrace`](InvalidParamsError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/InvalidGasLimitError.md b/tevm/docs/errors/classes/InvalidGasLimitError.md index 6e3837cc50..93852bbc0e 100644 --- a/tevm/docs/errors/classes/InvalidGasLimitError.md +++ b/tevm/docs/errors/classes/InvalidGasLimitError.md @@ -8,29 +8,30 @@ Represents an error that occurs when the gas limit is invalid. -This error is typically encountered when a transaction or operation references a gas limit that is invalid or does not conform to the expected structure. +This error is typically encountered when a transaction or operation specifies an invalid gas limit. ## Example -```ts +```javascript +import { InvalidGasLimitError } from '@tevm/errors' +import { createMemoryClient } from '@tevm/memory-client' + +const client = createMemoryClient() + try { - // Some operation that can throw an InvalidGasLimitError + await client.sendTransaction({ + from: '0x1234567890123456789012345678901234567890', + to: '0x0987654321098765432109876543210987654321', + gasLimit: -1n, // Invalid negative gas limit + }) } catch (error) { if (error instanceof InvalidGasLimitError) { - console.error(error.message); - // Handle the invalid gas limit error + console.error('Invalid gas limit:', error.message) + console.log('Documentation:', error.docsLink) } } ``` -## Param - -A human-readable error message. - -## Param - -Additional parameters for the InvalidGasLimitError. - ## Extends - [`InvalidParamsError`](InvalidParamsError.md) @@ -39,9 +40,9 @@ Additional parameters for the InvalidGasLimitError. ### new InvalidGasLimitError() -> **new InvalidGasLimitError**(`message`, `args`?, `tag`?): [`InvalidGasLimitError`](InvalidGasLimitError.md) +> **new InvalidGasLimitError**(`message`, `args`?): [`InvalidGasLimitError`](InvalidGasLimitError.md) -Constructs an InvalidParamsError. +Constructs an InvalidGasLimitError. #### Parameters @@ -49,25 +50,21 @@ Constructs an InvalidParamsError. Human-readable error message. -• **args?**: [`InvalidParamsErrorParameters`](../type-aliases/InvalidParamsErrorParameters.md) - -Additional parameters for the BaseError. - -• **tag?**: `string` +• **args?**: [`InvalidGasLimitErrorParameters`](../type-aliases/InvalidGasLimitErrorParameters.md) -The tag for the error. +Additional parameters for the InvalidGasLimitError. #### Returns [`InvalidGasLimitError`](InvalidGasLimitError.md) -#### Inherited from +#### Overrides [`InvalidParamsError`](InvalidParamsError.md).[`constructor`](InvalidParamsError.md#constructors) #### Defined in -packages/errors/types/ethereum/InvalidParamsError.d.ts:45 +packages/errors/types/input/InvalidGasLimitError.d.ts:47 ## Properties @@ -75,15 +72,13 @@ packages/errors/types/ethereum/InvalidParamsError.d.ts:45 > **\_tag**: `string` -Same as name, used internally. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`_tag`](InvalidParamsError.md#_tag) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -97,7 +92,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -105,15 +100,13 @@ packages/errors/types/ethereum/BaseError.d.ts:64 > **code**: `number` -Error code, analogous to the code in JSON RPC error. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`code`](InvalidParamsError.md#code) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -127,7 +120,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -135,15 +128,13 @@ packages/errors/types/ethereum/BaseError.d.ts:43 > **docsPath**: `undefined` \| `string` -Path to the documentation for this error. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`docsPath`](InvalidParamsError.md#docspath) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -167,15 +158,13 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 > **metaMessages**: `undefined` \| `string`[] -Additional meta messages for more context. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`metaMessages`](InvalidParamsError.md#metamessages) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -205,7 +194,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -233,7 +222,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -243,6 +232,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -253,10 +246,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`prepareStackTrace`](InvalidParamsError.md#preparestacktrace) @@ -305,7 +294,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -357,4 +346,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`InvalidParamsError`](InvalidParamsError.md).[`captureStackTrace`](InvalidParamsError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/InvalidGasPriceError.md b/tevm/docs/errors/classes/InvalidGasPriceError.md index 608bc52107..9c0f717441 100644 --- a/tevm/docs/errors/classes/InvalidGasPriceError.md +++ b/tevm/docs/errors/classes/InvalidGasPriceError.md @@ -83,7 +83,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -97,7 +97,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -113,7 +113,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -127,7 +127,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -143,7 +143,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -175,7 +175,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -205,7 +205,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -233,7 +233,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -243,6 +243,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -253,10 +257,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`BaseError`](BaseError.md).[`prepareStackTrace`](BaseError.md#preparestacktrace) @@ -305,7 +305,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -357,4 +357,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`BaseError`](BaseError.md).[`captureStackTrace`](BaseError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/InvalidGasRefundError.md b/tevm/docs/errors/classes/InvalidGasRefundError.md index a5e61fb9c2..ffec8c4f52 100644 --- a/tevm/docs/errors/classes/InvalidGasRefundError.md +++ b/tevm/docs/errors/classes/InvalidGasRefundError.md @@ -8,29 +8,29 @@ Represents an error that occurs when the gas refund is invalid. -This error is typically encountered when a transaction or operation references a gas refund that is invalid or does not conform to the expected structure. +This error is typically encountered when a transaction or operation specifies an invalid gas refund value. ## Example -```ts +```javascript +import { InvalidGasRefundError } from '@tevm/errors' +import { createMemoryClient } from '@tevm/memory-client' + +const client = createMemoryClient() + try { - // Some operation that can throw an InvalidGasRefundError + await client.setAccount({ + address: '0x1234567890123456789012345678901234567890', + gasRefund: -1n, // Invalid negative gas refund + }) } catch (error) { if (error instanceof InvalidGasRefundError) { - console.error(error.message); - // Handle the invalid gas refund error + console.error('Invalid gas refund:', error.message) + console.log('Documentation:', error.docsLink) } } ``` -## Param - -A human-readable error message. - -## Param - -Additional parameters for the InvalidGasRefundError. - ## Extends - [`InvalidParamsError`](InvalidParamsError.md) @@ -39,9 +39,9 @@ Additional parameters for the InvalidGasRefundError. ### new InvalidGasRefundError() -> **new InvalidGasRefundError**(`message`, `args`?, `tag`?): [`InvalidGasRefundError`](InvalidGasRefundError.md) +> **new InvalidGasRefundError**(`message`, `args`?): [`InvalidGasRefundError`](InvalidGasRefundError.md) -Constructs an InvalidParamsError. +Constructs an InvalidGasRefundError. #### Parameters @@ -49,25 +49,21 @@ Constructs an InvalidParamsError. Human-readable error message. -• **args?**: [`InvalidParamsErrorParameters`](../type-aliases/InvalidParamsErrorParameters.md) - -Additional parameters for the BaseError. - -• **tag?**: `string` +• **args?**: [`InvalidGasRefundErrorParameters`](../type-aliases/InvalidGasRefundErrorParameters.md) -The tag for the error. +Additional parameters for the InvalidGasRefundError. #### Returns [`InvalidGasRefundError`](InvalidGasRefundError.md) -#### Inherited from +#### Overrides [`InvalidParamsError`](InvalidParamsError.md).[`constructor`](InvalidParamsError.md#constructors) #### Defined in -packages/errors/types/ethereum/InvalidParamsError.d.ts:45 +packages/errors/types/input/InvalidGasRefundError.d.ts:46 ## Properties @@ -75,15 +71,13 @@ packages/errors/types/ethereum/InvalidParamsError.d.ts:45 > **\_tag**: `string` -Same as name, used internally. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`_tag`](InvalidParamsError.md#_tag) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -97,7 +91,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -105,15 +99,13 @@ packages/errors/types/ethereum/BaseError.d.ts:64 > **code**: `number` -Error code, analogous to the code in JSON RPC error. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`code`](InvalidParamsError.md#code) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -127,7 +119,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -135,15 +127,13 @@ packages/errors/types/ethereum/BaseError.d.ts:43 > **docsPath**: `undefined` \| `string` -Path to the documentation for this error. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`docsPath`](InvalidParamsError.md#docspath) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -167,15 +157,13 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 > **metaMessages**: `undefined` \| `string`[] -Additional meta messages for more context. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`metaMessages`](InvalidParamsError.md#metamessages) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -205,7 +193,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -233,7 +221,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -243,6 +231,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -253,10 +245,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`prepareStackTrace`](InvalidParamsError.md#preparestacktrace) @@ -305,7 +293,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -357,4 +345,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`InvalidParamsError`](InvalidParamsError.md).[`captureStackTrace`](InvalidParamsError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/InvalidInputLengthError.md b/tevm/docs/errors/classes/InvalidInputLengthError.md index fe1b90ab3b..c1ab5ad763 100644 --- a/tevm/docs/errors/classes/InvalidInputLengthError.md +++ b/tevm/docs/errors/classes/InvalidInputLengthError.md @@ -97,7 +97,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -111,7 +111,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -127,7 +127,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -141,7 +141,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -157,7 +157,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -189,7 +189,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -219,7 +219,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -247,7 +247,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -267,6 +267,10 @@ packages/errors/types/ethereum/ethereumjs/InvalidInputLengthError.d.ts:46 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -277,10 +281,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`ExecutionError`](ExecutionError.md).[`prepareStackTrace`](ExecutionError.md#preparestacktrace) @@ -329,7 +329,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -381,4 +381,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`ExecutionError`](ExecutionError.md).[`captureStackTrace`](ExecutionError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/InvalidInputRpcError.md b/tevm/docs/errors/classes/InvalidInputRpcError.md index d63e18a6d2..c2b148334d 100644 --- a/tevm/docs/errors/classes/InvalidInputRpcError.md +++ b/tevm/docs/errors/classes/InvalidInputRpcError.md @@ -30,7 +30,7 @@ #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:121 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:116 ## Properties @@ -58,7 +58,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es2022.err #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:20 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:20 *** @@ -72,7 +72,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:17 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:19 *** @@ -86,7 +86,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:18 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:20 *** @@ -114,7 +114,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:19 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:21 *** @@ -122,13 +122,13 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid > **name**: `string` -#### Overrides +#### Inherited from `RpcError.name` #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:119 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:24 *** @@ -142,7 +142,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:20 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:22 *** @@ -170,7 +170,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:22 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:23 *** @@ -180,7 +180,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:120 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:115 *** @@ -190,6 +190,10 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -200,10 +204,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from `RpcError.prepareStackTrace` @@ -244,7 +244,7 @@ node\_modules/.pnpm/@types+node@20.14.8/node\_modules/@types/node/globals.d.ts:3 ##### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:24 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:26 #### walk(fn) @@ -264,7 +264,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid ##### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:25 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:27 *** @@ -316,4 +316,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +`RpcError.captureStackTrace` + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/InvalidJumpError.md b/tevm/docs/errors/classes/InvalidJumpError.md index 13e4cb16d8..4b78cfef9c 100644 --- a/tevm/docs/errors/classes/InvalidJumpError.md +++ b/tevm/docs/errors/classes/InvalidJumpError.md @@ -105,7 +105,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -119,7 +119,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -135,7 +135,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -149,7 +149,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -165,7 +165,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -197,7 +197,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -227,7 +227,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -255,7 +255,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -275,6 +275,10 @@ packages/errors/types/ethereum/ethereumjs/InvalidJumpError.d.ts:50 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -285,10 +289,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`ExecutionError`](ExecutionError.md).[`prepareStackTrace`](ExecutionError.md#preparestacktrace) @@ -337,7 +337,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -389,4 +389,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`ExecutionError`](ExecutionError.md).[`captureStackTrace`](ExecutionError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/InvalidJumpSubError.md b/tevm/docs/errors/classes/InvalidJumpSubError.md index 72c0b95e30..a78a3e7d6e 100644 --- a/tevm/docs/errors/classes/InvalidJumpSubError.md +++ b/tevm/docs/errors/classes/InvalidJumpSubError.md @@ -77,6 +77,10 @@ The tag for the error.} [`InvalidJumpSubError`](InvalidJumpSubError.md) +#### Overrides + +[`ExecutionError`](ExecutionError.md).[`constructor`](ExecutionError.md#constructors) + #### Example ```typescript @@ -91,10 +95,6 @@ try { } ``` -#### Overrides - -[`ExecutionError`](ExecutionError.md).[`constructor`](ExecutionError.md#constructors) - #### Defined in packages/errors/types/ethereum/ethereumjs/InvalidJumpSubError.d.ts:77 @@ -113,7 +113,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -127,7 +127,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -143,7 +143,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -157,7 +157,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -173,7 +173,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -205,7 +205,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -235,7 +235,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -263,7 +263,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -283,6 +283,10 @@ packages/errors/types/ethereum/ethereumjs/InvalidJumpSubError.d.ts:47 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -293,10 +297,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`ExecutionError`](ExecutionError.md).[`prepareStackTrace`](ExecutionError.md#preparestacktrace) @@ -345,7 +345,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -397,4 +397,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`ExecutionError`](ExecutionError.md).[`captureStackTrace`](ExecutionError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/InvalidKzgInputsError.md b/tevm/docs/errors/classes/InvalidKzgInputsError.md index 626a63d325..2f0d870cbb 100644 --- a/tevm/docs/errors/classes/InvalidKzgInputsError.md +++ b/tevm/docs/errors/classes/InvalidKzgInputsError.md @@ -89,7 +89,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -103,7 +103,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -119,7 +119,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -133,7 +133,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -149,7 +149,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -181,7 +181,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -211,7 +211,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -239,7 +239,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -259,6 +259,10 @@ packages/errors/types/ethereum/ethereumjs/InvalidKzgInputsError.d.ts:42 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -269,10 +273,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`ExecutionError`](ExecutionError.md).[`prepareStackTrace`](ExecutionError.md#preparestacktrace) @@ -321,7 +321,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -373,4 +373,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`ExecutionError`](ExecutionError.md).[`captureStackTrace`](ExecutionError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/InvalidMaxFeePerGasError.md b/tevm/docs/errors/classes/InvalidMaxFeePerGasError.md index 68826d5f08..ba3f0a4b56 100644 --- a/tevm/docs/errors/classes/InvalidMaxFeePerGasError.md +++ b/tevm/docs/errors/classes/InvalidMaxFeePerGasError.md @@ -8,29 +8,30 @@ Represents an error that occurs when the max fee per gas is invalid. -This error is typically encountered when a transaction or operation references a max fee per gas that is invalid or does not conform to the expected structure. +This error is typically encountered when a transaction specifies an invalid max fee per gas value. ## Example -```ts +```javascript +import { InvalidMaxFeePerGasError } from '@tevm/errors' +import { createMemoryClient } from '@tevm/memory-client' + +const client = createMemoryClient() + try { - // Some operation that can throw an InvalidMaxFeePerGasError + await client.sendTransaction({ + from: '0x1234567890123456789012345678901234567890', + to: '0x0987654321098765432109876543210987654321', + maxFeePerGas: -1n, // Invalid negative max fee per gas + }) } catch (error) { if (error instanceof InvalidMaxFeePerGasError) { - console.error(error.message); - // Handle the invalid max fee per gas error + console.error('Invalid max fee per gas:', error.message) + console.log('Documentation:', error.docsLink) } } ``` -## Param - -A human-readable error message. - -## Param - -Additional parameters for the InvalidMaxFeePerGasError. - ## Extends - [`InvalidParamsError`](InvalidParamsError.md) @@ -39,9 +40,9 @@ Additional parameters for the InvalidMaxFeePerGasError. ### new InvalidMaxFeePerGasError() -> **new InvalidMaxFeePerGasError**(`message`, `args`?, `tag`?): [`InvalidMaxFeePerGasError`](InvalidMaxFeePerGasError.md) +> **new InvalidMaxFeePerGasError**(`message`, `args`?): [`InvalidMaxFeePerGasError`](InvalidMaxFeePerGasError.md) -Constructs an InvalidParamsError. +Constructs an InvalidMaxFeePerGasError. #### Parameters @@ -49,25 +50,21 @@ Constructs an InvalidParamsError. Human-readable error message. -• **args?**: [`InvalidParamsErrorParameters`](../type-aliases/InvalidParamsErrorParameters.md) - -Additional parameters for the BaseError. - -• **tag?**: `string` +• **args?**: [`InvalidMaxFeePerGasErrorParameters`](../type-aliases/InvalidMaxFeePerGasErrorParameters.md) -The tag for the error. +Additional parameters for the InvalidMaxFeePerGasError. #### Returns [`InvalidMaxFeePerGasError`](InvalidMaxFeePerGasError.md) -#### Inherited from +#### Overrides [`InvalidParamsError`](InvalidParamsError.md).[`constructor`](InvalidParamsError.md#constructors) #### Defined in -packages/errors/types/ethereum/InvalidParamsError.d.ts:45 +packages/errors/types/input/InvalidMaxFeePerGaserror.d.ts:47 ## Properties @@ -75,15 +72,13 @@ packages/errors/types/ethereum/InvalidParamsError.d.ts:45 > **\_tag**: `string` -Same as name, used internally. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`_tag`](InvalidParamsError.md#_tag) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -97,7 +92,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -105,15 +100,13 @@ packages/errors/types/ethereum/BaseError.d.ts:64 > **code**: `number` -Error code, analogous to the code in JSON RPC error. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`code`](InvalidParamsError.md#code) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -127,7 +120,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -135,15 +128,13 @@ packages/errors/types/ethereum/BaseError.d.ts:43 > **docsPath**: `undefined` \| `string` -Path to the documentation for this error. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`docsPath`](InvalidParamsError.md#docspath) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -167,15 +158,13 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 > **metaMessages**: `undefined` \| `string`[] -Additional meta messages for more context. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`metaMessages`](InvalidParamsError.md#metamessages) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -205,7 +194,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -233,7 +222,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -243,6 +232,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -253,10 +246,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`prepareStackTrace`](InvalidParamsError.md#preparestacktrace) @@ -305,7 +294,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -357,4 +346,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`InvalidParamsError`](InvalidParamsError.md).[`captureStackTrace`](InvalidParamsError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/InvalidMaxPriorityFeePerGasError.md b/tevm/docs/errors/classes/InvalidMaxPriorityFeePerGasError.md index e61152d26b..2fac4f50d3 100644 --- a/tevm/docs/errors/classes/InvalidMaxPriorityFeePerGasError.md +++ b/tevm/docs/errors/classes/InvalidMaxPriorityFeePerGasError.md @@ -8,29 +8,30 @@ Represents an error that occurs when the max priority fee per gas is invalid. -This error is typically encountered when a transaction or operation references a max priority fee per gas that is invalid or does not conform to the expected structure. +This error is typically encountered when a transaction specifies an invalid max priority fee per gas value. ## Example -```ts +```javascript +import { InvalidMaxPriorityFeePerGasError } from '@tevm/errors' +import { createMemoryClient } from '@tevm/memory-client' + +const client = createMemoryClient() + try { - // Some operation that can throw an InvalidMaxPriorityFeePerGasError + await client.sendTransaction({ + from: '0x1234567890123456789012345678901234567890', + to: '0x0987654321098765432109876543210987654321', + maxPriorityFeePerGas: -1n, // Invalid negative max priority fee per gas + }) } catch (error) { if (error instanceof InvalidMaxPriorityFeePerGasError) { - console.error(error.message); - // Handle the invalid max priority fee per gas error + console.error('Invalid max priority fee per gas:', error.message) + console.log('Documentation:', error.docsLink) } } ``` -## Param - -A human-readable error message. - -## Param - -Additional parameters for the InvalidMaxPriorityFeePerGasError. - ## Extends - [`InvalidParamsError`](InvalidParamsError.md) @@ -39,9 +40,9 @@ Additional parameters for the InvalidMaxPriorityFeePerGasError. ### new InvalidMaxPriorityFeePerGasError() -> **new InvalidMaxPriorityFeePerGasError**(`message`, `args`?, `tag`?): [`InvalidMaxPriorityFeePerGasError`](InvalidMaxPriorityFeePerGasError.md) +> **new InvalidMaxPriorityFeePerGasError**(`message`, `args`?): [`InvalidMaxPriorityFeePerGasError`](InvalidMaxPriorityFeePerGasError.md) -Constructs an InvalidParamsError. +Constructs an InvalidMaxPriorityFeePerGasError. #### Parameters @@ -49,25 +50,21 @@ Constructs an InvalidParamsError. Human-readable error message. -• **args?**: [`InvalidParamsErrorParameters`](../type-aliases/InvalidParamsErrorParameters.md) - -Additional parameters for the BaseError. - -• **tag?**: `string` +• **args?**: [`InvalidMaxPriorityFeePerGasErrorParameters`](../type-aliases/InvalidMaxPriorityFeePerGasErrorParameters.md) -The tag for the error. +Additional parameters for the InvalidMaxPriorityFeePerGasError. #### Returns [`InvalidMaxPriorityFeePerGasError`](InvalidMaxPriorityFeePerGasError.md) -#### Inherited from +#### Overrides [`InvalidParamsError`](InvalidParamsError.md).[`constructor`](InvalidParamsError.md#constructors) #### Defined in -packages/errors/types/ethereum/InvalidParamsError.d.ts:45 +packages/errors/types/input/InvalidMaxPriorityFeePerGas.d.ts:47 ## Properties @@ -75,15 +72,13 @@ packages/errors/types/ethereum/InvalidParamsError.d.ts:45 > **\_tag**: `string` -Same as name, used internally. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`_tag`](InvalidParamsError.md#_tag) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -97,7 +92,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -105,15 +100,13 @@ packages/errors/types/ethereum/BaseError.d.ts:64 > **code**: `number` -Error code, analogous to the code in JSON RPC error. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`code`](InvalidParamsError.md#code) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -127,7 +120,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -135,15 +128,13 @@ packages/errors/types/ethereum/BaseError.d.ts:43 > **docsPath**: `undefined` \| `string` -Path to the documentation for this error. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`docsPath`](InvalidParamsError.md#docspath) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -167,15 +158,13 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 > **metaMessages**: `undefined` \| `string`[] -Additional meta messages for more context. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`metaMessages`](InvalidParamsError.md#metamessages) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -205,7 +194,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -233,7 +222,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -243,6 +232,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -253,10 +246,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`prepareStackTrace`](InvalidParamsError.md#preparestacktrace) @@ -305,7 +294,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -357,4 +346,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`InvalidParamsError`](InvalidParamsError.md).[`captureStackTrace`](InvalidParamsError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/InvalidNonceError.md b/tevm/docs/errors/classes/InvalidNonceError.md index f302a2f8c4..8eee006dbc 100644 --- a/tevm/docs/errors/classes/InvalidNonceError.md +++ b/tevm/docs/errors/classes/InvalidNonceError.md @@ -83,7 +83,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -97,7 +97,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -113,7 +113,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -127,7 +127,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -143,7 +143,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -175,7 +175,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -205,7 +205,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -233,7 +233,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -243,6 +243,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -253,10 +257,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`prepareStackTrace`](InvalidParamsError.md#preparestacktrace) @@ -305,7 +305,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -357,4 +357,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`InvalidParamsError`](InvalidParamsError.md).[`captureStackTrace`](InvalidParamsError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/InvalidOpcodeError.md b/tevm/docs/errors/classes/InvalidOpcodeError.md index 765e393570..bacea83b0b 100644 --- a/tevm/docs/errors/classes/InvalidOpcodeError.md +++ b/tevm/docs/errors/classes/InvalidOpcodeError.md @@ -105,7 +105,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -119,7 +119,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -135,7 +135,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -149,7 +149,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -165,7 +165,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -197,7 +197,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -227,7 +227,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -255,7 +255,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -275,6 +275,10 @@ packages/errors/types/ethereum/ethereumjs/InvalidOpcodeError.d.ts:50 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -285,10 +289,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`ExecutionError`](ExecutionError.md).[`prepareStackTrace`](ExecutionError.md#preparestacktrace) @@ -337,7 +337,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -389,4 +389,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`ExecutionError`](ExecutionError.md).[`captureStackTrace`](ExecutionError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/InvalidOriginError.md b/tevm/docs/errors/classes/InvalidOriginError.md index f9928d0ec6..89883259dc 100644 --- a/tevm/docs/errors/classes/InvalidOriginError.md +++ b/tevm/docs/errors/classes/InvalidOriginError.md @@ -83,7 +83,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -97,7 +97,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -113,7 +113,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -127,7 +127,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -143,7 +143,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -175,7 +175,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -205,7 +205,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -233,7 +233,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -243,6 +243,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -253,10 +257,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`prepareStackTrace`](InvalidParamsError.md#preparestacktrace) @@ -305,7 +305,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -357,4 +357,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`InvalidParamsError`](InvalidParamsError.md).[`captureStackTrace`](InvalidParamsError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/InvalidParamsError.md b/tevm/docs/errors/classes/InvalidParamsError.md index 51a6f34e7d..d4fdc68cb4 100644 --- a/tevm/docs/errors/classes/InvalidParamsError.md +++ b/tevm/docs/errors/classes/InvalidParamsError.md @@ -112,7 +112,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -126,7 +126,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -142,7 +142,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -156,7 +156,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -172,7 +172,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -204,7 +204,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -234,7 +234,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -262,7 +262,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -272,6 +272,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -282,10 +286,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`BaseError`](BaseError.md).[`prepareStackTrace`](BaseError.md#preparestacktrace) @@ -334,7 +334,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -386,4 +386,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`BaseError`](BaseError.md).[`captureStackTrace`](BaseError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/InvalidParamsRpcError.md b/tevm/docs/errors/classes/InvalidParamsRpcError.md index 606e744ed4..b9465dce62 100644 --- a/tevm/docs/errors/classes/InvalidParamsRpcError.md +++ b/tevm/docs/errors/classes/InvalidParamsRpcError.md @@ -30,7 +30,7 @@ #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:93 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:90 ## Properties @@ -58,7 +58,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es2022.err #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:20 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:20 *** @@ -72,7 +72,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:17 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:19 *** @@ -86,7 +86,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:18 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:20 *** @@ -114,7 +114,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:19 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:21 *** @@ -122,13 +122,13 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid > **name**: `string` -#### Overrides +#### Inherited from `RpcError.name` #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:91 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:24 *** @@ -142,7 +142,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:20 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:22 *** @@ -170,7 +170,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:22 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:23 *** @@ -180,7 +180,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:92 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:89 *** @@ -190,6 +190,10 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -200,10 +204,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from `RpcError.prepareStackTrace` @@ -244,7 +244,7 @@ node\_modules/.pnpm/@types+node@20.14.8/node\_modules/@types/node/globals.d.ts:3 ##### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:24 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:26 #### walk(fn) @@ -264,7 +264,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid ##### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:25 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:27 *** @@ -316,4 +316,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +`RpcError.captureStackTrace` + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/InvalidProofError.md b/tevm/docs/errors/classes/InvalidProofError.md index 818609b200..b076c8fad6 100644 --- a/tevm/docs/errors/classes/InvalidProofError.md +++ b/tevm/docs/errors/classes/InvalidProofError.md @@ -89,7 +89,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -103,7 +103,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -119,7 +119,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -133,7 +133,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -149,7 +149,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -181,7 +181,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -211,7 +211,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -239,7 +239,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -259,6 +259,10 @@ packages/errors/types/ethereum/ethereumjs/InvalidProofError.d.ts:42 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -269,10 +273,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`ExecutionError`](ExecutionError.md).[`prepareStackTrace`](ExecutionError.md#preparestacktrace) @@ -321,7 +321,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -373,4 +373,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`ExecutionError`](ExecutionError.md).[`captureStackTrace`](ExecutionError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/InvalidRequestError.md b/tevm/docs/errors/classes/InvalidRequestError.md index 89a2824608..e2822dc825 100644 --- a/tevm/docs/errors/classes/InvalidRequestError.md +++ b/tevm/docs/errors/classes/InvalidRequestError.md @@ -83,7 +83,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -97,7 +97,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -113,7 +113,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -127,7 +127,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -143,7 +143,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -175,7 +175,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -205,7 +205,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -233,7 +233,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -243,6 +243,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -253,10 +257,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`BaseError`](BaseError.md).[`prepareStackTrace`](BaseError.md#preparestacktrace) @@ -305,7 +305,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -357,4 +357,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`BaseError`](BaseError.md).[`captureStackTrace`](BaseError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/InvalidRequestRpcError.md b/tevm/docs/errors/classes/InvalidRequestRpcError.md index e441ca1c2c..82e95d6af3 100644 --- a/tevm/docs/errors/classes/InvalidRequestRpcError.md +++ b/tevm/docs/errors/classes/InvalidRequestRpcError.md @@ -30,7 +30,7 @@ #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:65 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:62 ## Properties @@ -58,7 +58,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es2022.err #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:20 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:20 *** @@ -72,7 +72,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:17 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:19 *** @@ -86,7 +86,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:18 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:20 *** @@ -114,7 +114,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:19 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:21 *** @@ -122,13 +122,13 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid > **name**: `string` -#### Overrides +#### Inherited from `RpcError.name` #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:63 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:24 *** @@ -142,7 +142,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:20 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:22 *** @@ -170,7 +170,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:22 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:23 *** @@ -180,7 +180,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:64 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:61 *** @@ -190,6 +190,10 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -200,10 +204,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from `RpcError.prepareStackTrace` @@ -244,7 +244,7 @@ node\_modules/.pnpm/@types+node@20.14.8/node\_modules/@types/node/globals.d.ts:3 ##### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:24 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:26 #### walk(fn) @@ -264,7 +264,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid ##### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:25 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:27 *** @@ -316,4 +316,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +`RpcError.captureStackTrace` + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/InvalidReturnSubError.md b/tevm/docs/errors/classes/InvalidReturnSubError.md index d0fc3ebb00..45270a1439 100644 --- a/tevm/docs/errors/classes/InvalidReturnSubError.md +++ b/tevm/docs/errors/classes/InvalidReturnSubError.md @@ -99,7 +99,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -113,7 +113,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -129,7 +129,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -143,7 +143,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -159,7 +159,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -191,7 +191,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -221,7 +221,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -249,7 +249,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -269,6 +269,10 @@ packages/errors/types/ethereum/ethereumjs/InvalidReturnSubError.d.ts:47 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -279,10 +283,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`ExecutionError`](ExecutionError.md).[`prepareStackTrace`](ExecutionError.md#preparestacktrace) @@ -331,7 +331,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -383,4 +383,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`ExecutionError`](ExecutionError.md).[`captureStackTrace`](ExecutionError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/InvalidSaltError.md b/tevm/docs/errors/classes/InvalidSaltError.md index 317c55c71f..153ce3108b 100644 --- a/tevm/docs/errors/classes/InvalidSaltError.md +++ b/tevm/docs/errors/classes/InvalidSaltError.md @@ -83,7 +83,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -97,7 +97,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -113,7 +113,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -127,7 +127,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -143,7 +143,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -175,7 +175,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -205,7 +205,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -233,7 +233,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -243,6 +243,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -253,10 +257,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`prepareStackTrace`](InvalidParamsError.md#preparestacktrace) @@ -305,7 +305,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -357,4 +357,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`InvalidParamsError`](InvalidParamsError.md).[`captureStackTrace`](InvalidParamsError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/InvalidSelfdestructError.md b/tevm/docs/errors/classes/InvalidSelfdestructError.md index 9a1f076390..db96e1c41d 100644 --- a/tevm/docs/errors/classes/InvalidSelfdestructError.md +++ b/tevm/docs/errors/classes/InvalidSelfdestructError.md @@ -8,29 +8,29 @@ Represents an error that occurs when the selfdestruct parameter is invalid. -This error is typically encountered when a transaction or operation references a selfdestruct parameter that is invalid or does not conform to the expected structure. +This error is typically encountered when setting an account's selfdestruct status with an invalid value. ## Example -```ts +```javascript +import { InvalidSelfdestructError } from '@tevm/errors' +import { createMemoryClient } from '@tevm/memory-client' + +const client = createMemoryClient() + try { - // Some operation that can throw an InvalidSelfdestructError + await client.setAccount({ + address: '0x1234567890123456789012345678901234567890', + selfdestruct: 'not_a_boolean', // Should be a boolean + }) } catch (error) { if (error instanceof InvalidSelfdestructError) { - console.error(error.message); - // Handle the invalid selfdestruct error + console.error('Invalid selfdestruct value:', error.message) + console.log('Documentation:', error.docsLink) } } ``` -## Param - -A human-readable error message. - -## Param - -Additional parameters for the InvalidSelfdestructError. - ## Extends - [`InvalidParamsError`](InvalidParamsError.md) @@ -39,9 +39,9 @@ Additional parameters for the InvalidSelfdestructError. ### new InvalidSelfdestructError() -> **new InvalidSelfdestructError**(`message`, `args`?, `tag`?): [`InvalidSelfdestructError`](InvalidSelfdestructError.md) +> **new InvalidSelfdestructError**(`message`, `args`?): [`InvalidSelfdestructError`](InvalidSelfdestructError.md) -Constructs an InvalidParamsError. +Constructs an InvalidSelfdestructError. #### Parameters @@ -49,25 +49,21 @@ Constructs an InvalidParamsError. Human-readable error message. -• **args?**: [`InvalidParamsErrorParameters`](../type-aliases/InvalidParamsErrorParameters.md) - -Additional parameters for the BaseError. - -• **tag?**: `string` +• **args?**: [`InvalidSelfdestructErrorParameters`](../type-aliases/InvalidSelfdestructErrorParameters.md) -The tag for the error. +Additional parameters for the InvalidSelfdestructError. #### Returns [`InvalidSelfdestructError`](InvalidSelfdestructError.md) -#### Inherited from +#### Overrides [`InvalidParamsError`](InvalidParamsError.md).[`constructor`](InvalidParamsError.md#constructors) #### Defined in -packages/errors/types/ethereum/InvalidParamsError.d.ts:45 +packages/errors/types/input/InvalidSelfdestructError.d.ts:46 ## Properties @@ -75,15 +71,13 @@ packages/errors/types/ethereum/InvalidParamsError.d.ts:45 > **\_tag**: `string` -Same as name, used internally. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`_tag`](InvalidParamsError.md#_tag) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -97,7 +91,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -105,15 +99,13 @@ packages/errors/types/ethereum/BaseError.d.ts:64 > **code**: `number` -Error code, analogous to the code in JSON RPC error. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`code`](InvalidParamsError.md#code) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -127,7 +119,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -135,15 +127,13 @@ packages/errors/types/ethereum/BaseError.d.ts:43 > **docsPath**: `undefined` \| `string` -Path to the documentation for this error. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`docsPath`](InvalidParamsError.md#docspath) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -167,15 +157,13 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 > **metaMessages**: `undefined` \| `string`[] -Additional meta messages for more context. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`metaMessages`](InvalidParamsError.md#metamessages) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -205,7 +193,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -233,7 +221,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -243,6 +231,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -253,10 +245,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`prepareStackTrace`](InvalidParamsError.md#preparestacktrace) @@ -305,7 +293,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -357,4 +345,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`InvalidParamsError`](InvalidParamsError.md).[`captureStackTrace`](InvalidParamsError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/InvalidSignatureError.md b/tevm/docs/errors/classes/InvalidSignatureError.md index 3d28ec2712..2fa4c6fdd2 100644 --- a/tevm/docs/errors/classes/InvalidSignatureError.md +++ b/tevm/docs/errors/classes/InvalidSignatureError.md @@ -83,7 +83,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -97,7 +97,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -113,7 +113,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -127,7 +127,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -143,7 +143,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -175,7 +175,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -205,7 +205,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -233,7 +233,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -243,6 +243,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -253,10 +257,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`BaseError`](BaseError.md).[`prepareStackTrace`](BaseError.md#preparestacktrace) @@ -305,7 +305,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -357,4 +357,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`BaseError`](BaseError.md).[`captureStackTrace`](BaseError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/InvalidSkipBalanceError.md b/tevm/docs/errors/classes/InvalidSkipBalanceError.md index 0df91279a8..f43d5aba58 100644 --- a/tevm/docs/errors/classes/InvalidSkipBalanceError.md +++ b/tevm/docs/errors/classes/InvalidSkipBalanceError.md @@ -8,29 +8,29 @@ Represents an error that occurs when the skipBalance parameter is invalid. -This error is typically encountered when a transaction or operation references a skipBalance parameter that is invalid or does not conform to the expected structure. +This error is typically encountered when a transaction or operation uses an invalid skipBalance value. ## Example -```ts +```javascript +import { InvalidSkipBalanceError } from '@tevm/errors' +import { createMemoryClient } from '@tevm/memory-client' + +const client = createMemoryClient() + try { - // Some operation that can throw an InvalidSkipBalanceError + await client.setAccount({ + address: '0x...', + skipBalance: 'invalid', // This should be a boolean + }) } catch (error) { if (error instanceof InvalidSkipBalanceError) { - console.error(error.message); - // Handle the invalid skip balance error + console.error('Invalid skipBalance:', error.message) + console.log('Documentation:', error.docsLink) } } ``` -## Param - -A human-readable error message. - -## Param - -Additional parameters for the InvalidSkipBalanceError. - ## Extends - [`InvalidParamsError`](InvalidParamsError.md) @@ -39,9 +39,9 @@ Additional parameters for the InvalidSkipBalanceError. ### new InvalidSkipBalanceError() -> **new InvalidSkipBalanceError**(`message`, `args`?, `tag`?): [`InvalidSkipBalanceError`](InvalidSkipBalanceError.md) +> **new InvalidSkipBalanceError**(`message`, `args`?): [`InvalidSkipBalanceError`](InvalidSkipBalanceError.md) -Constructs an InvalidParamsError. +Constructs an InvalidSkipBalanceError. #### Parameters @@ -49,25 +49,21 @@ Constructs an InvalidParamsError. Human-readable error message. -• **args?**: [`InvalidParamsErrorParameters`](../type-aliases/InvalidParamsErrorParameters.md) - -Additional parameters for the BaseError. - -• **tag?**: `string` +• **args?**: [`InvalidSkipBalanceErrorParameters`](../type-aliases/InvalidSkipBalanceErrorParameters.md) -The tag for the error. +Additional parameters for the InvalidSkipBalanceError. #### Returns [`InvalidSkipBalanceError`](InvalidSkipBalanceError.md) -#### Inherited from +#### Overrides [`InvalidParamsError`](InvalidParamsError.md).[`constructor`](InvalidParamsError.md#constructors) #### Defined in -packages/errors/types/ethereum/InvalidParamsError.d.ts:45 +packages/errors/types/input/InvalidSkipBalanceError.d.ts:46 ## Properties @@ -75,15 +71,13 @@ packages/errors/types/ethereum/InvalidParamsError.d.ts:45 > **\_tag**: `string` -Same as name, used internally. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`_tag`](InvalidParamsError.md#_tag) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -97,7 +91,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -105,15 +99,13 @@ packages/errors/types/ethereum/BaseError.d.ts:64 > **code**: `number` -Error code, analogous to the code in JSON RPC error. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`code`](InvalidParamsError.md#code) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -127,7 +119,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -135,15 +127,13 @@ packages/errors/types/ethereum/BaseError.d.ts:43 > **docsPath**: `undefined` \| `string` -Path to the documentation for this error. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`docsPath`](InvalidParamsError.md#docspath) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -167,15 +157,13 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 > **metaMessages**: `undefined` \| `string`[] -Additional meta messages for more context. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`metaMessages`](InvalidParamsError.md#metamessages) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -205,7 +193,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -233,7 +221,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -243,6 +231,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -253,10 +245,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`prepareStackTrace`](InvalidParamsError.md#preparestacktrace) @@ -305,7 +293,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -357,4 +345,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`InvalidParamsError`](InvalidParamsError.md).[`captureStackTrace`](InvalidParamsError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/InvalidStorageRootError.md b/tevm/docs/errors/classes/InvalidStorageRootError.md index 3bce23a0cd..548daea164 100644 --- a/tevm/docs/errors/classes/InvalidStorageRootError.md +++ b/tevm/docs/errors/classes/InvalidStorageRootError.md @@ -12,25 +12,25 @@ This error is typically encountered when a transaction or operation references a ## Example -```ts +```javascript +import { InvalidStorageRootError } from '@tevm/errors' +import { createMemoryClient } from '@tevm/memory-client' + +const client = createMemoryClient() + try { - // Some operation that can throw an InvalidStorageRootError + await client.setAccount({ + address: '0x...', + storageRoot: 'invalid', // This should be a valid storage root + }) } catch (error) { if (error instanceof InvalidStorageRootError) { - console.error(error.message); - // Handle the invalid storage root error + console.error('Invalid storage root:', error.message) + console.log('Documentation:', error.docsLink) } } ``` -## Param - -A human-readable error message. - -## Param - -Additional parameters for the InvalidStorageRootError. - ## Extends - [`InvalidParamsError`](InvalidParamsError.md) @@ -39,9 +39,9 @@ Additional parameters for the InvalidStorageRootError. ### new InvalidStorageRootError() -> **new InvalidStorageRootError**(`message`, `args`?, `tag`?): [`InvalidStorageRootError`](InvalidStorageRootError.md) +> **new InvalidStorageRootError**(`message`, `args`?): [`InvalidStorageRootError`](InvalidStorageRootError.md) -Constructs an InvalidParamsError. +Constructs an InvalidStorageRootError. #### Parameters @@ -49,25 +49,21 @@ Constructs an InvalidParamsError. Human-readable error message. -• **args?**: [`InvalidParamsErrorParameters`](../type-aliases/InvalidParamsErrorParameters.md) - -Additional parameters for the BaseError. - -• **tag?**: `string` +• **args?**: [`InvalidStorageRootErrorParameters`](../type-aliases/InvalidStorageRootErrorParameters.md) -The tag for the error. +Additional parameters for the InvalidStorageRootError. #### Returns [`InvalidStorageRootError`](InvalidStorageRootError.md) -#### Inherited from +#### Overrides [`InvalidParamsError`](InvalidParamsError.md).[`constructor`](InvalidParamsError.md#constructors) #### Defined in -packages/errors/types/ethereum/InvalidParamsError.d.ts:45 +packages/errors/types/input/InvalidStorageRootError.d.ts:46 ## Properties @@ -75,15 +71,13 @@ packages/errors/types/ethereum/InvalidParamsError.d.ts:45 > **\_tag**: `string` -Same as name, used internally. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`_tag`](InvalidParamsError.md#_tag) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -97,7 +91,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -105,15 +99,13 @@ packages/errors/types/ethereum/BaseError.d.ts:64 > **code**: `number` -Error code, analogous to the code in JSON RPC error. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`code`](InvalidParamsError.md#code) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -127,7 +119,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -135,15 +127,13 @@ packages/errors/types/ethereum/BaseError.d.ts:43 > **docsPath**: `undefined` \| `string` -Path to the documentation for this error. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`docsPath`](InvalidParamsError.md#docspath) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -167,15 +157,13 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 > **metaMessages**: `undefined` \| `string`[] -Additional meta messages for more context. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`metaMessages`](InvalidParamsError.md#metamessages) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -205,7 +193,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -233,7 +221,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -243,6 +231,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -253,10 +245,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`prepareStackTrace`](InvalidParamsError.md#preparestacktrace) @@ -305,7 +293,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -357,4 +345,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`InvalidParamsError`](InvalidParamsError.md).[`captureStackTrace`](InvalidParamsError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/InvalidToError.md b/tevm/docs/errors/classes/InvalidToError.md index 4b4bd0c745..48f69c7270 100644 --- a/tevm/docs/errors/classes/InvalidToError.md +++ b/tevm/docs/errors/classes/InvalidToError.md @@ -6,31 +6,32 @@ # Class: InvalidToError -Represents an error that occurs when the 'to' parameter is invalid. +Represents an error that occurs when the 'to' address in a transaction or operation is invalid. -This error is typically encountered when a transaction or operation references a 'to' parameter that is invalid or does not conform to the expected structure. +This error is typically encountered when a transaction or contract interaction specifies an invalid recipient address. ## Example -```ts +```javascript +import { InvalidToError } from '@tevm/errors' +import { createMemoryClient } from '@tevm/memory-client' + +const client = createMemoryClient() + try { - // Some operation that can throw an InvalidToError + await client.sendTransaction({ + from: '0x1234567890123456789012345678901234567890', + to: 'invalid_address', // Invalid 'to' address + value: 1000n, + }) } catch (error) { if (error instanceof InvalidToError) { - console.error(error.message); - // Handle the invalid 'to' error + console.error('Invalid to address:', error.message) + console.log('Documentation:', error.docsLink) } } ``` -## Param - -A human-readable error message. - -## Param - -Additional parameters for the InvalidToError. - ## Extends - [`InvalidParamsError`](InvalidParamsError.md) @@ -39,9 +40,9 @@ Additional parameters for the InvalidToError. ### new InvalidToError() -> **new InvalidToError**(`message`, `args`?, `tag`?): [`InvalidToError`](InvalidToError.md) +> **new InvalidToError**(`message`, `args`?): [`InvalidToError`](InvalidToError.md) -Constructs an InvalidParamsError. +Constructs an InvalidToError. #### Parameters @@ -49,25 +50,21 @@ Constructs an InvalidParamsError. Human-readable error message. -• **args?**: [`InvalidParamsErrorParameters`](../type-aliases/InvalidParamsErrorParameters.md) - -Additional parameters for the BaseError. - -• **tag?**: `string` +• **args?**: [`InvalidToErrorParameters`](../type-aliases/InvalidToErrorParameters.md) -The tag for the error. +Additional parameters for the InvalidToError. #### Returns [`InvalidToError`](InvalidToError.md) -#### Inherited from +#### Overrides [`InvalidParamsError`](InvalidParamsError.md).[`constructor`](InvalidParamsError.md#constructors) #### Defined in -packages/errors/types/ethereum/InvalidParamsError.d.ts:45 +packages/errors/types/input/InvalidToError.d.ts:47 ## Properties @@ -75,15 +72,13 @@ packages/errors/types/ethereum/InvalidParamsError.d.ts:45 > **\_tag**: `string` -Same as name, used internally. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`_tag`](InvalidParamsError.md#_tag) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -97,7 +92,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -105,15 +100,13 @@ packages/errors/types/ethereum/BaseError.d.ts:64 > **code**: `number` -Error code, analogous to the code in JSON RPC error. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`code`](InvalidParamsError.md#code) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -127,7 +120,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -135,15 +128,13 @@ packages/errors/types/ethereum/BaseError.d.ts:43 > **docsPath**: `undefined` \| `string` -Path to the documentation for this error. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`docsPath`](InvalidParamsError.md#docspath) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -167,15 +158,13 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 > **metaMessages**: `undefined` \| `string`[] -Additional meta messages for more context. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`metaMessages`](InvalidParamsError.md#metamessages) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -205,7 +194,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -233,7 +222,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -243,6 +232,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -253,10 +246,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`prepareStackTrace`](InvalidParamsError.md#preparestacktrace) @@ -305,7 +294,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -357,4 +346,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`InvalidParamsError`](InvalidParamsError.md).[`captureStackTrace`](InvalidParamsError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/InvalidTransactionError.md b/tevm/docs/errors/classes/InvalidTransactionError.md index 5fe570055b..edabb054a4 100644 --- a/tevm/docs/errors/classes/InvalidTransactionError.md +++ b/tevm/docs/errors/classes/InvalidTransactionError.md @@ -83,7 +83,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -97,7 +97,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -113,7 +113,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -127,7 +127,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -143,7 +143,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -175,7 +175,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -205,7 +205,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -233,7 +233,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -243,6 +243,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -253,10 +257,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`BaseError`](BaseError.md).[`prepareStackTrace`](BaseError.md#preparestacktrace) @@ -305,7 +305,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -357,4 +357,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`BaseError`](BaseError.md).[`captureStackTrace`](BaseError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/InvalidUrlError.md b/tevm/docs/errors/classes/InvalidUrlError.md index 744178d02d..7c624e8f79 100644 --- a/tevm/docs/errors/classes/InvalidUrlError.md +++ b/tevm/docs/errors/classes/InvalidUrlError.md @@ -6,31 +6,30 @@ # Class: InvalidUrlError -Represents an error that occurs when the 'url' parameter is invalid. +Represents an error that occurs when a URL is invalid. -This error is typically encountered when a transaction or operation references a 'url' parameter that is invalid or does not conform to the expected structure. +This error is typically encountered when an operation requires a valid URL, but receives an invalid one. ## Example -```ts +```javascript +import { InvalidUrlError } from '@tevm/errors' +import { createMemoryClient } from '@tevm/memory-client' + try { - // Some operation that can throw an InvalidUrlError + const client = createMemoryClient({ + fork: { + url: 'not_a_valid_url' + } + }) } catch (error) { if (error instanceof InvalidUrlError) { - console.error(error.message); - // Handle the invalid 'url' error + console.error('Invalid URL:', error.message) + console.log('Documentation:', error.docsLink) } } ``` -## Param - -A human-readable error message. - -## Param - -Additional parameters for the InvalidUrlError. - ## Extends - [`InvalidParamsError`](InvalidParamsError.md) @@ -39,9 +38,9 @@ Additional parameters for the InvalidUrlError. ### new InvalidUrlError() -> **new InvalidUrlError**(`message`, `args`?, `tag`?): [`InvalidUrlError`](InvalidUrlError.md) +> **new InvalidUrlError**(`message`, `args`?): [`InvalidUrlError`](InvalidUrlError.md) -Constructs an InvalidParamsError. +Constructs an InvalidUrlError. #### Parameters @@ -49,25 +48,21 @@ Constructs an InvalidParamsError. Human-readable error message. -• **args?**: [`InvalidParamsErrorParameters`](../type-aliases/InvalidParamsErrorParameters.md) +• **args?**: [`InvalidUrlErrorParameters`](../type-aliases/InvalidUrlErrorParameters.md) -Additional parameters for the BaseError. - -• **tag?**: `string` - -The tag for the error. +Additional parameters for the InvalidUrlError. #### Returns [`InvalidUrlError`](InvalidUrlError.md) -#### Inherited from +#### Overrides [`InvalidParamsError`](InvalidParamsError.md).[`constructor`](InvalidParamsError.md#constructors) #### Defined in -packages/errors/types/ethereum/InvalidParamsError.d.ts:45 +packages/errors/types/input/InvalidUrlError.d.ts:45 ## Properties @@ -75,15 +70,13 @@ packages/errors/types/ethereum/InvalidParamsError.d.ts:45 > **\_tag**: `string` -Same as name, used internally. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`_tag`](InvalidParamsError.md#_tag) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -97,7 +90,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -105,15 +98,13 @@ packages/errors/types/ethereum/BaseError.d.ts:64 > **code**: `number` -Error code, analogous to the code in JSON RPC error. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`code`](InvalidParamsError.md#code) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -127,7 +118,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -135,15 +126,13 @@ packages/errors/types/ethereum/BaseError.d.ts:43 > **docsPath**: `undefined` \| `string` -Path to the documentation for this error. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`docsPath`](InvalidParamsError.md#docspath) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -167,15 +156,13 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 > **metaMessages**: `undefined` \| `string`[] -Additional meta messages for more context. - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`metaMessages`](InvalidParamsError.md#metamessages) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -205,7 +192,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -233,7 +220,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -243,6 +230,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -253,10 +244,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`prepareStackTrace`](InvalidParamsError.md#preparestacktrace) @@ -305,7 +292,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -357,4 +344,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`InvalidParamsError`](InvalidParamsError.md).[`captureStackTrace`](InvalidParamsError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/InvalidValueError.md b/tevm/docs/errors/classes/InvalidValueError.md index 322323d0f7..abb880b0af 100644 --- a/tevm/docs/errors/classes/InvalidValueError.md +++ b/tevm/docs/errors/classes/InvalidValueError.md @@ -83,7 +83,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -97,7 +97,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -113,7 +113,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -127,7 +127,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -143,7 +143,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -175,7 +175,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -205,7 +205,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -233,7 +233,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -243,6 +243,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -253,10 +257,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`InvalidParamsError`](InvalidParamsError.md).[`prepareStackTrace`](InvalidParamsError.md#preparestacktrace) @@ -305,7 +305,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -357,4 +357,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`InvalidParamsError`](InvalidParamsError.md).[`captureStackTrace`](InvalidParamsError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/JsonRpcVersionUnsupportedError.md b/tevm/docs/errors/classes/JsonRpcVersionUnsupportedError.md index 5f61a64adc..8f3eda3c51 100644 --- a/tevm/docs/errors/classes/JsonRpcVersionUnsupportedError.md +++ b/tevm/docs/errors/classes/JsonRpcVersionUnsupportedError.md @@ -30,7 +30,7 @@ #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:205 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:197 ## Properties @@ -58,7 +58,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es2022.err #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:20 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:20 *** @@ -72,7 +72,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:17 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:19 *** @@ -86,7 +86,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:18 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:20 *** @@ -114,7 +114,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:19 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:21 *** @@ -122,13 +122,13 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid > **name**: `string` -#### Overrides +#### Inherited from `RpcError.name` #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:203 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:24 *** @@ -142,7 +142,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:20 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:22 *** @@ -170,7 +170,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:22 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:23 *** @@ -180,7 +180,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:204 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:196 *** @@ -190,6 +190,10 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -200,10 +204,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from `RpcError.prepareStackTrace` @@ -244,7 +244,7 @@ node\_modules/.pnpm/@types+node@20.14.8/node\_modules/@types/node/globals.d.ts:3 ##### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:24 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:26 #### walk(fn) @@ -264,7 +264,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid ##### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:25 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:27 *** @@ -316,4 +316,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +`RpcError.captureStackTrace` + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/LimitExceededError.md b/tevm/docs/errors/classes/LimitExceededError.md index dc41eac359..c7e754d2c0 100644 --- a/tevm/docs/errors/classes/LimitExceededError.md +++ b/tevm/docs/errors/classes/LimitExceededError.md @@ -83,7 +83,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -97,7 +97,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -113,7 +113,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -127,7 +127,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -143,7 +143,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -175,7 +175,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -205,7 +205,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -233,7 +233,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -243,6 +243,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -253,10 +257,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`BaseError`](BaseError.md).[`prepareStackTrace`](BaseError.md#preparestacktrace) @@ -305,7 +305,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -357,4 +357,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`BaseError`](BaseError.md).[`captureStackTrace`](BaseError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/LimitExceededRpcError.md b/tevm/docs/errors/classes/LimitExceededRpcError.md index 34f797e579..042ea50ce1 100644 --- a/tevm/docs/errors/classes/LimitExceededRpcError.md +++ b/tevm/docs/errors/classes/LimitExceededRpcError.md @@ -30,7 +30,7 @@ #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:191 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:184 ## Properties @@ -58,7 +58,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es2022.err #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:20 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:20 *** @@ -72,7 +72,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:17 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:19 *** @@ -86,7 +86,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:18 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:20 *** @@ -114,7 +114,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:19 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:21 *** @@ -122,13 +122,13 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid > **name**: `string` -#### Overrides +#### Inherited from `RpcError.name` #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:189 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:24 *** @@ -142,7 +142,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:20 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:22 *** @@ -170,7 +170,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:22 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:23 *** @@ -180,7 +180,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:190 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:183 *** @@ -190,6 +190,10 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -200,10 +204,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from `RpcError.prepareStackTrace` @@ -244,7 +244,7 @@ node\_modules/.pnpm/@types+node@20.14.8/node\_modules/@types/node/globals.d.ts:3 ##### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:24 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:26 #### walk(fn) @@ -264,7 +264,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid ##### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:25 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:27 *** @@ -316,4 +316,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +`RpcError.captureStackTrace` + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/MethodNotFoundError.md b/tevm/docs/errors/classes/MethodNotFoundError.md index 4cf482e9e8..cd47e1eb3c 100644 --- a/tevm/docs/errors/classes/MethodNotFoundError.md +++ b/tevm/docs/errors/classes/MethodNotFoundError.md @@ -83,7 +83,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -97,7 +97,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -113,7 +113,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -127,7 +127,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -143,7 +143,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -175,7 +175,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -205,7 +205,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -233,7 +233,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -243,6 +243,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -253,10 +257,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`BaseError`](BaseError.md).[`prepareStackTrace`](BaseError.md#preparestacktrace) @@ -305,7 +305,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -357,4 +357,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`BaseError`](BaseError.md).[`captureStackTrace`](BaseError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/MethodNotFoundRpcError.md b/tevm/docs/errors/classes/MethodNotFoundRpcError.md index eeb4193c55..0ab5b69b86 100644 --- a/tevm/docs/errors/classes/MethodNotFoundRpcError.md +++ b/tevm/docs/errors/classes/MethodNotFoundRpcError.md @@ -14,12 +14,16 @@ ### new MethodNotFoundRpcError() -> **new MethodNotFoundRpcError**(`cause`): [`MethodNotFoundRpcError`](MethodNotFoundRpcError.md) +> **new MethodNotFoundRpcError**(`cause`, `__namedParameters`?): [`MethodNotFoundRpcError`](MethodNotFoundRpcError.md) #### Parameters • **cause**: `Error` +• **\_\_namedParameters?** + +• **\_\_namedParameters.method?**: `string` + #### Returns [`MethodNotFoundRpcError`](MethodNotFoundRpcError.md) @@ -30,7 +34,7 @@ #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:79 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:75 ## Properties @@ -58,7 +62,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es2022.err #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:20 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:20 *** @@ -72,7 +76,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:17 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:19 *** @@ -86,7 +90,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:18 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:20 *** @@ -114,7 +118,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:19 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:21 *** @@ -122,13 +126,13 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid > **name**: `string` -#### Overrides +#### Inherited from `RpcError.name` #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:77 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:24 *** @@ -142,7 +146,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:20 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:22 *** @@ -170,7 +174,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:22 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:23 *** @@ -180,7 +184,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:78 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:74 *** @@ -190,6 +194,10 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -200,10 +208,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from `RpcError.prepareStackTrace` @@ -244,7 +248,7 @@ node\_modules/.pnpm/@types+node@20.14.8/node\_modules/@types/node/globals.d.ts:3 ##### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:24 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:26 #### walk(fn) @@ -264,7 +268,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid ##### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:25 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:27 *** @@ -316,4 +320,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +`RpcError.captureStackTrace` + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/MethodNotSupportedError.md b/tevm/docs/errors/classes/MethodNotSupportedError.md index 84a03fa34d..78472e85c9 100644 --- a/tevm/docs/errors/classes/MethodNotSupportedError.md +++ b/tevm/docs/errors/classes/MethodNotSupportedError.md @@ -83,7 +83,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -97,7 +97,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -113,7 +113,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -127,7 +127,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -143,7 +143,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -175,7 +175,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -205,7 +205,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -233,7 +233,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -243,6 +243,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -253,10 +257,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`BaseError`](BaseError.md).[`prepareStackTrace`](BaseError.md#preparestacktrace) @@ -305,7 +305,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -357,4 +357,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`BaseError`](BaseError.md).[`captureStackTrace`](BaseError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/MethodNotSupportedRpcError.md b/tevm/docs/errors/classes/MethodNotSupportedRpcError.md index cf2ec54248..17f18c9618 100644 --- a/tevm/docs/errors/classes/MethodNotSupportedRpcError.md +++ b/tevm/docs/errors/classes/MethodNotSupportedRpcError.md @@ -14,12 +14,16 @@ ### new MethodNotSupportedRpcError() -> **new MethodNotSupportedRpcError**(`cause`): [`MethodNotSupportedRpcError`](MethodNotSupportedRpcError.md) +> **new MethodNotSupportedRpcError**(`cause`, `__namedParameters`?): [`MethodNotSupportedRpcError`](MethodNotSupportedRpcError.md) #### Parameters • **cause**: `Error` +• **\_\_namedParameters?** + +• **\_\_namedParameters.method?**: `string` + #### Returns [`MethodNotSupportedRpcError`](MethodNotSupportedRpcError.md) @@ -30,7 +34,7 @@ #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:177 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:169 ## Properties @@ -58,7 +62,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es2022.err #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:20 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:20 *** @@ -72,7 +76,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:17 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:19 *** @@ -86,7 +90,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:18 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:20 *** @@ -114,7 +118,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:19 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:21 *** @@ -122,13 +126,13 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid > **name**: `string` -#### Overrides +#### Inherited from `RpcError.name` #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:175 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:24 *** @@ -142,7 +146,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:20 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:22 *** @@ -170,7 +174,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:22 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:23 *** @@ -180,7 +184,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:176 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:168 *** @@ -190,6 +194,10 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -200,10 +208,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from `RpcError.prepareStackTrace` @@ -244,7 +248,7 @@ node\_modules/.pnpm/@types+node@20.14.8/node\_modules/@types/node/globals.d.ts:3 ##### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:24 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:26 #### walk(fn) @@ -264,7 +268,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid ##### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:25 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:27 *** @@ -316,4 +320,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +`RpcError.captureStackTrace` + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/MisconfiguredClientError.md b/tevm/docs/errors/classes/MisconfiguredClientError.md index e922faf2d4..94cb051089 100644 --- a/tevm/docs/errors/classes/MisconfiguredClientError.md +++ b/tevm/docs/errors/classes/MisconfiguredClientError.md @@ -8,31 +8,35 @@ Represents an error that occurs when the Client is misconfigured. -Misconfigured memory client errors can occur due to: -- Incorrect configuration parameters provided when creating a Client. +This error can be thrown when: +- Incorrect configuration parameters are provided when creating a Client. +- The Client is used in a way that's incompatible with its configuration. ## Example ```typescript +import { createMemoryClient } from '@tevm/memory-client' import { MisconfiguredClientError } from '@tevm/errors' + +const memoryClient = createMemoryClient({ + // Assume we've misconfigured something here +}) + try { - // Some operation that can throw a MisconfiguredClientError + await memoryClient.tevmCall({ + to: '0x...', + data: '0x...', + }) } catch (error) { if (error instanceof MisconfiguredClientError) { - console.error(error.message); - // Handle the misconfigured memory client error + console.error('Client misconfiguration:', error.message) + console.log('Documentation:', error.docsLink) + // Attempt to recreate the client with correct configuration + // or notify the user to check their client setup } } ``` -## Param - -A human-readable error message. - -## Param - -Additional parameters for the BaseError. - ## Extends - [`InternalError`](InternalError.md) @@ -41,7 +45,7 @@ Additional parameters for the BaseError. ### new MisconfiguredClientError() -> **new MisconfiguredClientError**(`message`?, `args`?, `tag`?): [`MisconfiguredClientError`](MisconfiguredClientError.md) +> **new MisconfiguredClientError**(`message`?, `args`?): [`MisconfiguredClientError`](MisconfiguredClientError.md) Constructs a MisconfiguredClientError. @@ -53,11 +57,7 @@ Human-readable error message. • **args?**: [`MisconfiguredClientErrorParameters`](../type-aliases/MisconfiguredClientErrorParameters.md) -Additional parameters for the BaseError. - -• **tag?**: `string` - -The tag for the error. +Additional parameters for the error. #### Returns @@ -69,7 +69,7 @@ The tag for the error. #### Defined in -packages/errors/types/client/MisconfiguredClient.d.ts:49 +packages/errors/types/client/MisconfiguredClient.d.ts:52 ## Properties @@ -77,15 +77,13 @@ packages/errors/types/client/MisconfiguredClient.d.ts:49 > **\_tag**: `string` -Same as name, used internally. - #### Inherited from [`InternalError`](InternalError.md).[`_tag`](InternalError.md#_tag) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -99,7 +97,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -107,15 +105,13 @@ packages/errors/types/ethereum/BaseError.d.ts:64 > **code**: `number` -Error code, analogous to the code in JSON RPC error. - #### Inherited from [`InternalError`](InternalError.md).[`code`](InternalError.md#code) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -129,7 +125,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -137,15 +133,13 @@ packages/errors/types/ethereum/BaseError.d.ts:43 > **docsPath**: `undefined` \| `string` -Path to the documentation for this error. - #### Inherited from [`InternalError`](InternalError.md).[`docsPath`](InternalError.md#docspath) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -177,7 +171,7 @@ Optional object containing additional information about the error. #### Defined in -packages/errors/types/ethereum/InternalErrorError.d.ts:49 +packages/errors/types/ethereum/InternalErrorError.d.ts:53 *** @@ -185,15 +179,13 @@ packages/errors/types/ethereum/InternalErrorError.d.ts:49 > **metaMessages**: `undefined` \| `string`[] -Additional meta messages for more context. - #### Inherited from [`InternalError`](InternalError.md).[`metaMessages`](InternalError.md#metamessages) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -223,7 +215,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -251,7 +243,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -261,6 +253,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -271,10 +267,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`InternalError`](InternalError.md).[`prepareStackTrace`](InternalError.md#preparestacktrace) @@ -323,7 +315,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -375,4 +367,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`InternalError`](InternalError.md).[`captureStackTrace`](InternalError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/NoForkTransportSetError.md b/tevm/docs/errors/classes/NoForkTransportSetError.md index b70802bad3..b5ad856f74 100644 --- a/tevm/docs/errors/classes/NoForkTransportSetError.md +++ b/tevm/docs/errors/classes/NoForkTransportSetError.md @@ -7,15 +7,25 @@ # Class: NoForkTransportSetError Error represents the tevm client attempted to fetch a resource from a Forked transport but no transport was set. -To set a transport use the `fork.transport` option for [`createMemoryClient`](https://tevm.sh/reference/tevm/memory-client/functions/creatememoryclient/) -## Param +## Example -A human-readable error message. +```javascript +import { NoForkTransportSetError } from '@tevm/errors' +import { createMemoryClient } from '@tevm/memory-client' -## Param +const client = createMemoryClient() // No fork configuration -Additional parameters for the InvalidParamsError. +try { + await client.getBalance('0x...') // This might throw if it needs to access forked state +} catch (error) { + if (error instanceof NoForkTransportSetError) { + console.error('No fork transport set:', error.message) + console.log('Documentation:', error.docsLink) + // Handle the error, e.g., by setting up a fork configuration + } +} +``` ## Extends @@ -25,9 +35,9 @@ Additional parameters for the InvalidParamsError. ### new NoForkTransportSetError() -> **new NoForkTransportSetError**(`message`, `args`?, `tag`?): [`NoForkTransportSetError`](NoForkTransportSetError.md) +> **new NoForkTransportSetError**(`message`, `args`?): [`NoForkTransportSetError`](NoForkTransportSetError.md) -Constructs an NoForkTransportSetError. +Constructs a NoForkTransportSetError. #### Parameters @@ -37,9 +47,7 @@ Human-readable error message. • **args?**: [`NoForkTransportSetErrorParameters`](../type-aliases/NoForkTransportSetErrorParameters.md) -Additional parameters to pass to BaseError. - -• **tag?**: `string` +Additional parameters for the error. #### Returns @@ -51,7 +59,7 @@ Additional parameters to pass to BaseError. #### Defined in -packages/errors/types/fork/NoForkUriSetError.d.ts:33 +packages/errors/types/fork/NoForkUriSetError.d.ts:42 ## Properties @@ -59,15 +67,13 @@ packages/errors/types/fork/NoForkUriSetError.d.ts:33 > **\_tag**: `string` -Same as name, used internally. - #### Inherited from [`BaseError`](BaseError.md).[`_tag`](BaseError.md#_tag) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -81,7 +87,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -89,15 +95,13 @@ packages/errors/types/ethereum/BaseError.d.ts:64 > **code**: `number` -Error code, analogous to the code in JSON RPC error. - #### Inherited from [`BaseError`](BaseError.md).[`code`](BaseError.md#code) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -111,7 +115,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -119,15 +123,13 @@ packages/errors/types/ethereum/BaseError.d.ts:43 > **docsPath**: `undefined` \| `string` -Path to the documentation for this error. - #### Inherited from [`BaseError`](BaseError.md).[`docsPath`](BaseError.md#docspath) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -135,8 +137,6 @@ packages/errors/types/ethereum/BaseError.d.ts:47 > **message**: `string` -Human-readable error message. - #### Inherited from [`BaseError`](BaseError.md).[`message`](BaseError.md#message) @@ -151,15 +151,13 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 > **metaMessages**: `undefined` \| `string`[] -Additional meta messages for more context. - #### Inherited from [`BaseError`](BaseError.md).[`metaMessages`](BaseError.md#metamessages) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -167,8 +165,6 @@ packages/errors/types/ethereum/BaseError.d.ts:51 > **name**: `string` -The name of the error, used to discriminate errors. - #### Inherited from [`BaseError`](BaseError.md).[`name`](BaseError.md#name) @@ -189,7 +185,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -217,7 +213,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -227,6 +223,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -237,10 +237,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`BaseError`](BaseError.md).[`prepareStackTrace`](BaseError.md#preparestacktrace) @@ -289,7 +285,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -341,4 +337,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`BaseError`](BaseError.md).[`captureStackTrace`](BaseError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/NonceAlreadyUsedError.md b/tevm/docs/errors/classes/NonceAlreadyUsedError.md index b317dac4e1..7ea0a6001c 100644 --- a/tevm/docs/errors/classes/NonceAlreadyUsedError.md +++ b/tevm/docs/errors/classes/NonceAlreadyUsedError.md @@ -83,7 +83,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -97,7 +97,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -113,7 +113,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -127,7 +127,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -143,7 +143,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -175,7 +175,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -205,7 +205,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -233,7 +233,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -243,6 +243,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -253,10 +257,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`BaseError`](BaseError.md).[`prepareStackTrace`](BaseError.md#preparestacktrace) @@ -305,7 +305,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -357,4 +357,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`BaseError`](BaseError.md).[`captureStackTrace`](BaseError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/NonceTooHighError.md b/tevm/docs/errors/classes/NonceTooHighError.md index 6d3ed129d7..97c88054df 100644 --- a/tevm/docs/errors/classes/NonceTooHighError.md +++ b/tevm/docs/errors/classes/NonceTooHighError.md @@ -6,19 +6,29 @@ # Class: NonceTooHighError -Represents an error that occurs when the nonce value is too high. +Represents an error that occurs when the nonce value is too high for a transaction. -This error is typically encountered when a transaction is attempted with a nonce that is higher than the next expected nonce. +This error is typically encountered when a transaction is submitted with a nonce that is higher +than the expected next nonce for the sender's account. In Ethereum, nonces must be used in strict +sequential order to ensure transactions are processed correctly. + +The error code -32000 is a standard Ethereum JSON-RPC error code indicating a generic server error, +which is often used for various transaction-related errors including nonce issues. ## Example ```ts try { - // Some operation that can throw a NonceTooHighError + await client.sendTransaction({ + from: '0x1234567890123456789012345678901234567890', + to: '0x0987654321098765432109876543210987654321', + value: '0x1', + nonce: 100 // Assuming this nonce is too high + }) } catch (error) { if (error instanceof NonceTooHighError) { - console.error(error.message); - // Handle the nonce too high error + console.error('Nonce too high:', error.message); + console.log('Try decreasing the nonce or use `await client.getTransactionCount(address)` to get the correct nonce'); } } ``` @@ -67,7 +77,7 @@ The tag for the error. #### Defined in -packages/errors/types/ethereum/NonceTooHighError.d.ts:45 +packages/errors/types/ethereum/NonceTooHighError.d.ts:55 ## Properties @@ -83,7 +93,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -97,7 +107,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -105,7 +115,7 @@ packages/errors/types/ethereum/BaseError.d.ts:64 > **code**: `number` -Error code, analogous to the code in JSON RPC error. +Error code (-32000), standard Ethereum JSON-RPC error code for server errors. #### Inherited from @@ -113,7 +123,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -127,7 +137,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -143,7 +153,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -175,7 +185,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -205,7 +215,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -233,7 +243,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -243,6 +253,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -253,10 +267,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`BaseError`](BaseError.md).[`prepareStackTrace`](BaseError.md#preparestacktrace) @@ -305,7 +315,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -357,4 +367,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`BaseError`](BaseError.md).[`captureStackTrace`](BaseError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/NonceTooLowError.md b/tevm/docs/errors/classes/NonceTooLowError.md index 8d9bb83bb0..b2f1233e79 100644 --- a/tevm/docs/errors/classes/NonceTooLowError.md +++ b/tevm/docs/errors/classes/NonceTooLowError.md @@ -6,19 +6,29 @@ # Class: NonceTooLowError -Represents an error that occurs when the nonce value is too low. +Represents an error that occurs when the nonce value is too low for a transaction. -This error is typically encountered when a transaction is attempted with a nonce that is lower than the next expected nonce. +This error is typically encountered when a transaction is submitted with a nonce that is lower +than the current nonce for the sender's account. In Ethereum, nonces are used to ensure +transactions are processed in the correct order and to prevent double-spending. + +The error code -32000 is a standard Ethereum JSON-RPC error code indicating a generic server error, +which is often used for various transaction-related errors including nonce issues. ## Example ```ts try { - // Some operation that can throw a NonceTooLowError + await client.sendTransaction({ + from: '0x1234567890123456789012345678901234567890', + to: '0x0987654321098765432109876543210987654321', + value: '0x1', + nonce: 5 // Assuming this nonce is too low + }) } catch (error) { if (error instanceof NonceTooLowError) { - console.error(error.message); - // Handle the nonce too low error + console.error('Nonce too low:', error.message); + console.log('Try increasing the nonce or use `await client.getTransactionCount(address)` to get the correct nonce'); } } ``` @@ -67,7 +77,7 @@ The tag for the error. #### Defined in -packages/errors/types/ethereum/NonceTooLowError.d.ts:45 +packages/errors/types/ethereum/NonceTooLowError.d.ts:55 ## Properties @@ -83,7 +93,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -97,7 +107,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -105,7 +115,7 @@ packages/errors/types/ethereum/BaseError.d.ts:64 > **code**: `number` -Error code, analogous to the code in JSON RPC error. +Error code (-32000), standard Ethereum JSON-RPC error code for server errors. #### Inherited from @@ -113,7 +123,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -127,7 +137,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -143,7 +153,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -175,7 +185,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -205,7 +215,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -233,7 +243,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -243,6 +253,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -253,10 +267,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`BaseError`](BaseError.md).[`prepareStackTrace`](BaseError.md#preparestacktrace) @@ -305,7 +315,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -357,4 +367,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`BaseError`](BaseError.md).[`captureStackTrace`](BaseError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/OutOfGasError.md b/tevm/docs/errors/classes/OutOfGasError.md index 3a63b6e80a..c0881f2618 100644 --- a/tevm/docs/errors/classes/OutOfGasError.md +++ b/tevm/docs/errors/classes/OutOfGasError.md @@ -112,7 +112,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -126,7 +126,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -142,7 +142,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -156,7 +156,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -172,7 +172,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -204,7 +204,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -234,7 +234,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -262,7 +262,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -282,6 +282,10 @@ packages/errors/types/ethereum/ethereumjs/OutOfGasError.d.ts:53 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -292,10 +296,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`GasLimitExceededError`](GasLimitExceededError.md).[`prepareStackTrace`](GasLimitExceededError.md#preparestacktrace) @@ -344,7 +344,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -396,4 +396,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`GasLimitExceededError`](GasLimitExceededError.md).[`captureStackTrace`](GasLimitExceededError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/OutOfRangeError.md b/tevm/docs/errors/classes/OutOfRangeError.md index e213517e4c..6a66fcfb89 100644 --- a/tevm/docs/errors/classes/OutOfRangeError.md +++ b/tevm/docs/errors/classes/OutOfRangeError.md @@ -107,7 +107,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -121,7 +121,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -137,7 +137,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -151,7 +151,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -167,7 +167,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -199,7 +199,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -229,7 +229,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -257,7 +257,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -277,6 +277,10 @@ packages/errors/types/ethereum/ethereumjs/OutOfRangeError.d.ts:51 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -287,10 +291,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`ExecutionError`](ExecutionError.md).[`prepareStackTrace`](ExecutionError.md#preparestacktrace) @@ -339,7 +339,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -391,4 +391,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`ExecutionError`](ExecutionError.md).[`captureStackTrace`](ExecutionError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/ParseError.md b/tevm/docs/errors/classes/ParseError.md index bcf720d54d..60f4313d75 100644 --- a/tevm/docs/errors/classes/ParseError.md +++ b/tevm/docs/errors/classes/ParseError.md @@ -9,16 +9,22 @@ Represents an error that occurs when invalid JSON is received by the server, resulting in a parsing error. This error is typically encountered when a JSON-RPC request is malformed or the JSON syntax is incorrect. +It's a standard JSON-RPC error with code -32700, indicating issues at the protocol level rather than +the application level. ## Example ```ts try { - // Some operation that can throw a ParseError + await client.request({ + method: 'eth_getBalance', + params: ['0x1234567890123456789012345678901234567890', 'latest'], + // Imagine this request is somehow malformed JSON + }) } catch (error) { if (error instanceof ParseError) { - console.error(error.message); - // Handle the parse error + console.error('JSON-RPC parse error:', error.message); + console.log('Check the request format and try again'); } } ``` @@ -67,7 +73,7 @@ The tag for the error. #### Defined in -packages/errors/types/ethereum/ParseErrorError.d.ts:45 +packages/errors/types/ethereum/ParseErrorError.d.ts:51 ## Properties @@ -83,7 +89,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -97,7 +103,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -105,7 +111,7 @@ packages/errors/types/ethereum/BaseError.d.ts:64 > **code**: `number` -Error code, analogous to the code in JSON RPC error. +Error code (-32700), standard JSON-RPC error code for parse errors. #### Inherited from @@ -113,7 +119,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -127,7 +133,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -143,7 +149,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -175,7 +181,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -205,7 +211,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -233,7 +239,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -243,6 +249,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -253,10 +263,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`BaseError`](BaseError.md).[`prepareStackTrace`](BaseError.md#preparestacktrace) @@ -305,7 +311,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -357,4 +363,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`BaseError`](BaseError.md).[`captureStackTrace`](BaseError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/ParseRpcError.md b/tevm/docs/errors/classes/ParseRpcError.md index efd7221375..770848fb96 100644 --- a/tevm/docs/errors/classes/ParseRpcError.md +++ b/tevm/docs/errors/classes/ParseRpcError.md @@ -30,7 +30,7 @@ #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:51 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:49 ## Properties @@ -58,7 +58,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es2022.err #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:20 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:20 *** @@ -72,7 +72,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:17 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:19 *** @@ -86,7 +86,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:18 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:20 *** @@ -114,7 +114,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:19 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:21 *** @@ -122,13 +122,13 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid > **name**: `string` -#### Overrides +#### Inherited from `RpcError.name` #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:49 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:24 *** @@ -142,7 +142,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:20 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:22 *** @@ -170,7 +170,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:22 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:23 *** @@ -180,7 +180,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:50 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:48 *** @@ -190,6 +190,10 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -200,10 +204,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from `RpcError.prepareStackTrace` @@ -244,7 +244,7 @@ node\_modules/.pnpm/@types+node@20.14.8/node\_modules/@types/node/globals.d.ts:3 ##### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:24 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:26 #### walk(fn) @@ -264,7 +264,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid ##### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:25 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:27 *** @@ -316,4 +316,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +`RpcError.captureStackTrace` + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/PendingTransactionTimeoutError.md b/tevm/docs/errors/classes/PendingTransactionTimeoutError.md index 6bcdfe9fb9..1690616a4d 100644 --- a/tevm/docs/errors/classes/PendingTransactionTimeoutError.md +++ b/tevm/docs/errors/classes/PendingTransactionTimeoutError.md @@ -83,7 +83,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -97,7 +97,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -113,7 +113,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -127,7 +127,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -143,7 +143,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -175,7 +175,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -205,7 +205,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -233,7 +233,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -243,6 +243,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -253,10 +257,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`BaseError`](BaseError.md).[`prepareStackTrace`](BaseError.md#preparestacktrace) @@ -305,7 +305,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -357,4 +357,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`BaseError`](BaseError.md).[`captureStackTrace`](BaseError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/ProviderDisconnectedError.md b/tevm/docs/errors/classes/ProviderDisconnectedError.md index 86240f37d7..7b55235d2d 100644 --- a/tevm/docs/errors/classes/ProviderDisconnectedError.md +++ b/tevm/docs/errors/classes/ProviderDisconnectedError.md @@ -30,7 +30,7 @@ #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:261 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:251 ## Properties @@ -58,7 +58,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es2022.err #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:20 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:20 *** @@ -72,7 +72,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:34 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:33 *** @@ -86,7 +86,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:17 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:19 *** @@ -100,7 +100,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:18 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:20 *** @@ -128,7 +128,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:19 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:21 *** @@ -136,13 +136,13 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid > **name**: `string` -#### Overrides +#### Inherited from `ProviderRpcError.name` #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:259 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:24 *** @@ -156,7 +156,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:20 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:22 *** @@ -184,7 +184,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:22 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:23 *** @@ -194,7 +194,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:260 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:250 *** @@ -204,6 +204,10 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -214,10 +218,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from `ProviderRpcError.prepareStackTrace` @@ -258,7 +258,7 @@ node\_modules/.pnpm/@types+node@20.14.8/node\_modules/@types/node/globals.d.ts:3 ##### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:24 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:26 #### walk(fn) @@ -278,7 +278,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid ##### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:25 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:27 *** @@ -330,4 +330,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +`ProviderRpcError.captureStackTrace` + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/RateLimitExceededError.md b/tevm/docs/errors/classes/RateLimitExceededError.md index eca8207af1..af9694e618 100644 --- a/tevm/docs/errors/classes/RateLimitExceededError.md +++ b/tevm/docs/errors/classes/RateLimitExceededError.md @@ -83,7 +83,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -97,7 +97,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -113,7 +113,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -127,7 +127,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -143,7 +143,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -175,7 +175,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -205,7 +205,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -233,7 +233,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -243,6 +243,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -253,10 +257,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`BaseError`](BaseError.md).[`prepareStackTrace`](BaseError.md#preparestacktrace) @@ -305,7 +305,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -357,4 +357,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`BaseError`](BaseError.md).[`captureStackTrace`](BaseError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/RefundExhaustedError.md b/tevm/docs/errors/classes/RefundExhaustedError.md index 2e41009368..a41b78acd2 100644 --- a/tevm/docs/errors/classes/RefundExhaustedError.md +++ b/tevm/docs/errors/classes/RefundExhaustedError.md @@ -99,7 +99,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -113,7 +113,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -129,7 +129,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -143,7 +143,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -159,7 +159,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -191,7 +191,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -221,7 +221,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -249,7 +249,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -269,6 +269,10 @@ packages/errors/types/ethereum/ethereumjs/RefundExhausted.d.ts:47 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -279,10 +283,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`ExecutionError`](ExecutionError.md).[`prepareStackTrace`](ExecutionError.md#preparestacktrace) @@ -331,7 +331,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -383,4 +383,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`ExecutionError`](ExecutionError.md).[`captureStackTrace`](ExecutionError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/ResourceNotFoundError.md b/tevm/docs/errors/classes/ResourceNotFoundError.md index bc42f51869..d720b5c114 100644 --- a/tevm/docs/errors/classes/ResourceNotFoundError.md +++ b/tevm/docs/errors/classes/ResourceNotFoundError.md @@ -87,7 +87,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -101,7 +101,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -117,7 +117,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -131,7 +131,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -147,7 +147,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -179,7 +179,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -209,7 +209,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -237,7 +237,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -247,6 +247,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -257,10 +261,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`BaseError`](BaseError.md).[`prepareStackTrace`](BaseError.md#preparestacktrace) @@ -309,7 +309,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -361,4 +361,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`BaseError`](BaseError.md).[`captureStackTrace`](BaseError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/ResourceNotFoundRpcError.md b/tevm/docs/errors/classes/ResourceNotFoundRpcError.md index e1a22638a2..2a12229ddf 100644 --- a/tevm/docs/errors/classes/ResourceNotFoundRpcError.md +++ b/tevm/docs/errors/classes/ResourceNotFoundRpcError.md @@ -30,7 +30,7 @@ #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:135 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:130 ## Properties @@ -58,7 +58,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es2022.err #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:20 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:20 *** @@ -72,7 +72,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:17 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:19 *** @@ -86,7 +86,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:18 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:20 *** @@ -114,7 +114,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:19 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:21 *** @@ -128,7 +128,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:133 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:128 *** @@ -142,7 +142,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:20 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:22 *** @@ -170,7 +170,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:22 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:23 *** @@ -180,7 +180,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:134 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:129 *** @@ -190,6 +190,10 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -200,10 +204,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from `RpcError.prepareStackTrace` @@ -244,7 +244,7 @@ node\_modules/.pnpm/@types+node@20.14.8/node\_modules/@types/node/globals.d.ts:3 ##### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:24 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:26 #### walk(fn) @@ -264,7 +264,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid ##### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:25 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:27 *** @@ -316,4 +316,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +`RpcError.captureStackTrace` + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/ResourceUnavailableError.md b/tevm/docs/errors/classes/ResourceUnavailableError.md index c5b0a3ee00..5598327232 100644 --- a/tevm/docs/errors/classes/ResourceUnavailableError.md +++ b/tevm/docs/errors/classes/ResourceUnavailableError.md @@ -83,7 +83,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -97,7 +97,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -113,7 +113,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -127,7 +127,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -143,7 +143,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -175,7 +175,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -205,7 +205,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -233,7 +233,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -243,6 +243,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -253,10 +257,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`BaseError`](BaseError.md).[`prepareStackTrace`](BaseError.md#preparestacktrace) @@ -305,7 +305,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -357,4 +357,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`BaseError`](BaseError.md).[`captureStackTrace`](BaseError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/ResourceUnavailableRpcError.md b/tevm/docs/errors/classes/ResourceUnavailableRpcError.md index 2d18b3414e..0a6d5b894a 100644 --- a/tevm/docs/errors/classes/ResourceUnavailableRpcError.md +++ b/tevm/docs/errors/classes/ResourceUnavailableRpcError.md @@ -30,7 +30,7 @@ #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:149 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:143 ## Properties @@ -58,7 +58,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es2022.err #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:20 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:20 *** @@ -72,7 +72,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:17 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:19 *** @@ -86,7 +86,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:18 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:20 *** @@ -114,7 +114,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:19 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:21 *** @@ -122,13 +122,13 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid > **name**: `string` -#### Overrides +#### Inherited from `RpcError.name` #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:147 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:24 *** @@ -142,7 +142,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:20 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:22 *** @@ -170,7 +170,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:22 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:23 *** @@ -180,7 +180,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:148 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:142 *** @@ -190,6 +190,10 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -200,10 +204,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from `RpcError.prepareStackTrace` @@ -244,7 +244,7 @@ node\_modules/.pnpm/@types+node@20.14.8/node\_modules/@types/node/globals.d.ts:3 ##### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:24 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:26 #### walk(fn) @@ -264,7 +264,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid ##### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:25 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:27 *** @@ -316,4 +316,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +`RpcError.captureStackTrace` + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/RevertError.md b/tevm/docs/errors/classes/RevertError.md index a7c3f5cdcb..0fc6deff9c 100644 --- a/tevm/docs/errors/classes/RevertError.md +++ b/tevm/docs/errors/classes/RevertError.md @@ -6,25 +6,32 @@ # Class: RevertError -Represents an error that occurs when a transaction execution is reverted. +Represents an error that occurs when a transaction or message call is reverted. -This error is typically encountered when a transaction or contract execution is reverted by the EVM. +This error is typically encountered when a contract explicitly calls the `revert` +operation or when a condition in a `require` statement is not met. It's a way for +smart contracts to signal that an operation should be rolled back due to a failure +condition. + +The error code -32000 is a standard Ethereum JSON-RPC error code indicating a +generic server error, which is often used for revert errors. ## Example ```ts try { - // Some operation that can throw a RevertError + const result = await client.call({ + to: '0x742d35Cc6634C0532925a3b844Bc454e4438f44e', + data: '0x...' // encoded function call that might revert + }) } catch (error) { if (error instanceof RevertError) { - console.error(error.message); - // Handle the revert error + console.error('Transaction reverted:', error.message); + console.log('Revert reason:', error.data); // If available } } ``` -## Abstract - ## Param A human-readable error message. @@ -61,6 +68,8 @@ Additional parameters for the BaseError. • **tag?**: `string` +The tag for the error. + #### Returns [`RevertError`](RevertError.md) @@ -71,7 +80,7 @@ Additional parameters for the BaseError. #### Defined in -packages/errors/types/ethereum/RevertError.d.ts:45 +packages/errors/types/ethereum/RevertError.d.ts:54 ## Properties @@ -87,7 +96,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -101,7 +110,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -109,7 +118,7 @@ packages/errors/types/ethereum/BaseError.d.ts:64 > **code**: `number` -Error code, analogous to the code in JSON RPC error. +Error code (-32000), standard Ethereum JSON-RPC error code for server errors. #### Inherited from @@ -117,7 +126,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -131,7 +140,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -147,7 +156,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -179,7 +188,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -209,7 +218,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -237,7 +246,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -247,6 +256,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -257,10 +270,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`BaseError`](BaseError.md).[`prepareStackTrace`](BaseError.md#preparestacktrace) @@ -309,7 +318,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -361,4 +370,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`BaseError`](BaseError.md).[`captureStackTrace`](BaseError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/StackOverflowError.md b/tevm/docs/errors/classes/StackOverflowError.md index 46dd8e9beb..1430e13dd7 100644 --- a/tevm/docs/errors/classes/StackOverflowError.md +++ b/tevm/docs/errors/classes/StackOverflowError.md @@ -108,7 +108,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -122,7 +122,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -138,7 +138,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -152,7 +152,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -168,7 +168,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -200,7 +200,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -230,7 +230,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -258,7 +258,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -278,6 +278,10 @@ packages/errors/types/ethereum/ethereumjs/StackOverflowError.d.ts:51 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -288,10 +292,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`ExecutionError`](ExecutionError.md).[`prepareStackTrace`](ExecutionError.md#preparestacktrace) @@ -340,7 +340,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -392,4 +392,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`ExecutionError`](ExecutionError.md).[`captureStackTrace`](ExecutionError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/StackUnderflowError.md b/tevm/docs/errors/classes/StackUnderflowError.md index 4e6fa93915..1891160415 100644 --- a/tevm/docs/errors/classes/StackUnderflowError.md +++ b/tevm/docs/errors/classes/StackUnderflowError.md @@ -105,7 +105,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -119,7 +119,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -135,7 +135,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -149,7 +149,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -165,7 +165,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -197,7 +197,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -227,7 +227,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -255,7 +255,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -275,6 +275,10 @@ packages/errors/types/ethereum/ethereumjs/StackUnderflowError.d.ts:50 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -285,10 +289,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`ExecutionError`](ExecutionError.md).[`prepareStackTrace`](ExecutionError.md#preparestacktrace) @@ -337,7 +337,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -389,4 +389,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`ExecutionError`](ExecutionError.md).[`captureStackTrace`](ExecutionError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/StaticStateChangeError.md b/tevm/docs/errors/classes/StaticStateChangeError.md index f89b0d1546..9c33cfe7c7 100644 --- a/tevm/docs/errors/classes/StaticStateChangeError.md +++ b/tevm/docs/errors/classes/StaticStateChangeError.md @@ -107,7 +107,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -121,7 +121,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -137,7 +137,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -151,7 +151,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -167,7 +167,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -199,7 +199,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -229,7 +229,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -257,7 +257,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -277,6 +277,10 @@ packages/errors/types/ethereum/ethereumjs/StaticStateChangeError.d.ts:51 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -287,10 +291,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`ExecutionError`](ExecutionError.md).[`prepareStackTrace`](ExecutionError.md#preparestacktrace) @@ -339,7 +339,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -391,4 +391,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`ExecutionError`](ExecutionError.md).[`captureStackTrace`](ExecutionError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/StopError.md b/tevm/docs/errors/classes/StopError.md index 48d7521c7e..915f9d141c 100644 --- a/tevm/docs/errors/classes/StopError.md +++ b/tevm/docs/errors/classes/StopError.md @@ -97,7 +97,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -111,7 +111,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -127,7 +127,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -141,7 +141,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -157,7 +157,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -189,7 +189,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -219,7 +219,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -247,7 +247,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -267,6 +267,10 @@ packages/errors/types/ethereum/ethereumjs/StopErrorError.d.ts:46 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -277,10 +281,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`ExecutionError`](ExecutionError.md).[`prepareStackTrace`](ExecutionError.md#preparestacktrace) @@ -329,7 +329,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -381,4 +381,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`ExecutionError`](ExecutionError.md).[`captureStackTrace`](ExecutionError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/TimeoutError.md b/tevm/docs/errors/classes/TimeoutError.md index be00f30ab8..91d8a92b70 100644 --- a/tevm/docs/errors/classes/TimeoutError.md +++ b/tevm/docs/errors/classes/TimeoutError.md @@ -34,7 +34,7 @@ #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/request.d.ts:64 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/request.d.ts:70 ## Properties @@ -62,7 +62,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es2022.err #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:17 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:19 *** @@ -76,7 +76,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:18 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:20 *** @@ -104,7 +104,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:19 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:21 *** @@ -112,13 +112,13 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid > **name**: `string` -#### Overrides +#### Inherited from `BaseError.name` #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/request.d.ts:63 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:24 *** @@ -132,7 +132,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:20 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:22 *** @@ -160,7 +160,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:22 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:23 *** @@ -170,6 +170,10 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -180,10 +184,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from `BaseError.prepareStackTrace` @@ -224,7 +224,7 @@ node\_modules/.pnpm/@types+node@20.14.8/node\_modules/@types/node/globals.d.ts:3 ##### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:24 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:26 #### walk(fn) @@ -244,7 +244,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid ##### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:25 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:27 *** @@ -296,4 +296,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +`BaseError.captureStackTrace` + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/TransactionRejectedError.md b/tevm/docs/errors/classes/TransactionRejectedError.md index 9b317d4085..066a8cbc69 100644 --- a/tevm/docs/errors/classes/TransactionRejectedError.md +++ b/tevm/docs/errors/classes/TransactionRejectedError.md @@ -97,7 +97,7 @@ packages/errors/types/ethereum/TransactionRejectedError.d.ts:54 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -113,7 +113,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -127,7 +127,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -143,7 +143,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -187,7 +187,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -217,7 +217,7 @@ packages/errors/types/ethereum/TransactionRejectedError.d.ts:59 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -245,7 +245,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -255,6 +255,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -265,10 +269,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`BaseError`](BaseError.md).[`prepareStackTrace`](BaseError.md#preparestacktrace) @@ -317,7 +317,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -369,4 +369,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`BaseError`](BaseError.md).[`captureStackTrace`](BaseError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/TransactionTooLargeError.md b/tevm/docs/errors/classes/TransactionTooLargeError.md index 5391ddc975..c5595fe98e 100644 --- a/tevm/docs/errors/classes/TransactionTooLargeError.md +++ b/tevm/docs/errors/classes/TransactionTooLargeError.md @@ -83,7 +83,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -97,7 +97,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -113,7 +113,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -127,7 +127,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -143,7 +143,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -175,7 +175,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -205,7 +205,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -233,7 +233,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -243,6 +243,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -253,10 +257,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`BaseError`](BaseError.md).[`prepareStackTrace`](BaseError.md#preparestacktrace) @@ -305,7 +305,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -357,4 +357,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`BaseError`](BaseError.md).[`captureStackTrace`](BaseError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/TransactionUnderpricedError.md b/tevm/docs/errors/classes/TransactionUnderpricedError.md index 495a8d29c1..a00dd3e09b 100644 --- a/tevm/docs/errors/classes/TransactionUnderpricedError.md +++ b/tevm/docs/errors/classes/TransactionUnderpricedError.md @@ -83,7 +83,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -97,7 +97,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -113,7 +113,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -127,7 +127,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -143,7 +143,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -175,7 +175,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -205,7 +205,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -233,7 +233,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -243,6 +243,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -253,10 +257,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`BaseError`](BaseError.md).[`prepareStackTrace`](BaseError.md#preparestacktrace) @@ -305,7 +305,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -357,4 +357,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`BaseError`](BaseError.md).[`captureStackTrace`](BaseError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/UnknownBlockError.md b/tevm/docs/errors/classes/UnknownBlockError.md index 11ca7a3489..56c4f8dd4b 100644 --- a/tevm/docs/errors/classes/UnknownBlockError.md +++ b/tevm/docs/errors/classes/UnknownBlockError.md @@ -8,17 +8,24 @@ Represents an error that occurs when the specified block could not be found. -This error is typically encountered when a block hash or number is provided that does not correspond to any block known to the node. +This error is typically encountered when a block hash or number is provided that does not correspond +to any block known to the node. This can happen if the block hasn't been mined yet, if it's on a +different chain, or if the node is not fully synced. + +The error code -32001 is a non-standard extension used by some Ethereum clients to +indicate this specific condition. ## Example ```ts try { - // Some operation that can throw an UnknownBlockError + const block = await client.getBlock({ + blockHash: '0x1234567890123456789012345678901234567890123456789012345678901234' + }) } catch (error) { if (error instanceof UnknownBlockError) { - console.error(error.message); - // Handle the unknown block error + console.error('Unknown block:', error.message); + console.log('The specified block does not exist or is not available to this node'); } } ``` @@ -67,7 +74,7 @@ The tag for the error. #### Defined in -packages/errors/types/ethereum/UnknownBlockError.d.ts:45 +packages/errors/types/ethereum/UnknownBlockError.d.ts:52 ## Properties @@ -83,7 +90,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -97,7 +104,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -105,7 +112,7 @@ packages/errors/types/ethereum/BaseError.d.ts:64 > **code**: `number` -Error code, analogous to the code in JSON RPC error. +Error code (-32001), a non-standard extension for this specific error. #### Inherited from @@ -113,7 +120,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -127,7 +134,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -143,7 +150,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -175,7 +182,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -205,7 +212,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -233,7 +240,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -243,6 +250,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -253,10 +264,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`BaseError`](BaseError.md).[`prepareStackTrace`](BaseError.md#preparestacktrace) @@ -305,7 +312,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -357,4 +364,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`BaseError`](BaseError.md).[`captureStackTrace`](BaseError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/UnknownRpcError.md b/tevm/docs/errors/classes/UnknownRpcError.md index 3e1ab7b20a..906cc39268 100644 --- a/tevm/docs/errors/classes/UnknownRpcError.md +++ b/tevm/docs/errors/classes/UnknownRpcError.md @@ -30,7 +30,7 @@ #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:299 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:286 ## Properties @@ -58,7 +58,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es2022.err #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:20 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:20 *** @@ -72,7 +72,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:17 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:19 *** @@ -86,7 +86,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:18 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:20 *** @@ -114,7 +114,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:19 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:21 *** @@ -122,13 +122,13 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid > **name**: `string` -#### Overrides +#### Inherited from `RpcError.name` #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:298 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:24 *** @@ -142,7 +142,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:20 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:22 *** @@ -170,7 +170,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:22 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:23 *** @@ -180,6 +180,10 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -190,10 +194,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from `RpcError.prepareStackTrace` @@ -234,7 +234,7 @@ node\_modules/.pnpm/@types+node@20.14.8/node\_modules/@types/node/globals.d.ts:3 ##### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:24 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:26 #### walk(fn) @@ -254,7 +254,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid ##### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:25 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:27 *** @@ -306,4 +306,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +`RpcError.captureStackTrace` + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/UnreachableCodeError.md b/tevm/docs/errors/classes/UnreachableCodeError.md index 7b88f35d50..46e0200c23 100644 --- a/tevm/docs/errors/classes/UnreachableCodeError.md +++ b/tevm/docs/errors/classes/UnreachableCodeError.md @@ -6,42 +6,40 @@ # Class: UnreachableCodeError -Represents an error that occurs when unreachable code is executed. This error always indicates a bug in the Tevm VM. - -Unreachable code errors can occur due to: -- Defensive programming checks to ensure all cases in a switch or if statement are covered. - -To handle this error take the following steps: -- ensure you did not modify the tevm VM in any unsupported way. -- Open an issue with a minimal reproducable example +Represents an error that occurs when unreachable code is executed. +This error always indicates a bug in the Tevm VM. ## Example -```typescript +```javascript import { UnreachableCodeError } from '@tevm/errors' -const x: 'a' | 'b' = 'a' - -if (x === 'a') { - console.log('A') -} else if (x === 'b') { - console.log('B') -} else { - throw new UnreachableCodeError(x, 'Unreachable code executed.') +function assertUnreachable(x) { + throw new UnreachableCodeError(x, 'Unreachable code executed') } -``` - -## Param - -The value that should be of type never. - -## Param - -A human-readable error message. -## Param +function getArea(shape) { + switch (shape) { + case 'circle': + return Math.PI * Math.pow(radius, 2) + case 'square': + return side * side + default: + return assertUnreachable(shape) + } +} -Additional parameters for the BaseError. +try { + getArea('triangle') // This should be unreachable +} catch (error) { + if (error instanceof UnreachableCodeError) { + console.error('Unreachable code executed:', error.message) + console.log('Unreachable value:', error.value) + // This indicates a bug in the Tevm VM + reportBugToTevmRepository(error) + } +} +``` ## Extends @@ -51,15 +49,15 @@ Additional parameters for the BaseError. ### new UnreachableCodeError() -> **new UnreachableCodeError**(`value`, `message`?, `args`?, `tag`?): [`UnreachableCodeError`](UnreachableCodeError.md) +> **new UnreachableCodeError**(`value`, `message`?, `args`?): [`UnreachableCodeError`](UnreachableCodeError.md) Constructs an UnreachableCodeError. #### Parameters -• **value**: `never` +• **value**: `any` -The value that should be of type never. +The value that should be unreachable. • **message?**: `string` @@ -67,11 +65,7 @@ Human-readable error message. • **args?**: [`UnreachableCodeErrorParameters`](../type-aliases/UnreachableCodeErrorParameters.md) -Additional parameters for the BaseError. - -• **tag?**: `string` - -The tag for the error. +Additional parameters for the error. #### Returns @@ -91,15 +85,13 @@ packages/errors/types/defensive/UnreachableCodeError.d.ts:57 > **\_tag**: `string` -Same as name, used internally. - #### Inherited from [`InternalError`](InternalError.md).[`_tag`](InternalError.md#_tag) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -113,7 +105,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -121,15 +113,13 @@ packages/errors/types/ethereum/BaseError.d.ts:64 > **code**: `number` -Error code, analogous to the code in JSON RPC error. - #### Inherited from [`InternalError`](InternalError.md).[`code`](InternalError.md#code) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -143,7 +133,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -151,15 +141,13 @@ packages/errors/types/ethereum/BaseError.d.ts:43 > **docsPath**: `undefined` \| `string` -Path to the documentation for this error. - #### Inherited from [`InternalError`](InternalError.md).[`docsPath`](InternalError.md#docspath) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -191,7 +179,7 @@ Optional object containing additional information about the error. #### Defined in -packages/errors/types/ethereum/InternalErrorError.d.ts:49 +packages/errors/types/ethereum/InternalErrorError.d.ts:53 *** @@ -199,15 +187,13 @@ packages/errors/types/ethereum/InternalErrorError.d.ts:49 > **metaMessages**: `undefined` \| `string`[] -Additional meta messages for more context. - #### Inherited from [`InternalError`](InternalError.md).[`metaMessages`](InternalError.md#metamessages) #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -237,7 +223,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -255,6 +241,18 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 *** +### value + +> **value**: `any` + +The value that should be unreachable. + +#### Defined in + +packages/errors/types/defensive/UnreachableCodeError.d.ts:62 + +*** + ### version > **version**: `string` @@ -265,7 +263,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -275,6 +273,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -285,10 +287,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`InternalError`](InternalError.md).[`prepareStackTrace`](InternalError.md#preparestacktrace) @@ -337,7 +335,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -389,4 +387,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`InternalError`](InternalError.md).[`captureStackTrace`](InternalError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/UnsupportedChainError.md b/tevm/docs/errors/classes/UnsupportedChainError.md index 935ad4d00b..a25d9601a0 100644 --- a/tevm/docs/errors/classes/UnsupportedChainError.md +++ b/tevm/docs/errors/classes/UnsupportedChainError.md @@ -83,7 +83,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -97,7 +97,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -113,7 +113,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -127,7 +127,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -143,7 +143,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -175,7 +175,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -205,7 +205,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -233,7 +233,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -243,6 +243,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -253,10 +257,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`BaseError`](BaseError.md).[`prepareStackTrace`](BaseError.md#preparestacktrace) @@ -305,7 +305,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -357,4 +357,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`BaseError`](BaseError.md).[`captureStackTrace`](BaseError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/UnsupportedProviderMethodError.md b/tevm/docs/errors/classes/UnsupportedProviderMethodError.md index 4eb8a0b280..e6516ba787 100644 --- a/tevm/docs/errors/classes/UnsupportedProviderMethodError.md +++ b/tevm/docs/errors/classes/UnsupportedProviderMethodError.md @@ -14,12 +14,16 @@ ### new UnsupportedProviderMethodError() -> **new UnsupportedProviderMethodError**(`cause`): [`UnsupportedProviderMethodError`](UnsupportedProviderMethodError.md) +> **new UnsupportedProviderMethodError**(`cause`, `__namedParameters`?): [`UnsupportedProviderMethodError`](UnsupportedProviderMethodError.md) #### Parameters • **cause**: `Error` +• **\_\_namedParameters?** + +• **\_\_namedParameters.method?**: `string` + #### Returns [`UnsupportedProviderMethodError`](UnsupportedProviderMethodError.md) @@ -30,7 +34,7 @@ #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:247 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:236 ## Properties @@ -58,7 +62,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es2022.err #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:20 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:20 *** @@ -72,7 +76,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:34 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:33 *** @@ -86,7 +90,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:17 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:19 *** @@ -100,7 +104,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:18 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:20 *** @@ -128,7 +132,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:19 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:21 *** @@ -136,13 +140,13 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid > **name**: `string` -#### Overrides +#### Inherited from `ProviderRpcError.name` #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:245 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:24 *** @@ -156,7 +160,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:20 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:22 *** @@ -184,7 +188,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:22 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:23 *** @@ -194,7 +198,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:246 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:235 *** @@ -204,6 +208,10 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -214,10 +222,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from `ProviderRpcError.prepareStackTrace` @@ -258,7 +262,7 @@ node\_modules/.pnpm/@types+node@20.14.8/node\_modules/@types/node/globals.d.ts:3 ##### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:24 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:26 #### walk(fn) @@ -278,7 +282,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid ##### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:25 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:27 *** @@ -330,4 +334,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +`ProviderRpcError.captureStackTrace` + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/UserRejectedRequestError.md b/tevm/docs/errors/classes/UserRejectedRequestError.md index e030dd4f2a..a01e4b01e2 100644 --- a/tevm/docs/errors/classes/UserRejectedRequestError.md +++ b/tevm/docs/errors/classes/UserRejectedRequestError.md @@ -30,7 +30,7 @@ #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:219 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:210 ## Properties @@ -58,7 +58,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es2022.err #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:20 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:20 *** @@ -72,7 +72,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:34 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:33 *** @@ -86,7 +86,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:17 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:19 *** @@ -100,7 +100,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:18 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:20 *** @@ -128,7 +128,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:19 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:21 *** @@ -136,13 +136,13 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid > **name**: `string` -#### Overrides +#### Inherited from `ProviderRpcError.name` #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:217 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:24 *** @@ -156,7 +156,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:20 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:22 *** @@ -184,7 +184,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:22 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:23 *** @@ -194,7 +194,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid #### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:218 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/rpc.d.ts:209 *** @@ -204,6 +204,10 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -214,10 +218,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from `ProviderRpcError.prepareStackTrace` @@ -258,7 +258,7 @@ node\_modules/.pnpm/@types+node@20.14.8/node\_modules/@types/node/globals.d.ts:3 ##### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:24 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:26 #### walk(fn) @@ -278,7 +278,7 @@ node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-valid ##### Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:25 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/errors/base.d.ts:27 *** @@ -330,4 +330,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +`ProviderRpcError.captureStackTrace` + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/classes/ValueOverflowError.md b/tevm/docs/errors/classes/ValueOverflowError.md index ce519fcc0d..984f228edc 100644 --- a/tevm/docs/errors/classes/ValueOverflowError.md +++ b/tevm/docs/errors/classes/ValueOverflowError.md @@ -97,7 +97,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -111,7 +111,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -127,7 +127,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -141,7 +141,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -157,7 +157,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -189,7 +189,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -219,7 +219,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -247,7 +247,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -267,6 +267,10 @@ packages/errors/types/ethereum/ethereumjs/ValueOverflowError.d.ts:46 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -277,10 +281,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`ExecutionError`](ExecutionError.md).[`prepareStackTrace`](ExecutionError.md#preparestacktrace) @@ -329,7 +329,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -381,4 +381,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`ExecutionError`](ExecutionError.md).[`captureStackTrace`](ExecutionError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/errors/type-aliases/AccountLockedErrorParameters.md b/tevm/docs/errors/type-aliases/AccountLockedErrorParameters.md index a2e4dff0b1..f2bbf21a8a 100644 --- a/tevm/docs/errors/type-aliases/AccountLockedErrorParameters.md +++ b/tevm/docs/errors/type-aliases/AccountLockedErrorParameters.md @@ -56,4 +56,4 @@ Parameters for constructing an AccountLockedError. ## Defined in -packages/errors/types/ethereum/AccountLockedError.d.ts:52 +packages/errors/types/ethereum/AccountLockedError.d.ts:60 diff --git a/tevm/docs/errors/type-aliases/AuthCallNonZeroValueExtErrorParameters.md b/tevm/docs/errors/type-aliases/AuthCallNonZeroValueExtErrorParameters.md deleted file mode 100644 index 148409b788..0000000000 --- a/tevm/docs/errors/type-aliases/AuthCallNonZeroValueExtErrorParameters.md +++ /dev/null @@ -1,59 +0,0 @@ -[**tevm**](../../README.md) • **Docs** - -*** - -[tevm](../../modules.md) / [errors](../README.md) / AuthCallNonZeroValueExtErrorParameters - -# Type Alias: AuthCallNonZeroValueExtErrorParameters - -> **AuthCallNonZeroValueExtErrorParameters**: `object` - -Parameters for constructing a [AuthCallNonZeroValueExtError](../classes/AuthCallNonZeroValueExtError.md). - -## Type declaration - -### cause? - -> `optional` **cause**: [`ExecutionError`](../classes/ExecutionError.md) \| `EvmError` - -- The cause of the error. - -### details? - -> `optional` **details**: `string` - -- Details of the error. - -### docsBaseUrl? - -> `optional` **docsBaseUrl**: `string` - -- Base URL for the documentation. - -### docsPath? - -> `optional` **docsPath**: `string` - -- Path to the documentation. - -### docsSlug? - -> `optional` **docsSlug**: `string` - -- Slug for the documentation. - -### meta? - -> `optional` **meta**: `object` - -- Optional object containing additional information about the error. - -### metaMessages? - -> `optional` **metaMessages**: `string`[] - -- Additional meta messages. - -## Defined in - -packages/errors/types/ethereum/ethereumjs/AuthCallNonZeroValueExtError.d.ts:71 diff --git a/tevm/docs/errors/type-aliases/AuthInvalidSErrorParameters.md b/tevm/docs/errors/type-aliases/AuthInvalidSErrorParameters.md deleted file mode 100644 index 2ccd53abac..0000000000 --- a/tevm/docs/errors/type-aliases/AuthInvalidSErrorParameters.md +++ /dev/null @@ -1,59 +0,0 @@ -[**tevm**](../../README.md) • **Docs** - -*** - -[tevm](../../modules.md) / [errors](../README.md) / AuthInvalidSErrorParameters - -# Type Alias: AuthInvalidSErrorParameters - -> **AuthInvalidSErrorParameters**: `object` - -Parameters for constructing a [AuthInvalidSError](../classes/AuthInvalidSError.md). - -## Type declaration - -### cause? - -> `optional` **cause**: [`ExecutionError`](../classes/ExecutionError.md) \| `EvmError` - -- The cause of the error. - -### details? - -> `optional` **details**: `string` - -- Details of the error. - -### docsBaseUrl? - -> `optional` **docsBaseUrl**: `string` - -- Base URL for the documentation. - -### docsPath? - -> `optional` **docsPath**: `string` - -- Path to the documentation. - -### docsSlug? - -> `optional` **docsSlug**: `string` - -- Slug for the documentation. - -### meta? - -> `optional` **meta**: `object` - -- Optional object containing additional information about the error. - -### metaMessages? - -> `optional` **metaMessages**: `string`[] - -- Additional meta messages. - -## Defined in - -packages/errors/types/ethereum/ethereumjs/AuthInvalidSError.d.ts:71 diff --git a/tevm/docs/errors/type-aliases/BaseErrorParameters.md b/tevm/docs/errors/type-aliases/BaseErrorParameters.md index 3c338a8629..aade1f636c 100644 --- a/tevm/docs/errors/type-aliases/BaseErrorParameters.md +++ b/tevm/docs/errors/type-aliases/BaseErrorParameters.md @@ -48,4 +48,4 @@ ## Defined in -packages/errors/types/ethereum/BaseError.d.ts:72 +packages/errors/types/ethereum/BaseError.d.ts:73 diff --git a/tevm/docs/errors/type-aliases/BlockGasLimitExceededErrorParameters.md b/tevm/docs/errors/type-aliases/BlockGasLimitExceededErrorParameters.md index aec0a496d9..f305d49b87 100644 --- a/tevm/docs/errors/type-aliases/BlockGasLimitExceededErrorParameters.md +++ b/tevm/docs/errors/type-aliases/BlockGasLimitExceededErrorParameters.md @@ -56,4 +56,4 @@ Parameters for constructing a BlockGasLimitExceededError. ## Defined in -packages/errors/types/ethereum/BlockGasLimitExceededError.d.ts:64 +packages/errors/types/ethereum/BlockGasLimitExceededError.d.ts:71 diff --git a/tevm/docs/errors/type-aliases/CommonMismatchErrorParameters.md b/tevm/docs/errors/type-aliases/CommonMismatchErrorParameters.md index 966d69873a..4fa68b79ac 100644 --- a/tevm/docs/errors/type-aliases/CommonMismatchErrorParameters.md +++ b/tevm/docs/errors/type-aliases/CommonMismatchErrorParameters.md @@ -56,4 +56,4 @@ Parameters for constructing a [CommonMismatchError](../classes/CommonMismatchErr ## Defined in -packages/errors/types/common/CommonMismatchError.d.ts:54 +packages/errors/types/common/CommonMismatchError.d.ts:53 diff --git a/tevm/docs/errors/type-aliases/ContractExecutionFailedErrorParameters.md b/tevm/docs/errors/type-aliases/ContractExecutionFailedErrorParameters.md index b542e78b76..cb394a9ac0 100644 --- a/tevm/docs/errors/type-aliases/ContractExecutionFailedErrorParameters.md +++ b/tevm/docs/errors/type-aliases/ContractExecutionFailedErrorParameters.md @@ -56,4 +56,4 @@ Parameters for constructing a ContractExecutionFailedError. ## Defined in -packages/errors/types/ethereum/ContractExecutionFailedError.d.ts:50 +packages/errors/types/ethereum/ContractExecutionFailedError.d.ts:58 diff --git a/tevm/docs/errors/type-aliases/DefensiveNullCheckErrorParameters.md b/tevm/docs/errors/type-aliases/DefensiveNullCheckErrorParameters.md index d2364decc7..28c38b051b 100644 --- a/tevm/docs/errors/type-aliases/DefensiveNullCheckErrorParameters.md +++ b/tevm/docs/errors/type-aliases/DefensiveNullCheckErrorParameters.md @@ -56,4 +56,4 @@ Parameters for constructing a [DefensiveNullCheckError](../classes/DefensiveNull ## Defined in -packages/errors/types/defensive/DefensiveNullCheckError.d.ts:59 +packages/errors/types/defensive/DefensiveNullCheckError.d.ts:53 diff --git a/tevm/docs/errors/type-aliases/ForkErrorParameters.md b/tevm/docs/errors/type-aliases/ForkErrorParameters.md index 0f068d0a2b..a91e76ccc3 100644 --- a/tevm/docs/errors/type-aliases/ForkErrorParameters.md +++ b/tevm/docs/errors/type-aliases/ForkErrorParameters.md @@ -8,7 +8,7 @@ > **ForkErrorParameters**: `object` -Parameters for constructing an ForkError. +Parameters for constructing a ForkError. ## Type declaration @@ -56,4 +56,4 @@ Parameters for constructing an ForkError. ## Defined in -packages/errors/types/fork/ForkError.d.ts:67 +packages/errors/types/fork/ForkError.d.ts:54 diff --git a/tevm/docs/errors/type-aliases/InternalErrorParameters.md b/tevm/docs/errors/type-aliases/InternalErrorParameters.md index 13bf869946..dfa1fad5b2 100644 --- a/tevm/docs/errors/type-aliases/InternalErrorParameters.md +++ b/tevm/docs/errors/type-aliases/InternalErrorParameters.md @@ -56,4 +56,4 @@ Parameters for constructing an InternalError. ## Defined in -packages/errors/types/ethereum/InternalErrorError.d.ts:54 +packages/errors/types/ethereum/InternalErrorError.d.ts:58 diff --git a/tevm/docs/errors/type-aliases/InvalidAbiErrorParameters.md b/tevm/docs/errors/type-aliases/InvalidAbiErrorParameters.md index f8fd542f6e..1d50d8776c 100644 --- a/tevm/docs/errors/type-aliases/InvalidAbiErrorParameters.md +++ b/tevm/docs/errors/type-aliases/InvalidAbiErrorParameters.md @@ -56,4 +56,4 @@ Parameters for constructing an InvalidAbiError. ## Defined in -packages/errors/types/input/InvalidAbiError.d.ts:42 +packages/errors/types/input/InvalidAbiError.d.ts:52 diff --git a/tevm/docs/errors/type-aliases/InvalidArgsErrorParameters.md b/tevm/docs/errors/type-aliases/InvalidArgsErrorParameters.md index 39248b6e34..47c370d46b 100644 --- a/tevm/docs/errors/type-aliases/InvalidArgsErrorParameters.md +++ b/tevm/docs/errors/type-aliases/InvalidArgsErrorParameters.md @@ -56,4 +56,4 @@ Parameters for constructing an InvalidArgsError. ## Defined in -packages/errors/types/input/InvalidArgsError.d.ts:42 +packages/errors/types/input/InvalidArgsError.d.ts:53 diff --git a/tevm/docs/errors/type-aliases/InvalidBalanceErrorParameters.md b/tevm/docs/errors/type-aliases/InvalidBalanceErrorParameters.md index e32eaed4bd..4d9d2f2120 100644 --- a/tevm/docs/errors/type-aliases/InvalidBalanceErrorParameters.md +++ b/tevm/docs/errors/type-aliases/InvalidBalanceErrorParameters.md @@ -56,4 +56,4 @@ Parameters for constructing an InvalidBalanceError. ## Defined in -packages/errors/types/input/InvalidBalanceError.d.ts:42 +packages/errors/types/input/InvalidBalanceError.d.ts:51 diff --git a/tevm/docs/errors/type-aliases/InvalidBlobVersionedHashesErrorParameters.md b/tevm/docs/errors/type-aliases/InvalidBlobVersionedHashesErrorParameters.md index fb0c54c89e..94ef45b8f4 100644 --- a/tevm/docs/errors/type-aliases/InvalidBlobVersionedHashesErrorParameters.md +++ b/tevm/docs/errors/type-aliases/InvalidBlobVersionedHashesErrorParameters.md @@ -56,4 +56,4 @@ Parameters for constructing an InvalidBlobVersionedHashesError. ## Defined in -packages/errors/types/input/InvalidBlobVersionedHashesError.d.ts:42 +packages/errors/types/input/InvalidBlobVersionedHashesError.d.ts:51 diff --git a/tevm/docs/errors/type-aliases/InvalidBytesSizeErrorParameters.md b/tevm/docs/errors/type-aliases/InvalidBytesSizeErrorParameters.md index d38059cc91..b4ac814f2f 100644 --- a/tevm/docs/errors/type-aliases/InvalidBytesSizeErrorParameters.md +++ b/tevm/docs/errors/type-aliases/InvalidBytesSizeErrorParameters.md @@ -56,4 +56,4 @@ Parameters for constructing an [InvalidBytesSizeError](../classes/InvalidBytesSi ## Defined in -packages/errors/types/data/InvalidByteSizeError.d.ts:57 +packages/errors/types/data/InvalidByteSizeError.d.ts:64 diff --git a/tevm/docs/errors/type-aliases/InvalidDataErrorParameters.md b/tevm/docs/errors/type-aliases/InvalidDataErrorParameters.md index cb2b068b85..a97a580c1f 100644 --- a/tevm/docs/errors/type-aliases/InvalidDataErrorParameters.md +++ b/tevm/docs/errors/type-aliases/InvalidDataErrorParameters.md @@ -56,4 +56,4 @@ Parameters for constructing an InvalidDataError. ## Defined in -packages/errors/types/input/InvalidDataError.d.ts:42 +packages/errors/types/input/InvalidDataError.d.ts:52 diff --git a/tevm/docs/errors/type-aliases/InvalidDeployedBytecodeErrorParameters.md b/tevm/docs/errors/type-aliases/InvalidDeployedBytecodeErrorParameters.md index be3082d0bc..db999558e9 100644 --- a/tevm/docs/errors/type-aliases/InvalidDeployedBytecodeErrorParameters.md +++ b/tevm/docs/errors/type-aliases/InvalidDeployedBytecodeErrorParameters.md @@ -56,4 +56,4 @@ Parameters for constructing an InvalidDeployedBytecodeError. ## Defined in -packages/errors/types/input/InvalidDeployedBytecodeError.d.ts:42 +packages/errors/types/input/InvalidDeployedBytecodeError.d.ts:51 diff --git a/tevm/docs/errors/type-aliases/InvalidFunctionNameErrorParameters.md b/tevm/docs/errors/type-aliases/InvalidFunctionNameErrorParameters.md index 00570097f8..c3455e50c2 100644 --- a/tevm/docs/errors/type-aliases/InvalidFunctionNameErrorParameters.md +++ b/tevm/docs/errors/type-aliases/InvalidFunctionNameErrorParameters.md @@ -56,4 +56,4 @@ Parameters for constructing an InvalidFunctionNameError. ## Defined in -packages/errors/types/input/InvalidFunctionNameError.d.ts:42 +packages/errors/types/input/InvalidFunctionNameError.d.ts:52 diff --git a/tevm/docs/errors/type-aliases/InvalidGasLimitErrorParameters.md b/tevm/docs/errors/type-aliases/InvalidGasLimitErrorParameters.md index c78f412e31..efa6ffe73d 100644 --- a/tevm/docs/errors/type-aliases/InvalidGasLimitErrorParameters.md +++ b/tevm/docs/errors/type-aliases/InvalidGasLimitErrorParameters.md @@ -56,4 +56,4 @@ Parameters for constructing an InvalidGasLimitError. ## Defined in -packages/errors/types/input/InvalidGasLimitError.d.ts:42 +packages/errors/types/input/InvalidGasLimitError.d.ts:52 diff --git a/tevm/docs/errors/type-aliases/InvalidGasRefundErrorParameters.md b/tevm/docs/errors/type-aliases/InvalidGasRefundErrorParameters.md index 8556190298..cdbd6f154b 100644 --- a/tevm/docs/errors/type-aliases/InvalidGasRefundErrorParameters.md +++ b/tevm/docs/errors/type-aliases/InvalidGasRefundErrorParameters.md @@ -56,4 +56,4 @@ Parameters for constructing an InvalidGasRefundError. ## Defined in -packages/errors/types/input/InvalidGasRefundError.d.ts:42 +packages/errors/types/input/InvalidGasRefundError.d.ts:51 diff --git a/tevm/docs/errors/type-aliases/InvalidMaxFeePerGasErrorParameters.md b/tevm/docs/errors/type-aliases/InvalidMaxFeePerGasErrorParameters.md index b9a3fcb0f5..3bbdb7f922 100644 --- a/tevm/docs/errors/type-aliases/InvalidMaxFeePerGasErrorParameters.md +++ b/tevm/docs/errors/type-aliases/InvalidMaxFeePerGasErrorParameters.md @@ -56,4 +56,4 @@ Parameters for constructing an InvalidMaxFeePerGasError. ## Defined in -packages/errors/types/input/InvalidMaxFeePerGaserror.d.ts:42 +packages/errors/types/input/InvalidMaxFeePerGaserror.d.ts:52 diff --git a/tevm/docs/errors/type-aliases/InvalidMaxPriorityFeePerGasErrorParameters.md b/tevm/docs/errors/type-aliases/InvalidMaxPriorityFeePerGasErrorParameters.md index c0b05ad621..da82741216 100644 --- a/tevm/docs/errors/type-aliases/InvalidMaxPriorityFeePerGasErrorParameters.md +++ b/tevm/docs/errors/type-aliases/InvalidMaxPriorityFeePerGasErrorParameters.md @@ -56,4 +56,4 @@ Parameters for constructing an InvalidMaxPriorityFeePerGasError. ## Defined in -packages/errors/types/input/InvalidMaxPriorityFeePerGas.d.ts:42 +packages/errors/types/input/InvalidMaxPriorityFeePerGas.d.ts:52 diff --git a/tevm/docs/errors/type-aliases/InvalidSelfdestructErrorParameters.md b/tevm/docs/errors/type-aliases/InvalidSelfdestructErrorParameters.md index bbaf921c74..76b2af8f23 100644 --- a/tevm/docs/errors/type-aliases/InvalidSelfdestructErrorParameters.md +++ b/tevm/docs/errors/type-aliases/InvalidSelfdestructErrorParameters.md @@ -56,4 +56,4 @@ Parameters for constructing an InvalidSelfdestructError. ## Defined in -packages/errors/types/input/InvalidSelfdestructError.d.ts:42 +packages/errors/types/input/InvalidSelfdestructError.d.ts:51 diff --git a/tevm/docs/errors/type-aliases/InvalidSkipBalanceErrorParameters.md b/tevm/docs/errors/type-aliases/InvalidSkipBalanceErrorParameters.md index 3cb1b78a96..dd74b63c86 100644 --- a/tevm/docs/errors/type-aliases/InvalidSkipBalanceErrorParameters.md +++ b/tevm/docs/errors/type-aliases/InvalidSkipBalanceErrorParameters.md @@ -56,4 +56,4 @@ Parameters for constructing an InvalidSkipBalanceError. ## Defined in -packages/errors/types/input/InvalidSkipBalanceError.d.ts:42 +packages/errors/types/input/InvalidSkipBalanceError.d.ts:51 diff --git a/tevm/docs/errors/type-aliases/InvalidStorageRootErrorParameters.md b/tevm/docs/errors/type-aliases/InvalidStorageRootErrorParameters.md index 9f9d0d7863..36c32ad3ac 100644 --- a/tevm/docs/errors/type-aliases/InvalidStorageRootErrorParameters.md +++ b/tevm/docs/errors/type-aliases/InvalidStorageRootErrorParameters.md @@ -56,4 +56,4 @@ Parameters for constructing an InvalidStorageRootError. ## Defined in -packages/errors/types/input/InvalidStorageRootError.d.ts:42 +packages/errors/types/input/InvalidStorageRootError.d.ts:51 diff --git a/tevm/docs/errors/type-aliases/InvalidToErrorParameters.md b/tevm/docs/errors/type-aliases/InvalidToErrorParameters.md index 8e91f8fa98..8470715e5d 100644 --- a/tevm/docs/errors/type-aliases/InvalidToErrorParameters.md +++ b/tevm/docs/errors/type-aliases/InvalidToErrorParameters.md @@ -56,4 +56,4 @@ Parameters for constructing an InvalidToError. ## Defined in -packages/errors/types/input/InvalidToError.d.ts:42 +packages/errors/types/input/InvalidToError.d.ts:52 diff --git a/tevm/docs/errors/type-aliases/InvalidUrlErrorParameters.md b/tevm/docs/errors/type-aliases/InvalidUrlErrorParameters.md index f48239b0e0..78383e6e0d 100644 --- a/tevm/docs/errors/type-aliases/InvalidUrlErrorParameters.md +++ b/tevm/docs/errors/type-aliases/InvalidUrlErrorParameters.md @@ -56,4 +56,4 @@ Parameters for constructing an InvalidUrlError. ## Defined in -packages/errors/types/input/InvalidUrlError.d.ts:42 +packages/errors/types/input/InvalidUrlError.d.ts:50 diff --git a/tevm/docs/errors/type-aliases/MisconfiguredClientErrorParameters.md b/tevm/docs/errors/type-aliases/MisconfiguredClientErrorParameters.md index 35cfa74d90..b61ebea3df 100644 --- a/tevm/docs/errors/type-aliases/MisconfiguredClientErrorParameters.md +++ b/tevm/docs/errors/type-aliases/MisconfiguredClientErrorParameters.md @@ -56,4 +56,4 @@ Parameters for constructing a [MisconfiguredClientError](../classes/Misconfigure ## Defined in -packages/errors/types/client/MisconfiguredClient.d.ts:54 +packages/errors/types/client/MisconfiguredClient.d.ts:57 diff --git a/tevm/docs/errors/type-aliases/NoForkTransportSetErrorParameters.md b/tevm/docs/errors/type-aliases/NoForkTransportSetErrorParameters.md index 7149508552..a69c6f4890 100644 --- a/tevm/docs/errors/type-aliases/NoForkTransportSetErrorParameters.md +++ b/tevm/docs/errors/type-aliases/NoForkTransportSetErrorParameters.md @@ -8,7 +8,7 @@ > **NoForkTransportSetErrorParameters**: `object` -Parameters for constructing an NoForkTransportSetError. +Parameters for constructing a NoForkTransportSetError. ## Type declaration @@ -56,4 +56,4 @@ Parameters for constructing an NoForkTransportSetError. ## Defined in -packages/errors/types/fork/NoForkUriSetError.d.ts:38 +packages/errors/types/fork/NoForkUriSetError.d.ts:47 diff --git a/tevm/docs/errors/type-aliases/NonceTooHighErrorParameters.md b/tevm/docs/errors/type-aliases/NonceTooHighErrorParameters.md index d675dd277f..e8114b3324 100644 --- a/tevm/docs/errors/type-aliases/NonceTooHighErrorParameters.md +++ b/tevm/docs/errors/type-aliases/NonceTooHighErrorParameters.md @@ -56,4 +56,4 @@ Parameters for constructing a NonceTooHighError. ## Defined in -packages/errors/types/ethereum/NonceTooHighError.d.ts:50 +packages/errors/types/ethereum/NonceTooHighError.d.ts:60 diff --git a/tevm/docs/errors/type-aliases/NonceTooLowErrorParameters.md b/tevm/docs/errors/type-aliases/NonceTooLowErrorParameters.md index 26f9ce8d5a..2172b1fbaf 100644 --- a/tevm/docs/errors/type-aliases/NonceTooLowErrorParameters.md +++ b/tevm/docs/errors/type-aliases/NonceTooLowErrorParameters.md @@ -56,4 +56,4 @@ Parameters for constructing a NonceTooLowError. ## Defined in -packages/errors/types/ethereum/NonceTooLowError.d.ts:50 +packages/errors/types/ethereum/NonceTooLowError.d.ts:60 diff --git a/tevm/docs/errors/type-aliases/ParseErrorParameters.md b/tevm/docs/errors/type-aliases/ParseErrorParameters.md index 0f4d64cf8b..5ccb9a20b5 100644 --- a/tevm/docs/errors/type-aliases/ParseErrorParameters.md +++ b/tevm/docs/errors/type-aliases/ParseErrorParameters.md @@ -56,4 +56,4 @@ Parameters for constructing a ParseError. ## Defined in -packages/errors/types/ethereum/ParseErrorError.d.ts:50 +packages/errors/types/ethereum/ParseErrorError.d.ts:56 diff --git a/tevm/docs/errors/type-aliases/RevertErrorParameters.md b/tevm/docs/errors/type-aliases/RevertErrorParameters.md index 25d5d0adc3..77000c2948 100644 --- a/tevm/docs/errors/type-aliases/RevertErrorParameters.md +++ b/tevm/docs/errors/type-aliases/RevertErrorParameters.md @@ -56,4 +56,4 @@ Parameters for constructing a RevertError. ## Defined in -packages/errors/types/ethereum/RevertError.d.ts:50 +packages/errors/types/ethereum/RevertError.d.ts:59 diff --git a/tevm/docs/errors/type-aliases/RpcErrorCode.md b/tevm/docs/errors/type-aliases/RpcErrorCode.md index 499b2c1218..46f5f6b995 100644 --- a/tevm/docs/errors/type-aliases/RpcErrorCode.md +++ b/tevm/docs/errors/type-aliases/RpcErrorCode.md @@ -8,6 +8,8 @@ > **RpcErrorCode**: `-1` \| `-32700` \| `-32600` \| `-32601` \| `-32602` \| `-32603` \| `-32000` \| `-32001` \| `-32002` \| `-32003` \| `-32004` \| `-32005` \| `-32006` \| `-32042` +Represents the possible error codes for RPC errors. + ## Defined in -packages/errors/types/requestErrors.d.ts:2 +packages/errors/types/requestErrors.d.ts:9 diff --git a/tevm/docs/errors/type-aliases/UnknownBlockErrorParameters.md b/tevm/docs/errors/type-aliases/UnknownBlockErrorParameters.md index aa17718c3e..ed9c2a52e1 100644 --- a/tevm/docs/errors/type-aliases/UnknownBlockErrorParameters.md +++ b/tevm/docs/errors/type-aliases/UnknownBlockErrorParameters.md @@ -56,4 +56,4 @@ Parameters for constructing an UnknownBlockError. ## Defined in -packages/errors/types/ethereum/UnknownBlockError.d.ts:50 +packages/errors/types/ethereum/UnknownBlockError.d.ts:57 diff --git a/tevm/docs/errors/type-aliases/UnreachableCodeErrorParameters.md b/tevm/docs/errors/type-aliases/UnreachableCodeErrorParameters.md index 47e484f551..84c94e655a 100644 --- a/tevm/docs/errors/type-aliases/UnreachableCodeErrorParameters.md +++ b/tevm/docs/errors/type-aliases/UnreachableCodeErrorParameters.md @@ -56,4 +56,4 @@ Parameters for constructing a [UnreachableCodeError](../classes/UnreachableCodeE ## Defined in -packages/errors/types/defensive/UnreachableCodeError.d.ts:62 +packages/errors/types/defensive/UnreachableCodeError.d.ts:67 diff --git a/tevm/docs/evm/classes/EthjsMessage.md b/tevm/docs/evm/classes/EthjsMessage.md index cf6dca5e82..185b62d3b4 100644 --- a/tevm/docs/evm/classes/EthjsMessage.md +++ b/tevm/docs/evm/classes/EthjsMessage.md @@ -22,7 +22,7 @@ #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:64 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:65 ## Properties @@ -32,17 +32,17 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:38 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:39 *** ### accessWitness? -> `optional` **accessWitness**: `AccessWitness` +> `optional` **accessWitness**: `AccessWitnessInterface` #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:63 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:64 *** @@ -55,7 +55,7 @@ the purpose is to figure out where `value` should be taken from (not from `calle #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:57 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:58 *** @@ -67,7 +67,7 @@ List of versioned hashes if message is a blob transaction in the outer VM #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:62 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:63 *** @@ -77,7 +77,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:33 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:34 *** @@ -87,7 +87,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:43 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:44 *** @@ -97,7 +97,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:37 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:38 *** @@ -107,19 +107,19 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:42 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:43 *** ### createdAddresses? -> `optional` **createdAddresses**: `Set`\<`string`\> +> `optional` **createdAddresses**: `Set`\<\`0x$\{string\}\`\> Map of addresses which were created (used in EIP 6780) #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:51 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:52 *** @@ -129,7 +129,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:35 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:36 *** @@ -139,7 +139,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:52 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:53 *** @@ -149,7 +149,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:36 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:37 *** @@ -159,7 +159,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:34 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:35 *** @@ -169,7 +169,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:58 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:59 *** @@ -179,7 +179,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:40 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:41 *** @@ -189,7 +189,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:39 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:40 *** @@ -199,19 +199,19 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:41 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:42 *** ### selfdestruct? -> `optional` **selfdestruct**: `Set`\<`string`\> +> `optional` **selfdestruct**: `Set`\<\`0x$\{string\}\`\> Set of addresses to selfdestruct. Key is the unprefixed address. #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:47 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:48 *** @@ -221,7 +221,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:31 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:32 *** @@ -231,7 +231,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:32 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:33 ## Accessors @@ -247,4 +247,4 @@ Note: should only be called in instances where `_codeAddress` or `to` is defined #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:68 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/message.d.ts:69 diff --git a/tevm/docs/evm/classes/Evm.md b/tevm/docs/evm/classes/Evm.md index d5915806c0..6f75bd6b3c 100644 --- a/tevm/docs/evm/classes/Evm.md +++ b/tevm/docs/evm/classes/Evm.md @@ -32,19 +32,19 @@ Initialized bn128 WASM object for precompile usage (internal) [`Evm`](Evm.md) +#### Inherited from + +`EVM.constructor` + #### Deprecated The direct usage of this constructor is replaced since non-finalized async initialization lead to side effects. Please use the async EVM.create constructor instead (same API). -#### Inherited from - -`EVM.constructor` - #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:77 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:78 ## Properties @@ -58,7 +58,21 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:27 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:27 + +*** + +### \_bls? + +> `protected` `readonly` `optional` **\_bls**: `EVMBLSInterface` + +#### Inherited from + +`EVM._bls` + +#### Defined in + +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:47 *** @@ -72,7 +86,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:37 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:37 *** @@ -100,7 +114,7 @@ packages/evm/dist/index.d.ts:72 #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:40 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:40 *** @@ -124,7 +138,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:56 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:57 *** @@ -138,7 +152,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:39 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:39 *** @@ -152,7 +166,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:41 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:41 *** @@ -166,7 +180,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:34 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:34 *** @@ -180,7 +194,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:43 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:43 *** @@ -194,7 +208,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:42 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:42 *** @@ -216,7 +230,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:23 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:23 *** @@ -230,7 +244,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:35 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:35 *** @@ -244,7 +258,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:36 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:36 *** @@ -258,7 +272,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:31 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:31 *** @@ -272,7 +286,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:28 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:28 *** @@ -286,7 +300,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:29 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:29 *** @@ -300,7 +314,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:32 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:32 *** @@ -314,7 +328,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:44 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:44 *** @@ -342,7 +356,7 @@ packages/evm/dist/index.d.ts:71 #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:33 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:33 *** @@ -356,7 +370,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:22 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:22 ## Accessors @@ -374,7 +388,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:46 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:46 *** @@ -392,7 +406,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:45 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:45 ## Methods @@ -416,7 +430,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:112 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:113 *** @@ -438,7 +452,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:83 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:84 *** @@ -460,7 +474,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:84 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:85 *** @@ -482,7 +496,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:110 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:111 *** @@ -504,7 +518,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:109 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:110 *** @@ -528,7 +542,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:111 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:112 *** @@ -564,7 +578,7 @@ packages/evm/dist/index.d.ts:73 #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:131 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:132 *** @@ -585,7 +599,7 @@ available for EVM execution #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:82 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:83 *** @@ -611,7 +625,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:127 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:128 *** @@ -636,7 +650,7 @@ if no such precompile exists. #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:104 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:105 *** @@ -680,7 +694,7 @@ if an exception happens during the message execution. #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:94 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:95 *** @@ -705,7 +719,7 @@ shouldn't be used directly from the evm class #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:99 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:100 *** @@ -731,7 +745,7 @@ Starts the actual bytecode processing for a CALL or CREATE #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:88 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:89 *** @@ -759,7 +773,7 @@ Executes a precompiled contract with given data and gas limit. #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:108 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:109 *** @@ -785,7 +799,7 @@ EVM #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:126 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/evm.d.ts:127 *** diff --git a/tevm/docs/evm/classes/EvmError.md b/tevm/docs/evm/classes/EvmError.md index 8473881fe8..61bf15780c 100644 --- a/tevm/docs/evm/classes/EvmError.md +++ b/tevm/docs/evm/classes/EvmError.md @@ -22,7 +22,7 @@ #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:39 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:37 ## Properties @@ -32,7 +32,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:37 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:35 *** @@ -42,4 +42,4 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:38 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:36 diff --git a/tevm/docs/evm/enumerations/EvmErrorMessage.md b/tevm/docs/evm/enumerations/EvmErrorMessage.md index 0a06c31851..070fe9059c 100644 --- a/tevm/docs/evm/enumerations/EvmErrorMessage.md +++ b/tevm/docs/evm/enumerations/EvmErrorMessage.md @@ -8,33 +8,13 @@ ## Enumeration Members -### AUTHCALL\_NONZERO\_VALUEEXT - -> **AUTHCALL\_NONZERO\_VALUEEXT**: `"attempting to execute AUTHCALL with nonzero external value"` - -#### Defined in - -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:26 - -*** - ### AUTHCALL\_UNSET > **AUTHCALL\_UNSET**: `"attempting to AUTHCALL without AUTH set"` #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:25 - -*** - -### AUTH\_INVALID\_S - -> **AUTH\_INVALID\_S**: `"invalid Signature: s-values greater than secp256k1n/2 are considered invalid"` - -#### Defined in - -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:27 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:25 *** @@ -44,7 +24,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:31 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:29 *** @@ -54,7 +34,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:30 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:28 *** @@ -64,7 +44,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:28 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:26 *** @@ -74,7 +54,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:29 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:27 *** @@ -84,7 +64,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:4 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:4 *** @@ -94,7 +74,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:3 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:3 *** @@ -104,7 +84,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:13 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:13 *** @@ -114,7 +94,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:23 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:23 *** @@ -124,7 +104,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:17 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:17 *** @@ -134,7 +114,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:12 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:12 *** @@ -144,7 +124,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:18 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:18 *** @@ -154,7 +134,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:21 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:21 *** @@ -164,7 +144,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:32 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:30 *** @@ -174,7 +154,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:22 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:22 *** @@ -184,7 +164,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:33 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:31 *** @@ -194,7 +174,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:24 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:24 *** @@ -204,7 +184,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:7 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:7 *** @@ -214,7 +194,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:20 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:20 *** @@ -224,7 +204,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:8 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:8 *** @@ -234,7 +214,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:34 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:32 *** @@ -244,7 +224,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:19 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:19 *** @@ -254,7 +234,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:2 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:2 *** @@ -264,7 +244,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:9 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:9 *** @@ -274,7 +254,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:15 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:15 *** @@ -284,7 +264,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:10 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:10 *** @@ -294,7 +274,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:6 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:6 *** @@ -304,7 +284,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:5 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:5 *** @@ -314,7 +294,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:11 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:11 *** @@ -324,7 +304,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:14 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:14 *** @@ -334,4 +314,4 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:16 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/exceptions.d.ts:16 diff --git a/tevm/docs/evm/functions/getActivePrecompiles.md b/tevm/docs/evm/functions/getActivePrecompiles.md index aae2258073..3cfc43d915 100644 --- a/tevm/docs/evm/functions/getActivePrecompiles.md +++ b/tevm/docs/evm/functions/getActivePrecompiles.md @@ -20,4 +20,4 @@ ## Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/precompiles/index.d.ts:37 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/precompiles/index.d.ts:38 diff --git a/tevm/docs/evm/interfaces/EvmResult.md b/tevm/docs/evm/interfaces/EvmResult.md index 7f7b33e936..3cde504334 100644 --- a/tevm/docs/evm/interfaces/EvmResult.md +++ b/tevm/docs/evm/interfaces/EvmResult.md @@ -22,7 +22,7 @@ Address of created account during transaction, if any #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:248 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:273 *** @@ -34,4 +34,4 @@ Contains the results from running the code, if any, as described in runCode #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:252 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:277 diff --git a/tevm/docs/evm/interfaces/EvmRunCallOpts.md b/tevm/docs/evm/interfaces/EvmRunCallOpts.md index c436a34df8..f39c93158f 100644 --- a/tevm/docs/evm/interfaces/EvmRunCallOpts.md +++ b/tevm/docs/evm/interfaces/EvmRunCallOpts.md @@ -16,11 +16,11 @@ Options for running a call (or create) operation with `EVM.runCall()` ### accessWitness? -> `optional` **accessWitness**: `AccessWitness` +> `optional` **accessWitness**: `AccessWitnessInterface` #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:115 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:114 *** @@ -36,7 +36,7 @@ Versioned hashes for each blob in a blob transaction #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:77 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:76 *** @@ -52,7 +52,7 @@ The `block` the `tx` belongs to. If omitted a default blank block will be used. #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:29 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:28 *** @@ -68,7 +68,7 @@ The address that ran this code (`msg.sender`). Defaults to the zero address. #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:41 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:40 *** @@ -84,19 +84,19 @@ The EVM code to run. #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:45 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:44 *** ### createdAddresses? -> `optional` **createdAddresses**: `Set`\<`string`\> +> `optional` **createdAddresses**: `Set`\<\`0x$\{string\}\`\> Created addresses in current context. Used in EIP 6780 #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:97 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:96 *** @@ -112,7 +112,7 @@ The input data. #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:49 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:48 *** @@ -124,7 +124,7 @@ If the call is a DELEGATECALL. Defaults to false. #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:106 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:105 *** @@ -140,7 +140,7 @@ The call depth. Defaults to `0` #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:61 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:60 *** @@ -156,7 +156,7 @@ The gas limit for the call. Defaults to `16777215` (`0xffffff`) #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:53 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:52 *** @@ -172,7 +172,7 @@ The gas price for the call. Defaults to `0` #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:33 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:32 *** @@ -184,7 +184,7 @@ Refund counter. Defaults to `0` #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:110 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:109 *** @@ -196,7 +196,7 @@ If the code location is a precompile. #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:89 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:88 *** @@ -212,7 +212,7 @@ If the call should be executed statically. Defaults to false. #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:65 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:64 *** @@ -224,7 +224,7 @@ Optionally pass in an already-built message. #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:114 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:113 *** @@ -240,7 +240,7 @@ The address where the call originated from. Defaults to the zero address. #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:37 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:36 *** @@ -252,13 +252,13 @@ An optional salt to pass to CREATE2. #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:93 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:92 *** ### selfdestruct? -> `optional` **selfdestruct**: `Set`\<`string`\> +> `optional` **selfdestruct**: `Set`\<\`0x$\{string\}\`\> Addresses to selfdestruct. Defaults to the empty set. @@ -268,7 +268,7 @@ Addresses to selfdestruct. Defaults to the empty set. #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:69 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:68 *** @@ -281,7 +281,7 @@ sets balance to message value to ensure execution doesn't fail. #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:102 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:101 *** @@ -297,7 +297,7 @@ The address of the account that is executing this code (`address(this)`). Defaul #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:73 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:72 *** @@ -313,4 +313,4 @@ The value in ether that is being sent to `opts.address`. Defaults to `0` #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:57 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:56 diff --git a/tevm/docs/evm/interfaces/ExecResult.md b/tevm/docs/evm/interfaces/ExecResult.md index 820fe09033..5b2eb022c0 100644 --- a/tevm/docs/evm/interfaces/ExecResult.md +++ b/tevm/docs/evm/interfaces/ExecResult.md @@ -18,19 +18,19 @@ Amount of blob gas consumed by the transaction #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:294 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:319 *** ### createdAddresses? -> `optional` **createdAddresses**: `Set`\<`string`\> +> `optional` **createdAddresses**: `Set`\<\`0x$\{string\}\`\> Map of addresses which were created (used in EIP 6780) #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:286 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:311 *** @@ -42,7 +42,7 @@ Description of the exception, if any occurred #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:262 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:287 *** @@ -54,7 +54,7 @@ Amount of gas the code used to run #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:270 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:295 *** @@ -66,7 +66,7 @@ Amount of gas left #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:266 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:291 *** @@ -78,7 +78,7 @@ The gas refund counter #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:290 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:315 *** @@ -90,7 +90,7 @@ Array of logs that the contract emitted #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:278 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:303 *** @@ -102,7 +102,7 @@ Return value from the contract #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:274 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:299 *** @@ -112,16 +112,16 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:258 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:283 *** ### selfdestruct? -> `optional` **selfdestruct**: `Set`\<`string`\> +> `optional` **selfdestruct**: `Set`\<\`0x$\{string\}\`\> A set of accounts to selfdestruct #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:282 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:307 diff --git a/tevm/docs/evm/interfaces/InterpreterStep.md b/tevm/docs/evm/interfaces/InterpreterStep.md index 0a7cb4fef1..1cc60f09cd 100644 --- a/tevm/docs/evm/interfaces/InterpreterStep.md +++ b/tevm/docs/evm/interfaces/InterpreterStep.md @@ -14,7 +14,7 @@ #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/interpreter.d.ts:94 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/interpreter.d.ts:91 *** @@ -24,7 +24,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/interpreter.d.ts:95 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/interpreter.d.ts:92 *** @@ -34,7 +34,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/interpreter.d.ts:98 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/interpreter.d.ts:95 *** @@ -44,7 +44,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/interpreter.d.ts:87 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/interpreter.d.ts:84 *** @@ -54,7 +54,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/interpreter.d.ts:81 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/interpreter.d.ts:79 *** @@ -64,7 +64,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/interpreter.d.ts:82 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/interpreter.d.ts:80 *** @@ -74,7 +74,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/interpreter.d.ts:96 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/interpreter.d.ts:93 *** @@ -84,7 +84,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/interpreter.d.ts:97 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/interpreter.d.ts:94 *** @@ -110,7 +110,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/interpreter.d.ts:88 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/interpreter.d.ts:85 *** @@ -120,17 +120,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/interpreter.d.ts:86 - -*** - -### returnStack - -> **returnStack**: `bigint`[] - -#### Defined in - -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/interpreter.d.ts:85 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/interpreter.d.ts:83 *** @@ -140,7 +130,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/interpreter.d.ts:84 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/interpreter.d.ts:82 *** @@ -150,4 +140,4 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/interpreter.d.ts:83 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/interpreter.d.ts:81 diff --git a/tevm/docs/evm/interfaces/PrecompileInput.md b/tevm/docs/evm/interfaces/PrecompileInput.md index 3ce838ed65..6a00cc69b8 100644 --- a/tevm/docs/evm/interfaces/PrecompileInput.md +++ b/tevm/docs/evm/interfaces/PrecompileInput.md @@ -14,7 +14,7 @@ #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/precompiles/types.d.ts:11 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/precompiles/types.d.ts:11 *** @@ -24,7 +24,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/precompiles/types.d.ts:12 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/precompiles/types.d.ts:12 *** @@ -34,7 +34,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/precompiles/types.d.ts:10 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/precompiles/types.d.ts:10 *** @@ -44,7 +44,7 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/precompiles/types.d.ts:8 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/precompiles/types.d.ts:8 *** @@ -54,4 +54,4 @@ node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/precompiles/types.d.ts:9 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/precompiles/types.d.ts:9 diff --git a/tevm/docs/evm/type-aliases/CreateEvmOptions.md b/tevm/docs/evm/type-aliases/CreateEvmOptions.md index b30fceb4e5..260e5d087a 100644 --- a/tevm/docs/evm/type-aliases/CreateEvmOptions.md +++ b/tevm/docs/evm/type-aliases/CreateEvmOptions.md @@ -10,6 +10,37 @@ Options for [createEvm](https://tevm.sh/reference/tevm/evm/functions/createevm/) +## Example + +```typescript +import { createEvm, CreateEvmOptions } from 'tevm/evm' +import { mainnet } from 'tevm/common' +import { createStateManager } from 'tevm/state' +import { createBlockchain } from 'tevm/blockchain'} +import { EthjsAddress } from 'tevm/utils' + +const evm = createEvm({ + common: mainnet.copy(), + stateManager: createStateManager(), + blockchain: createBlockchain(), +}) + +const result = await evm.runCall({ + to: EthjsAddress.fromString(`0x${'0'.repeat(40)}`), + value: 420n, + skipBalance: true, +}) + +console.log(result) +``` +The EVM is normally encapsolated by both `@tevm/vm` Vm, TevmNode, and MemoryClient. + +## See + + - [MemoryClient](https://tevm.sh/reference/tevm/memory-client/type-aliases/memoryclient/) + - [TevmNode](https://tevm.sh/reference/tevm/node/functions/createbaseclient/) + - [Vm](https://tevm.sh/reference/tevm/vm/functions/createvm/) + ## Type declaration ### allowUnlimitedContractSize? @@ -117,37 +148,6 @@ Enable profiler. Defaults to false. A custom Tevm state manager -## Example - -```typescript -import { createEvm, CreateEvmOptions } from 'tevm/evm' -import { mainnet } from 'tevm/common' -import { createStateManager } from 'tevm/state' -import { createBlockchain } from 'tevm/blockchain'} -import { EthjsAddress } from 'tevm/utils' - -const evm = createEvm({ - common: mainnet.copy(), - stateManager: createStateManager(), - blockchain: createBlockchain(), -}) - -const result = await evm.runCall({ - to: EthjsAddress.fromString(`0x${'0'.repeat(40)}`), - value: 420n, - skipBalance: true, -}) - -console.log(result) -``` -The EVM is normally encapsolated by both `@tevm/vm` Vm, TevmNode, and MemoryClient. - -## See - - - [MemoryClient](https://tevm.sh/reference/tevm/memory-client/type-aliases/memoryclient/) - - [TevmNode](https://tevm.sh/reference/tevm/node/functions/createbaseclient/) - - [Vm](https://tevm.sh/reference/tevm/vm/functions/createvm/) - ## Defined in packages/evm/dist/index.d.ts:107 diff --git a/tevm/docs/evm/variables/Eof.md b/tevm/docs/evm/variables/Eof.md index 62160ab379..b3c8272a0b 100644 --- a/tevm/docs/evm/variables/Eof.md +++ b/tevm/docs/evm/variables/Eof.md @@ -48,4 +48,4 @@ ## Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/eof.d.ts:18 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/eof.d.ts:18 diff --git a/tevm/docs/http-client/type-aliases/HttpClient.md b/tevm/docs/http-client/type-aliases/HttpClient.md index ab79171adc..c9b0b4aa08 100644 --- a/tevm/docs/http-client/type-aliases/HttpClient.md +++ b/tevm/docs/http-client/type-aliases/HttpClient.md @@ -8,6 +8,10 @@ > **HttpClient**: [`TevmClient`](../../index/type-aliases/TevmClient.md) & `object` +## Deprecated + +a new http client will be created in a future version. For now it's recomended to use viem + ## Type declaration ### ~~name~~ @@ -22,10 +26,6 @@ Name of the client The url being used to connect to the remote Tevm backend -## Deprecated - -a new http client will be created in a future version. For now it's recomended to use viem - ## Defined in packages/http-client/types/HttpClient.d.ts:5 diff --git a/tevm/docs/http-client/type-aliases/HttpClientOptions.md b/tevm/docs/http-client/type-aliases/HttpClientOptions.md index f89017d4f0..b38913b03f 100644 --- a/tevm/docs/http-client/type-aliases/HttpClientOptions.md +++ b/tevm/docs/http-client/type-aliases/HttpClientOptions.md @@ -8,6 +8,10 @@ > **HttpClientOptions**: `object` +## Deprecated + +Options for a HttpClient + ## Type declaration ### ~~name?~~ @@ -22,10 +26,6 @@ Optional name for the client Remote URL to connect to -## Deprecated - -Options for a HttpClient - ## Defined in packages/http-client/types/HttpClientOptions.d.ts:5 diff --git a/tevm/docs/index/README.md b/tevm/docs/index/README.md index 541387e0dc..134c330f70 100644 --- a/tevm/docs/index/README.md +++ b/tevm/docs/index/README.md @@ -43,11 +43,9 @@ - [CreateEventFilterParameters](type-aliases/CreateEventFilterParameters.md) - [CreateMemoryClientFn](type-aliases/CreateMemoryClientFn.md) - [CreateMemoryDbFn](type-aliases/CreateMemoryDbFn.md) -- [CreateScript](type-aliases/CreateScript.md) - [CreateSyncStoragePersisterOptions](type-aliases/CreateSyncStoragePersisterOptions.md) - [CustomPrecompile](type-aliases/CustomPrecompile.md) - [DecodeFunctionResultReturnType](type-aliases/DecodeFunctionResultReturnType.md) -- [DeployArgs](type-aliases/DeployArgs.md) - [DeployParams](type-aliases/DeployParams.md) - [DeployResult](type-aliases/DeployResult.md) - [DumpStateResult](type-aliases/DumpStateResult.md) diff --git a/tevm/docs/index/classes/ProviderRpcError.md b/tevm/docs/index/classes/ProviderRpcError.md index a06db2d5d1..e710f0a6fd 100644 --- a/tevm/docs/index/classes/ProviderRpcError.md +++ b/tevm/docs/index/classes/ProviderRpcError.md @@ -32,7 +32,7 @@ #### Defined in -packages/node/dist/index.d.ts:28 +packages/node/dist/index.d.ts:30 ## Properties @@ -56,7 +56,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es2022.err #### Defined in -packages/node/dist/index.d.ts:26 +packages/node/dist/index.d.ts:28 *** @@ -66,7 +66,7 @@ packages/node/dist/index.d.ts:26 #### Defined in -packages/node/dist/index.d.ts:27 +packages/node/dist/index.d.ts:29 *** @@ -118,6 +118,10 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -128,10 +132,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from `Error.prepareStackTrace` @@ -204,4 +204,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +`Error.captureStackTrace` + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/index/functions/boolToBytes.md b/tevm/docs/index/functions/boolToBytes.md index ff64953bc9..64a6860626 100644 --- a/tevm/docs/index/functions/boolToBytes.md +++ b/tevm/docs/index/functions/boolToBytes.md @@ -44,4 +44,4 @@ const data = boolToBytes(true, { size: 32 }) ## Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/encoding/toBytes.d.ts:62 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/encoding/toBytes.d.ts:62 diff --git a/tevm/docs/index/functions/boolToHex.md b/tevm/docs/index/functions/boolToHex.md index c46b4262f5..381a342bb6 100644 --- a/tevm/docs/index/functions/boolToHex.md +++ b/tevm/docs/index/functions/boolToHex.md @@ -50,4 +50,4 @@ const data = boolToHex(true, { size: 32 }) ## Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/encoding/toHex.d.ts:66 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/encoding/toHex.d.ts:66 diff --git a/tevm/docs/index/functions/bytesToBigint.md b/tevm/docs/index/functions/bytesToBigint.md index 041882a633..cc42871eb1 100644 --- a/tevm/docs/index/functions/bytesToBigint.md +++ b/tevm/docs/index/functions/bytesToBigint.md @@ -38,4 +38,4 @@ const data = bytesToBigInt(new Uint8Array([1, 164])) ## Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/encoding/fromBytes.d.ts:59 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/encoding/fromBytes.d.ts:59 diff --git a/tevm/docs/index/functions/bytesToBool.md b/tevm/docs/index/functions/bytesToBool.md index 5367a6a189..0613b99191 100644 --- a/tevm/docs/index/functions/bytesToBool.md +++ b/tevm/docs/index/functions/bytesToBool.md @@ -36,4 +36,4 @@ const data = bytesToBool(new Uint8Array([1])) ## Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/encoding/fromBytes.d.ts:79 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/encoding/fromBytes.d.ts:79 diff --git a/tevm/docs/index/functions/bytesToHex.md b/tevm/docs/index/functions/bytesToHex.md index 3a3ec96ed0..105be89f6f 100644 --- a/tevm/docs/index/functions/bytesToHex.md +++ b/tevm/docs/index/functions/bytesToHex.md @@ -44,4 +44,4 @@ const data = bytesToHex(Uint8Array.from([72, 101, 108, 108, 111, 32, 87, 111, 11 ## Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/encoding/toHex.d.ts:91 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/encoding/toHex.d.ts:91 diff --git a/tevm/docs/index/functions/bytesToNumber.md b/tevm/docs/index/functions/bytesToNumber.md index 5bb6c335af..d25c4d0e8a 100644 --- a/tevm/docs/index/functions/bytesToNumber.md +++ b/tevm/docs/index/functions/bytesToNumber.md @@ -38,4 +38,4 @@ const data = bytesToNumber(new Uint8Array([1, 164])) ## Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/encoding/fromBytes.d.ts:96 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/encoding/fromBytes.d.ts:96 diff --git a/tevm/docs/index/functions/createAddress.md b/tevm/docs/index/functions/createAddress.md index 3064811163..1fec6625d7 100644 --- a/tevm/docs/index/functions/createAddress.md +++ b/tevm/docs/index/functions/createAddress.md @@ -10,7 +10,7 @@ ## Parameters -• **address**: `number` \| `bigint` \| [`AddressLike`](../../utils/type-aliases/AddressLike.md) +• **address**: `string` \| `number` \| `bigint` \| [`EthjsAddress`](../../utils/classes/EthjsAddress.md) \| `Uint8Array` ## Returns diff --git a/tevm/docs/index/functions/createClient.md b/tevm/docs/index/functions/createClient.md index 19961adecc..e38163b34d 100644 --- a/tevm/docs/index/functions/createClient.md +++ b/tevm/docs/index/functions/createClient.md @@ -6,7 +6,7 @@ # Function: createClient() -> **createClient**\<`transport`, `chain`, `accountOrAddress`, `rpcSchema`\>(`parameters`): `Prettify`\<`Client`\<`transport`, `chain`, `accountOrAddress` *extends* [`Address`](../type-aliases/Address.md) ? `Prettify`\<`JsonRpcAccount`\<`accountOrAddress`\>\> : `accountOrAddress`, `rpcSchema`\>\> +> **createClient**\<`transport`, `chain`, `accountOrAddress`, `rpcSchema`\>(`parameters`): `Prettify`\<`Client`\<`transport`, `chain`, `accountOrAddress` *extends* `Address` ? `Prettify`\<`JsonRpcAccount`\<`accountOrAddress`\>\> : `accountOrAddress`, `rpcSchema`\>\> ## Type Parameters @@ -14,7 +14,7 @@ • **chain** *extends* `undefined` \| `Chain` = `undefined` -• **accountOrAddress** *extends* `undefined` \| \`0x$\{string\}\` \| `Account` = `undefined` +• **accountOrAddress** *extends* `undefined` \| \`0x$\{string\}\` \| [`Account`](../type-aliases/Account.md) = `undefined` • **rpcSchema** *extends* `undefined` \| `RpcSchema` = `undefined` @@ -24,8 +24,8 @@ ## Returns -`Prettify`\<`Client`\<`transport`, `chain`, `accountOrAddress` *extends* [`Address`](../type-aliases/Address.md) ? `Prettify`\<`JsonRpcAccount`\<`accountOrAddress`\>\> : `accountOrAddress`, `rpcSchema`\>\> +`Prettify`\<`Client`\<`transport`, `chain`, `accountOrAddress` *extends* `Address` ? `Prettify`\<`JsonRpcAccount`\<`accountOrAddress`\>\> : `accountOrAddress`, `rpcSchema`\>\> ## Defined in -node\_modules/.pnpm/viem@2.16.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/clients/createClient.d.ts:99 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/clients/createClient.d.ts:99 diff --git a/tevm/docs/index/functions/createContract.md b/tevm/docs/index/functions/createContract.md index 635179f7e4..aa5fee9cbb 100644 --- a/tevm/docs/index/functions/createContract.md +++ b/tevm/docs/index/functions/createContract.md @@ -8,7 +8,9 @@ > **createContract**\<`TName`, `TAbi`, `TAddress`, `TBytecode`, `TDeployedBytecode`, `TCode`, `THumanReadableAbi`\>(`__namedParameters`): [`Contract`](../type-aliases/Contract.md)\<`TName`, `THumanReadableAbi`, `TAddress`, `TBytecode`, `TDeployedBytecode`, `TCode`\> -Creates a tevm Contract instance from human readable abi +Creates a Tevm Contract instance from a human-readable ABI or JSON ABI. +This function is the core of Tevm's contract interaction capabilities, +allowing for type-safe and easy-to-use contract interfaces. ## Type Parameters @@ -34,32 +36,6 @@ Creates a tevm Contract instance from human readable abi [`Contract`](../type-aliases/Contract.md)\<`TName`, `THumanReadableAbi`, `TAddress`, `TBytecode`, `TDeployedBytecode`, `TCode`\> -## Examples - -```typescript -import { type Contract, createContract} from 'tevm/contract' - -const contract: Contract = createContract({ - name: 'MyContract', - abi: [ - ... - ], -}) -``` - -To use a json abi first pass it into `formatAbi` to turn it into human readable - -```typescript -import { type Contract, createContract} from 'tevm/contract' - -const contract = createContract({ - name: 'MyContract', - abi: [ - ... - ], -}) -``` - ## Defined in -packages/contract/types/createContract.d.ts:29 +packages/contract/types/createContract.d.ts:67 diff --git a/tevm/docs/index/functions/createMemoryClient.md b/tevm/docs/index/functions/createMemoryClient.md index c478074985..aea88850e5 100644 --- a/tevm/docs/index/functions/createMemoryClient.md +++ b/tevm/docs/index/functions/createMemoryClient.md @@ -13,9 +13,9 @@ It comes batteries included with all wallet, test, public, and tevm actions. ## Type Parameters -• **TCommon** *extends* `Chain` & `object` = `Chain` & `object` +• **TCommon** *extends* `object` & `object` & `ChainConfig`\<`undefined` \| `ChainFormatters`, `undefined` \| `Record`\<`string`, `unknown`\>\> = `object` & `object` & `ChainConfig`\<`undefined` \| `ChainFormatters`, `undefined` \| `Record`\<`string`, `unknown`\>\> -• **TAccountOrAddress** *extends* `undefined` \| \`0x$\{string\}\` \| `Account` = `undefined` +• **TAccountOrAddress** *extends* `undefined` \| \`0x$\{string\}\` \| [`Account`](../type-aliases/Account.md) = `undefined` • **TRpcSchema** *extends* `undefined` \| `RpcSchema` = [`object`, `object`, `object`, `object`, `object`] @@ -29,7 +29,7 @@ It comes batteries included with all wallet, test, public, and tevm actions. ### account -> **account**: `TAccountOrAddress` *extends* `Account` ? `Account` : `undefined` +> **account**: `TAccountOrAddress` *extends* [`Account`](../type-aliases/Account.md) ? [`Account`](../type-aliases/Account.md) : `undefined` The Account of the Client. @@ -42,16 +42,6 @@ Adds an EVM chain to the wallet. - Docs: https://viem.sh/docs/actions/wallet/addChain - JSON-RPC Methods: [`eth_addEthereumChain`](https://eips.ethereum.org/EIPS/eip-3085) -#### Parameters - -• **args**: `AddChainParameters` - -AddChainParameters - -#### Returns - -`Promise`\<`void`\> - #### Example ```ts @@ -64,6 +54,16 @@ const client = createWalletClient({ await client.addChain({ chain: optimism }) ``` +#### Parameters + +• **args**: `AddChainParameters` + +AddChainParameters + +#### Returns + +`Promise`\<`void`\> + ### batch? > `optional` **batch**: `object` @@ -132,63 +132,63 @@ Filter. CreateBlockFilterReturnType ### createContractEventFilter() -> **createContractEventFilter**: \<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>(`args`) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> +> **createContractEventFilter**: \<`abi`, `eventName`, `args`, `strict`, `fromBlock`, `toBlock`\>(`args`) => `Promise`\<`CreateContractEventFilterReturnType`\<`abi`, `eventName`, `args`, `strict`, `fromBlock`, `toBlock`\>\> #### Type Parameters -• **TAbi** *extends* [`Abi`](../type-aliases/Abi.md) \| readonly `unknown`[] +• **abi** *extends* `Abi` \| readonly `unknown`[] -• **TEventName** *extends* `undefined` \| `string` +• **eventName** *extends* `undefined` \| `string` -• **TArgs** *extends* `undefined` \| readonly `unknown`[] \| `Record`\<`string`, `unknown`\> +• **args** *extends* `undefined` \| readonly `unknown`[] \| `Record`\<`string`, `unknown`\> -• **TStrict** *extends* `undefined` \| `boolean` = `undefined` +• **strict** *extends* `undefined` \| `boolean` = `undefined` -• **TFromBlock** *extends* `undefined` \| `bigint` \| `BlockTag` = `undefined` +• **fromBlock** *extends* `undefined` \| `bigint` \| [`BlockTag`](../type-aliases/BlockTag.md) = `undefined` -• **TToBlock** *extends* `undefined` \| `bigint` \| `BlockTag` = `undefined` +• **toBlock** *extends* `undefined` \| `bigint` \| [`BlockTag`](../type-aliases/BlockTag.md) = `undefined` #### Parameters -• **args**: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\> +• **args**: `CreateContractEventFilterParameters`\<`abi`, `eventName`, `args`, `strict`, `fromBlock`, `toBlock`\> CreateContractEventFilterParameters #### Returns -`Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>\> +`Promise`\<`CreateContractEventFilterReturnType`\<`abi`, `eventName`, `args`, `strict`, `fromBlock`, `toBlock`\>\> [`Filter`](https://viem.sh/docs/glossary/types#filter). CreateContractEventFilterReturnType ### createEventFilter() -> **createEventFilter**: \<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>(`args`?) => `Promise`\<\{ \[K in string \| number \| symbol\]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>\[K\] \}\> +> **createEventFilter**: \<`abiEvent`, `abiEvents`, `strict`, `fromBlock`, `toBlock`, `_EventName`, `_Args`\>(`args`?) => `Promise`\<\{ \[K in string \| number \| symbol\]: EthjsFilter\<"event", abiEvents, \_EventName, \_Args, strict, fromBlock, toBlock\>\[K\] \}\> #### Type Parameters -• **TAbiEvent** *extends* `undefined` \| [`AbiEvent`](../type-aliases/AbiEvent.md) = `undefined` +• **abiEvent** *extends* `undefined` \| `AbiEvent` = `undefined` -• **TAbiEvents** *extends* `undefined` \| readonly `unknown`[] \| readonly [`AbiEvent`](../type-aliases/AbiEvent.md)[] = `TAbiEvent` *extends* [`AbiEvent`](../type-aliases/AbiEvent.md) ? [`TAbiEvent`\<`TAbiEvent`\>] : `undefined` +• **abiEvents** *extends* `undefined` \| readonly `unknown`[] \| readonly `AbiEvent`[] = `abiEvent` *extends* `AbiEvent` ? [`abiEvent`\<`abiEvent`\>] : `undefined` -• **TStrict** *extends* `undefined` \| `boolean` = `undefined` +• **strict** *extends* `undefined` \| `boolean` = `undefined` -• **TFromBlock** *extends* `undefined` \| `bigint` \| `BlockTag` = `undefined` +• **fromBlock** *extends* `undefined` \| `bigint` \| [`BlockTag`](../type-aliases/BlockTag.md) = `undefined` -• **TToBlock** *extends* `undefined` \| `bigint` \| `BlockTag` = `undefined` +• **toBlock** *extends* `undefined` \| `bigint` \| [`BlockTag`](../type-aliases/BlockTag.md) = `undefined` -• **_EventName** *extends* `undefined` \| `string` = `MaybeAbiEventName`\<`TAbiEvent`\> +• **_EventName** *extends* `undefined` \| `string` = `MaybeAbiEventName`\<`abiEvent`\> • **_Args** *extends* `undefined` \| readonly `unknown`[] \| `Record`\<`string`, `unknown`\> = `undefined` #### Parameters -• **args?**: `CreateEventFilterParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\> +• **args?**: [`CreateEventFilterParameters`](../type-aliases/CreateEventFilterParameters.md)\<`abiEvent`, `abiEvents`, `strict`, `fromBlock`, `toBlock`, `_EventName`, `_Args`\> [CreateEventFilterParameters](../type-aliases/CreateEventFilterParameters.md) #### Returns -`Promise`\<\{ \[K in string \| number \| symbol\]: Filter\<"event", TAbiEvents, \_EventName, \_Args, TStrict, TFromBlock, TToBlock\>\[K\] \}\> +`Promise`\<\{ \[K in string \| number \| symbol\]: EthjsFilter\<"event", abiEvents, \_EventName, \_Args, strict, fromBlock, toBlock\>\[K\] \}\> [`Filter`](https://viem.sh/docs/glossary/types#filter). CreateEventFilterReturnType @@ -220,13 +220,13 @@ CreateContractEventFilterParameters #### Type Parameters -• **abi** *extends* [`Abi`](../type-aliases/Abi.md) \| readonly `unknown`[] +• **abi** *extends* `Abi` \| readonly `unknown`[] • **chainOverride** *extends* `undefined` \| `Chain` #### Parameters -• **args**: `DeployContractParameters`\<`abi`, `TCommon`, `TAccountOrAddress` *extends* `Account` ? `Account` : `undefined`, `chainOverride`\> +• **args**: `DeployContractParameters`\<`abi`, `TCommon`, `TAccountOrAddress` *extends* [`Account`](../type-aliases/Account.md) ? [`Account`](../type-aliases/Account.md) : `undefined`, `chainOverride`\> DeployContractParameters @@ -244,16 +244,6 @@ Removes a transaction from the mempool. - Docs: https://viem.sh/docs/actions/test/dropTransaction -#### Parameters - -• **args**: `DropTransactionParameters` - -DropTransactionParameters - -#### Returns - -`Promise`\<`void`\> - #### Example ```ts @@ -270,6 +260,16 @@ await client.dropTransaction({ }) ``` +#### Parameters + +• **args**: `DropTransactionParameters` + +DropTransactionParameters + +#### Returns + +`Promise`\<`void`\> + ### dumpState() > **dumpState**: () => `Promise`\<\`0x$\{string\}\`\> @@ -279,10 +279,6 @@ accounts properties, etc.) into a savable data blob. - Docs: https://viem.sh/docs/actions/test/dumpState -#### Returns - -`Promise`\<\`0x$\{string\}\`\> - #### Example ```ts @@ -297,15 +293,19 @@ const client = createTestClient({ await client.dumpState() ``` +#### Returns + +`Promise`\<\`0x$\{string\}\`\> + ### estimateContractGas() -> **estimateContractGas**: \<`TChain`, `abi`, `functionName`, `args`\>(`args`) => `Promise`\<`bigint`\> +> **estimateContractGas**: \<`chain`, `abi`, `functionName`, `args`\>(`args`) => `Promise`\<`bigint`\> #### Type Parameters -• **TChain** *extends* `undefined` \| `Chain` +• **chain** *extends* `undefined` \| `Chain` -• **abi** *extends* [`Abi`](../type-aliases/Abi.md) \| readonly `unknown`[] +• **abi** *extends* `Abi` \| readonly `unknown`[] • **functionName** *extends* `string` @@ -313,7 +313,7 @@ await client.dumpState() #### Parameters -• **args**: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`\> +• **args**: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `chain`\> EstimateContractGasParameters @@ -325,21 +325,21 @@ The gas estimate (in wei). EstimateContractGasReturnType ### estimateFeesPerGas() -> **estimateFeesPerGas**: \<`TChainOverride`, `TType`\>(`args`?) => `Promise`\<`EstimateFeesPerGasReturnType`\> +> **estimateFeesPerGas**: \<`chainOverride`, `type`\>(`args`?) => `Promise`\<`EstimateFeesPerGasReturnType`\<`type`\>\> #### Type Parameters -• **TChainOverride** *extends* `undefined` \| `Chain` = `undefined` +• **chainOverride** *extends* `undefined` \| `Chain` = `undefined` -• **TType** *extends* `FeeValuesType` = `"eip1559"` +• **type** *extends* `FeeValuesType` = `"eip1559"` #### Parameters -• **args?**: `EstimateFeesPerGasParameters`\<`TCommon`, `TChainOverride`, `TType`\> +• **args?**: `EstimateFeesPerGasParameters`\<`TCommon`, `chainOverride`, `type`\> #### Returns -`Promise`\<`EstimateFeesPerGasReturnType`\> +`Promise`\<`EstimateFeesPerGasReturnType`\<`type`\>\> An estimate (in wei) for the fees per gas. EstimateFeesPerGasReturnType @@ -361,15 +361,15 @@ The gas estimate (in wei). EstimateGasReturnType ### estimateMaxPriorityFeePerGas() -> **estimateMaxPriorityFeePerGas**: \<`TChainOverride`\>(`args`?) => `Promise`\<`bigint`\> +> **estimateMaxPriorityFeePerGas**: \<`chainOverride`\>(`args`?) => `Promise`\<`bigint`\> #### Type Parameters -• **TChainOverride** *extends* `undefined` \| `Chain` = `undefined` +• **chainOverride** *extends* `undefined` \| `Chain` = `undefined` #### Parameters -• **args?**: `GetChainParameter`\<`TCommon`, `TChainOverride`\> +• **args?**: `GetChainParameter`\<`TCommon`, `chainOverride`\> #### Returns @@ -379,11 +379,11 @@ An estimate (in wei) for the max priority fee per gas. EstimateMaxPriorityFeePer ### extend() -> **extend**: \<`client`\>(`fn`) => `Client`\<[`TevmTransport`](../type-aliases/TevmTransport.md), `TCommon`, `TAccountOrAddress` *extends* `Account` ? `Account` : `undefined`, [`object`, `object`, `object`, `object`, `object`], \{ \[K in string \| number \| symbol\]: client\[K\] \} & [`TevmActions`](../type-aliases/TevmActions.md) & `PublicActions`\<[`TevmTransport`](../type-aliases/TevmTransport.md), `TCommon`, `TAccountOrAddress` *extends* `Account` ? `Account` : `undefined`\> & `WalletActions`\<`TCommon`, `TAccountOrAddress` *extends* `Account` ? `Account` : `undefined`\> & `TestActions`\> +> **extend**: \<`client`\>(`fn`) => `Client`\<[`TevmTransport`](../type-aliases/TevmTransport.md), `TCommon`, `TAccountOrAddress` *extends* [`Account`](../type-aliases/Account.md) ? [`Account`](../type-aliases/Account.md) : `undefined`, [`object`, `object`, `object`, `object`, `object`], \{ \[K in string \| number \| symbol\]: client\[K\] \} & [`TevmActions`](../type-aliases/TevmActions.md) & `PublicActions`\<[`TevmTransport`](../type-aliases/TevmTransport.md), `TCommon`, `TAccountOrAddress` *extends* [`Account`](../type-aliases/Account.md) ? [`Account`](../type-aliases/Account.md) : `undefined`\> & `WalletActions`\<`TCommon`, `TAccountOrAddress` *extends* [`Account`](../type-aliases/Account.md) ? [`Account`](../type-aliases/Account.md) : `undefined`\> & `TestActions`\> #### Type Parameters -• **client** *extends* `object` & `ExactPartial`\<`ExtendableProtectedActions`\<[`TevmTransport`](../type-aliases/TevmTransport.md), `TCommon`, `TAccountOrAddress` *extends* `Account` ? `Account` : `undefined`\>\> +• **client** *extends* `object` & `ExactPartial`\<`ExtendableProtectedActions`\<[`TevmTransport`](../type-aliases/TevmTransport.md), `TCommon`, `TAccountOrAddress` *extends* [`Account`](../type-aliases/Account.md) ? [`Account`](../type-aliases/Account.md) : `undefined`\>\> #### Parameters @@ -391,7 +391,7 @@ An estimate (in wei) for the max priority fee per gas. EstimateMaxPriorityFeePer #### Returns -`Client`\<[`TevmTransport`](../type-aliases/TevmTransport.md), `TCommon`, `TAccountOrAddress` *extends* `Account` ? `Account` : `undefined`, [`object`, `object`, `object`, `object`, `object`], \{ \[K in string \| number \| symbol\]: client\[K\] \} & [`TevmActions`](../type-aliases/TevmActions.md) & `PublicActions`\<[`TevmTransport`](../type-aliases/TevmTransport.md), `TCommon`, `TAccountOrAddress` *extends* `Account` ? `Account` : `undefined`\> & `WalletActions`\<`TCommon`, `TAccountOrAddress` *extends* `Account` ? `Account` : `undefined`\> & `TestActions`\> +`Client`\<[`TevmTransport`](../type-aliases/TevmTransport.md), `TCommon`, `TAccountOrAddress` *extends* [`Account`](../type-aliases/Account.md) ? [`Account`](../type-aliases/Account.md) : `undefined`, [`object`, `object`, `object`, `object`, `object`], \{ \[K in string \| number \| symbol\]: client\[K\] \} & [`TevmActions`](../type-aliases/TevmActions.md) & `PublicActions`\<[`TevmTransport`](../type-aliases/TevmTransport.md), `TCommon`, `TAccountOrAddress` *extends* [`Account`](../type-aliases/Account.md) ? [`Account`](../type-aliases/Account.md) : `undefined`\> & `WalletActions`\<`TCommon`, `TAccountOrAddress` *extends* [`Account`](../type-aliases/Account.md) ? [`Account`](../type-aliases/Account.md) : `undefined`\> & `TestActions`\> ### getAddresses() @@ -441,23 +441,23 @@ The blob base fee (in wei). GetBlobBaseFeeReturnType ### getBlock() -> **getBlock**: \<`TIncludeTransactions`, `TBlockTag`\>(`args`?) => `Promise`\<\{ \[K in string \| number \| symbol\]: FormattedBlock\\[K\] \}\> +> **getBlock**: \<`includeTransactions`, `blockTag`\>(`args`?) => `Promise`\<\{ \[K in string \| number \| symbol\]: FormattedBlock\\[K\] \}\> #### Type Parameters -• **TIncludeTransactions** *extends* `boolean` = `false` +• **includeTransactions** *extends* `boolean` = `false` -• **TBlockTag** *extends* `BlockTag` = `"latest"` +• **blockTag** *extends* [`BlockTag`](../type-aliases/BlockTag.md) = `"latest"` #### Parameters -• **args?**: `GetBlockParameters`\<`TIncludeTransactions`, `TBlockTag`\> +• **args?**: `GetBlockParameters`\<`includeTransactions`, `blockTag`\> GetBlockParameters #### Returns -`Promise`\<\{ \[K in string \| number \| symbol\]: FormattedBlock\\[K\] \}\> +`Promise`\<\{ \[K in string \| number \| symbol\]: FormattedBlock\\[K\] \}\> Information about the block. GetBlockReturnType @@ -497,6 +497,10 @@ The block transaction count. GetBlockTransactionCountReturnType > **getBytecode**: (`args`) => `Promise`\<`GetCodeReturnType`\> +#### Deprecated + +Use `getCode` instead. + #### Parameters • **args**: `GetCodeParameters` @@ -505,10 +509,6 @@ The block transaction count. GetBlockTransactionCountReturnType `Promise`\<`GetCodeReturnType`\> -#### Deprecated - -Use `getCode` instead. - ### getChainId > **getChainId**: () => `Promise`\<`number`\> & () => `Promise`\<`number`\> @@ -554,15 +554,15 @@ The contract's bytecode. GetBytecodeReturnType #### Type Parameters -• **abi** *extends* [`Abi`](../type-aliases/Abi.md) \| readonly `unknown`[] +• **abi** *extends* `Abi` \| readonly `unknown`[] • **eventName** *extends* `undefined` \| `string` = `undefined` • **strict** *extends* `undefined` \| `boolean` = `undefined` -• **fromBlock** *extends* `undefined` \| `bigint` \| `BlockTag` = `undefined` +• **fromBlock** *extends* `undefined` \| `bigint` \| [`BlockTag`](../type-aliases/BlockTag.md) = `undefined` -• **toBlock** *extends* `undefined` \| `bigint` \| `BlockTag` = `undefined` +• **toBlock** *extends* `undefined` \| `bigint` \| [`BlockTag`](../type-aliases/BlockTag.md) = `undefined` #### Parameters @@ -602,7 +602,7 @@ GetEnsAddressParameters The balance of the account at a block number. -• **args.blockTag?**: `BlockTag` +• **args.blockTag?**: [`BlockTag`](../type-aliases/BlockTag.md) The balance of the account at a block tag. @@ -656,7 +656,7 @@ Gateway urls to resolve IPFS and/or Arweave assets. The balance of the account at a block number. -• **args.blockTag?**: `BlockTag` +• **args.blockTag?**: [`BlockTag`](../type-aliases/BlockTag.md) The balance of the account at a block tag. @@ -706,7 +706,7 @@ Address to get ENS name for. The balance of the account at a block number. -• **args.blockTag?**: `BlockTag` +• **args.blockTag?**: [`BlockTag`](../type-aliases/BlockTag.md) The balance of the account at a block tag. @@ -748,7 +748,7 @@ GetEnsResolverParameters The balance of the account at a block number. -• **args.blockTag?**: `BlockTag` +• **args.blockTag?**: [`BlockTag`](../type-aliases/BlockTag.md) The balance of the account at a block tag. @@ -786,7 +786,7 @@ GetEnsTextParameters The balance of the account at a block number. -• **args.blockTag?**: `BlockTag` +• **args.blockTag?**: [`BlockTag`](../type-aliases/BlockTag.md) The balance of the account at a block tag. @@ -840,59 +840,59 @@ The gas estimate (in wei). GetFeeHistoryReturnType ### getFilterChanges() -> **getFilterChanges**: \<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>(`args`) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> +> **getFilterChanges**: \<`filterType`, `abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>(`args`) => `Promise`\<`GetFilterChangesReturnType`\<`filterType`, `abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> #### Type Parameters -• **TFilterType** *extends* `FilterType` +• **filterType** *extends* `FilterType` -• **TAbi** *extends* `undefined` \| [`Abi`](../type-aliases/Abi.md) \| readonly `unknown`[] +• **abi** *extends* `undefined` \| `Abi` \| readonly `unknown`[] -• **TEventName** *extends* `undefined` \| `string` +• **eventName** *extends* `undefined` \| `string` -• **TStrict** *extends* `undefined` \| `boolean` = `undefined` +• **strict** *extends* `undefined` \| `boolean` = `undefined` -• **TFromBlock** *extends* `undefined` \| `bigint` \| `BlockTag` = `undefined` +• **fromBlock** *extends* `undefined` \| `bigint` \| [`BlockTag`](../type-aliases/BlockTag.md) = `undefined` -• **TToBlock** *extends* `undefined` \| `bigint` \| `BlockTag` = `undefined` +• **toBlock** *extends* `undefined` \| `bigint` \| [`BlockTag`](../type-aliases/BlockTag.md) = `undefined` #### Parameters -• **args**: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\> +• **args**: `GetFilterChangesParameters`\<`filterType`, `abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\> GetFilterChangesParameters #### Returns -`Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> +`Promise`\<`GetFilterChangesReturnType`\<`filterType`, `abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> Logs or hashes. GetFilterChangesReturnType ### getFilterLogs() -> **getFilterLogs**: \<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>(`args`) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> +> **getFilterLogs**: \<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>(`args`) => `Promise`\<`GetFilterLogsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> #### Type Parameters -• **TAbi** *extends* `undefined` \| [`Abi`](../type-aliases/Abi.md) \| readonly `unknown`[] +• **abi** *extends* `undefined` \| `Abi` \| readonly `unknown`[] -• **TEventName** *extends* `undefined` \| `string` +• **eventName** *extends* `undefined` \| `string` -• **TStrict** *extends* `undefined` \| `boolean` = `undefined` +• **strict** *extends* `undefined` \| `boolean` = `undefined` -• **TFromBlock** *extends* `undefined` \| `bigint` \| `BlockTag` = `undefined` +• **fromBlock** *extends* `undefined` \| `bigint` \| [`BlockTag`](../type-aliases/BlockTag.md) = `undefined` -• **TToBlock** *extends* `undefined` \| `bigint` \| `BlockTag` = `undefined` +• **toBlock** *extends* `undefined` \| `bigint` \| [`BlockTag`](../type-aliases/BlockTag.md) = `undefined` #### Parameters -• **args**: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\> +• **args**: `GetFilterLogsParameters`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\> GetFilterLogsParameters #### Returns -`Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`\>\> +`Promise`\<`GetFilterLogsReturnType`\<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`\>\> A list of event logs. GetFilterLogsReturnType @@ -908,29 +908,29 @@ The gas price (in wei). GetGasPriceReturnType ### getLogs() -> **getLogs**: \<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>(`args`?) => `Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> +> **getLogs**: \<`abiEvent`, `abiEvents`, `strict`, `fromBlock`, `toBlock`\>(`args`?) => `Promise`\<`GetLogsReturnType`\<`abiEvent`, `abiEvents`, `strict`, `fromBlock`, `toBlock`\>\> #### Type Parameters -• **TAbiEvent** *extends* `undefined` \| [`AbiEvent`](../type-aliases/AbiEvent.md) = `undefined` +• **abiEvent** *extends* `undefined` \| `AbiEvent` = `undefined` -• **TAbiEvents** *extends* `undefined` \| readonly `unknown`[] \| readonly [`AbiEvent`](../type-aliases/AbiEvent.md)[] = `TAbiEvent` *extends* [`AbiEvent`](../type-aliases/AbiEvent.md) ? [`TAbiEvent`\<`TAbiEvent`\>] : `undefined` +• **abiEvents** *extends* `undefined` \| readonly `unknown`[] \| readonly `AbiEvent`[] = `abiEvent` *extends* `AbiEvent` ? [`abiEvent`\<`abiEvent`\>] : `undefined` -• **TStrict** *extends* `undefined` \| `boolean` = `undefined` +• **strict** *extends* `undefined` \| `boolean` = `undefined` -• **TFromBlock** *extends* `undefined` \| `bigint` \| `BlockTag` = `undefined` +• **fromBlock** *extends* `undefined` \| `bigint` \| [`BlockTag`](../type-aliases/BlockTag.md) = `undefined` -• **TToBlock** *extends* `undefined` \| `bigint` \| `BlockTag` = `undefined` +• **toBlock** *extends* `undefined` \| `bigint` \| [`BlockTag`](../type-aliases/BlockTag.md) = `undefined` #### Parameters -• **args?**: `GetLogsParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\> +• **args?**: `GetLogsParameters`\<`abiEvent`, `abiEvents`, `strict`, `fromBlock`, `toBlock`\> GetLogsParameters #### Returns -`Promise`\<`GetLogsReturnType`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`\>\> +`Promise`\<`GetLogsReturnType`\<`abiEvent`, `abiEvents`, `strict`, `fromBlock`, `toBlock`\>\> A list of event logs. GetLogsReturnType @@ -976,21 +976,21 @@ The value of the storage slot. GetStorageAtReturnType ### getTransaction() -> **getTransaction**: \<`TBlockTag`\>(`args`) => `Promise`\<\{ \[K in string \| number \| symbol\]: FormattedTransaction\\[K\] \}\> +> **getTransaction**: \<`blockTag`\>(`args`) => `Promise`\<\{ \[K in string \| number \| symbol\]: FormattedTransaction\\[K\] \}\> #### Type Parameters -• **TBlockTag** *extends* `BlockTag` = `"latest"` +• **blockTag** *extends* [`BlockTag`](../type-aliases/BlockTag.md) = `"latest"` #### Parameters -• **args**: `GetTransactionParameters`\<`TBlockTag`\> +• **args**: `GetTransactionParameters`\<`blockTag`\> GetTransactionParameters #### Returns -`Promise`\<\{ \[K in string \| number \| symbol\]: FormattedTransaction\\[K\] \}\> +`Promise`\<\{ \[K in string \| number \| symbol\]: FormattedTransaction\\[K\] \}\> The transaction information. GetTransactionReturnType @@ -1070,16 +1070,6 @@ Impersonate an account or contract address. This lets you send transactions from - Docs: https://viem.sh/docs/actions/test/impersonateAccount -#### Parameters - -• **args**: `ImpersonateAccountParameters` - -ImpersonateAccountParameters - -#### Returns - -`Promise`\<`void`\> - #### Example ```ts @@ -1096,23 +1086,23 @@ await client.impersonateAccount({ }) ``` -### increaseTime() +#### Parameters -> **increaseTime**: (`args`) => `Promise`\<\`0x$\{string\}\`\> +• **args**: `ImpersonateAccountParameters` -Jump forward in time by the given amount of time, in seconds. +ImpersonateAccountParameters -- Docs: https://viem.sh/docs/actions/test/increaseTime +#### Returns -#### Parameters +`Promise`\<`void`\> -• **args**: `IncreaseTimeParameters` +### increaseTime() -– IncreaseTimeParameters +> **increaseTime**: (`args`) => `Promise`\<\`0x$\{string\}\`\> -#### Returns +Jump forward in time by the given amount of time, in seconds. -`Promise`\<\`0x$\{string\}\`\> +- Docs: https://viem.sh/docs/actions/test/increaseTime #### Example @@ -1130,6 +1120,16 @@ await client.increaseTime({ }) ``` +#### Parameters + +• **args**: `IncreaseTimeParameters` + +– IncreaseTimeParameters + +#### Returns + +`Promise`\<\`0x$\{string\}\`\> + ### inspectTxpool() > **inspectTxpool**: () => `Promise`\<`InspectTxpoolReturnType`\> @@ -1154,14 +1154,6 @@ Adds state previously dumped with `dumpState` to the current chain. - Docs: https://viem.sh/docs/actions/test/loadState -#### Parameters - -• **args**: `LoadStateParameters` - -#### Returns - -`Promise`\<`void`\> - #### Example ```ts @@ -1176,23 +1168,21 @@ const client = createTestClient({ await client.loadState({ state: '0x...' }) ``` -### mine() - -> **mine**: (`args`) => `Promise`\<`void`\> +#### Parameters -Mine a specified number of blocks. +• **args**: `LoadStateParameters` -- Docs: https://viem.sh/docs/actions/test/mine +#### Returns -#### Parameters +`Promise`\<`void`\> -• **args**: `MineParameters` +### mine() -– MineParameters +> **mine**: (`args`) => `Promise`\<`void`\> -#### Returns +Mine a specified number of blocks. -`Promise`\<`void`\> +- Docs: https://viem.sh/docs/actions/test/mine #### Example @@ -1208,6 +1198,16 @@ const client = createTestClient({ await client.mine({ blocks: 1 }) ``` +#### Parameters + +• **args**: `MineParameters` + +– MineParameters + +#### Returns + +`Promise`\<`void`\> + ### multicall() > **multicall**: \<`contracts`, `allowFailure`\>(`args`) => `Promise`\<`MulticallReturnType`\<`contracts`, `allowFailure`\>\> @@ -1244,7 +1244,7 @@ Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 millis ### prepareTransactionRequest -> **prepareTransactionRequest**: \<`TRequest`, `TChainOverride`, `TAccountOverride`\>(`args`) => `Promise`\<\{ \[K in string \| number \| symbol\]: (UnionRequiredBy\ & Object, ParameterTypeToParameters\<(...)\[(...)\] extends readonly (...)\[\] ? (...)\[(...)\] : (...) \| (...) \| (...) \| (...) \| (...) \| (...)\>\> & (unknown extends TRequest\["kzg"\] ? Object : Pick\))\[K\] \}\> & \<`TRequest`, `TChainOverride`, `TAccountOverride`\>(`args`) => `Promise`\<\{ \[K in string \| number \| symbol\]: (UnionRequiredBy\ & Object, ParameterTypeToParameters\<(...)\[(...)\] extends readonly (...)\[\] ? (...)\[(...)\] : (...) \| (...) \| (...) \| (...) \| (...) \| (...)\>\> & (unknown extends TRequest\["kzg"\] ? Object : Pick\))\[K\] \}\> +> **prepareTransactionRequest**: \<`request`, `chainOverride`, `accountOverride`\>(`args`) => `Promise`\<\{ \[K in string \| number \| symbol\]: (UnionRequiredBy\ & Object, ParameterTypeToParameters\<(...)\[(...)\] extends readonly (...)\[\] ? (...)\[(...)\] : (...) \| (...) \| (...) \| (...) \| (...) \| (...)\>\> & (unknown extends request\["kzg"\] ? Object : Pick\))\[K\] \}\> & \<`request`, `chainOverride`, `accountOverride`\>(`args`) => `Promise`\<\{ \[K in string \| number \| symbol\]: (UnionRequiredBy\ & Object, ParameterTypeToParameters\<(...)\[(...)\] extends readonly (...)\[\] ? (...)\[(...)\] : (...) \| (...) \| (...) \| (...) \| (...) \| (...)\>\> & (unknown extends request\["kzg"\] ? Object : Pick\))\[K\] \}\> Prepares a transaction request for signing. @@ -1294,7 +1294,7 @@ const request = await client.prepareTransactionRequest({ #### Type Parameters -• **abi** *extends* [`Abi`](../type-aliases/Abi.md) \| readonly `unknown`[] +• **abi** *extends* `Abi` \| readonly `unknown`[] • **functionName** *extends* `string` @@ -1320,10 +1320,6 @@ Removes [`setBlockTimestampInterval`](https://viem.sh/docs/actions/test/setBlock - Docs: https://viem.sh/docs/actions/test/removeBlockTimestampInterval -#### Returns - -`Promise`\<`void`\> - #### Example ```ts @@ -1339,6 +1335,10 @@ const client = createTestClient({ await client.removeBlockTimestampInterval() ``` +#### Returns + +`Promise`\<`void`\> + ### request > **request**: `EIP1193RequestFn`\<[`object`, `object`, `object`, `object`, `object`]\> @@ -1381,16 +1381,6 @@ Resets fork back to its original state. - Docs: https://viem.sh/docs/actions/test/reset -#### Parameters - -• **args?**: `ResetParameters` - -– ResetParameters - -#### Returns - -`Promise`\<`void`\> - #### Example ```ts @@ -1405,23 +1395,23 @@ const client = createTestClient({ await client.reset({ blockNumber: 69420n }) ``` -### revert() +#### Parameters -> **revert**: (`args`) => `Promise`\<`void`\> +• **args?**: `ResetParameters` -Revert the state of the blockchain at the current block. +– ResetParameters -- Docs: https://viem.sh/docs/actions/test/revert +#### Returns -#### Parameters +`Promise`\<`void`\> -• **args**: `RevertParameters` +### revert() -– RevertParameters +> **revert**: (`args`) => `Promise`\<`void`\> -#### Returns +Revert the state of the blockchain at the current block. -`Promise`\<`void`\> +- Docs: https://viem.sh/docs/actions/test/revert #### Example @@ -1437,6 +1427,16 @@ const client = createTestClient({ await client.revert({ id: '0x…' }) ``` +#### Parameters + +• **args**: `RevertParameters` + +– RevertParameters + +#### Returns + +`Promise`\<`void`\> + ### sendRawTransaction > **sendRawTransaction**: (`args`) => `Promise`\<\`0x$\{string\}\`\> & (`args`) => `Promise`\<\`0x$\{string\}\`\> @@ -1473,17 +1473,17 @@ const hash = await client.sendRawTransaction({ ### sendTransaction() -> **sendTransaction**: \<`TRequest`, `TChainOverride`\>(`args`) => `Promise`\<\`0x$\{string\}\`\> +> **sendTransaction**: \<`request`, `chainOverride`\>(`args`) => `Promise`\<\`0x$\{string\}\`\> #### Type Parameters -• **TRequest** *extends* `Omit`\<`object`, `"from"`\> \| `Omit`\<`object`, `"from"`\> \| `Omit`\<`object`, `"from"`\> \| `Omit`\<`object`, `"from"`\> & `object` +• **request** *extends* `Omit`\<`object`, `"from"`\> \| `Omit`\<`object`, `"from"`\> \| `Omit`\<`object`, `"from"`\> \| `Omit`\<`object`, `"from"`\> \| `Omit`\<`object`, `"from"`\> & `object` -• **TChainOverride** *extends* `undefined` \| `Chain` = `undefined` +• **chainOverride** *extends* `undefined` \| `Chain` = `undefined` #### Parameters -• **args**: `SendTransactionParameters`\<`TCommon`, `TAccountOrAddress` *extends* `Account` ? `Account` : `undefined`, `TChainOverride`, `TRequest`\> +• **args**: `SendTransactionParameters`\<`TCommon`, `TAccountOrAddress` *extends* [`Account`](../type-aliases/Account.md) ? [`Account`](../type-aliases/Account.md) : `undefined`, `chainOverride`, `request`\> SendTransactionParameters @@ -1495,15 +1495,15 @@ The [Transaction](https://viem.sh/docs/glossary/terms#transaction) hash. SendTra ### sendUnsignedTransaction() -> **sendUnsignedTransaction**: \<`TChain`\>(`args`) => `Promise`\<\`0x$\{string\}\`\> +> **sendUnsignedTransaction**: \<`chain`\>(`args`) => `Promise`\<\`0x$\{string\}\`\> #### Type Parameters -• **TChain** *extends* `undefined` \| `Chain` +• **chain** *extends* `undefined` \| `Chain` #### Parameters -• **args**: `SendUnsignedTransactionParameters`\<`TChain`\> +• **args**: `SendUnsignedTransactionParameters`\<`chain`\> – SendUnsignedTransactionParameters @@ -1521,14 +1521,6 @@ Enables or disables the automatic mining of new blocks with each new transaction - Docs: https://viem.sh/docs/actions/test/setAutomine -#### Parameters - -• **args**: `boolean` - -#### Returns - -`Promise`\<`void`\> - #### Example ```ts @@ -1543,23 +1535,21 @@ const client = createTestClient({ await client.setAutomine() ``` -### setBalance() - -> **setBalance**: (`args`) => `Promise`\<`void`\> +#### Parameters -Modifies the balance of an account. +• **args**: `boolean` -- Docs: https://viem.sh/docs/actions/test/setBalance +#### Returns -#### Parameters +`Promise`\<`void`\> -• **args**: `SetBalanceParameters` +### setBalance() -– SetBalanceParameters +> **setBalance**: (`args`) => `Promise`\<`void`\> -#### Returns +Modifies the balance of an account. -`Promise`\<`void`\> +- Docs: https://viem.sh/docs/actions/test/setBalance #### Example @@ -1578,23 +1568,23 @@ await client.setBalance({ }) ``` -### setBlockGasLimit() +#### Parameters -> **setBlockGasLimit**: (`args`) => `Promise`\<`void`\> +• **args**: `SetBalanceParameters` -Sets the block's gas limit. +– SetBalanceParameters -- Docs: https://viem.sh/docs/actions/test/setBlockGasLimit +#### Returns -#### Parameters +`Promise`\<`void`\> -• **args**: `SetBlockGasLimitParameters` +### setBlockGasLimit() -– SetBlockGasLimitParameters +> **setBlockGasLimit**: (`args`) => `Promise`\<`void`\> -#### Returns +Sets the block's gas limit. -`Promise`\<`void`\> +- Docs: https://viem.sh/docs/actions/test/setBlockGasLimit #### Example @@ -1610,23 +1600,23 @@ const client = createTestClient({ await client.setBlockGasLimit({ gasLimit: 420_000n }) ``` -### setBlockTimestampInterval() +#### Parameters -> **setBlockTimestampInterval**: (`args`) => `Promise`\<`void`\> +• **args**: `SetBlockGasLimitParameters` -Similar to [`increaseTime`](https://viem.sh/docs/actions/test/increaseTime), but sets a block timestamp `interval`. The timestamp of future blocks will be computed as `lastBlock_timestamp` + `interval`. +– SetBlockGasLimitParameters -- Docs: https://viem.sh/docs/actions/test/setBlockTimestampInterval +#### Returns -#### Parameters +`Promise`\<`void`\> -• **args**: `SetBlockTimestampIntervalParameters` +### setBlockTimestampInterval() -– SetBlockTimestampIntervalParameters +> **setBlockTimestampInterval**: (`args`) => `Promise`\<`void`\> -#### Returns +Similar to [`increaseTime`](https://viem.sh/docs/actions/test/increaseTime), but sets a block timestamp `interval`. The timestamp of future blocks will be computed as `lastBlock_timestamp` + `interval`. -`Promise`\<`void`\> +- Docs: https://viem.sh/docs/actions/test/setBlockTimestampInterval #### Example @@ -1642,6 +1632,16 @@ const client = createTestClient({ await client.setBlockTimestampInterval({ interval: 5 }) ``` +#### Parameters + +• **args**: `SetBlockTimestampIntervalParameters` + +– SetBlockTimestampIntervalParameters + +#### Returns + +`Promise`\<`void`\> + ### setCode() > **setCode**: (`args`) => `Promise`\<`void`\> @@ -1650,17 +1650,7 @@ Modifies the bytecode stored at an account's address. - Docs: https://viem.sh/docs/actions/test/setCode -#### Parameters - -• **args**: `SetCodeParameters` - -– SetCodeParameters - -#### Returns - -`Promise`\<`void`\> - -#### Example +#### Example ```ts import { createTestClient, http } from 'viem' @@ -1677,23 +1667,23 @@ await client.setCode({ }) ``` -### setCoinbase() +#### Parameters -> **setCoinbase**: (`args`) => `Promise`\<`void`\> +• **args**: `SetCodeParameters` -Sets the coinbase address to be used in new blocks. +– SetCodeParameters -- Docs: https://viem.sh/docs/actions/test/setCoinbase +#### Returns -#### Parameters +`Promise`\<`void`\> -• **args**: `SetCoinbaseParameters` +### setCoinbase() -– SetCoinbaseParameters +> **setCoinbase**: (`args`) => `Promise`\<`void`\> -#### Returns +Sets the coinbase address to be used in new blocks. -`Promise`\<`void`\> +- Docs: https://viem.sh/docs/actions/test/setCoinbase #### Example @@ -1711,23 +1701,23 @@ await client.setCoinbase({ }) ``` -### setIntervalMining() +#### Parameters -> **setIntervalMining**: (`args`) => `Promise`\<`void`\> +• **args**: `SetCoinbaseParameters` -Sets the automatic mining interval (in seconds) of blocks. Setting the interval to 0 will disable automatic mining. +– SetCoinbaseParameters -- Docs: https://viem.sh/docs/actions/test/setIntervalMining +#### Returns -#### Parameters +`Promise`\<`void`\> -• **args**: `SetIntervalMiningParameters` +### setIntervalMining() -– SetIntervalMiningParameters +> **setIntervalMining**: (`args`) => `Promise`\<`void`\> -#### Returns +Sets the automatic mining interval (in seconds) of blocks. Setting the interval to 0 will disable automatic mining. -`Promise`\<`void`\> +- Docs: https://viem.sh/docs/actions/test/setIntervalMining #### Example @@ -1743,21 +1733,23 @@ const client = createTestClient({ await client.setIntervalMining({ interval: 5 }) ``` -### setLoggingEnabled() +#### Parameters -> **setLoggingEnabled**: (`args`) => `Promise`\<`void`\> +• **args**: `SetIntervalMiningParameters` -Enable or disable logging on the test node network. +– SetIntervalMiningParameters -- Docs: https://viem.sh/docs/actions/test/setLoggingEnabled +#### Returns -#### Parameters +`Promise`\<`void`\> -• **args**: `boolean` +### setLoggingEnabled() -#### Returns +> **setLoggingEnabled**: (`args`) => `Promise`\<`void`\> -`Promise`\<`void`\> +Enable or disable logging on the test node network. + +- Docs: https://viem.sh/docs/actions/test/setLoggingEnabled #### Example @@ -1773,6 +1765,14 @@ const client = createTestClient({ await client.setLoggingEnabled() ``` +#### Parameters + +• **args**: `boolean` + +#### Returns + +`Promise`\<`void`\> + ### setMinGasPrice() > **setMinGasPrice**: (`args`) => `Promise`\<`void`\> @@ -1783,16 +1783,6 @@ Change the minimum gas price accepted by the network (in wei). Note: `setMinGasPrice` can only be used on clients that do not have EIP-1559 enabled. -#### Parameters - -• **args**: `SetMinGasPriceParameters` - -– SetBlockGasLimitParameters - -#### Returns - -`Promise`\<`void`\> - #### Example ```ts @@ -1809,23 +1799,23 @@ await client.setMinGasPrice({ }) ``` -### setNextBlockBaseFeePerGas() +#### Parameters -> **setNextBlockBaseFeePerGas**: (`args`) => `Promise`\<`void`\> +• **args**: `SetMinGasPriceParameters` -Sets the next block's base fee per gas. +– SetBlockGasLimitParameters -- Docs: https://viem.sh/docs/actions/test/setNextBlockBaseFeePerGas +#### Returns -#### Parameters +`Promise`\<`void`\> -• **args**: `SetNextBlockBaseFeePerGasParameters` +### setNextBlockBaseFeePerGas() -– SetNextBlockBaseFeePerGasParameters +> **setNextBlockBaseFeePerGas**: (`args`) => `Promise`\<`void`\> -#### Returns +Sets the next block's base fee per gas. -`Promise`\<`void`\> +- Docs: https://viem.sh/docs/actions/test/setNextBlockBaseFeePerGas #### Example @@ -1843,23 +1833,23 @@ await client.setNextBlockBaseFeePerGas({ }) ``` -### setNextBlockTimestamp() +#### Parameters -> **setNextBlockTimestamp**: (`args`) => `Promise`\<`void`\> +• **args**: `SetNextBlockBaseFeePerGasParameters` -Sets the next block's timestamp. +– SetNextBlockBaseFeePerGasParameters -- Docs: https://viem.sh/docs/actions/test/setNextBlockTimestamp +#### Returns -#### Parameters +`Promise`\<`void`\> -• **args**: `SetNextBlockTimestampParameters` +### setNextBlockTimestamp() -– SetNextBlockTimestampParameters +> **setNextBlockTimestamp**: (`args`) => `Promise`\<`void`\> -#### Returns +Sets the next block's timestamp. -`Promise`\<`void`\> +- Docs: https://viem.sh/docs/actions/test/setNextBlockTimestamp #### Example @@ -1875,23 +1865,23 @@ const client = createTestClient({ await client.setNextBlockTimestamp({ timestamp: 1671744314n }) ``` -### setNonce() +#### Parameters -> **setNonce**: (`args`) => `Promise`\<`void`\> +• **args**: `SetNextBlockTimestampParameters` -Modifies (overrides) the nonce of an account. +– SetNextBlockTimestampParameters -- Docs: https://viem.sh/docs/actions/test/setNonce +#### Returns -#### Parameters +`Promise`\<`void`\> -• **args**: `SetNonceParameters` +### setNonce() -– SetNonceParameters +> **setNonce**: (`args`) => `Promise`\<`void`\> -#### Returns +Modifies (overrides) the nonce of an account. -`Promise`\<`void`\> +- Docs: https://viem.sh/docs/actions/test/setNonce #### Example @@ -1910,21 +1900,23 @@ await client.setNonce({ }) ``` -### setRpcUrl() +#### Parameters -> **setRpcUrl**: (`args`) => `Promise`\<`void`\> +• **args**: `SetNonceParameters` -Sets the backend RPC URL. +– SetNonceParameters -- Docs: https://viem.sh/docs/actions/test/setRpcUrl +#### Returns -#### Parameters +`Promise`\<`void`\> -• **args**: `string` +### setRpcUrl() -#### Returns +> **setRpcUrl**: (`args`) => `Promise`\<`void`\> -`Promise`\<`void`\> +Sets the backend RPC URL. + +- Docs: https://viem.sh/docs/actions/test/setRpcUrl #### Example @@ -1940,23 +1932,21 @@ const client = createTestClient({ await client.setRpcUrl('https://eth-mainnet.g.alchemy.com/v2') ``` -### setStorageAt() - -> **setStorageAt**: (`args`) => `Promise`\<`void`\> +#### Parameters -Writes to a slot of an account's storage. +• **args**: `string` -- Docs: https://viem.sh/docs/actions/test/setStorageAt +#### Returns -#### Parameters +`Promise`\<`void`\> -• **args**: `SetStorageAtParameters` +### setStorageAt() -– SetStorageAtParameters +> **setStorageAt**: (`args`) => `Promise`\<`void`\> -#### Returns +Writes to a slot of an account's storage. -`Promise`\<`void`\> +- Docs: https://viem.sh/docs/actions/test/setStorageAt #### Example @@ -1976,13 +1966,23 @@ await client.setStorageAt({ }) ``` +#### Parameters + +• **args**: `SetStorageAtParameters` + +– SetStorageAtParameters + +#### Returns + +`Promise`\<`void`\> + ### signMessage() > **signMessage**: (`args`) => `Promise`\<\`0x$\{string\}\`\> #### Parameters -• **args**: `SignMessageParameters`\<`TAccountOrAddress` *extends* `Account` ? `Account` : `undefined`\> +• **args**: `SignMessageParameters`\<`TAccountOrAddress` *extends* [`Account`](../type-aliases/Account.md) ? [`Account`](../type-aliases/Account.md) : `undefined`\> SignMessageParameters @@ -1994,37 +1994,37 @@ The signed message. SignMessageReturnType ### signTransaction() -> **signTransaction**: \<`TChainOverride`\>(`args`) => `Promise`\<\`0x02$\{string\}\` \| \`0x01$\{string\}\` \| \`0x03$\{string\}\` \| `TransactionSerializedLegacy`\> +> **signTransaction**: \<`chainOverride`\>(`args`) => `Promise`\<\`0x02$\{string\}\` \| \`0x01$\{string\}\` \| \`0x03$\{string\}\` \| \`0x04$\{string\}\` \| `TransactionSerializedLegacy`\> #### Type Parameters -• **TChainOverride** *extends* `undefined` \| `Chain` +• **chainOverride** *extends* `undefined` \| `Chain` #### Parameters -• **args**: `SignTransactionParameters`\<`TCommon`, `TAccountOrAddress` *extends* `Account` ? `Account` : `undefined`, `TChainOverride`\> +• **args**: `SignTransactionParameters`\<`TCommon`, `TAccountOrAddress` *extends* [`Account`](../type-aliases/Account.md) ? [`Account`](../type-aliases/Account.md) : `undefined`, `chainOverride`\> SignTransactionParameters #### Returns -`Promise`\<\`0x02$\{string\}\` \| \`0x01$\{string\}\` \| \`0x03$\{string\}\` \| `TransactionSerializedLegacy`\> +`Promise`\<\`0x02$\{string\}\` \| \`0x01$\{string\}\` \| \`0x03$\{string\}\` \| \`0x04$\{string\}\` \| `TransactionSerializedLegacy`\> The signed message. SignTransactionReturnType ### signTypedData() -> **signTypedData**: \<`TTypedData`, `TPrimaryType`\>(`args`) => `Promise`\<\`0x$\{string\}\`\> +> **signTypedData**: \<`typedData`, `primaryType`\>(`args`) => `Promise`\<\`0x$\{string\}\`\> #### Type Parameters -• **TTypedData** *extends* `object` \| `object` +• **typedData** *extends* `object` \| `object` -• **TPrimaryType** *extends* `string` +• **primaryType** *extends* `string` #### Parameters -• **args**: `SignTypedDataParameters`\<`TTypedData`, `TPrimaryType`, `TAccountOrAddress` *extends* `Account` ? `Account` : `undefined`\> +• **args**: `SignTypedDataParameters`\<`typedData`, `primaryType`, `TAccountOrAddress` *extends* [`Account`](../type-aliases/Account.md) ? [`Account`](../type-aliases/Account.md) : `undefined`\> SignTypedDataParameters @@ -2036,11 +2036,11 @@ The signed data. SignTypedDataReturnType ### simulateContract() -> **simulateContract**: \<`abi`, `functionName`, `args`, `chainOverride`, `accountOverride`\>(`args`) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `TCommon`, `TAccountOrAddress` *extends* `Account` ? `Account` : `undefined`, `chainOverride`, `accountOverride`\>\> +> **simulateContract**: \<`abi`, `functionName`, `args`, `chainOverride`, `accountOverride`\>(`args`) => `Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `TCommon`, `TAccountOrAddress` *extends* [`Account`](../type-aliases/Account.md) ? [`Account`](../type-aliases/Account.md) : `undefined`, `chainOverride`, `accountOverride`\>\> #### Type Parameters -• **abi** *extends* [`Abi`](../type-aliases/Abi.md) \| readonly `unknown`[] +• **abi** *extends* `Abi` \| readonly `unknown`[] • **functionName** *extends* `string` @@ -2048,7 +2048,7 @@ The signed data. SignTypedDataReturnType • **chainOverride** *extends* `undefined` \| `Chain` -• **accountOverride** *extends* `undefined` \| \`0x$\{string\}\` \| `Account` = `undefined` +• **accountOverride** *extends* `undefined` \| \`0x$\{string\}\` \| [`Account`](../type-aliases/Account.md) = `undefined` #### Parameters @@ -2058,7 +2058,7 @@ SimulateContractParameters #### Returns -`Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `TCommon`, `TAccountOrAddress` *extends* `Account` ? `Account` : `undefined`, `chainOverride`, `accountOverride`\>\> +`Promise`\<`SimulateContractReturnType`\<`abi`, `functionName`, `args`, `TCommon`, `TAccountOrAddress` *extends* [`Account`](../type-aliases/Account.md) ? [`Account`](../type-aliases/Account.md) : `undefined`, `chainOverride`, `accountOverride`\>\> The simulation result and write request. SimulateContractReturnType @@ -2070,10 +2070,6 @@ Snapshot the state of the blockchain at the current block. - Docs: https://viem.sh/docs/actions/test/snapshot -#### Returns - -`Promise`\<\`0x$\{string\}\`\> - #### Example ```ts @@ -2089,6 +2085,10 @@ const client = createTestClient({ await client.snapshot() ``` +#### Returns + +`Promise`\<\`0x$\{string\}\`\> + ### stopImpersonatingAccount() > **stopImpersonatingAccount**: (`args`) => `Promise`\<`void`\> @@ -2097,16 +2097,6 @@ Stop impersonating an account after having previously used [`impersonateAccount` - Docs: https://viem.sh/docs/actions/test/stopImpersonatingAccount -#### Parameters - -• **args**: `StopImpersonatingAccountParameters` - -– StopImpersonatingAccountParameters - -#### Returns - -`Promise`\<`void`\> - #### Example ```ts @@ -2124,24 +2114,24 @@ await client.stopImpersonatingAccount({ }) ``` -### switchChain() +#### Parameters -> **switchChain**: (`args`) => `Promise`\<`void`\> +• **args**: `StopImpersonatingAccountParameters` -Switch the target chain in a wallet. +– StopImpersonatingAccountParameters -- Docs: https://viem.sh/docs/actions/wallet/switchChain -- JSON-RPC Methods: [`eth_switchEthereumChain`](https://eips.ethereum.org/EIPS/eip-3326) +#### Returns -#### Parameters +`Promise`\<`void`\> -• **args**: `SwitchChainParameters` +### switchChain() -SwitchChainParameters +> **switchChain**: (`args`) => `Promise`\<`void`\> -#### Returns +Switch the target chain in a wallet. -`Promise`\<`void`\> +- Docs: https://viem.sh/docs/actions/wallet/switchChain +- JSON-RPC Methods: [`eth_switchEthereumChain`](https://eips.ethereum.org/EIPS/eip-3326) #### Example @@ -2156,12 +2146,45 @@ const client = createWalletClient({ await client.switchChain({ id: optimism.id }) ``` +#### Parameters + +• **args**: `SwitchChainParameters` + +SwitchChainParameters + +#### Returns + +`Promise`\<`void`\> + ### tevm > **tevm**: `object` & [`EIP1193Events`](../type-aliases/EIP1193Events.md) & `object` & [`Eip1193RequestProvider`](../type-aliases/Eip1193RequestProvider.md) Low level access to TEVM can be accessed via `tevm`. These APIs are not guaranteed to be stable. +#### See + +[TevmNode](../type-aliases/TevmNode.md) + +#### Example + +```typescript +import { createMemoryClient } from 'tevm' + +const memoryClient = createMemoryClient() + +// low level access to the TEVM VM, blockchain, EVM, stateManager, mempool, receiptsManager and more are available +const vm = await memoryClient.tevm.getVm() +vm.runBlock(...) +const { blockchain, evm, stateManager } = vm +blockchain.addBlock(...) +evm.runCall(...) +stateManager.putAccount(...) + +const mempool = await memoryClient.tevm.getTxPool() +const receiptsManager = await memoryClient.tevm.getReceiptsManager() +``` + #### Type declaration ##### deepCopy() @@ -2301,10 +2324,6 @@ Returns promise that resulves when the client is ready The client is usable without calling this method but may have extra latency on the first call from initialization -###### Returns - -`Promise`\<`true`\> - ###### Example ```ts @@ -2312,6 +2331,10 @@ const client = createMemoryClient() await client.ready() ``` +###### Returns + +`Promise`\<`true`\> + ##### removeFilter() > `readonly` **removeFilter**: (`id`) => `void` @@ -2387,29 +2410,6 @@ Arguments to pass to the event listeners. True if the event was emitted, false otherwise. -#### See - -[TevmNode](../type-aliases/TevmNode.md) - -#### Example - -```typescript -import { createMemoryClient } from 'tevm' - -const memoryClient = createMemoryClient() - -// low level access to the TEVM VM, blockchain, EVM, stateManager, mempool, receiptsManager and more are available -const vm = await memoryClient.tevm.getVm() -vm.runBlock(...) -const { blockchain, evm, stateManager } = vm -blockchain.addBlock(...) -evm.runCall(...) -stateManager.putAccount(...) - -const mempool = await memoryClient.tevm.getTxPool() -const receiptsManager = await memoryClient.tevm.getReceiptsManager() -``` - ### tevmCall > **tevmCall**: `CallHandler` @@ -2590,10 +2590,6 @@ await client.tevmMine() Returns a promise that resolves when the TEVM is ready. This is not needed to explicitly be called as all actions will wait for the TEVM to be ready. -#### Returns - -`Promise`\<`true`\> - #### Example ```typescript @@ -2605,6 +2601,10 @@ await client.tevmReady() ``` Same as calling `client.tevm.ready()` +#### Returns + +`Promise`\<`true`\> + ### ~~tevmScript~~ > **tevmScript**: `ScriptHandler` @@ -2815,10 +2815,6 @@ Returns promise that resulves when the client is ready The client is usable without calling this method but may have extra latency on the first call from initialization -###### Returns - -`Promise`\<`true`\> - ###### Example ```ts @@ -2826,6 +2822,10 @@ const client = createMemoryClient() await client.ready() ``` +###### Returns + +`Promise`\<`true`\> + ###### removeFilter() > `readonly` **removeFilter**: (`id`) => `void` @@ -2951,7 +2951,7 @@ The address that signed the original message. The balance of the account at a block number. -• **args.blockTag?**: `BlockTag` +• **args.blockTag?**: [`BlockTag`](../type-aliases/BlockTag.md) The balance of the account at a block tag. @@ -2995,7 +2995,7 @@ Ethereum address to check against. The balance of the account at a block number. -• **args.blockTag?**: `BlockTag` +• **args.blockTag?**: [`BlockTag`](../type-aliases/BlockTag.md) The balance of the account at a block tag. @@ -3105,17 +3105,17 @@ A function that can be invoked to stop watching for new block numbers. WatchBloc ### watchBlocks() -> **watchBlocks**: \<`TIncludeTransactions`, `TBlockTag`\>(`args`) => `WatchBlocksReturnType` +> **watchBlocks**: \<`includeTransactions`, `blockTag`\>(`args`) => `WatchBlocksReturnType` #### Type Parameters -• **TIncludeTransactions** *extends* `boolean` = `false` +• **includeTransactions** *extends* `boolean` = `false` -• **TBlockTag** *extends* `BlockTag` = `"latest"` +• **blockTag** *extends* [`BlockTag`](../type-aliases/BlockTag.md) = `"latest"` #### Parameters -• **args**: `WatchBlocksParameters`\<[`TevmTransport`](../type-aliases/TevmTransport.md), `TCommon`, `TIncludeTransactions`, `TBlockTag`\> +• **args**: `WatchBlocksParameters`\<[`TevmTransport`](../type-aliases/TevmTransport.md), `TCommon`, `includeTransactions`, `blockTag`\> WatchBlocksParameters @@ -3127,19 +3127,19 @@ A function that can be invoked to stop watching for new block numbers. WatchBloc ### watchContractEvent() -> **watchContractEvent**: \<`TAbi`, `TEventName`, `TStrict`\>(`args`) => `WatchContractEventReturnType` +> **watchContractEvent**: \<`abi`, `eventName`, `strict`\>(`args`) => `WatchContractEventReturnType` #### Type Parameters -• **TAbi** *extends* [`Abi`](../type-aliases/Abi.md) \| readonly `unknown`[] +• **abi** *extends* `Abi` \| readonly `unknown`[] -• **TEventName** *extends* `string` +• **eventName** *extends* `string` -• **TStrict** *extends* `undefined` \| `boolean` = `undefined` +• **strict** *extends* `undefined` \| `boolean` = `undefined` #### Parameters -• **args**: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, [`TevmTransport`](../type-aliases/TevmTransport.md)\> +• **args**: `WatchContractEventParameters`\<`abi`, `eventName`, `strict`, [`TevmTransport`](../type-aliases/TevmTransport.md)\> WatchContractEventParameters @@ -3151,19 +3151,19 @@ A function that can be invoked to stop watching for new event logs. WatchContrac ### watchEvent() -> **watchEvent**: \<`TAbiEvent`, `TAbiEvents`, `TStrict`\>(`args`) => `WatchEventReturnType` +> **watchEvent**: \<`abiEvent`, `abiEvents`, `strict`\>(`args`) => `WatchEventReturnType` #### Type Parameters -• **TAbiEvent** *extends* `undefined` \| [`AbiEvent`](../type-aliases/AbiEvent.md) = `undefined` +• **abiEvent** *extends* `undefined` \| `AbiEvent` = `undefined` -• **TAbiEvents** *extends* `undefined` \| readonly `unknown`[] \| readonly [`AbiEvent`](../type-aliases/AbiEvent.md)[] = `TAbiEvent` *extends* [`AbiEvent`](../type-aliases/AbiEvent.md) ? [`TAbiEvent`\<`TAbiEvent`\>] : `undefined` +• **abiEvents** *extends* `undefined` \| readonly `unknown`[] \| readonly `AbiEvent`[] = `abiEvent` *extends* `AbiEvent` ? [`abiEvent`\<`abiEvent`\>] : `undefined` -• **TStrict** *extends* `undefined` \| `boolean` = `undefined` +• **strict** *extends* `undefined` \| `boolean` = `undefined` #### Parameters -• **args**: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, [`TevmTransport`](../type-aliases/TevmTransport.md)\> +• **args**: `WatchEventParameters`\<`abiEvent`, `abiEvents`, `strict`, [`TevmTransport`](../type-aliases/TevmTransport.md)\> WatchEventParameters @@ -3191,21 +3191,21 @@ A function that can be invoked to stop watching for new pending transaction hash ### writeContract() -> **writeContract**: \<`abi`, `functionName`, `args`, `TChainOverride`\>(`args`) => `Promise`\<\`0x$\{string\}\`\> +> **writeContract**: \<`abi`, `functionName`, `args`, `chainOverride`\>(`args`) => `Promise`\<\`0x$\{string\}\`\> #### Type Parameters -• **abi** *extends* [`Abi`](../type-aliases/Abi.md) \| readonly `unknown`[] +• **abi** *extends* `Abi` \| readonly `unknown`[] • **functionName** *extends* `string` • **args** *extends* `unknown` -• **TChainOverride** *extends* `undefined` \| `Chain` = `undefined` +• **chainOverride** *extends* `undefined` \| `Chain` = `undefined` #### Parameters -• **args**: `WriteContractParameters`\<`abi`, `functionName`, `args`, `TCommon`, `TAccountOrAddress` *extends* `Account` ? `Account` : `undefined`, `TChainOverride`\> +• **args**: `WriteContractParameters`\<`abi`, `functionName`, `args`, `TCommon`, `TAccountOrAddress` *extends* [`Account`](../type-aliases/Account.md) ? [`Account`](../type-aliases/Account.md) : `undefined`, `chainOverride`\> WriteContractParameters @@ -3215,186 +3215,6 @@ WriteContractParameters A [Transaction Hash](https://viem.sh/docs/glossary/terms#hash). WriteContractReturnType -## Example - -```typescript -import { createMemoryClient } from "tevm"; - -const client = createMemoryClient({ - fork: { - transport: http("https://mainnet.optimism.io")({}), - }, -}); - -const blockNumber = await client.getBlockNumber(); -console.log(blockNumber); -``` - -## See - - - [Client Guide](https://tevm.sh/learn/clients/) - - [Actions Guide](https://tevm.sh/learn/actions/) - - [Reference Docs](https://tevm.sh/reference/tevm/memory-client/functions/creatememoryclient/) - - For more information on viem clients, see the [viem client docs](https://viem.sh/docs/clients/introduction) - -## Actions API - -MemoryClient supports the following viem actions: - -- [TEVM actions API](https://tevm.sh/reference/tevm/memory-client/type-aliases/tevmactions/) -```typescript -import { createMemoryClient } from "tevm"; - -const tevm = createMemoryClient(); -await tevm.setAccount({ address: `0x${'01'.repeat(20)}`, balance: 100n }); -``` -- [Viem public actions API](https://viem.sh/docs/actions/public/introduction) such as [getBlockNumber](https://viem.sh/docs/actions/public/getBlockNumber) -```typescript -import { createMemoryClient } from "tevm"; - -const tevm = createMemoryClient(); -const bn = await tevm.getBlockNumber(); -``` -- [Test actions](https://viem.sh/docs/actions/test/introduction) are included by default. -```typescript -import { createMemoryClient } from "tevm"; - -const tevm = createMemoryClient(); -await tevm.setBalance({ address: `0x${'01'.repeat(20)}`, balance: 100n }); -``` - -## Forking - -To fork an existing network, pass an EIP-1193 transport to the `fork.transport` option with an optional block tag. -When you fork, TEVM will pin the block tag and lazily cache state from the fork transport. -It's highly recommended to pass in a `common` object that matches the chain. This will increase the performance of forking with known values. - -```typescript -import { createMemoryClient, http } from "tevm"; -import { optimism } from "tevm/common"; - -const forkedClient = createMemoryClient({ - fork: { - transport: http("https://mainnet.optimism.io")({}), - blockTag: '0xa6a63cd70fbbe396321ca6fe79e1b6735760c03538208b50d7e3a5dac5226435', - }, - common: optimism, -}); -``` - -The `common` object extends the viem chain interface with EVM-specific information. When using TEVM, you should also use `tevm/common` rather than `viem/chains` or use `createCommon` and pass in a viem chain. - -Viem clients, including MemoryClient, are themselves EIP-1193 transports. This means you can fork a client with another client. - -## Mining Modes - -TEVM supports two mining modes: -- Manual: Using `tevm.mine()` -- Auto: Automatically mines a block after every transaction. - -TEVM state does not update until blocks are mined. - -## Using TEVM over HTTP - -TEVM can be run as an HTTP server using `@tevm/server` to handle JSON-RPC requests. - -```typescript -import { createServer } from "tevm/server"; -import { createMemoryClient } from "tevm"; - -const memoryClient = createMemoryClient(); - -const server = createServer({ - request: memoryClient.request, -}); - -server.listen(8545, () => console.log("listening on 8545")); -``` - -This allows you to use any Ethereum client to communicate with it, including a viem public client. - -```typescript -import { createPublicClient, http } from "viem"; -import { mainnet } from "viem/chains"; - -const publicClient = createPublicClient({ - chain: mainnet, - transport: http("https://localhost:8545"), -}); - -console.log(await publicClient.getChainId()); -``` - -## State Persistence (Experimental) - -It is possible to persist the TEVM client to a synchronous source using the `persister` option. - -```typescript -import { createMemoryClient, createSyncPersister } from "tevm"; -import { createMemoryClient } from "tevm/sync-storage-persister"; - -// Client state will be hydrated and persisted from/to local storage -const clientWithLocalStoragePersistence = createMemoryClient({ - persister: createSyncPersister({ - storage: localStorage, - }), -}); -``` - -## Network Support - -TEVM guarantees support for the following networks: -- Ethereum mainnet -- Standard OP Stack chains - -Other EVM chains are likely to work but do not officially carry support. More official chain support will be added in the near future. - -Note: Optimism deposit transactions are not currently supported but will be in a future release. TEVM filters out these transactions from blocks. - -## Network and Hardfork Support - -TEVM supports enabling and disabling different EIPs, but the following EIPs are always turned on: -- 1559 -- 4895 -- 4844 -- 4788 - -Currently, only EIP-1559 Fee Market transactions are supported. - -## Tree Shakeable Actions - -TEVM supports tree-shakeable actions using `createTevmNode()` and the `tevm/actions` package. If you are building a UI, you should use tree-shakeable actions to optimize bundle size. These are described in detail in the [actions API guide](https://tevm.sh/learn/actions/). - -## Composing with TEVM Contracts and Bundler - -MemoryClient can compose with TEVM contracts and the TEVM bundler. For more information, see the [TEVM contracts guide](https://tevm.sh/learn/contracts/) and the [TEVM Solidity imports guide](https://tevm.sh/learn/solidity-imports/). - -```typescript -import { createMemoryClient } from "tevm"; -import { MyERC721 } from './MyERC721.sol'; - -const tevm = createMemoryClient({ - fork: { - transport: http("https://mainnet.optimism.io")({}), - }, -}); - -const address = '0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045'; - -await tevm.runContractCall( - MyERC721.write.mint({ - caller: address, - }), -); - -const balance = await tevm.runContractCall( - MyERC721.read.balanceOf({ - caller: address, - }), -); -console.log(balance); // 1n -``` - ## Defined in packages/memory-client/types/createMemoryClient.d.ts:184 diff --git a/tevm/docs/index/functions/createMemoryDb.md b/tevm/docs/index/functions/createMemoryDb.md index 15cd29ff7c..1e64a8f9ae 100644 --- a/tevm/docs/index/functions/createMemoryDb.md +++ b/tevm/docs/index/functions/createMemoryDb.md @@ -21,8 +21,6 @@ Pass in an initial DB optionally to prepoulate the DB. [`MemoryDb`](../type-aliases/MemoryDb.md)\<`Uint8Array`, `Uint8Array`\> -## Throws - ## Defined in packages/utils/types/createMemoryDb.d.ts:8 diff --git a/tevm/docs/index/functions/createTevmNode.md b/tevm/docs/index/functions/createTevmNode.md index 9cb3d81c36..7fcf936e38 100644 --- a/tevm/docs/index/functions/createTevmNode.md +++ b/tevm/docs/index/functions/createTevmNode.md @@ -10,7 +10,7 @@ ## Parameters -• **options?**: [`TevmNodeOptions`](../type-aliases/TevmNodeOptions.md)\<[`Common`](../../common/type-aliases/Common.md)\> +• **options?**: [`TevmNodeOptions`](../type-aliases/TevmNodeOptions.md)\<`object`\> ## Returns @@ -18,4 +18,4 @@ ## Defined in -packages/node/dist/index.d.ts:356 +packages/node/dist/index.d.ts:358 diff --git a/tevm/docs/index/functions/createTevmTransport.md b/tevm/docs/index/functions/createTevmTransport.md index 16f11d18d1..158f9e3178 100644 --- a/tevm/docs/index/functions/createTevmTransport.md +++ b/tevm/docs/index/functions/createTevmTransport.md @@ -10,7 +10,7 @@ ## Parameters -• **options?**: [`TevmNodeOptions`](../type-aliases/TevmNodeOptions.md)\<[`Common`](../../common/type-aliases/Common.md)\> +• **options?**: [`TevmNodeOptions`](../type-aliases/TevmNodeOptions.md)\<`object`\> ## Returns diff --git a/tevm/docs/index/functions/decodeAbiParameters.md b/tevm/docs/index/functions/decodeAbiParameters.md index c3811f8b5a..a6796c81de 100644 --- a/tevm/docs/index/functions/decodeAbiParameters.md +++ b/tevm/docs/index/functions/decodeAbiParameters.md @@ -6,22 +6,22 @@ # Function: decodeAbiParameters() -> **decodeAbiParameters**\<`TParams`\>(`params`, `data`): `DecodeAbiParametersReturnType`\<`TParams`\> +> **decodeAbiParameters**\<`params`\>(`params`, `data`): `DecodeAbiParametersReturnType`\<`params`\> ## Type Parameters -• **TParams** *extends* readonly `AbiParameter`[] +• **params** *extends* readonly `AbiParameter`[] ## Parameters -• **params**: `TParams` +• **params**: `params` • **data**: \`0x$\{string\}\` \| `Uint8Array` ## Returns -`DecodeAbiParametersReturnType`\<`TParams`\> +`DecodeAbiParametersReturnType`\<`params`\> ## Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/abi/decodeAbiParameters.d.ts:15 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/abi/decodeAbiParameters.d.ts:15 diff --git a/tevm/docs/index/functions/decodeErrorResult.md b/tevm/docs/index/functions/decodeErrorResult.md index 23b695f727..562e3f282d 100644 --- a/tevm/docs/index/functions/decodeErrorResult.md +++ b/tevm/docs/index/functions/decodeErrorResult.md @@ -6,20 +6,20 @@ # Function: decodeErrorResult() -> **decodeErrorResult**\<`TAbi`\>(`parameters`): `DecodeErrorResultReturnType`\<`TAbi`\> +> **decodeErrorResult**\<`abi`\>(`parameters`): `DecodeErrorResultReturnType`\<`abi`\> ## Type Parameters -• **TAbi** *extends* `Abi` \| readonly `unknown`[] +• **abi** *extends* `Abi` \| readonly `unknown`[] ## Parameters -• **parameters**: `DecodeErrorResultParameters`\<`TAbi`\> +• **parameters**: `DecodeErrorResultParameters`\<`abi`\> ## Returns -`DecodeErrorResultReturnType`\<`TAbi`\> +`DecodeErrorResultReturnType`\<`abi`\> ## Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/abi/decodeErrorResult.d.ts:26 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/abi/decodeErrorResult.d.ts:26 diff --git a/tevm/docs/index/functions/decodeEventLog.md b/tevm/docs/index/functions/decodeEventLog.md index 5f6f424e7f..a3467a77c0 100644 --- a/tevm/docs/index/functions/decodeEventLog.md +++ b/tevm/docs/index/functions/decodeEventLog.md @@ -30,4 +30,4 @@ ## Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/abi/decodeEventLog.d.ts:32 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/abi/decodeEventLog.d.ts:32 diff --git a/tevm/docs/index/functions/decodeFunctionData.md b/tevm/docs/index/functions/decodeFunctionData.md index 4443a30058..855d69172b 100644 --- a/tevm/docs/index/functions/decodeFunctionData.md +++ b/tevm/docs/index/functions/decodeFunctionData.md @@ -6,7 +6,7 @@ # Function: decodeFunctionData() -> **decodeFunctionData**\<`abi`\>(`parameters`): `DecodeFunctionDataReturnType`\<`abi`, [`ContractFunctionName`](../type-aliases/ContractFunctionName.md)\<`abi`, `AbiStateMutability`\>\> +> **decodeFunctionData**\<`abi`\>(`parameters`): `DecodeFunctionDataReturnType`\<`abi`\> ## Type Parameters @@ -18,8 +18,8 @@ ## Returns -`DecodeFunctionDataReturnType`\<`abi`, [`ContractFunctionName`](../type-aliases/ContractFunctionName.md)\<`abi`, `AbiStateMutability`\>\> +`DecodeFunctionDataReturnType`\<`abi`\> ## Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/abi/decodeFunctionData.d.ts:25 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/abi/decodeFunctionData.d.ts:25 diff --git a/tevm/docs/index/functions/decodeFunctionResult.md b/tevm/docs/index/functions/decodeFunctionResult.md index 709a09875f..d7edb47a2c 100644 --- a/tevm/docs/index/functions/decodeFunctionResult.md +++ b/tevm/docs/index/functions/decodeFunctionResult.md @@ -26,4 +26,4 @@ ## Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/abi/decodeFunctionResult.d.ts:25 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/abi/decodeFunctionResult.d.ts:25 diff --git a/tevm/docs/index/functions/definePredeploy.md b/tevm/docs/index/functions/definePredeploy.md index 210ac44a06..6d1b82b3ee 100644 --- a/tevm/docs/index/functions/definePredeploy.md +++ b/tevm/docs/index/functions/definePredeploy.md @@ -24,28 +24,6 @@ Defines a predeploy contract to use in the tevm vm [`Predeploy`](../type-aliases/Predeploy.md)\<`TName`, `THumanReadableAbi`\> -## Example - -```ts -import { definePredeploy } from 'tevm/predeploys' -import { createMemoryClient } from 'tevm/vm' -import { createContract } from 'tevm/contract' - -const predeploy = definePredeploy({ - address: `0x${'23'.repeat(20)}`, - contract: createContract({ - name: 'PredeployExample', - humanReadableAbi: ['function foo() external pure returns (uint256)'], - bytecode: '0x608060405234801561001057600080fd5b5061012f806100206000396000f3fe608060405260043610610041576000357c0100', - deployedBytecode: '0x608060405260043610610041576000357c010000 - }) -}) - -const vm = createMemoryClient({ - predeploys: [predeploy.predeploy()], -}) -``` - ## Defined in packages/predeploys/types/definePredeploy.d.ts:25 diff --git a/tevm/docs/index/functions/encodeAbiParameters.md b/tevm/docs/index/functions/encodeAbiParameters.md index ee859e48a7..945cc74853 100644 --- a/tevm/docs/index/functions/encodeAbiParameters.md +++ b/tevm/docs/index/functions/encodeAbiParameters.md @@ -6,19 +6,19 @@ # Function: encodeAbiParameters() -> **encodeAbiParameters**\<`TParams`\>(`params`, `values`): `EncodeAbiParametersReturnType` +> **encodeAbiParameters**\<`params`\>(`params`, `values`): `EncodeAbiParametersReturnType` ## Type Parameters -• **TParams** *extends* readonly `unknown`[] \| readonly `AbiParameter`[] +• **params** *extends* readonly `unknown`[] \| readonly `AbiParameter`[] -## Parameters +a set of ABI Parameters (params), that can be in the shape of the inputs or outputs attribute of an ABI Item. -• **params**: `TParams` +## Parameters -a set of ABI Parameters (params), that can be in the shape of the inputs or outputs attribute of an ABI Item. +• **params**: `params` -• **values**: `TParams` *extends* readonly `AbiParameter`[] ? \{ \[K in string \| number \| symbol\]: \{ \[K in string \| number \| symbol\]: AbiParameterToPrimitiveType\\[K\\], AbiParameterKind\> \}\[K\] \} : `never` +• **values**: `params` *extends* readonly `AbiParameter`[] ? \{ \[key in string \| number \| symbol\]: \{ \[key in string \| number \| symbol\]: AbiParameterToPrimitiveType\\[key\\], AbiParameterKind\> \}\[key\] \} : `never` a set of values (values) that correspond to the given params. @@ -62,4 +62,4 @@ const encodedData = encodeAbiParameters( ## Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/abi/encodeAbiParameters.d.ts:49 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/abi/encodeAbiParameters.d.ts:49 diff --git a/tevm/docs/index/functions/encodeDeployData.md b/tevm/docs/index/functions/encodeDeployData.md index 39869e2021..b4efb1522c 100644 --- a/tevm/docs/index/functions/encodeDeployData.md +++ b/tevm/docs/index/functions/encodeDeployData.md @@ -22,4 +22,4 @@ ## Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/abi/encodeDeployData.d.ts:23 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/abi/encodeDeployData.d.ts:23 diff --git a/tevm/docs/index/functions/encodeErrorResult.md b/tevm/docs/index/functions/encodeErrorResult.md index 80546f4f3c..9d378b420d 100644 --- a/tevm/docs/index/functions/encodeErrorResult.md +++ b/tevm/docs/index/functions/encodeErrorResult.md @@ -24,4 +24,4 @@ ## Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/abi/encodeErrorResult.d.ts:23 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/abi/encodeErrorResult.d.ts:23 diff --git a/tevm/docs/index/functions/encodeEventTopics.md b/tevm/docs/index/functions/encodeEventTopics.md index da8491fee6..a38453ba50 100644 --- a/tevm/docs/index/functions/encodeEventTopics.md +++ b/tevm/docs/index/functions/encodeEventTopics.md @@ -6,7 +6,7 @@ # Function: encodeEventTopics() -> **encodeEventTopics**\<`abi`, `eventName`\>(`parameters`): \`0x$\{string\}\`[] +> **encodeEventTopics**\<`abi`, `eventName`\>(`parameters`): `EncodeEventTopicsReturnType` ## Type Parameters @@ -20,8 +20,8 @@ ## Returns -\`0x$\{string\}\`[] +`EncodeEventTopicsReturnType` ## Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/abi/encodeEventTopics.d.ts:24 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/abi/encodeEventTopics.d.ts:26 diff --git a/tevm/docs/index/functions/encodeFunctionData.md b/tevm/docs/index/functions/encodeFunctionData.md index 7acfcad73d..69b660820c 100644 --- a/tevm/docs/index/functions/encodeFunctionData.md +++ b/tevm/docs/index/functions/encodeFunctionData.md @@ -24,4 +24,4 @@ ## Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/abi/encodeFunctionData.d.ts:27 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/abi/encodeFunctionData.d.ts:27 diff --git a/tevm/docs/index/functions/encodeFunctionResult.md b/tevm/docs/index/functions/encodeFunctionResult.md index 399f3556df..a799af17cd 100644 --- a/tevm/docs/index/functions/encodeFunctionResult.md +++ b/tevm/docs/index/functions/encodeFunctionResult.md @@ -24,4 +24,4 @@ ## Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/abi/encodeFunctionResult.d.ts:21 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/abi/encodeFunctionResult.d.ts:21 diff --git a/tevm/docs/index/functions/encodePacked.md b/tevm/docs/index/functions/encodePacked.md index 70b67cec92..a0128cb370 100644 --- a/tevm/docs/index/functions/encodePacked.md +++ b/tevm/docs/index/functions/encodePacked.md @@ -6,17 +6,17 @@ # Function: encodePacked() -> **encodePacked**\<`TPackedAbiTypes`\>(`types`, `values`): [`Hex`](../type-aliases/Hex.md) +> **encodePacked**\<`packedAbiTypes`\>(`types`, `values`): [`Hex`](../type-aliases/Hex.md) ## Type Parameters -• **TPackedAbiTypes** *extends* readonly `unknown`[] \| readonly `PackedAbiType`[] +• **packedAbiTypes** *extends* readonly `unknown`[] \| readonly `PackedAbiType`[] ## Parameters -• **types**: `TPackedAbiTypes` +• **types**: `packedAbiTypes` -• **values**: `EncodePackedValues`\<`TPackedAbiTypes`\> +• **values**: `EncodePackedValues`\<`packedAbiTypes`\> ## Returns @@ -24,4 +24,4 @@ ## Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/abi/encodePacked.d.ts:17 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/abi/encodePacked.d.ts:17 diff --git a/tevm/docs/index/functions/formatAbi.md b/tevm/docs/index/functions/formatAbi.md index 858095197a..56b3b44f91 100644 --- a/tevm/docs/index/functions/formatAbi.md +++ b/tevm/docs/index/functions/formatAbi.md @@ -28,4 +28,4 @@ Human-readable ABI ## Defined in -node\_modules/.pnpm/abitype@1.0.4\_typescript@5.5.4\_zod@3.23.8/node\_modules/abitype/dist/types/human-readable/formatAbi.d.ts:18 +node\_modules/.pnpm/abitype@1.0.6\_typescript@5.5.4\_zod@3.23.8/node\_modules/abitype/dist/types/human-readable/formatAbi.d.ts:18 diff --git a/tevm/docs/index/functions/formatEther.md b/tevm/docs/index/functions/formatEther.md index 8f38af8574..b9d49a8e90 100644 --- a/tevm/docs/index/functions/formatEther.md +++ b/tevm/docs/index/functions/formatEther.md @@ -33,4 +33,4 @@ formatEther(1000000000000000000n) ## Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/unit/formatEther.d.ts:14 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/unit/formatEther.d.ts:14 diff --git a/tevm/docs/index/functions/formatGwei.md b/tevm/docs/index/functions/formatGwei.md index c165b91774..1c146e83f3 100644 --- a/tevm/docs/index/functions/formatGwei.md +++ b/tevm/docs/index/functions/formatGwei.md @@ -33,4 +33,4 @@ formatGwei(1000000000n) ## Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/unit/formatGwei.d.ts:14 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/unit/formatGwei.d.ts:14 diff --git a/tevm/docs/index/functions/formatLog.md b/tevm/docs/index/functions/formatLog.md index 2022427238..48de5769f4 100644 --- a/tevm/docs/index/functions/formatLog.md +++ b/tevm/docs/index/functions/formatLog.md @@ -24,4 +24,4 @@ ## Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/formatters/log.d.ts:6 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/formatters/log.d.ts:6 diff --git a/tevm/docs/index/functions/fromBytes.md b/tevm/docs/index/functions/fromBytes.md index 9c9f1cbbea..82ecad2f05 100644 --- a/tevm/docs/index/functions/fromBytes.md +++ b/tevm/docs/index/functions/fromBytes.md @@ -6,7 +6,7 @@ # Function: fromBytes() -> **fromBytes**\<`TTo`\>(`bytes`, `toOrOpts`): `FromBytesReturnType`\<`TTo`\> +> **fromBytes**\<`to`\>(`bytes`, `toOrOpts`): `FromBytesReturnType`\<`to`\> Decodes a byte array into a UTF-8 string, hex value, number, bigint or boolean. @@ -15,7 +15,7 @@ Decodes a byte array into a UTF-8 string, hex value, number, bigint or boolean. ## Type Parameters -• **TTo** *extends* `"string"` \| `"number"` \| `"bigint"` \| `"boolean"` \| `"hex"` +• **to** *extends* `"string"` \| `"number"` \| `"bigint"` \| `"boolean"` \| `"hex"` ## Parameters @@ -23,13 +23,13 @@ Decodes a byte array into a UTF-8 string, hex value, number, bigint or boolean. Byte array to decode. -• **toOrOpts**: `FromBytesParameters`\<`TTo`\> +• **toOrOpts**: `FromBytesParameters`\<`to`\> Type to convert to or options. ## Returns -`FromBytesReturnType`\<`TTo`\> +`FromBytesReturnType`\<`to`\> Decoded value. @@ -52,4 +52,4 @@ const data = fromBytes( ## Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/encoding/fromBytes.d.ts:37 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/encoding/fromBytes.d.ts:37 diff --git a/tevm/docs/index/functions/fromHex.md b/tevm/docs/index/functions/fromHex.md index 868cf4238d..17e817e0f2 100644 --- a/tevm/docs/index/functions/fromHex.md +++ b/tevm/docs/index/functions/fromHex.md @@ -6,7 +6,7 @@ # Function: fromHex() -> **fromHex**\<`TTo`\>(`hex`, `toOrOpts`): `FromHexReturnType`\<`TTo`\> +> **fromHex**\<`to`\>(`hex`, `toOrOpts`): `FromHexReturnType`\<`to`\> Decodes a hex string into a string, number, bigint, boolean, or byte array. @@ -15,7 +15,7 @@ Decodes a hex string into a string, number, bigint, boolean, or byte array. ## Type Parameters -• **TTo** *extends* `"string"` \| `"number"` \| `"bigint"` \| `"boolean"` \| `"bytes"` +• **to** *extends* `"string"` \| `"number"` \| `"bigint"` \| `"boolean"` \| `"bytes"` ## Parameters @@ -23,13 +23,13 @@ Decodes a hex string into a string, number, bigint, boolean, or byte array. Hex string to decode. -• **toOrOpts**: `FromHexParameters`\<`TTo`\> +• **toOrOpts**: `FromHexParameters`\<`to`\> Type to convert to or options. ## Returns -`FromHexReturnType`\<`TTo`\> +`FromHexReturnType`\<`to`\> Decoded value. @@ -58,4 +58,4 @@ const data = fromHex('0x48656c6c6f20576f726c642100000000000000000000000000000000 ## Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/encoding/fromHex.d.ts:47 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/encoding/fromHex.d.ts:47 diff --git a/tevm/docs/index/functions/fromRlp.md b/tevm/docs/index/functions/fromRlp.md index 88964d90a9..f232742bc8 100644 --- a/tevm/docs/index/functions/fromRlp.md +++ b/tevm/docs/index/functions/fromRlp.md @@ -24,4 +24,4 @@ ## Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/encoding/fromRlp.d.ts:12 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/encoding/fromRlp.d.ts:12 diff --git a/tevm/docs/index/functions/getAddress.md b/tevm/docs/index/functions/getAddress.md index ec4db068e6..0c3ef00525 100644 --- a/tevm/docs/index/functions/getAddress.md +++ b/tevm/docs/index/functions/getAddress.md @@ -29,4 +29,4 @@ See more: https://github.com/ethereum/EIPs/issues/1121 ## Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/address/getAddress.d.ts:20 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/address/getAddress.d.ts:20 diff --git a/tevm/docs/index/functions/hexToBigInt.md b/tevm/docs/index/functions/hexToBigInt.md index 47bf2400f6..10d1d2fc6f 100644 --- a/tevm/docs/index/functions/hexToBigInt.md +++ b/tevm/docs/index/functions/hexToBigInt.md @@ -44,4 +44,4 @@ const data = hexToBigInt('0x0000000000000000000000000000000000000000000000000000 ## Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/encoding/fromHex.d.ts:74 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/encoding/fromHex.d.ts:74 diff --git a/tevm/docs/index/functions/hexToBool.md b/tevm/docs/index/functions/hexToBool.md index d63c465e0d..2ae766df53 100644 --- a/tevm/docs/index/functions/hexToBool.md +++ b/tevm/docs/index/functions/hexToBool.md @@ -42,4 +42,4 @@ const data = hexToBool('0x000000000000000000000000000000000000000000000000000000 ## Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/encoding/fromHex.d.ts:99 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/encoding/fromHex.d.ts:99 diff --git a/tevm/docs/index/functions/hexToBytes.md b/tevm/docs/index/functions/hexToBytes.md index 68001f500a..a7dcbc2587 100644 --- a/tevm/docs/index/functions/hexToBytes.md +++ b/tevm/docs/index/functions/hexToBytes.md @@ -42,4 +42,4 @@ const data = hexToBytes('0x48656c6c6f20776f726c6421', { size: 32 }) ## Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/encoding/toBytes.d.ts:87 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/encoding/toBytes.d.ts:87 diff --git a/tevm/docs/index/functions/hexToNumber.md b/tevm/docs/index/functions/hexToNumber.md index 93d2c2d48e..bc573f014f 100644 --- a/tevm/docs/index/functions/hexToNumber.md +++ b/tevm/docs/index/functions/hexToNumber.md @@ -44,4 +44,4 @@ const data = hexToBigInt('0x0000000000000000000000000000000000000000000000000000 ## Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/encoding/fromHex.d.ts:121 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/encoding/fromHex.d.ts:121 diff --git a/tevm/docs/index/functions/hexToString.md b/tevm/docs/index/functions/hexToString.md index 093ec716e2..72befdc6d9 100644 --- a/tevm/docs/index/functions/hexToString.md +++ b/tevm/docs/index/functions/hexToString.md @@ -46,4 +46,4 @@ const data = hexToString('0x48656c6c6f20576f726c64210000000000000000000000000000 ## Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/encoding/fromHex.d.ts:148 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/encoding/fromHex.d.ts:148 diff --git a/tevm/docs/index/functions/http.md b/tevm/docs/index/functions/http.md index de369830f5..66c516722b 100644 --- a/tevm/docs/index/functions/http.md +++ b/tevm/docs/index/functions/http.md @@ -26,4 +26,4 @@ Creates a HTTP transport that connects to a JSON-RPC API. ## Defined in -node\_modules/.pnpm/viem@2.16.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/clients/transports/http.d.ts:44 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/clients/transports/http.d.ts:44 diff --git a/tevm/docs/index/functions/isAddress.md b/tevm/docs/index/functions/isAddress.md index d31ff78df0..23cfd5caac 100644 --- a/tevm/docs/index/functions/isAddress.md +++ b/tevm/docs/index/functions/isAddress.md @@ -20,4 +20,4 @@ address is \`0x$\{string\}\` ## Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/address/isAddress.d.ts:15 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/address/isAddress.d.ts:15 diff --git a/tevm/docs/index/functions/isBytes.md b/tevm/docs/index/functions/isBytes.md index 18a27daae5..58879bcf86 100644 --- a/tevm/docs/index/functions/isBytes.md +++ b/tevm/docs/index/functions/isBytes.md @@ -18,4 +18,4 @@ ## Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/data/isBytes.d.ts:4 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/data/isBytes.d.ts:4 diff --git a/tevm/docs/index/functions/isHex.md b/tevm/docs/index/functions/isHex.md index d98d1034b6..250dc0a94d 100644 --- a/tevm/docs/index/functions/isHex.md +++ b/tevm/docs/index/functions/isHex.md @@ -22,4 +22,4 @@ value is \`0x$\{string\}\` ## Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/data/isHex.d.ts:4 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/data/isHex.d.ts:4 diff --git a/tevm/docs/index/functions/keccak256.md b/tevm/docs/index/functions/keccak256.md index 863c552389..d31788f0ab 100644 --- a/tevm/docs/index/functions/keccak256.md +++ b/tevm/docs/index/functions/keccak256.md @@ -6,22 +6,22 @@ # Function: keccak256() -> **keccak256**\<`TTo`\>(`value`, `to_`?): `Keccak256Hash`\<`TTo`\> +> **keccak256**\<`to`\>(`value`, `to_`?): `Keccak256Hash`\<`to`\> ## Type Parameters -• **TTo** *extends* `To` = `"hex"` +• **to** *extends* `To` = `"hex"` ## Parameters • **value**: \`0x$\{string\}\` \| `Uint8Array` -• **to\_?**: `TTo` +• **to\_?**: `to` ## Returns -`Keccak256Hash`\<`TTo`\> +`Keccak256Hash`\<`to`\> ## Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/hash/keccak256.d.ts:9 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/hash/keccak256.d.ts:9 diff --git a/tevm/docs/index/functions/loadBalance.md b/tevm/docs/index/functions/loadBalance.md index 0736458880..387926ee38 100644 --- a/tevm/docs/index/functions/loadBalance.md +++ b/tevm/docs/index/functions/loadBalance.md @@ -16,10 +16,6 @@ `Transport` -## Description - -Creates a load balanced transport that spreads requests between child transports using a round robin algorithm. - ## Defined in -node\_modules/.pnpm/@ponder+utils@0.1.6\_typescript@5.5.4\_viem@2.16.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8\_/node\_modules/@ponder/utils/dist/index.d.ts:44 +node\_modules/.pnpm/@ponder+utils@0.1.7\_typescript@5.5.4\_viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8\_/node\_modules/@ponder/utils/dist/index.d.ts:44 diff --git a/tevm/docs/index/functions/mnemonicToAccount.md b/tevm/docs/index/functions/mnemonicToAccount.md index 94bb9b4b63..d2c0c6c9ff 100644 --- a/tevm/docs/index/functions/mnemonicToAccount.md +++ b/tevm/docs/index/functions/mnemonicToAccount.md @@ -26,4 +26,4 @@ Creates an Account from a mnemonic phrase. ## Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/accounts/mnemonicToAccount.d.ts:10 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/accounts/mnemonicToAccount.d.ts:11 diff --git a/tevm/docs/index/functions/numberToHex.md b/tevm/docs/index/functions/numberToHex.md index 60fd85786d..7f4170d2f6 100644 --- a/tevm/docs/index/functions/numberToHex.md +++ b/tevm/docs/index/functions/numberToHex.md @@ -42,4 +42,4 @@ const data = numberToHex(420, { size: 32 }) ## Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/encoding/toHex.d.ts:122 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/encoding/toHex.d.ts:122 diff --git a/tevm/docs/index/functions/parseAbi.md b/tevm/docs/index/functions/parseAbi.md index 3682f1817c..fac1e6b65c 100644 --- a/tevm/docs/index/functions/parseAbi.md +++ b/tevm/docs/index/functions/parseAbi.md @@ -38,4 +38,4 @@ const abi = parseAbi([ ## Defined in -node\_modules/.pnpm/abitype@1.0.4\_typescript@5.5.4\_zod@3.23.8/node\_modules/abitype/dist/types/human-readable/parseAbi.d.ts:37 +node\_modules/.pnpm/abitype@1.0.6\_typescript@5.5.4\_zod@3.23.8/node\_modules/abitype/dist/types/human-readable/parseAbi.d.ts:37 diff --git a/tevm/docs/index/functions/parseEther.md b/tevm/docs/index/functions/parseEther.md index 80a6595e51..63df0b7452 100644 --- a/tevm/docs/index/functions/parseEther.md +++ b/tevm/docs/index/functions/parseEther.md @@ -33,4 +33,4 @@ parseEther('420') ## Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/unit/parseEther.d.ts:15 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/unit/parseEther.d.ts:15 diff --git a/tevm/docs/index/functions/parseGwei.md b/tevm/docs/index/functions/parseGwei.md index 8e258af7b4..eb91c6f4c8 100644 --- a/tevm/docs/index/functions/parseGwei.md +++ b/tevm/docs/index/functions/parseGwei.md @@ -33,4 +33,4 @@ parseGwei('420') ## Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/unit/parseGwei.d.ts:15 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/unit/parseGwei.d.ts:15 diff --git a/tevm/docs/index/functions/publicActions.md b/tevm/docs/index/functions/publicActions.md index a5ac0d0b00..b661a7aa48 100644 --- a/tevm/docs/index/functions/publicActions.md +++ b/tevm/docs/index/functions/publicActions.md @@ -6,24 +6,24 @@ # Function: publicActions() -> **publicActions**\<`TTransport`, `TChain`, `TAccount`\>(`client`): `PublicActions`\<`TTransport`, `TChain`, `TAccount`\> +> **publicActions**\<`transport`, `chain`, `account`\>(`client`): `PublicActions`\<`transport`, `chain`, `account`\> ## Type Parameters -• **TTransport** *extends* `Transport` = `Transport` +• **transport** *extends* `Transport` = `Transport` -• **TChain** *extends* `undefined` \| `Chain` = `undefined` \| `Chain` +• **chain** *extends* `undefined` \| `Chain` = `undefined` \| `Chain` -• **TAccount** *extends* `undefined` \| `Account` = `undefined` \| `Account` +• **account** *extends* `undefined` \| [`Account`](../type-aliases/Account.md) = `undefined` \| [`Account`](../type-aliases/Account.md) ## Parameters -• **client**: `Client`\<`TTransport`, `TChain`, `TAccount`\> +• **client**: `Client`\<`transport`, `chain`, `account`\> ## Returns -`PublicActions`\<`TTransport`, `TChain`, `TAccount`\> +`PublicActions`\<`transport`, `chain`, `account`\> ## Defined in -node\_modules/.pnpm/viem@2.16.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/clients/decorators/public.d.ts:1339 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/clients/decorators/public.d.ts:1339 diff --git a/tevm/docs/index/functions/rateLimit.md b/tevm/docs/index/functions/rateLimit.md index 02314d78ee..df35e3b2d9 100644 --- a/tevm/docs/index/functions/rateLimit.md +++ b/tevm/docs/index/functions/rateLimit.md @@ -22,10 +22,6 @@ `Transport` -## Description - -Creates a rate limited transport that throttles request throughput. - ## Defined in -node\_modules/.pnpm/@ponder+utils@0.1.6\_typescript@5.5.4\_viem@2.16.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8\_/node\_modules/@ponder/utils/dist/index.d.ts:49 +node\_modules/.pnpm/@ponder+utils@0.1.7\_typescript@5.5.4\_viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8\_/node\_modules/@ponder/utils/dist/index.d.ts:49 diff --git a/tevm/docs/index/functions/stringToHex.md b/tevm/docs/index/functions/stringToHex.md index 71666bcb2c..9ef8026b45 100644 --- a/tevm/docs/index/functions/stringToHex.md +++ b/tevm/docs/index/functions/stringToHex.md @@ -42,4 +42,4 @@ const data = stringToHex('Hello World!', { size: 32 }) ## Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/encoding/toHex.d.ts:147 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/encoding/toHex.d.ts:147 diff --git a/tevm/docs/index/functions/testActions.md b/tevm/docs/index/functions/testActions.md index 2c4d362c28..9340a76329 100644 --- a/tevm/docs/index/functions/testActions.md +++ b/tevm/docs/index/functions/testActions.md @@ -6,17 +6,17 @@ # Function: testActions() -> **testActions**\<`TMode`\>(`__namedParameters`): \<`TTransport`, `TChain`, `TAccount`\>(`client`) => `TestActions` +> **testActions**\<`mode`\>(`__namedParameters`): \<`transport`, `chain`, `account`\>(`client`) => `TestActions` ## Type Parameters -• **TMode** *extends* `TestClientMode` +• **mode** *extends* `TestClientMode` ## Parameters • **\_\_namedParameters** -• **\_\_namedParameters.mode**: `TMode` +• **\_\_namedParameters.mode**: `mode` ## Returns @@ -24,15 +24,15 @@ ### Type Parameters -• **TTransport** *extends* `Transport` = `Transport` +• **transport** *extends* `Transport` = `Transport` -• **TChain** *extends* `Chain` \| `undefined` = `Chain` \| `undefined` +• **chain** *extends* `Chain` \| `undefined` = `Chain` \| `undefined` -• **TAccount** *extends* `Account` \| `undefined` = `Account` \| `undefined` +• **account** *extends* [`Account`](../type-aliases/Account.md) \| `undefined` = [`Account`](../type-aliases/Account.md) \| `undefined` ### Parameters -• **client**: `Client`\<`TTransport`, `TChain`, `TAccount`\> +• **client**: `Client`\<`transport`, `chain`, `account`\> ### Returns @@ -40,4 +40,4 @@ ## Defined in -node\_modules/.pnpm/viem@2.16.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/clients/decorators/test.d.ts:637 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/clients/decorators/test.d.ts:637 diff --git a/tevm/docs/index/functions/tevmCall.md b/tevm/docs/index/functions/tevmCall.md index 2de74394bc..e36abbbfcf 100644 --- a/tevm/docs/index/functions/tevmCall.md +++ b/tevm/docs/index/functions/tevmCall.md @@ -10,7 +10,7 @@ ## Parameters -• **client**: `Client`\<[`TevmTransport`](../type-aliases/TevmTransport.md)\<`string`\>, `undefined` \| `Chain`, `undefined` \| `Account`, `undefined`, `undefined` \| `object`\> +• **client**: `Client`\<[`TevmTransport`](../type-aliases/TevmTransport.md)\<`string`\>, `undefined` \| `Chain`, `undefined` \| [`Account`](../type-aliases/Account.md), `undefined`, `undefined` \| `object`\> • **params**: [`CallParams`](../type-aliases/CallParams.md)\<`boolean`\> diff --git a/tevm/docs/index/functions/tevmContract.md b/tevm/docs/index/functions/tevmContract.md index a8874b2462..f21a784ddd 100644 --- a/tevm/docs/index/functions/tevmContract.md +++ b/tevm/docs/index/functions/tevmContract.md @@ -29,40 +29,6 @@ Internally, `tevmContract` wraps `tevmCall`. It automatically encodes and decode `Promise`\<[`ContractResult`](../type-aliases/ContractResult.md)\<`TAbi`, `TFunctionName`\>\> -## Example - -```typescript -import { tevmContract } from 'tevm/actions' -import { createClient, http } from 'viem' -import { optimism } from 'tevm/common' -import { createTevmTransport } from 'tevm' - -const client = createClient({ - transport: createTevmTransport({ - fork: { transport: http('https://mainnet.optimism.io')({}) } - }), - chain: optimism, -}) - -async function example() { - const res = await tevmContract(client, { - abi: [...], - functionName: 'myFunction', - args: [...], - }) - console.log(res) -} - -example() -``` - -## See - - - [ContractParams](https://tevm.sh/reference/tevm/actions/type-aliases/contractparams/) for options reference. - - [ContractResult](https://tevm.sh/reference/tevm/actions/type-aliases/contractresult/) for return values reference. - - [BaseCallParams](https://tevm.sh/reference/tevm/actions/type-aliases/basecallparams-1/) for the base call parameters. - - [TEVM Actions Guide](https://tevm.sh/learn/actions/) - ## Defined in packages/memory-client/types/tevmContract.d.ts:39 diff --git a/tevm/docs/index/functions/tevmDeploy.md b/tevm/docs/index/functions/tevmDeploy.md index e7c19cc1c7..37e3c50802 100644 --- a/tevm/docs/index/functions/tevmDeploy.md +++ b/tevm/docs/index/functions/tevmDeploy.md @@ -10,7 +10,7 @@ ## Parameters -• **client**: `Client`\<[`TevmTransport`](../type-aliases/TevmTransport.md)\<`string`\>, `undefined` \| `Chain`, `undefined` \| `Account`, `undefined`, `undefined` \| `object`\> +• **client**: `Client`\<[`TevmTransport`](../type-aliases/TevmTransport.md)\<`string`\>, `undefined` \| `Chain`, `undefined` \| [`Account`](../type-aliases/Account.md), `undefined`, `undefined` \| `object`\> • **params**: [`DeployParams`](../type-aliases/DeployParams.md)\<`boolean`, [`Abi`](../type-aliases/Abi.md), `true`, readonly `unknown`[]\> diff --git a/tevm/docs/index/functions/tevmDumpState.md b/tevm/docs/index/functions/tevmDumpState.md index e9b7f80d7d..739ecd66df 100644 --- a/tevm/docs/index/functions/tevmDumpState.md +++ b/tevm/docs/index/functions/tevmDumpState.md @@ -10,7 +10,7 @@ ## Parameters -• **client**: `Client`\<[`TevmTransport`](../type-aliases/TevmTransport.md)\<`string`\>, `undefined` \| `Chain`, `undefined` \| `Account`, `undefined`, `undefined` \| `object`\> +• **client**: `Client`\<[`TevmTransport`](../type-aliases/TevmTransport.md)\<`string`\>, `undefined` \| `Chain`, `undefined` \| [`Account`](../type-aliases/Account.md), `undefined`, `undefined` \| `object`\> ## Returns diff --git a/tevm/docs/index/functions/tevmGetAccount.md b/tevm/docs/index/functions/tevmGetAccount.md index 86322ad0d2..c691d4f0cf 100644 --- a/tevm/docs/index/functions/tevmGetAccount.md +++ b/tevm/docs/index/functions/tevmGetAccount.md @@ -10,7 +10,7 @@ ## Parameters -• **client**: `Client`\<[`TevmTransport`](../type-aliases/TevmTransport.md)\<`string`\>, `undefined` \| `Chain`, `undefined` \| `Account`, `undefined`, `undefined` \| `object`\> +• **client**: `Client`\<[`TevmTransport`](../type-aliases/TevmTransport.md)\<`string`\>, `undefined` \| `Chain`, `undefined` \| [`Account`](../type-aliases/Account.md), `undefined`, `undefined` \| `object`\> • **params**: [`GetAccountParams`](../type-aliases/GetAccountParams.md)\<`boolean`\> diff --git a/tevm/docs/index/functions/tevmLoadState.md b/tevm/docs/index/functions/tevmLoadState.md index 2bb8b50292..99c0258859 100644 --- a/tevm/docs/index/functions/tevmLoadState.md +++ b/tevm/docs/index/functions/tevmLoadState.md @@ -10,7 +10,7 @@ ## Parameters -• **client**: `Client`\<[`TevmTransport`](../type-aliases/TevmTransport.md)\<`string`\>, `undefined` \| `Chain`, `undefined` \| `Account`, `undefined`, `undefined` \| `object`\> +• **client**: `Client`\<[`TevmTransport`](../type-aliases/TevmTransport.md)\<`string`\>, `undefined` \| `Chain`, `undefined` \| [`Account`](../type-aliases/Account.md), `undefined`, `undefined` \| `object`\> • **params**: `LoadStateParams`\<`boolean`\> diff --git a/tevm/docs/index/functions/tevmMine.md b/tevm/docs/index/functions/tevmMine.md index 3eaf4a07ff..3f49e3cef6 100644 --- a/tevm/docs/index/functions/tevmMine.md +++ b/tevm/docs/index/functions/tevmMine.md @@ -10,7 +10,7 @@ ## Parameters -• **client**: `Client`\<[`TevmTransport`](../type-aliases/TevmTransport.md)\<`string`\>, `undefined` \| `Chain`, `undefined` \| `Account`, `undefined`, `undefined` \| `object`\> +• **client**: `Client`\<[`TevmTransport`](../type-aliases/TevmTransport.md)\<`string`\>, `undefined` \| `Chain`, `undefined` \| [`Account`](../type-aliases/Account.md), `undefined`, `undefined` \| `object`\> • **params?**: [`MineParams`](../type-aliases/MineParams.md)\<`boolean`\> diff --git a/tevm/docs/index/functions/tevmReady.md b/tevm/docs/index/functions/tevmReady.md index 7abf711a68..a5ac805618 100644 --- a/tevm/docs/index/functions/tevmReady.md +++ b/tevm/docs/index/functions/tevmReady.md @@ -10,7 +10,7 @@ ## Parameters -• **client**: `Client`\<[`TevmTransport`](../type-aliases/TevmTransport.md)\<`string`\>, `undefined` \| `Chain`, `undefined` \| `Account`, `undefined`, `undefined` \| `object`\> +• **client**: `Client`\<[`TevmTransport`](../type-aliases/TevmTransport.md)\<`string`\>, `undefined` \| `Chain`, `undefined` \| [`Account`](../type-aliases/Account.md), `undefined`, `undefined` \| `object`\> ## Returns diff --git a/tevm/docs/index/functions/tevmSetAccount.md b/tevm/docs/index/functions/tevmSetAccount.md index cc6a5b3a94..460025e349 100644 --- a/tevm/docs/index/functions/tevmSetAccount.md +++ b/tevm/docs/index/functions/tevmSetAccount.md @@ -10,7 +10,7 @@ ## Parameters -• **client**: `Client`\<[`TevmTransport`](../type-aliases/TevmTransport.md)\<`string`\>, `undefined` \| `Chain`, `undefined` \| `Account`, `undefined`, `undefined` \| `object`\> +• **client**: `Client`\<[`TevmTransport`](../type-aliases/TevmTransport.md)\<`string`\>, `undefined` \| `Chain`, `undefined` \| [`Account`](../type-aliases/Account.md), `undefined`, `undefined` \| `object`\> • **params**: [`SetAccountParams`](../type-aliases/SetAccountParams.md)\<`boolean`\> diff --git a/tevm/docs/index/functions/toBytes.md b/tevm/docs/index/functions/toBytes.md index efccc04ee3..96a171d199 100644 --- a/tevm/docs/index/functions/toBytes.md +++ b/tevm/docs/index/functions/toBytes.md @@ -51,4 +51,4 @@ const data = toBytes(420, { size: 4 }) ## Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/encoding/toBytes.d.ts:37 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/encoding/toBytes.d.ts:37 diff --git a/tevm/docs/index/functions/toHex.md b/tevm/docs/index/functions/toHex.md index 8255945153..2e49fe63fe 100644 --- a/tevm/docs/index/functions/toHex.md +++ b/tevm/docs/index/functions/toHex.md @@ -51,4 +51,4 @@ const data = toHex('Hello world', { size: 32 }) ## Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/encoding/toHex.d.ts:36 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/encoding/toHex.d.ts:36 diff --git a/tevm/docs/index/functions/toRlp.md b/tevm/docs/index/functions/toRlp.md index 6bd70ef7bf..1007355e98 100644 --- a/tevm/docs/index/functions/toRlp.md +++ b/tevm/docs/index/functions/toRlp.md @@ -24,4 +24,4 @@ ## Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/encoding/toRlp.d.ts:10 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/encoding/toRlp.d.ts:10 diff --git a/tevm/docs/index/functions/walletActions.md b/tevm/docs/index/functions/walletActions.md index c1db541c16..d0694d1827 100644 --- a/tevm/docs/index/functions/walletActions.md +++ b/tevm/docs/index/functions/walletActions.md @@ -6,24 +6,24 @@ # Function: walletActions() -> **walletActions**\<`TTransport`, `TChain`, `TAccount`\>(`client`): `WalletActions`\<`TChain`, `TAccount`\> +> **walletActions**\<`transport`, `chain`, `account`\>(`client`): `WalletActions`\<`chain`, `account`\> ## Type Parameters -• **TTransport** *extends* `Transport` +• **transport** *extends* `Transport` -• **TChain** *extends* `undefined` \| `Chain` = `undefined` \| `Chain` +• **chain** *extends* `undefined` \| `Chain` = `undefined` \| `Chain` -• **TAccount** *extends* `undefined` \| `Account` = `undefined` \| `Account` +• **account** *extends* `undefined` \| [`Account`](../type-aliases/Account.md) = `undefined` \| [`Account`](../type-aliases/Account.md) ## Parameters -• **client**: `Client`\<`TTransport`, `TChain`, `TAccount`\> +• **client**: `Client`\<`transport`, `chain`, `account`\> ## Returns -`WalletActions`\<`TChain`, `TAccount`\> +`WalletActions`\<`chain`, `account`\> ## Defined in -node\_modules/.pnpm/viem@2.16.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/clients/decorators/wallet.d.ts:560 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/clients/decorators/wallet.d.ts:560 diff --git a/tevm/docs/index/functions/webSocket.md b/tevm/docs/index/functions/webSocket.md index 5e1fa9788f..250c1c99dd 100644 --- a/tevm/docs/index/functions/webSocket.md +++ b/tevm/docs/index/functions/webSocket.md @@ -26,4 +26,4 @@ Creates a WebSocket transport that connects to a JSON-RPC API. ## Defined in -node\_modules/.pnpm/viem@2.16.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/clients/transports/webSocket.d.ts:54 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/clients/transports/webSocket.d.ts:59 diff --git a/tevm/docs/index/type-aliases/Abi.md b/tevm/docs/index/type-aliases/Abi.md index be6c5100e1..0dc829ac1e 100644 --- a/tevm/docs/index/type-aliases/Abi.md +++ b/tevm/docs/index/type-aliases/Abi.md @@ -12,4 +12,4 @@ Contract [ABI Specification](https://docs.soliditylang.org/en/latest/abi-spec.ht ## Defined in -node\_modules/.pnpm/abitype@1.0.4\_typescript@5.5.4\_zod@3.23.8/node\_modules/abitype/dist/types/abi.d.ts:121 +node\_modules/.pnpm/abitype@1.0.6\_typescript@5.5.4\_zod@3.23.8/node\_modules/abitype/dist/types/abi.d.ts:120 diff --git a/tevm/docs/index/type-aliases/AbiConstructor.md b/tevm/docs/index/type-aliases/AbiConstructor.md index c958bfd88c..621c43af54 100644 --- a/tevm/docs/index/type-aliases/AbiConstructor.md +++ b/tevm/docs/index/type-aliases/AbiConstructor.md @@ -38,4 +38,4 @@ https://github.com/ethereum/solidity/issues/992 ## Defined in -node\_modules/.pnpm/abitype@1.0.4\_typescript@5.5.4\_zod@3.23.8/node\_modules/abitype/dist/types/abi.d.ts:77 +node\_modules/.pnpm/abitype@1.0.6\_typescript@5.5.4\_zod@3.23.8/node\_modules/abitype/dist/types/abi.d.ts:77 diff --git a/tevm/docs/index/type-aliases/AbiEvent.md b/tevm/docs/index/type-aliases/AbiEvent.md index d1e38dce41..7184316826 100644 --- a/tevm/docs/index/type-aliases/AbiEvent.md +++ b/tevm/docs/index/type-aliases/AbiEvent.md @@ -30,4 +30,4 @@ ABI ["event"](https://docs.soliditylang.org/en/latest/abi-spec.html#events) type ## Defined in -node\_modules/.pnpm/abitype@1.0.4\_typescript@5.5.4\_zod@3.23.8/node\_modules/abitype/dist/types/abi.d.ts:104 +node\_modules/.pnpm/abitype@1.0.6\_typescript@5.5.4\_zod@3.23.8/node\_modules/abitype/dist/types/abi.d.ts:103 diff --git a/tevm/docs/index/type-aliases/AbiFunction.md b/tevm/docs/index/type-aliases/AbiFunction.md index 709820e94e..67552394a4 100644 --- a/tevm/docs/index/type-aliases/AbiFunction.md +++ b/tevm/docs/index/type-aliases/AbiFunction.md @@ -70,4 +70,4 @@ https://github.com/ethereum/solidity/issues/992 ## Defined in -node\_modules/.pnpm/abitype@1.0.4\_typescript@5.5.4\_zod@3.23.8/node\_modules/abitype/dist/types/abi.d.ts:54 +node\_modules/.pnpm/abitype@1.0.6\_typescript@5.5.4\_zod@3.23.8/node\_modules/abitype/dist/types/abi.d.ts:54 diff --git a/tevm/docs/index/type-aliases/AbiItemType.md b/tevm/docs/index/type-aliases/AbiItemType.md index 3f18390c10..7e225a4ee6 100644 --- a/tevm/docs/index/type-aliases/AbiItemType.md +++ b/tevm/docs/index/type-aliases/AbiItemType.md @@ -12,4 +12,4 @@ ## Defined in -node\_modules/.pnpm/abitype@1.0.4\_typescript@5.5.4\_zod@3.23.8/node\_modules/abitype/dist/types/abi.d.ts:117 +node\_modules/.pnpm/abitype@1.0.6\_typescript@5.5.4\_zod@3.23.8/node\_modules/abitype/dist/types/abi.d.ts:116 diff --git a/tevm/docs/index/type-aliases/AbiParametersToPrimitiveTypes.md b/tevm/docs/index/type-aliases/AbiParametersToPrimitiveTypes.md index 08693b6c5b..af42915143 100644 --- a/tevm/docs/index/type-aliases/AbiParametersToPrimitiveTypes.md +++ b/tevm/docs/index/type-aliases/AbiParametersToPrimitiveTypes.md @@ -22,4 +22,4 @@ Optional AbiParameterKind to narrow by parameter type ## Defined in -node\_modules/.pnpm/abitype@1.0.4\_typescript@5.5.4\_zod@3.23.8/node\_modules/abitype/dist/types/utils.d.ts:86 +node\_modules/.pnpm/abitype@1.0.6\_typescript@5.5.4\_zod@3.23.8/node\_modules/abitype/dist/types/utils.d.ts:86 diff --git a/tevm/docs/index/type-aliases/Account.md b/tevm/docs/index/type-aliases/Account.md index 6222f4d8f6..1408d25c94 100644 --- a/tevm/docs/index/type-aliases/Account.md +++ b/tevm/docs/index/type-aliases/Account.md @@ -4,14 +4,14 @@ [tevm](../../modules.md) / [index](../README.md) / Account -# Type Alias: Account\ +# Type Alias: Account\ -> **Account**\<`TAddress`\>: `OneOf`\<`JsonRpcAccount`\<`TAddress`\> \| `LocalAccount`\<`string`, `TAddress`\>\> +> **Account**\<`address`\>: `OneOf`\<`JsonRpcAccount`\<`address`\> \| `LocalAccount`\<`string`, `address`\> \| `SmartAccount`\> ## Type Parameters -• **TAddress** *extends* `Address` = `Address` +• **address** *extends* `Address` = `Address` ## Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/accounts/types.d.ts:9 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/accounts/types.d.ts:13 diff --git a/tevm/docs/index/type-aliases/Address.md b/tevm/docs/index/type-aliases/Address.md index 2c1bd06e60..d39ceafb3a 100644 --- a/tevm/docs/index/type-aliases/Address.md +++ b/tevm/docs/index/type-aliases/Address.md @@ -10,4 +10,4 @@ ## Defined in -node\_modules/.pnpm/abitype@1.0.4\_typescript@5.5.4\_zod@3.23.8/node\_modules/abitype/dist/types/abi.d.ts:3 +node\_modules/.pnpm/abitype@1.0.6\_typescript@5.5.4\_zod@3.23.8/node\_modules/abitype/dist/types/abi.d.ts:3 diff --git a/tevm/docs/index/type-aliases/AutoMining.md b/tevm/docs/index/type-aliases/AutoMining.md index 216c25054b..7ab88dc3c9 100644 --- a/tevm/docs/index/type-aliases/AutoMining.md +++ b/tevm/docs/index/type-aliases/AutoMining.md @@ -16,4 +16,4 @@ ## Defined in -packages/node/dist/index.d.ts:114 +packages/node/dist/index.d.ts:116 diff --git a/tevm/docs/index/type-aliases/BlockNumber.md b/tevm/docs/index/type-aliases/BlockNumber.md index 92d5a38615..db610e8c70 100644 --- a/tevm/docs/index/type-aliases/BlockNumber.md +++ b/tevm/docs/index/type-aliases/BlockNumber.md @@ -14,4 +14,4 @@ ## Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/types/block.d.ts:68 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/types/block.d.ts:68 diff --git a/tevm/docs/index/type-aliases/BlockTag.md b/tevm/docs/index/type-aliases/BlockTag.md index d3ca94787c..498ec5caad 100644 --- a/tevm/docs/index/type-aliases/BlockTag.md +++ b/tevm/docs/index/type-aliases/BlockTag.md @@ -10,4 +10,4 @@ ## Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/types/block.d.ts:69 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/types/block.d.ts:69 diff --git a/tevm/docs/index/type-aliases/CallParams.md b/tevm/docs/index/type-aliases/CallParams.md index 1bedff5e5d..c0f00f6aab 100644 --- a/tevm/docs/index/type-aliases/CallParams.md +++ b/tevm/docs/index/type-aliases/CallParams.md @@ -11,6 +11,32 @@ TEVM parameters to execute a call on the VM. `Call` is the lowest level method to interact with the VM, and other methods such as `contract` and `script` use `call` under the hood. +## Example + +```typescript +import { createClient } from 'viem' +import { createTevmTransport, tevmCall } from 'tevm' +import { optimism } from 'tevm/common' + +const client = createClient({ + transport: createTevmTransport({}), + chain: optimism, +}) + +const callParams = { + data: '0x...', + bytecode: '0x...', + gasLimit: 420n, +} + +await tevmCall(client, callParams) +``` + +## See + + - [BaseCallParams](https://tevm.sh/reference/tevm/actions/type-aliases/basecallparams-1/) + - [tevmCall](https://tevm.sh/reference/tevm/memory-client/functions/tevmCall/) + ## Type declaration ### code? @@ -129,32 +155,6 @@ await tevmCall(client, callParams) • **TThrowOnFail** *extends* `boolean` = `boolean` -## Example - -```typescript -import { createClient } from 'viem' -import { createTevmTransport, tevmCall } from 'tevm' -import { optimism } from 'tevm/common' - -const client = createClient({ - transport: createTevmTransport({}), - chain: optimism, -}) - -const callParams = { - data: '0x...', - bytecode: '0x...', - gasLimit: 420n, -} - -await tevmCall(client, callParams) -``` - -## See - - - [BaseCallParams](https://tevm.sh/reference/tevm/actions/type-aliases/basecallparams-1/) - - [tevmCall](https://tevm.sh/reference/tevm/memory-client/functions/tevmCall/) - ## Defined in packages/actions/types/Call/CallParams.d.ts:30 diff --git a/tevm/docs/index/type-aliases/CallResult.md b/tevm/docs/index/type-aliases/CallResult.md index 7ce5e0e3c9..4cb9b8febd 100644 --- a/tevm/docs/index/type-aliases/CallResult.md +++ b/tevm/docs/index/type-aliases/CallResult.md @@ -10,6 +10,33 @@ Result of a TEVM VM Call method. +## Example + +```typescript +import { createClient } from 'viem' +import { createTevmTransport, tevmCall } from 'tevm' +import { optimism } from 'tevm/common' +import { CallResult } from 'tevm/actions' + +const client = createClient({ + transport: createTevmTransport({}), + chain: optimism, +}) + +const callParams = { + data: '0x...', + bytecode: '0x...', + gasLimit: 420n, +} + +const result: CallResult = await tevmCall(client, callParams) +console.log(result) +``` + +## See + +[tevmCall](https://tevm.sh/reference/tevm/memory-client/functions/tevmCall/) + ## Type Parameters • **ErrorType** = [`TevmCallError`](TevmCallError.md) @@ -218,33 +245,6 @@ if (txHash) { } ``` -## Example - -```typescript -import { createClient } from 'viem' -import { createTevmTransport, tevmCall } from 'tevm' -import { optimism } from 'tevm/common' -import { CallResult } from 'tevm/actions' - -const client = createClient({ - transport: createTevmTransport({}), - chain: optimism, -}) - -const callParams = { - data: '0x...', - bytecode: '0x...', - gasLimit: 420n, -} - -const result: CallResult = await tevmCall(client, callParams) -console.log(result) -``` - -## See - -[tevmCall](https://tevm.sh/reference/tevm/memory-client/functions/tevmCall/) - ## Defined in packages/actions/types/Call/CallResult.d.ts:31 diff --git a/tevm/docs/index/type-aliases/Contract.md b/tevm/docs/index/type-aliases/Contract.md index 7de842a522..5f5941f86d 100644 --- a/tevm/docs/index/type-aliases/Contract.md +++ b/tevm/docs/index/type-aliases/Contract.md @@ -8,64 +8,126 @@ > **Contract**\<`TName`, `THumanReadableAbi`, `TAddress`, `TBytecode`, `TDeployedBytecode`, `TCode`\>: `object` -Represents a specific contract abi and optional bytecode. +Represents a specific contract with its ABI and optional bytecode. +Contracts provide type-safe interfaces for interacting with smart contracts, +including read and write methods, event filtering, and deployment. + +## Examples + +Creating and using a Contract instance: +```typescript +import { createContract } from 'tevm/contract' + +const MyContract = createContract({ + name: 'MyToken', + humanReadableAbi: [ + 'function balanceOf(address account) view returns (uint256)', + 'function transfer(address to, uint256 amount) returns (bool)', + 'event Transfer(address indexed from, address indexed to, uint256 value)' + ], + address: '0x1234567890123456789012345678901234567890' +}) + +// Read contract state +const balanceAction = MyContract.read.balanceOf('0xabcdef...') +const balance = await tevm.contract(balanceAction) + +// Write to contract +const transferAction = MyContract.write.transfer('0xfedcba...', 1000n) +const result = await tevm.contract(transferAction) + +// Create event filter +const transferFilter = MyContract.events.Transfer({ fromBlock: 'latest' }) +const logs = await tevm.eth.getLogs(transferFilter) +``` + +Using with other libraries: +```typescript +import { createPublicClient, http } from 'viem' +import { mainnet } from 'viem/chains' + +const client = createPublicClient({ + chain: mainnet, + transport: http() +}) + +const balance = await client.readContract( + MyContract.read.balanceOf('0xabcdef...') +) +``` ## Type Parameters • **TName** *extends* `string` +The name of the contract + • **THumanReadableAbi** *extends* `ReadonlyArray`\<`string`\> +The human-readable ABI of the contract + • **TAddress** *extends* `undefined` \| [`Address`](Address.md) = `undefined` +The address of the contract (optional) + • **TBytecode** *extends* `undefined` \| [`Hex`](Hex.md) = `undefined` +The creation bytecode of the contract (optional) + • **TDeployedBytecode** *extends* `undefined` \| [`Hex`](Hex.md) = `undefined` +The deployed bytecode of the contract (optional) + • **TCode** *extends* `undefined` \| [`Hex`](Hex.md) = `undefined` +The runtime bytecode of the contract (optional) + ## Type declaration ### abi > **abi**: [`ParseAbi`](ParseAbi.md)\<`THumanReadableAbi`\> -The json abi of the contract +The JSON ABI of the contract. #### Example ```typescript -import { MyContract } from './MyContract.sol' -console.log(MyContract.abi) // [{name: 'balanceOf', inputs: [...], outputs: [...], ...}] +console.log(MyContract.abi) +// [{name: 'balanceOf', inputs: [...], outputs: [...], ...}] ``` ### address > **address**: `TAddress` -Configured address of the contract. If not set it will be undefined -To set use the `withAddress` method +The configured address of the contract. If not set, it will be undefined. +Use the `withAddress` method to set or change the address. ### bytecode > **bytecode**: `TBytecode` -The contract bytecode is not defined on Contract objects are expected -to be deployed to the chain. See `Script` type which is a contract with bytecode -It's provided here to allow easier access of the property when using a -`Contract | Script` union type +The creation bytecode of the contract. ### code > **code**: `TCode` -Code i +The runtime bytecode of the contract, encoded with constructor arguments. ### deploy() > **deploy**: (...`args`) => [`EncodeDeployDataParameters`](../../utils/type-aliases/EncodeDeployDataParameters.md)\<[`ParseAbi`](ParseAbi.md)\<`THumanReadableAbi`\>\> -Action creator for deploying the contract +Action creator for deploying the contract. + +#### Example + +```typescript +const deployAction = MyContract.deploy('Constructor', 'Args') +const deployedContract = await tevm.contract(deployAction) +``` #### Parameters @@ -79,35 +141,30 @@ Action creator for deploying the contract > **deployedBytecode**: `TDeployedBytecode` -The contract deployedBytecode is not defined on Contract objects are expected -to be deployed to the chain. See `Script` type which is a contract with deployedBytecode -It's provided here to allow easier access of the property when using a -`Contract | Script` union type +The deployed bytecode of the contract. ### events > **events**: [`EventActionCreator`](EventActionCreator.md)\<`THumanReadableAbi`, `TAddress`, `TBytecode`, `TDeployedBytecode`\> -Action creators for events. Can be used to create event filters in a typesafe way +Action creators for events. Used to create event filters in a type-safe way. #### Example ```typescript -tevm.eth.getLog( - MyContract.withAddress('0x420...').events.Transfer({ from: '0x1234...' }), -) -=== +const transferFilter = MyContract.events.Transfer({ from: '0x1234...' }) +const logs = await tevm.eth.getLogs(transferFilter) +``` ### humanReadableAbi > **humanReadableAbi**: `THumanReadableAbi` -The human readable abi of the contract +The human-readable ABI of the contract. #### Example ```typescript -import { MyContract } from './MyContract.sol' console.log(MyContract.humanReadableAbi) // ['function balanceOf(address): uint256', ...] ``` @@ -116,121 +173,76 @@ console.log(MyContract.humanReadableAbi) > `optional` **name**: `TName` -The name of the contract. If imported this will match the name of the contract import +The name of the contract. If imported, this will match the name of the contract import. ### read > **read**: [`ReadActionCreator`](ReadActionCreator.md)\<`THumanReadableAbi`, `TAddress`, `TCode`\> -Action creators for contract view and pure functions +Action creators for contract view and pure functions. #### Example ```typescript -tevm.contract( - MyContract.withAddress('0x420...').read.balanceOf('0x1234...'), -) +const balanceAction = MyContract.read.balanceOf('0x1234...') +const balance = await tevm.contract(balanceAction) ``` -### script - -> **script**: [`CreateScript`](CreateScript.md)\<`TName`, `THumanReadableAbi`, `TAddress`, `TBytecode`\> - -Creates a deployless instance of the contract that can be used with -tevm and viem as [deployless contracts](https://viem.sh/docs/contract/readContract#deployless-reads) - ### withAddress() -> **withAddress**: \<`TAddress`\>(`address`) => [`Contract`](Contract.md)\<`TName`, `THumanReadableAbi`, `TAddress`, `TBytecode`, `TDeployedBytecode`, `TCode`\> +> **withAddress**: \<`TNewAddress`\>(`address`) => [`Contract`](Contract.md)\<`TName`, `THumanReadableAbi`, `TNewAddress`, `TBytecode`, `TDeployedBytecode`, `TCode`\> -Adds an address to the contract. All action creators will return -the address property if added. THis method returns a new contract +Adds an address to the contract. All action creators will include +the address property if added. This method returns a new contract; it does not modify the existing contract. +#### Example + +```typescript +const MyContractWithAddress = MyContract.withAddress('0x1234...') +``` + #### Type Parameters -• **TAddress** *extends* [`Address`](Address.md) +• **TNewAddress** *extends* [`Address`](Address.md) #### Parameters -• **address**: `TAddress` +• **address**: `TNewAddress` #### Returns -[`Contract`](Contract.md)\<`TName`, `THumanReadableAbi`, `TAddress`, `TBytecode`, `TDeployedBytecode`, `TCode`\> +[`Contract`](Contract.md)\<`TName`, `THumanReadableAbi`, `TNewAddress`, `TBytecode`, `TDeployedBytecode`, `TCode`\> -#### Example +### withCode() -```typescript -import { MyContract } from './MyContract.sol' -const MyContractOptimism = MyContract.withAddress('0x420...') -``` +> **withCode**: (`encodedBytecode`) => [`Contract`](Contract.md)\<`TName`, `THumanReadableAbi`, `TAddress`, `TBytecode`, `TDeployedBytecode`, [`Hex`](Hex.md)\> -### write - -> **write**: [`WriteActionCreator`](WriteActionCreator.md)\<`THumanReadableAbi`, `TAddress`, `TCode`\> +#### Parameters -Action creators for contract payable and nonpayable functions +• **encodedBytecode**: [`Hex`](Hex.md) -#### Example +The encoded bytecode of the contract -```typescript -tevm.contract( - MyContract.withAddress('0x420...').read.balanceOf('0x1234...'), -) -``` +#### Returns -## Examples +[`Contract`](Contract.md)\<`TName`, `THumanReadableAbi`, `TAddress`, `TBytecode`, `TDeployedBytecode`, [`Hex`](Hex.md)\> -```typescript -import {createContract} from 'tevm/contract' +A new contract instance with updated code -const contract = createContract({ - address, - bytecode, - deployedBytecode, - humanReadableAbi, -}) -``` - -Contracts have actions creators for read methods, write methods, deploying, and events - -```typescript -tevm.contract( -- { abi: [...], args: ['0x1234...'], functionName: 'balanceOf' }, -+ MyContract.read.balanceOf('0x1234...'), -) -``` +### write -These contracts can be automatically generated by using [@tevm/bundler](https://todo.todo) -and then importing it. The Tevm bundler will automatically resolve your solidity imports into -tevm contract instances +> **write**: [`WriteActionCreator`](WriteActionCreator.md)\<`THumanReadableAbi`, `TAddress`, `TCode`\> -```typescript -import { MyContract } from './MyContract.sol' +Action creators for contract payable and nonpayable functions. -console.log(MyContract.humanReadableAbi) -``` -Address can be added to a contract using the `withAddress` method +#### Example ```typescript -import { MyContract } from './MyContract.sol' - -const MyContractOptimism = MyContract.withAddress('0x420...') +const transferAction = MyContract.write.transfer('0x5678...', 1000n) +const result = await tevm.contract(transferAction) ``` -Contracts can also be used with other libraries such as Viem and ethers. - -```typescript -import { MyContract } from './MyContract.sol' -import { createPublicClient } from 'viem' - -// see viem docs -const client = createPublicClient({...}) - -const result = await client.readContract( - MyContract.withAddress('0x420...').read.balanceOf('0x1234...'), -) ## Defined in -packages/contract/types/Contract.d.ts:58 +packages/contract/types/Contract.d.ts:61 diff --git a/tevm/docs/index/type-aliases/ContractFunctionName.md b/tevm/docs/index/type-aliases/ContractFunctionName.md index ca2a83db55..fbb0ebcc0c 100644 --- a/tevm/docs/index/type-aliases/ContractFunctionName.md +++ b/tevm/docs/index/type-aliases/ContractFunctionName.md @@ -16,4 +16,4 @@ ## Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/types/contract.d.ts:5 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/types/contract.d.ts:5 diff --git a/tevm/docs/index/type-aliases/ContractParams.md b/tevm/docs/index/type-aliases/ContractParams.md index 9d87af6a86..8d060cccfc 100644 --- a/tevm/docs/index/type-aliases/ContractParams.md +++ b/tevm/docs/index/type-aliases/ContractParams.md @@ -12,20 +12,6 @@ Parameters to execute a call on a contract with TEVM. This type combines the parameters required for encoding function data with additional call parameters. -## Type Parameters - -• **TAbi** *extends* `Abi` \| readonly `unknown`[] = `Abi` - -The ABI type. - -• **TFunctionName** *extends* [`ContractFunctionName`](ContractFunctionName.md)\<`TAbi`\> = [`ContractFunctionName`](ContractFunctionName.md)\<`TAbi`\> - -The function name type from the ABI. - -• **TThrowOnFail** *extends* `boolean` = `boolean` - -The type indicating whether to throw on failure. - ## Example ```typescript @@ -57,6 +43,20 @@ console.log(res) - BaseCallParams - [EncodeFunctionDataParameters](EncodeFunctionDataParameters.md) +## Type Parameters + +• **TAbi** *extends* `Abi` \| readonly `unknown`[] = `Abi` + +The ABI type. + +• **TFunctionName** *extends* [`ContractFunctionName`](ContractFunctionName.md)\<`TAbi`\> = [`ContractFunctionName`](ContractFunctionName.md)\<`TAbi`\> + +The function name type from the ABI. + +• **TThrowOnFail** *extends* `boolean` = `boolean` + +The type indicating whether to throw on failure. + ## Defined in packages/actions/types/Contract/ContractParams.d.ts:41 diff --git a/tevm/docs/index/type-aliases/ContractResult.md b/tevm/docs/index/type-aliases/ContractResult.md index e441b2246d..ce45697111 100644 --- a/tevm/docs/index/type-aliases/ContractResult.md +++ b/tevm/docs/index/type-aliases/ContractResult.md @@ -12,20 +12,6 @@ The result type for a TEVM contract call. This type extends the `CallResult` type with additional contract-specific fields, and it supports both success and error states. -## Type Parameters - -• **TAbi** *extends* `Abi` \| readonly `unknown`[] = `Abi` - -The ABI type. - -• **TFunctionName** *extends* [`ContractFunctionName`](ContractFunctionName.md)\<`TAbi`\> = [`ContractFunctionName`](ContractFunctionName.md)\<`TAbi`\> - -The function name type from the ABI. - -• **ErrorType** = [`TevmContractError`](TevmContractError.md) - -The error type. - ## Example ```typescript @@ -60,6 +46,20 @@ if (result.errors) { [CallResult](CallResult.md) +## Type Parameters + +• **TAbi** *extends* `Abi` \| readonly `unknown`[] = `Abi` + +The ABI type. + +• **TFunctionName** *extends* [`ContractFunctionName`](ContractFunctionName.md)\<`TAbi`\> = [`ContractFunctionName`](ContractFunctionName.md)\<`TAbi`\> + +The function name type from the ABI. + +• **ErrorType** = [`TevmContractError`](TevmContractError.md) + +The error type. + ## Defined in packages/actions/types/Contract/ContractResult.d.ts:45 diff --git a/tevm/docs/index/type-aliases/CreateContractParams.md b/tevm/docs/index/type-aliases/CreateContractParams.md index 50bd9e101f..6577e8e4c9 100644 --- a/tevm/docs/index/type-aliases/CreateContractParams.md +++ b/tevm/docs/index/type-aliases/CreateContractParams.md @@ -8,26 +8,71 @@ > **CreateContractParams**\<`TName`, `TAbi`, `TAddress`, `TBytecode`, `TDeployedBytecode`, `TCode`\>: `object` \| `object` -Params for creating a [Contract](Contract.md) instance +Parameters for creating a [Contract](Contract.md) instance. +This type allows for two mutually exclusive ways of specifying the ABI: +either as a human-readable ABI or as a JSON ABI. + +## See + +CreateContract + +## Examples + +Using human-readable ABI: +```typescript +const params: CreateContractParams = { + name: 'ERC20', + humanReadableAbi: [ + 'function balanceOf(address owner) view returns (uint256)', + 'function transfer(address to, uint256 amount) returns (bool)', + ], + address: '0x6B175474E89094C44Da98b954EedeAC495271d0F', +} +``` + +Using JSON ABI: +```typescript +const params: CreateContractParams = { + name: 'ERC20', + abi: [ + { + "inputs": [{"name": "owner", "type": "address"}], + "name": "balanceOf", + "outputs": [{"type": "uint256"}], + "stateMutability": "view", + "type": "function" + }, + ], + address: '0x6B175474E89094C44Da98b954EedeAC495271d0F', +} +``` ## Type Parameters • **TName** *extends* `string` \| `undefined` \| `never` +The name of the contract (optional) + • **TAbi** *extends* readonly `string`[] \| [`Abi`](Abi.md) +The ABI type (either string[] for human readable or Abi for JSON) + • **TAddress** *extends* `undefined` \| [`Address`](Address.md) \| `never` +The contract address type (optional) + • **TBytecode** *extends* `undefined` \| [`Hex`](Hex.md) \| `never` +The contract creation bytecode type (optional) + • **TDeployedBytecode** *extends* `undefined` \| [`Hex`](Hex.md) \| `never` -• **TCode** *extends* `undefined` \| [`Hex`](Hex.md) \| `never` +The deployed bytecode type (optional) -## See +• **TCode** *extends* `undefined` \| [`Hex`](Hex.md) \| `never` -CreateContract +The runtime bytecode type (optional) ## Defined in -packages/contract/types/CreateContractParams.d.ts:6 +packages/contract/types/CreateContractParams.d.ts:47 diff --git a/tevm/docs/index/type-aliases/CreateEventFilterParameters.md b/tevm/docs/index/type-aliases/CreateEventFilterParameters.md index 0b183ed801..228d9a7659 100644 --- a/tevm/docs/index/type-aliases/CreateEventFilterParameters.md +++ b/tevm/docs/index/type-aliases/CreateEventFilterParameters.md @@ -4,9 +4,9 @@ [tevm](../../modules.md) / [index](../README.md) / CreateEventFilterParameters -# Type Alias: CreateEventFilterParameters\ +# Type Alias: CreateEventFilterParameters\ -> **CreateEventFilterParameters**\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `TFromBlock`, `TToBlock`, `_EventName`, `_Args`\>: `object` & `MaybeExtractEventArgsFromAbi`\<`TAbiEvents`, `_EventName`\> *extends* infer TEventFilterArgs ? `object` \| `object` \| `object` \| `object` : `object` +> **CreateEventFilterParameters**\<`abiEvent`, `abiEvents`, `strict`, `fromBlock`, `toBlock`, `_eventName`, `_args`\>: `object` & `MaybeExtractEventArgsFromAbi`\<`abiEvents`, `_eventName`\> *extends* infer eventFilterArgs ? `object` \| `object` \| `object` \| `object` : `object` ## Type declaration @@ -16,28 +16,28 @@ ### fromBlock? -> `optional` **fromBlock**: `TFromBlock` \| [`BlockNumber`](BlockNumber.md) \| [`BlockTag`](BlockTag.md) +> `optional` **fromBlock**: `fromBlock` \| [`BlockNumber`](BlockNumber.md) \| [`BlockTag`](BlockTag.md) ### toBlock? -> `optional` **toBlock**: `TToBlock` \| [`BlockNumber`](BlockNumber.md) \| [`BlockTag`](BlockTag.md) +> `optional` **toBlock**: `toBlock` \| [`BlockNumber`](BlockNumber.md) \| [`BlockTag`](BlockTag.md) ## Type Parameters -• **TAbiEvent** *extends* `AbiEvent` \| `undefined` = `undefined` +• **abiEvent** *extends* `AbiEvent` \| `undefined` = `undefined` -• **TAbiEvents** *extends* readonly `AbiEvent`[] \| readonly `unknown`[] \| `undefined` = `TAbiEvent` *extends* `AbiEvent` ? [`TAbiEvent`] : `undefined` +• **abiEvents** *extends* readonly `AbiEvent`[] \| readonly `unknown`[] \| `undefined` = `abiEvent` *extends* `AbiEvent` ? [`abiEvent`] : `undefined` -• **TStrict** *extends* `boolean` \| `undefined` = `undefined` +• **strict** *extends* `boolean` \| `undefined` = `undefined` -• **TFromBlock** *extends* [`BlockNumber`](BlockNumber.md) \| [`BlockTag`](BlockTag.md) \| `undefined` = `undefined` +• **fromBlock** *extends* [`BlockNumber`](BlockNumber.md) \| [`BlockTag`](BlockTag.md) \| `undefined` = `undefined` -• **TToBlock** *extends* [`BlockNumber`](BlockNumber.md) \| [`BlockTag`](BlockTag.md) \| `undefined` = `undefined` +• **toBlock** *extends* [`BlockNumber`](BlockNumber.md) \| [`BlockTag`](BlockTag.md) \| `undefined` = `undefined` -• **_EventName** *extends* `string` \| `undefined` = `MaybeAbiEventName`\<`TAbiEvent`\> +• **_eventName** *extends* `string` \| `undefined` = `MaybeAbiEventName`\<`abiEvent`\> -• **_Args** *extends* `MaybeExtractEventArgsFromAbi`\<`TAbiEvents`, `_EventName`\> \| `undefined` = `undefined` +• **_args** *extends* `MaybeExtractEventArgsFromAbi`\<`abiEvents`, `_eventName`\> \| `undefined` = `undefined` ## Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/actions/public/createEventFilter.d.ts:13 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/actions/public/createEventFilter.d.ts:13 diff --git a/tevm/docs/index/type-aliases/CreateMemoryClientFn.md b/tevm/docs/index/type-aliases/CreateMemoryClientFn.md index 7ead742806..646017ca25 100644 --- a/tevm/docs/index/type-aliases/CreateMemoryClientFn.md +++ b/tevm/docs/index/type-aliases/CreateMemoryClientFn.md @@ -14,7 +14,7 @@ The common chain configuration, extending both `Common` and `Chain`. -• **TAccountOrAddress** *extends* `Account` \| [`Address`](Address.md) \| `undefined` = `undefined` +• **TAccountOrAddress** *extends* [`Account`](Account.md) \| [`Address`](Address.md) \| `undefined` = `undefined` The account or address type for the client. diff --git a/tevm/docs/index/type-aliases/CreateScript.md b/tevm/docs/index/type-aliases/CreateScript.md deleted file mode 100644 index 2240b7c84d..0000000000 --- a/tevm/docs/index/type-aliases/CreateScript.md +++ /dev/null @@ -1,35 +0,0 @@ -[**tevm**](../../README.md) • **Docs** - -*** - -[tevm](../../modules.md) / [index](../README.md) / CreateScript - -# Type Alias: CreateScript()\ - -> **CreateScript**\<`TName`, `THumanReadableAbi`, `TAddress`, `TBytecode`\>: (...`args`) => [`Contract`](Contract.md)\<`TName`, `THumanReadableAbi`, `TAddress`, [`Hex`](Hex.md), [`Hex`](Hex.md), [`Hex`](Hex.md)\> - -Creates a deployless instance of a contract -Can be used to execute code that isn't deployed in tevm -or [viem](https://viem.sh/docs/actions/public/call#deployless-calls) - -## Type Parameters - -• **TName** *extends* `string` - -• **THumanReadableAbi** *extends* `string`[] \| readonly `string`[] - -• **TAddress** *extends* [`Address`](Address.md) \| `undefined` = `undefined` - -• **TBytecode** *extends* [`Hex`](Hex.md) \| `undefined` = `undefined` - -## Parameters - -• ...**args**: [`DeployArgs`](DeployArgs.md)\<`THumanReadableAbi`, `TBytecode`\> - -## Returns - -[`Contract`](Contract.md)\<`TName`, `THumanReadableAbi`, `TAddress`, [`Hex`](Hex.md), [`Hex`](Hex.md), [`Hex`](Hex.md)\> - -## Defined in - -packages/contract/types/CreateScript.d.ts:9 diff --git a/tevm/docs/index/type-aliases/CreateSyncStoragePersisterOptions.md b/tevm/docs/index/type-aliases/CreateSyncStoragePersisterOptions.md index 4c2a715817..08e86b1a68 100644 --- a/tevm/docs/index/type-aliases/CreateSyncStoragePersisterOptions.md +++ b/tevm/docs/index/type-aliases/CreateSyncStoragePersisterOptions.md @@ -18,6 +18,10 @@ Options for creating a sync storage persister. How to deserialize the data from storage. +#### Default + +`JSON.parse` + #### Parameters • **cachedString**: `string` @@ -26,10 +30,6 @@ How to deserialize the data from storage. [`SerializableTevmState`](../../state/type-aliases/SerializableTevmState.md) -#### Default - -`JSON.parse` - ### key? > `optional` **key**: `string` @@ -42,6 +42,10 @@ The key to use when storing the cache How to serialize the data to storage. +#### Default + +`JSON.stringify` + #### Parameters • **client**: [`SerializableTevmState`](../../state/type-aliases/SerializableTevmState.md) @@ -50,10 +54,6 @@ How to serialize the data to storage. `string` -#### Default - -`JSON.stringify` - ### storage > **storage**: [`Storage`](../interfaces/Storage.md) diff --git a/tevm/docs/index/type-aliases/CustomPrecompile.md b/tevm/docs/index/type-aliases/CustomPrecompile.md index 8ab929b90b..c542071284 100644 --- a/tevm/docs/index/type-aliases/CustomPrecompile.md +++ b/tevm/docs/index/type-aliases/CustomPrecompile.md @@ -12,4 +12,4 @@ Custom precompiles allow you to run arbitrary JavaScript code in the EVM ## Defined in -packages/node/dist/index.d.ts:235 +packages/node/dist/index.d.ts:237 diff --git a/tevm/docs/index/type-aliases/DecodeFunctionResultReturnType.md b/tevm/docs/index/type-aliases/DecodeFunctionResultReturnType.md index e3d860a3c2..9f33d1a29e 100644 --- a/tevm/docs/index/type-aliases/DecodeFunctionResultReturnType.md +++ b/tevm/docs/index/type-aliases/DecodeFunctionResultReturnType.md @@ -18,4 +18,4 @@ ## Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/abi/decodeFunctionResult.d.ts:23 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/abi/decodeFunctionResult.d.ts:23 diff --git a/tevm/docs/index/type-aliases/DeployArgs.md b/tevm/docs/index/type-aliases/DeployArgs.md deleted file mode 100644 index 95f77c385e..0000000000 --- a/tevm/docs/index/type-aliases/DeployArgs.md +++ /dev/null @@ -1,25 +0,0 @@ -[**tevm**](../../README.md) • **Docs** - -*** - -[tevm](../../modules.md) / [index](../README.md) / DeployArgs - -# Type Alias: DeployArgs\ - -> **DeployArgs**\<`THumanReadableAbi`, `TBytecode`, `TAbi`, `THasConstructor`\>: `THasConstructor` *extends* `false` ? `TBytecode` *extends* [`Hex`](Hex.md) ? [] \| [`object`] : [`object`] : `TBytecode` *extends* [`Hex`](Hex.md) ? [`object`] : [`object`] - -Inferred arguments for a contract deployment - -## Type Parameters - -• **THumanReadableAbi** *extends* `string`[] \| readonly `string`[] - -• **TBytecode** *extends* [`Hex`](Hex.md) \| `undefined` = `undefined` - -• **TAbi** *extends* [`ParseAbi`](ParseAbi.md)\<`THumanReadableAbi`\> = [`ParseAbi`](ParseAbi.md)\<`THumanReadableAbi`\> - -• **THasConstructor** = `TAbi` *extends* [`Abi`](Abi.md) ? [`Abi`](Abi.md) *extends* `TAbi` ? `true` : [`Extract`\<`TAbi`\[`number`\], `object`\>] *extends* [`never`] ? `false` : `true` : `true` - -## Defined in - -packages/contract/types/DeployArgs.d.ts:5 diff --git a/tevm/docs/index/type-aliases/DeployParams.md b/tevm/docs/index/type-aliases/DeployParams.md index beb22cd666..1d72119773 100644 --- a/tevm/docs/index/type-aliases/DeployParams.md +++ b/tevm/docs/index/type-aliases/DeployParams.md @@ -15,32 +15,6 @@ is set to true, because deployments result in state changes that need to be mine The `salt` parameter supports the use of CREATE2, allowing for deterministic address deployment. -## Type declaration - -### salt? - -> `readonly` `optional` **salt**: `Hex` - -An optional CREATE2 salt, if deploying with CREATE2 for a predictable contract address. - -## Type Parameters - -• **TThrowOnFail** *extends* `boolean` = `boolean` - -Indicates whether the function should throw on failure. - -• **TAbi** *extends* [`Abi`](Abi.md) \| readonly `unknown`[] = [`Abi`](Abi.md) - -The ABI type, typically including constructor definitions. - -• **THasConstructor** = `TAbi` *extends* [`Abi`](Abi.md) ? [`Abi`](Abi.md) *extends* `TAbi` ? `true` : [`Extract`\<`TAbi`\[`number`\], `object`\>] *extends* [`never`] ? `false` : `true` : `true` - -Determines whether the ABI includes a constructor. - -• **TAllArgs** = [`ContractConstructorArgs`](../../utils/type-aliases/ContractConstructorArgs.md)\<`TAbi`\> - -Types of the constructor arguments for the deployment. - ## Example ```typescript @@ -71,6 +45,32 @@ const result = await deployHandler(client)(deployParams) console.log('Deployed contract address:', result.createdAddress) ``` +## Type declaration + +### salt? + +> `readonly` `optional` **salt**: `Hex` + +An optional CREATE2 salt, if deploying with CREATE2 for a predictable contract address. + +## Type Parameters + +• **TThrowOnFail** *extends* `boolean` = `boolean` + +Indicates whether the function should throw on failure. + +• **TAbi** *extends* [`Abi`](Abi.md) \| readonly `unknown`[] = [`Abi`](Abi.md) + +The ABI type, typically including constructor definitions. + +• **THasConstructor** = `TAbi` *extends* [`Abi`](Abi.md) ? [`Abi`](Abi.md) *extends* `TAbi` ? `true` : [`Extract`\<`TAbi`\[`number`\], `object`\>] *extends* [`never`] ? `false` : `true` : `true` + +Determines whether the ABI includes a constructor. + +• **TAllArgs** = [`ContractConstructorArgs`](../../utils/type-aliases/ContractConstructorArgs.md)\<`TAbi`\> + +Types of the constructor arguments for the deployment. + ## Defined in packages/actions/types/Deploy/DeployParams.d.ts:46 diff --git a/tevm/docs/index/type-aliases/EIP1193EventEmitter.md b/tevm/docs/index/type-aliases/EIP1193EventEmitter.md index 5a5f4b2e59..fa927b8b31 100644 --- a/tevm/docs/index/type-aliases/EIP1193EventEmitter.md +++ b/tevm/docs/index/type-aliases/EIP1193EventEmitter.md @@ -34,4 +34,4 @@ True if the event was emitted, false otherwise. ## Defined in -packages/node/dist/index.d.ts:48 +packages/node/dist/index.d.ts:50 diff --git a/tevm/docs/index/type-aliases/EIP1193EventMap.md b/tevm/docs/index/type-aliases/EIP1193EventMap.md index 04a82a0337..028ef8ff24 100644 --- a/tevm/docs/index/type-aliases/EIP1193EventMap.md +++ b/tevm/docs/index/type-aliases/EIP1193EventMap.md @@ -102,4 +102,4 @@ ## Defined in -packages/node/dist/index.d.ts:30 +packages/node/dist/index.d.ts:32 diff --git a/tevm/docs/index/type-aliases/EIP1193Events.md b/tevm/docs/index/type-aliases/EIP1193Events.md index b36dbd18fe..630797ce6d 100644 --- a/tevm/docs/index/type-aliases/EIP1193Events.md +++ b/tevm/docs/index/type-aliases/EIP1193Events.md @@ -44,4 +44,4 @@ ## Defined in -packages/node/dist/index.d.ts:41 +packages/node/dist/index.d.ts:43 diff --git a/tevm/docs/index/type-aliases/EncodeFunctionDataParameters.md b/tevm/docs/index/type-aliases/EncodeFunctionDataParameters.md index 75e3dbf9c6..5a6c1db16d 100644 --- a/tevm/docs/index/type-aliases/EncodeFunctionDataParameters.md +++ b/tevm/docs/index/type-aliases/EncodeFunctionDataParameters.md @@ -28,4 +28,4 @@ ## Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/abi/encodeFunctionData.d.ts:12 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/abi/encodeFunctionData.d.ts:12 diff --git a/tevm/docs/index/type-aliases/EthActionsApi.md b/tevm/docs/index/type-aliases/EthActionsApi.md index 4d2dcc3d49..5514007796 100644 --- a/tevm/docs/index/type-aliases/EthActionsApi.md +++ b/tevm/docs/index/type-aliases/EthActionsApi.md @@ -11,6 +11,10 @@ The actions api is the high level API for interacting with a Tevm client similar to [viem actions](https://viem.sh/learn/actions/) These actions correspond 1:1 eith the public ethereum JSON-RPC api +## See + +[https://tevm.sh/learn/actions/](https://tevm.sh/learn/actions/) + ## Type declaration ### eth @@ -154,10 +158,6 @@ Block tag defaults to 'pending' tag which is the optimistic state of the VM const storageValue = await tevm.eth.getStorageAt({address: '0x123...', position: 0}) ``` -## See - -[https://tevm.sh/learn/actions/](https://tevm.sh/learn/actions/) - ## Defined in packages/decorators/dist/index.d.ts:12 diff --git a/tevm/docs/index/type-aliases/EthjsFilter.md b/tevm/docs/index/type-aliases/EthjsFilter.md index 3ea655eb74..2626f31a9d 100644 --- a/tevm/docs/index/type-aliases/EthjsFilter.md +++ b/tevm/docs/index/type-aliases/EthjsFilter.md @@ -4,9 +4,9 @@ [tevm](../../modules.md) / [index](../README.md) / EthjsFilter -# Type Alias: EthjsFilter\ +# Type Alias: EthjsFilter\ -> **EthjsFilter**\<`TFilterType`, `TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`\>: `object` & `TFilterType` *extends* `"event"` ? `object` & `TAbi` *extends* `Abi` ? `undefined` *extends* `TEventName` ? `object` : `TArgs` *extends* `MaybeExtractEventArgsFromAbi`\<`TAbi`, `TEventName`\> ? `object` : `object` : `object` : `object` +> **EthjsFilter**\<`filterType`, `abi`, `eventName`, `args`, `strict`, `fromBlock`, `toBlock`\>: `object` & `filterType` *extends* `"event"` ? `object` & `abi` *extends* `Abi` ? `undefined` *extends* `eventName` ? `object` : `args` *extends* `MaybeExtractEventArgsFromAbi`\<`abi`, `eventName`\> ? `object` : `object` : `object` : `object` ## Type declaration @@ -20,24 +20,24 @@ ### type -> **type**: `TFilterType` +> **type**: `filterType` ## Type Parameters -• **TFilterType** *extends* `FilterType` = `"event"` +• **filterType** *extends* `FilterType` = `"event"` -• **TAbi** *extends* `Abi` \| readonly `unknown`[] \| `undefined` = `undefined` +• **abi** *extends* `Abi` \| readonly `unknown`[] \| `undefined` = `undefined` -• **TEventName** *extends* `string` \| `undefined` = `undefined` +• **eventName** *extends* `string` \| `undefined` = `undefined` -• **TArgs** *extends* `MaybeExtractEventArgsFromAbi`\<`TAbi`, `TEventName`\> \| `undefined` = `MaybeExtractEventArgsFromAbi`\<`TAbi`, `TEventName`\> +• **args** *extends* `MaybeExtractEventArgsFromAbi`\<`abi`, `eventName`\> \| `undefined` = `MaybeExtractEventArgsFromAbi`\<`abi`, `eventName`\> -• **TStrict** *extends* `boolean` \| `undefined` = `undefined` +• **strict** *extends* `boolean` \| `undefined` = `undefined` -• **TFromBlock** *extends* [`BlockNumber`](BlockNumber.md) \| [`BlockTag`](BlockTag.md) \| `undefined` = `undefined` +• **fromBlock** *extends* [`BlockNumber`](BlockNumber.md) \| [`BlockTag`](BlockTag.md) \| `undefined` = `undefined` -• **TToBlock** *extends* [`BlockNumber`](BlockNumber.md) \| [`BlockTag`](BlockTag.md) \| `undefined` = `undefined` +• **toBlock** *extends* [`BlockNumber`](BlockNumber.md) \| [`BlockTag`](BlockTag.md) \| `undefined` = `undefined` ## Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/types/filter.d.ts:11 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/types/filter.d.ts:11 diff --git a/tevm/docs/index/type-aliases/EventActionCreator.md b/tevm/docs/index/type-aliases/EventActionCreator.md index f80b4aaac9..c90c8b837b 100644 --- a/tevm/docs/index/type-aliases/EventActionCreator.md +++ b/tevm/docs/index/type-aliases/EventActionCreator.md @@ -8,28 +8,44 @@ > **EventActionCreator**\<`THumanReadableAbi`, `TBytecode`, `TDeployedBytecode`, `TAddress`, `TAddressArgs`\>: `{ [TEventName in ExtractAbiEventNames>]: Function & Object & TAddressArgs }` -A mapping of event names to action creators for events. Can be used to create event filters in a typesafe way +A mapping of event names to action creators for events. Can be used to create event filters in a typesafe way. + +## Example + +```typescript +// Creating an event filter for a Transfer event +const filter = MyContract.events.Transfer({ + fromBlock: 'latest', + toBlock: 'latest', + args: { from: '0x1234...', to: '0x5678...' } +}) + +// Using the filter with tevm +const logs = await tevm.eth.getLogs(filter) +``` ## Type Parameters • **THumanReadableAbi** *extends* readonly `string`[] +The human-readable ABI of the contract. + • **TBytecode** *extends* [`Hex`](Hex.md) \| `undefined` +The bytecode of the contract. + • **TDeployedBytecode** *extends* [`Hex`](Hex.md) \| `undefined` +The deployed bytecode of the contract. + • **TAddress** *extends* [`Address`](Address.md) \| `undefined` -• **TAddressArgs** = `TAddress` *extends* `undefined` ? `object` : `object` +The address of the contract. -## Example +• **TAddressArgs** = `TAddress` *extends* `undefined` ? `object` : `object` -```typescript -tevm.eth.getLog( - MyScript.withAddress('0x420...').events.Transfer({ from: '0x1234...' }), -) -=== +Additional arguments for the address. ## Defined in -packages/contract/types/event/EventActionCreator.d.ts:16 +packages/contract/types/event/EventActionCreator.d.ts:34 diff --git a/tevm/docs/index/type-aliases/Extension.md b/tevm/docs/index/type-aliases/Extension.md index 94ef5d6d49..def5d549a6 100644 --- a/tevm/docs/index/type-aliases/Extension.md +++ b/tevm/docs/index/type-aliases/Extension.md @@ -22,4 +22,4 @@ ## Defined in -packages/node/dist/index.d.ts:363 +packages/node/dist/index.d.ts:412 diff --git a/tevm/docs/index/type-aliases/ExtractAbiEvent.md b/tevm/docs/index/type-aliases/ExtractAbiEvent.md index 8c1468cddd..26d2af3016 100644 --- a/tevm/docs/index/type-aliases/ExtractAbiEvent.md +++ b/tevm/docs/index/type-aliases/ExtractAbiEvent.md @@ -22,4 +22,4 @@ String name of event to extract from [Abi](Abi.md) ## Defined in -node\_modules/.pnpm/abitype@1.0.4\_typescript@5.5.4\_zod@3.23.8/node\_modules/abitype/dist/types/utils.d.ts:149 +node\_modules/.pnpm/abitype@1.0.6\_typescript@5.5.4\_zod@3.23.8/node\_modules/abitype/dist/types/utils.d.ts:149 diff --git a/tevm/docs/index/type-aliases/ExtractAbiEventNames.md b/tevm/docs/index/type-aliases/ExtractAbiEventNames.md index 028c058d86..814ec81184 100644 --- a/tevm/docs/index/type-aliases/ExtractAbiEventNames.md +++ b/tevm/docs/index/type-aliases/ExtractAbiEventNames.md @@ -18,4 +18,4 @@ Extracts all [AbiEvent](AbiEvent.md) names from [Abi](Abi.md). ## Defined in -node\_modules/.pnpm/abitype@1.0.4\_typescript@5.5.4\_zod@3.23.8/node\_modules/abitype/dist/types/utils.d.ts:141 +node\_modules/.pnpm/abitype@1.0.6\_typescript@5.5.4\_zod@3.23.8/node\_modules/abitype/dist/types/utils.d.ts:141 diff --git a/tevm/docs/index/type-aliases/ExtractAbiEvents.md b/tevm/docs/index/type-aliases/ExtractAbiEvents.md index 2f1e1c5de6..e8aab5dfda 100644 --- a/tevm/docs/index/type-aliases/ExtractAbiEvents.md +++ b/tevm/docs/index/type-aliases/ExtractAbiEvents.md @@ -18,4 +18,4 @@ Extracts all [AbiEvent](AbiEvent.md) types from [Abi](Abi.md). ## Defined in -node\_modules/.pnpm/abitype@1.0.4\_typescript@5.5.4\_zod@3.23.8/node\_modules/abitype/dist/types/utils.d.ts:132 +node\_modules/.pnpm/abitype@1.0.6\_typescript@5.5.4\_zod@3.23.8/node\_modules/abitype/dist/types/utils.d.ts:132 diff --git a/tevm/docs/index/type-aliases/ExtractAbiFunction.md b/tevm/docs/index/type-aliases/ExtractAbiFunction.md index 4bef1c4dcc..2cd4086b70 100644 --- a/tevm/docs/index/type-aliases/ExtractAbiFunction.md +++ b/tevm/docs/index/type-aliases/ExtractAbiFunction.md @@ -26,4 +26,4 @@ AbiStateMutability to filter by ## Defined in -node\_modules/.pnpm/abitype@1.0.4\_typescript@5.5.4\_zod@3.23.8/node\_modules/abitype/dist/types/utils.d.ts:123 +node\_modules/.pnpm/abitype@1.0.6\_typescript@5.5.4\_zod@3.23.8/node\_modules/abitype/dist/types/utils.d.ts:123 diff --git a/tevm/docs/index/type-aliases/ExtractAbiFunctionNames.md b/tevm/docs/index/type-aliases/ExtractAbiFunctionNames.md index 82164a2c3a..9d9b4a40a6 100644 --- a/tevm/docs/index/type-aliases/ExtractAbiFunctionNames.md +++ b/tevm/docs/index/type-aliases/ExtractAbiFunctionNames.md @@ -22,4 +22,4 @@ AbiStateMutability to filter by ## Defined in -node\_modules/.pnpm/abitype@1.0.4\_typescript@5.5.4\_zod@3.23.8/node\_modules/abitype/dist/types/utils.d.ts:114 +node\_modules/.pnpm/abitype@1.0.6\_typescript@5.5.4\_zod@3.23.8/node\_modules/abitype/dist/types/utils.d.ts:114 diff --git a/tevm/docs/index/type-aliases/Filter.md b/tevm/docs/index/type-aliases/Filter.md index 9980f82a46..57230253cb 100644 --- a/tevm/docs/index/type-aliases/Filter.md +++ b/tevm/docs/index/type-aliases/Filter.md @@ -75,4 +75,4 @@ The type of the filter ## Defined in -packages/node/dist/index.d.ts:63 +packages/node/dist/index.d.ts:65 diff --git a/tevm/docs/index/type-aliases/FilterType.md b/tevm/docs/index/type-aliases/FilterType.md index c93e7f7710..57b50d53c3 100644 --- a/tevm/docs/index/type-aliases/FilterType.md +++ b/tevm/docs/index/type-aliases/FilterType.md @@ -10,4 +10,4 @@ ## Defined in -packages/node/dist/index.d.ts:58 +packages/node/dist/index.d.ts:60 diff --git a/tevm/docs/index/type-aliases/FormatAbi.md b/tevm/docs/index/type-aliases/FormatAbi.md index 06c951bbc7..66318b85a4 100644 --- a/tevm/docs/index/type-aliases/FormatAbi.md +++ b/tevm/docs/index/type-aliases/FormatAbi.md @@ -18,4 +18,4 @@ ABI ## Defined in -node\_modules/.pnpm/abitype@1.0.4\_typescript@5.5.4\_zod@3.23.8/node\_modules/abitype/dist/types/human-readable/formatAbi.d.ts:9 +node\_modules/.pnpm/abitype@1.0.6\_typescript@5.5.4\_zod@3.23.8/node\_modules/abitype/dist/types/human-readable/formatAbi.d.ts:9 diff --git a/tevm/docs/index/type-aliases/GetAccountParams.md b/tevm/docs/index/type-aliases/GetAccountParams.md index e16b4a4cf5..8c261e6fc9 100644 --- a/tevm/docs/index/type-aliases/GetAccountParams.md +++ b/tevm/docs/index/type-aliases/GetAccountParams.md @@ -10,6 +10,14 @@ Tevm params to get an account +## Example + +```ts +const getAccountParams: import('@tevm/api').GetAccountParams = { + address: '0x...', +} +``` + ## Type declaration ### address @@ -41,14 +49,6 @@ Be aware that this can be very expensive if a contract has a lot of storage • **TThrowOnFail** *extends* `boolean` = `boolean` -## Example - -```ts -const getAccountParams: import('@tevm/api').GetAccountParams = { - address: '0x...', -} -``` - ## Defined in packages/actions/types/GetAccount/GetAccountParams.d.ts:10 diff --git a/tevm/docs/index/type-aliases/GetEventArgs.md b/tevm/docs/index/type-aliases/GetEventArgs.md index 194e5c403f..c5433e70a4 100644 --- a/tevm/docs/index/type-aliases/GetEventArgs.md +++ b/tevm/docs/index/type-aliases/GetEventArgs.md @@ -4,24 +4,24 @@ [tevm](../../modules.md) / [index](../README.md) / GetEventArgs -# Type Alias: GetEventArgs\ +# Type Alias: GetEventArgs\ -> **GetEventArgs**\<`TAbi`, `TEventName`, `TConfig`, `TAbiEvent`, `TArgs`, `FailedToParseArgs`\>: `true` *extends* `FailedToParseArgs` ? readonly `unknown`[] \| `Record`\<`string`, `unknown`\> : `TArgs` +> **GetEventArgs**\<`abi`, `eventName`, `config`, `abiEvent`, `args`, `FailedToParseArgs`\>: `true` *extends* `FailedToParseArgs` ? readonly `unknown`[] \| `Record`\<`string`, `unknown`\> : `args` ## Type Parameters -• **TAbi** *extends* `Abi` \| readonly `unknown`[] +• **abi** *extends* `Abi` \| readonly `unknown`[] -• **TEventName** *extends* `string` +• **eventName** *extends* `string` -• **TConfig** *extends* `EventParameterOptions` = `DefaultEventParameterOptions` +• **config** *extends* `EventParameterOptions` = `DefaultEventParameterOptions` -• **TAbiEvent** *extends* `AbiEvent` & `object` = `TAbi` *extends* `Abi` ? `ExtractAbiEvent`\<`TAbi`, `TEventName`\> : `AbiEvent` & `object` +• **abiEvent** *extends* `AbiEvent` & `object` = `abi` *extends* `Abi` ? `ExtractAbiEvent`\<`abi`, `eventName`\> : `AbiEvent` & `object` -• **TArgs** = `AbiEventParametersToPrimitiveTypes`\<`TAbiEvent`\[`"inputs"`\], `TConfig`\> +• **args** = `AbiEventParametersToPrimitiveTypes`\<`abiEvent`\[`"inputs"`\], `config`\> -• **FailedToParseArgs** = [`TArgs`] *extends* [`never`] ? `true` : `false` \| readonly `unknown`[] *extends* `TArgs` ? `true` : `false` +• **FailedToParseArgs** = [`args`] *extends* [`never`] ? `true` : `false` \| readonly `unknown`[] *extends* `args` ? `true` : `false` ## Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/types/contract.d.ts:72 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/types/contract.d.ts:72 diff --git a/tevm/docs/index/type-aliases/HDAccount.md b/tevm/docs/index/type-aliases/HDAccount.md index 8e4d486255..71791d9647 100644 --- a/tevm/docs/index/type-aliases/HDAccount.md +++ b/tevm/docs/index/type-aliases/HDAccount.md @@ -6,16 +6,8 @@ # Type Alias: HDAccount -> **HDAccount**: `LocalAccount`\<`"hd"`\> & `object` - -## Type declaration - -### getHdKey() - -#### Returns - -`HDKey` +> **HDAccount**: `Prettify`\<`LocalAccount`\<`"hd"`\> & `object`\> ## Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/accounts/types.d.ts:31 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/accounts/types.d.ts:40 diff --git a/tevm/docs/index/type-aliases/Hardfork.md b/tevm/docs/index/type-aliases/Hardfork.md index ec77b10304..8471300778 100644 --- a/tevm/docs/index/type-aliases/Hardfork.md +++ b/tevm/docs/index/type-aliases/Hardfork.md @@ -12,4 +12,4 @@ Ethereum hardfork option ## Defined in -packages/node/dist/index.d.ts:368 +packages/node/dist/index.d.ts:417 diff --git a/tevm/docs/index/type-aliases/Hex.md b/tevm/docs/index/type-aliases/Hex.md index b66ac178c8..0a00fbfc49 100644 --- a/tevm/docs/index/type-aliases/Hex.md +++ b/tevm/docs/index/type-aliases/Hex.md @@ -10,4 +10,4 @@ ## Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/types/misc.d.ts:3 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/types/misc.d.ts:3 diff --git a/tevm/docs/index/type-aliases/IntervalMining.md b/tevm/docs/index/type-aliases/IntervalMining.md index adf0e2250f..1cc92826e5 100644 --- a/tevm/docs/index/type-aliases/IntervalMining.md +++ b/tevm/docs/index/type-aliases/IntervalMining.md @@ -20,4 +20,4 @@ ## Defined in -packages/node/dist/index.d.ts:107 +packages/node/dist/index.d.ts:109 diff --git a/tevm/docs/index/type-aliases/JsonRpcRequestTypeFromMethod.md b/tevm/docs/index/type-aliases/JsonRpcRequestTypeFromMethod.md index ed21e7de1d..16c4d50ffe 100644 --- a/tevm/docs/index/type-aliases/JsonRpcRequestTypeFromMethod.md +++ b/tevm/docs/index/type-aliases/JsonRpcRequestTypeFromMethod.md @@ -10,16 +10,16 @@ Utility type to get the request type given a method name -## Type Parameters - -• **TMethod** *extends* keyof [`EthRequestType`](../../procedures/type-aliases/EthRequestType.md) \| keyof [`TevmRequestType`](../../procedures/type-aliases/TevmRequestType.md) \| keyof [`AnvilRequestType`](../../procedures/type-aliases/AnvilRequestType.md) \| keyof [`DebugRequestType`](../../procedures/type-aliases/DebugRequestType.md) - ## Example ```typescript type BlockNumberRequestType = JsonRpcRequestTypeFromMethod<'eth_blockNumber'> ``` +## Type Parameters + +• **TMethod** *extends* keyof [`EthRequestType`](../../procedures/type-aliases/EthRequestType.md) \| keyof [`TevmRequestType`](../../procedures/type-aliases/TevmRequestType.md) \| keyof [`AnvilRequestType`](../../procedures/type-aliases/AnvilRequestType.md) \| keyof [`DebugRequestType`](../../procedures/type-aliases/DebugRequestType.md) + ## Defined in -packages/procedures/dist/index.d.ts:1344 +packages/procedures/dist/index.d.ts:1349 diff --git a/tevm/docs/index/type-aliases/JsonRpcReturnTypeFromMethod.md b/tevm/docs/index/type-aliases/JsonRpcReturnTypeFromMethod.md index 77c7d6209d..0bfa872ff6 100644 --- a/tevm/docs/index/type-aliases/JsonRpcReturnTypeFromMethod.md +++ b/tevm/docs/index/type-aliases/JsonRpcReturnTypeFromMethod.md @@ -10,16 +10,16 @@ Utility type to get the return type given a method name -## Type Parameters - -• **TMethod** *extends* keyof [`EthReturnType`](../../procedures/type-aliases/EthReturnType.md) \| keyof [`TevmReturnType`](../../procedures/type-aliases/TevmReturnType.md) \| keyof [`AnvilReturnType`](../../procedures/type-aliases/AnvilReturnType.md) \| keyof [`DebugReturnType`](../../procedures/type-aliases/DebugReturnType.md) - ## Example ```typescript type BlockNumberReturnType = JsonRpcReturnTypeFromMethod<'eth_blockNumber'> ``` +## Type Parameters + +• **TMethod** *extends* keyof [`EthReturnType`](../../procedures/type-aliases/EthReturnType.md) \| keyof [`TevmReturnType`](../../procedures/type-aliases/TevmReturnType.md) \| keyof [`AnvilReturnType`](../../procedures/type-aliases/AnvilReturnType.md) \| keyof [`DebugReturnType`](../../procedures/type-aliases/DebugReturnType.md) + ## Defined in -packages/procedures/dist/index.d.ts:1004 +packages/procedures/dist/index.d.ts:1009 diff --git a/tevm/docs/index/type-aliases/LoadStateResult.md b/tevm/docs/index/type-aliases/LoadStateResult.md index 3c949852a3..0cbe897c1f 100644 --- a/tevm/docs/index/type-aliases/LoadStateResult.md +++ b/tevm/docs/index/type-aliases/LoadStateResult.md @@ -12,18 +12,6 @@ Result of the `tevmLoadState` method. This type represents the result returned by the `tevmLoadState` method. It includes any errors that might have occurred during the state loading process. -## Type Parameters - -• **ErrorType** = [`TevmLoadStateError`](TevmLoadStateError.md) - -## Type declaration - -### errors? - -> `optional` **errors**: `ErrorType`[] - -Description of the exception, if any occurred. - ## Example ```typescript @@ -45,6 +33,18 @@ if (result.errors) { [TevmLoadStateError](TevmLoadStateError.md) +## Type Parameters + +• **ErrorType** = [`TevmLoadStateError`](TevmLoadStateError.md) + +## Type declaration + +### errors? + +> `optional` **errors**: `ErrorType`[] + +Description of the exception, if any occurred. + ## Defined in packages/actions/types/LoadState/LoadStateResult.d.ts:25 diff --git a/tevm/docs/index/type-aliases/ManualMining.md b/tevm/docs/index/type-aliases/ManualMining.md index eff0d27bee..380de04cf9 100644 --- a/tevm/docs/index/type-aliases/ManualMining.md +++ b/tevm/docs/index/type-aliases/ManualMining.md @@ -16,4 +16,4 @@ ## Defined in -packages/node/dist/index.d.ts:111 +packages/node/dist/index.d.ts:113 diff --git a/tevm/docs/index/type-aliases/MemoryClient.md b/tevm/docs/index/type-aliases/MemoryClient.md index 9e2a1e0d2c..7ff77fc986 100644 --- a/tevm/docs/index/type-aliases/MemoryClient.md +++ b/tevm/docs/index/type-aliases/MemoryClient.md @@ -6,19 +6,13 @@ # Type Alias: MemoryClient\ -> **MemoryClient**\<`TChain`, `TAccountOrAddress`\>: `Prettify`\<`Client`\<[`TevmTransport`](TevmTransport.md), `TChain`, `TAccountOrAddress` *extends* `Account` ? `Account` : `undefined`, [`TevmRpcSchema`](TevmRpcSchema.md), [`TevmActions`](TevmActions.md) & `PublicActions`\<[`TevmTransport`](TevmTransport.md), `TChain`, `TAccountOrAddress` *extends* `Account` ? `Account` : `undefined`\> & `WalletActions`\<`TChain`, `TAccountOrAddress` *extends* `Account` ? `Account` : `undefined`\> & `TestActions`\>\> +> **MemoryClient**\<`TChain`, `TAccountOrAddress`\>: `Prettify`\<`Client`\<[`TevmTransport`](TevmTransport.md), `TChain`, `TAccountOrAddress` *extends* [`Account`](Account.md) ? [`Account`](Account.md) : `undefined`, [`TevmRpcSchema`](TevmRpcSchema.md), [`TevmActions`](TevmActions.md) & `PublicActions`\<[`TevmTransport`](TevmTransport.md), `TChain`, `TAccountOrAddress` *extends* [`Account`](Account.md) ? [`Account`](Account.md) : `undefined`\> & `WalletActions`\<`TChain`, `TAccountOrAddress` *extends* [`Account`](Account.md) ? [`Account`](Account.md) : `undefined`\> & `TestActions`\>\> Represents a TEVM-enhanced viem client with an in-memory Ethereum client as its transport. The MemoryClient comes preloaded with all wallet, test, public, and TEVM actions, and supports both manual and auto mining modes. This client allows for extensive interaction with the EVM, including making JSON-RPC requests, managing accounts, forking networks, and handling state persistence. -## Type Parameters - -• **TChain** *extends* `Chain` \| `undefined` = `Chain` \| `undefined` - -• **TAccountOrAddress** *extends* `Account` \| [`Address`](Address.md) \| `undefined` = `Account` \| [`Address`](Address.md) \| `undefined` - ## Example ```typescript @@ -199,6 +193,12 @@ const balance = await tevm.runContractCall( console.log(balance); // 1n ``` +## Type Parameters + +• **TChain** *extends* `Chain` \| `undefined` = `Chain` \| `undefined` + +• **TAccountOrAddress** *extends* [`Account`](Account.md) \| [`Address`](Address.md) \| `undefined` = [`Account`](Account.md) \| [`Address`](Address.md) \| `undefined` + ## Defined in packages/memory-client/types/MemoryClient.d.ts:192 diff --git a/tevm/docs/index/type-aliases/MemoryClientOptions.md b/tevm/docs/index/type-aliases/MemoryClientOptions.md index 015831a4ea..ea7ee4aa67 100644 --- a/tevm/docs/index/type-aliases/MemoryClientOptions.md +++ b/tevm/docs/index/type-aliases/MemoryClientOptions.md @@ -13,20 +13,6 @@ Configuration options for creating a [MemoryClient](MemoryClient.md). This type extends `TevmNodeOptions` and includes specific options for configuring the MemoryClient, such as the transport type, account, polling interval, and caching behavior. -## Type Parameters - -• **TCommon** *extends* [`Common`](../../common/type-aliases/Common.md) & `Chain` = [`Common`](../../common/type-aliases/Common.md) & `Chain` - -The common chain configuration, extending both `Common` and `Chain`. - -• **TAccountOrAddress** *extends* `Account` \| [`Address`](Address.md) \| `undefined` = `undefined` - -The account or address type for the client. - -• **TRpcSchema** *extends* `RpcSchema` \| `undefined` = [`TevmRpcSchema`](TevmRpcSchema.md) - -The RPC schema type, defaults to `TevmRpcSchema`. - ## Example ```typescript @@ -52,6 +38,20 @@ const client = createMemoryClient(options); - [MemoryClient](MemoryClient.md) - [CreateMemoryClientFn](CreateMemoryClientFn.md) +## Type Parameters + +• **TCommon** *extends* [`Common`](../../common/type-aliases/Common.md) & `Chain` = [`Common`](../../common/type-aliases/Common.md) & `Chain` + +The common chain configuration, extending both `Common` and `Chain`. + +• **TAccountOrAddress** *extends* [`Account`](Account.md) \| [`Address`](Address.md) \| `undefined` = `undefined` + +The account or address type for the client. + +• **TRpcSchema** *extends* `RpcSchema` \| `undefined` = [`TevmRpcSchema`](TevmRpcSchema.md) + +The RPC schema type, defaults to `TevmRpcSchema`. + ## Defined in packages/memory-client/types/MemoryClientOptions.d.ts:49 diff --git a/tevm/docs/index/type-aliases/MineParams.md b/tevm/docs/index/type-aliases/MineParams.md index f478165d4e..83f1a046e8 100644 --- a/tevm/docs/index/type-aliases/MineParams.md +++ b/tevm/docs/index/type-aliases/MineParams.md @@ -10,6 +10,22 @@ Tevm params to mine one or more blocks. +## Example + +```typescript +const mineParams: import('@tevm/actions').MineParams = { + blockCount: 5, +} +``` + +## Param + +Number of blocks to mine. Defaults to 1. + +## Param + +Interval between block timestamps in seconds. Defaults to 1. + ## Type declaration ### blockCount? @@ -28,22 +44,6 @@ Interval between block timestamps. Defaults to 1. • **TThrowOnFail** *extends* `boolean` = `boolean` -## Example - -```typescript -const mineParams: import('@tevm/actions').MineParams = { - blockCount: 5, -} -``` - -## Param - -Number of blocks to mine. Defaults to 1. - -## Param - -Interval between block timestamps in seconds. Defaults to 1. - ## Defined in packages/actions/types/Mine/MineParams.d.ts:14 diff --git a/tevm/docs/index/type-aliases/MiningConfig.md b/tevm/docs/index/type-aliases/MiningConfig.md index a7cfc52106..04fa1bd8ad 100644 --- a/tevm/docs/index/type-aliases/MiningConfig.md +++ b/tevm/docs/index/type-aliases/MiningConfig.md @@ -10,4 +10,4 @@ ## Defined in -packages/node/dist/index.d.ts:121 +packages/node/dist/index.d.ts:123 diff --git a/tevm/docs/index/type-aliases/ParseAbi.md b/tevm/docs/index/type-aliases/ParseAbi.md index 0deecd096d..b69f7c1973 100644 --- a/tevm/docs/index/type-aliases/ParseAbi.md +++ b/tevm/docs/index/type-aliases/ParseAbi.md @@ -10,12 +10,6 @@ Parses human-readable ABI into JSON [Abi](Abi.md) -## Type Parameters - -• **signatures** *extends* readonly `string`[] - -Human-readable ABI - ## Example ```ts @@ -28,6 +22,12 @@ type Result = ParseAbi< > ``` +## Type Parameters + +• **signatures** *extends* readonly `string`[] + +Human-readable ABI + ## Defined in -node\_modules/.pnpm/abitype@1.0.4\_typescript@5.5.4\_zod@3.23.8/node\_modules/abitype/dist/types/human-readable/parseAbi.d.ts:21 +node\_modules/.pnpm/abitype@1.0.6\_typescript@5.5.4\_zod@3.23.8/node\_modules/abitype/dist/types/human-readable/parseAbi.d.ts:21 diff --git a/tevm/docs/index/type-aliases/ProviderConnectInfo.md b/tevm/docs/index/type-aliases/ProviderConnectInfo.md index 2b8a900081..ed3d65babb 100644 --- a/tevm/docs/index/type-aliases/ProviderConnectInfo.md +++ b/tevm/docs/index/type-aliases/ProviderConnectInfo.md @@ -16,4 +16,4 @@ ## Defined in -packages/node/dist/index.d.ts:18 +packages/node/dist/index.d.ts:20 diff --git a/tevm/docs/index/type-aliases/ProviderMessage.md b/tevm/docs/index/type-aliases/ProviderMessage.md index 2a37c77c3d..24dd37f170 100644 --- a/tevm/docs/index/type-aliases/ProviderMessage.md +++ b/tevm/docs/index/type-aliases/ProviderMessage.md @@ -20,4 +20,4 @@ ## Defined in -packages/node/dist/index.d.ts:21 +packages/node/dist/index.d.ts:23 diff --git a/tevm/docs/index/type-aliases/ReadActionCreator.md b/tevm/docs/index/type-aliases/ReadActionCreator.md index 3d65e26d86..5188364ef2 100644 --- a/tevm/docs/index/type-aliases/ReadActionCreator.md +++ b/tevm/docs/index/type-aliases/ReadActionCreator.md @@ -8,26 +8,38 @@ > **ReadActionCreator**\<`THumanReadableAbi`, `TAddress`, `TCode`, `TAddressArgs`\>: \{ \[TFunctionName in ExtractAbiFunctionNames\, "pure" \| "view"\>\]: Function & Object & (TCode extends undefined ? Object : Object) & TAddressArgs \} -A mapping of view and pure contract methods to action creators +A mapping of view and pure contract methods to action creators. +This type provides a way to create type-safe read actions for contract methods. + +## Example + +```typescript +// Assuming we have a contract with a 'balanceOf' method +const balanceAction = MyContract.read.balanceOf('0x1234...') + +// Use the action with tevm +const balance = await tevm.contract(balanceAction) +console.log('Balance:', balance) +``` ## Type Parameters • **THumanReadableAbi** *extends* readonly `string`[] +The human-readable ABI of the contract. + • **TAddress** *extends* [`Address`](Address.md) \| `undefined` +The address of the contract (optional). + • **TCode** *extends* [`Hex`](Hex.md) \| `undefined` -• **TAddressArgs** = `TAddress` *extends* `undefined` ? `object` : `object` +The runtime bytecode of the contract (optional). -## Example +• **TAddressArgs** = `TAddress` *extends* `undefined` ? `object` : `object` -```typescript -tevm.contract( - MyScript.withAddress('0x420...').read.balanceOf('0x1234...'), -) -``` +Additional arguments for the address (derived from TAddress). ## Defined in -packages/contract/types/read/ReadActionCreator.d.ts:12 +packages/contract/types/read/ReadActionCreator.d.ts:26 diff --git a/tevm/docs/index/type-aliases/ScriptParams.md b/tevm/docs/index/type-aliases/ScriptParams.md index 72c1d90b14..75eafaa32e 100644 --- a/tevm/docs/index/type-aliases/ScriptParams.md +++ b/tevm/docs/index/type-aliases/ScriptParams.md @@ -8,6 +8,11 @@ > **ScriptParams**\<`TAbi`, `TFunctionName`, `TThrowOnFail`\>: [`EncodeFunctionDataParameters`](EncodeFunctionDataParameters.md)\<`TAbi`, `TFunctionName`\> & `BaseCallParams`\<`TThrowOnFail`\> & `object` +## Deprecated + +Can use `ContraactParams` instead +Tevm params for deploying and running a script + ## Type declaration ### ~~deployedBytecode~~ @@ -24,11 +29,6 @@ The EVM code to run. • **TThrowOnFail** *extends* `boolean` = `boolean` -## Deprecated - -Can use `ContraactParams` instead -Tevm params for deploying and running a script - ## Defined in packages/actions/types/Script/ScriptParams.d.ts:8 diff --git a/tevm/docs/index/type-aliases/ScriptResult.md b/tevm/docs/index/type-aliases/ScriptResult.md index 2faaca5505..c272ac2cb3 100644 --- a/tevm/docs/index/type-aliases/ScriptResult.md +++ b/tevm/docs/index/type-aliases/ScriptResult.md @@ -8,6 +8,10 @@ > **ScriptResult**\<`TAbi`, `TFunctionName`, `TErrorType`\>: [`ContractResult`](ContractResult.md)\<`TAbi`, `TFunctionName`, `TErrorType`\> +## Deprecated + +Can use `ContractResult` instead + ## Type Parameters • **TAbi** *extends* `Abi` \| readonly `unknown`[] = `Abi` @@ -16,10 +20,6 @@ • **TErrorType** = [`TevmScriptError`](TevmScriptError.md) -## Deprecated - -Can use `ContractResult` instead - ## Defined in packages/actions/types/Script/ScriptResult.d.ts:8 diff --git a/tevm/docs/index/type-aliases/SetAccountParams.md b/tevm/docs/index/type-aliases/SetAccountParams.md index a746e40be6..9982c6d9f8 100644 --- a/tevm/docs/index/type-aliases/SetAccountParams.md +++ b/tevm/docs/index/type-aliases/SetAccountParams.md @@ -11,6 +11,18 @@ Tevm params to set an account in the vm state all fields are optional except address +## Example + +```ts +const accountParams: import('tevm/api').SetAccountParams = { + account: '0x...', + nonce: 5n, + balance: 9000000000000n, + storageRoot: '0x....', + deployedBytecode: '0x....' +} +``` + ## Type declaration ### address @@ -59,18 +71,6 @@ Storage root to set account to • **TThrowOnFail** *extends* `boolean` = `boolean` -## Example - -```ts -const accountParams: import('tevm/api').SetAccountParams = { - account: '0x...', - nonce: 5n, - balance: 9000000000000n, - storageRoot: '0x....', - deployedBytecode: '0x....' -} -``` - ## Defined in packages/actions/types/SetAccount/SetAccountParams.d.ts:16 diff --git a/tevm/docs/index/type-aliases/TevmActions.md b/tevm/docs/index/type-aliases/TevmActions.md index ff5732ac3a..2fe5ec0c5a 100644 --- a/tevm/docs/index/type-aliases/TevmActions.md +++ b/tevm/docs/index/type-aliases/TevmActions.md @@ -11,6 +11,11 @@ Provides powerful actions for interacting with the EVM using the TEVM API. These actions allow for low-level access to the EVM, managing accounts, deploying contracts, and more. +## See + + - [Actions Guide](https://tevm.sh/learn/actions/) + - [Viem Actions API](https://viem.sh/docs/actions/introduction) + ## Type declaration ### tevm @@ -222,10 +227,6 @@ await client.tevmMine() Returns a promise that resolves when the TEVM is ready. This is not needed to explicitly be called as all actions will wait for the TEVM to be ready. -#### Returns - -`Promise`\<`true`\> - #### Example ```typescript @@ -237,6 +238,10 @@ await client.tevmReady() ``` Same as calling `client.tevm.ready()` +#### Returns + +`Promise`\<`true`\> + ### ~~tevmScript~~ > **tevmScript**: [`TevmActionsApi`](TevmActionsApi.md)\[`"script"`\] @@ -296,11 +301,6 @@ await client.tevmSetAccount({ }) ``` -## See - - - [Actions Guide](https://tevm.sh/learn/actions/) - - [Viem Actions API](https://viem.sh/docs/actions/introduction) - ## Defined in packages/memory-client/types/TevmActions.d.ts:10 diff --git a/tevm/docs/index/type-aliases/TevmActionsApi.md b/tevm/docs/index/type-aliases/TevmActionsApi.md index 5ebc46778f..f4ee679bb4 100644 --- a/tevm/docs/index/type-aliases/TevmActionsApi.md +++ b/tevm/docs/index/type-aliases/TevmActionsApi.md @@ -10,6 +10,10 @@ The actions api is the high level API for interacting with a Tevm client similar to [viem actions](https://viem.sh/learn/actions/) +## See + +[https://tevm.sh/learn/actions/](https://tevm.sh/learn/actions/) + ## Type declaration ### call @@ -178,10 +182,6 @@ await tevm.setAccount({ }) ``` -## See - -[https://tevm.sh/learn/actions/](https://tevm.sh/learn/actions/) - ## Defined in packages/decorators/dist/index.d.ts:95 diff --git a/tevm/docs/index/type-aliases/TevmClient.md b/tevm/docs/index/type-aliases/TevmClient.md index 506e2ef46e..663a71165b 100644 --- a/tevm/docs/index/type-aliases/TevmClient.md +++ b/tevm/docs/index/type-aliases/TevmClient.md @@ -8,6 +8,62 @@ > **TevmClient**: `object` +## Deprecated + +This type has been superseded by Provider types from `@tevm/decorators` package +The docs have not been updated to reflect this change if you are looking at this + +A local EVM instance running in the browser, Bun, or Node.js. Akin to anvil or ganache. The TevmClient interface +is a unified interface that all Clients implement. This provides a consistent developer experience no matter how you are +using Tevm. + +## See + +[TevmClient guide](https://tevm.sh/learn/clients/) for more documentation on clients + +#### JSON-RPC + +Tevm exposes a JSON-RPC interface for interacting with the EVM via the TevmClient.request + +## Examples + +```typescript +import {createMemoryClient, type Tevm} from 'tevm' + +const tevm: Tevm = createMemoryClient() + +await tevm.request({ + method: 'eth_blockNumber', + params: [], + id: 1, + jsonrpc: '2.0', +}) // 0n +``` + +#### Actions + +TevmClient exposes a higher level `actions` based api similar to [viem](https://viem.sh) for interacting with TevmClient in a typesasafe +ergonomic way. + +```typescript +// same as eth_blockNumber example +const account = await tevm.account({address: `0x${'0'.repeat(40)}`}) +console.log(account.balance) // 0n +``` + +#### Ethereum actions + +Ethereum actions are namespaced under TevmClient.eth + +```typescript +const blockNumber = await tevm.eth.blockNumber() +console.log(blockNumber) // 0n +``` + +#### Anvil hardhat and ganache compatibility + +Will have anvil_* ganache_* and hardhat_* JSON-RPC compatibility in future versions + ## Type declaration ### ~~call~~ @@ -419,62 +475,6 @@ await tevm.setAccount({ }) ``` -## Deprecated - -This type has been superseded by Provider types from `@tevm/decorators` package -The docs have not been updated to reflect this change if you are looking at this - -A local EVM instance running in the browser, Bun, or Node.js. Akin to anvil or ganache. The TevmClient interface -is a unified interface that all Clients implement. This provides a consistent developer experience no matter how you are -using Tevm. - -## See - -[TevmClient guide](https://tevm.sh/learn/clients/) for more documentation on clients - -#### JSON-RPC - -Tevm exposes a JSON-RPC interface for interacting with the EVM via the TevmClient.request - -## Examples - -```typescript -import {createMemoryClient, type Tevm} from 'tevm' - -const tevm: Tevm = createMemoryClient() - -await tevm.request({ - method: 'eth_blockNumber', - params: [], - id: 1, - jsonrpc: '2.0', -}) // 0n -``` - -#### Actions - -TevmClient exposes a higher level `actions` based api similar to [viem](https://viem.sh) for interacting with TevmClient in a typesasafe -ergonomic way. - -```typescript -// same as eth_blockNumber example -const account = await tevm.account({address: `0x${'0'.repeat(40)}`}) -console.log(account.balance) // 0n -``` - -#### Ethereum actions - -Ethereum actions are namespaced under TevmClient.eth - -```typescript -const blockNumber = await tevm.eth.blockNumber() -console.log(blockNumber) // 0n -``` - -#### Anvil hardhat and ganache compatibility - -Will have anvil_* ganache_* and hardhat_* JSON-RPC compatibility in future versions - ## Defined in packages/client-types/types/TevmClient.d.ts:111 diff --git a/tevm/docs/index/type-aliases/TevmJsonRpcBulkRequestHandler.md b/tevm/docs/index/type-aliases/TevmJsonRpcBulkRequestHandler.md index 80d3329d30..58dfb60952 100644 --- a/tevm/docs/index/type-aliases/TevmJsonRpcBulkRequestHandler.md +++ b/tevm/docs/index/type-aliases/TevmJsonRpcBulkRequestHandler.md @@ -15,14 +15,6 @@ will be added in the future. Currently is not very generic with regard to input and output types. -## Parameters - -• **requests**: `ReadonlyArray`\<[`TevmJsonRpcRequest`](TevmJsonRpcRequest.md) \| [`EthJsonRpcRequest`](../../procedures/type-aliases/EthJsonRpcRequest.md) \| [`AnvilJsonRpcRequest`](../../procedures/type-aliases/AnvilJsonRpcRequest.md) \| [`DebugJsonRpcRequest`](../../procedures/type-aliases/DebugJsonRpcRequest.md)\> - -## Returns - -`Promise`\<[`JsonRpcReturnTypeFromMethod`](JsonRpcReturnTypeFromMethod.md)\<`any`\>[]\> - ## Example ```typescript @@ -95,6 +87,14 @@ response - [EthGasPriceJsonRpcResponse](../../procedures/type-aliases/EthGasPric request - [EthGetBalanceJsonRpcRequest](../../procedures/type-aliases/EthGetBalanceJsonRpcRequest.md) response - [EthGetBalanceJsonRpcResponse](../../procedures/type-aliases/EthGetBalanceJsonRpcResponse.md) +## Parameters + +• **requests**: `ReadonlyArray`\<[`TevmJsonRpcRequest`](TevmJsonRpcRequest.md) \| [`EthJsonRpcRequest`](../../procedures/type-aliases/EthJsonRpcRequest.md) \| [`AnvilJsonRpcRequest`](../../procedures/type-aliases/AnvilJsonRpcRequest.md) \| [`DebugJsonRpcRequest`](../../procedures/type-aliases/DebugJsonRpcRequest.md)\> + +## Returns + +`Promise`\<[`JsonRpcReturnTypeFromMethod`](JsonRpcReturnTypeFromMethod.md)\<`any`\>[]\> + ## Defined in -packages/procedures/dist/index.d.ts:1164 +packages/procedures/dist/index.d.ts:1169 diff --git a/tevm/docs/index/type-aliases/TevmJsonRpcRequestHandler.md b/tevm/docs/index/type-aliases/TevmJsonRpcRequestHandler.md index 1eb33f8d43..058b0262ef 100644 --- a/tevm/docs/index/type-aliases/TevmJsonRpcRequestHandler.md +++ b/tevm/docs/index/type-aliases/TevmJsonRpcRequestHandler.md @@ -11,18 +11,6 @@ Typesafe request handler for JSON-RPC requests. Most users will want to use the higher level and more feature-rich `actions` api -## Type Parameters - -• **TRequest** *extends* [`TevmJsonRpcRequest`](TevmJsonRpcRequest.md) \| [`EthJsonRpcRequest`](../../procedures/type-aliases/EthJsonRpcRequest.md) \| [`AnvilJsonRpcRequest`](../../procedures/type-aliases/AnvilJsonRpcRequest.md) \| [`DebugJsonRpcRequest`](../../procedures/type-aliases/DebugJsonRpcRequest.md) - -## Parameters - -• **request**: `TRequest` - -## Returns - -`Promise`\<[`JsonRpcReturnTypeFromMethod`](JsonRpcReturnTypeFromMethod.md)\<`TRequest`\[`"method"`\]\>\> - ## Example ```typescript @@ -96,6 +84,18 @@ response - [EthGasPriceJsonRpcResponse](../../procedures/type-aliases/EthGasPric request - [EthGetBalanceJsonRpcRequest](../../procedures/type-aliases/EthGetBalanceJsonRpcRequest.md) response - [EthGetBalanceJsonRpcResponse](../../procedures/type-aliases/EthGetBalanceJsonRpcResponse.md) +## Type Parameters + +• **TRequest** *extends* [`TevmJsonRpcRequest`](TevmJsonRpcRequest.md) \| [`EthJsonRpcRequest`](../../procedures/type-aliases/EthJsonRpcRequest.md) \| [`AnvilJsonRpcRequest`](../../procedures/type-aliases/AnvilJsonRpcRequest.md) \| [`DebugJsonRpcRequest`](../../procedures/type-aliases/DebugJsonRpcRequest.md) + +## Parameters + +• **request**: `TRequest` + +## Returns + +`Promise`\<[`JsonRpcReturnTypeFromMethod`](JsonRpcReturnTypeFromMethod.md)\<`TRequest`\[`"method"`\]\>\> + ## Defined in -packages/procedures/dist/index.d.ts:1081 +packages/procedures/dist/index.d.ts:1086 diff --git a/tevm/docs/index/type-aliases/TevmNode.md b/tevm/docs/index/type-aliases/TevmNode.md index 104136c7b8..213c577d51 100644 --- a/tevm/docs/index/type-aliases/TevmNode.md +++ b/tevm/docs/index/type-aliases/TevmNode.md @@ -149,10 +149,6 @@ Returns promise that resulves when the client is ready The client is usable without calling this method but may have extra latency on the first call from initialization -#### Returns - -`Promise`\<`true`\> - #### Example ```ts @@ -160,6 +156,10 @@ const client = createMemoryClient() await client.ready() ``` +#### Returns + +`Promise`\<`true`\> + ### removeFilter() > `readonly` **removeFilter**: (`id`) => `void` @@ -221,4 +221,4 @@ Returns status of the client ## Defined in -packages/node/dist/index.d.ts:126 +packages/node/dist/index.d.ts:128 diff --git a/tevm/docs/index/type-aliases/TevmNodeOptions.md b/tevm/docs/index/type-aliases/TevmNodeOptions.md index a3a2afb435..67c7569d06 100644 --- a/tevm/docs/index/type-aliases/TevmNodeOptions.md +++ b/tevm/docs/index/type-aliases/TevmNodeOptions.md @@ -156,4 +156,4 @@ Enable profiler. Defaults to false. ## Defined in -packages/node/dist/index.d.ts:240 +packages/node/dist/index.d.ts:242 diff --git a/tevm/docs/index/type-aliases/TevmViemActionsApi.md b/tevm/docs/index/type-aliases/TevmViemActionsApi.md index ee9da6b151..3231169e9b 100644 --- a/tevm/docs/index/type-aliases/TevmViemActionsApi.md +++ b/tevm/docs/index/type-aliases/TevmViemActionsApi.md @@ -12,6 +12,15 @@ A custom [viem extension](https://viem.sh/docs/clients/custom#extending-with-act Tevm specific actions to the client. These actions come preloaded with [MemoryClient](https://tevm.sh/reference/tevm/memory-client/type-aliases/memoryclient/) To add these actions use the `extend` method on a TevmClient with the tevmViemActions() extension. +## Example + +```typescript +import { createTevmClient, tevmViemActions } from 'tevm' + +const client = createTevmClient() + .extend(tevmViemActions()) +``` + ## Type declaration ### tevm @@ -58,15 +67,6 @@ To add these actions use the `extend` method on a TevmClient with the tevmViemAc > **tevmSetAccount**: [`TevmActionsApi`](TevmActionsApi.md)\[`"setAccount"`\] -## Example - -```typescript -import { createTevmClient, tevmViemActions } from 'tevm' - -const client = createTevmClient() - .extend(tevmViemActions()) -``` - ## Defined in packages/memory-client/types/TevmViemActionsApi.d.ts:15 diff --git a/tevm/docs/index/type-aliases/WriteActionCreator.md b/tevm/docs/index/type-aliases/WriteActionCreator.md index 0fef8d25b4..13ccb13e34 100644 --- a/tevm/docs/index/type-aliases/WriteActionCreator.md +++ b/tevm/docs/index/type-aliases/WriteActionCreator.md @@ -8,26 +8,38 @@ > **WriteActionCreator**\<`THumanReadableAbi`, `TAddress`, `TCode`, `TAddressArgs`\>: \{ \[TFunctionName in ExtractAbiFunctionNames\, "payable" \| "nonpayable"\>\]: Function & Object & (TCode extends undefined ? Object : Object) & TAddressArgs \} -A mapping of payable and nonpayable contract methods to action creators +A mapping of payable and nonpayable contract methods to action creators. +This type provides a way to create type-safe write actions for contract methods. + +## Example + +```typescript +// Assuming we have a contract with a 'transfer' method +const transferAction = MyContract.write.transfer('0x1234...', 1000n) + +// Use the action with tevm +const result = await tevm.contract(transferAction) +console.log('Transaction hash:', result.transactionHash) +``` ## Type Parameters • **THumanReadableAbi** *extends* readonly `string`[] +The human-readable ABI of the contract. + • **TAddress** *extends* [`Address`](Address.md) \| `undefined` +The address of the contract (optional). + • **TCode** *extends* [`Hex`](Hex.md) \| `undefined` -• **TAddressArgs** = `TAddress` *extends* `undefined` ? `object` : `object` +The runtime bytecode of the contract (optional). -## Example +• **TAddressArgs** = `TAddress` *extends* `undefined` ? `object` : `object` -```typescript -tevm.contract( - MyContract.withAddress('0x420...').read.balanceOf('0x1234...'), -) -``` +Additional arguments for the address (derived from TAddress). ## Defined in -packages/contract/types/write/WriteActionCreator.d.ts:12 +packages/contract/types/write/WriteActionCreator.d.ts:26 diff --git a/tevm/docs/index/variables/GENESIS_STATE.md b/tevm/docs/index/variables/GENESIS_STATE.md index c1f1c349c3..a63c629b98 100644 --- a/tevm/docs/index/variables/GENESIS_STATE.md +++ b/tevm/docs/index/variables/GENESIS_STATE.md @@ -10,4 +10,4 @@ ## Defined in -packages/node/dist/index.d.ts:379 +packages/node/dist/index.d.ts:428 diff --git a/tevm/docs/index/variables/PREFUNDED_ACCOUNTS.md b/tevm/docs/index/variables/PREFUNDED_ACCOUNTS.md index b76ac55342..2384fc615e 100644 --- a/tevm/docs/index/variables/PREFUNDED_ACCOUNTS.md +++ b/tevm/docs/index/variables/PREFUNDED_ACCOUNTS.md @@ -6,8 +6,8 @@ # Variable: PREFUNDED\_ACCOUNTS -> `const` **PREFUNDED\_ACCOUNTS**: readonly [`PrivateKeyAccount`, `PrivateKeyAccount`, `PrivateKeyAccount`, `PrivateKeyAccount`, `PrivateKeyAccount`, `PrivateKeyAccount`, `PrivateKeyAccount`, `PrivateKeyAccount`, `PrivateKeyAccount`, `PrivateKeyAccount`] +> `const` **PREFUNDED\_ACCOUNTS**: [`PrivateKeyAccount`, `PrivateKeyAccount`, `PrivateKeyAccount`, `PrivateKeyAccount`, `PrivateKeyAccount`, `PrivateKeyAccount`, `PrivateKeyAccount`, `PrivateKeyAccount`, `PrivateKeyAccount`, `PrivateKeyAccount`] ## Defined in -packages/utils/types/prefundedAccounts.d.ts:3 +packages/utils/types/prefundedAccounts.d.ts:4 diff --git a/tevm/docs/index/variables/PREFUNDED_PRIVATE_KEYS.md b/tevm/docs/index/variables/PREFUNDED_PRIVATE_KEYS.md index e4059b69c2..a52dfa05d6 100644 --- a/tevm/docs/index/variables/PREFUNDED_PRIVATE_KEYS.md +++ b/tevm/docs/index/variables/PREFUNDED_PRIVATE_KEYS.md @@ -10,4 +10,4 @@ ## Defined in -packages/utils/types/prefundedAccounts.d.ts:1 +packages/utils/types/prefundedAccounts.d.ts:2 diff --git a/tevm/docs/index/variables/PREFUNDED_PUBLIC_KEYS.md b/tevm/docs/index/variables/PREFUNDED_PUBLIC_KEYS.md index e2567586fd..a089b23dd9 100644 --- a/tevm/docs/index/variables/PREFUNDED_PUBLIC_KEYS.md +++ b/tevm/docs/index/variables/PREFUNDED_PUBLIC_KEYS.md @@ -10,4 +10,4 @@ ## Defined in -packages/utils/types/prefundedAccounts.d.ts:2 +packages/utils/types/prefundedAccounts.d.ts:3 diff --git a/tevm/docs/index/variables/PREFUNDED_SEED.md b/tevm/docs/index/variables/PREFUNDED_SEED.md index 400115c799..e15088ae49 100644 --- a/tevm/docs/index/variables/PREFUNDED_SEED.md +++ b/tevm/docs/index/variables/PREFUNDED_SEED.md @@ -20,4 +20,4 @@ ## Defined in -packages/utils/types/prefundedAccounts.d.ts:4 +packages/utils/types/prefundedAccounts.d.ts:16 diff --git a/tevm/docs/index/variables/prefundedAccounts.md b/tevm/docs/index/variables/prefundedAccounts.md index f0fd4c09a9..44813c52ed 100644 --- a/tevm/docs/index/variables/prefundedAccounts.md +++ b/tevm/docs/index/variables/prefundedAccounts.md @@ -13,4 +13,4 @@ Also including zero address ## Defined in -packages/node/dist/index.d.ts:375 +packages/node/dist/index.d.ts:424 diff --git a/tevm/docs/node/type-aliases/BaseClientOptions.md b/tevm/docs/node/type-aliases/BaseClientOptions.md index f7b79b0d39..0c2636d24d 100644 --- a/tevm/docs/node/type-aliases/BaseClientOptions.md +++ b/tevm/docs/node/type-aliases/BaseClientOptions.md @@ -14,4 +14,4 @@ Use [TevmNodeOptions](../../index/type-aliases/TevmNodeOptions.md) instead. ## Defined in -packages/node/dist/index.d.ts:361 +packages/node/dist/index.d.ts:410 diff --git a/tevm/docs/predeploys/type-aliases/DefinePredeployFn.md b/tevm/docs/predeploys/type-aliases/DefinePredeployFn.md index 40d4d7a3f4..31d278ca46 100644 --- a/tevm/docs/predeploys/type-aliases/DefinePredeployFn.md +++ b/tevm/docs/predeploys/type-aliases/DefinePredeployFn.md @@ -10,20 +10,6 @@ Defines a predeploy contract to use in the tevm vm -## Type Parameters - -• **TName** *extends* `string` - -• **THumanReadableAbi** *extends* readonly `string`[] - -## Parameters - -• **contract**: [`Contract`](../../index/type-aliases/Contract.md)\<`TName`, `THumanReadableAbi`, [`Address`](../../index/type-aliases/Address.md), [`Hex`](../../index/type-aliases/Hex.md), [`Hex`](../../index/type-aliases/Hex.md)\> - -## Returns - -[`Predeploy`](../../index/type-aliases/Predeploy.md)\<`TName`, `THumanReadableAbi`\> - ## Example ```ts @@ -46,6 +32,20 @@ const vm = createMemoryClient({ }) ``` +## Type Parameters + +• **TName** *extends* `string` + +• **THumanReadableAbi** *extends* readonly `string`[] + +## Parameters + +• **contract**: [`Contract`](../../index/type-aliases/Contract.md)\<`TName`, `THumanReadableAbi`, [`Address`](../../index/type-aliases/Address.md), [`Hex`](../../index/type-aliases/Hex.md), [`Hex`](../../index/type-aliases/Hex.md)\> + +## Returns + +[`Predeploy`](../../index/type-aliases/Predeploy.md)\<`TName`, `THumanReadableAbi`\> + ## Defined in packages/predeploys/types/DefinePredeployFn.d.ts:27 diff --git a/tevm/docs/procedures/functions/anvilDropTransactionJsonRpcProcedure.md b/tevm/docs/procedures/functions/anvilDropTransactionJsonRpcProcedure.md index 221ac6da72..a53ccb1fa3 100644 --- a/tevm/docs/procedures/functions/anvilDropTransactionJsonRpcProcedure.md +++ b/tevm/docs/procedures/functions/anvilDropTransactionJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:825 +packages/procedures/dist/index.d.ts:830 diff --git a/tevm/docs/procedures/functions/anvilDumpStateJsonRpcProcedure.md b/tevm/docs/procedures/functions/anvilDumpStateJsonRpcProcedure.md index a9273469a6..35a86f5314 100644 --- a/tevm/docs/procedures/functions/anvilDumpStateJsonRpcProcedure.md +++ b/tevm/docs/procedures/functions/anvilDumpStateJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:827 +packages/procedures/dist/index.d.ts:832 diff --git a/tevm/docs/procedures/functions/anvilGetAutomineJsonRpcProcedure.md b/tevm/docs/procedures/functions/anvilGetAutomineJsonRpcProcedure.md index 9fb5371fcf..ad41156df8 100644 --- a/tevm/docs/procedures/functions/anvilGetAutomineJsonRpcProcedure.md +++ b/tevm/docs/procedures/functions/anvilGetAutomineJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:829 +packages/procedures/dist/index.d.ts:834 diff --git a/tevm/docs/procedures/functions/anvilImpersonateAccountJsonRpcProcedure.md b/tevm/docs/procedures/functions/anvilImpersonateAccountJsonRpcProcedure.md index 3ec468175f..b98a0dd887 100644 --- a/tevm/docs/procedures/functions/anvilImpersonateAccountJsonRpcProcedure.md +++ b/tevm/docs/procedures/functions/anvilImpersonateAccountJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:831 +packages/procedures/dist/index.d.ts:836 diff --git a/tevm/docs/procedures/functions/anvilLoadStateJsonRpcProcedure.md b/tevm/docs/procedures/functions/anvilLoadStateJsonRpcProcedure.md index a90a7d82d8..4e81cf8967 100644 --- a/tevm/docs/procedures/functions/anvilLoadStateJsonRpcProcedure.md +++ b/tevm/docs/procedures/functions/anvilLoadStateJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:833 +packages/procedures/dist/index.d.ts:838 diff --git a/tevm/docs/procedures/functions/anvilResetJsonRpcProcedure.md b/tevm/docs/procedures/functions/anvilResetJsonRpcProcedure.md index a1cef67f9e..6c168dd88b 100644 --- a/tevm/docs/procedures/functions/anvilResetJsonRpcProcedure.md +++ b/tevm/docs/procedures/functions/anvilResetJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:835 +packages/procedures/dist/index.d.ts:840 diff --git a/tevm/docs/procedures/functions/anvilSetBalanceJsonRpcProcedure.md b/tevm/docs/procedures/functions/anvilSetBalanceJsonRpcProcedure.md index 09919472f0..bc069279f6 100644 --- a/tevm/docs/procedures/functions/anvilSetBalanceJsonRpcProcedure.md +++ b/tevm/docs/procedures/functions/anvilSetBalanceJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:837 +packages/procedures/dist/index.d.ts:842 diff --git a/tevm/docs/procedures/functions/anvilSetChainIdJsonRpcProcedure.md b/tevm/docs/procedures/functions/anvilSetChainIdJsonRpcProcedure.md index 7b96e88a18..5b2bab7566 100644 --- a/tevm/docs/procedures/functions/anvilSetChainIdJsonRpcProcedure.md +++ b/tevm/docs/procedures/functions/anvilSetChainIdJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:839 +packages/procedures/dist/index.d.ts:844 diff --git a/tevm/docs/procedures/functions/anvilSetCoinbaseJsonRpcProcedure.md b/tevm/docs/procedures/functions/anvilSetCoinbaseJsonRpcProcedure.md index 4b82133eae..e933e6080b 100644 --- a/tevm/docs/procedures/functions/anvilSetCoinbaseJsonRpcProcedure.md +++ b/tevm/docs/procedures/functions/anvilSetCoinbaseJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:841 +packages/procedures/dist/index.d.ts:846 diff --git a/tevm/docs/procedures/functions/anvilSetNonceJsonRpcProcedure.md b/tevm/docs/procedures/functions/anvilSetNonceJsonRpcProcedure.md index f61bc18940..c9bcc71720 100644 --- a/tevm/docs/procedures/functions/anvilSetNonceJsonRpcProcedure.md +++ b/tevm/docs/procedures/functions/anvilSetNonceJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:843 +packages/procedures/dist/index.d.ts:848 diff --git a/tevm/docs/procedures/functions/anvilSetStorageAtJsonRpcProcedure.md b/tevm/docs/procedures/functions/anvilSetStorageAtJsonRpcProcedure.md index fa405feea4..bc1074e68a 100644 --- a/tevm/docs/procedures/functions/anvilSetStorageAtJsonRpcProcedure.md +++ b/tevm/docs/procedures/functions/anvilSetStorageAtJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:845 +packages/procedures/dist/index.d.ts:850 diff --git a/tevm/docs/procedures/functions/anvilStopImpersonatingAccountJsonRpcProcedure.md b/tevm/docs/procedures/functions/anvilStopImpersonatingAccountJsonRpcProcedure.md index 4e933d4362..2356af9bfe 100644 --- a/tevm/docs/procedures/functions/anvilStopImpersonatingAccountJsonRpcProcedure.md +++ b/tevm/docs/procedures/functions/anvilStopImpersonatingAccountJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:847 +packages/procedures/dist/index.d.ts:852 diff --git a/tevm/docs/procedures/functions/blockNumberProcedure.md b/tevm/docs/procedures/functions/blockNumberProcedure.md index a9bca4b7a2..24d382a25f 100644 --- a/tevm/docs/procedures/functions/blockNumberProcedure.md +++ b/tevm/docs/procedures/functions/blockNumberProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:641 +packages/procedures/dist/index.d.ts:646 diff --git a/tevm/docs/procedures/functions/blockToJsonRpcBlock.md b/tevm/docs/procedures/functions/blockToJsonRpcBlock.md index 9e7ffd7777..3307d2b321 100644 --- a/tevm/docs/procedures/functions/blockToJsonRpcBlock.md +++ b/tevm/docs/procedures/functions/blockToJsonRpcBlock.md @@ -20,4 +20,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:1346 +packages/procedures/dist/index.d.ts:1351 diff --git a/tevm/docs/procedures/functions/callProcedure.md b/tevm/docs/procedures/functions/callProcedure.md index 2bffd37bde..d600326d6a 100644 --- a/tevm/docs/procedures/functions/callProcedure.md +++ b/tevm/docs/procedures/functions/callProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:1173 +packages/procedures/dist/index.d.ts:1178 diff --git a/tevm/docs/procedures/functions/chainIdProcedure.md b/tevm/docs/procedures/functions/chainIdProcedure.md index a80eaefd0a..73104ae560 100644 --- a/tevm/docs/procedures/functions/chainIdProcedure.md +++ b/tevm/docs/procedures/functions/chainIdProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:643 +packages/procedures/dist/index.d.ts:648 diff --git a/tevm/docs/procedures/functions/debugTraceCallJsonRpcProcedure.md b/tevm/docs/procedures/functions/debugTraceCallJsonRpcProcedure.md index 984c248910..b1314d1c35 100644 --- a/tevm/docs/procedures/functions/debugTraceCallJsonRpcProcedure.md +++ b/tevm/docs/procedures/functions/debugTraceCallJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:1184 +packages/procedures/dist/index.d.ts:1189 diff --git a/tevm/docs/procedures/functions/debugTraceTransactionJsonRpcProcedure.md b/tevm/docs/procedures/functions/debugTraceTransactionJsonRpcProcedure.md index 82eebb77a5..315f42082c 100644 --- a/tevm/docs/procedures/functions/debugTraceTransactionJsonRpcProcedure.md +++ b/tevm/docs/procedures/functions/debugTraceTransactionJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:1186 +packages/procedures/dist/index.d.ts:1191 diff --git a/tevm/docs/procedures/functions/dumpStateProcedure.md b/tevm/docs/procedures/functions/dumpStateProcedure.md index 206695f6c6..e33ce0e220 100644 --- a/tevm/docs/procedures/functions/dumpStateProcedure.md +++ b/tevm/docs/procedures/functions/dumpStateProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:1202 +packages/procedures/dist/index.d.ts:1207 diff --git a/tevm/docs/procedures/functions/ethAccountsProcedure.md b/tevm/docs/procedures/functions/ethAccountsProcedure.md index 0b45d95a8f..06aeb037d1 100644 --- a/tevm/docs/procedures/functions/ethAccountsProcedure.md +++ b/tevm/docs/procedures/functions/ethAccountsProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:645 +packages/procedures/dist/index.d.ts:650 diff --git a/tevm/docs/procedures/functions/ethBlobBaseFeeJsonRpcProcedure.md b/tevm/docs/procedures/functions/ethBlobBaseFeeJsonRpcProcedure.md index decb37771a..fa20548d5b 100644 --- a/tevm/docs/procedures/functions/ethBlobBaseFeeJsonRpcProcedure.md +++ b/tevm/docs/procedures/functions/ethBlobBaseFeeJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:647 +packages/procedures/dist/index.d.ts:652 diff --git a/tevm/docs/procedures/functions/ethCallProcedure.md b/tevm/docs/procedures/functions/ethCallProcedure.md index f2f22697c6..f751bb8c22 100644 --- a/tevm/docs/procedures/functions/ethCallProcedure.md +++ b/tevm/docs/procedures/functions/ethCallProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:649 +packages/procedures/dist/index.d.ts:654 diff --git a/tevm/docs/procedures/functions/ethCoinbaseJsonRpcProcedure.md b/tevm/docs/procedures/functions/ethCoinbaseJsonRpcProcedure.md index 5aedd6e523..ba32d12de0 100644 --- a/tevm/docs/procedures/functions/ethCoinbaseJsonRpcProcedure.md +++ b/tevm/docs/procedures/functions/ethCoinbaseJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:651 +packages/procedures/dist/index.d.ts:656 diff --git a/tevm/docs/procedures/functions/ethEstimateGasJsonRpcProcedure.md b/tevm/docs/procedures/functions/ethEstimateGasJsonRpcProcedure.md index 66ac17d74d..648c78f163 100644 --- a/tevm/docs/procedures/functions/ethEstimateGasJsonRpcProcedure.md +++ b/tevm/docs/procedures/functions/ethEstimateGasJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:653 +packages/procedures/dist/index.d.ts:658 diff --git a/tevm/docs/procedures/functions/ethGetBlockByHashJsonRpcProcedure.md b/tevm/docs/procedures/functions/ethGetBlockByHashJsonRpcProcedure.md index 238c0f481d..a7b094ef59 100644 --- a/tevm/docs/procedures/functions/ethGetBlockByHashJsonRpcProcedure.md +++ b/tevm/docs/procedures/functions/ethGetBlockByHashJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:655 +packages/procedures/dist/index.d.ts:660 diff --git a/tevm/docs/procedures/functions/ethGetBlockByNumberJsonRpcProcedure.md b/tevm/docs/procedures/functions/ethGetBlockByNumberJsonRpcProcedure.md index 03161f3a2b..f0493488f6 100644 --- a/tevm/docs/procedures/functions/ethGetBlockByNumberJsonRpcProcedure.md +++ b/tevm/docs/procedures/functions/ethGetBlockByNumberJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:657 +packages/procedures/dist/index.d.ts:662 diff --git a/tevm/docs/procedures/functions/ethGetBlockTransactionCountByHashJsonRpcProcedure.md b/tevm/docs/procedures/functions/ethGetBlockTransactionCountByHashJsonRpcProcedure.md index a3b21ff6a8..16a9a3bf0d 100644 --- a/tevm/docs/procedures/functions/ethGetBlockTransactionCountByHashJsonRpcProcedure.md +++ b/tevm/docs/procedures/functions/ethGetBlockTransactionCountByHashJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:659 +packages/procedures/dist/index.d.ts:664 diff --git a/tevm/docs/procedures/functions/ethGetBlockTransactionCountByNumberJsonRpcProcedure.md b/tevm/docs/procedures/functions/ethGetBlockTransactionCountByNumberJsonRpcProcedure.md index 719f59df73..4d8ece3ae8 100644 --- a/tevm/docs/procedures/functions/ethGetBlockTransactionCountByNumberJsonRpcProcedure.md +++ b/tevm/docs/procedures/functions/ethGetBlockTransactionCountByNumberJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:661 +packages/procedures/dist/index.d.ts:666 diff --git a/tevm/docs/procedures/functions/ethGetFilterChangesProcedure.md b/tevm/docs/procedures/functions/ethGetFilterChangesProcedure.md index 21e8bbdcee..beb230233c 100644 --- a/tevm/docs/procedures/functions/ethGetFilterChangesProcedure.md +++ b/tevm/docs/procedures/functions/ethGetFilterChangesProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:663 +packages/procedures/dist/index.d.ts:668 diff --git a/tevm/docs/procedures/functions/ethGetFilterLogsProcedure.md b/tevm/docs/procedures/functions/ethGetFilterLogsProcedure.md index 89992a6d19..c6afea6915 100644 --- a/tevm/docs/procedures/functions/ethGetFilterLogsProcedure.md +++ b/tevm/docs/procedures/functions/ethGetFilterLogsProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:665 +packages/procedures/dist/index.d.ts:670 diff --git a/tevm/docs/procedures/functions/ethGetLogsProcedure.md b/tevm/docs/procedures/functions/ethGetLogsProcedure.md index c2d3e2ea34..af8cdf462f 100644 --- a/tevm/docs/procedures/functions/ethGetLogsProcedure.md +++ b/tevm/docs/procedures/functions/ethGetLogsProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:667 +packages/procedures/dist/index.d.ts:672 diff --git a/tevm/docs/procedures/functions/ethGetTransactionByBlockHashAndIndexJsonRpcProcedure.md b/tevm/docs/procedures/functions/ethGetTransactionByBlockHashAndIndexJsonRpcProcedure.md index eeae6ea422..470710af90 100644 --- a/tevm/docs/procedures/functions/ethGetTransactionByBlockHashAndIndexJsonRpcProcedure.md +++ b/tevm/docs/procedures/functions/ethGetTransactionByBlockHashAndIndexJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:669 +packages/procedures/dist/index.d.ts:674 diff --git a/tevm/docs/procedures/functions/ethGetTransactionByBlockNumberAndIndexJsonRpcProcedure.md b/tevm/docs/procedures/functions/ethGetTransactionByBlockNumberAndIndexJsonRpcProcedure.md index 83dfae9691..af582d05a2 100644 --- a/tevm/docs/procedures/functions/ethGetTransactionByBlockNumberAndIndexJsonRpcProcedure.md +++ b/tevm/docs/procedures/functions/ethGetTransactionByBlockNumberAndIndexJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:671 +packages/procedures/dist/index.d.ts:676 diff --git a/tevm/docs/procedures/functions/ethGetTransactionByHashJsonRpcProcedure.md b/tevm/docs/procedures/functions/ethGetTransactionByHashJsonRpcProcedure.md index 6317b3bc80..b88e3b37ac 100644 --- a/tevm/docs/procedures/functions/ethGetTransactionByHashJsonRpcProcedure.md +++ b/tevm/docs/procedures/functions/ethGetTransactionByHashJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:673 +packages/procedures/dist/index.d.ts:678 diff --git a/tevm/docs/procedures/functions/ethGetTransactionCountProcedure.md b/tevm/docs/procedures/functions/ethGetTransactionCountProcedure.md index b0c59c3152..ba971c0f4c 100644 --- a/tevm/docs/procedures/functions/ethGetTransactionCountProcedure.md +++ b/tevm/docs/procedures/functions/ethGetTransactionCountProcedure.md @@ -6,11 +6,11 @@ # Function: ethGetTransactionCountProcedure() -> **ethGetTransactionCountProcedure**(`client`): [`EthGetTransactionCountJsonRpcProcedure`](../type-aliases/EthGetTransactionCountJsonRpcProcedure.md) +> **ethGetTransactionCountProcedure**(`node`): [`EthGetTransactionCountJsonRpcProcedure`](../type-aliases/EthGetTransactionCountJsonRpcProcedure.md) ## Parameters -• **client**: [`TevmNode`](../../index/type-aliases/TevmNode.md) +• **node**: [`TevmNode`](../../index/type-aliases/TevmNode.md) ## Returns @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:675 +packages/procedures/dist/index.d.ts:680 diff --git a/tevm/docs/procedures/functions/ethGetTransactionReceiptJsonRpcProcedure.md b/tevm/docs/procedures/functions/ethGetTransactionReceiptJsonRpcProcedure.md index 7e3d2f082f..0858d356a4 100644 --- a/tevm/docs/procedures/functions/ethGetTransactionReceiptJsonRpcProcedure.md +++ b/tevm/docs/procedures/functions/ethGetTransactionReceiptJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:677 +packages/procedures/dist/index.d.ts:682 diff --git a/tevm/docs/procedures/functions/ethNewBlockFilterProcedure.md b/tevm/docs/procedures/functions/ethNewBlockFilterProcedure.md index dc4e321838..543311bfae 100644 --- a/tevm/docs/procedures/functions/ethNewBlockFilterProcedure.md +++ b/tevm/docs/procedures/functions/ethNewBlockFilterProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:679 +packages/procedures/dist/index.d.ts:684 diff --git a/tevm/docs/procedures/functions/ethNewFilterJsonRpcProcedure.md b/tevm/docs/procedures/functions/ethNewFilterJsonRpcProcedure.md index a198f56c5e..16f5302e4c 100644 --- a/tevm/docs/procedures/functions/ethNewFilterJsonRpcProcedure.md +++ b/tevm/docs/procedures/functions/ethNewFilterJsonRpcProcedure.md @@ -6,11 +6,11 @@ # Function: ethNewFilterJsonRpcProcedure() -> **ethNewFilterJsonRpcProcedure**(`client`): [`EthNewFilterJsonRpcProcedure`](../type-aliases/EthNewFilterJsonRpcProcedure.md) +> **ethNewFilterJsonRpcProcedure**(`tevmNode`): [`EthNewFilterJsonRpcProcedure`](../type-aliases/EthNewFilterJsonRpcProcedure.md) ## Parameters -• **client**: [`TevmNode`](../../index/type-aliases/TevmNode.md) +• **tevmNode**: [`TevmNode`](../../index/type-aliases/TevmNode.md) ## Returns @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:681 +packages/procedures/dist/index.d.ts:686 diff --git a/tevm/docs/procedures/functions/ethNewPendingTransactionFilterProcedure.md b/tevm/docs/procedures/functions/ethNewPendingTransactionFilterProcedure.md index f3ef69f032..c758eb7cf4 100644 --- a/tevm/docs/procedures/functions/ethNewPendingTransactionFilterProcedure.md +++ b/tevm/docs/procedures/functions/ethNewPendingTransactionFilterProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:683 +packages/procedures/dist/index.d.ts:688 diff --git a/tevm/docs/procedures/functions/ethProtocolVersionJsonRpcProcedure.md b/tevm/docs/procedures/functions/ethProtocolVersionJsonRpcProcedure.md index f62ff94d45..de39ec6201 100644 --- a/tevm/docs/procedures/functions/ethProtocolVersionJsonRpcProcedure.md +++ b/tevm/docs/procedures/functions/ethProtocolVersionJsonRpcProcedure.md @@ -14,4 +14,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:685 +packages/procedures/dist/index.d.ts:690 diff --git a/tevm/docs/procedures/functions/ethSendRawTransactionJsonRpcProcedure.md b/tevm/docs/procedures/functions/ethSendRawTransactionJsonRpcProcedure.md index b37bcfa9d5..d33a4b5638 100644 --- a/tevm/docs/procedures/functions/ethSendRawTransactionJsonRpcProcedure.md +++ b/tevm/docs/procedures/functions/ethSendRawTransactionJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:687 +packages/procedures/dist/index.d.ts:692 diff --git a/tevm/docs/procedures/functions/ethSendTransactionJsonRpcProcedure.md b/tevm/docs/procedures/functions/ethSendTransactionJsonRpcProcedure.md index eb911da3eb..6d93bc2c7e 100644 --- a/tevm/docs/procedures/functions/ethSendTransactionJsonRpcProcedure.md +++ b/tevm/docs/procedures/functions/ethSendTransactionJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:689 +packages/procedures/dist/index.d.ts:694 diff --git a/tevm/docs/procedures/functions/ethSignProcedure.md b/tevm/docs/procedures/functions/ethSignProcedure.md index 7760b4f1c7..993508dbf2 100644 --- a/tevm/docs/procedures/functions/ethSignProcedure.md +++ b/tevm/docs/procedures/functions/ethSignProcedure.md @@ -10,7 +10,7 @@ ## Parameters -• **accounts**: readonly [`HDAccount`](../../index/type-aliases/HDAccount.md)[] +• **accounts**: readonly `object`[] ## Returns @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:691 +packages/procedures/dist/index.d.ts:696 diff --git a/tevm/docs/procedures/functions/ethSignTransactionProcedure.md b/tevm/docs/procedures/functions/ethSignTransactionProcedure.md index 36169dd3f2..9577a344ce 100644 --- a/tevm/docs/procedures/functions/ethSignTransactionProcedure.md +++ b/tevm/docs/procedures/functions/ethSignTransactionProcedure.md @@ -12,7 +12,7 @@ • **options** -• **options.accounts**: readonly [`HDAccount`](../../index/type-aliases/HDAccount.md)[] +• **options.accounts**: readonly `object`[] • **options.getChainId** @@ -22,4 +22,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:693 +packages/procedures/dist/index.d.ts:698 diff --git a/tevm/docs/procedures/functions/ethUninstallFilterJsonRpcProcedure.md b/tevm/docs/procedures/functions/ethUninstallFilterJsonRpcProcedure.md index 84be0f606f..6b3bb169d8 100644 --- a/tevm/docs/procedures/functions/ethUninstallFilterJsonRpcProcedure.md +++ b/tevm/docs/procedures/functions/ethUninstallFilterJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:695 +packages/procedures/dist/index.d.ts:700 diff --git a/tevm/docs/procedures/functions/gasPriceProcedure.md b/tevm/docs/procedures/functions/gasPriceProcedure.md index 0f55f6d102..9c8d97c175 100644 --- a/tevm/docs/procedures/functions/gasPriceProcedure.md +++ b/tevm/docs/procedures/functions/gasPriceProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:697 +packages/procedures/dist/index.d.ts:702 diff --git a/tevm/docs/procedures/functions/generateRandomId.md b/tevm/docs/procedures/functions/generateRandomId.md index 93dc983834..b8745788da 100644 --- a/tevm/docs/procedures/functions/generateRandomId.md +++ b/tevm/docs/procedures/functions/generateRandomId.md @@ -14,4 +14,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:1348 +packages/procedures/dist/index.d.ts:1353 diff --git a/tevm/docs/procedures/functions/getAccountProcedure.md b/tevm/docs/procedures/functions/getAccountProcedure.md index 8c6d345cad..5dfcfaeda8 100644 --- a/tevm/docs/procedures/functions/getAccountProcedure.md +++ b/tevm/docs/procedures/functions/getAccountProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:1209 +packages/procedures/dist/index.d.ts:1214 diff --git a/tevm/docs/procedures/functions/getBalanceProcedure.md b/tevm/docs/procedures/functions/getBalanceProcedure.md index a0301335b0..d911e8ea09 100644 --- a/tevm/docs/procedures/functions/getBalanceProcedure.md +++ b/tevm/docs/procedures/functions/getBalanceProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:699 +packages/procedures/dist/index.d.ts:704 diff --git a/tevm/docs/procedures/functions/getCodeProcedure.md b/tevm/docs/procedures/functions/getCodeProcedure.md index 726d3ea66c..d066d8db95 100644 --- a/tevm/docs/procedures/functions/getCodeProcedure.md +++ b/tevm/docs/procedures/functions/getCodeProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:701 +packages/procedures/dist/index.d.ts:706 diff --git a/tevm/docs/procedures/functions/getStorageAtProcedure.md b/tevm/docs/procedures/functions/getStorageAtProcedure.md index 874a9956e8..ff8bb87f15 100644 --- a/tevm/docs/procedures/functions/getStorageAtProcedure.md +++ b/tevm/docs/procedures/functions/getStorageAtProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:703 +packages/procedures/dist/index.d.ts:708 diff --git a/tevm/docs/procedures/functions/loadStateProcedure.md b/tevm/docs/procedures/functions/loadStateProcedure.md index 0fb1318545..cef626ce9e 100644 --- a/tevm/docs/procedures/functions/loadStateProcedure.md +++ b/tevm/docs/procedures/functions/loadStateProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:1226 +packages/procedures/dist/index.d.ts:1231 diff --git a/tevm/docs/procedures/functions/mineProcedure.md b/tevm/docs/procedures/functions/mineProcedure.md index b69867ab1a..325b844c52 100644 --- a/tevm/docs/procedures/functions/mineProcedure.md +++ b/tevm/docs/procedures/functions/mineProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:1233 +packages/procedures/dist/index.d.ts:1238 diff --git a/tevm/docs/procedures/functions/parseBlockTag.md b/tevm/docs/procedures/functions/parseBlockTag.md index daa11d3f88..1a0dffc4cb 100644 --- a/tevm/docs/procedures/functions/parseBlockTag.md +++ b/tevm/docs/procedures/functions/parseBlockTag.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:1350 +packages/procedures/dist/index.d.ts:1355 diff --git a/tevm/docs/procedures/functions/requestBulkProcedure.md b/tevm/docs/procedures/functions/requestBulkProcedure.md index f0633afeaa..d60c949422 100644 --- a/tevm/docs/procedures/functions/requestBulkProcedure.md +++ b/tevm/docs/procedures/functions/requestBulkProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:1166 +packages/procedures/dist/index.d.ts:1171 diff --git a/tevm/docs/procedures/functions/requestProcedure.md b/tevm/docs/procedures/functions/requestProcedure.md index 66148c2901..76428f7c0b 100644 --- a/tevm/docs/procedures/functions/requestProcedure.md +++ b/tevm/docs/procedures/functions/requestProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:1083 +packages/procedures/dist/index.d.ts:1088 diff --git a/tevm/docs/procedures/functions/scriptProcedure.md b/tevm/docs/procedures/functions/scriptProcedure.md index 69aed150df..efd85acd11 100644 --- a/tevm/docs/procedures/functions/scriptProcedure.md +++ b/tevm/docs/procedures/functions/scriptProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:1241 +packages/procedures/dist/index.d.ts:1246 diff --git a/tevm/docs/procedures/functions/setAccountProcedure.md b/tevm/docs/procedures/functions/setAccountProcedure.md index 862a8d275d..434cc55d20 100644 --- a/tevm/docs/procedures/functions/setAccountProcedure.md +++ b/tevm/docs/procedures/functions/setAccountProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:1248 +packages/procedures/dist/index.d.ts:1253 diff --git a/tevm/docs/procedures/functions/txToJsonRpcTx.md b/tevm/docs/procedures/functions/txToJsonRpcTx.md index dd4561bb6d..7add50a4b1 100644 --- a/tevm/docs/procedures/functions/txToJsonRpcTx.md +++ b/tevm/docs/procedures/functions/txToJsonRpcTx.md @@ -22,4 +22,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:1352 +packages/procedures/dist/index.d.ts:1357 diff --git a/tevm/docs/procedures/type-aliases/AnvilDropTransactionJsonRpcResponse.md b/tevm/docs/procedures/type-aliases/AnvilDropTransactionJsonRpcResponse.md index b90af7d857..424ab27072 100644 --- a/tevm/docs/procedures/type-aliases/AnvilDropTransactionJsonRpcResponse.md +++ b/tevm/docs/procedures/type-aliases/AnvilDropTransactionJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `anvil_dropTransaction` procedure ## Defined in -packages/procedures/dist/index.d.ts:737 +packages/procedures/dist/index.d.ts:742 diff --git a/tevm/docs/procedures/type-aliases/AnvilDropTransactionProcedure.md b/tevm/docs/procedures/type-aliases/AnvilDropTransactionProcedure.md index 7d8697374c..01f3c0fa5a 100644 --- a/tevm/docs/procedures/type-aliases/AnvilDropTransactionProcedure.md +++ b/tevm/docs/procedures/type-aliases/AnvilDropTransactionProcedure.md @@ -20,4 +20,4 @@ JSON-RPC procedure for `anvil_dropTransaction` ## Defined in -packages/procedures/dist/index.d.ts:795 +packages/procedures/dist/index.d.ts:800 diff --git a/tevm/docs/procedures/type-aliases/AnvilDumpStateJsonRpcResponse.md b/tevm/docs/procedures/type-aliases/AnvilDumpStateJsonRpcResponse.md index 3370b48c8f..e848b9dc97 100644 --- a/tevm/docs/procedures/type-aliases/AnvilDumpStateJsonRpcResponse.md +++ b/tevm/docs/procedures/type-aliases/AnvilDumpStateJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `anvil_dumpState` procedure ## Defined in -packages/procedures/dist/index.d.ts:761 +packages/procedures/dist/index.d.ts:766 diff --git a/tevm/docs/procedures/type-aliases/AnvilDumpStateProcedure.md b/tevm/docs/procedures/type-aliases/AnvilDumpStateProcedure.md index 73772dbdb9..717ba0fb3c 100644 --- a/tevm/docs/procedures/type-aliases/AnvilDumpStateProcedure.md +++ b/tevm/docs/procedures/type-aliases/AnvilDumpStateProcedure.md @@ -20,4 +20,4 @@ JSON-RPC procedure for `anvil_dumpState` ## Defined in -packages/procedures/dist/index.d.ts:819 +packages/procedures/dist/index.d.ts:824 diff --git a/tevm/docs/procedures/type-aliases/AnvilGetAutomineJsonRpcResponse.md b/tevm/docs/procedures/type-aliases/AnvilGetAutomineJsonRpcResponse.md index daa4d75b16..18628ee6de 100644 --- a/tevm/docs/procedures/type-aliases/AnvilGetAutomineJsonRpcResponse.md +++ b/tevm/docs/procedures/type-aliases/AnvilGetAutomineJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `anvil_getAutomine` procedure ## Defined in -packages/procedures/dist/index.d.ts:725 +packages/procedures/dist/index.d.ts:730 diff --git a/tevm/docs/procedures/type-aliases/AnvilGetAutomineProcedure.md b/tevm/docs/procedures/type-aliases/AnvilGetAutomineProcedure.md index 8491d5d565..2ab7b52d2f 100644 --- a/tevm/docs/procedures/type-aliases/AnvilGetAutomineProcedure.md +++ b/tevm/docs/procedures/type-aliases/AnvilGetAutomineProcedure.md @@ -20,4 +20,4 @@ JSON-RPC procedure for `anvil_getAutomine` ## Defined in -packages/procedures/dist/index.d.ts:783 +packages/procedures/dist/index.d.ts:788 diff --git a/tevm/docs/procedures/type-aliases/AnvilImpersonateAccountJsonRpcResponse.md b/tevm/docs/procedures/type-aliases/AnvilImpersonateAccountJsonRpcResponse.md index 385e4a153f..19d1668924 100644 --- a/tevm/docs/procedures/type-aliases/AnvilImpersonateAccountJsonRpcResponse.md +++ b/tevm/docs/procedures/type-aliases/AnvilImpersonateAccountJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `anvil_impersonateAccount` procedure ## Defined in -packages/procedures/dist/index.d.ts:709 +packages/procedures/dist/index.d.ts:714 diff --git a/tevm/docs/procedures/type-aliases/AnvilImpersonateAccountProcedure.md b/tevm/docs/procedures/type-aliases/AnvilImpersonateAccountProcedure.md index a1d5fdceee..ca43cbc88f 100644 --- a/tevm/docs/procedures/type-aliases/AnvilImpersonateAccountProcedure.md +++ b/tevm/docs/procedures/type-aliases/AnvilImpersonateAccountProcedure.md @@ -20,4 +20,4 @@ JSON-RPC procedure for `anvil_impersonateAccount` ## Defined in -packages/procedures/dist/index.d.ts:771 +packages/procedures/dist/index.d.ts:776 diff --git a/tevm/docs/procedures/type-aliases/AnvilLoadStateJsonRpcResponse.md b/tevm/docs/procedures/type-aliases/AnvilLoadStateJsonRpcResponse.md index 3459814af6..d4798490e7 100644 --- a/tevm/docs/procedures/type-aliases/AnvilLoadStateJsonRpcResponse.md +++ b/tevm/docs/procedures/type-aliases/AnvilLoadStateJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `anvil_loadState` procedure ## Defined in -packages/procedures/dist/index.d.ts:765 +packages/procedures/dist/index.d.ts:770 diff --git a/tevm/docs/procedures/type-aliases/AnvilLoadStateProcedure.md b/tevm/docs/procedures/type-aliases/AnvilLoadStateProcedure.md index 147677e1fb..5c65c00a20 100644 --- a/tevm/docs/procedures/type-aliases/AnvilLoadStateProcedure.md +++ b/tevm/docs/procedures/type-aliases/AnvilLoadStateProcedure.md @@ -20,4 +20,4 @@ JSON-RPC procedure for `anvil_loadState` ## Defined in -packages/procedures/dist/index.d.ts:823 +packages/procedures/dist/index.d.ts:828 diff --git a/tevm/docs/procedures/type-aliases/AnvilMineJsonRpcResponse.md b/tevm/docs/procedures/type-aliases/AnvilMineJsonRpcResponse.md index 1a5ff9dceb..c45a772d77 100644 --- a/tevm/docs/procedures/type-aliases/AnvilMineJsonRpcResponse.md +++ b/tevm/docs/procedures/type-aliases/AnvilMineJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `anvil_mine` procedure ## Defined in -packages/procedures/dist/index.d.ts:729 +packages/procedures/dist/index.d.ts:734 diff --git a/tevm/docs/procedures/type-aliases/AnvilMineProcedure.md b/tevm/docs/procedures/type-aliases/AnvilMineProcedure.md index 2cca4951f7..ed932e4c06 100644 --- a/tevm/docs/procedures/type-aliases/AnvilMineProcedure.md +++ b/tevm/docs/procedures/type-aliases/AnvilMineProcedure.md @@ -20,4 +20,4 @@ JSON-RPC procedure for `anvil_mine` ## Defined in -packages/procedures/dist/index.d.ts:787 +packages/procedures/dist/index.d.ts:792 diff --git a/tevm/docs/procedures/type-aliases/AnvilRequestType.md b/tevm/docs/procedures/type-aliases/AnvilRequestType.md index 48657b8e5d..81b30522fe 100644 --- a/tevm/docs/procedures/type-aliases/AnvilRequestType.md +++ b/tevm/docs/procedures/type-aliases/AnvilRequestType.md @@ -66,4 +66,4 @@ A mapping of `anvil_*` method names to their request type ## Defined in -packages/procedures/dist/index.d.ts:1253 +packages/procedures/dist/index.d.ts:1258 diff --git a/tevm/docs/procedures/type-aliases/AnvilResetJsonRpcResponse.md b/tevm/docs/procedures/type-aliases/AnvilResetJsonRpcResponse.md index a9abe0d668..6c5bc23d7f 100644 --- a/tevm/docs/procedures/type-aliases/AnvilResetJsonRpcResponse.md +++ b/tevm/docs/procedures/type-aliases/AnvilResetJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `anvil_reset` procedure ## Defined in -packages/procedures/dist/index.d.ts:733 +packages/procedures/dist/index.d.ts:738 diff --git a/tevm/docs/procedures/type-aliases/AnvilResetProcedure.md b/tevm/docs/procedures/type-aliases/AnvilResetProcedure.md index 051f4e563e..6cf1ce91a2 100644 --- a/tevm/docs/procedures/type-aliases/AnvilResetProcedure.md +++ b/tevm/docs/procedures/type-aliases/AnvilResetProcedure.md @@ -20,4 +20,4 @@ JSON-RPC procedure for `anvil_reset` ## Defined in -packages/procedures/dist/index.d.ts:791 +packages/procedures/dist/index.d.ts:796 diff --git a/tevm/docs/procedures/type-aliases/AnvilReturnType.md b/tevm/docs/procedures/type-aliases/AnvilReturnType.md index 30708fb769..77b49cbf44 100644 --- a/tevm/docs/procedures/type-aliases/AnvilReturnType.md +++ b/tevm/docs/procedures/type-aliases/AnvilReturnType.md @@ -70,4 +70,4 @@ A mapping of `anvil_*` method names to their return type ## Defined in -packages/procedures/dist/index.d.ts:852 +packages/procedures/dist/index.d.ts:857 diff --git a/tevm/docs/procedures/type-aliases/AnvilSetBalanceJsonRpcResponse.md b/tevm/docs/procedures/type-aliases/AnvilSetBalanceJsonRpcResponse.md index b8bd6da162..165a1e562a 100644 --- a/tevm/docs/procedures/type-aliases/AnvilSetBalanceJsonRpcResponse.md +++ b/tevm/docs/procedures/type-aliases/AnvilSetBalanceJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `anvil_setBalance` procedure ## Defined in -packages/procedures/dist/index.d.ts:741 +packages/procedures/dist/index.d.ts:746 diff --git a/tevm/docs/procedures/type-aliases/AnvilSetBalanceProcedure.md b/tevm/docs/procedures/type-aliases/AnvilSetBalanceProcedure.md index 94ae5497ae..46920a0916 100644 --- a/tevm/docs/procedures/type-aliases/AnvilSetBalanceProcedure.md +++ b/tevm/docs/procedures/type-aliases/AnvilSetBalanceProcedure.md @@ -20,4 +20,4 @@ JSON-RPC procedure for `anvil_setBalance` ## Defined in -packages/procedures/dist/index.d.ts:799 +packages/procedures/dist/index.d.ts:804 diff --git a/tevm/docs/procedures/type-aliases/AnvilSetChainIdJsonRpcResponse.md b/tevm/docs/procedures/type-aliases/AnvilSetChainIdJsonRpcResponse.md index 1998bf11cc..8fe95e88dc 100644 --- a/tevm/docs/procedures/type-aliases/AnvilSetChainIdJsonRpcResponse.md +++ b/tevm/docs/procedures/type-aliases/AnvilSetChainIdJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `anvil_setChainId` procedure ## Defined in -packages/procedures/dist/index.d.ts:757 +packages/procedures/dist/index.d.ts:762 diff --git a/tevm/docs/procedures/type-aliases/AnvilSetChainIdProcedure.md b/tevm/docs/procedures/type-aliases/AnvilSetChainIdProcedure.md index c445cc04b0..78a2c3abd7 100644 --- a/tevm/docs/procedures/type-aliases/AnvilSetChainIdProcedure.md +++ b/tevm/docs/procedures/type-aliases/AnvilSetChainIdProcedure.md @@ -20,4 +20,4 @@ JSON-RPC procedure for `anvil_setChainId` ## Defined in -packages/procedures/dist/index.d.ts:815 +packages/procedures/dist/index.d.ts:820 diff --git a/tevm/docs/procedures/type-aliases/AnvilSetCodeJsonRpcResponse.md b/tevm/docs/procedures/type-aliases/AnvilSetCodeJsonRpcResponse.md index 21f1469f5c..e21bf13bde 100644 --- a/tevm/docs/procedures/type-aliases/AnvilSetCodeJsonRpcResponse.md +++ b/tevm/docs/procedures/type-aliases/AnvilSetCodeJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `anvil_setCode` procedure ## Defined in -packages/procedures/dist/index.d.ts:745 +packages/procedures/dist/index.d.ts:750 diff --git a/tevm/docs/procedures/type-aliases/AnvilSetCodeProcedure.md b/tevm/docs/procedures/type-aliases/AnvilSetCodeProcedure.md index 8c6bcfb89b..2ed511a819 100644 --- a/tevm/docs/procedures/type-aliases/AnvilSetCodeProcedure.md +++ b/tevm/docs/procedures/type-aliases/AnvilSetCodeProcedure.md @@ -20,4 +20,4 @@ JSON-RPC procedure for `anvil_setCode` ## Defined in -packages/procedures/dist/index.d.ts:803 +packages/procedures/dist/index.d.ts:808 diff --git a/tevm/docs/procedures/type-aliases/AnvilSetCoinbaseJsonRpcResponse.md b/tevm/docs/procedures/type-aliases/AnvilSetCoinbaseJsonRpcResponse.md index d728048ae2..c0dac2c9e0 100644 --- a/tevm/docs/procedures/type-aliases/AnvilSetCoinbaseJsonRpcResponse.md +++ b/tevm/docs/procedures/type-aliases/AnvilSetCoinbaseJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `anvil_setCoinbase` procedure ## Defined in -packages/procedures/dist/index.d.ts:717 +packages/procedures/dist/index.d.ts:722 diff --git a/tevm/docs/procedures/type-aliases/AnvilSetCoinbaseProcedure.md b/tevm/docs/procedures/type-aliases/AnvilSetCoinbaseProcedure.md index cdde863677..2a5aa9ed8f 100644 --- a/tevm/docs/procedures/type-aliases/AnvilSetCoinbaseProcedure.md +++ b/tevm/docs/procedures/type-aliases/AnvilSetCoinbaseProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:767 +packages/procedures/dist/index.d.ts:772 diff --git a/tevm/docs/procedures/type-aliases/AnvilSetNonceJsonRpcResponse.md b/tevm/docs/procedures/type-aliases/AnvilSetNonceJsonRpcResponse.md index fbf0c7ee5b..769cc353cf 100644 --- a/tevm/docs/procedures/type-aliases/AnvilSetNonceJsonRpcResponse.md +++ b/tevm/docs/procedures/type-aliases/AnvilSetNonceJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `anvil_setNonce` procedure ## Defined in -packages/procedures/dist/index.d.ts:749 +packages/procedures/dist/index.d.ts:754 diff --git a/tevm/docs/procedures/type-aliases/AnvilSetNonceProcedure.md b/tevm/docs/procedures/type-aliases/AnvilSetNonceProcedure.md index c00b016418..529bf4ab10 100644 --- a/tevm/docs/procedures/type-aliases/AnvilSetNonceProcedure.md +++ b/tevm/docs/procedures/type-aliases/AnvilSetNonceProcedure.md @@ -20,4 +20,4 @@ JSON-RPC procedure for `anvil_setNonce` ## Defined in -packages/procedures/dist/index.d.ts:807 +packages/procedures/dist/index.d.ts:812 diff --git a/tevm/docs/procedures/type-aliases/AnvilSetStorageAtJsonRpcResponse.md b/tevm/docs/procedures/type-aliases/AnvilSetStorageAtJsonRpcResponse.md index 662568fda3..ce61e4322a 100644 --- a/tevm/docs/procedures/type-aliases/AnvilSetStorageAtJsonRpcResponse.md +++ b/tevm/docs/procedures/type-aliases/AnvilSetStorageAtJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `anvil_setStorageAt` procedure ## Defined in -packages/procedures/dist/index.d.ts:753 +packages/procedures/dist/index.d.ts:758 diff --git a/tevm/docs/procedures/type-aliases/AnvilSetStorageAtProcedure.md b/tevm/docs/procedures/type-aliases/AnvilSetStorageAtProcedure.md index b3ae88f330..457ebfdb7a 100644 --- a/tevm/docs/procedures/type-aliases/AnvilSetStorageAtProcedure.md +++ b/tevm/docs/procedures/type-aliases/AnvilSetStorageAtProcedure.md @@ -20,4 +20,4 @@ JSON-RPC procedure for `anvil_setStorageAt` ## Defined in -packages/procedures/dist/index.d.ts:811 +packages/procedures/dist/index.d.ts:816 diff --git a/tevm/docs/procedures/type-aliases/AnvilStopImpersonatingAccountJsonRpcResponse.md b/tevm/docs/procedures/type-aliases/AnvilStopImpersonatingAccountJsonRpcResponse.md index 315054b02b..c950b29441 100644 --- a/tevm/docs/procedures/type-aliases/AnvilStopImpersonatingAccountJsonRpcResponse.md +++ b/tevm/docs/procedures/type-aliases/AnvilStopImpersonatingAccountJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `anvil_stopImpersonatingAccount` procedure ## Defined in -packages/procedures/dist/index.d.ts:713 +packages/procedures/dist/index.d.ts:718 diff --git a/tevm/docs/procedures/type-aliases/AnvilStopImpersonatingAccountProcedure.md b/tevm/docs/procedures/type-aliases/AnvilStopImpersonatingAccountProcedure.md index b9c8a6f922..7ea3f702c8 100644 --- a/tevm/docs/procedures/type-aliases/AnvilStopImpersonatingAccountProcedure.md +++ b/tevm/docs/procedures/type-aliases/AnvilStopImpersonatingAccountProcedure.md @@ -20,4 +20,4 @@ JSON-RPC procedure for `anvil_stopImpersonatingAccount` ## Defined in -packages/procedures/dist/index.d.ts:775 +packages/procedures/dist/index.d.ts:780 diff --git a/tevm/docs/procedures/type-aliases/CallJsonRpcProcedure.md b/tevm/docs/procedures/type-aliases/CallJsonRpcProcedure.md index 3191600bcc..f3b43f5c70 100644 --- a/tevm/docs/procedures/type-aliases/CallJsonRpcProcedure.md +++ b/tevm/docs/procedures/type-aliases/CallJsonRpcProcedure.md @@ -20,4 +20,4 @@ Call JSON-RPC procedure executes a call against the tevm EVM ## Defined in -packages/procedures/dist/index.d.ts:1171 +packages/procedures/dist/index.d.ts:1176 diff --git a/tevm/docs/procedures/type-aliases/CallJsonRpcResponse.md b/tevm/docs/procedures/type-aliases/CallJsonRpcResponse.md index 920da88969..c648f2b2d5 100644 --- a/tevm/docs/procedures/type-aliases/CallJsonRpcResponse.md +++ b/tevm/docs/procedures/type-aliases/CallJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `tevm_call` procedure ## Defined in -packages/procedures/dist/index.d.ts:934 +packages/procedures/dist/index.d.ts:939 diff --git a/tevm/docs/procedures/type-aliases/DebugRequestType.md b/tevm/docs/procedures/type-aliases/DebugRequestType.md index 1c0e0757bc..930da698da 100644 --- a/tevm/docs/procedures/type-aliases/DebugRequestType.md +++ b/tevm/docs/procedures/type-aliases/DebugRequestType.md @@ -22,4 +22,4 @@ A mapping of `debug_*` method names to their request type ## Defined in -packages/procedures/dist/index.d.ts:1272 +packages/procedures/dist/index.d.ts:1277 diff --git a/tevm/docs/procedures/type-aliases/DebugReturnType.md b/tevm/docs/procedures/type-aliases/DebugReturnType.md index ccb555fd13..9734cad632 100644 --- a/tevm/docs/procedures/type-aliases/DebugReturnType.md +++ b/tevm/docs/procedures/type-aliases/DebugReturnType.md @@ -22,4 +22,4 @@ A mapping of `debug_*` method names to their return type ## Defined in -packages/procedures/dist/index.d.ts:882 +packages/procedures/dist/index.d.ts:887 diff --git a/tevm/docs/procedures/type-aliases/DebugTraceCallJsonRpcResponse.md b/tevm/docs/procedures/type-aliases/DebugTraceCallJsonRpcResponse.md index 6dcd4f2ac3..8774900b63 100644 --- a/tevm/docs/procedures/type-aliases/DebugTraceCallJsonRpcResponse.md +++ b/tevm/docs/procedures/type-aliases/DebugTraceCallJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `debug_traceCall` procedure ## Defined in -packages/procedures/dist/index.d.ts:877 +packages/procedures/dist/index.d.ts:882 diff --git a/tevm/docs/procedures/type-aliases/DebugTraceCallProcedure.md b/tevm/docs/procedures/type-aliases/DebugTraceCallProcedure.md index 5ccec6a53a..f6db8de45e 100644 --- a/tevm/docs/procedures/type-aliases/DebugTraceCallProcedure.md +++ b/tevm/docs/procedures/type-aliases/DebugTraceCallProcedure.md @@ -20,4 +20,4 @@ JSON-RPC procedure for `debug_traceCall` ## Defined in -packages/procedures/dist/index.d.ts:1182 +packages/procedures/dist/index.d.ts:1187 diff --git a/tevm/docs/procedures/type-aliases/DebugTraceTransactionJsonRpcResponse.md b/tevm/docs/procedures/type-aliases/DebugTraceTransactionJsonRpcResponse.md index a58c7bb48a..3467a9feb7 100644 --- a/tevm/docs/procedures/type-aliases/DebugTraceTransactionJsonRpcResponse.md +++ b/tevm/docs/procedures/type-aliases/DebugTraceTransactionJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `debug_traceTransaction` procedure ## Defined in -packages/procedures/dist/index.d.ts:873 +packages/procedures/dist/index.d.ts:878 diff --git a/tevm/docs/procedures/type-aliases/DebugTraceTransactionProcedure.md b/tevm/docs/procedures/type-aliases/DebugTraceTransactionProcedure.md index c3abd2729c..07ab42b107 100644 --- a/tevm/docs/procedures/type-aliases/DebugTraceTransactionProcedure.md +++ b/tevm/docs/procedures/type-aliases/DebugTraceTransactionProcedure.md @@ -20,4 +20,4 @@ JSON-RPC procedure for `debug_traceTransaction` ## Defined in -packages/procedures/dist/index.d.ts:1178 +packages/procedures/dist/index.d.ts:1183 diff --git a/tevm/docs/procedures/type-aliases/DumpStateJsonRpcProcedure.md b/tevm/docs/procedures/type-aliases/DumpStateJsonRpcProcedure.md index 4559998d01..4d80ef73a2 100644 --- a/tevm/docs/procedures/type-aliases/DumpStateJsonRpcProcedure.md +++ b/tevm/docs/procedures/type-aliases/DumpStateJsonRpcProcedure.md @@ -20,4 +20,4 @@ the state as a JSON-RPC successful result ## Defined in -packages/procedures/dist/index.d.ts:1200 +packages/procedures/dist/index.d.ts:1205 diff --git a/tevm/docs/procedures/type-aliases/DumpStateJsonRpcResponse.md b/tevm/docs/procedures/type-aliases/DumpStateJsonRpcResponse.md index 90f8fd5360..96a1116f63 100644 --- a/tevm/docs/procedures/type-aliases/DumpStateJsonRpcResponse.md +++ b/tevm/docs/procedures/type-aliases/DumpStateJsonRpcResponse.md @@ -12,4 +12,4 @@ The response to the `tevm_dumpState` JSON-RPC request. ## Defined in -packages/procedures/dist/index.d.ts:939 +packages/procedures/dist/index.d.ts:944 diff --git a/tevm/docs/procedures/type-aliases/EthAccountsJsonRpcProcedure.md b/tevm/docs/procedures/type-aliases/EthAccountsJsonRpcProcedure.md index 2e2e3f5967..407d25d805 100644 --- a/tevm/docs/procedures/type-aliases/EthAccountsJsonRpcProcedure.md +++ b/tevm/docs/procedures/type-aliases/EthAccountsJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:602 +packages/procedures/dist/index.d.ts:607 diff --git a/tevm/docs/procedures/type-aliases/EthAccountsJsonRpcResponse.md b/tevm/docs/procedures/type-aliases/EthAccountsJsonRpcResponse.md index ee4fe32a28..a4e9c31c7e 100644 --- a/tevm/docs/procedures/type-aliases/EthAccountsJsonRpcResponse.md +++ b/tevm/docs/procedures/type-aliases/EthAccountsJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_accounts` procedure ## Defined in -packages/procedures/dist/index.d.ts:437 +packages/procedures/dist/index.d.ts:442 diff --git a/tevm/docs/procedures/type-aliases/EthBlockNumberJsonRpcProcedure.md b/tevm/docs/procedures/type-aliases/EthBlockNumberJsonRpcProcedure.md index 3c5b7442ae..6111dc96ed 100644 --- a/tevm/docs/procedures/type-aliases/EthBlockNumberJsonRpcProcedure.md +++ b/tevm/docs/procedures/type-aliases/EthBlockNumberJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:603 +packages/procedures/dist/index.d.ts:608 diff --git a/tevm/docs/procedures/type-aliases/EthBlockNumberJsonRpcResponse.md b/tevm/docs/procedures/type-aliases/EthBlockNumberJsonRpcResponse.md index eeddea0643..d3a3cfb210 100644 --- a/tevm/docs/procedures/type-aliases/EthBlockNumberJsonRpcResponse.md +++ b/tevm/docs/procedures/type-aliases/EthBlockNumberJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_blockNumber` procedure ## Defined in -packages/procedures/dist/index.d.ts:441 +packages/procedures/dist/index.d.ts:446 diff --git a/tevm/docs/procedures/type-aliases/EthCallJsonRpcProcedure.md b/tevm/docs/procedures/type-aliases/EthCallJsonRpcProcedure.md index 68291be19f..3f6c9f27fb 100644 --- a/tevm/docs/procedures/type-aliases/EthCallJsonRpcProcedure.md +++ b/tevm/docs/procedures/type-aliases/EthCallJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:604 +packages/procedures/dist/index.d.ts:609 diff --git a/tevm/docs/procedures/type-aliases/EthCallJsonRpcResponse.md b/tevm/docs/procedures/type-aliases/EthCallJsonRpcResponse.md index 3b9a3db41b..8612f79c38 100644 --- a/tevm/docs/procedures/type-aliases/EthCallJsonRpcResponse.md +++ b/tevm/docs/procedures/type-aliases/EthCallJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_call` procedure ## Defined in -packages/procedures/dist/index.d.ts:445 +packages/procedures/dist/index.d.ts:450 diff --git a/tevm/docs/procedures/type-aliases/EthChainIdJsonRpcProcedure.md b/tevm/docs/procedures/type-aliases/EthChainIdJsonRpcProcedure.md index 3e4e5d6d4f..2ee6eb9227 100644 --- a/tevm/docs/procedures/type-aliases/EthChainIdJsonRpcProcedure.md +++ b/tevm/docs/procedures/type-aliases/EthChainIdJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:605 +packages/procedures/dist/index.d.ts:610 diff --git a/tevm/docs/procedures/type-aliases/EthChainIdJsonRpcResponse.md b/tevm/docs/procedures/type-aliases/EthChainIdJsonRpcResponse.md index 2e241ff178..d081b181b1 100644 --- a/tevm/docs/procedures/type-aliases/EthChainIdJsonRpcResponse.md +++ b/tevm/docs/procedures/type-aliases/EthChainIdJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_chainId` procedure ## Defined in -packages/procedures/dist/index.d.ts:449 +packages/procedures/dist/index.d.ts:454 diff --git a/tevm/docs/procedures/type-aliases/EthCoinbaseJsonRpcProcedure.md b/tevm/docs/procedures/type-aliases/EthCoinbaseJsonRpcProcedure.md index 392344617f..631d3f539a 100644 --- a/tevm/docs/procedures/type-aliases/EthCoinbaseJsonRpcProcedure.md +++ b/tevm/docs/procedures/type-aliases/EthCoinbaseJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:606 +packages/procedures/dist/index.d.ts:611 diff --git a/tevm/docs/procedures/type-aliases/EthCoinbaseJsonRpcResponse.md b/tevm/docs/procedures/type-aliases/EthCoinbaseJsonRpcResponse.md index ee9ebb125f..644e8bbfbd 100644 --- a/tevm/docs/procedures/type-aliases/EthCoinbaseJsonRpcResponse.md +++ b/tevm/docs/procedures/type-aliases/EthCoinbaseJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_coinbase` procedure ## Defined in -packages/procedures/dist/index.d.ts:453 +packages/procedures/dist/index.d.ts:458 diff --git a/tevm/docs/procedures/type-aliases/EthEstimateGasJsonRpcProcedure.md b/tevm/docs/procedures/type-aliases/EthEstimateGasJsonRpcProcedure.md index 2e288ccad2..ce0a9988ed 100644 --- a/tevm/docs/procedures/type-aliases/EthEstimateGasJsonRpcProcedure.md +++ b/tevm/docs/procedures/type-aliases/EthEstimateGasJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:607 +packages/procedures/dist/index.d.ts:612 diff --git a/tevm/docs/procedures/type-aliases/EthEstimateGasJsonRpcRequest.md b/tevm/docs/procedures/type-aliases/EthEstimateGasJsonRpcRequest.md index efccb696e9..5942cdb001 100644 --- a/tevm/docs/procedures/type-aliases/EthEstimateGasJsonRpcRequest.md +++ b/tevm/docs/procedures/type-aliases/EthEstimateGasJsonRpcRequest.md @@ -6,7 +6,7 @@ # Type Alias: EthEstimateGasJsonRpcRequest -> **EthEstimateGasJsonRpcRequest**: [`JsonRpcRequest`](../../index/type-aliases/JsonRpcRequest.md)\<`"eth_estimateGas"`, readonly [[`JsonRpcTransaction`](JsonRpcTransaction.md)]\> +> **EthEstimateGasJsonRpcRequest**: [`JsonRpcRequest`](../../index/type-aliases/JsonRpcRequest.md)\<`"eth_estimateGas"`, readonly [[`JsonRpcTransaction`](JsonRpcTransaction.md), [`BlockTag`](../../index/type-aliases/BlockTag.md) \| [`Hex`](../../index/type-aliases/Hex.md), [`SerializeToJson`](SerializeToJson.md)\<`BaseCallParams`\[`"stateOverrideSet"`\]\>, [`SerializeToJson`](SerializeToJson.md)\<`BaseCallParams`\[`"blockOverrideSet"`\]\>]\> JSON-RPC request for `eth_estimateGas` procedure diff --git a/tevm/docs/procedures/type-aliases/EthEstimateGasJsonRpcResponse.md b/tevm/docs/procedures/type-aliases/EthEstimateGasJsonRpcResponse.md index 6d660fd2a2..c1a5bc6ac1 100644 --- a/tevm/docs/procedures/type-aliases/EthEstimateGasJsonRpcResponse.md +++ b/tevm/docs/procedures/type-aliases/EthEstimateGasJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_estimateGas` procedure ## Defined in -packages/procedures/dist/index.d.ts:457 +packages/procedures/dist/index.d.ts:462 diff --git a/tevm/docs/procedures/type-aliases/EthGasPriceJsonRpcProcedure.md b/tevm/docs/procedures/type-aliases/EthGasPriceJsonRpcProcedure.md index 476cda7d7d..72150d1953 100644 --- a/tevm/docs/procedures/type-aliases/EthGasPriceJsonRpcProcedure.md +++ b/tevm/docs/procedures/type-aliases/EthGasPriceJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:609 +packages/procedures/dist/index.d.ts:614 diff --git a/tevm/docs/procedures/type-aliases/EthGasPriceJsonRpcRequest.md b/tevm/docs/procedures/type-aliases/EthGasPriceJsonRpcRequest.md index 1c26781f7a..c1c8ad9b51 100644 --- a/tevm/docs/procedures/type-aliases/EthGasPriceJsonRpcRequest.md +++ b/tevm/docs/procedures/type-aliases/EthGasPriceJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_gasPrice` procedure ## Defined in -packages/procedures/dist/index.d.ts:300 +packages/procedures/dist/index.d.ts:305 diff --git a/tevm/docs/procedures/type-aliases/EthGasPriceJsonRpcResponse.md b/tevm/docs/procedures/type-aliases/EthGasPriceJsonRpcResponse.md index a58d5f5f10..dbd9fc050b 100644 --- a/tevm/docs/procedures/type-aliases/EthGasPriceJsonRpcResponse.md +++ b/tevm/docs/procedures/type-aliases/EthGasPriceJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_gasPrice` procedure ## Defined in -packages/procedures/dist/index.d.ts:465 +packages/procedures/dist/index.d.ts:470 diff --git a/tevm/docs/procedures/type-aliases/EthGetBalanceJsonRpcProcedure.md b/tevm/docs/procedures/type-aliases/EthGetBalanceJsonRpcProcedure.md index 2883633a03..62fe213467 100644 --- a/tevm/docs/procedures/type-aliases/EthGetBalanceJsonRpcProcedure.md +++ b/tevm/docs/procedures/type-aliases/EthGetBalanceJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:610 +packages/procedures/dist/index.d.ts:615 diff --git a/tevm/docs/procedures/type-aliases/EthGetBalanceJsonRpcRequest.md b/tevm/docs/procedures/type-aliases/EthGetBalanceJsonRpcRequest.md index 63417ea987..810e10da02 100644 --- a/tevm/docs/procedures/type-aliases/EthGetBalanceJsonRpcRequest.md +++ b/tevm/docs/procedures/type-aliases/EthGetBalanceJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_getBalance` procedure ## Defined in -packages/procedures/dist/index.d.ts:304 +packages/procedures/dist/index.d.ts:309 diff --git a/tevm/docs/procedures/type-aliases/EthGetBalanceJsonRpcResponse.md b/tevm/docs/procedures/type-aliases/EthGetBalanceJsonRpcResponse.md index fa116c6d8b..a3ed6a56cd 100644 --- a/tevm/docs/procedures/type-aliases/EthGetBalanceJsonRpcResponse.md +++ b/tevm/docs/procedures/type-aliases/EthGetBalanceJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_getBalance` procedure ## Defined in -packages/procedures/dist/index.d.ts:469 +packages/procedures/dist/index.d.ts:474 diff --git a/tevm/docs/procedures/type-aliases/EthGetBlockByHashJsonRpcProcedure.md b/tevm/docs/procedures/type-aliases/EthGetBlockByHashJsonRpcProcedure.md index a6be179251..0c3b1b71a3 100644 --- a/tevm/docs/procedures/type-aliases/EthGetBlockByHashJsonRpcProcedure.md +++ b/tevm/docs/procedures/type-aliases/EthGetBlockByHashJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:611 +packages/procedures/dist/index.d.ts:616 diff --git a/tevm/docs/procedures/type-aliases/EthGetBlockByHashJsonRpcRequest.md b/tevm/docs/procedures/type-aliases/EthGetBlockByHashJsonRpcRequest.md index 31adf74e1d..ff35b7151b 100644 --- a/tevm/docs/procedures/type-aliases/EthGetBlockByHashJsonRpcRequest.md +++ b/tevm/docs/procedures/type-aliases/EthGetBlockByHashJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_getBlockByHash` procedure ## Defined in -packages/procedures/dist/index.d.ts:308 +packages/procedures/dist/index.d.ts:313 diff --git a/tevm/docs/procedures/type-aliases/EthGetBlockByHashJsonRpcResponse.md b/tevm/docs/procedures/type-aliases/EthGetBlockByHashJsonRpcResponse.md index 671bd3f879..c0e129c3df 100644 --- a/tevm/docs/procedures/type-aliases/EthGetBlockByHashJsonRpcResponse.md +++ b/tevm/docs/procedures/type-aliases/EthGetBlockByHashJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_getBlockByHash` procedure ## Defined in -packages/procedures/dist/index.d.ts:473 +packages/procedures/dist/index.d.ts:478 diff --git a/tevm/docs/procedures/type-aliases/EthGetBlockByNumberJsonRpcProcedure.md b/tevm/docs/procedures/type-aliases/EthGetBlockByNumberJsonRpcProcedure.md index a19c206a82..5bc75d8d50 100644 --- a/tevm/docs/procedures/type-aliases/EthGetBlockByNumberJsonRpcProcedure.md +++ b/tevm/docs/procedures/type-aliases/EthGetBlockByNumberJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:612 +packages/procedures/dist/index.d.ts:617 diff --git a/tevm/docs/procedures/type-aliases/EthGetBlockByNumberJsonRpcRequest.md b/tevm/docs/procedures/type-aliases/EthGetBlockByNumberJsonRpcRequest.md index 56c5ed2aee..687dc6c2aa 100644 --- a/tevm/docs/procedures/type-aliases/EthGetBlockByNumberJsonRpcRequest.md +++ b/tevm/docs/procedures/type-aliases/EthGetBlockByNumberJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_getBlockByNumber` procedure ## Defined in -packages/procedures/dist/index.d.ts:312 +packages/procedures/dist/index.d.ts:317 diff --git a/tevm/docs/procedures/type-aliases/EthGetBlockByNumberJsonRpcResponse.md b/tevm/docs/procedures/type-aliases/EthGetBlockByNumberJsonRpcResponse.md index c382256d2d..f18c032d21 100644 --- a/tevm/docs/procedures/type-aliases/EthGetBlockByNumberJsonRpcResponse.md +++ b/tevm/docs/procedures/type-aliases/EthGetBlockByNumberJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_getBlockByNumber` procedure ## Defined in -packages/procedures/dist/index.d.ts:477 +packages/procedures/dist/index.d.ts:482 diff --git a/tevm/docs/procedures/type-aliases/EthGetBlockTransactionCountByHashJsonRpcProcedure.md b/tevm/docs/procedures/type-aliases/EthGetBlockTransactionCountByHashJsonRpcProcedure.md index 6d056da6a3..53c8578125 100644 --- a/tevm/docs/procedures/type-aliases/EthGetBlockTransactionCountByHashJsonRpcProcedure.md +++ b/tevm/docs/procedures/type-aliases/EthGetBlockTransactionCountByHashJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:613 +packages/procedures/dist/index.d.ts:618 diff --git a/tevm/docs/procedures/type-aliases/EthGetBlockTransactionCountByHashJsonRpcRequest.md b/tevm/docs/procedures/type-aliases/EthGetBlockTransactionCountByHashJsonRpcRequest.md index 1d45b06d42..2f1fb7b636 100644 --- a/tevm/docs/procedures/type-aliases/EthGetBlockTransactionCountByHashJsonRpcRequest.md +++ b/tevm/docs/procedures/type-aliases/EthGetBlockTransactionCountByHashJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_getBlockTransactionCountByHash` procedure ## Defined in -packages/procedures/dist/index.d.ts:316 +packages/procedures/dist/index.d.ts:321 diff --git a/tevm/docs/procedures/type-aliases/EthGetBlockTransactionCountByHashJsonRpcResponse.md b/tevm/docs/procedures/type-aliases/EthGetBlockTransactionCountByHashJsonRpcResponse.md index eea91ef9c8..3b1720e6a1 100644 --- a/tevm/docs/procedures/type-aliases/EthGetBlockTransactionCountByHashJsonRpcResponse.md +++ b/tevm/docs/procedures/type-aliases/EthGetBlockTransactionCountByHashJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_getBlockTransactionCountByHash` procedure ## Defined in -packages/procedures/dist/index.d.ts:481 +packages/procedures/dist/index.d.ts:486 diff --git a/tevm/docs/procedures/type-aliases/EthGetBlockTransactionCountByNumberJsonRpcProcedure.md b/tevm/docs/procedures/type-aliases/EthGetBlockTransactionCountByNumberJsonRpcProcedure.md index 2bee8c22c1..3fafc859a3 100644 --- a/tevm/docs/procedures/type-aliases/EthGetBlockTransactionCountByNumberJsonRpcProcedure.md +++ b/tevm/docs/procedures/type-aliases/EthGetBlockTransactionCountByNumberJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:614 +packages/procedures/dist/index.d.ts:619 diff --git a/tevm/docs/procedures/type-aliases/EthGetBlockTransactionCountByNumberJsonRpcRequest.md b/tevm/docs/procedures/type-aliases/EthGetBlockTransactionCountByNumberJsonRpcRequest.md index f3c1039c82..8bbb22bbca 100644 --- a/tevm/docs/procedures/type-aliases/EthGetBlockTransactionCountByNumberJsonRpcRequest.md +++ b/tevm/docs/procedures/type-aliases/EthGetBlockTransactionCountByNumberJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_getBlockTransactionCountByNumber` procedure ## Defined in -packages/procedures/dist/index.d.ts:320 +packages/procedures/dist/index.d.ts:325 diff --git a/tevm/docs/procedures/type-aliases/EthGetBlockTransactionCountByNumberJsonRpcResponse.md b/tevm/docs/procedures/type-aliases/EthGetBlockTransactionCountByNumberJsonRpcResponse.md index c1b6801375..d74584bb40 100644 --- a/tevm/docs/procedures/type-aliases/EthGetBlockTransactionCountByNumberJsonRpcResponse.md +++ b/tevm/docs/procedures/type-aliases/EthGetBlockTransactionCountByNumberJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_getBlockTransactionCountByNumber` procedure ## Defined in -packages/procedures/dist/index.d.ts:485 +packages/procedures/dist/index.d.ts:490 diff --git a/tevm/docs/procedures/type-aliases/EthGetCodeJsonRpcProcedure.md b/tevm/docs/procedures/type-aliases/EthGetCodeJsonRpcProcedure.md index b7b2feb441..552ffa1a76 100644 --- a/tevm/docs/procedures/type-aliases/EthGetCodeJsonRpcProcedure.md +++ b/tevm/docs/procedures/type-aliases/EthGetCodeJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:615 +packages/procedures/dist/index.d.ts:620 diff --git a/tevm/docs/procedures/type-aliases/EthGetCodeJsonRpcRequest.md b/tevm/docs/procedures/type-aliases/EthGetCodeJsonRpcRequest.md index 7b584c509f..40f3bda4f4 100644 --- a/tevm/docs/procedures/type-aliases/EthGetCodeJsonRpcRequest.md +++ b/tevm/docs/procedures/type-aliases/EthGetCodeJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_getCode` procedure ## Defined in -packages/procedures/dist/index.d.ts:324 +packages/procedures/dist/index.d.ts:329 diff --git a/tevm/docs/procedures/type-aliases/EthGetCodeJsonRpcResponse.md b/tevm/docs/procedures/type-aliases/EthGetCodeJsonRpcResponse.md index 3e30645ca4..05ed8d8a7b 100644 --- a/tevm/docs/procedures/type-aliases/EthGetCodeJsonRpcResponse.md +++ b/tevm/docs/procedures/type-aliases/EthGetCodeJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_getCode` procedure ## Defined in -packages/procedures/dist/index.d.ts:489 +packages/procedures/dist/index.d.ts:494 diff --git a/tevm/docs/procedures/type-aliases/EthGetFilterChangesJsonRpcProcedure.md b/tevm/docs/procedures/type-aliases/EthGetFilterChangesJsonRpcProcedure.md index d6f8607ab5..b8c32a6f8a 100644 --- a/tevm/docs/procedures/type-aliases/EthGetFilterChangesJsonRpcProcedure.md +++ b/tevm/docs/procedures/type-aliases/EthGetFilterChangesJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:616 +packages/procedures/dist/index.d.ts:621 diff --git a/tevm/docs/procedures/type-aliases/EthGetFilterChangesJsonRpcRequest.md b/tevm/docs/procedures/type-aliases/EthGetFilterChangesJsonRpcRequest.md index 0463e913a7..e02ff67a05 100644 --- a/tevm/docs/procedures/type-aliases/EthGetFilterChangesJsonRpcRequest.md +++ b/tevm/docs/procedures/type-aliases/EthGetFilterChangesJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_getFilterChanges` procedure ## Defined in -packages/procedures/dist/index.d.ts:328 +packages/procedures/dist/index.d.ts:333 diff --git a/tevm/docs/procedures/type-aliases/EthGetFilterChangesJsonRpcResponse.md b/tevm/docs/procedures/type-aliases/EthGetFilterChangesJsonRpcResponse.md index 96d87892f9..6516d4cc7f 100644 --- a/tevm/docs/procedures/type-aliases/EthGetFilterChangesJsonRpcResponse.md +++ b/tevm/docs/procedures/type-aliases/EthGetFilterChangesJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_getFilterChanges` procedure ## Defined in -packages/procedures/dist/index.d.ts:493 +packages/procedures/dist/index.d.ts:498 diff --git a/tevm/docs/procedures/type-aliases/EthGetFilterLogsJsonRpcProcedure.md b/tevm/docs/procedures/type-aliases/EthGetFilterLogsJsonRpcProcedure.md index af048d8cd4..84602f7381 100644 --- a/tevm/docs/procedures/type-aliases/EthGetFilterLogsJsonRpcProcedure.md +++ b/tevm/docs/procedures/type-aliases/EthGetFilterLogsJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:617 +packages/procedures/dist/index.d.ts:622 diff --git a/tevm/docs/procedures/type-aliases/EthGetFilterLogsJsonRpcRequest.md b/tevm/docs/procedures/type-aliases/EthGetFilterLogsJsonRpcRequest.md index 633f68a99e..2eb89a6b18 100644 --- a/tevm/docs/procedures/type-aliases/EthGetFilterLogsJsonRpcRequest.md +++ b/tevm/docs/procedures/type-aliases/EthGetFilterLogsJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_getFilterLogs` procedure ## Defined in -packages/procedures/dist/index.d.ts:332 +packages/procedures/dist/index.d.ts:337 diff --git a/tevm/docs/procedures/type-aliases/EthGetFilterLogsJsonRpcResponse.md b/tevm/docs/procedures/type-aliases/EthGetFilterLogsJsonRpcResponse.md index e1e7481817..db3bc4c2ef 100644 --- a/tevm/docs/procedures/type-aliases/EthGetFilterLogsJsonRpcResponse.md +++ b/tevm/docs/procedures/type-aliases/EthGetFilterLogsJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_getFilterLogs` procedure ## Defined in -packages/procedures/dist/index.d.ts:497 +packages/procedures/dist/index.d.ts:502 diff --git a/tevm/docs/procedures/type-aliases/EthGetLogsJsonRpcProcedure.md b/tevm/docs/procedures/type-aliases/EthGetLogsJsonRpcProcedure.md index 13bd53c8ab..4c52654a64 100644 --- a/tevm/docs/procedures/type-aliases/EthGetLogsJsonRpcProcedure.md +++ b/tevm/docs/procedures/type-aliases/EthGetLogsJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:618 +packages/procedures/dist/index.d.ts:623 diff --git a/tevm/docs/procedures/type-aliases/EthGetLogsJsonRpcRequest.md b/tevm/docs/procedures/type-aliases/EthGetLogsJsonRpcRequest.md index c32d1de30d..e957b29284 100644 --- a/tevm/docs/procedures/type-aliases/EthGetLogsJsonRpcRequest.md +++ b/tevm/docs/procedures/type-aliases/EthGetLogsJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_getLogs` procedure ## Defined in -packages/procedures/dist/index.d.ts:336 +packages/procedures/dist/index.d.ts:341 diff --git a/tevm/docs/procedures/type-aliases/EthGetLogsJsonRpcResponse.md b/tevm/docs/procedures/type-aliases/EthGetLogsJsonRpcResponse.md index f952f3edc6..cf1b25cd77 100644 --- a/tevm/docs/procedures/type-aliases/EthGetLogsJsonRpcResponse.md +++ b/tevm/docs/procedures/type-aliases/EthGetLogsJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_getLogs` procedure ## Defined in -packages/procedures/dist/index.d.ts:501 +packages/procedures/dist/index.d.ts:506 diff --git a/tevm/docs/procedures/type-aliases/EthGetStorageAtJsonRpcProcedure.md b/tevm/docs/procedures/type-aliases/EthGetStorageAtJsonRpcProcedure.md index 4150f6a0fb..4f74ef0bce 100644 --- a/tevm/docs/procedures/type-aliases/EthGetStorageAtJsonRpcProcedure.md +++ b/tevm/docs/procedures/type-aliases/EthGetStorageAtJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:619 +packages/procedures/dist/index.d.ts:624 diff --git a/tevm/docs/procedures/type-aliases/EthGetStorageAtJsonRpcRequest.md b/tevm/docs/procedures/type-aliases/EthGetStorageAtJsonRpcRequest.md index 1060e376e6..1368e5b64f 100644 --- a/tevm/docs/procedures/type-aliases/EthGetStorageAtJsonRpcRequest.md +++ b/tevm/docs/procedures/type-aliases/EthGetStorageAtJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_getStorageAt` procedure ## Defined in -packages/procedures/dist/index.d.ts:340 +packages/procedures/dist/index.d.ts:345 diff --git a/tevm/docs/procedures/type-aliases/EthGetStorageAtJsonRpcResponse.md b/tevm/docs/procedures/type-aliases/EthGetStorageAtJsonRpcResponse.md index b1a5381ee4..5869759f69 100644 --- a/tevm/docs/procedures/type-aliases/EthGetStorageAtJsonRpcResponse.md +++ b/tevm/docs/procedures/type-aliases/EthGetStorageAtJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_getStorageAt` procedure ## Defined in -packages/procedures/dist/index.d.ts:505 +packages/procedures/dist/index.d.ts:510 diff --git a/tevm/docs/procedures/type-aliases/EthGetTransactionByBlockHashAndIndexJsonRpcProcedure.md b/tevm/docs/procedures/type-aliases/EthGetTransactionByBlockHashAndIndexJsonRpcProcedure.md index 53dcb4ed84..91f9ba140e 100644 --- a/tevm/docs/procedures/type-aliases/EthGetTransactionByBlockHashAndIndexJsonRpcProcedure.md +++ b/tevm/docs/procedures/type-aliases/EthGetTransactionByBlockHashAndIndexJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:624 +packages/procedures/dist/index.d.ts:629 diff --git a/tevm/docs/procedures/type-aliases/EthGetTransactionByBlockHashAndIndexJsonRpcRequest.md b/tevm/docs/procedures/type-aliases/EthGetTransactionByBlockHashAndIndexJsonRpcRequest.md index 79d5ab1670..f49493bb74 100644 --- a/tevm/docs/procedures/type-aliases/EthGetTransactionByBlockHashAndIndexJsonRpcRequest.md +++ b/tevm/docs/procedures/type-aliases/EthGetTransactionByBlockHashAndIndexJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_getTransactionByBlockHashAndIndex` procedure ## Defined in -packages/procedures/dist/index.d.ts:360 +packages/procedures/dist/index.d.ts:365 diff --git a/tevm/docs/procedures/type-aliases/EthGetTransactionByBlockHashAndIndexJsonRpcResponse.md b/tevm/docs/procedures/type-aliases/EthGetTransactionByBlockHashAndIndexJsonRpcResponse.md index 6ba459bd91..e78063d298 100644 --- a/tevm/docs/procedures/type-aliases/EthGetTransactionByBlockHashAndIndexJsonRpcResponse.md +++ b/tevm/docs/procedures/type-aliases/EthGetTransactionByBlockHashAndIndexJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_getTransactionByBlockHashAndIndex` procedure ## Defined in -packages/procedures/dist/index.d.ts:525 +packages/procedures/dist/index.d.ts:530 diff --git a/tevm/docs/procedures/type-aliases/EthGetTransactionByBlockNumberAndIndexJsonRpcProcedure.md b/tevm/docs/procedures/type-aliases/EthGetTransactionByBlockNumberAndIndexJsonRpcProcedure.md index a559d902a4..023d8294ee 100644 --- a/tevm/docs/procedures/type-aliases/EthGetTransactionByBlockNumberAndIndexJsonRpcProcedure.md +++ b/tevm/docs/procedures/type-aliases/EthGetTransactionByBlockNumberAndIndexJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:625 +packages/procedures/dist/index.d.ts:630 diff --git a/tevm/docs/procedures/type-aliases/EthGetTransactionByBlockNumberAndIndexJsonRpcRequest.md b/tevm/docs/procedures/type-aliases/EthGetTransactionByBlockNumberAndIndexJsonRpcRequest.md index 020d4732bb..364fc66ae1 100644 --- a/tevm/docs/procedures/type-aliases/EthGetTransactionByBlockNumberAndIndexJsonRpcRequest.md +++ b/tevm/docs/procedures/type-aliases/EthGetTransactionByBlockNumberAndIndexJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_getTransactionByBlockNumberAndIndex` procedure ## Defined in -packages/procedures/dist/index.d.ts:364 +packages/procedures/dist/index.d.ts:369 diff --git a/tevm/docs/procedures/type-aliases/EthGetTransactionByBlockNumberAndIndexJsonRpcResponse.md b/tevm/docs/procedures/type-aliases/EthGetTransactionByBlockNumberAndIndexJsonRpcResponse.md index a3adece37b..364f78ed3c 100644 --- a/tevm/docs/procedures/type-aliases/EthGetTransactionByBlockNumberAndIndexJsonRpcResponse.md +++ b/tevm/docs/procedures/type-aliases/EthGetTransactionByBlockNumberAndIndexJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_getTransactionByBlockNumberAndIndex` procedure ## Defined in -packages/procedures/dist/index.d.ts:529 +packages/procedures/dist/index.d.ts:534 diff --git a/tevm/docs/procedures/type-aliases/EthGetTransactionByHashJsonRpcProcedure.md b/tevm/docs/procedures/type-aliases/EthGetTransactionByHashJsonRpcProcedure.md index 9136c8403f..7e48ddf280 100644 --- a/tevm/docs/procedures/type-aliases/EthGetTransactionByHashJsonRpcProcedure.md +++ b/tevm/docs/procedures/type-aliases/EthGetTransactionByHashJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:623 +packages/procedures/dist/index.d.ts:628 diff --git a/tevm/docs/procedures/type-aliases/EthGetTransactionByHashJsonRpcRequest.md b/tevm/docs/procedures/type-aliases/EthGetTransactionByHashJsonRpcRequest.md index 35b498ca1f..aa56c18a3e 100644 --- a/tevm/docs/procedures/type-aliases/EthGetTransactionByHashJsonRpcRequest.md +++ b/tevm/docs/procedures/type-aliases/EthGetTransactionByHashJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_getTransactionByHash` procedure ## Defined in -packages/procedures/dist/index.d.ts:356 +packages/procedures/dist/index.d.ts:361 diff --git a/tevm/docs/procedures/type-aliases/EthGetTransactionByHashJsonRpcResponse.md b/tevm/docs/procedures/type-aliases/EthGetTransactionByHashJsonRpcResponse.md index aa1996b5b7..df947e8361 100644 --- a/tevm/docs/procedures/type-aliases/EthGetTransactionByHashJsonRpcResponse.md +++ b/tevm/docs/procedures/type-aliases/EthGetTransactionByHashJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_getTransactionByHash` procedure ## Defined in -packages/procedures/dist/index.d.ts:521 +packages/procedures/dist/index.d.ts:526 diff --git a/tevm/docs/procedures/type-aliases/EthGetTransactionCountJsonRpcProcedure.md b/tevm/docs/procedures/type-aliases/EthGetTransactionCountJsonRpcProcedure.md index d9ab7fa5e5..a53a75fa2a 100644 --- a/tevm/docs/procedures/type-aliases/EthGetTransactionCountJsonRpcProcedure.md +++ b/tevm/docs/procedures/type-aliases/EthGetTransactionCountJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:620 +packages/procedures/dist/index.d.ts:625 diff --git a/tevm/docs/procedures/type-aliases/EthGetTransactionCountJsonRpcRequest.md b/tevm/docs/procedures/type-aliases/EthGetTransactionCountJsonRpcRequest.md index 8c6a036818..98f2095cbb 100644 --- a/tevm/docs/procedures/type-aliases/EthGetTransactionCountJsonRpcRequest.md +++ b/tevm/docs/procedures/type-aliases/EthGetTransactionCountJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_getTransactionCount` procedure ## Defined in -packages/procedures/dist/index.d.ts:344 +packages/procedures/dist/index.d.ts:349 diff --git a/tevm/docs/procedures/type-aliases/EthGetTransactionCountJsonRpcResponse.md b/tevm/docs/procedures/type-aliases/EthGetTransactionCountJsonRpcResponse.md index 7758ce991e..3d664cd79d 100644 --- a/tevm/docs/procedures/type-aliases/EthGetTransactionCountJsonRpcResponse.md +++ b/tevm/docs/procedures/type-aliases/EthGetTransactionCountJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_getTransactionCount` procedure ## Defined in -packages/procedures/dist/index.d.ts:509 +packages/procedures/dist/index.d.ts:514 diff --git a/tevm/docs/procedures/type-aliases/EthGetTransactionReceiptJsonRpcProcedure.md b/tevm/docs/procedures/type-aliases/EthGetTransactionReceiptJsonRpcProcedure.md index 9974c23c68..286a4615dc 100644 --- a/tevm/docs/procedures/type-aliases/EthGetTransactionReceiptJsonRpcProcedure.md +++ b/tevm/docs/procedures/type-aliases/EthGetTransactionReceiptJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:626 +packages/procedures/dist/index.d.ts:631 diff --git a/tevm/docs/procedures/type-aliases/EthGetTransactionReceiptJsonRpcRequest.md b/tevm/docs/procedures/type-aliases/EthGetTransactionReceiptJsonRpcRequest.md index f75cedba89..ef89132ba6 100644 --- a/tevm/docs/procedures/type-aliases/EthGetTransactionReceiptJsonRpcRequest.md +++ b/tevm/docs/procedures/type-aliases/EthGetTransactionReceiptJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_getTransactionReceipt` procedure ## Defined in -packages/procedures/dist/index.d.ts:368 +packages/procedures/dist/index.d.ts:373 diff --git a/tevm/docs/procedures/type-aliases/EthGetTransactionReceiptJsonRpcResponse.md b/tevm/docs/procedures/type-aliases/EthGetTransactionReceiptJsonRpcResponse.md index 3dc389a07b..ddec32213f 100644 --- a/tevm/docs/procedures/type-aliases/EthGetTransactionReceiptJsonRpcResponse.md +++ b/tevm/docs/procedures/type-aliases/EthGetTransactionReceiptJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_getTransactionReceipt` procedure ## Defined in -packages/procedures/dist/index.d.ts:533 +packages/procedures/dist/index.d.ts:538 diff --git a/tevm/docs/procedures/type-aliases/EthGetUncleByBlockHashAndIndexJsonRpcProcedure.md b/tevm/docs/procedures/type-aliases/EthGetUncleByBlockHashAndIndexJsonRpcProcedure.md index 1a4e8a6014..ed9ce62aeb 100644 --- a/tevm/docs/procedures/type-aliases/EthGetUncleByBlockHashAndIndexJsonRpcProcedure.md +++ b/tevm/docs/procedures/type-aliases/EthGetUncleByBlockHashAndIndexJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:627 +packages/procedures/dist/index.d.ts:632 diff --git a/tevm/docs/procedures/type-aliases/EthGetUncleByBlockHashAndIndexJsonRpcRequest.md b/tevm/docs/procedures/type-aliases/EthGetUncleByBlockHashAndIndexJsonRpcRequest.md index 85862571f3..f0e41dd463 100644 --- a/tevm/docs/procedures/type-aliases/EthGetUncleByBlockHashAndIndexJsonRpcRequest.md +++ b/tevm/docs/procedures/type-aliases/EthGetUncleByBlockHashAndIndexJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_getUncleByBlockHashAndIndex` procedure ## Defined in -packages/procedures/dist/index.d.ts:372 +packages/procedures/dist/index.d.ts:377 diff --git a/tevm/docs/procedures/type-aliases/EthGetUncleByBlockHashAndIndexJsonRpcResponse.md b/tevm/docs/procedures/type-aliases/EthGetUncleByBlockHashAndIndexJsonRpcResponse.md index 814b4026a5..6331df5314 100644 --- a/tevm/docs/procedures/type-aliases/EthGetUncleByBlockHashAndIndexJsonRpcResponse.md +++ b/tevm/docs/procedures/type-aliases/EthGetUncleByBlockHashAndIndexJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_getUncleByBlockHashAndIndex` procedure ## Defined in -packages/procedures/dist/index.d.ts:537 +packages/procedures/dist/index.d.ts:542 diff --git a/tevm/docs/procedures/type-aliases/EthGetUncleByBlockNumberAndIndexJsonRpcProcedure.md b/tevm/docs/procedures/type-aliases/EthGetUncleByBlockNumberAndIndexJsonRpcProcedure.md index 9dc1780d23..60f204595e 100644 --- a/tevm/docs/procedures/type-aliases/EthGetUncleByBlockNumberAndIndexJsonRpcProcedure.md +++ b/tevm/docs/procedures/type-aliases/EthGetUncleByBlockNumberAndIndexJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:628 +packages/procedures/dist/index.d.ts:633 diff --git a/tevm/docs/procedures/type-aliases/EthGetUncleByBlockNumberAndIndexJsonRpcRequest.md b/tevm/docs/procedures/type-aliases/EthGetUncleByBlockNumberAndIndexJsonRpcRequest.md index b3d32299b0..8f5f3dab9b 100644 --- a/tevm/docs/procedures/type-aliases/EthGetUncleByBlockNumberAndIndexJsonRpcRequest.md +++ b/tevm/docs/procedures/type-aliases/EthGetUncleByBlockNumberAndIndexJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_getUncleByBlockNumberAndIndex` procedure ## Defined in -packages/procedures/dist/index.d.ts:376 +packages/procedures/dist/index.d.ts:381 diff --git a/tevm/docs/procedures/type-aliases/EthGetUncleByBlockNumberAndIndexJsonRpcResponse.md b/tevm/docs/procedures/type-aliases/EthGetUncleByBlockNumberAndIndexJsonRpcResponse.md index 731954053c..446f7b6818 100644 --- a/tevm/docs/procedures/type-aliases/EthGetUncleByBlockNumberAndIndexJsonRpcResponse.md +++ b/tevm/docs/procedures/type-aliases/EthGetUncleByBlockNumberAndIndexJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_getUncleByBlockNumberAndIndex` procedure ## Defined in -packages/procedures/dist/index.d.ts:541 +packages/procedures/dist/index.d.ts:546 diff --git a/tevm/docs/procedures/type-aliases/EthGetUncleCountByBlockHashJsonRpcProcedure.md b/tevm/docs/procedures/type-aliases/EthGetUncleCountByBlockHashJsonRpcProcedure.md index 989cd3a6b7..7d8c3c6c30 100644 --- a/tevm/docs/procedures/type-aliases/EthGetUncleCountByBlockHashJsonRpcProcedure.md +++ b/tevm/docs/procedures/type-aliases/EthGetUncleCountByBlockHashJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:621 +packages/procedures/dist/index.d.ts:626 diff --git a/tevm/docs/procedures/type-aliases/EthGetUncleCountByBlockHashJsonRpcRequest.md b/tevm/docs/procedures/type-aliases/EthGetUncleCountByBlockHashJsonRpcRequest.md index 6d0114899a..289fbea5b7 100644 --- a/tevm/docs/procedures/type-aliases/EthGetUncleCountByBlockHashJsonRpcRequest.md +++ b/tevm/docs/procedures/type-aliases/EthGetUncleCountByBlockHashJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_getUncleCountByBlockHash` procedure ## Defined in -packages/procedures/dist/index.d.ts:348 +packages/procedures/dist/index.d.ts:353 diff --git a/tevm/docs/procedures/type-aliases/EthGetUncleCountByBlockHashJsonRpcResponse.md b/tevm/docs/procedures/type-aliases/EthGetUncleCountByBlockHashJsonRpcResponse.md index 23caa4c61a..d51082a219 100644 --- a/tevm/docs/procedures/type-aliases/EthGetUncleCountByBlockHashJsonRpcResponse.md +++ b/tevm/docs/procedures/type-aliases/EthGetUncleCountByBlockHashJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_getUncleCountByBlockHash` procedure ## Defined in -packages/procedures/dist/index.d.ts:513 +packages/procedures/dist/index.d.ts:518 diff --git a/tevm/docs/procedures/type-aliases/EthGetUncleCountByBlockNumberJsonRpcProcedure.md b/tevm/docs/procedures/type-aliases/EthGetUncleCountByBlockNumberJsonRpcProcedure.md index e186024a3c..0a51941521 100644 --- a/tevm/docs/procedures/type-aliases/EthGetUncleCountByBlockNumberJsonRpcProcedure.md +++ b/tevm/docs/procedures/type-aliases/EthGetUncleCountByBlockNumberJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:622 +packages/procedures/dist/index.d.ts:627 diff --git a/tevm/docs/procedures/type-aliases/EthGetUncleCountByBlockNumberJsonRpcRequest.md b/tevm/docs/procedures/type-aliases/EthGetUncleCountByBlockNumberJsonRpcRequest.md index 6530a35b17..a1d5c3c77e 100644 --- a/tevm/docs/procedures/type-aliases/EthGetUncleCountByBlockNumberJsonRpcRequest.md +++ b/tevm/docs/procedures/type-aliases/EthGetUncleCountByBlockNumberJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_getUncleCountByBlockNumber` procedure ## Defined in -packages/procedures/dist/index.d.ts:352 +packages/procedures/dist/index.d.ts:357 diff --git a/tevm/docs/procedures/type-aliases/EthGetUncleCountByBlockNumberJsonRpcResponse.md b/tevm/docs/procedures/type-aliases/EthGetUncleCountByBlockNumberJsonRpcResponse.md index 86301652d9..2d1c07cd41 100644 --- a/tevm/docs/procedures/type-aliases/EthGetUncleCountByBlockNumberJsonRpcResponse.md +++ b/tevm/docs/procedures/type-aliases/EthGetUncleCountByBlockNumberJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_getUncleCountByBlockNumber` procedure ## Defined in -packages/procedures/dist/index.d.ts:517 +packages/procedures/dist/index.d.ts:522 diff --git a/tevm/docs/procedures/type-aliases/EthHashrateJsonRpcProcedure.md b/tevm/docs/procedures/type-aliases/EthHashrateJsonRpcProcedure.md index b5f3bfc56f..7ab3ff4ce4 100644 --- a/tevm/docs/procedures/type-aliases/EthHashrateJsonRpcProcedure.md +++ b/tevm/docs/procedures/type-aliases/EthHashrateJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:608 +packages/procedures/dist/index.d.ts:613 diff --git a/tevm/docs/procedures/type-aliases/EthHashrateJsonRpcRequest.md b/tevm/docs/procedures/type-aliases/EthHashrateJsonRpcRequest.md index e30befa532..d9d5287b79 100644 --- a/tevm/docs/procedures/type-aliases/EthHashrateJsonRpcRequest.md +++ b/tevm/docs/procedures/type-aliases/EthHashrateJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_hashrate` procedure ## Defined in -packages/procedures/dist/index.d.ts:296 +packages/procedures/dist/index.d.ts:301 diff --git a/tevm/docs/procedures/type-aliases/EthHashrateJsonRpcResponse.md b/tevm/docs/procedures/type-aliases/EthHashrateJsonRpcResponse.md index 763203a2ba..35c4ac9786 100644 --- a/tevm/docs/procedures/type-aliases/EthHashrateJsonRpcResponse.md +++ b/tevm/docs/procedures/type-aliases/EthHashrateJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_hashrate` procedure ## Defined in -packages/procedures/dist/index.d.ts:461 +packages/procedures/dist/index.d.ts:466 diff --git a/tevm/docs/procedures/type-aliases/EthJsonRpcRequest.md b/tevm/docs/procedures/type-aliases/EthJsonRpcRequest.md index 137416f51d..fd8845793a 100644 --- a/tevm/docs/procedures/type-aliases/EthJsonRpcRequest.md +++ b/tevm/docs/procedures/type-aliases/EthJsonRpcRequest.md @@ -10,4 +10,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:432 +packages/procedures/dist/index.d.ts:437 diff --git a/tevm/docs/procedures/type-aliases/EthMiningJsonRpcProcedure.md b/tevm/docs/procedures/type-aliases/EthMiningJsonRpcProcedure.md index fa4a8d16a5..33238903ff 100644 --- a/tevm/docs/procedures/type-aliases/EthMiningJsonRpcProcedure.md +++ b/tevm/docs/procedures/type-aliases/EthMiningJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:629 +packages/procedures/dist/index.d.ts:634 diff --git a/tevm/docs/procedures/type-aliases/EthMiningJsonRpcRequest.md b/tevm/docs/procedures/type-aliases/EthMiningJsonRpcRequest.md index 6cbe03cd62..6838921c88 100644 --- a/tevm/docs/procedures/type-aliases/EthMiningJsonRpcRequest.md +++ b/tevm/docs/procedures/type-aliases/EthMiningJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_mining` procedure ## Defined in -packages/procedures/dist/index.d.ts:380 +packages/procedures/dist/index.d.ts:385 diff --git a/tevm/docs/procedures/type-aliases/EthMiningJsonRpcResponse.md b/tevm/docs/procedures/type-aliases/EthMiningJsonRpcResponse.md index 1d042fb142..ee1bc7cab0 100644 --- a/tevm/docs/procedures/type-aliases/EthMiningJsonRpcResponse.md +++ b/tevm/docs/procedures/type-aliases/EthMiningJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_mining` procedure ## Defined in -packages/procedures/dist/index.d.ts:545 +packages/procedures/dist/index.d.ts:550 diff --git a/tevm/docs/procedures/type-aliases/EthNewBlockFilterJsonRpcProcedure.md b/tevm/docs/procedures/type-aliases/EthNewBlockFilterJsonRpcProcedure.md index fa27a2c68a..2549dc9a2b 100644 --- a/tevm/docs/procedures/type-aliases/EthNewBlockFilterJsonRpcProcedure.md +++ b/tevm/docs/procedures/type-aliases/EthNewBlockFilterJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:637 +packages/procedures/dist/index.d.ts:642 diff --git a/tevm/docs/procedures/type-aliases/EthNewBlockFilterJsonRpcRequest.md b/tevm/docs/procedures/type-aliases/EthNewBlockFilterJsonRpcRequest.md index bea21278cf..78584cf91e 100644 --- a/tevm/docs/procedures/type-aliases/EthNewBlockFilterJsonRpcRequest.md +++ b/tevm/docs/procedures/type-aliases/EthNewBlockFilterJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_newBlockFilter` procedure ## Defined in -packages/procedures/dist/index.d.ts:423 +packages/procedures/dist/index.d.ts:428 diff --git a/tevm/docs/procedures/type-aliases/EthNewBlockFilterJsonRpcResponse.md b/tevm/docs/procedures/type-aliases/EthNewBlockFilterJsonRpcResponse.md index b7fd10d448..1587c79099 100644 --- a/tevm/docs/procedures/type-aliases/EthNewBlockFilterJsonRpcResponse.md +++ b/tevm/docs/procedures/type-aliases/EthNewBlockFilterJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_newBlockFilter` procedure ## Defined in -packages/procedures/dist/index.d.ts:592 +packages/procedures/dist/index.d.ts:597 diff --git a/tevm/docs/procedures/type-aliases/EthNewFilterJsonRpcProcedure.md b/tevm/docs/procedures/type-aliases/EthNewFilterJsonRpcProcedure.md index b909509fec..e39642f793 100644 --- a/tevm/docs/procedures/type-aliases/EthNewFilterJsonRpcProcedure.md +++ b/tevm/docs/procedures/type-aliases/EthNewFilterJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:636 +packages/procedures/dist/index.d.ts:641 diff --git a/tevm/docs/procedures/type-aliases/EthNewFilterJsonRpcRequest.md b/tevm/docs/procedures/type-aliases/EthNewFilterJsonRpcRequest.md index d8cc4f6ada..d3f456205a 100644 --- a/tevm/docs/procedures/type-aliases/EthNewFilterJsonRpcRequest.md +++ b/tevm/docs/procedures/type-aliases/EthNewFilterJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_newFilter` procedure ## Defined in -packages/procedures/dist/index.d.ts:419 +packages/procedures/dist/index.d.ts:424 diff --git a/tevm/docs/procedures/type-aliases/EthNewFilterJsonRpcResponse.md b/tevm/docs/procedures/type-aliases/EthNewFilterJsonRpcResponse.md index efc3f7dfca..db50896b2a 100644 --- a/tevm/docs/procedures/type-aliases/EthNewFilterJsonRpcResponse.md +++ b/tevm/docs/procedures/type-aliases/EthNewFilterJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_newFilter` procedure ## Defined in -packages/procedures/dist/index.d.ts:588 +packages/procedures/dist/index.d.ts:593 diff --git a/tevm/docs/procedures/type-aliases/EthNewPendingTransactionFilterJsonRpcProcedure.md b/tevm/docs/procedures/type-aliases/EthNewPendingTransactionFilterJsonRpcProcedure.md index 9f39e2a5a4..4e3fa7e4bf 100644 --- a/tevm/docs/procedures/type-aliases/EthNewPendingTransactionFilterJsonRpcProcedure.md +++ b/tevm/docs/procedures/type-aliases/EthNewPendingTransactionFilterJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:638 +packages/procedures/dist/index.d.ts:643 diff --git a/tevm/docs/procedures/type-aliases/EthNewPendingTransactionFilterJsonRpcRequest.md b/tevm/docs/procedures/type-aliases/EthNewPendingTransactionFilterJsonRpcRequest.md index f2b96602de..a56ed9ca3f 100644 --- a/tevm/docs/procedures/type-aliases/EthNewPendingTransactionFilterJsonRpcRequest.md +++ b/tevm/docs/procedures/type-aliases/EthNewPendingTransactionFilterJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_newPendingTransactionFilter` procedure ## Defined in -packages/procedures/dist/index.d.ts:427 +packages/procedures/dist/index.d.ts:432 diff --git a/tevm/docs/procedures/type-aliases/EthNewPendingTransactionFilterJsonRpcResponse.md b/tevm/docs/procedures/type-aliases/EthNewPendingTransactionFilterJsonRpcResponse.md index db3c683fb3..44936785e9 100644 --- a/tevm/docs/procedures/type-aliases/EthNewPendingTransactionFilterJsonRpcResponse.md +++ b/tevm/docs/procedures/type-aliases/EthNewPendingTransactionFilterJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_newPendingTransactionFilter` procedure ## Defined in -packages/procedures/dist/index.d.ts:596 +packages/procedures/dist/index.d.ts:601 diff --git a/tevm/docs/procedures/type-aliases/EthProtocolVersionJsonRpcProcedure.md b/tevm/docs/procedures/type-aliases/EthProtocolVersionJsonRpcProcedure.md index eee0037664..a749252df7 100644 --- a/tevm/docs/procedures/type-aliases/EthProtocolVersionJsonRpcProcedure.md +++ b/tevm/docs/procedures/type-aliases/EthProtocolVersionJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:630 +packages/procedures/dist/index.d.ts:635 diff --git a/tevm/docs/procedures/type-aliases/EthProtocolVersionJsonRpcRequest.md b/tevm/docs/procedures/type-aliases/EthProtocolVersionJsonRpcRequest.md index 47ee7ce0f4..42038ae127 100644 --- a/tevm/docs/procedures/type-aliases/EthProtocolVersionJsonRpcRequest.md +++ b/tevm/docs/procedures/type-aliases/EthProtocolVersionJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_protocolVersion` procedure ## Defined in -packages/procedures/dist/index.d.ts:384 +packages/procedures/dist/index.d.ts:389 diff --git a/tevm/docs/procedures/type-aliases/EthProtocolVersionJsonRpcResponse.md b/tevm/docs/procedures/type-aliases/EthProtocolVersionJsonRpcResponse.md index 5ac0103cb8..57f0b8dd32 100644 --- a/tevm/docs/procedures/type-aliases/EthProtocolVersionJsonRpcResponse.md +++ b/tevm/docs/procedures/type-aliases/EthProtocolVersionJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_protocolVersion` procedure ## Defined in -packages/procedures/dist/index.d.ts:549 +packages/procedures/dist/index.d.ts:554 diff --git a/tevm/docs/procedures/type-aliases/EthRequestType.md b/tevm/docs/procedures/type-aliases/EthRequestType.md index e9c01cb1c3..695ab5ee89 100644 --- a/tevm/docs/procedures/type-aliases/EthRequestType.md +++ b/tevm/docs/procedures/type-aliases/EthRequestType.md @@ -166,4 +166,4 @@ A mapping of `eth_*` method names to their request type ## Defined in -packages/procedures/dist/index.d.ts:1280 +packages/procedures/dist/index.d.ts:1285 diff --git a/tevm/docs/procedures/type-aliases/EthReturnType.md b/tevm/docs/procedures/type-aliases/EthReturnType.md index 8aee2e90bb..3228a662b1 100644 --- a/tevm/docs/procedures/type-aliases/EthReturnType.md +++ b/tevm/docs/procedures/type-aliases/EthReturnType.md @@ -166,4 +166,4 @@ A mapping of `eth_*` method names to their return type ## Defined in -packages/procedures/dist/index.d.ts:890 +packages/procedures/dist/index.d.ts:895 diff --git a/tevm/docs/procedures/type-aliases/EthSendRawTransactionJsonRpcProcedure.md b/tevm/docs/procedures/type-aliases/EthSendRawTransactionJsonRpcProcedure.md index f4fddca174..2f9ad1061e 100644 --- a/tevm/docs/procedures/type-aliases/EthSendRawTransactionJsonRpcProcedure.md +++ b/tevm/docs/procedures/type-aliases/EthSendRawTransactionJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:631 +packages/procedures/dist/index.d.ts:636 diff --git a/tevm/docs/procedures/type-aliases/EthSendRawTransactionJsonRpcRequest.md b/tevm/docs/procedures/type-aliases/EthSendRawTransactionJsonRpcRequest.md index c0f6bfae4c..0358ae72c0 100644 --- a/tevm/docs/procedures/type-aliases/EthSendRawTransactionJsonRpcRequest.md +++ b/tevm/docs/procedures/type-aliases/EthSendRawTransactionJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_sendRawTransaction` procedure ## Defined in -packages/procedures/dist/index.d.ts:388 +packages/procedures/dist/index.d.ts:393 diff --git a/tevm/docs/procedures/type-aliases/EthSendRawTransactionJsonRpcResponse.md b/tevm/docs/procedures/type-aliases/EthSendRawTransactionJsonRpcResponse.md index a7ddc82edb..59fb5f5317 100644 --- a/tevm/docs/procedures/type-aliases/EthSendRawTransactionJsonRpcResponse.md +++ b/tevm/docs/procedures/type-aliases/EthSendRawTransactionJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_sendRawTransaction` procedure ## Defined in -packages/procedures/dist/index.d.ts:553 +packages/procedures/dist/index.d.ts:558 diff --git a/tevm/docs/procedures/type-aliases/EthSendTransactionJsonRpcProcedure.md b/tevm/docs/procedures/type-aliases/EthSendTransactionJsonRpcProcedure.md index 4f3f21e4d9..844e5ce46c 100644 --- a/tevm/docs/procedures/type-aliases/EthSendTransactionJsonRpcProcedure.md +++ b/tevm/docs/procedures/type-aliases/EthSendTransactionJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:632 +packages/procedures/dist/index.d.ts:637 diff --git a/tevm/docs/procedures/type-aliases/EthSendTransactionJsonRpcRequest.md b/tevm/docs/procedures/type-aliases/EthSendTransactionJsonRpcRequest.md index 50656ab9d3..9d301a9828 100644 --- a/tevm/docs/procedures/type-aliases/EthSendTransactionJsonRpcRequest.md +++ b/tevm/docs/procedures/type-aliases/EthSendTransactionJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_sendTransaction` procedure ## Defined in -packages/procedures/dist/index.d.ts:392 +packages/procedures/dist/index.d.ts:397 diff --git a/tevm/docs/procedures/type-aliases/EthSendTransactionJsonRpcResponse.md b/tevm/docs/procedures/type-aliases/EthSendTransactionJsonRpcResponse.md index 34d88b7325..db4fe7ed55 100644 --- a/tevm/docs/procedures/type-aliases/EthSendTransactionJsonRpcResponse.md +++ b/tevm/docs/procedures/type-aliases/EthSendTransactionJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_sendTransaction` procedure ## Defined in -packages/procedures/dist/index.d.ts:557 +packages/procedures/dist/index.d.ts:562 diff --git a/tevm/docs/procedures/type-aliases/EthSignJsonRpcProcedure.md b/tevm/docs/procedures/type-aliases/EthSignJsonRpcProcedure.md index 800cdb4fe6..124b834d68 100644 --- a/tevm/docs/procedures/type-aliases/EthSignJsonRpcProcedure.md +++ b/tevm/docs/procedures/type-aliases/EthSignJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:633 +packages/procedures/dist/index.d.ts:638 diff --git a/tevm/docs/procedures/type-aliases/EthSignJsonRpcRequest.md b/tevm/docs/procedures/type-aliases/EthSignJsonRpcRequest.md index 5ef63d330b..a7db071259 100644 --- a/tevm/docs/procedures/type-aliases/EthSignJsonRpcRequest.md +++ b/tevm/docs/procedures/type-aliases/EthSignJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_sign` procedure ## Defined in -packages/procedures/dist/index.d.ts:396 +packages/procedures/dist/index.d.ts:401 diff --git a/tevm/docs/procedures/type-aliases/EthSignJsonRpcResponse.md b/tevm/docs/procedures/type-aliases/EthSignJsonRpcResponse.md index dddb803339..1e50f412b3 100644 --- a/tevm/docs/procedures/type-aliases/EthSignJsonRpcResponse.md +++ b/tevm/docs/procedures/type-aliases/EthSignJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_sign` procedure ## Defined in -packages/procedures/dist/index.d.ts:561 +packages/procedures/dist/index.d.ts:566 diff --git a/tevm/docs/procedures/type-aliases/EthSignTransactionJsonRpcProcedure.md b/tevm/docs/procedures/type-aliases/EthSignTransactionJsonRpcProcedure.md index c844fd2e2b..7c1a0c6fe8 100644 --- a/tevm/docs/procedures/type-aliases/EthSignTransactionJsonRpcProcedure.md +++ b/tevm/docs/procedures/type-aliases/EthSignTransactionJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:634 +packages/procedures/dist/index.d.ts:639 diff --git a/tevm/docs/procedures/type-aliases/EthSignTransactionJsonRpcRequest.md b/tevm/docs/procedures/type-aliases/EthSignTransactionJsonRpcRequest.md index fff3b00185..1ddd3ce567 100644 --- a/tevm/docs/procedures/type-aliases/EthSignTransactionJsonRpcRequest.md +++ b/tevm/docs/procedures/type-aliases/EthSignTransactionJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_signTransaction` procedure ## Defined in -packages/procedures/dist/index.d.ts:400 +packages/procedures/dist/index.d.ts:405 diff --git a/tevm/docs/procedures/type-aliases/EthSignTransactionJsonRpcResponse.md b/tevm/docs/procedures/type-aliases/EthSignTransactionJsonRpcResponse.md index 434e6906d0..73acef29c2 100644 --- a/tevm/docs/procedures/type-aliases/EthSignTransactionJsonRpcResponse.md +++ b/tevm/docs/procedures/type-aliases/EthSignTransactionJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_signTransaction` procedure ## Defined in -packages/procedures/dist/index.d.ts:565 +packages/procedures/dist/index.d.ts:570 diff --git a/tevm/docs/procedures/type-aliases/EthSyncingJsonRpcProcedure.md b/tevm/docs/procedures/type-aliases/EthSyncingJsonRpcProcedure.md index e2f8e5bb24..54bb42a50e 100644 --- a/tevm/docs/procedures/type-aliases/EthSyncingJsonRpcProcedure.md +++ b/tevm/docs/procedures/type-aliases/EthSyncingJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:635 +packages/procedures/dist/index.d.ts:640 diff --git a/tevm/docs/procedures/type-aliases/EthSyncingJsonRpcRequest.md b/tevm/docs/procedures/type-aliases/EthSyncingJsonRpcRequest.md index 16ed83a5c9..14ce3989b8 100644 --- a/tevm/docs/procedures/type-aliases/EthSyncingJsonRpcRequest.md +++ b/tevm/docs/procedures/type-aliases/EthSyncingJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_syncing` procedure ## Defined in -packages/procedures/dist/index.d.ts:415 +packages/procedures/dist/index.d.ts:420 diff --git a/tevm/docs/procedures/type-aliases/EthSyncingJsonRpcResponse.md b/tevm/docs/procedures/type-aliases/EthSyncingJsonRpcResponse.md index 649345ef8e..6523b447b1 100644 --- a/tevm/docs/procedures/type-aliases/EthSyncingJsonRpcResponse.md +++ b/tevm/docs/procedures/type-aliases/EthSyncingJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_syncing` procedure ## Defined in -packages/procedures/dist/index.d.ts:569 +packages/procedures/dist/index.d.ts:574 diff --git a/tevm/docs/procedures/type-aliases/EthUninstallFilterJsonRpcProcedure.md b/tevm/docs/procedures/type-aliases/EthUninstallFilterJsonRpcProcedure.md index 92ecfe6cd8..9db84fa9a9 100644 --- a/tevm/docs/procedures/type-aliases/EthUninstallFilterJsonRpcProcedure.md +++ b/tevm/docs/procedures/type-aliases/EthUninstallFilterJsonRpcProcedure.md @@ -18,4 +18,4 @@ ## Defined in -packages/procedures/dist/index.d.ts:639 +packages/procedures/dist/index.d.ts:644 diff --git a/tevm/docs/procedures/type-aliases/EthUninstallFilterJsonRpcRequest.md b/tevm/docs/procedures/type-aliases/EthUninstallFilterJsonRpcRequest.md index bbef7621ff..9ee472a9e8 100644 --- a/tevm/docs/procedures/type-aliases/EthUninstallFilterJsonRpcRequest.md +++ b/tevm/docs/procedures/type-aliases/EthUninstallFilterJsonRpcRequest.md @@ -12,4 +12,4 @@ JSON-RPC request for `eth_uninstallFilter` procedure ## Defined in -packages/procedures/dist/index.d.ts:431 +packages/procedures/dist/index.d.ts:436 diff --git a/tevm/docs/procedures/type-aliases/EthUninstallFilterJsonRpcResponse.md b/tevm/docs/procedures/type-aliases/EthUninstallFilterJsonRpcResponse.md index ebedfa2a72..5a57c32121 100644 --- a/tevm/docs/procedures/type-aliases/EthUninstallFilterJsonRpcResponse.md +++ b/tevm/docs/procedures/type-aliases/EthUninstallFilterJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `eth_uninstallFilter` procedure ## Defined in -packages/procedures/dist/index.d.ts:600 +packages/procedures/dist/index.d.ts:605 diff --git a/tevm/docs/procedures/type-aliases/GetAccountJsonRpcProcedure.md b/tevm/docs/procedures/type-aliases/GetAccountJsonRpcProcedure.md index 5b7603a9f1..41feb8e45b 100644 --- a/tevm/docs/procedures/type-aliases/GetAccountJsonRpcProcedure.md +++ b/tevm/docs/procedures/type-aliases/GetAccountJsonRpcProcedure.md @@ -20,4 +20,4 @@ GetAccount JSON-RPC tevm procedure puts an account or contract into the tevm sta ## Defined in -packages/procedures/dist/index.d.ts:1207 +packages/procedures/dist/index.d.ts:1212 diff --git a/tevm/docs/procedures/type-aliases/GetAccountJsonRpcResponse.md b/tevm/docs/procedures/type-aliases/GetAccountJsonRpcResponse.md index a616736706..ca4552c08a 100644 --- a/tevm/docs/procedures/type-aliases/GetAccountJsonRpcResponse.md +++ b/tevm/docs/procedures/type-aliases/GetAccountJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `tevm_getAccount` method ## Defined in -packages/procedures/dist/index.d.ts:946 +packages/procedures/dist/index.d.ts:951 diff --git a/tevm/docs/procedures/type-aliases/LoadStateJsonRpcProcedure.md b/tevm/docs/procedures/type-aliases/LoadStateJsonRpcProcedure.md index 74ebc86cac..3203554f4c 100644 --- a/tevm/docs/procedures/type-aliases/LoadStateJsonRpcProcedure.md +++ b/tevm/docs/procedures/type-aliases/LoadStateJsonRpcProcedure.md @@ -20,4 +20,4 @@ jsonrpc error response if there are errors otherwise it returns a successful emp ## Defined in -packages/procedures/dist/index.d.ts:1224 +packages/procedures/dist/index.d.ts:1229 diff --git a/tevm/docs/procedures/type-aliases/LoadStateJsonRpcResponse.md b/tevm/docs/procedures/type-aliases/LoadStateJsonRpcResponse.md index 413418e502..88ec7712d2 100644 --- a/tevm/docs/procedures/type-aliases/LoadStateJsonRpcResponse.md +++ b/tevm/docs/procedures/type-aliases/LoadStateJsonRpcResponse.md @@ -12,4 +12,4 @@ Response of the `tevm_loadState` RPC method. ## Defined in -packages/procedures/dist/index.d.ts:951 +packages/procedures/dist/index.d.ts:956 diff --git a/tevm/docs/procedures/type-aliases/MineJsonRpcProcedure.md b/tevm/docs/procedures/type-aliases/MineJsonRpcProcedure.md index 8415d38348..ef52802607 100644 --- a/tevm/docs/procedures/type-aliases/MineJsonRpcProcedure.md +++ b/tevm/docs/procedures/type-aliases/MineJsonRpcProcedure.md @@ -20,4 +20,4 @@ Mine JSON-RPC tevm procedure mines 1 or more blocks ## Defined in -packages/procedures/dist/index.d.ts:1231 +packages/procedures/dist/index.d.ts:1236 diff --git a/tevm/docs/procedures/type-aliases/MineJsonRpcResponse.md b/tevm/docs/procedures/type-aliases/MineJsonRpcResponse.md index 7a11879998..439df72450 100644 --- a/tevm/docs/procedures/type-aliases/MineJsonRpcResponse.md +++ b/tevm/docs/procedures/type-aliases/MineJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `tevm_mine` method ## Defined in -packages/procedures/dist/index.d.ts:956 +packages/procedures/dist/index.d.ts:961 diff --git a/tevm/docs/procedures/type-aliases/ScriptJsonRpcProcedure.md b/tevm/docs/procedures/type-aliases/ScriptJsonRpcProcedure.md index 51fe206969..da87ca6bf7 100644 --- a/tevm/docs/procedures/type-aliases/ScriptJsonRpcProcedure.md +++ b/tevm/docs/procedures/type-aliases/ScriptJsonRpcProcedure.md @@ -8,6 +8,11 @@ > **ScriptJsonRpcProcedure**: (`request`) => `Promise`\<[`ScriptJsonRpcResponse`](ScriptJsonRpcResponse.md)\> +## Deprecated + +Use CallJsonRpcProcedure instead +Procedure for handling script JSON-RPC requests + ## Parameters • **request**: [`ScriptJsonRpcRequest`](ScriptJsonRpcRequest.md) @@ -16,11 +21,6 @@ `Promise`\<[`ScriptJsonRpcResponse`](ScriptJsonRpcResponse.md)\> -## Deprecated - -Use CallJsonRpcProcedure instead -Procedure for handling script JSON-RPC requests - ## Defined in -packages/procedures/dist/index.d.ts:1239 +packages/procedures/dist/index.d.ts:1244 diff --git a/tevm/docs/procedures/type-aliases/ScriptJsonRpcResponse.md b/tevm/docs/procedures/type-aliases/ScriptJsonRpcResponse.md index 791bb42e25..61103ef670 100644 --- a/tevm/docs/procedures/type-aliases/ScriptJsonRpcResponse.md +++ b/tevm/docs/procedures/type-aliases/ScriptJsonRpcResponse.md @@ -31,4 +31,4 @@ const respose: ScriptJsonRpcResponse = await tevm.request({ ## Defined in -packages/procedures/dist/index.d.ts:974 +packages/procedures/dist/index.d.ts:979 diff --git a/tevm/docs/procedures/type-aliases/SetAccountJsonRpcProcedure.md b/tevm/docs/procedures/type-aliases/SetAccountJsonRpcProcedure.md index 0f680cdb7b..231e88a5be 100644 --- a/tevm/docs/procedures/type-aliases/SetAccountJsonRpcProcedure.md +++ b/tevm/docs/procedures/type-aliases/SetAccountJsonRpcProcedure.md @@ -20,4 +20,4 @@ SetAccount JSON-RPC tevm procedure sets an account into the tevm state ## Defined in -packages/procedures/dist/index.d.ts:1246 +packages/procedures/dist/index.d.ts:1251 diff --git a/tevm/docs/procedures/type-aliases/SetAccountJsonRpcResponse.md b/tevm/docs/procedures/type-aliases/SetAccountJsonRpcResponse.md index 04cda976b6..5e94a875fd 100644 --- a/tevm/docs/procedures/type-aliases/SetAccountJsonRpcResponse.md +++ b/tevm/docs/procedures/type-aliases/SetAccountJsonRpcResponse.md @@ -12,4 +12,4 @@ JSON-RPC response for `tevm_setAccount` method ## Defined in -packages/procedures/dist/index.d.ts:979 +packages/procedures/dist/index.d.ts:984 diff --git a/tevm/docs/procedures/type-aliases/TevmRequestType.md b/tevm/docs/procedures/type-aliases/TevmRequestType.md index 1fb188e83a..c682cc43cf 100644 --- a/tevm/docs/procedures/type-aliases/TevmRequestType.md +++ b/tevm/docs/procedures/type-aliases/TevmRequestType.md @@ -44,4 +44,4 @@ A mapping of `tevm_*` method names to their request type ## Defined in -packages/procedures/dist/index.d.ts:1324 +packages/procedures/dist/index.d.ts:1329 diff --git a/tevm/docs/procedures/type-aliases/TevmReturnType.md b/tevm/docs/procedures/type-aliases/TevmReturnType.md index f026e6ceeb..faad058b22 100644 --- a/tevm/docs/procedures/type-aliases/TevmReturnType.md +++ b/tevm/docs/procedures/type-aliases/TevmReturnType.md @@ -44,4 +44,4 @@ A mapping of `tevm_*` method names to their return type ## Defined in -packages/procedures/dist/index.d.ts:984 +packages/procedures/dist/index.d.ts:989 diff --git a/tevm/docs/server/classes/InvalidJsonError.md b/tevm/docs/server/classes/InvalidJsonError.md index e27ecac464..0601aa2238 100644 --- a/tevm/docs/server/classes/InvalidJsonError.md +++ b/tevm/docs/server/classes/InvalidJsonError.md @@ -79,7 +79,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -93,7 +93,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -109,7 +109,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -123,7 +123,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -139,7 +139,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -171,7 +171,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -201,7 +201,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -229,7 +229,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -239,6 +239,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -249,10 +253,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`BaseError`](../../errors/classes/BaseError.md).[`prepareStackTrace`](../../errors/classes/BaseError.md#preparestacktrace) @@ -301,7 +301,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -353,4 +353,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`BaseError`](../../errors/classes/BaseError.md).[`captureStackTrace`](../../errors/classes/BaseError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/server/classes/ReadRequestBodyError.md b/tevm/docs/server/classes/ReadRequestBodyError.md index 08fe3b3cfb..e61775624b 100644 --- a/tevm/docs/server/classes/ReadRequestBodyError.md +++ b/tevm/docs/server/classes/ReadRequestBodyError.md @@ -66,7 +66,7 @@ Same as name, used internally. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:39 +packages/errors/types/ethereum/BaseError.d.ts:40 *** @@ -80,7 +80,7 @@ packages/errors/types/ethereum/BaseError.d.ts:39 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:64 +packages/errors/types/ethereum/BaseError.d.ts:65 *** @@ -96,7 +96,7 @@ Error code, analogous to the code in JSON RPC error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:63 +packages/errors/types/ethereum/BaseError.d.ts:64 *** @@ -110,7 +110,7 @@ packages/errors/types/ethereum/BaseError.d.ts:63 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:43 +packages/errors/types/ethereum/BaseError.d.ts:44 *** @@ -126,7 +126,7 @@ Path to the documentation for this error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:47 +packages/errors/types/ethereum/BaseError.d.ts:48 *** @@ -158,7 +158,7 @@ Additional meta messages for more context. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:51 +packages/errors/types/ethereum/BaseError.d.ts:52 *** @@ -188,7 +188,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:55 +packages/errors/types/ethereum/BaseError.d.ts:56 *** @@ -216,7 +216,7 @@ node\_modules/.pnpm/typescript@5.5.4/node\_modules/typescript/lib/lib.es5.d.ts:1 #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:59 +packages/errors/types/ethereum/BaseError.d.ts:60 *** @@ -226,6 +226,10 @@ packages/errors/types/ethereum/BaseError.d.ts:59 Optional override for formatting stack traces +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + #### Parameters • **err**: `Error` @@ -236,10 +240,6 @@ Optional override for formatting stack traces `any` -#### See - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - #### Inherited from [`BaseError`](../../errors/classes/BaseError.md).[`prepareStackTrace`](../../errors/classes/BaseError.md#preparestacktrace) @@ -288,7 +288,7 @@ The first error that matches the function, or the original error. #### Defined in -packages/errors/types/ethereum/BaseError.d.ts:70 +packages/errors/types/ethereum/BaseError.d.ts:71 *** @@ -340,4 +340,28 @@ Create .stack property on a target object ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/globals.d.ts:22 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/globals.d.ts:21 + +#### captureStackTrace(targetObject, constructorOpt) + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void` + +Create .stack property on a target object + +##### Parameters + +• **targetObject**: `object` + +• **constructorOpt?**: `Function` + +##### Returns + +`void` + +##### Inherited from + +[`BaseError`](../../errors/classes/BaseError.md).[`captureStackTrace`](../../errors/classes/BaseError.md#capturestacktrace) + +##### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/globals.d.ts:67 diff --git a/tevm/docs/server/functions/createServer.md b/tevm/docs/server/functions/createServer.md index 37e4c3f1c7..bb22e9d2ba 100644 --- a/tevm/docs/server/functions/createServer.md +++ b/tevm/docs/server/functions/createServer.md @@ -12,7 +12,7 @@ • **client** -• **client.account**: `undefined` \| `Account` +• **client.account**: `undefined` \| [`Account`](../../index/type-aliases/Account.md) The Account of the Client. @@ -1273,7 +1273,7 @@ A name for the client. Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. -• **client.prepareTransactionRequest?**: \<`TRequest`, `TChainOverride`, `TAccountOverride`\>(`args`) => `Promise`\<\{ \[K in string \| number \| symbol\]: (UnionRequiredBy\ & Object, ParameterTypeToParameters\<(...)\[(...)\] extends readonly (...)\[\] ? (...)\[(...)\] : (...) \| (...) \| (...) \| (...) \| (...) \| (...)\>\> & (unknown extends TRequest\["kzg"\] ? Object : Pick\))\[K\] \}\> & \<`TRequest`, `TChainOverride`, `TAccountOverride`\>(`args`) => `Promise`\<\{ \[K in string \| number \| symbol\]: (UnionRequiredBy\ & Object, ParameterTypeToParameters\<(...)\[(...)\] extends readonly (...)\[\] ? (...)\[(...)\] : (...) \| (...) \| (...) \| (...) \| (...) \| (...)\>\> & (unknown extends TRequest\["kzg"\] ? Object : Pick\))\[K\] \}\> +• **client.prepareTransactionRequest?**: \<`request`, `chainOverride`, `accountOverride`\>(`args`) => `Promise`\<\{ \[K in string \| number \| symbol\]: (UnionRequiredBy\ & Object, ParameterTypeToParameters\<(...)\[(...)\] extends readonly (...)\[\] ? (...)\[(...)\] : (...) \| (...) \| (...) \| (...) \| (...) \| (...)\>\> & (unknown extends request\["kzg"\] ? Object : Pick\))\[K\] \}\> & \<`request`, `chainOverride`, `accountOverride`\>(`args`) => `Promise`\<\{ \[K in string \| number \| symbol\]: (UnionRequiredBy\ & Object, ParameterTypeToParameters\<(...)\[(...)\] extends readonly (...)\[\] ? (...)\[(...)\] : (...) \| (...) \| (...) \| (...) \| (...) \| (...)\>\> & (unknown extends request\["kzg"\] ? Object : Pick\))\[K\] \}\> Prepares a transaction request for signing. diff --git a/tevm/docs/state/classes/AccountCache.md b/tevm/docs/state/classes/AccountCache.md index 14ce427323..0dba2a4e93 100644 --- a/tevm/docs/state/classes/AccountCache.md +++ b/tevm/docs/state/classes/AccountCache.md @@ -30,7 +30,7 @@ #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/account.d.ts:27 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/account.d.ts:27 ## Properties @@ -44,7 +44,7 @@ node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/sta #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/cache.d.ts:4 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/cache.d.ts:4 *** @@ -58,7 +58,7 @@ node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/sta #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/cache.d.ts:3 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/cache.d.ts:3 *** @@ -76,7 +76,7 @@ before. #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/account.d.ts:26 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/account.d.ts:26 *** @@ -86,7 +86,7 @@ node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/sta #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/account.d.ts:15 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/account.d.ts:15 *** @@ -96,7 +96,7 @@ node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/sta #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/account.d.ts:16 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/account.d.ts:16 *** @@ -130,7 +130,7 @@ node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/sta #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/cache.d.ts:5 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/cache.d.ts:5 ## Methods @@ -148,7 +148,7 @@ node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/sta #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/account.d.ts:28 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/account.d.ts:28 *** @@ -165,7 +165,7 @@ later on be reverted or committed. #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/account.d.ts:62 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/account.d.ts:62 *** @@ -181,7 +181,7 @@ Clears cache. #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/account.d.ts:82 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/account.d.ts:82 *** @@ -197,7 +197,7 @@ Commits to current state of cache (no effect on trie). #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/account.d.ts:57 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/account.d.ts:57 *** @@ -219,7 +219,7 @@ Address #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/account.d.ts:44 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/account.d.ts:44 *** @@ -236,7 +236,7 @@ or deleted and resetting the diff cache (at checkpoint height). #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/account.d.ts:49 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/account.d.ts:49 *** @@ -258,13 +258,13 @@ Address of account #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/account.d.ts:39 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/account.d.ts:39 *** ### put() -> **put**(`address`, `account`): `void` +> **put**(`address`, `account`, `couldBeParitalAccount`?): `void` Puts account to cache under its address. @@ -278,13 +278,15 @@ Address of account Account or undefined if account doesn't exist in the trie +• **couldBeParitalAccount?**: `boolean` + #### Returns `void` #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/account.d.ts:34 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/account.d.ts:34 *** @@ -300,7 +302,7 @@ Revert changes to cache last checkpoint (no effect on trie). #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/account.d.ts:53 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/account.d.ts:53 *** @@ -316,7 +318,7 @@ Returns the size of the cache #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/account.d.ts:67 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/account.d.ts:67 *** @@ -356,4 +358,4 @@ Returns a dict with cache stats #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/account.d.ts:72 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/account.d.ts:72 diff --git a/tevm/docs/state/classes/StorageCache.md b/tevm/docs/state/classes/StorageCache.md index 474944c446..0ed9e79d61 100644 --- a/tevm/docs/state/classes/StorageCache.md +++ b/tevm/docs/state/classes/StorageCache.md @@ -30,7 +30,7 @@ #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:26 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:26 ## Properties @@ -44,7 +44,7 @@ node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/sta #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/cache.d.ts:4 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/cache.d.ts:4 *** @@ -58,7 +58,7 @@ node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/sta #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/cache.d.ts:3 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/cache.d.ts:3 *** @@ -76,7 +76,7 @@ before. #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:25 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:25 *** @@ -86,7 +86,7 @@ node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/sta #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:14 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:14 *** @@ -96,7 +96,7 @@ node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/sta #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:15 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:15 *** @@ -130,7 +130,7 @@ node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/sta #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/cache.d.ts:5 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/cache.d.ts:5 ## Methods @@ -150,7 +150,7 @@ node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/sta #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:27 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:27 *** @@ -167,7 +167,7 @@ later on be reverted or committed. #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:72 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:72 *** @@ -183,7 +183,7 @@ Clears cache. #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:92 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:92 *** @@ -203,7 +203,7 @@ Deletes all storage slots for address from the cache #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:54 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:54 *** @@ -219,7 +219,7 @@ Commits to current state of cache (no effect on trie). #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:67 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:67 *** @@ -245,7 +245,7 @@ Storage key #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:49 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:49 *** @@ -269,7 +269,7 @@ The address of the `account` to return storage for #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:98 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:98 *** @@ -286,7 +286,7 @@ or deleted and resetting the diff cache (at checkpoint height). #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:59 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:59 *** @@ -316,7 +316,7 @@ Storage value or undefined #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:43 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:43 *** @@ -344,7 +344,7 @@ Storage key #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:34 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:34 *** @@ -360,7 +360,7 @@ Revert changes to cache last checkpoint (no effect on trie). #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:63 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:63 *** @@ -376,7 +376,7 @@ Returns the size of the cache #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:77 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:77 *** @@ -416,4 +416,4 @@ Returns a dict with cache stats #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:82 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/storage.d.ts:82 diff --git a/tevm/docs/state/enumerations/CacheType.md b/tevm/docs/state/enumerations/CacheType.md index 4f31c66049..e5b7308265 100644 --- a/tevm/docs/state/enumerations/CacheType.md +++ b/tevm/docs/state/enumerations/CacheType.md @@ -14,7 +14,7 @@ #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/types.d.ts:2 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/types.d.ts:2 *** @@ -24,4 +24,4 @@ node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/sta #### Defined in -node\_modules/.pnpm/@ethereumjs+statemanager@2.3.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/types.d.ts:3 +node\_modules/.pnpm/@ethereumjs+statemanager@2.4.0/node\_modules/@ethereumjs/statemanager/dist/esm/cache/types.d.ts:3 diff --git a/tevm/docs/state/functions/getAppliedKey.md b/tevm/docs/state/functions/getAppliedKey.md index d81cad9262..6915fe570f 100644 --- a/tevm/docs/state/functions/getAppliedKey.md +++ b/tevm/docs/state/functions/getAppliedKey.md @@ -18,11 +18,6 @@ `undefined` \| (`address`) => `Uint8Array` -## Deprecated - -Returns the applied key for a given address -Used for saving preimages - ## Defined in packages/state/dist/index.d.ts:285 diff --git a/tevm/docs/state/interfaces/StateManager.md b/tevm/docs/state/interfaces/StateManager.md index eb795e36b0..ecdd045ca4 100644 --- a/tevm/docs/state/interfaces/StateManager.md +++ b/tevm/docs/state/interfaces/StateManager.md @@ -68,7 +68,7 @@ packages/state/dist/index.d.ts:132 #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:73 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:136 *** @@ -86,6 +86,30 @@ packages/state/dist/index.d.ts:128 ## Methods +### checkChunkWitnessPresent()? + +> `optional` **checkChunkWitnessPresent**(`contract`, `programCounter`): `Promise`\<`boolean`\> + +#### Parameters + +• **contract**: [`EthjsAddress`](../../utils/classes/EthjsAddress.md) + +• **programCounter**: `number` + +#### Returns + +`Promise`\<`boolean`\> + +#### Inherited from + +[`EvmStateManagerInterface`](../../common/interfaces/EvmStateManagerInterface.md).[`checkChunkWitnessPresent`](../../common/interfaces/EvmStateManagerInterface.md#checkchunkwitnesspresent) + +#### Defined in + +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:133 + +*** + ### checkpoint() > **checkpoint**(): `Promise`\<`void`\> @@ -100,7 +124,7 @@ packages/state/dist/index.d.ts:128 #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:62 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:124 *** @@ -138,7 +162,7 @@ packages/state/dist/index.d.ts:144 #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:61 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:123 *** @@ -206,7 +230,7 @@ packages/state/dist/index.d.ts:136 #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:55 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:116 *** @@ -244,7 +268,7 @@ packages/state/dist/index.d.ts:140 #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:77 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:140 *** @@ -270,7 +294,7 @@ node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/di #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:78 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:141 *** @@ -292,7 +316,7 @@ node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/di #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:79 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:142 *** @@ -314,7 +338,7 @@ node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/di #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:53 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:114 *** @@ -336,7 +360,7 @@ node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/di #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:70 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:132 *** @@ -358,7 +382,29 @@ node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/di #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:58 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:119 + +*** + +### getContractCodeSize()? + +> `optional` **getContractCodeSize**(`address`): `Promise`\<`number`\> + +#### Parameters + +• **address**: [`EthjsAddress`](../../utils/classes/EthjsAddress.md) + +#### Returns + +`Promise`\<`number`\> + +#### Inherited from + +[`EvmStateManagerInterface`](../../common/interfaces/EvmStateManagerInterface.md).[`getContractCodeSize`](../../common/interfaces/EvmStateManagerInterface.md#getcontractcodesize) + +#### Defined in + +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:120 *** @@ -382,7 +428,7 @@ node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/di #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:59 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:121 *** @@ -406,7 +452,7 @@ node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/di #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:80 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:143 *** @@ -424,7 +470,7 @@ node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/di #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:65 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:127 *** @@ -446,7 +492,7 @@ node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/di #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:68 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:130 *** @@ -470,7 +516,7 @@ node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/di #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:56 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:117 *** @@ -494,7 +540,7 @@ node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/di #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:54 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:115 *** @@ -518,7 +564,7 @@ node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/di #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:57 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:118 *** @@ -544,7 +590,7 @@ node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/di #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:60 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:122 *** @@ -562,7 +608,7 @@ node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/di #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:64 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:126 *** @@ -611,7 +657,7 @@ packages/state/dist/index.d.ts:150 #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:66 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:128 *** @@ -633,4 +679,4 @@ node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/di #### Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:81 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:144 diff --git a/tevm/docs/tx/classes/AccessListEIP2930Transaction.md b/tevm/docs/tx/classes/AccessListEIP2930Transaction.md index f762daf424..dc31f26525 100644 --- a/tevm/docs/tx/classes/AccessListEIP2930Transaction.md +++ b/tevm/docs/tx/classes/AccessListEIP2930Transaction.md @@ -43,7 +43,7 @@ varying data types. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:51 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:51 ## Properties @@ -53,7 +53,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:16 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:16 *** @@ -67,7 +67,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:14 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:14 *** @@ -77,7 +77,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:15 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:15 *** @@ -95,7 +95,7 @@ for FeeMarketEIP1559Transaction objects #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:31 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:31 *** @@ -109,7 +109,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:24 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:24 *** @@ -119,7 +119,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:14 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:14 *** @@ -133,7 +133,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:18 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:18 *** @@ -147,7 +147,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:19 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:19 *** @@ -161,7 +161,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:16 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:16 *** @@ -171,7 +171,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:17 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:17 *** @@ -185,7 +185,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:15 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:15 *** @@ -199,7 +199,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:21 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:21 *** @@ -213,7 +213,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:22 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:22 *** @@ -227,7 +227,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:17 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:17 *** @@ -241,7 +241,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:25 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:25 *** @@ -255,7 +255,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:20 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:20 *** @@ -269,7 +269,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:18 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:18 ## Accessors @@ -291,7 +291,7 @@ Note: legacy txs will return tx type `0`. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:47 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:47 ## Methods @@ -312,7 +312,7 @@ tx type implementations. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:189 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:189 *** @@ -346,7 +346,7 @@ Pass true if the number also cannot equal one less the maximum value #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:168 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:168 *** @@ -386,7 +386,7 @@ Set this to `true` if the raw output of `ecsign` is used. If this is `false` (de #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:121 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:121 *** @@ -406,7 +406,7 @@ Return a compact error string representation of the object #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:129 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:129 *** @@ -426,7 +426,7 @@ The minimum amount of gas the tx must have (DataFee + TxFee + Creation Fee) #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:78 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:78 *** @@ -446,7 +446,7 @@ The amount of gas paid for the data in this tx #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:56 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:56 *** @@ -473,7 +473,7 @@ Optional baseFee of the block. Note for EIP1559 and EIP4844 this is required. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:52 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:52 *** @@ -497,7 +497,7 @@ serialized and doesn't need to be RLP encoded any more. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:105 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:105 *** @@ -525,7 +525,7 @@ const serializedMessage = tx.getMessageToSign() // use this for the HW wallet in #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:97 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:97 *** @@ -545,7 +545,7 @@ Computes a sha3-256 hash which can be used to verify the signature #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:116 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:116 *** @@ -565,7 +565,7 @@ Returns the sender's address #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:124 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:124 *** @@ -585,7 +585,7 @@ Returns the public key of the sender #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:120 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:120 *** @@ -605,7 +605,7 @@ The up front amount that an account must have for this transaction to be valid #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:60 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:60 *** @@ -627,7 +627,7 @@ an array of error strings #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:69 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:69 *** @@ -650,7 +650,7 @@ Use [AccessListEIP2930Transaction.getMessageToSign](AccessListEIP2930Transaction #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:112 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:112 *** @@ -668,7 +668,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:116 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:116 *** @@ -690,7 +690,7 @@ true if the transaction is valid, false otherwise #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:74 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:74 *** @@ -698,7 +698,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b > **raw**(): `AccessListEIP2930TxValuesArray` -Returns a Uint8Array Array of the raw Bytess of the EIP-2930 transaction, in order. +Returns a Uint8Array Array of the raw Bytes of the EIP-2930 transaction, in order. Format: `[chainId, nonce, gasPrice, gasLimit, to, value, data, accessList, signatureYParity (v), signatureR (r), signatureS (s)]` @@ -720,7 +720,7 @@ representation for external signing use [AccessListEIP2930Transaction.getMessage #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:74 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:74 *** @@ -747,7 +747,7 @@ the RLP encoding of the values. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:85 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:85 *** @@ -777,7 +777,7 @@ const signedTx = tx.sign(privateKey) #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:138 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:138 *** @@ -814,7 +814,7 @@ on all supported capabilities. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:64 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:64 *** @@ -834,7 +834,7 @@ If the tx's `to` is to the creation address #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:96 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:96 *** @@ -854,7 +854,7 @@ Returns an object with the JSON representation of the transaction #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:125 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:125 *** @@ -874,7 +874,7 @@ Determines if the signature is valid #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:120 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:120 *** @@ -896,7 +896,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:171 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:171 *** @@ -921,7 +921,7 @@ signatureYParity (v), signatureR (r), signatureS (s)])` #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:36 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:36 *** @@ -950,7 +950,7 @@ Notes: #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:29 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:29 *** @@ -975,4 +975,4 @@ signatureYParity (v), signatureR (r), signatureS (s)]` #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:43 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip2930Transaction.d.ts:43 diff --git a/tevm/docs/tx/classes/BlobEIP4844Transaction.md b/tevm/docs/tx/classes/BlobEIP4844Transaction.md index e769b6a06d..8029960c0b 100644 --- a/tevm/docs/tx/classes/BlobEIP4844Transaction.md +++ b/tevm/docs/tx/classes/BlobEIP4844Transaction.md @@ -43,7 +43,7 @@ varying data types. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:32 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:32 ## Properties @@ -53,7 +53,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:16 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:16 *** @@ -67,7 +67,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:14 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:14 *** @@ -77,7 +77,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:15 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:15 *** @@ -95,7 +95,7 @@ for FeeMarketEIP1559Transaction objects #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:31 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:31 *** @@ -105,7 +105,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:21 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:21 *** @@ -115,7 +115,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:22 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:22 *** @@ -129,7 +129,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:24 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:24 *** @@ -139,7 +139,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:14 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:14 *** @@ -153,7 +153,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:20 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:20 *** @@ -167,7 +167,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:19 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:19 *** @@ -181,7 +181,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:16 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:16 *** @@ -191,7 +191,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:23 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:23 *** @@ -201,7 +201,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:24 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:24 *** @@ -211,7 +211,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:19 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:19 *** @@ -221,7 +221,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:18 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:18 *** @@ -231,7 +231,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:17 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:17 *** @@ -245,7 +245,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:15 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:15 *** @@ -259,7 +259,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:21 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:21 *** @@ -273,7 +273,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:22 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:22 *** @@ -287,7 +287,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:17 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:17 *** @@ -301,7 +301,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:25 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:25 *** @@ -315,7 +315,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:20 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:20 *** @@ -329,7 +329,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:18 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:18 ## Accessors @@ -351,7 +351,7 @@ Note: legacy txs will return tx type `0`. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:47 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:47 ## Methods @@ -372,7 +372,7 @@ tx type implementations. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:189 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:189 *** @@ -406,7 +406,7 @@ Pass true if the number also cannot equal one less the maximum value #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:168 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:168 *** @@ -446,7 +446,7 @@ Set this to `true` if the raw output of `ecsign` is used. If this is `false` (de #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:139 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:147 *** @@ -466,7 +466,7 @@ Return a compact error string representation of the object #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:143 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:151 *** @@ -486,7 +486,7 @@ The minimum amount of gas the tx must have (DataFee + TxFee + Creation Fee) #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:78 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:78 *** @@ -506,7 +506,7 @@ The amount of gas paid for the data in this tx #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:71 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:71 *** @@ -532,7 +532,7 @@ Base fee retrieved from block #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:38 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:38 *** @@ -556,7 +556,7 @@ serialized and doesn't need to be RLP encoded any more. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:125 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:125 *** @@ -584,7 +584,7 @@ const serializedMessage = tx.getMessageToSign() // use this for the HW wallet in #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:117 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:117 *** @@ -602,7 +602,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:133 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:133 *** @@ -622,7 +622,7 @@ Returns the sender's address #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:124 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:124 *** @@ -642,7 +642,7 @@ Returns the public key of the sender #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:137 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:137 *** @@ -668,7 +668,7 @@ The base fee of the block (will be set to 0 if not provided) #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:76 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:76 *** @@ -690,7 +690,7 @@ an array of error strings #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:69 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:69 *** @@ -713,7 +713,7 @@ Use [BlobEIP4844Transaction.getMessageToSign](BlobEIP4844Transaction.md#getmessa #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:132 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:132 *** @@ -731,7 +731,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:116 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:116 *** @@ -753,7 +753,7 @@ true if the transaction is valid, false otherwise #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:74 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:74 *** @@ -769,7 +769,7 @@ the number of blobs included with this transaction #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:154 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:162 *** @@ -799,7 +799,7 @@ representation for external signing use [BlobEIP4844Transaction.getMessageToSign #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:90 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:90 *** @@ -826,7 +826,7 @@ the RLP encoding of the values. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:101 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:101 *** @@ -842,7 +842,7 @@ the serialized form of a blob transaction in the network wrapper format (used fo #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:105 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:105 *** @@ -872,7 +872,7 @@ const signedTx = tx.sign(privateKey) #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:138 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:138 *** @@ -909,7 +909,7 @@ on all supported capabilities. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:64 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:64 *** @@ -929,7 +929,7 @@ If the tx's `to` is to the creation address #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:96 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:96 *** @@ -949,7 +949,7 @@ Returns an object with the JSON representation of the transaction #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:138 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:146 *** @@ -969,7 +969,7 @@ Determines if the signature is valid #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:120 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:120 *** @@ -991,7 +991,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:171 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:171 *** @@ -1019,7 +1019,7 @@ a BlobEIP4844Transaction #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:67 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:67 *** @@ -1044,7 +1044,7 @@ access_list, max_fee_per_data_gas, blob_versioned_hashes, y_parity, r, s])` #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:53 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:53 *** @@ -1064,7 +1064,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:33 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:33 *** @@ -1089,7 +1089,7 @@ accessList, signatureYParity, signatureR, signatureS]` #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:60 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:60 *** @@ -1118,4 +1118,33 @@ the "minimal" representation of a BlobEIP4844Transaction (i.e. transaction objec #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:46 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:46 + +*** + +### networkWrapperToJson() + +> `static` **networkWrapperToJson**(`serialized`, `opts`?): `JsonBlobTxNetworkWrapper` + +Returns the EIP 4844 transaction network wrapper in JSON format similar to toJSON, including +blobs, commitments, and proofs fields + +#### Parameters + +• **serialized**: `Uint8Array` + +a buffer representing a serialized BlobTransactionNetworkWrapper + +• **opts?**: [`TxOptions`](../interfaces/TxOptions.md) + +any TxOptions defined + +#### Returns + +`JsonBlobTxNetworkWrapper` + +JsonBlobTxNetworkWrapper with blobs, KZG commitments, and KZG proofs fields + +#### Defined in + +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip4844Transaction.d.ts:145 diff --git a/tevm/docs/tx/classes/FeeMarketEIP1559Transaction.md b/tevm/docs/tx/classes/FeeMarketEIP1559Transaction.md index dc2ebe6209..31febe300a 100644 --- a/tevm/docs/tx/classes/FeeMarketEIP1559Transaction.md +++ b/tevm/docs/tx/classes/FeeMarketEIP1559Transaction.md @@ -47,7 +47,7 @@ varying data types. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:52 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:52 ## Properties @@ -57,7 +57,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:16 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:16 *** @@ -71,7 +71,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:14 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:14 *** @@ -81,7 +81,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:15 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:15 *** @@ -99,7 +99,7 @@ for FeeMarketEIP1559Transaction objects #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:31 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:31 *** @@ -113,7 +113,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:24 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:24 *** @@ -123,7 +123,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:14 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:14 *** @@ -137,7 +137,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:19 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:19 *** @@ -151,7 +151,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:19 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:19 *** @@ -165,7 +165,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:16 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:16 *** @@ -175,7 +175,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:18 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:18 *** @@ -185,7 +185,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:17 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:17 *** @@ -199,7 +199,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:15 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:15 *** @@ -213,7 +213,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:21 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:21 *** @@ -227,7 +227,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:22 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:22 *** @@ -241,7 +241,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:17 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:17 *** @@ -255,7 +255,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:25 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:25 *** @@ -269,7 +269,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:20 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:20 *** @@ -283,7 +283,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:18 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:18 ## Accessors @@ -305,7 +305,7 @@ Note: legacy txs will return tx type `0`. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:47 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:47 ## Methods @@ -326,7 +326,7 @@ tx type implementations. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:189 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:189 *** @@ -360,7 +360,7 @@ Pass true if the number also cannot equal one less the maximum value #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:168 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:168 *** @@ -400,7 +400,7 @@ Set this to `true` if the raw output of `ecsign` is used. If this is `false` (de #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:127 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:127 *** @@ -420,7 +420,7 @@ Return a compact error string representation of the object #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:135 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:135 *** @@ -440,7 +440,7 @@ The minimum amount of gas the tx must have (DataFee + TxFee + Creation Fee) #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:78 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:78 *** @@ -460,7 +460,7 @@ The amount of gas paid for the data in this tx #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:56 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:56 *** @@ -486,7 +486,7 @@ Base fee retrieved from block #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:61 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:61 *** @@ -510,7 +510,7 @@ serialized and doesn't need to be RLP encoded any more. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:111 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:111 *** @@ -538,7 +538,7 @@ const serializedMessage = tx.getMessageToSign() // use this for the HW wallet in #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:103 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:103 *** @@ -558,7 +558,7 @@ Computes a sha3-256 hash which can be used to verify the signature #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:122 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:122 *** @@ -578,7 +578,7 @@ Returns the sender's address #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:124 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:124 *** @@ -598,7 +598,7 @@ Returns the public key of the sender #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:126 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:126 *** @@ -624,7 +624,7 @@ The base fee of the block (will be set to 0 if not provided) #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:66 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:66 *** @@ -646,7 +646,7 @@ an array of error strings #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:69 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:69 *** @@ -669,7 +669,7 @@ Use [FeeMarketEIP1559Transaction.getMessageToSign](FeeMarketEIP1559Transaction.m #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:118 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:118 *** @@ -687,7 +687,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:116 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:116 *** @@ -709,7 +709,7 @@ true if the transaction is valid, false otherwise #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:74 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:74 *** @@ -739,7 +739,7 @@ representation for external signing use [FeeMarketEIP1559Transaction.getMessageT #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:80 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:80 *** @@ -766,7 +766,7 @@ the RLP encoding of the values. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:91 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:91 *** @@ -796,7 +796,7 @@ const signedTx = tx.sign(privateKey) #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:138 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:138 *** @@ -833,7 +833,7 @@ on all supported capabilities. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:64 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:64 *** @@ -853,7 +853,7 @@ If the tx's `to` is to the creation address #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:96 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:96 *** @@ -873,7 +873,7 @@ Returns an object with the JSON representation of the transaction #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:131 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:131 *** @@ -893,7 +893,7 @@ Determines if the signature is valid #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:120 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:120 *** @@ -915,7 +915,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:171 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:171 *** @@ -940,7 +940,7 @@ accessList, signatureYParity, signatureR, signatureS])` #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:37 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:37 *** @@ -969,7 +969,7 @@ Notes: #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:30 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:30 *** @@ -994,4 +994,4 @@ accessList, signatureYParity, signatureR, signatureS]` #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:44 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:44 diff --git a/tevm/docs/tx/classes/LegacyTransaction.md b/tevm/docs/tx/classes/LegacyTransaction.md index e17b365f12..6cf9c0183f 100644 --- a/tevm/docs/tx/classes/LegacyTransaction.md +++ b/tevm/docs/tx/classes/LegacyTransaction.md @@ -40,7 +40,7 @@ varying data types. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:42 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:42 ## Properties @@ -54,7 +54,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/l #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:14 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:14 *** @@ -72,7 +72,7 @@ for FeeMarketEIP1559Transaction objects #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:31 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:31 *** @@ -86,7 +86,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:24 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:24 *** @@ -100,7 +100,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:12 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:12 *** @@ -114,7 +114,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/l #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:19 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:19 *** @@ -128,7 +128,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:16 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:16 *** @@ -138,7 +138,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:11 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:11 *** @@ -152,7 +152,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/l #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:15 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:15 *** @@ -166,7 +166,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:21 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:21 *** @@ -180,7 +180,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:22 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:22 *** @@ -194,7 +194,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:17 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:17 *** @@ -208,7 +208,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:25 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:25 *** @@ -222,7 +222,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:20 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:20 *** @@ -236,7 +236,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:18 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:18 ## Accessors @@ -258,7 +258,7 @@ Note: legacy txs will return tx type `0`. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:47 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:47 ## Methods @@ -279,7 +279,7 @@ tx type implementations. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:189 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:189 *** @@ -313,7 +313,7 @@ Pass true if the number also cannot equal one less the maximum value #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:168 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:168 *** @@ -335,7 +335,7 @@ Validates tx's `v` value #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:118 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:118 *** @@ -375,7 +375,7 @@ Set this to `true` if the raw output of `ecsign` is used. If this is `false` (de #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:110 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:110 *** @@ -395,7 +395,7 @@ Return a compact error string representation of the object #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:122 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:122 *** @@ -415,7 +415,7 @@ The minimum amount of gas the tx must have (DataFee + TxFee + Creation Fee) #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:78 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:78 *** @@ -435,7 +435,7 @@ The amount of gas paid for the data in this tx #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:90 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:90 *** @@ -462,7 +462,7 @@ Optional baseFee of the block. Note for EIP1559 and EIP4844 this is required. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:43 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:43 *** @@ -483,7 +483,7 @@ to sign the transaction (e.g. for sending to a hardware wallet). #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:86 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:86 *** @@ -513,7 +513,7 @@ const serializedMessage = RLP.encode(message)) // use this for the HW wallet inp #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:81 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:81 *** @@ -533,7 +533,7 @@ Computes a sha3-256 hash which can be used to verify the signature #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:105 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:105 *** @@ -553,7 +553,7 @@ Returns the sender's address #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:124 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:124 *** @@ -573,7 +573,7 @@ Returns the public key of the sender #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:109 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:109 *** @@ -593,7 +593,7 @@ The up front amount that an account must have for this transaction to be valid #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:94 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:94 *** @@ -615,7 +615,7 @@ an array of error strings #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:69 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:69 *** @@ -638,7 +638,7 @@ Use Transaction.getMessageToSign to get a tx hash for the purpose of signing. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:101 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:101 *** @@ -656,7 +656,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/l #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:116 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:116 *** @@ -678,7 +678,7 @@ true if the transaction is valid, false otherwise #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:74 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:74 *** @@ -708,7 +708,7 @@ representation have a look at Transaction.getMessageToSign. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:57 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:57 *** @@ -734,7 +734,7 @@ representation for external signing use Transaction.getMessageToSign. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:67 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:67 *** @@ -764,7 +764,7 @@ const signedTx = tx.sign(privateKey) #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:138 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:138 *** @@ -801,7 +801,7 @@ on all supported capabilities. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:64 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:64 *** @@ -821,7 +821,7 @@ If the tx's `to` is to the creation address #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:96 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:96 *** @@ -841,7 +841,7 @@ Returns an object with the JSON representation of the transaction. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:114 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:114 *** @@ -861,7 +861,7 @@ Determines if the signature is valid #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:120 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:120 *** @@ -883,7 +883,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:171 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:171 *** @@ -907,7 +907,7 @@ Format: `rlp([nonce, gasPrice, gasLimit, to, value, data, v, r, s])` #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:28 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:28 *** @@ -934,7 +934,7 @@ Notes: #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:22 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:22 *** @@ -958,4 +958,4 @@ Format: `[nonce, gasPrice, gasLimit, to, value, data, v, r, s]` #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:34 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/legacyTransaction.d.ts:34 diff --git a/tevm/docs/tx/classes/TransactionFactory.md b/tevm/docs/tx/classes/TransactionFactory.md index 61a7d53aa8..07ec0820ec 100644 --- a/tevm/docs/tx/classes/TransactionFactory.md +++ b/tevm/docs/tx/classes/TransactionFactory.md @@ -10,7 +10,7 @@ ### fromBlockBodyData() -> `static` **fromBlockBodyData**(`data`, `txOptions`?): [`LegacyTransaction`](LegacyTransaction.md) \| [`AccessListEIP2930Transaction`](AccessListEIP2930Transaction.md) \| [`FeeMarketEIP1559Transaction`](FeeMarketEIP1559Transaction.md) \| [`BlobEIP4844Transaction`](BlobEIP4844Transaction.md) +> `static` **fromBlockBodyData**(`data`, `txOptions`?): [`LegacyTransaction`](LegacyTransaction.md) \| [`AccessListEIP2930Transaction`](AccessListEIP2930Transaction.md) \| [`FeeMarketEIP1559Transaction`](FeeMarketEIP1559Transaction.md) \| [`BlobEIP4844Transaction`](BlobEIP4844Transaction.md) \| `EOACodeEIP7702Transaction` When decoding a BlockBody, in the transactions field, a field is either: A Uint8Array (a TypedTransaction - encoded as TransactionType || rlp(TransactionPayload)) @@ -29,17 +29,17 @@ The transaction options #### Returns -[`LegacyTransaction`](LegacyTransaction.md) \| [`AccessListEIP2930Transaction`](AccessListEIP2930Transaction.md) \| [`FeeMarketEIP1559Transaction`](FeeMarketEIP1559Transaction.md) \| [`BlobEIP4844Transaction`](BlobEIP4844Transaction.md) +[`LegacyTransaction`](LegacyTransaction.md) \| [`AccessListEIP2930Transaction`](AccessListEIP2930Transaction.md) \| [`FeeMarketEIP1559Transaction`](FeeMarketEIP1559Transaction.md) \| [`BlobEIP4844Transaction`](BlobEIP4844Transaction.md) \| `EOACodeEIP7702Transaction` #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/transactionFactory.d.ts:33 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/transactionFactory.d.ts:34 *** ### fromJsonRpcProvider() -> `static` **fromJsonRpcProvider**(`provider`, `txHash`, `txOptions`?): `Promise`\<[`LegacyTransaction`](LegacyTransaction.md) \| [`AccessListEIP2930Transaction`](AccessListEIP2930Transaction.md) \| [`FeeMarketEIP1559Transaction`](FeeMarketEIP1559Transaction.md) \| [`BlobEIP4844Transaction`](BlobEIP4844Transaction.md)\> +> `static` **fromJsonRpcProvider**(`provider`, `txHash`, `txOptions`?): `Promise`\<[`LegacyTransaction`](LegacyTransaction.md) \| [`AccessListEIP2930Transaction`](AccessListEIP2930Transaction.md) \| [`FeeMarketEIP1559Transaction`](FeeMarketEIP1559Transaction.md) \| [`BlobEIP4844Transaction`](BlobEIP4844Transaction.md) \| `EOACodeEIP7702Transaction`\> Method to retrieve a transaction from the provider @@ -59,13 +59,13 @@ The transaction options #### Returns -`Promise`\<[`LegacyTransaction`](LegacyTransaction.md) \| [`AccessListEIP2930Transaction`](AccessListEIP2930Transaction.md) \| [`FeeMarketEIP1559Transaction`](FeeMarketEIP1559Transaction.md) \| [`BlobEIP4844Transaction`](BlobEIP4844Transaction.md)\> +`Promise`\<[`LegacyTransaction`](LegacyTransaction.md) \| [`AccessListEIP2930Transaction`](AccessListEIP2930Transaction.md) \| [`FeeMarketEIP1559Transaction`](FeeMarketEIP1559Transaction.md) \| [`BlobEIP4844Transaction`](BlobEIP4844Transaction.md) \| `EOACodeEIP7702Transaction`\> the transaction specified by `txHash` #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/transactionFactory.d.ts:41 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/transactionFactory.d.ts:42 *** @@ -96,7 +96,7 @@ The transaction options #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/transactionFactory.d.ts:49 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/transactionFactory.d.ts:50 *** @@ -126,7 +126,7 @@ The transaction options #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/transactionFactory.d.ts:23 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/transactionFactory.d.ts:24 *** @@ -156,4 +156,4 @@ Options to pass on to the constructor of the transaction #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/transactionFactory.d.ts:16 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/transactionFactory.d.ts:17 diff --git a/tevm/docs/tx/enumerations/Capability.md b/tevm/docs/tx/enumerations/Capability.md index cfcc01f114..91dfdc1c46 100644 --- a/tevm/docs/tx/enumerations/Capability.md +++ b/tevm/docs/tx/enumerations/Capability.md @@ -20,7 +20,7 @@ See: [1559](https://eips.ethereum.org/EIPS/eip-1559) Fee Market EIP #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:22 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:23 *** @@ -33,7 +33,7 @@ See: [155](https://eips.ethereum.org/EIPS/eip-155) Replay Attack Protection EIP #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:17 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:18 *** @@ -46,7 +46,7 @@ See: [2718](https://eips.ethereum.org/EIPS/eip-2718) Transaction Type EIP #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:27 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:28 *** @@ -59,4 +59,17 @@ See: [2930](https://eips.ethereum.org/EIPS/eip-2930) Access Lists EIP #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:32 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:33 + +*** + +### EIP7702EOACode + +> **EIP7702EOACode**: `7702` + +Tx supports setting EOA code +See [EIP-7702](https://eips.ethereum.org/EIPS/eip-7702) + +#### Defined in + +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:38 diff --git a/tevm/docs/tx/enumerations/TransactionType.md b/tevm/docs/tx/enumerations/TransactionType.md index d53354d914..9dfc499548 100644 --- a/tevm/docs/tx/enumerations/TransactionType.md +++ b/tevm/docs/tx/enumerations/TransactionType.md @@ -16,7 +16,7 @@ Encompassing type for all transaction types. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:82 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:90 *** @@ -26,7 +26,17 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:84 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:92 + +*** + +### EOACodeEIP7702 + +> **EOACodeEIP7702**: `4` + +#### Defined in + +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:93 *** @@ -36,7 +46,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:83 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:91 *** @@ -46,4 +56,4 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:81 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:89 diff --git a/tevm/docs/tx/functions/isAccessListEIP2930Tx.md b/tevm/docs/tx/functions/isAccessListEIP2930Tx.md index 2093b5c5a9..a7f1aa8b71 100644 --- a/tevm/docs/tx/functions/isAccessListEIP2930Tx.md +++ b/tevm/docs/tx/functions/isAccessListEIP2930Tx.md @@ -18,4 +18,4 @@ ## Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:94 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:104 diff --git a/tevm/docs/tx/functions/isBlobEIP4844Tx.md b/tevm/docs/tx/functions/isBlobEIP4844Tx.md index 2b76f2cd83..d138207c46 100644 --- a/tevm/docs/tx/functions/isBlobEIP4844Tx.md +++ b/tevm/docs/tx/functions/isBlobEIP4844Tx.md @@ -18,4 +18,4 @@ ## Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:96 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:106 diff --git a/tevm/docs/tx/functions/isFeeMarketEIP1559Tx.md b/tevm/docs/tx/functions/isFeeMarketEIP1559Tx.md index d6f72ff2ff..9602cca2e2 100644 --- a/tevm/docs/tx/functions/isFeeMarketEIP1559Tx.md +++ b/tevm/docs/tx/functions/isFeeMarketEIP1559Tx.md @@ -18,4 +18,4 @@ ## Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:95 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:105 diff --git a/tevm/docs/tx/functions/isLegacyTx.md b/tevm/docs/tx/functions/isLegacyTx.md index b583ad700b..df714d752d 100644 --- a/tevm/docs/tx/functions/isLegacyTx.md +++ b/tevm/docs/tx/functions/isLegacyTx.md @@ -18,4 +18,4 @@ ## Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:93 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:103 diff --git a/tevm/docs/tx/interfaces/EIP1559CompatibleTx.md b/tevm/docs/tx/interfaces/EIP1559CompatibleTx.md index 5e14b5a716..a9652024ed 100644 --- a/tevm/docs/tx/interfaces/EIP1559CompatibleTx.md +++ b/tevm/docs/tx/interfaces/EIP1559CompatibleTx.md @@ -30,7 +30,7 @@ #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:138 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:149 *** @@ -44,7 +44,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:137 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:148 *** @@ -58,7 +58,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:107 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:118 *** @@ -72,7 +72,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:133 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:144 *** @@ -86,7 +86,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:98 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:109 *** @@ -100,7 +100,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:103 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:114 *** @@ -114,7 +114,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:100 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:111 *** @@ -124,7 +124,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:142 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:153 *** @@ -134,7 +134,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:141 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:152 *** @@ -148,7 +148,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:99 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:110 *** @@ -162,7 +162,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:105 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:116 *** @@ -176,7 +176,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:106 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:117 *** @@ -190,7 +190,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:101 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:112 *** @@ -204,7 +204,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:109 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:120 *** @@ -218,7 +218,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:104 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:115 *** @@ -232,7 +232,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:102 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:113 ## Methods @@ -250,7 +250,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:128 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:139 *** @@ -268,7 +268,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:110 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:121 *** @@ -286,7 +286,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:111 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:122 *** @@ -304,7 +304,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:117 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:128 *** @@ -322,7 +322,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:134 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:145 *** @@ -340,7 +340,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:119 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:130 *** @@ -358,7 +358,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:124 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:135 *** @@ -376,7 +376,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:125 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:136 *** @@ -394,7 +394,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:112 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:123 *** @@ -412,7 +412,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:120 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:131 *** @@ -430,7 +430,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:118 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:129 *** @@ -448,7 +448,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:121 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:132 *** @@ -466,7 +466,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:122 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:133 *** @@ -484,7 +484,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:114 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:125 *** @@ -502,7 +502,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:115 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:126 *** @@ -524,7 +524,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:126 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:137 *** @@ -546,7 +546,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:108 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:119 *** @@ -564,7 +564,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:113 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:124 *** @@ -582,7 +582,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:127 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:138 *** @@ -600,4 +600,4 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:123 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:134 diff --git a/tevm/docs/tx/interfaces/EIP4844CompatibleTx.md b/tevm/docs/tx/interfaces/EIP4844CompatibleTx.md index bf08cab865..dbb59d51fe 100644 --- a/tevm/docs/tx/interfaces/EIP4844CompatibleTx.md +++ b/tevm/docs/tx/interfaces/EIP4844CompatibleTx.md @@ -26,7 +26,7 @@ #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:138 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:149 *** @@ -40,7 +40,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:137 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:148 *** @@ -50,7 +50,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:146 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:157 *** @@ -60,7 +60,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:147 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:158 *** @@ -74,7 +74,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:107 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:118 *** @@ -88,7 +88,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:133 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:144 *** @@ -102,7 +102,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:98 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:109 *** @@ -116,7 +116,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:103 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:114 *** @@ -130,7 +130,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:100 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:111 *** @@ -140,7 +140,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:148 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:159 *** @@ -150,7 +150,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:149 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:160 *** @@ -160,7 +160,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:145 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:156 *** @@ -174,7 +174,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:142 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:153 *** @@ -188,7 +188,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:141 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:152 *** @@ -202,7 +202,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:99 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:110 *** @@ -216,7 +216,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:105 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:116 *** @@ -230,7 +230,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:106 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:117 *** @@ -244,7 +244,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:101 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:112 *** @@ -258,7 +258,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:109 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:120 *** @@ -272,7 +272,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:104 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:115 *** @@ -286,7 +286,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:102 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:113 ## Methods @@ -304,7 +304,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:128 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:139 *** @@ -322,7 +322,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:110 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:121 *** @@ -340,7 +340,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:111 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:122 *** @@ -358,7 +358,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:117 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:128 *** @@ -376,7 +376,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:134 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:145 *** @@ -394,7 +394,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:119 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:130 *** @@ -412,7 +412,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:124 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:135 *** @@ -430,7 +430,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:125 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:136 *** @@ -448,7 +448,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:112 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:123 *** @@ -466,7 +466,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:120 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:131 *** @@ -484,7 +484,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:118 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:129 *** @@ -502,7 +502,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:121 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:132 *** @@ -520,7 +520,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:122 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:133 *** @@ -534,7 +534,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:151 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:162 *** @@ -552,7 +552,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:114 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:125 *** @@ -570,7 +570,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:115 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:126 *** @@ -584,7 +584,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:150 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:161 *** @@ -606,7 +606,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:126 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:137 *** @@ -628,7 +628,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:108 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:119 *** @@ -646,7 +646,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:113 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:124 *** @@ -664,7 +664,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:127 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:138 *** @@ -682,4 +682,4 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:123 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:134 diff --git a/tevm/docs/tx/interfaces/ImpersonatedTx.md b/tevm/docs/tx/interfaces/ImpersonatedTx.md index 899a73cd78..cd2dee4cbf 100644 --- a/tevm/docs/tx/interfaces/ImpersonatedTx.md +++ b/tevm/docs/tx/interfaces/ImpersonatedTx.md @@ -27,7 +27,7 @@ Typed transaction with a new gas fee market mechanism #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:16 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:16 *** @@ -41,7 +41,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:14 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:14 *** @@ -55,7 +55,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:15 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:15 *** @@ -73,7 +73,7 @@ for FeeMarketEIP1559Transaction objects #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:31 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:31 *** @@ -87,7 +87,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:24 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:24 *** @@ -101,7 +101,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:14 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:14 *** @@ -115,7 +115,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:19 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:19 *** @@ -129,7 +129,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:19 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:19 *** @@ -143,7 +143,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:16 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:16 *** @@ -167,7 +167,7 @@ packages/tx/types/ImpersonatedTx.d.ts:3 #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:18 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:18 *** @@ -181,7 +181,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:17 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:17 *** @@ -195,7 +195,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:15 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:15 *** @@ -209,7 +209,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:21 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:21 *** @@ -223,7 +223,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:22 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:22 *** @@ -237,7 +237,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:17 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:17 *** @@ -251,7 +251,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:25 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:25 *** @@ -265,7 +265,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:20 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:20 *** @@ -279,7 +279,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/b #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:18 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:18 ## Accessors @@ -301,7 +301,7 @@ Note: legacy txs will return tx type `0`. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:47 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:47 ## Methods @@ -322,7 +322,7 @@ tx type implementations. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:189 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:189 *** @@ -356,7 +356,7 @@ Pass true if the number also cannot equal one less the maximum value #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:168 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:168 *** @@ -396,7 +396,7 @@ Set this to `true` if the raw output of `ecsign` is used. If this is `false` (de #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:127 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:127 *** @@ -416,7 +416,7 @@ Return a compact error string representation of the object #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:135 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:135 *** @@ -436,7 +436,7 @@ The minimum amount of gas the tx must have (DataFee + TxFee + Creation Fee) #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:78 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:78 *** @@ -456,7 +456,7 @@ The amount of gas paid for the data in this tx #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:56 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:56 *** @@ -482,7 +482,7 @@ Base fee retrieved from block #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:61 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:61 *** @@ -506,7 +506,7 @@ serialized and doesn't need to be RLP encoded any more. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:111 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:111 *** @@ -534,7 +534,7 @@ const serializedMessage = tx.getMessageToSign() // use this for the HW wallet in #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:103 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:103 *** @@ -554,7 +554,7 @@ Computes a sha3-256 hash which can be used to verify the signature #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:122 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:122 *** @@ -574,7 +574,7 @@ Returns the sender's address #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:124 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:124 *** @@ -594,7 +594,7 @@ Returns the public key of the sender #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:126 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:126 *** @@ -620,7 +620,7 @@ The base fee of the block (will be set to 0 if not provided) #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:66 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:66 *** @@ -642,7 +642,7 @@ an array of error strings #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:69 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:69 *** @@ -665,7 +665,7 @@ Use [FeeMarketEIP1559Transaction.getMessageToSign](../classes/FeeMarketEIP1559Tr #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:118 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:118 *** @@ -683,7 +683,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/e #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:116 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:116 *** @@ -705,7 +705,7 @@ true if the transaction is valid, false otherwise #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:74 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:74 *** @@ -735,7 +735,7 @@ representation for external signing use [FeeMarketEIP1559Transaction.getMessageT #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:80 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:80 *** @@ -762,7 +762,7 @@ the RLP encoding of the values. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:91 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:91 *** @@ -792,7 +792,7 @@ const signedTx = tx.sign(privateKey) #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:138 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:138 *** @@ -829,7 +829,7 @@ on all supported capabilities. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:64 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:64 *** @@ -849,7 +849,7 @@ If the tx's `to` is to the creation address #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:96 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:96 *** @@ -869,7 +869,7 @@ Returns an object with the JSON representation of the transaction #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:131 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/eip1559Transaction.d.ts:131 *** @@ -889,4 +889,4 @@ Determines if the signature is valid #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:120 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/baseTransaction.d.ts:120 diff --git a/tevm/docs/tx/interfaces/JsonRpcTx.md b/tevm/docs/tx/interfaces/JsonRpcTx.md index 4dffe52ffe..47ff42202c 100644 --- a/tevm/docs/tx/interfaces/JsonRpcTx.md +++ b/tevm/docs/tx/interfaces/JsonRpcTx.md @@ -14,7 +14,7 @@ #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:376 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:423 *** @@ -24,7 +24,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:388 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:435 *** @@ -34,7 +34,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:368 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:415 *** @@ -44,7 +44,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:369 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:416 *** @@ -54,7 +54,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:377 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:424 *** @@ -64,7 +64,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:370 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:417 *** @@ -74,7 +74,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:371 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:418 *** @@ -84,7 +84,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:372 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:419 *** @@ -94,7 +94,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:378 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:425 *** @@ -104,7 +104,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:379 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:426 *** @@ -114,7 +114,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:387 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:434 *** @@ -124,7 +124,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:373 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:420 *** @@ -134,7 +134,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:374 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:421 *** @@ -144,7 +144,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:380 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:427 *** @@ -154,7 +154,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:385 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:432 *** @@ -164,7 +164,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:386 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:433 *** @@ -174,7 +174,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:381 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:428 *** @@ -184,7 +184,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:382 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:429 *** @@ -194,7 +194,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:375 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:422 *** @@ -204,7 +204,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:384 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:431 *** @@ -214,4 +214,4 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:383 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:430 diff --git a/tevm/docs/tx/interfaces/JsonTx.md b/tevm/docs/tx/interfaces/JsonTx.md index ec39003607..d8849f8fd2 100644 --- a/tevm/docs/tx/interfaces/JsonTx.md +++ b/tevm/docs/tx/interfaces/JsonTx.md @@ -21,154 +21,164 @@ and not all the values are present on all tx types #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:360 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:401 + +*** + +### authorizationList? + +> `optional` **authorizationList**: `AuthorizationList` + +#### Defined in + +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:402 *** ### blobVersionedHashes? -> `optional` **blobVersionedHashes**: `string`[] +> `optional` **blobVersionedHashes**: \`0x$\{string\}\`[] #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:365 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:407 *** ### chainId? -> `optional` **chainId**: `string` +> `optional` **chainId**: \`0x$\{string\}\` #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:359 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:400 *** ### data? -> `optional` **data**: `string` +> `optional` **data**: \`0x$\{string\}\` #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:354 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:395 *** ### gasLimit? -> `optional` **gasLimit**: `string` +> `optional` **gasLimit**: \`0x$\{string\}\` #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:352 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:393 *** ### gasPrice? -> `optional` **gasPrice**: `string` +> `optional` **gasPrice**: \`0x$\{string\}\` #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:351 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:392 *** ### maxFeePerBlobGas? -> `optional` **maxFeePerBlobGas**: `string` +> `optional` **maxFeePerBlobGas**: \`0x$\{string\}\` #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:364 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:406 *** ### maxFeePerGas? -> `optional` **maxFeePerGas**: `string` +> `optional` **maxFeePerGas**: \`0x$\{string\}\` #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:363 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:405 *** ### maxPriorityFeePerGas? -> `optional` **maxPriorityFeePerGas**: `string` +> `optional` **maxPriorityFeePerGas**: \`0x$\{string\}\` #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:362 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:404 *** ### nonce? -> `optional` **nonce**: `string` +> `optional` **nonce**: \`0x$\{string\}\` #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:350 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:391 *** ### r? -> `optional` **r**: `string` +> `optional` **r**: \`0x$\{string\}\` #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:356 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:397 *** ### s? -> `optional` **s**: `string` +> `optional` **s**: \`0x$\{string\}\` #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:357 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:398 *** ### to? -> `optional` **to**: `string` +> `optional` **to**: \`0x$\{string\}\` #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:353 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:394 *** ### type? -> `optional` **type**: `string` +> `optional` **type**: \`0x$\{string\}\` #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:361 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:403 *** ### v? -> `optional` **v**: `string` +> `optional` **v**: \`0x$\{string\}\` #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:355 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:396 *** ### value? -> `optional` **value**: `string` +> `optional` **value**: \`0x$\{string\}\` #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:358 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:399 diff --git a/tevm/docs/tx/interfaces/TxData.md b/tevm/docs/tx/interfaces/TxData.md index c364dc0e18..dee53ee72d 100644 --- a/tevm/docs/tx/interfaces/TxData.md +++ b/tevm/docs/tx/interfaces/TxData.md @@ -14,7 +14,7 @@ #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:154 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:168 *** @@ -24,7 +24,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:155 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:169 *** @@ -34,7 +34,7 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:156 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:170 *** @@ -44,4 +44,14 @@ node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/t #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:157 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:171 + +*** + +### 4 + +> **4**: `EOACodeEIP7702TxData` + +#### Defined in + +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:172 diff --git a/tevm/docs/tx/interfaces/TxOptions.md b/tevm/docs/tx/interfaces/TxOptions.md index e9b62eda3b..5b5de564aa 100644 --- a/tevm/docs/tx/interfaces/TxOptions.md +++ b/tevm/docs/tx/interfaces/TxOptions.md @@ -19,7 +19,7 @@ Gas cost for initcode size analysis will still be charged. Use with caution. #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:65 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:71 *** @@ -38,7 +38,7 @@ Current default hardfork: `istanbul` #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:48 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:54 *** @@ -58,4 +58,4 @@ Default: true #### Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:60 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:66 diff --git a/tevm/docs/tx/type-aliases/AccessList.md b/tevm/docs/tx/type-aliases/AccessList.md index d2540e461f..32d0b2cda9 100644 --- a/tevm/docs/tx/type-aliases/AccessList.md +++ b/tevm/docs/tx/type-aliases/AccessList.md @@ -10,4 +10,4 @@ ## Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:51 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:51 diff --git a/tevm/docs/tx/type-aliases/AccessListItem.md b/tevm/docs/tx/type-aliases/AccessListItem.md index 48b5a17375..3bee04a3fb 100644 --- a/tevm/docs/tx/type-aliases/AccessListItem.md +++ b/tevm/docs/tx/type-aliases/AccessListItem.md @@ -20,4 +20,4 @@ ## Defined in -node\_modules/.pnpm/@ethereumjs+common@4.3.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:45 +node\_modules/.pnpm/@ethereumjs+common@4.4.0/node\_modules/@ethereumjs/common/dist/esm/interfaces.d.ts:45 diff --git a/tevm/docs/tx/type-aliases/TypedTransaction.md b/tevm/docs/tx/type-aliases/TypedTransaction.md index 59727cbd3e..13b84af788 100644 --- a/tevm/docs/tx/type-aliases/TypedTransaction.md +++ b/tevm/docs/tx/type-aliases/TypedTransaction.md @@ -10,4 +10,4 @@ ## Defined in -node\_modules/.pnpm/@ethereumjs+tx@5.3.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:92 +node\_modules/.pnpm/@ethereumjs+tx@5.4.0/node\_modules/@ethereumjs/tx/dist/esm/types.d.ts:102 diff --git a/tevm/docs/txpool/classes/TxPool.md b/tevm/docs/txpool/classes/TxPool.md index 5efd3a6a6b..8a30782574 100644 --- a/tevm/docs/txpool/classes/TxPool.md +++ b/tevm/docs/txpool/classes/TxPool.md @@ -22,6 +22,8 @@ module:service **`Experimental`** +Create new tx pool + #### Parameters • **options**: `TxPoolOptions` @@ -146,6 +148,12 @@ packages/txpool/types/TxPool.d.ts:166 **`Experimental`** +Adds a tx to the pool. + +If there is a tx in the pool with the same address and +nonce it will be replaced by the new tx, if it has a sufficient gas bump. +This also verifies certain constraints, if these are not met, tx will not be added to the pool. + #### Parameters • **tx**: [`TypedTransaction`](../../tx/type-aliases/TypedTransaction.md) \| [`ImpersonatedTx`](../../tx/interfaces/ImpersonatedTx.md) @@ -172,6 +180,12 @@ packages/txpool/types/TxPool.d.ts:102 **`Experimental`** +Adds a tx to the pool without validating it. + +If there is a tx in the pool with the same address and +nonce it will be replaced by the new tx, if it has a sufficient gas bump. +This also verifies certain constraints, if these are not met, tx will not be added to the pool. + #### Parameters • **tx**: [`TypedTransaction`](../../tx/type-aliases/TypedTransaction.md) \| [`ImpersonatedTx`](../../tx/interfaces/ImpersonatedTx.md) @@ -194,6 +208,8 @@ packages/txpool/types/TxPool.d.ts:92 **`Experimental`** +Regular tx pool cleanup + #### Returns `void` @@ -210,6 +226,8 @@ packages/txpool/types/TxPool.d.ts:121 **`Experimental`** +Close pool + #### Returns `void` @@ -246,6 +264,8 @@ packages/txpool/types/TxPool.d.ts:68 **`Experimental`** +Returns the available txs from the pool + #### Parameters • **txHashes**: readonly `Uint8Array`[] @@ -288,6 +308,8 @@ packages/txpool/types/TxPool.d.ts:137 **`Experimental`** +Open pool + #### Returns `boolean` @@ -304,6 +326,8 @@ packages/txpool/types/TxPool.d.ts:72 **`Experimental`** +Removes the given tx from the pool + #### Parameters • **txHash**: `string` @@ -326,6 +350,8 @@ packages/txpool/types/TxPool.d.ts:113 **`Experimental`** +Remove txs included in the latest blocks from the tx pool + #### Parameters • **newBlocks**: [`Block`](../../block/classes/Block.md)[] @@ -346,6 +372,8 @@ packages/txpool/types/TxPool.d.ts:117 **`Experimental`** +Start tx processing + #### Returns `boolean` @@ -362,6 +390,8 @@ packages/txpool/types/TxPool.d.ts:76 **`Experimental`** +Stop pool execution + #### Returns `boolean` @@ -378,6 +408,19 @@ packages/txpool/types/TxPool.d.ts:161 **`Experimental`** +Returns eligible txs to be mined sorted by price in such a way that the +nonce orderings within a single account are maintained. + +Note, this is not as trivial as it seems from the first look as there are three +different criteria that need to be taken into account (price, nonce, account +match), which cannot be done with any plain sorting method, as certain items +cannot be compared without context. + +This method first sorts the separates the list of transactions into individual +sender accounts and sorts them by nonce. After the account nonce ordering is +satisfied, the results are merged back together by price, always comparing only +the head transaction from each account. This is done via a heap to keep it fast. + #### Parameters • **baseFee?** diff --git a/tevm/docs/utils/classes/AsyncEventEmitter.md b/tevm/docs/utils/classes/AsyncEventEmitter.md index 360725d499..7f84f3a9f5 100644 --- a/tevm/docs/utils/classes/AsyncEventEmitter.md +++ b/tevm/docs/utils/classes/AsyncEventEmitter.md @@ -215,7 +215,37 @@ node\_modules/.pnpm/@types+node@20.14.8/node\_modules/@types/node/events.d.ts:15 #### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/events.d.ts:592 +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/events.d.ts:592 + +*** + +### \[captureRejectionSymbol\]()? + +> `optional` **\[captureRejectionSymbol\]**\<`K`\>(`error`, `event`, ...`args`): `void` + +#### Type Parameters + +• **K** + +#### Parameters + +• **error**: `Error` + +• **event**: `string` \| `symbol` + +• ...**args**: `AnyRest` + +#### Returns + +`void` + +#### Inherited from + +`EventEmitter.[captureRejectionSymbol]` + +#### Defined in + +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/events.d.ts:592 *** @@ -239,17 +269,17 @@ Alias for `emitter.on(eventName, listener)`. `this` -#### Since - -v0.1.26 - #### Overrides `EventEmitter.addListener` +#### Since + +v0.1.26 + #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/asyncEventEmitter.d.ts:23 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/asyncEventEmitter.d.ts:23 *** @@ -275,7 +305,7 @@ node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/e #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/asyncEventEmitter.d.ts:20 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/asyncEventEmitter.d.ts:20 *** @@ -301,7 +331,7 @@ node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/e #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/asyncEventEmitter.d.ts:19 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/asyncEventEmitter.d.ts:19 *** @@ -361,17 +391,17 @@ myEmitter.emit('event', 1, 2, 3, 4, 5); `boolean` -#### Since - -v0.1.26 - #### Overrides `EventEmitter.emit` +#### Since + +v0.1.26 + #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/asyncEventEmitter.d.ts:16 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/asyncEventEmitter.d.ts:16 *** @@ -400,17 +430,17 @@ console.log(myEE.eventNames()); keyof `T` & `string`[] -#### Since - -v6.0.0 - #### Overrides `EventEmitter.eventNames` +#### Since + +v6.0.0 + #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/asyncEventEmitter.d.ts:28 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/asyncEventEmitter.d.ts:28 *** @@ -434,7 +464,7 @@ node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/e #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/asyncEventEmitter.d.ts:18 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/asyncEventEmitter.d.ts:18 *** @@ -449,17 +479,17 @@ set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](AsyncEv `number` -#### Since - -v1.0.0 - #### Overrides `EventEmitter.getMaxListeners` +#### Since + +v1.0.0 + #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/asyncEventEmitter.d.ts:31 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/asyncEventEmitter.d.ts:31 *** @@ -479,17 +509,17 @@ in the list of the listeners of the event. `number` -#### Since - -v3.2.0 - #### Overrides `EventEmitter.listenerCount` +#### Since + +v3.2.0 + #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/asyncEventEmitter.d.ts:30 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/asyncEventEmitter.d.ts:30 *** @@ -519,17 +549,17 @@ console.log(util.inspect(server.listeners('connection'))); `T`\[`E`\][] -#### Since - -v0.1.26 - #### Overrides `EventEmitter.listeners` +#### Since + +v0.1.26 + #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/asyncEventEmitter.d.ts:29 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/asyncEventEmitter.d.ts:29 *** @@ -555,14 +585,14 @@ Alias for `emitter.removeListener()`. `this` -##### Since - -v10.0.0 - ##### Inherited from `EventEmitter.off` +##### Since + +v10.0.0 + ##### Defined in node\_modules/.pnpm/@types+node@20.14.8/node\_modules/@types/node/events.d.ts:763 @@ -587,17 +617,49 @@ Alias for `emitter.removeListener()`. `this` +##### Inherited from + +`EventEmitter.off` + ##### Since v10.0.0 +##### Defined in + +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/events.d.ts:747 + +#### off(eventName, listener) + +> **off**\<`K`\>(`eventName`, `listener`): `this` + +Alias for `emitter.removeListener()`. + +##### Type Parameters + +• **K** + +##### Parameters + +• **eventName**: `string` \| `symbol` + +• **listener** + +##### Returns + +`this` + ##### Inherited from `EventEmitter.off` +##### Since + +v10.0.0 + ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/events.d.ts:747 +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/events.d.ts:747 *** @@ -648,17 +710,17 @@ The callback function `this` -#### Since - -v0.1.101 - #### Overrides `EventEmitter.on` +#### Since + +v0.1.101 + #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/asyncEventEmitter.d.ts:22 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/asyncEventEmitter.d.ts:22 *** @@ -707,17 +769,17 @@ The callback function `this` -#### Since - -v0.3.0 - #### Overrides `EventEmitter.once` +#### Since + +v0.3.0 + #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/asyncEventEmitter.d.ts:17 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/asyncEventEmitter.d.ts:17 *** @@ -754,17 +816,17 @@ The callback function `this` -#### Since - -v6.0.0 - #### Overrides `EventEmitter.prependListener` +#### Since + +v6.0.0 + #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/asyncEventEmitter.d.ts:24 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/asyncEventEmitter.d.ts:24 *** @@ -799,17 +861,17 @@ The callback function `this` -#### Since - -v6.0.0 - #### Overrides `EventEmitter.prependOnceListener` +#### Since + +v6.0.0 + #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/asyncEventEmitter.d.ts:25 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/asyncEventEmitter.d.ts:25 *** @@ -859,14 +921,14 @@ emitter.emit('log'); `Function`[] -##### Since - -v9.4.0 - ##### Inherited from `EventEmitter.rawListeners` +##### Since + +v9.4.0 + ##### Defined in node\_modules/.pnpm/@types+node@20.14.8/node\_modules/@types/node/events.d.ts:834 @@ -915,17 +977,73 @@ emitter.emit('log'); `Function`[] +##### Inherited from + +`EventEmitter.rawListeners` + ##### Since v9.4.0 +##### Defined in + +node\_modules/.pnpm/@types+node@20.14.15/node\_modules/@types/node/events.d.ts:818 + +#### rawListeners(eventName) + +> **rawListeners**\<`K`\>(`eventName`): `Function`[] + +Returns a copy of the array of listeners for the event named `eventName`, +including any wrappers (such as those created by `.once()`). + +```js +import { EventEmitter } from 'node:events'; +const emitter = new EventEmitter(); +emitter.once('log', () => console.log('log once')); + +// Returns a new Array with a function `onceWrapper` which has a property +// `listener` which contains the original listener bound above +const listeners = emitter.rawListeners('log'); +const logFnWrapper = listeners[0]; + +// Logs "log once" to the console and does not unbind the `once` event +logFnWrapper.listener(); + +// Logs "log once" to the console and removes the listener +logFnWrapper(); + +emitter.on('log', () => console.log('log persistently')); +// Will return a new Array with a single function bound by `.on()` above +const newListeners = emitter.rawListeners('log'); + +// Logs "log persistently" twice +newListeners[0](); +emitter.emit('log'); +``` + +##### Type Parameters + +• **K** + +##### Parameters + +• **eventName**: `string` \| `symbol` + +##### Returns + +`Function`[] + ##### Inherited from `EventEmitter.rawListeners` +##### Since + +v9.4.0 + ##### Defined in -node\_modules/.pnpm/@types+node@22.2.0/node\_modules/@types/node/events.d.ts:818 +node\_modules/.pnpm/@types+node@22.5.1/node\_modules/@types/node/events.d.ts:818 *** @@ -949,17 +1067,17 @@ Returns a reference to the `EventEmitter`, so that calls can be chained. `this` -#### Since - -v0.1.26 - #### Overrides `EventEmitter.removeAllListeners` +#### Since + +v0.1.26 + #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/asyncEventEmitter.d.ts:26 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/asyncEventEmitter.d.ts:26 *** @@ -1061,17 +1179,17 @@ Returns a reference to the `EventEmitter`, so that calls can be chained. `this` -#### Since - -v0.1.26 - #### Overrides `EventEmitter.removeListener` +#### Since + +v0.1.26 + #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/asyncEventEmitter.d.ts:27 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/asyncEventEmitter.d.ts:27 *** @@ -1094,17 +1212,17 @@ Returns a reference to the `EventEmitter`, so that calls can be chained. `this` -#### Since - -v0.3.5 - #### Overrides `EventEmitter.setMaxListeners` +#### Since + +v0.3.5 + #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/asyncEventEmitter.d.ts:32 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/asyncEventEmitter.d.ts:32 *** @@ -1156,14 +1274,14 @@ function example(signal) { Disposable that removes the `abort` listener. -#### Since - -v20.5.0 - #### Inherited from `EventEmitter.addAbortListener` +#### Since + +v20.5.0 + #### Defined in node\_modules/.pnpm/@types+node@20.14.8/node\_modules/@types/node/events.d.ts:453 @@ -1209,14 +1327,14 @@ import { getEventListeners, EventEmitter } from 'node:events'; `Function`[] -#### Since - -v15.2.0, v14.17.0 - #### Inherited from `EventEmitter.getEventListeners` +#### Since + +v15.2.0, v14.17.0 + #### Defined in node\_modules/.pnpm/@types+node@20.14.8/node\_modules/@types/node/events.d.ts:374 @@ -1261,14 +1379,14 @@ import { getMaxListeners, setMaxListeners, EventEmitter } from 'node:events'; `number` -#### Since - -v19.9.0 - #### Inherited from `EventEmitter.getMaxListeners` +#### Since + +v19.9.0 + #### Defined in node\_modules/.pnpm/@types+node@20.14.8/node\_modules/@types/node/events.d.ts:403 @@ -1305,6 +1423,10 @@ The event name `number` +#### Inherited from + +`EventEmitter.listenerCount` + #### Since v0.9.12 @@ -1313,10 +1435,6 @@ v0.9.12 Since v3.2.0 - Use `listenerCount` instead. -#### Inherited from - -`EventEmitter.listenerCount` - #### Defined in node\_modules/.pnpm/@types+node@20.14.8/node\_modules/@types/node/events.d.ts:346 @@ -1422,14 +1540,14 @@ The name of the event being listened for An `AsyncIterator` that iterates `eventName` events emitted by the `emitter` -##### Since - -v13.6.0, v12.16.0 - ##### Inherited from `EventEmitter.on` +##### Since + +v13.6.0, v12.16.0 + ##### Defined in node\_modules/.pnpm/@types+node@20.14.8/node\_modules/@types/node/events.d.ts:319 @@ -1555,14 +1673,14 @@ ee.emit('foo'); // Prints: Waiting for the event was canceled! `Promise`\<`any`[]\> -##### Since - -v11.13.0, v10.16.0 - ##### Inherited from `EventEmitter.once` +##### Since + +v11.13.0, v10.16.0 + ##### Defined in node\_modules/.pnpm/@types+node@20.14.8/node\_modules/@types/node/events.d.ts:232 @@ -1618,14 +1736,14 @@ A non-negative number. The maximum number of listeners per `EventTarget` event. `void` -#### Since - -v15.4.0 - #### Inherited from `EventEmitter.setMaxListeners` +#### Since + +v15.4.0 + #### Defined in node\_modules/.pnpm/@types+node@20.14.8/node\_modules/@types/node/events.d.ts:418 diff --git a/tevm/docs/utils/classes/EthjsAccount.md b/tevm/docs/utils/classes/EthjsAccount.md index ae07db88fd..cfe5e33ad8 100644 --- a/tevm/docs/utils/classes/EthjsAccount.md +++ b/tevm/docs/utils/classes/EthjsAccount.md @@ -6,24 +6,38 @@ # Class: EthjsAccount +Account class to load and maintain the basic account objects. +Supports partial loading and access required for verkle with null +as the placeholder. + +Note: passing undefined in constructor is different from null +While undefined leads to default assignment, null is retained +to track the information not available/loaded because of partial +witness access + ## Constructors ### new EthjsAccount() -> **new EthjsAccount**(`nonce`?, `balance`?, `storageRoot`?, `codeHash`?): [`EthjsAccount`](EthjsAccount.md) +> **new EthjsAccount**(`nonce`?, `balance`?, `storageRoot`?, `codeHash`?, `codeSize`?, `version`?): [`EthjsAccount`](EthjsAccount.md) This constructor assigns and validates the values. Use the static factory methods to assist in creating an Account from varying data types. +undefined get assigned with the defaults present, but null args are retained as is #### Parameters -• **nonce?**: `bigint` +• **nonce?**: `null` \| `bigint` + +• **balance?**: `null` \| `bigint` -• **balance?**: `bigint` +• **storageRoot?**: `null` \| `Uint8Array` -• **storageRoot?**: `Uint8Array` +• **codeHash?**: `null` \| `Uint8Array` -• **codeHash?**: `Uint8Array` +• **codeSize?**: `null` \| `number` + +• **version?**: `null` \| `number` #### Returns @@ -31,47 +45,187 @@ Use the static factory methods to assist in creating an Account from varying dat #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/account.d.ts:21 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/account.d.ts:56 ## Properties +### \_balance + +> **\_balance**: `null` \| `bigint` + +#### Defined in + +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/account.d.ts:29 + +*** + +### \_codeHash + +> **\_codeHash**: `null` \| `Uint8Array` + +#### Defined in + +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/account.d.ts:31 + +*** + +### \_codeSize + +> **\_codeSize**: `null` \| `number` + +#### Defined in + +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/account.d.ts:32 + +*** + +### \_nonce + +> **\_nonce**: `null` \| `bigint` + +#### Defined in + +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/account.d.ts:28 + +*** + +### \_storageRoot + +> **\_storageRoot**: `null` \| `Uint8Array` + +#### Defined in + +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/account.d.ts:30 + +*** + +### \_version + +> **\_version**: `null` \| `number` + +#### Defined in + +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/account.d.ts:33 + +## Accessors + ### balance -> **balance**: `bigint` +> `get` **balance**(): `bigint` + +> `set` **balance**(`_balance`): `void` + +#### Parameters + +• **\_balance**: `bigint` + +#### Returns + +`bigint` #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/account.d.ts:11 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/account.d.ts:38 *** ### codeHash -> **codeHash**: `Uint8Array` +> `get` **codeHash**(): `Uint8Array` + +> `set` **codeHash**(`_codeHash`): `void` + +#### Parameters + +• **\_codeHash**: `Uint8Array` + +#### Returns + +`Uint8Array` #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/account.d.ts:13 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/account.d.ts:42 + +*** + +### codeSize + +> `get` **codeSize**(): `number` + +> `set` **codeSize**(`_codeSize`): `void` + +#### Parameters + +• **\_codeSize**: `number` + +#### Returns + +`number` + +#### Defined in + +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/account.d.ts:44 *** ### nonce -> **nonce**: `bigint` +> `get` **nonce**(): `bigint` + +> `set` **nonce**(`_nonce`): `void` + +#### Parameters + +• **\_nonce**: `bigint` + +#### Returns + +`bigint` #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/account.d.ts:10 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/account.d.ts:36 *** ### storageRoot -> **storageRoot**: `Uint8Array` +> `get` **storageRoot**(): `Uint8Array` + +> `set` **storageRoot**(`_storageRoot`): `void` + +#### Parameters + +• **\_storageRoot**: `Uint8Array` + +#### Returns + +`Uint8Array` + +#### Defined in + +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/account.d.ts:40 + +*** + +### version + +> `get` **version**(): `number` + +> `set` **version**(`_version`): `void` + +#### Parameters + +• **\_version**: `number` + +#### Returns + +`number` #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/account.d.ts:12 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/account.d.ts:34 ## Methods @@ -87,7 +241,7 @@ Returns a `Boolean` determining if the account is a contract. #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/account.d.ts:34 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/account.d.ts:70 *** @@ -105,7 +259,7 @@ account emptiness in [EIP-161](https://eips.ethereum.org/EIPS/eip-161): #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/account.d.ts:40 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/account.d.ts:76 *** @@ -121,7 +275,7 @@ Returns an array of Uint8Arrays of the raw bytes for the account, in order. #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/account.d.ts:26 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/account.d.ts:61 *** @@ -137,7 +291,21 @@ Returns the RLP serialization of the account as a `Uint8Array`. #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/account.d.ts:30 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/account.d.ts:65 + +*** + +### serializeWithPartialInfo() + +> **serializeWithPartialInfo**(): `Uint8Array` + +#### Returns + +`Uint8Array` + +#### Defined in + +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/account.d.ts:66 *** @@ -155,7 +323,25 @@ node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/e #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/account.d.ts:14 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/account.d.ts:46 + +*** + +### fromPartialAccountData() + +> `static` **fromPartialAccountData**(`partialAccountData`): [`EthjsAccount`](EthjsAccount.md) + +#### Parameters + +• **partialAccountData**: `PartialAccountData` + +#### Returns + +[`EthjsAccount`](EthjsAccount.md) + +#### Defined in + +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/account.d.ts:47 *** @@ -173,7 +359,25 @@ node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/e #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/account.d.ts:15 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/account.d.ts:48 + +*** + +### fromRlpSerializedPartialAccount() + +> `static` **fromRlpSerializedPartialAccount**(`serialized`): [`EthjsAccount`](EthjsAccount.md) + +#### Parameters + +• **serialized**: `Uint8Array` + +#### Returns + +[`EthjsAccount`](EthjsAccount.md) + +#### Defined in + +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/account.d.ts:49 *** @@ -191,4 +395,4 @@ node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/e #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/account.d.ts:16 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/account.d.ts:50 diff --git a/tevm/docs/utils/classes/EthjsAddress.md b/tevm/docs/utils/classes/EthjsAddress.md index ddaec39254..0063cdc3d1 100644 --- a/tevm/docs/utils/classes/EthjsAddress.md +++ b/tevm/docs/utils/classes/EthjsAddress.md @@ -28,7 +28,7 @@ Handling and generating Ethereum addresses #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/address.d.ts:6 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/address.d.ts:7 ## Properties @@ -38,7 +38,7 @@ node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/e #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/address.d.ts:5 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/address.d.ts:6 ## Methods @@ -58,7 +58,7 @@ Is address equal to another. #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/address.d.ts:42 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/address.d.ts:43 *** @@ -75,7 +75,7 @@ by EIP-1352 #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/address.d.ts:51 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/address.d.ts:52 *** @@ -91,7 +91,7 @@ Is address zero. #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/address.d.ts:46 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/address.d.ts:47 *** @@ -107,23 +107,23 @@ Returns a new Uint8Array representation of address. #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/address.d.ts:59 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/address.d.ts:60 *** ### toString() -> **toString**(): `string` +> **toString**(): \`0x$\{string\}\` Returns hex encoding of address. #### Returns -`string` +\`0x$\{string\}\` #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/address.d.ts:55 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/address.d.ts:56 *** @@ -145,7 +145,7 @@ A private key must be 256 bits wide #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/address.d.ts:25 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/address.d.ts:26 *** @@ -167,7 +167,7 @@ The two points of an uncompressed key #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/address.d.ts:20 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/address.d.ts:21 *** @@ -189,7 +189,7 @@ Hex-encoded address #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/address.d.ts:15 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/address.d.ts:16 *** @@ -215,7 +215,7 @@ The nonce of the from account #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/address.d.ts:31 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/address.d.ts:32 *** @@ -245,7 +245,7 @@ The init code of the contract being created #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/address.d.ts:38 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/address.d.ts:39 *** @@ -261,4 +261,4 @@ Returns the zero address. #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/address.d.ts:10 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/address.d.ts:11 diff --git a/tevm/docs/utils/classes/Withdrawal.md b/tevm/docs/utils/classes/Withdrawal.md index 548af77ae0..775dc787b1 100644 --- a/tevm/docs/utils/classes/Withdrawal.md +++ b/tevm/docs/utils/classes/Withdrawal.md @@ -36,7 +36,7 @@ withdrawal amount in Gwei to match the CL repesentation and eventually ssz withd #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/withdrawal.d.ts:40 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/withdrawal.d.ts:40 ## Properties @@ -46,7 +46,7 @@ node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/e #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/withdrawal.d.ts:30 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/withdrawal.d.ts:30 *** @@ -58,7 +58,7 @@ withdrawal amount in Gwei to match the CL repesentation and eventually ssz withd #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/withdrawal.d.ts:34 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/withdrawal.d.ts:34 *** @@ -68,7 +68,7 @@ node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/e #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/withdrawal.d.ts:28 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/withdrawal.d.ts:28 *** @@ -78,7 +78,7 @@ node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/e #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/withdrawal.d.ts:29 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/withdrawal.d.ts:29 ## Methods @@ -92,7 +92,7 @@ node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/e #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/withdrawal.d.ts:53 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/withdrawal.d.ts:53 *** @@ -106,23 +106,23 @@ node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/e ##### address -> **address**: `string` +> **address**: \`0x$\{string\}\` ##### amount -> **amount**: `string` +> **amount**: \`0x$\{string\}\` ##### index -> **index**: `string` +> **index**: \`0x$\{string\}\` ##### validatorIndex -> **validatorIndex**: `string` +> **validatorIndex**: \`0x$\{string\}\` #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/withdrawal.d.ts:60 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/withdrawal.d.ts:60 *** @@ -152,7 +152,7 @@ node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/e #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/withdrawal.d.ts:54 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/withdrawal.d.ts:54 *** @@ -170,7 +170,7 @@ node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/e #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/withdrawal.d.ts:46 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/withdrawal.d.ts:46 *** @@ -188,7 +188,7 @@ node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/e #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/withdrawal.d.ts:45 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/withdrawal.d.ts:45 *** @@ -212,4 +212,4 @@ buffer array of the withdrawal #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/withdrawal.d.ts:52 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/withdrawal.d.ts:52 diff --git a/tevm/docs/utils/enumerations/KeyEncoding.md b/tevm/docs/utils/enumerations/KeyEncoding.md index 8c2232d84a..26a49901c9 100644 --- a/tevm/docs/utils/enumerations/KeyEncoding.md +++ b/tevm/docs/utils/enumerations/KeyEncoding.md @@ -14,7 +14,7 @@ #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/db.d.ts:7 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/db.d.ts:7 *** @@ -24,7 +24,7 @@ node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/e #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/db.d.ts:8 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/db.d.ts:8 *** @@ -34,4 +34,4 @@ node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/e #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/db.d.ts:6 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/db.d.ts:6 diff --git a/tevm/docs/utils/enumerations/TypeOutput.md b/tevm/docs/utils/enumerations/TypeOutput.md index 83e967e852..c8b90c18c3 100644 --- a/tevm/docs/utils/enumerations/TypeOutput.md +++ b/tevm/docs/utils/enumerations/TypeOutput.md @@ -16,7 +16,7 @@ Type output options #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/types.d.ts:19 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/types.d.ts:20 *** @@ -26,7 +26,7 @@ node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/e #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/types.d.ts:18 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/types.d.ts:19 *** @@ -36,7 +36,7 @@ node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/e #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/types.d.ts:21 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/types.d.ts:22 *** @@ -46,4 +46,4 @@ node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/e #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/types.d.ts:20 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/types.d.ts:21 diff --git a/tevm/docs/utils/enumerations/ValueEncoding.md b/tevm/docs/utils/enumerations/ValueEncoding.md index 850fff6702..00426dbfd7 100644 --- a/tevm/docs/utils/enumerations/ValueEncoding.md +++ b/tevm/docs/utils/enumerations/ValueEncoding.md @@ -14,7 +14,7 @@ #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/db.d.ts:12 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/db.d.ts:12 *** @@ -24,7 +24,7 @@ node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/e #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/db.d.ts:13 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/db.d.ts:13 *** @@ -34,4 +34,4 @@ node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/e #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/db.d.ts:11 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/db.d.ts:11 diff --git a/tevm/docs/utils/functions/bytesToUnprefixedHex.md b/tevm/docs/utils/functions/bytesToUnprefixedHex.md index 7babe24fe4..ef3d2fcc50 100644 --- a/tevm/docs/utils/functions/bytesToUnprefixedHex.md +++ b/tevm/docs/utils/functions/bytesToUnprefixedHex.md @@ -16,8 +16,6 @@ `string` -## Deprecated - ## Example ```ts @@ -26,4 +24,4 @@ bytesToHex(Uint8Array.from([0xca, 0xfe, 0x01, 0x23])) // 'cafe0123' ## Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/bytes.d.ts:6 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/bytes.d.ts:6 diff --git a/tevm/docs/utils/functions/bytesToUtf8.md b/tevm/docs/utils/functions/bytesToUtf8.md index cd1e452042..79b1cb8a5a 100644 --- a/tevm/docs/utils/functions/bytesToUtf8.md +++ b/tevm/docs/utils/functions/bytesToUtf8.md @@ -18,4 +18,4 @@ ## Defined in -node\_modules/.pnpm/ethereum-cryptography@2.2.0/node\_modules/ethereum-cryptography/utils.d.ts:5 +node\_modules/.pnpm/ethereum-cryptography@2.2.1/node\_modules/ethereum-cryptography/utils.d.ts:5 diff --git a/tevm/docs/utils/functions/concatBytes.md b/tevm/docs/utils/functions/concatBytes.md index d1844db54d..7aa9f11d0b 100644 --- a/tevm/docs/utils/functions/concatBytes.md +++ b/tevm/docs/utils/functions/concatBytes.md @@ -8,10 +8,6 @@ > **concatBytes**(...`arrays`): `Uint8Array` -This mirrors the functionality of the `ethereum-cryptography` export except -it skips the check to validate that every element of `arrays` is indead a `uint8Array` -Can give small performance gains on large arrays - ## Parameters • ...**arrays**: `Uint8Array`[] @@ -27,4 +23,4 @@ works like `Buffer.concat` ## Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/bytes.d.ts:195 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/bytes.d.ts:202 diff --git a/tevm/docs/utils/functions/ecrecover.md b/tevm/docs/utils/functions/ecrecover.md index ef84d15076..de2754e257 100644 --- a/tevm/docs/utils/functions/ecrecover.md +++ b/tevm/docs/utils/functions/ecrecover.md @@ -8,9 +8,6 @@ > **ecrecover**(`msgHash`, `v`, `r`, `s`, `chainId`?): `Uint8Array` -ECDSA public key recovery from signature. -NOTE: Accepts `v === 0 | v === 1` for EIP1559 transactions - ## Parameters • **msgHash**: `Uint8Array` @@ -31,4 +28,4 @@ Recovered public key ## Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/signature.d.ts:19 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/signature.d.ts:20 diff --git a/tevm/docs/utils/functions/ecsign.md b/tevm/docs/utils/functions/ecsign.md index 2320b36584..15043f964f 100644 --- a/tevm/docs/utils/functions/ecsign.md +++ b/tevm/docs/utils/functions/ecsign.md @@ -27,4 +27,4 @@ accordingly, otherwise return a "static" `v` just derived from the `recovery` bi ## Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/signature.d.ts:12 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/signature.d.ts:13 diff --git a/tevm/docs/utils/functions/equalsBytes.md b/tevm/docs/utils/functions/equalsBytes.md index 1ba2fb2384..9543a9bd78 100644 --- a/tevm/docs/utils/functions/equalsBytes.md +++ b/tevm/docs/utils/functions/equalsBytes.md @@ -20,4 +20,4 @@ ## Defined in -node\_modules/.pnpm/ethereum-cryptography@2.2.0/node\_modules/ethereum-cryptography/utils.d.ts:7 +node\_modules/.pnpm/ethereum-cryptography@2.2.1/node\_modules/ethereum-cryptography/utils.d.ts:7 diff --git a/tevm/docs/utils/functions/fetchFromProvider.md b/tevm/docs/utils/functions/fetchFromProvider.md index 0267d6cbfc..d8ae596cfd 100644 --- a/tevm/docs/utils/functions/fetchFromProvider.md +++ b/tevm/docs/utils/functions/fetchFromProvider.md @@ -8,9 +8,6 @@ > **fetchFromProvider**(`url`, `params`): `Promise`\<`any`\> -Makes a simple RPC call to a remote Ethereum JSON-RPC provider and passes through the response. -No parameter or response validation is done. - ## Parameters • **url**: `string` @@ -28,16 +25,6 @@ https://ethereum.org/en/developers/docs/apis/json-rpc/ for details on RPC method the `result` field from the JSON-RPC response -## Example - -```ts -const provider = 'https://mainnet.infura.io/v3/...' -const params = { - method: 'eth_getBlockByNumber', - params: ['latest', false], -} - const block = await fetchFromProvider(provider, params) - ## Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/provider.d.ts:22 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/provider.d.ts:23 diff --git a/tevm/docs/utils/functions/getProvider.md b/tevm/docs/utils/functions/getProvider.md index 21c3f76909..c903f2b978 100644 --- a/tevm/docs/utils/functions/getProvider.md +++ b/tevm/docs/utils/functions/getProvider.md @@ -22,4 +22,4 @@ the extracted URL string for the JSON-RPC Provider ## Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/provider.d.ts:28 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/provider.d.ts:29 diff --git a/tevm/docs/utils/functions/randomBytes.md b/tevm/docs/utils/functions/randomBytes.md index fceacc5b2a..c98550f8f3 100644 --- a/tevm/docs/utils/functions/randomBytes.md +++ b/tevm/docs/utils/functions/randomBytes.md @@ -8,8 +8,6 @@ > **randomBytes**(`length`): `Uint8Array` -Generates a Uint8Array of random bytes of specified length. - ## Parameters • **length**: `number` @@ -24,4 +22,4 @@ A Uint8Array of random bytes of specified length. ## Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/bytes.d.ts:186 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/bytes.d.ts:193 diff --git a/tevm/docs/utils/functions/serializeTransaction.md b/tevm/docs/utils/functions/serializeTransaction.md index 58d503f086..e304e8e74a 100644 --- a/tevm/docs/utils/functions/serializeTransaction.md +++ b/tevm/docs/utils/functions/serializeTransaction.md @@ -26,4 +26,4 @@ ## Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/transaction/serializeTransaction.d.ts:19 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/transaction/serializeTransaction.d.ts:20 diff --git a/tevm/docs/utils/functions/setLengthLeft.md b/tevm/docs/utils/functions/setLengthLeft.md index 64eee950aa..77d4c57dac 100644 --- a/tevm/docs/utils/functions/setLengthLeft.md +++ b/tevm/docs/utils/functions/setLengthLeft.md @@ -8,9 +8,6 @@ > **setLengthLeft**(`msg`, `length`): `Uint8Array` -Left Pads a `Uint8Array` with leading zeros till it has `length` bytes. -Or it truncates the beginning if it exceeds. - ## Parameters • **msg**: `Uint8Array` @@ -27,4 +24,4 @@ the number of bytes the output should be ## Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/bytes.d.ts:58 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/bytes.d.ts:64 diff --git a/tevm/docs/utils/functions/toType.md b/tevm/docs/utils/functions/toType.md index a832d653b7..17b5783edb 100644 --- a/tevm/docs/utils/functions/toType.md +++ b/tevm/docs/utils/functions/toType.md @@ -33,7 +33,7 @@ type to output ### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/types.d.ts:35 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/types.d.ts:36 ## toType(input, outputType) @@ -55,7 +55,7 @@ node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/e ### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/types.d.ts:36 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/types.d.ts:37 ## toType(input, outputType) @@ -77,4 +77,4 @@ node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/e ### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/types.d.ts:37 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/types.d.ts:38 diff --git a/tevm/docs/utils/functions/zeros.md b/tevm/docs/utils/functions/zeros.md index 4b6cc8a47d..235c1b1355 100644 --- a/tevm/docs/utils/functions/zeros.md +++ b/tevm/docs/utils/functions/zeros.md @@ -8,8 +8,6 @@ > **zeros**(`bytes`): `Uint8Array` -Returns a Uint8Array filled with 0s. - ## Parameters • **bytes**: `number` @@ -22,4 +20,4 @@ the number of bytes of the Uint8Array ## Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/bytes.d.ts:50 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/bytes.d.ts:56 diff --git a/tevm/docs/utils/interfaces/Db.md b/tevm/docs/utils/interfaces/Db.md index c5562260c2..c4640c051f 100644 --- a/tevm/docs/utils/interfaces/Db.md +++ b/tevm/docs/utils/interfaces/Db.md @@ -32,7 +32,7 @@ A stack of levelup operations #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/db.d.ts:52 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/db.d.ts:52 *** @@ -54,7 +54,7 @@ Removes a raw value in the underlying db. #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/db.d.ts:47 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/db.d.ts:47 *** @@ -78,7 +78,7 @@ A Promise that resolves to `Uint8Array` if a value is found or `undefined` if no #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/db.d.ts:36 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/db.d.ts:36 *** @@ -94,7 +94,7 @@ Opens the database -- if applicable #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/db.d.ts:61 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/db.d.ts:61 *** @@ -120,7 +120,7 @@ The key as a `TValue` #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/db.d.ts:42 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/db.d.ts:42 *** @@ -137,4 +137,4 @@ to the **same** underlying db instance. #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/db.d.ts:57 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/db.d.ts:57 diff --git a/tevm/docs/utils/interfaces/GenesisState.md b/tevm/docs/utils/interfaces/GenesisState.md index 96cc841764..4bfd041160 100644 --- a/tevm/docs/utils/interfaces/GenesisState.md +++ b/tevm/docs/utils/interfaces/GenesisState.md @@ -31,4 +31,4 @@ A complex genesis state with Contract and EoA states would have the following fo ## Indexable - \[`key`: `PrefixedHexString`\]: `PrefixedHexString` \| `AccountState` + \[`key`: `string`\]: `PrefixedHexString` \| `AccountState` diff --git a/tevm/docs/utils/interfaces/JsonRpcWithdrawal.md b/tevm/docs/utils/interfaces/JsonRpcWithdrawal.md index c5caebd22d..b85df53514 100644 --- a/tevm/docs/utils/interfaces/JsonRpcWithdrawal.md +++ b/tevm/docs/utils/interfaces/JsonRpcWithdrawal.md @@ -13,38 +13,38 @@ match CL representation and for eventual ssz withdrawalsRoot ### address -> **address**: `string` +> **address**: \`0x$\{string\}\` #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/withdrawal.d.ts:20 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/withdrawal.d.ts:20 *** ### amount -> **amount**: `string` +> **amount**: \`0x$\{string\}\` #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/withdrawal.d.ts:21 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/withdrawal.d.ts:21 *** ### index -> **index**: `string` +> **index**: \`0x$\{string\}\` #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/withdrawal.d.ts:18 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/withdrawal.d.ts:18 *** ### validatorIndex -> **validatorIndex**: `string` +> **validatorIndex**: \`0x$\{string\}\` #### Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/withdrawal.d.ts:19 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/withdrawal.d.ts:19 diff --git a/tevm/docs/utils/type-aliases/AddressLike.md b/tevm/docs/utils/type-aliases/AddressLike.md index 683af9657c..6c1e169f13 100644 --- a/tevm/docs/utils/type-aliases/AddressLike.md +++ b/tevm/docs/utils/type-aliases/AddressLike.md @@ -12,4 +12,4 @@ A type that represents an input that can be converted to an Address. ## Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/types.d.ts:9 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/types.d.ts:9 diff --git a/tevm/docs/utils/type-aliases/BatchDbOp.md b/tevm/docs/utils/type-aliases/BatchDbOp.md index c1c64fc941..793ad4e47a 100644 --- a/tevm/docs/utils/type-aliases/BatchDbOp.md +++ b/tevm/docs/utils/type-aliases/BatchDbOp.md @@ -16,4 +16,4 @@ ## Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/db.d.ts:4 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/db.d.ts:4 diff --git a/tevm/docs/utils/type-aliases/BigIntLike.md b/tevm/docs/utils/type-aliases/BigIntLike.md index ef0a726cd8..390196aea7 100644 --- a/tevm/docs/utils/type-aliases/BigIntLike.md +++ b/tevm/docs/utils/type-aliases/BigIntLike.md @@ -10,4 +10,4 @@ ## Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/types.d.ts:3 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/types.d.ts:3 diff --git a/tevm/docs/utils/type-aliases/BytesLike.md b/tevm/docs/utils/type-aliases/BytesLike.md index c94e733190..e9924b0d42 100644 --- a/tevm/docs/utils/type-aliases/BytesLike.md +++ b/tevm/docs/utils/type-aliases/BytesLike.md @@ -10,4 +10,4 @@ ## Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/types.d.ts:4 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/types.d.ts:4 diff --git a/tevm/docs/utils/type-aliases/ContractConstructorArgs.md b/tevm/docs/utils/type-aliases/ContractConstructorArgs.md index c98ea9f64d..7eb9ca4aac 100644 --- a/tevm/docs/utils/type-aliases/ContractConstructorArgs.md +++ b/tevm/docs/utils/type-aliases/ContractConstructorArgs.md @@ -14,4 +14,4 @@ ## Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/types/contract.d.ts:9 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/types/contract.d.ts:9 diff --git a/tevm/docs/utils/type-aliases/DbObject.md b/tevm/docs/utils/type-aliases/DbObject.md index 41c0b0b0e0..164ec7fae9 100644 --- a/tevm/docs/utils/type-aliases/DbObject.md +++ b/tevm/docs/utils/type-aliases/DbObject.md @@ -14,4 +14,4 @@ ## Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/db.d.ts:1 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/db.d.ts:1 diff --git a/tevm/docs/utils/type-aliases/EncodeDeployDataParameters.md b/tevm/docs/utils/type-aliases/EncodeDeployDataParameters.md index 317350c252..b5cf72b388 100644 --- a/tevm/docs/utils/type-aliases/EncodeDeployDataParameters.md +++ b/tevm/docs/utils/type-aliases/EncodeDeployDataParameters.md @@ -28,4 +28,4 @@ ## Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/abi/encodeDeployData.d.ts:9 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/abi/encodeDeployData.d.ts:9 diff --git a/tevm/docs/utils/type-aliases/EncodeEventTopicsParameters.md b/tevm/docs/utils/type-aliases/EncodeEventTopicsParameters.md index 70800fd8a0..59cdd39dab 100644 --- a/tevm/docs/utils/type-aliases/EncodeEventTopicsParameters.md +++ b/tevm/docs/utils/type-aliases/EncodeEventTopicsParameters.md @@ -32,4 +32,4 @@ ## Defined in -node\_modules/.pnpm/viem@2.14.2\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/abi/encodeEventTopics.d.ts:13 +node\_modules/.pnpm/viem@2.21.1\_bufferutil@4.0.8\_typescript@5.5.4\_utf-8-validate@6.0.4\_zod@3.23.8/node\_modules/viem/\_types/utils/abi/encodeEventTopics.d.ts:14 diff --git a/tevm/docs/utils/type-aliases/EncodingOpts.md b/tevm/docs/utils/type-aliases/EncodingOpts.md index 654df1535c..940203b785 100644 --- a/tevm/docs/utils/type-aliases/EncodingOpts.md +++ b/tevm/docs/utils/type-aliases/EncodingOpts.md @@ -20,4 +20,4 @@ ## Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/db.d.ts:15 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/db.d.ts:15 diff --git a/tevm/docs/utils/type-aliases/EthjsLog.md b/tevm/docs/utils/type-aliases/EthjsLog.md index f7a3237c89..85e7a7b0d6 100644 --- a/tevm/docs/utils/type-aliases/EthjsLog.md +++ b/tevm/docs/utils/type-aliases/EthjsLog.md @@ -12,4 +12,4 @@ Log that the contract emits. ## Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:299 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:336 diff --git a/tevm/docs/utils/type-aliases/WithdrawalData.md b/tevm/docs/utils/type-aliases/WithdrawalData.md index ee478313a5..5bc1fbb7d2 100644 --- a/tevm/docs/utils/type-aliases/WithdrawalData.md +++ b/tevm/docs/utils/type-aliases/WithdrawalData.md @@ -31,4 +31,4 @@ match CL representation and for eventual ssz withdrawalsRoot ## Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/withdrawal.d.ts:7 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/withdrawal.d.ts:7 diff --git a/tevm/docs/utils/variables/GWEI_TO_WEI.md b/tevm/docs/utils/variables/GWEI_TO_WEI.md index 4f1fe669d9..5d16444510 100644 --- a/tevm/docs/utils/variables/GWEI_TO_WEI.md +++ b/tevm/docs/utils/variables/GWEI_TO_WEI.md @@ -12,4 +12,4 @@ Easy conversion from Gwei to wei ## Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/units.d.ts:2 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/units.d.ts:2 diff --git a/tevm/docs/utils/variables/KECCAK256_RLP.md b/tevm/docs/utils/variables/KECCAK256_RLP.md index 53c6c9caf5..f9186e9ab5 100644 --- a/tevm/docs/utils/variables/KECCAK256_RLP.md +++ b/tevm/docs/utils/variables/KECCAK256_RLP.md @@ -12,4 +12,4 @@ Keccak-256 hash of the RLP of null ## Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/constants.d.ts:44 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/constants.d.ts:44 diff --git a/tevm/docs/utils/variables/KECCAK256_RLP_ARRAY.md b/tevm/docs/utils/variables/KECCAK256_RLP_ARRAY.md index eedcf38fdf..f3d563835e 100644 --- a/tevm/docs/utils/variables/KECCAK256_RLP_ARRAY.md +++ b/tevm/docs/utils/variables/KECCAK256_RLP_ARRAY.md @@ -12,4 +12,4 @@ Keccak-256 of an RLP of an empty array ## Defined in -node\_modules/.pnpm/@ethereumjs+util@9.0.3/node\_modules/@ethereumjs/util/dist/esm/constants.d.ts:36 +node\_modules/.pnpm/@ethereumjs+util@9.1.0/node\_modules/@ethereumjs/util/dist/esm/constants.d.ts:36 diff --git a/tevm/docs/vm/functions/txLogsBloom.md b/tevm/docs/vm/functions/txLogsBloom.md index 1407439885..98f6cc3041 100644 --- a/tevm/docs/vm/functions/txLogsBloom.md +++ b/tevm/docs/vm/functions/txLogsBloom.md @@ -18,10 +18,72 @@ Creates a bloom filter from the logs. The logs to create the bloom filter from. -• **common**: [`Common`](../../common/type-aliases/Common.md) +• **common** The common object.')} +• **common.blockExplorers?** + +Collection of block explorers + +• **common.blockExplorers.default**: `ChainBlockExplorer` + +• **common.contracts?** + +Collection of contracts + +• **common.contracts.ensRegistry?**: `ChainContract` + +• **common.contracts.ensUniversalResolver?**: `ChainContract` + +• **common.contracts.multicall3?**: `ChainContract` + +• **common.copy** + +• **common.custom?**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +• **common.ethjsCommon**: `Common` + +• **common.fees?**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +• **common.formatters?**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +• **common.id**: `number` + +ID in number form + +• **common.name**: `string` + +Human-readable name + +• **common.nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +• **common.rpcUrls** + +Collection of RPC endpoints + +• **common.rpcUrls.default**: `ChainRpcUrls` + +• **common.serializers?**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +• **common.sourceId?**: `number` + +Source Chain ID (ie. the L1 chain) + +• **common.testnet?**: `boolean` + +Flag for test networks + ## Returns `Bloom` diff --git a/tevm/docs/vm/interfaces/AfterTxEvent.md b/tevm/docs/vm/interfaces/AfterTxEvent.md index f1db43a22d..29acf571dc 100644 --- a/tevm/docs/vm/interfaces/AfterTxEvent.md +++ b/tevm/docs/vm/interfaces/AfterTxEvent.md @@ -90,7 +90,7 @@ Address of created account during transaction, if any #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:248 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:273 *** @@ -106,7 +106,7 @@ Contains the results from running the code, if any, as described in runCode #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:252 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:277 *** diff --git a/tevm/docs/vm/interfaces/BuilderOpts.md b/tevm/docs/vm/interfaces/BuilderOpts.md index eb663bb417..d68050931c 100644 --- a/tevm/docs/vm/interfaces/BuilderOpts.md +++ b/tevm/docs/vm/interfaces/BuilderOpts.md @@ -54,7 +54,7 @@ packages/block/types/types.d.ts:59 ### common -> **common**: [`Common`](../../common/type-aliases/Common.md) +> **common**: `object` A [Common](../../common/type-aliases/Common.md) object defining the chain and the hardfork a block/block header belongs to. @@ -66,6 +66,118 @@ hardfork in the [Common](../../common/type-aliases/Common.md) class. Current default hardfork: `merge` +#### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +##### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +#### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +#### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +#### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +#### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +#### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +#### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +##### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +#### ethjsCommon + +> **ethjsCommon**: `Common` + +#### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +#### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +#### id + +> **id**: `number` + +ID in number form + +#### name + +> **name**: `string` + +Human-readable name + +#### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +#### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +##### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +#### rpcUrls.default + +> **default**: `ChainRpcUrls` + +#### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +#### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +#### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + #### Inherited from [`BlockOptions`](../../block/interfaces/BlockOptions.md).[`common`](../../block/interfaces/BlockOptions.md#common) diff --git a/tevm/docs/vm/interfaces/RunTxResult.md b/tevm/docs/vm/interfaces/RunTxResult.md index 829534f444..0cd3c0d855 100644 --- a/tevm/docs/vm/interfaces/RunTxResult.md +++ b/tevm/docs/vm/interfaces/RunTxResult.md @@ -78,7 +78,7 @@ Address of created account during transaction, if any #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:248 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:273 *** @@ -94,7 +94,7 @@ Contains the results from running the code, if any, as described in runCode #### Defined in -node\_modules/.pnpm/@ethereumjs+evm@3.0.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:252 +node\_modules/.pnpm/@ethereumjs+evm@3.1.0/node\_modules/@ethereumjs/evm/dist/esm/types.d.ts:277 *** diff --git a/tevm/docs/vm/interfaces/VMOpts.md b/tevm/docs/vm/interfaces/VMOpts.md index 9930b1cd67..29e95de38f 100644 --- a/tevm/docs/vm/interfaces/VMOpts.md +++ b/tevm/docs/vm/interfaces/VMOpts.md @@ -46,7 +46,7 @@ packages/vm/types/utils/VMOpts.d.ts:40 ### common? -> `optional` **common**: [`Common`](../../common/type-aliases/Common.md) +> `optional` **common**: `object` Use a [Common](../../common/type-aliases/Common.md) instance if you want to change the chain setup. @@ -68,6 +68,118 @@ Default setup if no `Common` instance is provided: - `hardfork`: `paris` - `eips`: `[]` +#### blockExplorers? + +> `optional` **blockExplorers**: `object` + +Collection of block explorers + +##### Index Signature + + \[`key`: `string`\]: `ChainBlockExplorer` + +#### blockExplorers.default + +> **default**: `ChainBlockExplorer` + +#### contracts? + +> `optional` **contracts**: `object` + +Collection of contracts + +#### contracts.ensRegistry? + +> `optional` **ensRegistry**: `ChainContract` + +#### contracts.ensUniversalResolver? + +> `optional` **ensUniversalResolver**: `ChainContract` + +#### contracts.multicall3? + +> `optional` **multicall3**: `ChainContract` + +#### copy() + +> **copy**: () => \{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +##### Returns + +\{ blockExplorers?: \{ \[key: string\]: ChainBlockExplorer; default: ChainBlockExplorer; \} \| undefined; contracts?: \{ \[x: string\]: ChainContract \| \{ ...; \} \| undefined; ensRegistry?: ChainContract \| undefined; ensUniversalResolver?: ChainContract \| undefined; multicall3?: ChainContract \| undefined; \} \| undefined; ... 11... + +#### custom? + +> `optional` **custom**: `Record`\<`string`, `unknown`\> + +Custom chain data. + +#### ethjsCommon + +> **ethjsCommon**: `Common` + +#### fees? + +> `optional` **fees**: `ChainFees`\<`undefined` \| `ChainFormatters`\> + +Modifies how fees are derived. + +#### formatters? + +> `optional` **formatters**: `ChainFormatters` + +Modifies how data is formatted and typed (e.g. blocks and transactions) + +#### id + +> **id**: `number` + +ID in number form + +#### name + +> **name**: `string` + +Human-readable name + +#### nativeCurrency + +> **nativeCurrency**: `ChainNativeCurrency` + +Currency used by chain + +#### rpcUrls + +> **rpcUrls**: `object` + +Collection of RPC endpoints + +##### Index Signature + + \[`key`: `string`\]: `ChainRpcUrls` + +#### rpcUrls.default + +> **default**: `ChainRpcUrls` + +#### serializers? + +> `optional` **serializers**: `ChainSerializers`\<`undefined` \| `ChainFormatters`, `TransactionSerializable`\> + +Modifies how data is serialized (e.g. transactions). + +#### sourceId? + +> `optional` **sourceId**: `number` + +Source Chain ID (ie. the L1 chain) + +#### testnet? + +> `optional` **testnet**: `boolean` + +Flag for test networks + #### Defined in packages/vm/types/utils/VMOpts.d.ts:32 diff --git a/tevm/index.ts b/tevm/index.ts index a13d2c5729..e27df5b1fc 100644 --- a/tevm/index.ts +++ b/tevm/index.ts @@ -59,12 +59,10 @@ definePredeploy, export { type Contract, -type CreateScript, type ReadActionCreator, type EventActionCreator, type WriteActionCreator, type CreateContractParams, -type DeployArgs, createContract, } from "@tevm/contract"; diff --git a/tevm/package.json b/tevm/package.json index 8d3adc4803..306fd0569d 100644 --- a/tevm/package.json +++ b/tevm/package.json @@ -21,6 +21,7 @@ "contributors": [ "Will Cory " ], + "sideEffects": false, "type": "module", "exports": { "./package.json": "./package.json", @@ -475,6 +476,5 @@ }, "publishConfig": { "access": "public" - }, - "sideEffects": false + } } \ No newline at end of file