From 43d6702cf940929e467a346dc8addf5d6d413976 Mon Sep 17 00:00:00 2001 From: Will Cory Date: Mon, 23 Oct 2023 19:34:48 -0700 Subject: [PATCH] :bug: fix: Typedoc doc generation bugs (#604) ## Description - Bad public path - More explicit entrypoints ## Testing Explain the quality checks that have been done on the code changes ## Additional Information - [ ] I read the [contributing docs](../docs/contributing.md) (if this is your first contribution) Your ENS/address: Co-authored-by: Will Cory --- .github/workflows/test.yml | 18 + blockexplorer/doc/README.md | 2 +- .../doc/classes/SafeStandardBlockExplorer.md | 20 +- .../doc/classes/StandardBlockExplorer.md | 24 +- .../doc/interfaces/BlockExplorerOptions.md | 8 +- blockexplorer/doc/modules.md | 12 +- blockexplorer/typedoc.json | 3 +- bundlers/bun/docs/README.md | 2 +- bundlers/bun/docs/modules.md | 4 +- bundlers/bun/typedoc.json | 1 - bundlers/bundler/typedoc.json | 6 +- bundlers/esbuild/docs/README.md | 2 +- bundlers/esbuild/docs/modules.md | 4 +- bundlers/esbuild/typedoc.json | 1 - bundlers/rollup/docs/README.md | 2 +- bundlers/rollup/docs/modules.md | 4 +- bundlers/rollup/typedoc.json | 1 - bundlers/rspack/docs/README.md | 2 +- bundlers/rspack/docs/modules.md | 4 +- bundlers/rspack/typedoc.json | 1 - bundlers/unplugin/docs/README.md | 2 +- bundlers/unplugin/docs/modules.md | 8 +- bundlers/unplugin/typedoc.json | 1 - bundlers/vite/docs/README.md | 2 +- bundlers/vite/docs/modules.md | 4 +- bundlers/vite/typedoc.json | 1 - bundlers/webpack/docs/README.md | 2 +- bundlers/webpack/docs/modules.md | 4 +- bundlers/webpack/typedoc.json | 1 - config/docs/README.md | 2 +- .../classes/defineConfig.DefineConfigError.md | 196 +++++ .../classes/loadConfig.LoadConfigError.md | 196 +++++ config/docs/modules.md | 152 +--- config/docs/modules/defaultConfig.md | 29 + config/docs/modules/defineConfig.md | 51 ++ config/docs/modules/loadConfig.md | 60 ++ config/docs/modules/types.md | 124 +++ config/src/defaultConfig.js | 1 + config/src/index.js | 2 +- config/typedoc.json | 8 +- core/docs/README.md | 2 +- core/docs/modules.md | 16 +- core/typedoc.json | 1 - effect/docs/README.md | 2 +- effect/docs/classes/CreateRequireError.md | 20 +- effect/docs/classes/ParseJsonError.md | 20 +- effect/docs/classes/RequireError.md | 20 +- effect/docs/modules.md | 24 +- effect/typedoc.json | 1 - ethers/docs/README.md | 2 +- ethers/docs/modules.md | 14 +- ethers/typedoc.json | 1 - revm/docs/README.md | 2 +- revm/docs/classes/EVM.md | 12 +- revm/docs/modules.md | 4 +- revm/typedoc.json | 1 - runtime/docs/README.md | 2 +- runtime/docs/modules.md | 14 +- runtime/typedoc.json | 1 - schemas/docs/README.md | 2 +- .../classes/common.InvalidBlockNumberError.md | 20 +- .../docs/classes/common.InvalidUrlError.md | 20 +- .../classes/ethereum.InvalidAddressError.md | 20 +- .../classes/ethereum.InvalidBytesError.md | 20 +- .../ethereum.InvalidBytesFixedError.md | 22 +- .../docs/classes/ethereum.InvalidINTError.md | 22 +- .../docs/classes/ethereum.InvalidUINTError.md | 22 +- .../classes/evmts.InvalidAddressBookError.md | 20 +- .../docs/interfaces/ethereum.SchemaOptions.md | 6 +- .../docs/interfaces/evmts.AddressBookEntry.md | 8 +- schemas/docs/modules.md | 10 +- schemas/docs/modules/common.md | 34 +- schemas/docs/modules/ethereum.md | 746 +++++++++--------- schemas/docs/modules/evmts.md | 32 +- schemas/docs/modules/types.md | 12 +- schemas/typedoc.json | 1 - solc/docs/README.md | 2 +- solc/docs/interfaces/types.ModuleInfo.md | 16 +- solc/docs/modules.md | 10 +- solc/docs/modules/resolveArtifacts.md | 12 +- solc/docs/modules/resolveArtifactsSync.md | 12 +- solc/docs/modules/solc.md | 6 +- solc/docs/modules/types.md | 14 +- solc/typedoc.json | 1 - ts-plugin/docs/README.md | 2 +- ts-plugin/docs/modules.md | 4 +- ts-plugin/typedoc.json | 1 - 87 files changed, 1371 insertions(+), 852 deletions(-) create mode 100644 config/docs/classes/defineConfig.DefineConfigError.md create mode 100644 config/docs/classes/loadConfig.LoadConfigError.md create mode 100644 config/docs/modules/defaultConfig.md create mode 100644 config/docs/modules/defineConfig.md create mode 100644 config/docs/modules/loadConfig.md create mode 100644 config/docs/modules/types.md create mode 100644 config/src/defaultConfig.js diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 9c540b9f15..d8e72778f9 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -80,3 +80,21 @@ jobs: with: name: "@evmts/blockexplorer" working-directory: "./blockexplorer" + - name: 'Report @evmts/runtime Coverage' + if: always() # Also generate the report if tests are failing + uses: davelosert/vitest-coverage-report-action@v2 + with: + name: "@evmts/runtime" + working-directory: "./runtime" + - name: 'Report @evmts/solc Coverage' + if: always() # Also generate the report if tests are failing + uses: davelosert/vitest-coverage-report-action@v2 + with: + name: "@evmts/solc" + working-directory: "./solc" + - name: 'Report @evmts/unplugin Coverage' + if: always() # Also generate the report if tests are failing + uses: davelosert/vitest-coverage-report-action@v2 + with: + name: "@evmts/unplugin" + working-directory: "./bundlers/unplugin" diff --git a/blockexplorer/doc/README.md b/blockexplorer/doc/README.md index 70451e9da3..6ff24b26af 100644 --- a/blockexplorer/doc/README.md +++ b/blockexplorer/doc/README.md @@ -1,4 +1,4 @@ -@evmts/blockexplorer / [Exports](/reference/blockexplorer/modules.md) +@evmts/blockexplorer / [Exports](modules.md)

diff --git a/blockexplorer/doc/classes/SafeStandardBlockExplorer.md b/blockexplorer/doc/classes/SafeStandardBlockExplorer.md index 646285eec4..3a3d5adbff 100644 --- a/blockexplorer/doc/classes/SafeStandardBlockExplorer.md +++ b/blockexplorer/doc/classes/SafeStandardBlockExplorer.md @@ -1,4 +1,4 @@ -[@evmts/blockexplorer](/reference/blockexplorer/README.md) / [Exports](/reference/blockexplorer/modules.md) / SafeStandardBlockExplorer +[@evmts/blockexplorer](../README.md) / [Exports](../modules.md) / SafeStandardBlockExplorer # Class: SafeStandardBlockExplorer @@ -22,20 +22,20 @@ const txUrlEffect = etherscan.getTxUrl('0x1234') ### Constructors -- [constructor](/reference/blockexplorer/classes/SafeStandardBlockExplorer.md#constructor) +- [constructor](SafeStandardBlockExplorer.md#constructor) ### Properties -- [chainId](/reference/blockexplorer/classes/SafeStandardBlockExplorer.md#chainid) -- [name](/reference/blockexplorer/classes/SafeStandardBlockExplorer.md#name) -- [url](/reference/blockexplorer/classes/SafeStandardBlockExplorer.md#url) -- [ERRORS](/reference/blockexplorer/classes/SafeStandardBlockExplorer.md#errors) +- [chainId](SafeStandardBlockExplorer.md#chainid) +- [name](SafeStandardBlockExplorer.md#name) +- [url](SafeStandardBlockExplorer.md#url) +- [ERRORS](SafeStandardBlockExplorer.md#errors) ### Methods -- [getAddressUrl](/reference/blockexplorer/classes/SafeStandardBlockExplorer.md#getaddressurl) -- [getBlockUrl](/reference/blockexplorer/classes/SafeStandardBlockExplorer.md#getblockurl) -- [getTxUrl](/reference/blockexplorer/classes/SafeStandardBlockExplorer.md#gettxurl) +- [getAddressUrl](SafeStandardBlockExplorer.md#getaddressurl) +- [getBlockUrl](SafeStandardBlockExplorer.md#getblockurl) +- [getTxUrl](SafeStandardBlockExplorer.md#gettxurl) ## Constructors @@ -47,7 +47,7 @@ const txUrlEffect = etherscan.getTxUrl('0x1234') | Name | Type | Description | | :------ | :------ | :------ | -| `options` | [`BlockExplorerOptions`](/reference/blockexplorer/interfaces/BlockExplorerOptions.md) | The options for the BlockExplorer. | +| `options` | [`BlockExplorerOptions`](../interfaces/BlockExplorerOptions.md) | The options for the BlockExplorer. | #### Defined in diff --git a/blockexplorer/doc/classes/StandardBlockExplorer.md b/blockexplorer/doc/classes/StandardBlockExplorer.md index 74da043e57..2dba3b8639 100644 --- a/blockexplorer/doc/classes/StandardBlockExplorer.md +++ b/blockexplorer/doc/classes/StandardBlockExplorer.md @@ -1,4 +1,4 @@ -[@evmts/blockexplorer](/reference/blockexplorer/README.md) / [Exports](/reference/blockexplorer/modules.md) / StandardBlockExplorer +[@evmts/blockexplorer](../README.md) / [Exports](../modules.md) / StandardBlockExplorer # Class: StandardBlockExplorer @@ -21,21 +21,21 @@ const txUrl = etherscan.getTxUrl('0x1234') ### Constructors -- [constructor](/reference/blockexplorer/classes/StandardBlockExplorer.md#constructor) +- [constructor](StandardBlockExplorer.md#constructor) ### Properties -- [chainId](/reference/blockexplorer/classes/StandardBlockExplorer.md#chainid) -- [name](/reference/blockexplorer/classes/StandardBlockExplorer.md#name) -- [safeBlockExplorer](/reference/blockexplorer/classes/StandardBlockExplorer.md#safeblockexplorer) -- [url](/reference/blockexplorer/classes/StandardBlockExplorer.md#url) -- [ERRORS](/reference/blockexplorer/classes/StandardBlockExplorer.md#errors) +- [chainId](StandardBlockExplorer.md#chainid) +- [name](StandardBlockExplorer.md#name) +- [safeBlockExplorer](StandardBlockExplorer.md#safeblockexplorer) +- [url](StandardBlockExplorer.md#url) +- [ERRORS](StandardBlockExplorer.md#errors) ### Methods -- [getAddressUrl](/reference/blockexplorer/classes/StandardBlockExplorer.md#getaddressurl) -- [getBlockUrl](/reference/blockexplorer/classes/StandardBlockExplorer.md#getblockurl) -- [getTxUrl](/reference/blockexplorer/classes/StandardBlockExplorer.md#gettxurl) +- [getAddressUrl](StandardBlockExplorer.md#getaddressurl) +- [getBlockUrl](StandardBlockExplorer.md#getblockurl) +- [getTxUrl](StandardBlockExplorer.md#gettxurl) ## Constructors @@ -47,7 +47,7 @@ const txUrl = etherscan.getTxUrl('0x1234') | Name | Type | Description | | :------ | :------ | :------ | -| `options` | [`BlockExplorerOptions`](/reference/blockexplorer/interfaces/BlockExplorerOptions.md) | The options for the BlockExplorer. | +| `options` | [`BlockExplorerOptions`](../interfaces/BlockExplorerOptions.md) | The options for the BlockExplorer. | #### Defined in @@ -77,7 +77,7 @@ ___ ### safeBlockExplorer -• **safeBlockExplorer**: [`SafeStandardBlockExplorer`](/reference/blockexplorer/classes/SafeStandardBlockExplorer.md) +• **safeBlockExplorer**: [`SafeStandardBlockExplorer`](SafeStandardBlockExplorer.md) #### Defined in diff --git a/blockexplorer/doc/interfaces/BlockExplorerOptions.md b/blockexplorer/doc/interfaces/BlockExplorerOptions.md index 485a153070..765c0a5bd0 100644 --- a/blockexplorer/doc/interfaces/BlockExplorerOptions.md +++ b/blockexplorer/doc/interfaces/BlockExplorerOptions.md @@ -1,4 +1,4 @@ -[@evmts/blockexplorer](/reference/blockexplorer/README.md) / [Exports](/reference/blockexplorer/modules.md) / BlockExplorerOptions +[@evmts/blockexplorer](../README.md) / [Exports](../modules.md) / BlockExplorerOptions # Interface: BlockExplorerOptions<\> @@ -6,9 +6,9 @@ ### Properties -- [chainId](/reference/blockexplorer/interfaces/BlockExplorerOptions.md#chainid) -- [name](/reference/blockexplorer/interfaces/BlockExplorerOptions.md#name) -- [url](/reference/blockexplorer/interfaces/BlockExplorerOptions.md#url) +- [chainId](BlockExplorerOptions.md#chainid) +- [name](BlockExplorerOptions.md#name) +- [url](BlockExplorerOptions.md#url) ## Properties diff --git a/blockexplorer/doc/modules.md b/blockexplorer/doc/modules.md index 45e6eee161..9ee5b6bd8e 100644 --- a/blockexplorer/doc/modules.md +++ b/blockexplorer/doc/modules.md @@ -1,4 +1,4 @@ -[@evmts/blockexplorer](/reference/blockexplorer/README.md) / Exports +[@evmts/blockexplorer](README.md) / Exports # @evmts/blockexplorer @@ -6,17 +6,17 @@ ### Classes -- [SafeStandardBlockExplorer](/reference/blockexplorer/classes/SafeStandardBlockExplorer.md) -- [StandardBlockExplorer](/reference/blockexplorer/classes/StandardBlockExplorer.md) +- [SafeStandardBlockExplorer](classes/SafeStandardBlockExplorer.md) +- [StandardBlockExplorer](classes/StandardBlockExplorer.md) ### Interfaces -- [BlockExplorerOptions](/reference/blockexplorer/interfaces/BlockExplorerOptions.md) +- [BlockExplorerOptions](interfaces/BlockExplorerOptions.md) ### Type Aliases -- [Address](/reference/blockexplorer/modules.md#address) -- [Hex](/reference/blockexplorer/modules.md#hex) +- [Address](modules.md#address) +- [Hex](modules.md#hex) ## Type Aliases diff --git a/blockexplorer/typedoc.json b/blockexplorer/typedoc.json index fd3420dcb3..c94b5c3ee2 100644 --- a/blockexplorer/typedoc.json +++ b/blockexplorer/typedoc.json @@ -1,8 +1,7 @@ { "$schema": "https://typedoc.org/schema.json", "out": "./doc", - "entryPoints": ["./src/index.js"], - "publicPath": "/reference/blockexplorer/", + "entryPoints": ["./src/blockExplorer.js"], "plugin": ["typedoc-plugin-markdown"], "gitRevision": "main" } diff --git a/bundlers/bun/docs/README.md b/bundlers/bun/docs/README.md index 02aa8b0422..18284706fe 100644 --- a/bundlers/bun/docs/README.md +++ b/bundlers/bun/docs/README.md @@ -1,4 +1,4 @@ -@evmts/bun-plugin / [Exports](/reference/bun-plugin/modules.md) +@evmts/bun-plugin / [Exports](modules.md) # @evmts/plugin-bun diff --git a/bundlers/bun/docs/modules.md b/bundlers/bun/docs/modules.md index c0ab920266..b95da4f4d1 100644 --- a/bundlers/bun/docs/modules.md +++ b/bundlers/bun/docs/modules.md @@ -1,4 +1,4 @@ -[@evmts/bun-plugin](/reference/bun-plugin/README.md) / Exports +[@evmts/bun-plugin](README.md) / Exports # @evmts/bun-plugin @@ -6,7 +6,7 @@ ### Functions -- [evmtsBunPlugin](/reference/bun-plugin/modules.md#evmtsbunplugin) +- [evmtsBunPlugin](modules.md#evmtsbunplugin) ## Functions diff --git a/bundlers/bun/typedoc.json b/bundlers/bun/typedoc.json index 22ae464e35..d78cdfd822 100644 --- a/bundlers/bun/typedoc.json +++ b/bundlers/bun/typedoc.json @@ -2,7 +2,6 @@ "$schema": "https://typedoc.org/schema.json", "out": "./docs", "entryPoints": ["./src/index.js"], - "publicPath": "/reference/bun-plugin/", "plugin": ["typedoc-plugin-markdown"], "gitRevision": "main" } diff --git a/bundlers/bundler/typedoc.json b/bundlers/bundler/typedoc.json index d3c2a350fd..8aa13911af 100644 --- a/bundlers/bundler/typedoc.json +++ b/bundlers/bundler/typedoc.json @@ -4,12 +4,8 @@ "entryPoints": [ "./src/bundler.js", "./src/createCache.js", - "./src/unplugin.js", - "./src/runtime/index.js", - "./src/solc/index.js", - "./src/utils/index.js" + "./src/solc/types.js" ], - "publicPath": "/reference/bundler/", "plugin": ["typedoc-plugin-markdown"], "gitRevision": "main" } diff --git a/bundlers/esbuild/docs/README.md b/bundlers/esbuild/docs/README.md index 0dbcc36fcf..7a546a0ca9 100644 --- a/bundlers/esbuild/docs/README.md +++ b/bundlers/esbuild/docs/README.md @@ -1,4 +1,4 @@ -@evmts/esbuild-plugin / [Exports](/reference/esbuild-plugin/modules.md) +@evmts/esbuild-plugin / [Exports](modules.md) # @evmts/plugin diff --git a/bundlers/esbuild/docs/modules.md b/bundlers/esbuild/docs/modules.md index b01bd7e01e..44c2229f0b 100644 --- a/bundlers/esbuild/docs/modules.md +++ b/bundlers/esbuild/docs/modules.md @@ -1,4 +1,4 @@ -[@evmts/esbuild-plugin](/reference/esbuild-plugin/README.md) / Exports +[@evmts/esbuild-plugin](README.md) / Exports # @evmts/esbuild-plugin @@ -6,7 +6,7 @@ ### Functions -- [esbuildPluginEvmts](/reference/esbuild-plugin/modules.md#esbuildpluginevmts) +- [esbuildPluginEvmts](modules.md#esbuildpluginevmts) ## Functions diff --git a/bundlers/esbuild/typedoc.json b/bundlers/esbuild/typedoc.json index 9c5e425992..d78cdfd822 100644 --- a/bundlers/esbuild/typedoc.json +++ b/bundlers/esbuild/typedoc.json @@ -2,7 +2,6 @@ "$schema": "https://typedoc.org/schema.json", "out": "./docs", "entryPoints": ["./src/index.js"], - "publicPath": "/reference/esbuild-plugin/", "plugin": ["typedoc-plugin-markdown"], "gitRevision": "main" } diff --git a/bundlers/rollup/docs/README.md b/bundlers/rollup/docs/README.md index 9b2ee978ef..80a2efd7eb 100644 --- a/bundlers/rollup/docs/README.md +++ b/bundlers/rollup/docs/README.md @@ -1,4 +1,4 @@ -@evmts/rollup-plugin / [Exports](/reference/rollup-plugin/modules.md) +@evmts/rollup-plugin / [Exports](modules.md) # @evmts/plugin diff --git a/bundlers/rollup/docs/modules.md b/bundlers/rollup/docs/modules.md index 1341ce8551..6bd96347a3 100644 --- a/bundlers/rollup/docs/modules.md +++ b/bundlers/rollup/docs/modules.md @@ -1,4 +1,4 @@ -[@evmts/rollup-plugin](/reference/rollup-plugin/README.md) / Exports +[@evmts/rollup-plugin](README.md) / Exports # @evmts/rollup-plugin @@ -6,7 +6,7 @@ ### Functions -- [rollupPluginEvmts](/reference/rollup-plugin/modules.md#rolluppluginevmts) +- [rollupPluginEvmts](modules.md#rolluppluginevmts) ## Functions diff --git a/bundlers/rollup/typedoc.json b/bundlers/rollup/typedoc.json index ecd6136eff..d78cdfd822 100644 --- a/bundlers/rollup/typedoc.json +++ b/bundlers/rollup/typedoc.json @@ -2,7 +2,6 @@ "$schema": "https://typedoc.org/schema.json", "out": "./docs", "entryPoints": ["./src/index.js"], - "publicPath": "/reference/rollup-plugin/", "plugin": ["typedoc-plugin-markdown"], "gitRevision": "main" } diff --git a/bundlers/rspack/docs/README.md b/bundlers/rspack/docs/README.md index 7b6be27597..93d59979cb 100644 --- a/bundlers/rspack/docs/README.md +++ b/bundlers/rspack/docs/README.md @@ -1,4 +1,4 @@ -@evmts/rspack-plugin / [Exports](/reference/rspack-plugin/modules.md) +@evmts/rspack-plugin / [Exports](modules.md) # @evmts/rspack-plugin diff --git a/bundlers/rspack/docs/modules.md b/bundlers/rspack/docs/modules.md index ee202b6314..316035853d 100644 --- a/bundlers/rspack/docs/modules.md +++ b/bundlers/rspack/docs/modules.md @@ -1,4 +1,4 @@ -[@evmts/rspack-plugin](/reference/rspack-plugin/README.md) / Exports +[@evmts/rspack-plugin](README.md) / Exports # @evmts/rspack-plugin @@ -6,7 +6,7 @@ ### Functions -- [rspackPluginEvmts](/reference/rspack-plugin/modules.md#rspackpluginevmts) +- [rspackPluginEvmts](modules.md#rspackpluginevmts) ## Functions diff --git a/bundlers/rspack/typedoc.json b/bundlers/rspack/typedoc.json index d67e38042a..d78cdfd822 100644 --- a/bundlers/rspack/typedoc.json +++ b/bundlers/rspack/typedoc.json @@ -2,7 +2,6 @@ "$schema": "https://typedoc.org/schema.json", "out": "./docs", "entryPoints": ["./src/index.js"], - "publicPath": "/reference/rspack-plugin/", "plugin": ["typedoc-plugin-markdown"], "gitRevision": "main" } diff --git a/bundlers/unplugin/docs/README.md b/bundlers/unplugin/docs/README.md index 52b381866f..031351b56f 100644 --- a/bundlers/unplugin/docs/README.md +++ b/bundlers/unplugin/docs/README.md @@ -1,4 +1,4 @@ -@evmts/unplugin / [Exports](/reference/unplugin/modules.md) +@evmts/unplugin / [Exports](modules.md)

diff --git a/bundlers/unplugin/docs/modules.md b/bundlers/unplugin/docs/modules.md index 877422c778..063c8f7080 100644 --- a/bundlers/unplugin/docs/modules.md +++ b/bundlers/unplugin/docs/modules.md @@ -1,4 +1,4 @@ -[@evmts/unplugin](/reference/unplugin/README.md) / Exports +[@evmts/unplugin](README.md) / Exports # @evmts/unplugin @@ -6,12 +6,12 @@ ### Type Aliases -- [CompilerOption](/reference/unplugin/modules.md#compileroption) +- [CompilerOption](modules.md#compileroption) ### Functions -- [createUnplugin](/reference/unplugin/modules.md#createunplugin) -- [evmtsUnplugin](/reference/unplugin/modules.md#evmtsunplugin) +- [createUnplugin](modules.md#createunplugin) +- [evmtsUnplugin](modules.md#evmtsunplugin) ## Type Aliases diff --git a/bundlers/unplugin/typedoc.json b/bundlers/unplugin/typedoc.json index 971aa00963..d78cdfd822 100644 --- a/bundlers/unplugin/typedoc.json +++ b/bundlers/unplugin/typedoc.json @@ -2,7 +2,6 @@ "$schema": "https://typedoc.org/schema.json", "out": "./docs", "entryPoints": ["./src/index.js"], - "publicPath": "/reference/unplugin/", "plugin": ["typedoc-plugin-markdown"], "gitRevision": "main" } diff --git a/bundlers/vite/docs/README.md b/bundlers/vite/docs/README.md index d67d971078..06fc969782 100644 --- a/bundlers/vite/docs/README.md +++ b/bundlers/vite/docs/README.md @@ -1,4 +1,4 @@ -@evmts/vite-plugin / [Exports](/reference/vite-plugin/modules.md) +@evmts/vite-plugin / [Exports](modules.md) # @evmts/plugin diff --git a/bundlers/vite/docs/modules.md b/bundlers/vite/docs/modules.md index be5236cda3..41ec3e85e1 100644 --- a/bundlers/vite/docs/modules.md +++ b/bundlers/vite/docs/modules.md @@ -1,4 +1,4 @@ -[@evmts/vite-plugin](/reference/vite-plugin/README.md) / Exports +[@evmts/vite-plugin](README.md) / Exports # @evmts/vite-plugin @@ -6,7 +6,7 @@ ### Functions -- [vitePluginEvmts](/reference/vite-plugin/modules.md#vitepluginevmts) +- [vitePluginEvmts](modules.md#vitepluginevmts) ## Functions diff --git a/bundlers/vite/typedoc.json b/bundlers/vite/typedoc.json index f7bcfd867f..d78cdfd822 100644 --- a/bundlers/vite/typedoc.json +++ b/bundlers/vite/typedoc.json @@ -2,7 +2,6 @@ "$schema": "https://typedoc.org/schema.json", "out": "./docs", "entryPoints": ["./src/index.js"], - "publicPath": "/reference/vite-plugin/", "plugin": ["typedoc-plugin-markdown"], "gitRevision": "main" } diff --git a/bundlers/webpack/docs/README.md b/bundlers/webpack/docs/README.md index 159d070a16..ab7a0eb36c 100644 --- a/bundlers/webpack/docs/README.md +++ b/bundlers/webpack/docs/README.md @@ -1,4 +1,4 @@ -@evmts/webpack-plugin / [Exports](/reference/webpack-plugin/modules.md) +@evmts/webpack-plugin / [Exports](modules.md) # @evmts/plugin diff --git a/bundlers/webpack/docs/modules.md b/bundlers/webpack/docs/modules.md index 296020d0d0..3986c3123d 100644 --- a/bundlers/webpack/docs/modules.md +++ b/bundlers/webpack/docs/modules.md @@ -1,4 +1,4 @@ -[@evmts/webpack-plugin](/reference/webpack-plugin/README.md) / Exports +[@evmts/webpack-plugin](README.md) / Exports # @evmts/webpack-plugin @@ -6,7 +6,7 @@ ### Functions -- [webpackPluginEvmts](/reference/webpack-plugin/modules.md#webpackpluginevmts) +- [webpackPluginEvmts](modules.md#webpackpluginevmts) ## Functions diff --git a/bundlers/webpack/typedoc.json b/bundlers/webpack/typedoc.json index 578be53dd2..d78cdfd822 100644 --- a/bundlers/webpack/typedoc.json +++ b/bundlers/webpack/typedoc.json @@ -2,7 +2,6 @@ "$schema": "https://typedoc.org/schema.json", "out": "./docs", "entryPoints": ["./src/index.js"], - "publicPath": "/reference/webpack-plugin/", "plugin": ["typedoc-plugin-markdown"], "gitRevision": "main" } diff --git a/config/docs/README.md b/config/docs/README.md index 71c9b72c1d..621ce9ae53 100644 --- a/config/docs/README.md +++ b/config/docs/README.md @@ -1,4 +1,4 @@ -@evmts/config / [Exports](/reference/config/modules.md) +@evmts/config / [Modules](modules.md)

diff --git a/config/docs/classes/defineConfig.DefineConfigError.md b/config/docs/classes/defineConfig.DefineConfigError.md new file mode 100644 index 0000000000..2d93a68c6b --- /dev/null +++ b/config/docs/classes/defineConfig.DefineConfigError.md @@ -0,0 +1,196 @@ +[@evmts/config](../README.md) / [Modules](../modules.md) / [defineConfig](../modules/defineConfig.md) / DefineConfigError + +# Class: DefineConfigError + +[defineConfig](../modules/defineConfig.md).DefineConfigError + +Error class for [defineConfig](../modules/defineConfig.md#defineconfig) + +## Hierarchy + +- `Error` + + ↳ **`DefineConfigError`** + +## Table of contents + +### Constructors + +- [constructor](defineConfig.DefineConfigError.md#constructor) + +### Properties + +- [\_tag](defineConfig.DefineConfigError.md#_tag) +- [cause](defineConfig.DefineConfigError.md#cause) +- [message](defineConfig.DefineConfigError.md#message) +- [name](defineConfig.DefineConfigError.md#name) +- [stack](defineConfig.DefineConfigError.md#stack) +- [prepareStackTrace](defineConfig.DefineConfigError.md#preparestacktrace) +- [stackTraceLimit](defineConfig.DefineConfigError.md#stacktracelimit) + +### Methods + +- [captureStackTrace](defineConfig.DefineConfigError.md#capturestacktrace) + +## Constructors + +### constructor + +• **new DefineConfigError**(`configFilePath`, `underlyingError`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `configFilePath` | `string` | +| `underlyingError` | [`DefineConfigErrorType`](../modules/types.md#defineconfigerrortype) | + +#### Overrides + +Error.constructor + +#### Defined in + +[config/src/defineConfig.js:26](https://github.com/evmts/evmts-monorepo/blob/main/config/src/defineConfig.js#L26) + +## Properties + +### \_tag + +• **\_tag**: ``"ConfigFnThrowError"`` \| ``"InvalidConfigError"`` \| ``"FoundryNotFoundError"`` \| ``"FoundryConfigError"`` \| ``"InvalidRemappingsError"`` + +#### Defined in + +[config/src/defineConfig.js:21](https://github.com/evmts/evmts-monorepo/blob/main/config/src/defineConfig.js#L21) + +___ + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +node_modules/typescript/lib/lib.es2022.error.d.ts:24 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1068 + +___ + +### name + +• **name**: ``"ConfigFnThrowError"`` \| ``"InvalidConfigError"`` \| ``"FoundryNotFoundError"`` \| ``"FoundryConfigError"`` \| ``"InvalidRemappingsError"`` + +#### Overrides + +Error.name + +#### Defined in + +[config/src/defineConfig.js:17](https://github.com/evmts/evmts-monorepo/blob/main/config/src/defineConfig.js#L17) + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1069 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +Optional override for formatting stack traces + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:11 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:13 + +## Methods + +### captureStackTrace + +▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:4 diff --git a/config/docs/classes/loadConfig.LoadConfigError.md b/config/docs/classes/loadConfig.LoadConfigError.md new file mode 100644 index 0000000000..63ede68a6e --- /dev/null +++ b/config/docs/classes/loadConfig.LoadConfigError.md @@ -0,0 +1,196 @@ +[@evmts/config](../README.md) / [Modules](../modules.md) / [loadConfig](../modules/loadConfig.md) / LoadConfigError + +# Class: LoadConfigError + +[loadConfig](../modules/loadConfig.md).LoadConfigError + +Error class for [loadConfig](../modules/loadConfig.md#loadconfig) + +## Hierarchy + +- `Error` + + ↳ **`LoadConfigError`** + +## Table of contents + +### Constructors + +- [constructor](loadConfig.LoadConfigError.md#constructor) + +### Properties + +- [\_tag](loadConfig.LoadConfigError.md#_tag) +- [cause](loadConfig.LoadConfigError.md#cause) +- [message](loadConfig.LoadConfigError.md#message) +- [name](loadConfig.LoadConfigError.md#name) +- [stack](loadConfig.LoadConfigError.md#stack) +- [prepareStackTrace](loadConfig.LoadConfigError.md#preparestacktrace) +- [stackTraceLimit](loadConfig.LoadConfigError.md#stacktracelimit) + +### Methods + +- [captureStackTrace](loadConfig.LoadConfigError.md#capturestacktrace) + +## Constructors + +### constructor + +• **new LoadConfigError**(`configFilePath`, `underlyingError`) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `configFilePath` | `string` | +| `underlyingError` | [`LoadConfigErrorType`](../modules/loadConfig.md#loadconfigerrortype) | + +#### Overrides + +Error.constructor + +#### Defined in + +[config/src/loadConfig.js:36](https://github.com/evmts/evmts-monorepo/blob/main/config/src/loadConfig.js#L36) + +## Properties + +### \_tag + +• **\_tag**: ``"ConfigFnThrowError"`` \| ``"InvalidConfigError"`` \| ``"FoundryNotFoundError"`` \| ``"FoundryConfigError"`` \| ``"InvalidRemappingsError"`` \| ``"FailedToReadConfigError"`` \| ``"ParseJsonError"`` \| ``"NoPluginFoundError"`` + +#### Defined in + +[config/src/loadConfig.js:31](https://github.com/evmts/evmts-monorepo/blob/main/config/src/loadConfig.js#L31) + +___ + +### cause + +• `Optional` **cause**: `unknown` + +#### Inherited from + +Error.cause + +#### Defined in + +node_modules/typescript/lib/lib.es2022.error.d.ts:24 + +___ + +### message + +• **message**: `string` + +#### Inherited from + +Error.message + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1068 + +___ + +### name + +• **name**: ``"ConfigFnThrowError"`` \| ``"InvalidConfigError"`` \| ``"FoundryNotFoundError"`` \| ``"FoundryConfigError"`` \| ``"InvalidRemappingsError"`` \| ``"FailedToReadConfigError"`` \| ``"ParseJsonError"`` \| ``"NoPluginFoundError"`` + +#### Overrides + +Error.name + +#### Defined in + +[config/src/loadConfig.js:27](https://github.com/evmts/evmts-monorepo/blob/main/config/src/loadConfig.js#L27) + +___ + +### stack + +• `Optional` **stack**: `string` + +#### Inherited from + +Error.stack + +#### Defined in + +node_modules/typescript/lib/lib.es5.d.ts:1069 + +___ + +### prepareStackTrace + +▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` + +#### Type declaration + +▸ (`err`, `stackTraces`): `any` + +Optional override for formatting stack traces + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `err` | `Error` | +| `stackTraces` | `CallSite`[] | + +##### Returns + +`any` + +**`See`** + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Inherited from + +Error.prepareStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:11 + +___ + +### stackTraceLimit + +▪ `Static` **stackTraceLimit**: `number` + +#### Inherited from + +Error.stackTraceLimit + +#### Defined in + +node_modules/@types/node/globals.d.ts:13 + +## Methods + +### captureStackTrace + +▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Create .stack property on a target object + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `targetObject` | `object` | +| `constructorOpt?` | `Function` | + +#### Returns + +`void` + +#### Inherited from + +Error.captureStackTrace + +#### Defined in + +node_modules/@types/node/globals.d.ts:4 diff --git a/config/docs/modules.md b/config/docs/modules.md index e7cf010252..7264946bfa 100644 --- a/config/docs/modules.md +++ b/config/docs/modules.md @@ -1,152 +1,12 @@ -[@evmts/config](/reference/config/README.md) / Exports +[@evmts/config](README.md) / Modules # @evmts/config ## Table of contents -### Type Aliases +### Modules -- [CompilerConfig](/reference/config/modules.md#compilerconfig) -- [ResolvedCompilerConfig](/reference/config/modules.md#resolvedcompilerconfig) - -### Variables - -- [defaultConfig](/reference/config/modules.md#defaultconfig) - -### Functions - -- [defineConfig](/reference/config/modules.md#defineconfig) -- [loadConfig](/reference/config/modules.md#loadconfig) - -## Type Aliases - -### CompilerConfig - -Ƭ **CompilerConfig**: `Object` - -Configuration of the solidity compiler -When resolved with defaults it is a [ResolvedCompilerConfig](/reference/config/modules.md#resolvedcompilerconfig) - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `foundryProject?` | `boolean` \| `string` | If set to true it will resolve forge remappings and libs Set to "path/to/forge/executable" to use a custom forge executable | -| `libs?` | readonly `string`[] | Sets directories to search for solidity imports in Read autoamtically for forge projects if forge: true | -| `remappings?` | `ReadonlyRecord`<`string`\> | Remap the location of contracts | - -#### Defined in - -[types.ts:11](https://github.com/evmts/evmts-monorepo/blob/main/config/src/types.ts#L11) - -___ - -### ResolvedCompilerConfig - -Ƭ **ResolvedCompilerConfig**: `Object` - -A fully resolved compiler config with defaults filled in -See [CompilerConfig](/reference/config/modules.md#compilerconfig) - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `foundryProject` | `boolean` \| `string` | If set to true it will resolve forge remappings and libs Set to "path/to/forge/executable" to use a custom forge executable | -| `libs` | readonly `string`[] | Sets directories to search for solidity imports in Read autoamtically for forge projects if forge: true | -| `remappings` | `ReadonlyRecord`<`string`\> | Remap the location of contracts | - -#### Defined in - -[types.ts:37](https://github.com/evmts/evmts-monorepo/blob/main/config/src/types.ts#L37) - -## Variables - -### defaultConfig - -• `Const` **defaultConfig**: `Object` - -The default CompilerConfig - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `foundryProject` | `boolean` | -| `libs` | `never`[] | -| `remappings` | {} | - -#### Defined in - -[config/withDefaults.js:6](https://github.com/evmts/evmts-monorepo/blob/main/config/src/config/withDefaults.js#L6) - -## Functions - -### defineConfig - -▸ **defineConfig**(`configFactory`): `Object` - -Typesafe way to create an EVMts CompilerConfig - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configFactory` | `ConfigFactory` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `configFn` | (`configFilePath`: `string`) => `Effect`<`never`, `DefineConfigError`, [`ResolvedCompilerConfig`](/reference/config/modules.md#resolvedcompilerconfig)\> | - -**`Example`** - -```ts -import { defineConfig } from '@evmts/ts-plugin' - -export default defineConfig(() => ({ - lib: ['lib'], - remappings: { - 'foo': 'foo/bar' - } -}) - -#### Defined in - -[types.ts:68](https://github.com/evmts/evmts-monorepo/blob/main/config/src/types.ts#L68) - -___ - -### loadConfig - -▸ **loadConfig**(`configFilePath`): `Effect`<`never`, `LoadConfigError`, [`ResolvedCompilerConfig`](/reference/config/modules.md#resolvedcompilerconfig)\> - -Loads an EVMts config from the given path - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configFilePath` | `string` | - -#### Returns - -`Effect`<`never`, `LoadConfigError`, [`ResolvedCompilerConfig`](/reference/config/modules.md#resolvedcompilerconfig)\> - -**`Example`** - -```ts -import {tap} from 'effect/Effect' -import {loadConfig} from '@evmts/config' - -runPromise(loadConfig('./tsconfig.json')).pipe( - tap(config => console.log(config)) -) -``` - -#### Defined in - -[loadConfig.js:61](https://github.com/evmts/evmts-monorepo/blob/main/config/src/loadConfig.js#L61) +- [defaultConfig](modules/defaultConfig.md) +- [defineConfig](modules/defineConfig.md) +- [loadConfig](modules/loadConfig.md) +- [types](modules/types.md) diff --git a/config/docs/modules/defaultConfig.md b/config/docs/modules/defaultConfig.md new file mode 100644 index 0000000000..6743b5bd54 --- /dev/null +++ b/config/docs/modules/defaultConfig.md @@ -0,0 +1,29 @@ +[@evmts/config](../README.md) / [Modules](../modules.md) / defaultConfig + +# Module: defaultConfig + +## Table of contents + +### Variables + +- [defaultConfig](defaultConfig.md#defaultconfig) + +## Variables + +### defaultConfig + +• `Const` **defaultConfig**: `Object` + +The default CompilerConfig + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `foundryProject` | `boolean` | +| `libs` | `never`[] | +| `remappings` | {} | + +#### Defined in + +[config/src/config/withDefaults.js:6](https://github.com/evmts/evmts-monorepo/blob/main/config/src/config/withDefaults.js#L6) diff --git a/config/docs/modules/defineConfig.md b/config/docs/modules/defineConfig.md new file mode 100644 index 0000000000..357e8077d1 --- /dev/null +++ b/config/docs/modules/defineConfig.md @@ -0,0 +1,51 @@ +[@evmts/config](../README.md) / [Modules](../modules.md) / defineConfig + +# Module: defineConfig + +## Table of contents + +### Classes + +- [DefineConfigError](../classes/defineConfig.DefineConfigError.md) + +### Functions + +- [defineConfig](defineConfig.md#defineconfig) + +## Functions + +### defineConfig + +▸ **defineConfig**(`configFactory`): `Object` + +Typesafe way to create an EVMts CompilerConfig + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `configFactory` | [`ConfigFactory`](types.md#configfactory) | + +#### Returns + +`Object` + +| Name | Type | +| :------ | :------ | +| `configFn` | (`configFilePath`: `string`) => `Effect`<`never`, [`DefineConfigError`](../classes/defineConfig.DefineConfigError.md), [`ResolvedCompilerConfig`](types.md#resolvedcompilerconfig)\> | + +**`Example`** + +```ts +import { defineConfig } from '@evmts/ts-plugin' + +export default defineConfig(() => ({ + lib: ['lib'], + remappings: { + 'foo': 'foo/bar' + } +}) + +#### Defined in + +[config/src/types.ts:68](https://github.com/evmts/evmts-monorepo/blob/main/config/src/types.ts#L68) diff --git a/config/docs/modules/loadConfig.md b/config/docs/modules/loadConfig.md new file mode 100644 index 0000000000..1edfd35a96 --- /dev/null +++ b/config/docs/modules/loadConfig.md @@ -0,0 +1,60 @@ +[@evmts/config](../README.md) / [Modules](../modules.md) / loadConfig + +# Module: loadConfig + +## Table of contents + +### Classes + +- [LoadConfigError](../classes/loadConfig.LoadConfigError.md) + +### Type Aliases + +- [LoadConfigErrorType](loadConfig.md#loadconfigerrortype) + +### Functions + +- [loadConfig](loadConfig.md#loadconfig) + +## Type Aliases + +### LoadConfigErrorType + +Ƭ **LoadConfigErrorType**<\>: `LoadTsConfigError` \| `GetEvmtsConfigFromTsConfigError` \| `LoadFoundryConfigError` + +#### Defined in + +[config/src/loadConfig.js:16](https://github.com/evmts/evmts-monorepo/blob/main/config/src/loadConfig.js#L16) + +## Functions + +### loadConfig + +▸ **loadConfig**(`configFilePath`): `Effect`<`never`, [`LoadConfigError`](../classes/loadConfig.LoadConfigError.md), [`ResolvedCompilerConfig`](types.md#resolvedcompilerconfig)\> + +Loads an EVMts config from the given path + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `configFilePath` | `string` | + +#### Returns + +`Effect`<`never`, [`LoadConfigError`](../classes/loadConfig.LoadConfigError.md), [`ResolvedCompilerConfig`](types.md#resolvedcompilerconfig)\> + +**`Example`** + +```ts +import {tap} from 'effect/Effect' +import {loadConfig} from '@evmts/config' + +runPromise(loadConfig('./tsconfig.json')).pipe( + tap(config => console.log(config)) +) +``` + +#### Defined in + +[config/src/loadConfig.js:61](https://github.com/evmts/evmts-monorepo/blob/main/config/src/loadConfig.js#L61) diff --git a/config/docs/modules/types.md b/config/docs/modules/types.md new file mode 100644 index 0000000000..81fd780712 --- /dev/null +++ b/config/docs/modules/types.md @@ -0,0 +1,124 @@ +[@evmts/config](../README.md) / [Modules](../modules.md) / types + +# Module: types + +## Table of contents + +### Type Aliases + +- [CompilerConfig](types.md#compilerconfig) +- [ConfigFactory](types.md#configfactory) +- [DefineConfig](types.md#defineconfig) +- [DefineConfigErrorType](types.md#defineconfigerrortype) +- [ResolvedCompilerConfig](types.md#resolvedcompilerconfig) + +## Type Aliases + +### CompilerConfig + +Ƭ **CompilerConfig**: `Object` + +Configuration of the solidity compiler +When resolved with defaults it is a [ResolvedCompilerConfig](types.md#resolvedcompilerconfig) + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `foundryProject?` | `boolean` \| `string` | If set to true it will resolve forge remappings and libs Set to "path/to/forge/executable" to use a custom forge executable | +| `libs?` | readonly `string`[] | Sets directories to search for solidity imports in Read autoamtically for forge projects if forge: true | +| `remappings?` | `ReadonlyRecord`<`string`\> | Remap the location of contracts | + +#### Defined in + +[config/src/types.ts:11](https://github.com/evmts/evmts-monorepo/blob/main/config/src/types.ts#L11) + +___ + +### ConfigFactory + +Ƭ **ConfigFactory**: () => [`CompilerConfig`](types.md#compilerconfig) + +#### Type declaration + +▸ (): [`CompilerConfig`](types.md#compilerconfig) + +##### Returns + +[`CompilerConfig`](types.md#compilerconfig) + +#### Defined in + +[config/src/types.ts:31](https://github.com/evmts/evmts-monorepo/blob/main/config/src/types.ts#L31) + +___ + +### DefineConfig + +Ƭ **DefineConfig**: (`configFactory`: [`ConfigFactory`](types.md#configfactory)) => { `configFn`: (`configFilePath`: `string`) => `Effect`<`never`, [`DefineConfigError`](../classes/defineConfig.DefineConfigError.md), [`ResolvedCompilerConfig`](types.md#resolvedcompilerconfig)\> } + +#### Type declaration + +▸ (`configFactory`): `Object` + +Creates an EVMts config +Takes a user provided configFactory + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `configFactory` | [`ConfigFactory`](types.md#configfactory) | + +##### Returns + +`Object` + +| Name | Type | +| :------ | :------ | +| `configFn` | (`configFilePath`: `string`) => `Effect`<`never`, [`DefineConfigError`](../classes/defineConfig.DefineConfigError.md), [`ResolvedCompilerConfig`](types.md#resolvedcompilerconfig)\> | + +**`Example`** + +```ts +import { defineConfig } from 'evmts/config' +export default defineConfig({ + foundryProject: true, + libs: ['libs/contracts'], + }) +``` + +#### Defined in + +[config/src/types.ts:68](https://github.com/evmts/evmts-monorepo/blob/main/config/src/types.ts#L68) + +___ + +### DefineConfigErrorType + +Ƭ **DefineConfigErrorType**: `ValidateUserConfigError` \| `LoadFoundryConfigError` + +#### Defined in + +[config/src/types.ts:54](https://github.com/evmts/evmts-monorepo/blob/main/config/src/types.ts#L54) + +___ + +### ResolvedCompilerConfig + +Ƭ **ResolvedCompilerConfig**: `Object` + +A fully resolved compiler config with defaults filled in +See [CompilerConfig](types.md#compilerconfig) + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `foundryProject` | `boolean` \| `string` | If set to true it will resolve forge remappings and libs Set to "path/to/forge/executable" to use a custom forge executable | +| `libs` | readonly `string`[] | Sets directories to search for solidity imports in Read autoamtically for forge projects if forge: true | +| `remappings` | `ReadonlyRecord`<`string`\> | Remap the location of contracts | + +#### Defined in + +[config/src/types.ts:37](https://github.com/evmts/evmts-monorepo/blob/main/config/src/types.ts#L37) diff --git a/config/src/defaultConfig.js b/config/src/defaultConfig.js new file mode 100644 index 0000000000..570676103d --- /dev/null +++ b/config/src/defaultConfig.js @@ -0,0 +1 @@ +export { defaultConfig } from './config/withDefaults.js' diff --git a/config/src/index.js b/config/src/index.js index 979ee6b214..fed35afa63 100644 --- a/config/src/index.js +++ b/config/src/index.js @@ -3,6 +3,6 @@ * @typedef {import('./types.js').ResolvedCompilerConfig} ResolvedCompilerConfig */ -export { defaultConfig } from './config/index.js' +export { defaultConfig } from './defaultConfig.js' export { defineConfig } from './defineConfig.js' export { loadConfig } from './loadConfig.js' diff --git a/config/typedoc.json b/config/typedoc.json index 5aca56a75d..24c0ddcf26 100644 --- a/config/typedoc.json +++ b/config/typedoc.json @@ -1,8 +1,12 @@ { "$schema": "https://typedoc.org/schema.json", "out": "./docs", - "entryPoints": ["./src/index.js"], - "publicPath": "/reference/config/", + "entryPoints": [ + "./src/defaultConfig.js", + "./src/defineConfig.js", + "./src/types.ts", + "./src/loadConfig.js" + ], "plugin": ["typedoc-plugin-markdown"], "gitRevision": "main" } diff --git a/core/docs/README.md b/core/docs/README.md index 60a2420cfc..0f0de9c414 100644 --- a/core/docs/README.md +++ b/core/docs/README.md @@ -1,4 +1,4 @@ -@evmts/core / [Exports](/reference/core/modules.md) +@evmts/core / [Exports](modules.md)

diff --git a/core/docs/modules.md b/core/docs/modules.md index 72c1503858..ec5613cf45 100644 --- a/core/docs/modules.md +++ b/core/docs/modules.md @@ -1,4 +1,4 @@ -[@evmts/core](/reference/core/README.md) / Exports +[@evmts/core](README.md) / Exports # @evmts/core @@ -6,13 +6,13 @@ ### Type Aliases -- [EvmtsContract](/reference/core/modules.md#evmtscontract) +- [EvmtsContract](modules.md#evmtscontract) ### Functions -- [evmtsContractFactory](/reference/core/modules.md#evmtscontractfactory) -- [formatAbi](/reference/core/modules.md#formatabi) -- [parseAbi](/reference/core/modules.md#parseabi) +- [evmtsContractFactory](modules.md#evmtscontractfactory) +- [formatAbi](modules.md#formatabi) +- [parseAbi](modules.md#parseabi) ## Type Aliases @@ -46,7 +46,7 @@ ### evmtsContractFactory -▸ **evmtsContractFactory**<`TName`, `THumanReadableAbi`\>(`«destructured»`): [`EvmtsContract`](/reference/core/modules.md#evmtscontract)<`TName`, `THumanReadableAbi`\> +▸ **evmtsContractFactory**<`TName`, `THumanReadableAbi`\>(`«destructured»`): [`EvmtsContract`](modules.md#evmtscontract)<`TName`, `THumanReadableAbi`\> #### Type parameters @@ -59,11 +59,11 @@ | Name | Type | | :------ | :------ | -| `«destructured»` | `Pick`<[`EvmtsContract`](/reference/core/modules.md#evmtscontract)<`TName`, `THumanReadableAbi`\>, ``"name"`` \| ``"humanReadableAbi"``\> | +| `«destructured»` | `Pick`<[`EvmtsContract`](modules.md#evmtscontract)<`TName`, `THumanReadableAbi`\>, ``"name"`` \| ``"humanReadableAbi"``\> | #### Returns -[`EvmtsContract`](/reference/core/modules.md#evmtscontract)<`TName`, `THumanReadableAbi`\> +[`EvmtsContract`](modules.md#evmtscontract)<`TName`, `THumanReadableAbi`\> #### Defined in diff --git a/core/typedoc.json b/core/typedoc.json index 8e6c5d4648..93f5d67354 100644 --- a/core/typedoc.json +++ b/core/typedoc.json @@ -2,7 +2,6 @@ "$schema": "https://typedoc.org/schema.json", "out": "./docs", "entryPoints": ["./src/index.ts"], - "publicPath": "/reference/core/", "plugin": ["typedoc-plugin-markdown"], "gitRevision": "main" } diff --git a/effect/docs/README.md b/effect/docs/README.md index 49cf5a990f..493d36bc30 100644 --- a/effect/docs/README.md +++ b/effect/docs/README.md @@ -1,4 +1,4 @@ -@evmts/effect / [Exports](/reference/effect/modules.md) +@evmts/effect / [Exports](modules.md)

diff --git a/effect/docs/classes/CreateRequireError.md b/effect/docs/classes/CreateRequireError.md index 2edb7a0389..efac194653 100644 --- a/effect/docs/classes/CreateRequireError.md +++ b/effect/docs/classes/CreateRequireError.md @@ -1,4 +1,4 @@ -[@evmts/effect](/reference/effect/README.md) / [Exports](/reference/effect/modules.md) / CreateRequireError +[@evmts/effect](../README.md) / [Exports](../modules.md) / CreateRequireError # Class: CreateRequireError @@ -12,21 +12,21 @@ ### Constructors -- [constructor](/reference/effect/classes/CreateRequireError.md#constructor) +- [constructor](CreateRequireError.md#constructor) ### Properties -- [\_tag](/reference/effect/classes/CreateRequireError.md#_tag) -- [cause](/reference/effect/classes/CreateRequireError.md#cause) -- [message](/reference/effect/classes/CreateRequireError.md#message) -- [name](/reference/effect/classes/CreateRequireError.md#name) -- [stack](/reference/effect/classes/CreateRequireError.md#stack) -- [prepareStackTrace](/reference/effect/classes/CreateRequireError.md#preparestacktrace) -- [stackTraceLimit](/reference/effect/classes/CreateRequireError.md#stacktracelimit) +- [\_tag](CreateRequireError.md#_tag) +- [cause](CreateRequireError.md#cause) +- [message](CreateRequireError.md#message) +- [name](CreateRequireError.md#name) +- [stack](CreateRequireError.md#stack) +- [prepareStackTrace](CreateRequireError.md#preparestacktrace) +- [stackTraceLimit](CreateRequireError.md#stacktracelimit) ### Methods -- [captureStackTrace](/reference/effect/classes/CreateRequireError.md#capturestacktrace) +- [captureStackTrace](CreateRequireError.md#capturestacktrace) ## Constructors diff --git a/effect/docs/classes/ParseJsonError.md b/effect/docs/classes/ParseJsonError.md index 81aa2ea76e..cc58356650 100644 --- a/effect/docs/classes/ParseJsonError.md +++ b/effect/docs/classes/ParseJsonError.md @@ -1,4 +1,4 @@ -[@evmts/effect](/reference/effect/README.md) / [Exports](/reference/effect/modules.md) / ParseJsonError +[@evmts/effect](../README.md) / [Exports](../modules.md) / ParseJsonError # Class: ParseJsonError @@ -14,21 +14,21 @@ Error thrown when the tsconfig.json file is not valid json ### Constructors -- [constructor](/reference/effect/classes/ParseJsonError.md#constructor) +- [constructor](ParseJsonError.md#constructor) ### Properties -- [\_tag](/reference/effect/classes/ParseJsonError.md#_tag) -- [cause](/reference/effect/classes/ParseJsonError.md#cause) -- [message](/reference/effect/classes/ParseJsonError.md#message) -- [name](/reference/effect/classes/ParseJsonError.md#name) -- [stack](/reference/effect/classes/ParseJsonError.md#stack) -- [prepareStackTrace](/reference/effect/classes/ParseJsonError.md#preparestacktrace) -- [stackTraceLimit](/reference/effect/classes/ParseJsonError.md#stacktracelimit) +- [\_tag](ParseJsonError.md#_tag) +- [cause](ParseJsonError.md#cause) +- [message](ParseJsonError.md#message) +- [name](ParseJsonError.md#name) +- [stack](ParseJsonError.md#stack) +- [prepareStackTrace](ParseJsonError.md#preparestacktrace) +- [stackTraceLimit](ParseJsonError.md#stacktracelimit) ### Methods -- [captureStackTrace](/reference/effect/classes/ParseJsonError.md#capturestacktrace) +- [captureStackTrace](ParseJsonError.md#capturestacktrace) ## Constructors diff --git a/effect/docs/classes/RequireError.md b/effect/docs/classes/RequireError.md index 45898cc250..a2ff6429a2 100644 --- a/effect/docs/classes/RequireError.md +++ b/effect/docs/classes/RequireError.md @@ -1,4 +1,4 @@ -[@evmts/effect](/reference/effect/README.md) / [Exports](/reference/effect/modules.md) / RequireError +[@evmts/effect](../README.md) / [Exports](../modules.md) / RequireError # Class: RequireError @@ -12,21 +12,21 @@ ### Constructors -- [constructor](/reference/effect/classes/RequireError.md#constructor) +- [constructor](RequireError.md#constructor) ### Properties -- [\_tag](/reference/effect/classes/RequireError.md#_tag) -- [cause](/reference/effect/classes/RequireError.md#cause) -- [message](/reference/effect/classes/RequireError.md#message) -- [name](/reference/effect/classes/RequireError.md#name) -- [stack](/reference/effect/classes/RequireError.md#stack) -- [prepareStackTrace](/reference/effect/classes/RequireError.md#preparestacktrace) -- [stackTraceLimit](/reference/effect/classes/RequireError.md#stacktracelimit) +- [\_tag](RequireError.md#_tag) +- [cause](RequireError.md#cause) +- [message](RequireError.md#message) +- [name](RequireError.md#name) +- [stack](RequireError.md#stack) +- [prepareStackTrace](RequireError.md#preparestacktrace) +- [stackTraceLimit](RequireError.md#stacktracelimit) ### Methods -- [captureStackTrace](/reference/effect/classes/RequireError.md#capturestacktrace) +- [captureStackTrace](RequireError.md#capturestacktrace) ## Constructors diff --git a/effect/docs/modules.md b/effect/docs/modules.md index dfcdf1ff1d..6dc7c4781b 100644 --- a/effect/docs/modules.md +++ b/effect/docs/modules.md @@ -1,4 +1,4 @@ -[@evmts/effect](/reference/effect/README.md) / Exports +[@evmts/effect](README.md) / Exports # @evmts/effect @@ -6,22 +6,22 @@ ### Classes -- [CreateRequireError](/reference/effect/classes/CreateRequireError.md) -- [ParseJsonError](/reference/effect/classes/ParseJsonError.md) -- [RequireError](/reference/effect/classes/RequireError.md) +- [CreateRequireError](classes/CreateRequireError.md) +- [ParseJsonError](classes/ParseJsonError.md) +- [RequireError](classes/RequireError.md) ### Functions -- [createRequireEffect](/reference/effect/modules.md#createrequireeffect) -- [fileExists](/reference/effect/modules.md#fileexists) -- [logAllErrors](/reference/effect/modules.md#logallerrors) -- [parseJson](/reference/effect/modules.md#parsejson) +- [createRequireEffect](modules.md#createrequireeffect) +- [fileExists](modules.md#fileexists) +- [logAllErrors](modules.md#logallerrors) +- [parseJson](modules.md#parsejson) ## Functions ### createRequireEffect -▸ **createRequireEffect**(`url`): `Effect`<`never`, [`CreateRequireError`](/reference/effect/classes/CreateRequireError.md), (`id`: `string`) => `Effect`<`never`, [`RequireError`](/reference/effect/classes/RequireError.md), `any`\>\> +▸ **createRequireEffect**(`url`): `Effect`<`never`, [`CreateRequireError`](classes/CreateRequireError.md), (`id`: `string`) => `Effect`<`never`, [`RequireError`](classes/RequireError.md), `any`\>\> An [Effect](https://www.effect.website/docs/introduction) wrapper around createRequire createRequire is used to use the node.js `require` function in esm modules and cjs modules @@ -35,7 +35,7 @@ in a way that is compatible with both. It also wraps them weith Effect for bette #### Returns -`Effect`<`never`, [`CreateRequireError`](/reference/effect/classes/CreateRequireError.md), (`id`: `string`) => `Effect`<`never`, [`RequireError`](/reference/effect/classes/RequireError.md), `any`\>\> +`Effect`<`never`, [`CreateRequireError`](classes/CreateRequireError.md), (`id`: `string`) => `Effect`<`never`, [`RequireError`](classes/RequireError.md), `any`\>\> require function @@ -121,7 +121,7 @@ ___ ### parseJson -▸ **parseJson**(`jsonStr`): `Effect`<`never`, [`ParseJsonError`](/reference/effect/classes/ParseJsonError.md), { `compilerOptions?`: { `plugins`: { `name`: `string` }[] } }\> +▸ **parseJson**(`jsonStr`): `Effect`<`never`, [`ParseJsonError`](classes/ParseJsonError.md), { `compilerOptions?`: { `plugins`: { `name`: `string` }[] } }\> Parses a json string @@ -133,7 +133,7 @@ Parses a json string #### Returns -`Effect`<`never`, [`ParseJsonError`](/reference/effect/classes/ParseJsonError.md), { `compilerOptions?`: { `plugins`: { `name`: `string` }[] } }\> +`Effect`<`never`, [`ParseJsonError`](classes/ParseJsonError.md), { `compilerOptions?`: { `plugins`: { `name`: `string` }[] } }\> **`Throws`** diff --git a/effect/typedoc.json b/effect/typedoc.json index 7ef51fb017..d78cdfd822 100644 --- a/effect/typedoc.json +++ b/effect/typedoc.json @@ -2,7 +2,6 @@ "$schema": "https://typedoc.org/schema.json", "out": "./docs", "entryPoints": ["./src/index.js"], - "publicPath": "/reference/effect/", "plugin": ["typedoc-plugin-markdown"], "gitRevision": "main" } diff --git a/ethers/docs/README.md b/ethers/docs/README.md index 2a3100d424..e3dc78b0b7 100644 --- a/ethers/docs/README.md +++ b/ethers/docs/README.md @@ -1,4 +1,4 @@ -@evmts/ethers / [Exports](/reference/ethers/modules.md) +@evmts/ethers / [Exports](modules.md)

diff --git a/ethers/docs/modules.md b/ethers/docs/modules.md index 709aac6d31..e208dbcffa 100644 --- a/ethers/docs/modules.md +++ b/ethers/docs/modules.md @@ -1,4 +1,4 @@ -[@evmts/ethers](/reference/ethers/README.md) / Exports +[@evmts/ethers](README.md) / Exports # @evmts/ethers @@ -6,13 +6,13 @@ ### Type Aliases -- [TypesafeEthersContractConstructor](/reference/ethers/modules.md#typesafeetherscontractconstructor) -- [TypesafeEthersInterfaceConstructor](/reference/ethers/modules.md#typesafeethersinterfaceconstructor) +- [TypesafeEthersContractConstructor](modules.md#typesafeetherscontractconstructor) +- [TypesafeEthersInterfaceConstructor](modules.md#typesafeethersinterfaceconstructor) ### Variables -- [Contract](/reference/ethers/modules.md#contract) -- [Interface](/reference/ethers/modules.md#interface) +- [Contract](modules.md#contract) +- [Interface](modules.md#interface) ## Type Aliases @@ -81,7 +81,7 @@ ___ ### Contract -• `Const` **Contract**: [`TypesafeEthersContractConstructor`](/reference/ethers/modules.md#typesafeetherscontractconstructor) +• `Const` **Contract**: [`TypesafeEthersContractConstructor`](modules.md#typesafeetherscontractconstructor) #### Defined in @@ -91,7 +91,7 @@ ___ ### Interface -• `Const` **Interface**: [`TypesafeEthersInterfaceConstructor`](/reference/ethers/modules.md#typesafeethersinterfaceconstructor) +• `Const` **Interface**: [`TypesafeEthersInterfaceConstructor`](modules.md#typesafeethersinterfaceconstructor) #### Defined in diff --git a/ethers/typedoc.json b/ethers/typedoc.json index 2c228c352a..d78cdfd822 100644 --- a/ethers/typedoc.json +++ b/ethers/typedoc.json @@ -2,7 +2,6 @@ "$schema": "https://typedoc.org/schema.json", "out": "./docs", "entryPoints": ["./src/index.js"], - "publicPath": "/reference/ethers/", "plugin": ["typedoc-plugin-markdown"], "gitRevision": "main" } diff --git a/revm/docs/README.md b/revm/docs/README.md index e9084ef589..311ae74fb7 100644 --- a/revm/docs/README.md +++ b/revm/docs/README.md @@ -1,4 +1,4 @@ -@evmts/revm / [Exports](/reference/revm/modules.md) +@evmts/revm / [Exports](modules.md)

diff --git a/revm/docs/classes/EVM.md b/revm/docs/classes/EVM.md index cb4c2af798..3ec36dda69 100644 --- a/revm/docs/classes/EVM.md +++ b/revm/docs/classes/EVM.md @@ -1,4 +1,4 @@ -[@evmts/revm](/reference/revm/README.md) / [Exports](/reference/revm/modules.md) / EVM +[@evmts/revm](../README.md) / [Exports](../modules.md) / EVM # Class: EVM @@ -6,12 +6,12 @@ ### Constructors -- [constructor](/reference/revm/classes/EVM.md#constructor) +- [constructor](EVM.md#constructor) ### Methods -- [free](/reference/revm/classes/EVM.md#free) -- [new](/reference/revm/classes/EVM.md#new) +- [free](EVM.md#free) +- [new](EVM.md#new) ## Constructors @@ -37,11 +37,11 @@ ___ ### new -▸ `Static` **new**(): [`EVM`](/reference/revm/classes/EVM.md) +▸ `Static` **new**(): [`EVM`](EVM.md) #### Returns -[`EVM`](/reference/revm/classes/EVM.md) +[`EVM`](EVM.md) #### Defined in diff --git a/revm/docs/modules.md b/revm/docs/modules.md index 5c83b42965..b9b42c0eb7 100644 --- a/revm/docs/modules.md +++ b/revm/docs/modules.md @@ -1,4 +1,4 @@ -[@evmts/revm](/reference/revm/README.md) / Exports +[@evmts/revm](README.md) / Exports # @evmts/revm @@ -6,4 +6,4 @@ ### Classes -- [EVM](/reference/revm/classes/EVM.md) +- [EVM](classes/EVM.md) diff --git a/revm/typedoc.json b/revm/typedoc.json index 6f9c39be04..f7845f454e 100644 --- a/revm/typedoc.json +++ b/revm/typedoc.json @@ -2,7 +2,6 @@ "$schema": "https://typedoc.org/schema.json", "out": "./docs", "entryPoints": ["./dist/esm/revmts.d.ts"], - "publicPath": "/reference/revm/", "plugin": ["typedoc-plugin-markdown"], "gitRevision": "main", "tsconfig": "tsconfig.typedoc.json" diff --git a/runtime/docs/README.md b/runtime/docs/README.md index 5efa30d544..9a6c58b320 100644 --- a/runtime/docs/README.md +++ b/runtime/docs/README.md @@ -1,4 +1,4 @@ -@evmts/runtime / [Exports](/reference/runtime/modules.md) +@evmts/runtime / [Exports](modules.md)

diff --git a/runtime/docs/modules.md b/runtime/docs/modules.md index 88b5cb6120..bf944cca62 100644 --- a/runtime/docs/modules.md +++ b/runtime/docs/modules.md @@ -1,4 +1,4 @@ -[@evmts/runtime](/reference/runtime/README.md) / Exports +[@evmts/runtime](README.md) / Exports # @evmts/runtime @@ -6,14 +6,14 @@ ### Type Aliases -- [ModuleType](/reference/runtime/modules.md#moduletype) +- [ModuleType](modules.md#moduletype) ### Functions -- [generateDtsBody](/reference/runtime/modules.md#generatedtsbody) -- [generateEvmtsBody](/reference/runtime/modules.md#generateevmtsbody) -- [generateRuntime](/reference/runtime/modules.md#generateruntime) -- [generateRuntimeSync](/reference/runtime/modules.md#generateruntimesync) +- [generateDtsBody](modules.md#generatedtsbody) +- [generateEvmtsBody](modules.md#generateevmtsbody) +- [generateRuntime](modules.md#generateruntime) +- [generateRuntimeSync](modules.md#generateruntimesync) ## Type Aliases @@ -56,7 +56,7 @@ ___ | Name | Type | | :------ | :------ | | `artifacts` | `Artifacts` | -| `moduleType` | [`ModuleType`](/reference/runtime/modules.md#moduletype) | +| `moduleType` | [`ModuleType`](modules.md#moduletype) | #### Returns diff --git a/runtime/typedoc.json b/runtime/typedoc.json index b70ad6c47e..d78cdfd822 100644 --- a/runtime/typedoc.json +++ b/runtime/typedoc.json @@ -2,7 +2,6 @@ "$schema": "https://typedoc.org/schema.json", "out": "./docs", "entryPoints": ["./src/index.js"], - "publicPath": "/reference/runtime/", "plugin": ["typedoc-plugin-markdown"], "gitRevision": "main" } diff --git a/schemas/docs/README.md b/schemas/docs/README.md index 91ff59eba7..72f58ce561 100644 --- a/schemas/docs/README.md +++ b/schemas/docs/README.md @@ -1,4 +1,4 @@ -@evmts/schemas / [Modules](/reference/schemas/modules.md) +@evmts/schemas / [Modules](modules.md)

diff --git a/schemas/docs/classes/common.InvalidBlockNumberError.md b/schemas/docs/classes/common.InvalidBlockNumberError.md index b2e7a791ef..cb17437a38 100644 --- a/schemas/docs/classes/common.InvalidBlockNumberError.md +++ b/schemas/docs/classes/common.InvalidBlockNumberError.md @@ -1,8 +1,8 @@ -[@evmts/schemas](/reference/schemas/README.md) / [Modules](/reference/schemas/modules.md) / [common](/reference/schemas/modules/common.md) / InvalidBlockNumberError +[@evmts/schemas](../README.md) / [Modules](../modules.md) / [common](../modules/common.md) / InvalidBlockNumberError # Class: InvalidBlockNumberError -[common](/reference/schemas/modules/common.md).InvalidBlockNumberError +[common](../modules/common.md).InvalidBlockNumberError Error thrown when a BlockNumber is invalid. A block number is invalid if it is not a non-negative integer. @@ -17,20 +17,20 @@ A block number is invalid if it is not a non-negative integer. ### Constructors -- [constructor](/reference/schemas/classes/common.InvalidBlockNumberError.md#constructor) +- [constructor](common.InvalidBlockNumberError.md#constructor) ### Properties -- [cause](/reference/schemas/classes/common.InvalidBlockNumberError.md#cause) -- [message](/reference/schemas/classes/common.InvalidBlockNumberError.md#message) -- [name](/reference/schemas/classes/common.InvalidBlockNumberError.md#name) -- [stack](/reference/schemas/classes/common.InvalidBlockNumberError.md#stack) -- [prepareStackTrace](/reference/schemas/classes/common.InvalidBlockNumberError.md#preparestacktrace) -- [stackTraceLimit](/reference/schemas/classes/common.InvalidBlockNumberError.md#stacktracelimit) +- [cause](common.InvalidBlockNumberError.md#cause) +- [message](common.InvalidBlockNumberError.md#message) +- [name](common.InvalidBlockNumberError.md#name) +- [stack](common.InvalidBlockNumberError.md#stack) +- [prepareStackTrace](common.InvalidBlockNumberError.md#preparestacktrace) +- [stackTraceLimit](common.InvalidBlockNumberError.md#stacktracelimit) ### Methods -- [captureStackTrace](/reference/schemas/classes/common.InvalidBlockNumberError.md#capturestacktrace) +- [captureStackTrace](common.InvalidBlockNumberError.md#capturestacktrace) ## Constructors diff --git a/schemas/docs/classes/common.InvalidUrlError.md b/schemas/docs/classes/common.InvalidUrlError.md index 1222655844..d090e3b654 100644 --- a/schemas/docs/classes/common.InvalidUrlError.md +++ b/schemas/docs/classes/common.InvalidUrlError.md @@ -1,8 +1,8 @@ -[@evmts/schemas](/reference/schemas/README.md) / [Modules](/reference/schemas/modules.md) / [common](/reference/schemas/modules/common.md) / InvalidUrlError +[@evmts/schemas](../README.md) / [Modules](../modules.md) / [common](../modules/common.md) / InvalidUrlError # Class: InvalidUrlError -[common](/reference/schemas/modules/common.md).InvalidUrlError +[common](../modules/common.md).InvalidUrlError Error thrown when an invalid Url is provided. @@ -16,20 +16,20 @@ Error thrown when an invalid Url is provided. ### Constructors -- [constructor](/reference/schemas/classes/common.InvalidUrlError.md#constructor) +- [constructor](common.InvalidUrlError.md#constructor) ### Properties -- [cause](/reference/schemas/classes/common.InvalidUrlError.md#cause) -- [message](/reference/schemas/classes/common.InvalidUrlError.md#message) -- [name](/reference/schemas/classes/common.InvalidUrlError.md#name) -- [stack](/reference/schemas/classes/common.InvalidUrlError.md#stack) -- [prepareStackTrace](/reference/schemas/classes/common.InvalidUrlError.md#preparestacktrace) -- [stackTraceLimit](/reference/schemas/classes/common.InvalidUrlError.md#stacktracelimit) +- [cause](common.InvalidUrlError.md#cause) +- [message](common.InvalidUrlError.md#message) +- [name](common.InvalidUrlError.md#name) +- [stack](common.InvalidUrlError.md#stack) +- [prepareStackTrace](common.InvalidUrlError.md#preparestacktrace) +- [stackTraceLimit](common.InvalidUrlError.md#stacktracelimit) ### Methods -- [captureStackTrace](/reference/schemas/classes/common.InvalidUrlError.md#capturestacktrace) +- [captureStackTrace](common.InvalidUrlError.md#capturestacktrace) ## Constructors diff --git a/schemas/docs/classes/ethereum.InvalidAddressError.md b/schemas/docs/classes/ethereum.InvalidAddressError.md index fad199c394..84f40c46ce 100644 --- a/schemas/docs/classes/ethereum.InvalidAddressError.md +++ b/schemas/docs/classes/ethereum.InvalidAddressError.md @@ -1,8 +1,8 @@ -[@evmts/schemas](/reference/schemas/README.md) / [Modules](/reference/schemas/modules.md) / [ethereum](/reference/schemas/modules/ethereum.md) / InvalidAddressError +[@evmts/schemas](../README.md) / [Modules](../modules.md) / [ethereum](../modules/ethereum.md) / InvalidAddressError # Class: InvalidAddressError -[ethereum](/reference/schemas/modules/ethereum.md).InvalidAddressError +[ethereum](../modules/ethereum.md).InvalidAddressError Error thrown when an Address is invalid. @@ -23,20 +23,20 @@ throw new InvalidAddressError({ address: '0x1234' }); ### Constructors -- [constructor](/reference/schemas/classes/ethereum.InvalidAddressError.md#constructor) +- [constructor](ethereum.InvalidAddressError.md#constructor) ### Properties -- [cause](/reference/schemas/classes/ethereum.InvalidAddressError.md#cause) -- [message](/reference/schemas/classes/ethereum.InvalidAddressError.md#message) -- [name](/reference/schemas/classes/ethereum.InvalidAddressError.md#name) -- [stack](/reference/schemas/classes/ethereum.InvalidAddressError.md#stack) -- [prepareStackTrace](/reference/schemas/classes/ethereum.InvalidAddressError.md#preparestacktrace) -- [stackTraceLimit](/reference/schemas/classes/ethereum.InvalidAddressError.md#stacktracelimit) +- [cause](ethereum.InvalidAddressError.md#cause) +- [message](ethereum.InvalidAddressError.md#message) +- [name](ethereum.InvalidAddressError.md#name) +- [stack](ethereum.InvalidAddressError.md#stack) +- [prepareStackTrace](ethereum.InvalidAddressError.md#preparestacktrace) +- [stackTraceLimit](ethereum.InvalidAddressError.md#stacktracelimit) ### Methods -- [captureStackTrace](/reference/schemas/classes/ethereum.InvalidAddressError.md#capturestacktrace) +- [captureStackTrace](ethereum.InvalidAddressError.md#capturestacktrace) ## Constructors diff --git a/schemas/docs/classes/ethereum.InvalidBytesError.md b/schemas/docs/classes/ethereum.InvalidBytesError.md index 0cc9bba5ab..cc706bdeda 100644 --- a/schemas/docs/classes/ethereum.InvalidBytesError.md +++ b/schemas/docs/classes/ethereum.InvalidBytesError.md @@ -1,8 +1,8 @@ -[@evmts/schemas](/reference/schemas/README.md) / [Modules](/reference/schemas/modules.md) / [ethereum](/reference/schemas/modules/ethereum.md) / InvalidBytesError +[@evmts/schemas](../README.md) / [Modules](../modules.md) / [ethereum](../modules/ethereum.md) / InvalidBytesError # Class: InvalidBytesError -[ethereum](/reference/schemas/modules/ethereum.md).InvalidBytesError +[ethereum](../modules/ethereum.md).InvalidBytesError Error thrown when an invalid Bytes is provided. @@ -16,20 +16,20 @@ Error thrown when an invalid Bytes is provided. ### Constructors -- [constructor](/reference/schemas/classes/ethereum.InvalidBytesError.md#constructor) +- [constructor](ethereum.InvalidBytesError.md#constructor) ### Properties -- [cause](/reference/schemas/classes/ethereum.InvalidBytesError.md#cause) -- [message](/reference/schemas/classes/ethereum.InvalidBytesError.md#message) -- [name](/reference/schemas/classes/ethereum.InvalidBytesError.md#name) -- [stack](/reference/schemas/classes/ethereum.InvalidBytesError.md#stack) -- [prepareStackTrace](/reference/schemas/classes/ethereum.InvalidBytesError.md#preparestacktrace) -- [stackTraceLimit](/reference/schemas/classes/ethereum.InvalidBytesError.md#stacktracelimit) +- [cause](ethereum.InvalidBytesError.md#cause) +- [message](ethereum.InvalidBytesError.md#message) +- [name](ethereum.InvalidBytesError.md#name) +- [stack](ethereum.InvalidBytesError.md#stack) +- [prepareStackTrace](ethereum.InvalidBytesError.md#preparestacktrace) +- [stackTraceLimit](ethereum.InvalidBytesError.md#stacktracelimit) ### Methods -- [captureStackTrace](/reference/schemas/classes/ethereum.InvalidBytesError.md#capturestacktrace) +- [captureStackTrace](ethereum.InvalidBytesError.md#capturestacktrace) ## Constructors diff --git a/schemas/docs/classes/ethereum.InvalidBytesFixedError.md b/schemas/docs/classes/ethereum.InvalidBytesFixedError.md index f0e0dd08ce..6d14a3b01f 100644 --- a/schemas/docs/classes/ethereum.InvalidBytesFixedError.md +++ b/schemas/docs/classes/ethereum.InvalidBytesFixedError.md @@ -1,8 +1,8 @@ -[@evmts/schemas](/reference/schemas/README.md) / [Modules](/reference/schemas/modules.md) / [ethereum](/reference/schemas/modules/ethereum.md) / InvalidBytesFixedError +[@evmts/schemas](../README.md) / [Modules](../modules.md) / [ethereum](../modules/ethereum.md) / InvalidBytesFixedError # Class: InvalidBytesFixedError -[ethereum](/reference/schemas/modules/ethereum.md).InvalidBytesFixedError +[ethereum](../modules/ethereum.md).InvalidBytesFixedError Error thrown when a FixedByte is invalid. A FixedByte string is invalid if it's not within the bounds of its size. @@ -17,20 +17,20 @@ A FixedByte string is invalid if it's not within the bounds of its size. ### Constructors -- [constructor](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md#constructor) +- [constructor](ethereum.InvalidBytesFixedError.md#constructor) ### Properties -- [cause](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md#cause) -- [message](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md#message) -- [name](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md#name) -- [stack](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md#stack) -- [prepareStackTrace](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md#preparestacktrace) -- [stackTraceLimit](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md#stacktracelimit) +- [cause](ethereum.InvalidBytesFixedError.md#cause) +- [message](ethereum.InvalidBytesFixedError.md#message) +- [name](ethereum.InvalidBytesFixedError.md#name) +- [stack](ethereum.InvalidBytesFixedError.md#stack) +- [prepareStackTrace](ethereum.InvalidBytesFixedError.md#preparestacktrace) +- [stackTraceLimit](ethereum.InvalidBytesFixedError.md#stacktracelimit) ### Methods -- [captureStackTrace](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md#capturestacktrace) +- [captureStackTrace](ethereum.InvalidBytesFixedError.md#capturestacktrace) ## Constructors @@ -47,7 +47,7 @@ A FixedByte string is invalid if it's not within the bounds of its size. | `options.cause` | `undefined` \| readonly [`ParseErrors`, `ParseErrors`] | The cause of the error. | | `options.docs` | `undefined` \| `string` | The documentation URL. | | `options.message` | `undefined` \| `string` | The error message. | -| `options.size` | [`BytesCapacity`](/reference/schemas/modules/ethereum.md#bytescapacity) | The size of the bytes. | +| `options.size` | [`BytesCapacity`](../modules/ethereum.md#bytescapacity) | The size of the bytes. | #### Overrides diff --git a/schemas/docs/classes/ethereum.InvalidINTError.md b/schemas/docs/classes/ethereum.InvalidINTError.md index 7f74d574d0..256ed1a37c 100644 --- a/schemas/docs/classes/ethereum.InvalidINTError.md +++ b/schemas/docs/classes/ethereum.InvalidINTError.md @@ -1,8 +1,8 @@ -[@evmts/schemas](/reference/schemas/README.md) / [Modules](/reference/schemas/modules.md) / [ethereum](/reference/schemas/modules/ethereum.md) / InvalidINTError +[@evmts/schemas](../README.md) / [Modules](../modules.md) / [ethereum](../modules/ethereum.md) / InvalidINTError # Class: InvalidINTError -[ethereum](/reference/schemas/modules/ethereum.md).InvalidINTError +[ethereum](../modules/ethereum.md).InvalidINTError Error thrown when an INT is invalid. An int bigint is invalid if it's not within the bounds of its size. @@ -17,20 +17,20 @@ An int bigint is invalid if it's not within the bounds of its size. ### Constructors -- [constructor](/reference/schemas/classes/ethereum.InvalidINTError.md#constructor) +- [constructor](ethereum.InvalidINTError.md#constructor) ### Properties -- [cause](/reference/schemas/classes/ethereum.InvalidINTError.md#cause) -- [message](/reference/schemas/classes/ethereum.InvalidINTError.md#message) -- [name](/reference/schemas/classes/ethereum.InvalidINTError.md#name) -- [stack](/reference/schemas/classes/ethereum.InvalidINTError.md#stack) -- [prepareStackTrace](/reference/schemas/classes/ethereum.InvalidINTError.md#preparestacktrace) -- [stackTraceLimit](/reference/schemas/classes/ethereum.InvalidINTError.md#stacktracelimit) +- [cause](ethereum.InvalidINTError.md#cause) +- [message](ethereum.InvalidINTError.md#message) +- [name](ethereum.InvalidINTError.md#name) +- [stack](ethereum.InvalidINTError.md#stack) +- [prepareStackTrace](ethereum.InvalidINTError.md#preparestacktrace) +- [stackTraceLimit](ethereum.InvalidINTError.md#stacktracelimit) ### Methods -- [captureStackTrace](/reference/schemas/classes/ethereum.InvalidINTError.md#capturestacktrace) +- [captureStackTrace](ethereum.InvalidINTError.md#capturestacktrace) ## Constructors @@ -47,7 +47,7 @@ An int bigint is invalid if it's not within the bounds of its size. | `options.docs` | `undefined` \| `string` | The documentation URL. | | `options.int` | `bigint` | The invalid int bigint. | | `options.message` | `undefined` \| `string` | The error message. | -| `options.size` | [`INTSize`](/reference/schemas/modules/ethereum.md#intsize) | The size of the int. | +| `options.size` | [`INTSize`](../modules/ethereum.md#intsize) | The size of the int. | #### Overrides diff --git a/schemas/docs/classes/ethereum.InvalidUINTError.md b/schemas/docs/classes/ethereum.InvalidUINTError.md index 0b234aa72f..225a476273 100644 --- a/schemas/docs/classes/ethereum.InvalidUINTError.md +++ b/schemas/docs/classes/ethereum.InvalidUINTError.md @@ -1,8 +1,8 @@ -[@evmts/schemas](/reference/schemas/README.md) / [Modules](/reference/schemas/modules.md) / [ethereum](/reference/schemas/modules/ethereum.md) / InvalidUINTError +[@evmts/schemas](../README.md) / [Modules](../modules.md) / [ethereum](../modules/ethereum.md) / InvalidUINTError # Class: InvalidUINTError -[ethereum](/reference/schemas/modules/ethereum.md).InvalidUINTError +[ethereum](../modules/ethereum.md).InvalidUINTError Error thrown when a UINT256 is invalid. A uintbigint is invalid if it is not a non-negative integer or overflows @@ -17,20 +17,20 @@ A uintbigint is invalid if it is not a non-negative integer or overflows ### Constructors -- [constructor](/reference/schemas/classes/ethereum.InvalidUINTError.md#constructor) +- [constructor](ethereum.InvalidUINTError.md#constructor) ### Properties -- [cause](/reference/schemas/classes/ethereum.InvalidUINTError.md#cause) -- [message](/reference/schemas/classes/ethereum.InvalidUINTError.md#message) -- [name](/reference/schemas/classes/ethereum.InvalidUINTError.md#name) -- [stack](/reference/schemas/classes/ethereum.InvalidUINTError.md#stack) -- [prepareStackTrace](/reference/schemas/classes/ethereum.InvalidUINTError.md#preparestacktrace) -- [stackTraceLimit](/reference/schemas/classes/ethereum.InvalidUINTError.md#stacktracelimit) +- [cause](ethereum.InvalidUINTError.md#cause) +- [message](ethereum.InvalidUINTError.md#message) +- [name](ethereum.InvalidUINTError.md#name) +- [stack](ethereum.InvalidUINTError.md#stack) +- [prepareStackTrace](ethereum.InvalidUINTError.md#preparestacktrace) +- [stackTraceLimit](ethereum.InvalidUINTError.md#stacktracelimit) ### Methods -- [captureStackTrace](/reference/schemas/classes/ethereum.InvalidUINTError.md#capturestacktrace) +- [captureStackTrace](ethereum.InvalidUINTError.md#capturestacktrace) ## Constructors @@ -46,7 +46,7 @@ A uintbigint is invalid if it is not a non-negative integer or overflows | `options.cause` | `undefined` \| readonly [`ParseErrors`, `ParseErrors`] | The cause of the error. | | `options.docs` | `undefined` \| `string` | The documentation URL. | | `options.message` | `undefined` \| `string` | The error message. | -| `options.size` | [`UINTSize`](/reference/schemas/modules/ethereum.md#uintsize) | The size of the uint. | +| `options.size` | [`UINTSize`](../modules/ethereum.md#uintsize) | The size of the uint. | | `options.uint` | `bigint` | The invalid uint256 bigint. | #### Overrides diff --git a/schemas/docs/classes/evmts.InvalidAddressBookError.md b/schemas/docs/classes/evmts.InvalidAddressBookError.md index bfd0bb0f4c..752b702888 100644 --- a/schemas/docs/classes/evmts.InvalidAddressBookError.md +++ b/schemas/docs/classes/evmts.InvalidAddressBookError.md @@ -1,8 +1,8 @@ -[@evmts/schemas](/reference/schemas/README.md) / [Modules](/reference/schemas/modules.md) / [evmts](/reference/schemas/modules/evmts.md) / InvalidAddressBookError +[@evmts/schemas](../README.md) / [Modules](../modules.md) / [evmts](../modules/evmts.md) / InvalidAddressBookError # Class: InvalidAddressBookError -[evmts](/reference/schemas/modules/evmts.md).InvalidAddressBookError +[evmts](../modules/evmts.md).InvalidAddressBookError Error thrown when an AddressBook is invalid. @@ -16,20 +16,20 @@ Error thrown when an AddressBook is invalid. ### Constructors -- [constructor](/reference/schemas/classes/evmts.InvalidAddressBookError.md#constructor) +- [constructor](evmts.InvalidAddressBookError.md#constructor) ### Properties -- [cause](/reference/schemas/classes/evmts.InvalidAddressBookError.md#cause) -- [message](/reference/schemas/classes/evmts.InvalidAddressBookError.md#message) -- [name](/reference/schemas/classes/evmts.InvalidAddressBookError.md#name) -- [stack](/reference/schemas/classes/evmts.InvalidAddressBookError.md#stack) -- [prepareStackTrace](/reference/schemas/classes/evmts.InvalidAddressBookError.md#preparestacktrace) -- [stackTraceLimit](/reference/schemas/classes/evmts.InvalidAddressBookError.md#stacktracelimit) +- [cause](evmts.InvalidAddressBookError.md#cause) +- [message](evmts.InvalidAddressBookError.md#message) +- [name](evmts.InvalidAddressBookError.md#name) +- [stack](evmts.InvalidAddressBookError.md#stack) +- [prepareStackTrace](evmts.InvalidAddressBookError.md#preparestacktrace) +- [stackTraceLimit](evmts.InvalidAddressBookError.md#stacktracelimit) ### Methods -- [captureStackTrace](/reference/schemas/classes/evmts.InvalidAddressBookError.md#capturestacktrace) +- [captureStackTrace](evmts.InvalidAddressBookError.md#capturestacktrace) ## Constructors diff --git a/schemas/docs/interfaces/ethereum.SchemaOptions.md b/schemas/docs/interfaces/ethereum.SchemaOptions.md index 297745dd13..f73029285c 100644 --- a/schemas/docs/interfaces/ethereum.SchemaOptions.md +++ b/schemas/docs/interfaces/ethereum.SchemaOptions.md @@ -1,14 +1,14 @@ -[@evmts/schemas](/reference/schemas/README.md) / [Modules](/reference/schemas/modules.md) / [ethereum](/reference/schemas/modules/ethereum.md) / SchemaOptions +[@evmts/schemas](../README.md) / [Modules](../modules.md) / [ethereum](../modules/ethereum.md) / SchemaOptions # Interface: SchemaOptions<\> -[ethereum](/reference/schemas/modules/ethereum.md).SchemaOptions +[ethereum](../modules/ethereum.md).SchemaOptions ## Table of contents ### Properties -- [message](/reference/schemas/interfaces/ethereum.SchemaOptions.md#message) +- [message](ethereum.SchemaOptions.md#message) ## Properties diff --git a/schemas/docs/interfaces/evmts.AddressBookEntry.md b/schemas/docs/interfaces/evmts.AddressBookEntry.md index 68843e60aa..e6d1915028 100644 --- a/schemas/docs/interfaces/evmts.AddressBookEntry.md +++ b/schemas/docs/interfaces/evmts.AddressBookEntry.md @@ -1,15 +1,15 @@ -[@evmts/schemas](/reference/schemas/README.md) / [Modules](/reference/schemas/modules.md) / [evmts](/reference/schemas/modules/evmts.md) / AddressBookEntry +[@evmts/schemas](../README.md) / [Modules](../modules.md) / [evmts](../modules/evmts.md) / AddressBookEntry # Interface: AddressBookEntry<\> -[evmts](/reference/schemas/modules/evmts.md).AddressBookEntry +[evmts](../modules/evmts.md).AddressBookEntry ## Table of contents ### Properties -- [address](/reference/schemas/interfaces/evmts.AddressBookEntry.md#address) -- [blockCreated](/reference/schemas/interfaces/evmts.AddressBookEntry.md#blockcreated) +- [address](evmts.AddressBookEntry.md#address) +- [blockCreated](evmts.AddressBookEntry.md#blockcreated) ## Properties diff --git a/schemas/docs/modules.md b/schemas/docs/modules.md index de87c2c369..cc4e58651b 100644 --- a/schemas/docs/modules.md +++ b/schemas/docs/modules.md @@ -1,4 +1,4 @@ -[@evmts/schemas](/reference/schemas/README.md) / Modules +[@evmts/schemas](README.md) / Modules # @evmts/schemas @@ -6,7 +6,7 @@ ### Modules -- [common](/reference/schemas/modules/common.md) -- [ethereum](/reference/schemas/modules/ethereum.md) -- [evmts](/reference/schemas/modules/evmts.md) -- [types](/reference/schemas/modules/types.md) +- [common](modules/common.md) +- [ethereum](modules/ethereum.md) +- [evmts](modules/evmts.md) +- [types](modules/types.md) diff --git a/schemas/docs/modules/common.md b/schemas/docs/modules/common.md index 3d150cfcdf..1407bb5f5b 100644 --- a/schemas/docs/modules/common.md +++ b/schemas/docs/modules/common.md @@ -1,4 +1,4 @@ -[@evmts/schemas](/reference/schemas/README.md) / [Modules](/reference/schemas/modules.md) / common +[@evmts/schemas](../README.md) / [Modules](../modules.md) / common # Module: common @@ -6,27 +6,27 @@ ### Classes -- [InvalidBlockNumberError](/reference/schemas/classes/common.InvalidBlockNumberError.md) -- [InvalidUrlError](/reference/schemas/classes/common.InvalidUrlError.md) +- [InvalidBlockNumberError](../classes/common.InvalidBlockNumberError.md) +- [InvalidUrlError](../classes/common.InvalidUrlError.md) ### Type Aliases -- [BlockNumber](/reference/schemas/modules/common.md#blocknumber) -- [Url](/reference/schemas/modules/common.md#url) +- [BlockNumber](common.md#blocknumber) +- [Url](common.md#url) ### Variables -- [SBlockNumber](/reference/schemas/modules/common.md#sblocknumber) -- [SUrl](/reference/schemas/modules/common.md#surl) +- [SBlockNumber](common.md#sblocknumber) +- [SUrl](common.md#surl) ### Functions -- [isBlockNumber](/reference/schemas/modules/common.md#isblocknumber) -- [isUrl](/reference/schemas/modules/common.md#isurl) -- [parseBlockNumber](/reference/schemas/modules/common.md#parseblocknumber) -- [parseBlockNumberSafe](/reference/schemas/modules/common.md#parseblocknumbersafe) -- [parseUrl](/reference/schemas/modules/common.md#parseurl) -- [parseUrlSafe](/reference/schemas/modules/common.md#parseurlsafe) +- [isBlockNumber](common.md#isblocknumber) +- [isUrl](common.md#isurl) +- [parseBlockNumber](common.md#parseblocknumber) +- [parseBlockNumberSafe](common.md#parseblocknumbersafe) +- [parseUrl](common.md#parseurl) +- [parseUrlSafe](common.md#parseurlsafe) ## Type Aliases @@ -185,7 +185,7 @@ ___ ### parseBlockNumberSafe -▸ **parseBlockNumberSafe**<`TBlockNumber`\>(`blockNumber`): `Effect`<`never`, [`InvalidBlockNumberError`](/reference/schemas/classes/common.InvalidBlockNumberError.md), `TBlockNumber`\> +▸ **parseBlockNumberSafe**<`TBlockNumber`\>(`blockNumber`): `Effect`<`never`, [`InvalidBlockNumberError`](../classes/common.InvalidBlockNumberError.md), `TBlockNumber`\> Safely parses a BlockNumber into an [Effect](https://www.effect.website/docs/essentials/effect-type). @@ -203,7 +203,7 @@ Safely parses a BlockNumber into an [Effect](https://www.effect.website/docs/ess #### Returns -`Effect`<`never`, [`InvalidBlockNumberError`](/reference/schemas/classes/common.InvalidBlockNumberError.md), `TBlockNumber`\> +`Effect`<`never`, [`InvalidBlockNumberError`](../classes/common.InvalidBlockNumberError.md), `TBlockNumber`\> **`Example`** @@ -255,7 +255,7 @@ ___ ### parseUrlSafe -▸ **parseUrlSafe**<`TUrl`\>(`url`): `Effect`<`never`, [`InvalidUrlError`](/reference/schemas/classes/common.InvalidUrlError.md), `TUrl`\> +▸ **parseUrlSafe**<`TUrl`\>(`url`): `Effect`<`never`, [`InvalidUrlError`](../classes/common.InvalidUrlError.md), `TUrl`\> Safely parses a Url into an [Effect](https://www.effect.website/docs/essentials/effect-type). @@ -273,7 +273,7 @@ Safely parses a Url into an [Effect](https://www.effect.website/docs/essentials/ #### Returns -`Effect`<`never`, [`InvalidUrlError`](/reference/schemas/classes/common.InvalidUrlError.md), `TUrl`\> +`Effect`<`never`, [`InvalidUrlError`](../classes/common.InvalidUrlError.md), `TUrl`\> **`Example`** diff --git a/schemas/docs/modules/ethereum.md b/schemas/docs/modules/ethereum.md index 56208f2ad5..d45572fa33 100644 --- a/schemas/docs/modules/ethereum.md +++ b/schemas/docs/modules/ethereum.md @@ -1,4 +1,4 @@ -[@evmts/schemas](/reference/schemas/README.md) / [Modules](/reference/schemas/modules.md) / ethereum +[@evmts/schemas](../README.md) / [Modules](../modules.md) / ethereum # Module: ethereum @@ -6,279 +6,279 @@ ### Classes -- [InvalidAddressError](/reference/schemas/classes/ethereum.InvalidAddressError.md) -- [InvalidBytesError](/reference/schemas/classes/ethereum.InvalidBytesError.md) -- [InvalidBytesFixedError](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md) -- [InvalidINTError](/reference/schemas/classes/ethereum.InvalidINTError.md) -- [InvalidUINTError](/reference/schemas/classes/ethereum.InvalidUINTError.md) +- [InvalidAddressError](../classes/ethereum.InvalidAddressError.md) +- [InvalidBytesError](../classes/ethereum.InvalidBytesError.md) +- [InvalidBytesFixedError](../classes/ethereum.InvalidBytesFixedError.md) +- [InvalidINTError](../classes/ethereum.InvalidINTError.md) +- [InvalidUINTError](../classes/ethereum.InvalidUINTError.md) ### Interfaces -- [SchemaOptions](/reference/schemas/interfaces/ethereum.SchemaOptions.md) +- [SchemaOptions](../interfaces/ethereum.SchemaOptions.md) ### Type Aliases -- [Address](/reference/schemas/modules/ethereum.md#address) -- [Bytes](/reference/schemas/modules/ethereum.md#bytes) -- [Bytes1](/reference/schemas/modules/ethereum.md#bytes1) -- [Bytes10](/reference/schemas/modules/ethereum.md#bytes10) -- [Bytes11](/reference/schemas/modules/ethereum.md#bytes11) -- [Bytes12](/reference/schemas/modules/ethereum.md#bytes12) -- [Bytes13](/reference/schemas/modules/ethereum.md#bytes13) -- [Bytes14](/reference/schemas/modules/ethereum.md#bytes14) -- [Bytes15](/reference/schemas/modules/ethereum.md#bytes15) -- [Bytes16](/reference/schemas/modules/ethereum.md#bytes16) -- [Bytes17](/reference/schemas/modules/ethereum.md#bytes17) -- [Bytes18](/reference/schemas/modules/ethereum.md#bytes18) -- [Bytes19](/reference/schemas/modules/ethereum.md#bytes19) -- [Bytes2](/reference/schemas/modules/ethereum.md#bytes2) -- [Bytes20](/reference/schemas/modules/ethereum.md#bytes20) -- [Bytes21](/reference/schemas/modules/ethereum.md#bytes21) -- [Bytes22](/reference/schemas/modules/ethereum.md#bytes22) -- [Bytes23](/reference/schemas/modules/ethereum.md#bytes23) -- [Bytes24](/reference/schemas/modules/ethereum.md#bytes24) -- [Bytes25](/reference/schemas/modules/ethereum.md#bytes25) -- [Bytes26](/reference/schemas/modules/ethereum.md#bytes26) -- [Bytes27](/reference/schemas/modules/ethereum.md#bytes27) -- [Bytes28](/reference/schemas/modules/ethereum.md#bytes28) -- [Bytes29](/reference/schemas/modules/ethereum.md#bytes29) -- [Bytes3](/reference/schemas/modules/ethereum.md#bytes3) -- [Bytes30](/reference/schemas/modules/ethereum.md#bytes30) -- [Bytes31](/reference/schemas/modules/ethereum.md#bytes31) -- [Bytes32](/reference/schemas/modules/ethereum.md#bytes32) -- [Bytes4](/reference/schemas/modules/ethereum.md#bytes4) -- [Bytes5](/reference/schemas/modules/ethereum.md#bytes5) -- [Bytes6](/reference/schemas/modules/ethereum.md#bytes6) -- [Bytes7](/reference/schemas/modules/ethereum.md#bytes7) -- [Bytes8](/reference/schemas/modules/ethereum.md#bytes8) -- [Bytes9](/reference/schemas/modules/ethereum.md#bytes9) -- [BytesCapacity](/reference/schemas/modules/ethereum.md#bytescapacity) -- [INT128](/reference/schemas/modules/ethereum.md#int128) -- [INT16](/reference/schemas/modules/ethereum.md#int16) -- [INT256](/reference/schemas/modules/ethereum.md#int256) -- [INT32](/reference/schemas/modules/ethereum.md#int32) -- [INT64](/reference/schemas/modules/ethereum.md#int64) -- [INT8](/reference/schemas/modules/ethereum.md#int8) -- [INTName](/reference/schemas/modules/ethereum.md#intname) -- [INTSize](/reference/schemas/modules/ethereum.md#intsize) -- [SAddress](/reference/schemas/modules/ethereum.md#saddress) -- [SAddressSchema](/reference/schemas/modules/ethereum.md#saddressschema) -- [UINT128](/reference/schemas/modules/ethereum.md#uint128) -- [UINT16](/reference/schemas/modules/ethereum.md#uint16) -- [UINT256](/reference/schemas/modules/ethereum.md#uint256) -- [UINT32](/reference/schemas/modules/ethereum.md#uint32) -- [UINT64](/reference/schemas/modules/ethereum.md#uint64) -- [UINT8](/reference/schemas/modules/ethereum.md#uint8) -- [UINTName](/reference/schemas/modules/ethereum.md#uintname) -- [UINTSize](/reference/schemas/modules/ethereum.md#uintsize) +- [Address](ethereum.md#address) +- [Bytes](ethereum.md#bytes) +- [Bytes1](ethereum.md#bytes1) +- [Bytes10](ethereum.md#bytes10) +- [Bytes11](ethereum.md#bytes11) +- [Bytes12](ethereum.md#bytes12) +- [Bytes13](ethereum.md#bytes13) +- [Bytes14](ethereum.md#bytes14) +- [Bytes15](ethereum.md#bytes15) +- [Bytes16](ethereum.md#bytes16) +- [Bytes17](ethereum.md#bytes17) +- [Bytes18](ethereum.md#bytes18) +- [Bytes19](ethereum.md#bytes19) +- [Bytes2](ethereum.md#bytes2) +- [Bytes20](ethereum.md#bytes20) +- [Bytes21](ethereum.md#bytes21) +- [Bytes22](ethereum.md#bytes22) +- [Bytes23](ethereum.md#bytes23) +- [Bytes24](ethereum.md#bytes24) +- [Bytes25](ethereum.md#bytes25) +- [Bytes26](ethereum.md#bytes26) +- [Bytes27](ethereum.md#bytes27) +- [Bytes28](ethereum.md#bytes28) +- [Bytes29](ethereum.md#bytes29) +- [Bytes3](ethereum.md#bytes3) +- [Bytes30](ethereum.md#bytes30) +- [Bytes31](ethereum.md#bytes31) +- [Bytes32](ethereum.md#bytes32) +- [Bytes4](ethereum.md#bytes4) +- [Bytes5](ethereum.md#bytes5) +- [Bytes6](ethereum.md#bytes6) +- [Bytes7](ethereum.md#bytes7) +- [Bytes8](ethereum.md#bytes8) +- [Bytes9](ethereum.md#bytes9) +- [BytesCapacity](ethereum.md#bytescapacity) +- [INT128](ethereum.md#int128) +- [INT16](ethereum.md#int16) +- [INT256](ethereum.md#int256) +- [INT32](ethereum.md#int32) +- [INT64](ethereum.md#int64) +- [INT8](ethereum.md#int8) +- [INTName](ethereum.md#intname) +- [INTSize](ethereum.md#intsize) +- [SAddress](ethereum.md#saddress) +- [SAddressSchema](ethereum.md#saddressschema) +- [UINT128](ethereum.md#uint128) +- [UINT16](ethereum.md#uint16) +- [UINT256](ethereum.md#uint256) +- [UINT32](ethereum.md#uint32) +- [UINT64](ethereum.md#uint64) +- [UINT8](ethereum.md#uint8) +- [UINTName](ethereum.md#uintname) +- [UINTSize](ethereum.md#uintsize) ### Variables -- [INT128\_MAX](/reference/schemas/modules/ethereum.md#int128_max) -- [INT128\_MIN](/reference/schemas/modules/ethereum.md#int128_min) -- [INT16\_MAX](/reference/schemas/modules/ethereum.md#int16_max) -- [INT16\_MIN](/reference/schemas/modules/ethereum.md#int16_min) -- [INT256\_MAX](/reference/schemas/modules/ethereum.md#int256_max) -- [INT256\_MIN](/reference/schemas/modules/ethereum.md#int256_min) -- [INT32\_MAX](/reference/schemas/modules/ethereum.md#int32_max) -- [INT32\_MIN](/reference/schemas/modules/ethereum.md#int32_min) -- [INT64\_MAX](/reference/schemas/modules/ethereum.md#int64_max) -- [INT64\_MIN](/reference/schemas/modules/ethereum.md#int64_min) -- [INT8\_MAX](/reference/schemas/modules/ethereum.md#int8_max) -- [INT8\_MIN](/reference/schemas/modules/ethereum.md#int8_min) -- [SAddress](/reference/schemas/modules/ethereum.md#saddress-1) -- [SBytes](/reference/schemas/modules/ethereum.md#sbytes) -- [SBytes1](/reference/schemas/modules/ethereum.md#sbytes1) -- [SBytes10](/reference/schemas/modules/ethereum.md#sbytes10) -- [SBytes11](/reference/schemas/modules/ethereum.md#sbytes11) -- [SBytes12](/reference/schemas/modules/ethereum.md#sbytes12) -- [SBytes13](/reference/schemas/modules/ethereum.md#sbytes13) -- [SBytes14](/reference/schemas/modules/ethereum.md#sbytes14) -- [SBytes15](/reference/schemas/modules/ethereum.md#sbytes15) -- [SBytes16](/reference/schemas/modules/ethereum.md#sbytes16) -- [SBytes17](/reference/schemas/modules/ethereum.md#sbytes17) -- [SBytes18](/reference/schemas/modules/ethereum.md#sbytes18) -- [SBytes19](/reference/schemas/modules/ethereum.md#sbytes19) -- [SBytes2](/reference/schemas/modules/ethereum.md#sbytes2) -- [SBytes20](/reference/schemas/modules/ethereum.md#sbytes20) -- [SBytes21](/reference/schemas/modules/ethereum.md#sbytes21) -- [SBytes22](/reference/schemas/modules/ethereum.md#sbytes22) -- [SBytes23](/reference/schemas/modules/ethereum.md#sbytes23) -- [SBytes24](/reference/schemas/modules/ethereum.md#sbytes24) -- [SBytes25](/reference/schemas/modules/ethereum.md#sbytes25) -- [SBytes26](/reference/schemas/modules/ethereum.md#sbytes26) -- [SBytes27](/reference/schemas/modules/ethereum.md#sbytes27) -- [SBytes28](/reference/schemas/modules/ethereum.md#sbytes28) -- [SBytes29](/reference/schemas/modules/ethereum.md#sbytes29) -- [SBytes3](/reference/schemas/modules/ethereum.md#sbytes3) -- [SBytes30](/reference/schemas/modules/ethereum.md#sbytes30) -- [SBytes31](/reference/schemas/modules/ethereum.md#sbytes31) -- [SBytes32](/reference/schemas/modules/ethereum.md#sbytes32) -- [SBytes4](/reference/schemas/modules/ethereum.md#sbytes4) -- [SBytes5](/reference/schemas/modules/ethereum.md#sbytes5) -- [SBytes6](/reference/schemas/modules/ethereum.md#sbytes6) -- [SBytes7](/reference/schemas/modules/ethereum.md#sbytes7) -- [SBytes8](/reference/schemas/modules/ethereum.md#sbytes8) -- [SBytes9](/reference/schemas/modules/ethereum.md#sbytes9) -- [SINT128](/reference/schemas/modules/ethereum.md#sint128) -- [SINT16](/reference/schemas/modules/ethereum.md#sint16) -- [SINT256](/reference/schemas/modules/ethereum.md#sint256) -- [SINT32](/reference/schemas/modules/ethereum.md#sint32) -- [SINT64](/reference/schemas/modules/ethereum.md#sint64) -- [SINT8](/reference/schemas/modules/ethereum.md#sint8) -- [SUINT128](/reference/schemas/modules/ethereum.md#suint128) -- [SUINT16](/reference/schemas/modules/ethereum.md#suint16) -- [SUINT256](/reference/schemas/modules/ethereum.md#suint256) -- [SUINT32](/reference/schemas/modules/ethereum.md#suint32) -- [SUINT64](/reference/schemas/modules/ethereum.md#suint64) -- [SUINT8](/reference/schemas/modules/ethereum.md#suint8) -- [UINT128\_MAX](/reference/schemas/modules/ethereum.md#uint128_max) -- [UINT16\_MAX](/reference/schemas/modules/ethereum.md#uint16_max) -- [UINT256\_MAX](/reference/schemas/modules/ethereum.md#uint256_max) -- [UINT32\_MAX](/reference/schemas/modules/ethereum.md#uint32_max) -- [UINT64\_MAX](/reference/schemas/modules/ethereum.md#uint64_max) -- [UINT8\_MAX](/reference/schemas/modules/ethereum.md#uint8_max) +- [INT128\_MAX](ethereum.md#int128_max) +- [INT128\_MIN](ethereum.md#int128_min) +- [INT16\_MAX](ethereum.md#int16_max) +- [INT16\_MIN](ethereum.md#int16_min) +- [INT256\_MAX](ethereum.md#int256_max) +- [INT256\_MIN](ethereum.md#int256_min) +- [INT32\_MAX](ethereum.md#int32_max) +- [INT32\_MIN](ethereum.md#int32_min) +- [INT64\_MAX](ethereum.md#int64_max) +- [INT64\_MIN](ethereum.md#int64_min) +- [INT8\_MAX](ethereum.md#int8_max) +- [INT8\_MIN](ethereum.md#int8_min) +- [SAddress](ethereum.md#saddress-1) +- [SBytes](ethereum.md#sbytes) +- [SBytes1](ethereum.md#sbytes1) +- [SBytes10](ethereum.md#sbytes10) +- [SBytes11](ethereum.md#sbytes11) +- [SBytes12](ethereum.md#sbytes12) +- [SBytes13](ethereum.md#sbytes13) +- [SBytes14](ethereum.md#sbytes14) +- [SBytes15](ethereum.md#sbytes15) +- [SBytes16](ethereum.md#sbytes16) +- [SBytes17](ethereum.md#sbytes17) +- [SBytes18](ethereum.md#sbytes18) +- [SBytes19](ethereum.md#sbytes19) +- [SBytes2](ethereum.md#sbytes2) +- [SBytes20](ethereum.md#sbytes20) +- [SBytes21](ethereum.md#sbytes21) +- [SBytes22](ethereum.md#sbytes22) +- [SBytes23](ethereum.md#sbytes23) +- [SBytes24](ethereum.md#sbytes24) +- [SBytes25](ethereum.md#sbytes25) +- [SBytes26](ethereum.md#sbytes26) +- [SBytes27](ethereum.md#sbytes27) +- [SBytes28](ethereum.md#sbytes28) +- [SBytes29](ethereum.md#sbytes29) +- [SBytes3](ethereum.md#sbytes3) +- [SBytes30](ethereum.md#sbytes30) +- [SBytes31](ethereum.md#sbytes31) +- [SBytes32](ethereum.md#sbytes32) +- [SBytes4](ethereum.md#sbytes4) +- [SBytes5](ethereum.md#sbytes5) +- [SBytes6](ethereum.md#sbytes6) +- [SBytes7](ethereum.md#sbytes7) +- [SBytes8](ethereum.md#sbytes8) +- [SBytes9](ethereum.md#sbytes9) +- [SINT128](ethereum.md#sint128) +- [SINT16](ethereum.md#sint16) +- [SINT256](ethereum.md#sint256) +- [SINT32](ethereum.md#sint32) +- [SINT64](ethereum.md#sint64) +- [SINT8](ethereum.md#sint8) +- [SUINT128](ethereum.md#suint128) +- [SUINT16](ethereum.md#suint16) +- [SUINT256](ethereum.md#suint256) +- [SUINT32](ethereum.md#suint32) +- [SUINT64](ethereum.md#suint64) +- [SUINT8](ethereum.md#suint8) +- [UINT128\_MAX](ethereum.md#uint128_max) +- [UINT16\_MAX](ethereum.md#uint16_max) +- [UINT256\_MAX](ethereum.md#uint256_max) +- [UINT32\_MAX](ethereum.md#uint32_max) +- [UINT64\_MAX](ethereum.md#uint64_max) +- [UINT8\_MAX](ethereum.md#uint8_max) ### Functions -- [isAddress](/reference/schemas/modules/ethereum.md#isaddress) -- [isBytes](/reference/schemas/modules/ethereum.md#isbytes) -- [isBytes1](/reference/schemas/modules/ethereum.md#isbytes1) -- [isBytes10](/reference/schemas/modules/ethereum.md#isbytes10) -- [isBytes11](/reference/schemas/modules/ethereum.md#isbytes11) -- [isBytes12](/reference/schemas/modules/ethereum.md#isbytes12) -- [isBytes13](/reference/schemas/modules/ethereum.md#isbytes13) -- [isBytes14](/reference/schemas/modules/ethereum.md#isbytes14) -- [isBytes15](/reference/schemas/modules/ethereum.md#isbytes15) -- [isBytes16](/reference/schemas/modules/ethereum.md#isbytes16) -- [isBytes17](/reference/schemas/modules/ethereum.md#isbytes17) -- [isBytes18](/reference/schemas/modules/ethereum.md#isbytes18) -- [isBytes19](/reference/schemas/modules/ethereum.md#isbytes19) -- [isBytes2](/reference/schemas/modules/ethereum.md#isbytes2) -- [isBytes20](/reference/schemas/modules/ethereum.md#isbytes20) -- [isBytes21](/reference/schemas/modules/ethereum.md#isbytes21) -- [isBytes22](/reference/schemas/modules/ethereum.md#isbytes22) -- [isBytes23](/reference/schemas/modules/ethereum.md#isbytes23) -- [isBytes24](/reference/schemas/modules/ethereum.md#isbytes24) -- [isBytes25](/reference/schemas/modules/ethereum.md#isbytes25) -- [isBytes26](/reference/schemas/modules/ethereum.md#isbytes26) -- [isBytes27](/reference/schemas/modules/ethereum.md#isbytes27) -- [isBytes28](/reference/schemas/modules/ethereum.md#isbytes28) -- [isBytes29](/reference/schemas/modules/ethereum.md#isbytes29) -- [isBytes3](/reference/schemas/modules/ethereum.md#isbytes3) -- [isBytes30](/reference/schemas/modules/ethereum.md#isbytes30) -- [isBytes31](/reference/schemas/modules/ethereum.md#isbytes31) -- [isBytes32](/reference/schemas/modules/ethereum.md#isbytes32) -- [isBytes4](/reference/schemas/modules/ethereum.md#isbytes4) -- [isBytes5](/reference/schemas/modules/ethereum.md#isbytes5) -- [isBytes6](/reference/schemas/modules/ethereum.md#isbytes6) -- [isBytes7](/reference/schemas/modules/ethereum.md#isbytes7) -- [isBytes8](/reference/schemas/modules/ethereum.md#isbytes8) -- [isBytes9](/reference/schemas/modules/ethereum.md#isbytes9) -- [isINT128](/reference/schemas/modules/ethereum.md#isint128) -- [isINT16](/reference/schemas/modules/ethereum.md#isint16) -- [isINT256](/reference/schemas/modules/ethereum.md#isint256) -- [isINT32](/reference/schemas/modules/ethereum.md#isint32) -- [isINT64](/reference/schemas/modules/ethereum.md#isint64) -- [isINT8](/reference/schemas/modules/ethereum.md#isint8) -- [isUINT128](/reference/schemas/modules/ethereum.md#isuint128) -- [isUINT16](/reference/schemas/modules/ethereum.md#isuint16) -- [isUINT256](/reference/schemas/modules/ethereum.md#isuint256) -- [isUINT32](/reference/schemas/modules/ethereum.md#isuint32) -- [isUINT64](/reference/schemas/modules/ethereum.md#isuint64) -- [isUINT8](/reference/schemas/modules/ethereum.md#isuint8) -- [parseAddress](/reference/schemas/modules/ethereum.md#parseaddress) -- [parseAddressSafe](/reference/schemas/modules/ethereum.md#parseaddresssafe) -- [parseBytes](/reference/schemas/modules/ethereum.md#parsebytes) -- [parseBytes1](/reference/schemas/modules/ethereum.md#parsebytes1) -- [parseBytes10](/reference/schemas/modules/ethereum.md#parsebytes10) -- [parseBytes10Safe](/reference/schemas/modules/ethereum.md#parsebytes10safe) -- [parseBytes11](/reference/schemas/modules/ethereum.md#parsebytes11) -- [parseBytes11Safe](/reference/schemas/modules/ethereum.md#parsebytes11safe) -- [parseBytes12](/reference/schemas/modules/ethereum.md#parsebytes12) -- [parseBytes12Safe](/reference/schemas/modules/ethereum.md#parsebytes12safe) -- [parseBytes13](/reference/schemas/modules/ethereum.md#parsebytes13) -- [parseBytes13Safe](/reference/schemas/modules/ethereum.md#parsebytes13safe) -- [parseBytes14](/reference/schemas/modules/ethereum.md#parsebytes14) -- [parseBytes14Safe](/reference/schemas/modules/ethereum.md#parsebytes14safe) -- [parseBytes15](/reference/schemas/modules/ethereum.md#parsebytes15) -- [parseBytes15Safe](/reference/schemas/modules/ethereum.md#parsebytes15safe) -- [parseBytes16](/reference/schemas/modules/ethereum.md#parsebytes16) -- [parseBytes16Safe](/reference/schemas/modules/ethereum.md#parsebytes16safe) -- [parseBytes17](/reference/schemas/modules/ethereum.md#parsebytes17) -- [parseBytes17Safe](/reference/schemas/modules/ethereum.md#parsebytes17safe) -- [parseBytes18](/reference/schemas/modules/ethereum.md#parsebytes18) -- [parseBytes18Safe](/reference/schemas/modules/ethereum.md#parsebytes18safe) -- [parseBytes19](/reference/schemas/modules/ethereum.md#parsebytes19) -- [parseBytes19Safe](/reference/schemas/modules/ethereum.md#parsebytes19safe) -- [parseBytes1Safe](/reference/schemas/modules/ethereum.md#parsebytes1safe) -- [parseBytes2](/reference/schemas/modules/ethereum.md#parsebytes2) -- [parseBytes20](/reference/schemas/modules/ethereum.md#parsebytes20) -- [parseBytes20Safe](/reference/schemas/modules/ethereum.md#parsebytes20safe) -- [parseBytes21](/reference/schemas/modules/ethereum.md#parsebytes21) -- [parseBytes21Safe](/reference/schemas/modules/ethereum.md#parsebytes21safe) -- [parseBytes22](/reference/schemas/modules/ethereum.md#parsebytes22) -- [parseBytes22Safe](/reference/schemas/modules/ethereum.md#parsebytes22safe) -- [parseBytes23](/reference/schemas/modules/ethereum.md#parsebytes23) -- [parseBytes23Safe](/reference/schemas/modules/ethereum.md#parsebytes23safe) -- [parseBytes24](/reference/schemas/modules/ethereum.md#parsebytes24) -- [parseBytes24Safe](/reference/schemas/modules/ethereum.md#parsebytes24safe) -- [parseBytes25](/reference/schemas/modules/ethereum.md#parsebytes25) -- [parseBytes25Safe](/reference/schemas/modules/ethereum.md#parsebytes25safe) -- [parseBytes26](/reference/schemas/modules/ethereum.md#parsebytes26) -- [parseBytes26Safe](/reference/schemas/modules/ethereum.md#parsebytes26safe) -- [parseBytes27](/reference/schemas/modules/ethereum.md#parsebytes27) -- [parseBytes27Safe](/reference/schemas/modules/ethereum.md#parsebytes27safe) -- [parseBytes28](/reference/schemas/modules/ethereum.md#parsebytes28) -- [parseBytes28Safe](/reference/schemas/modules/ethereum.md#parsebytes28safe) -- [parseBytes29](/reference/schemas/modules/ethereum.md#parsebytes29) -- [parseBytes29Safe](/reference/schemas/modules/ethereum.md#parsebytes29safe) -- [parseBytes2Safe](/reference/schemas/modules/ethereum.md#parsebytes2safe) -- [parseBytes3](/reference/schemas/modules/ethereum.md#parsebytes3) -- [parseBytes30](/reference/schemas/modules/ethereum.md#parsebytes30) -- [parseBytes30Safe](/reference/schemas/modules/ethereum.md#parsebytes30safe) -- [parseBytes31](/reference/schemas/modules/ethereum.md#parsebytes31) -- [parseBytes31Safe](/reference/schemas/modules/ethereum.md#parsebytes31safe) -- [parseBytes32](/reference/schemas/modules/ethereum.md#parsebytes32) -- [parseBytes32Safe](/reference/schemas/modules/ethereum.md#parsebytes32safe) -- [parseBytes3Safe](/reference/schemas/modules/ethereum.md#parsebytes3safe) -- [parseBytes4](/reference/schemas/modules/ethereum.md#parsebytes4) -- [parseBytes4Safe](/reference/schemas/modules/ethereum.md#parsebytes4safe) -- [parseBytes5](/reference/schemas/modules/ethereum.md#parsebytes5) -- [parseBytes5Safe](/reference/schemas/modules/ethereum.md#parsebytes5safe) -- [parseBytes6](/reference/schemas/modules/ethereum.md#parsebytes6) -- [parseBytes6Safe](/reference/schemas/modules/ethereum.md#parsebytes6safe) -- [parseBytes7](/reference/schemas/modules/ethereum.md#parsebytes7) -- [parseBytes7Safe](/reference/schemas/modules/ethereum.md#parsebytes7safe) -- [parseBytes8](/reference/schemas/modules/ethereum.md#parsebytes8) -- [parseBytes8Safe](/reference/schemas/modules/ethereum.md#parsebytes8safe) -- [parseBytes9](/reference/schemas/modules/ethereum.md#parsebytes9) -- [parseBytes9Safe](/reference/schemas/modules/ethereum.md#parsebytes9safe) -- [parseBytesSafe](/reference/schemas/modules/ethereum.md#parsebytessafe) -- [parseINT128Safe](/reference/schemas/modules/ethereum.md#parseint128safe) -- [parseINT16Safe](/reference/schemas/modules/ethereum.md#parseint16safe) -- [parseINT256Safe](/reference/schemas/modules/ethereum.md#parseint256safe) -- [parseINT32Safe](/reference/schemas/modules/ethereum.md#parseint32safe) -- [parseINT64Safe](/reference/schemas/modules/ethereum.md#parseint64safe) -- [parseINT8Safe](/reference/schemas/modules/ethereum.md#parseint8safe) -- [parseInt128](/reference/schemas/modules/ethereum.md#parseint128) -- [parseInt16](/reference/schemas/modules/ethereum.md#parseint16) -- [parseInt256](/reference/schemas/modules/ethereum.md#parseint256) -- [parseInt32](/reference/schemas/modules/ethereum.md#parseint32) -- [parseInt64](/reference/schemas/modules/ethereum.md#parseint64) -- [parseInt8](/reference/schemas/modules/ethereum.md#parseint8) -- [parseUINT128](/reference/schemas/modules/ethereum.md#parseuint128) -- [parseUINT128Safe](/reference/schemas/modules/ethereum.md#parseuint128safe) -- [parseUINT16](/reference/schemas/modules/ethereum.md#parseuint16) -- [parseUINT16Safe](/reference/schemas/modules/ethereum.md#parseuint16safe) -- [parseUINT256](/reference/schemas/modules/ethereum.md#parseuint256) -- [parseUINT256Safe](/reference/schemas/modules/ethereum.md#parseuint256safe) -- [parseUINT32](/reference/schemas/modules/ethereum.md#parseuint32) -- [parseUINT32Safe](/reference/schemas/modules/ethereum.md#parseuint32safe) -- [parseUINT64](/reference/schemas/modules/ethereum.md#parseuint64) -- [parseUINT64Safe](/reference/schemas/modules/ethereum.md#parseuint64safe) -- [parseUINT8](/reference/schemas/modules/ethereum.md#parseuint8) -- [parseUINT8Safe](/reference/schemas/modules/ethereum.md#parseuint8safe) +- [isAddress](ethereum.md#isaddress) +- [isBytes](ethereum.md#isbytes) +- [isBytes1](ethereum.md#isbytes1) +- [isBytes10](ethereum.md#isbytes10) +- [isBytes11](ethereum.md#isbytes11) +- [isBytes12](ethereum.md#isbytes12) +- [isBytes13](ethereum.md#isbytes13) +- [isBytes14](ethereum.md#isbytes14) +- [isBytes15](ethereum.md#isbytes15) +- [isBytes16](ethereum.md#isbytes16) +- [isBytes17](ethereum.md#isbytes17) +- [isBytes18](ethereum.md#isbytes18) +- [isBytes19](ethereum.md#isbytes19) +- [isBytes2](ethereum.md#isbytes2) +- [isBytes20](ethereum.md#isbytes20) +- [isBytes21](ethereum.md#isbytes21) +- [isBytes22](ethereum.md#isbytes22) +- [isBytes23](ethereum.md#isbytes23) +- [isBytes24](ethereum.md#isbytes24) +- [isBytes25](ethereum.md#isbytes25) +- [isBytes26](ethereum.md#isbytes26) +- [isBytes27](ethereum.md#isbytes27) +- [isBytes28](ethereum.md#isbytes28) +- [isBytes29](ethereum.md#isbytes29) +- [isBytes3](ethereum.md#isbytes3) +- [isBytes30](ethereum.md#isbytes30) +- [isBytes31](ethereum.md#isbytes31) +- [isBytes32](ethereum.md#isbytes32) +- [isBytes4](ethereum.md#isbytes4) +- [isBytes5](ethereum.md#isbytes5) +- [isBytes6](ethereum.md#isbytes6) +- [isBytes7](ethereum.md#isbytes7) +- [isBytes8](ethereum.md#isbytes8) +- [isBytes9](ethereum.md#isbytes9) +- [isINT128](ethereum.md#isint128) +- [isINT16](ethereum.md#isint16) +- [isINT256](ethereum.md#isint256) +- [isINT32](ethereum.md#isint32) +- [isINT64](ethereum.md#isint64) +- [isINT8](ethereum.md#isint8) +- [isUINT128](ethereum.md#isuint128) +- [isUINT16](ethereum.md#isuint16) +- [isUINT256](ethereum.md#isuint256) +- [isUINT32](ethereum.md#isuint32) +- [isUINT64](ethereum.md#isuint64) +- [isUINT8](ethereum.md#isuint8) +- [parseAddress](ethereum.md#parseaddress) +- [parseAddressSafe](ethereum.md#parseaddresssafe) +- [parseBytes](ethereum.md#parsebytes) +- [parseBytes1](ethereum.md#parsebytes1) +- [parseBytes10](ethereum.md#parsebytes10) +- [parseBytes10Safe](ethereum.md#parsebytes10safe) +- [parseBytes11](ethereum.md#parsebytes11) +- [parseBytes11Safe](ethereum.md#parsebytes11safe) +- [parseBytes12](ethereum.md#parsebytes12) +- [parseBytes12Safe](ethereum.md#parsebytes12safe) +- [parseBytes13](ethereum.md#parsebytes13) +- [parseBytes13Safe](ethereum.md#parsebytes13safe) +- [parseBytes14](ethereum.md#parsebytes14) +- [parseBytes14Safe](ethereum.md#parsebytes14safe) +- [parseBytes15](ethereum.md#parsebytes15) +- [parseBytes15Safe](ethereum.md#parsebytes15safe) +- [parseBytes16](ethereum.md#parsebytes16) +- [parseBytes16Safe](ethereum.md#parsebytes16safe) +- [parseBytes17](ethereum.md#parsebytes17) +- [parseBytes17Safe](ethereum.md#parsebytes17safe) +- [parseBytes18](ethereum.md#parsebytes18) +- [parseBytes18Safe](ethereum.md#parsebytes18safe) +- [parseBytes19](ethereum.md#parsebytes19) +- [parseBytes19Safe](ethereum.md#parsebytes19safe) +- [parseBytes1Safe](ethereum.md#parsebytes1safe) +- [parseBytes2](ethereum.md#parsebytes2) +- [parseBytes20](ethereum.md#parsebytes20) +- [parseBytes20Safe](ethereum.md#parsebytes20safe) +- [parseBytes21](ethereum.md#parsebytes21) +- [parseBytes21Safe](ethereum.md#parsebytes21safe) +- [parseBytes22](ethereum.md#parsebytes22) +- [parseBytes22Safe](ethereum.md#parsebytes22safe) +- [parseBytes23](ethereum.md#parsebytes23) +- [parseBytes23Safe](ethereum.md#parsebytes23safe) +- [parseBytes24](ethereum.md#parsebytes24) +- [parseBytes24Safe](ethereum.md#parsebytes24safe) +- [parseBytes25](ethereum.md#parsebytes25) +- [parseBytes25Safe](ethereum.md#parsebytes25safe) +- [parseBytes26](ethereum.md#parsebytes26) +- [parseBytes26Safe](ethereum.md#parsebytes26safe) +- [parseBytes27](ethereum.md#parsebytes27) +- [parseBytes27Safe](ethereum.md#parsebytes27safe) +- [parseBytes28](ethereum.md#parsebytes28) +- [parseBytes28Safe](ethereum.md#parsebytes28safe) +- [parseBytes29](ethereum.md#parsebytes29) +- [parseBytes29Safe](ethereum.md#parsebytes29safe) +- [parseBytes2Safe](ethereum.md#parsebytes2safe) +- [parseBytes3](ethereum.md#parsebytes3) +- [parseBytes30](ethereum.md#parsebytes30) +- [parseBytes30Safe](ethereum.md#parsebytes30safe) +- [parseBytes31](ethereum.md#parsebytes31) +- [parseBytes31Safe](ethereum.md#parsebytes31safe) +- [parseBytes32](ethereum.md#parsebytes32) +- [parseBytes32Safe](ethereum.md#parsebytes32safe) +- [parseBytes3Safe](ethereum.md#parsebytes3safe) +- [parseBytes4](ethereum.md#parsebytes4) +- [parseBytes4Safe](ethereum.md#parsebytes4safe) +- [parseBytes5](ethereum.md#parsebytes5) +- [parseBytes5Safe](ethereum.md#parsebytes5safe) +- [parseBytes6](ethereum.md#parsebytes6) +- [parseBytes6Safe](ethereum.md#parsebytes6safe) +- [parseBytes7](ethereum.md#parsebytes7) +- [parseBytes7Safe](ethereum.md#parsebytes7safe) +- [parseBytes8](ethereum.md#parsebytes8) +- [parseBytes8Safe](ethereum.md#parsebytes8safe) +- [parseBytes9](ethereum.md#parsebytes9) +- [parseBytes9Safe](ethereum.md#parsebytes9safe) +- [parseBytesSafe](ethereum.md#parsebytessafe) +- [parseINT128Safe](ethereum.md#parseint128safe) +- [parseINT16Safe](ethereum.md#parseint16safe) +- [parseINT256Safe](ethereum.md#parseint256safe) +- [parseINT32Safe](ethereum.md#parseint32safe) +- [parseINT64Safe](ethereum.md#parseint64safe) +- [parseINT8Safe](ethereum.md#parseint8safe) +- [parseInt128](ethereum.md#parseint128) +- [parseInt16](ethereum.md#parseint16) +- [parseInt256](ethereum.md#parseint256) +- [parseInt32](ethereum.md#parseint32) +- [parseInt64](ethereum.md#parseint64) +- [parseInt8](ethereum.md#parseint8) +- [parseUINT128](ethereum.md#parseuint128) +- [parseUINT128Safe](ethereum.md#parseuint128safe) +- [parseUINT16](ethereum.md#parseuint16) +- [parseUINT16Safe](ethereum.md#parseuint16safe) +- [parseUINT256](ethereum.md#parseuint256) +- [parseUINT256Safe](ethereum.md#parseuint256safe) +- [parseUINT32](ethereum.md#parseuint32) +- [parseUINT32Safe](ethereum.md#parseuint32safe) +- [parseUINT64](ethereum.md#parseuint64) +- [parseUINT64Safe](ethereum.md#parseuint64safe) +- [parseUINT8](ethereum.md#parseuint8) +- [parseUINT8Safe](ethereum.md#parseuint8safe) ## Type Aliases @@ -781,7 +781,7 @@ ___ ### SAddress -Ƭ **SAddress**<\>: [`SAddressSchema`](/reference/schemas/modules/ethereum.md#saddressschema) +Ƭ **SAddress**<\>: [`SAddressSchema`](ethereum.md#saddressschema) Effect/schema for Address type. [effect/schema](https://github.com/Effect-TS/schema) representing a valid Ethereum address. @@ -892,7 +892,7 @@ ___ • `Const` **INT128\_MAX**: `bigint` -The maximum value a [INT128](/reference/schemas/modules/ethereum.md#int128) can be. +The maximum value a [INT128](ethereum.md#int128) can be. [Solidity docs](https://docs.soliditylang.org/en/latest/types.html#integers) #### Defined in @@ -905,7 +905,7 @@ ___ • `Const` **INT128\_MIN**: `bigint` = `-BigInt('0x80000000000000000000000000000000')` -The minimum value a [INT128](/reference/schemas/modules/ethereum.md#int128) can be. +The minimum value a [INT128](ethereum.md#int128) can be. [Solidity docs](https://docs.soliditylang.org/en/latest/types.html#integers) #### Defined in @@ -918,7 +918,7 @@ ___ • `Const` **INT16\_MAX**: `bigint` -The maximum value a [INT16](/reference/schemas/modules/ethereum.md#int16) can be. +The maximum value a [INT16](ethereum.md#int16) can be. [Solidity docs](https://docs.soliditylang.org/en/latest/types.html#integers) #### Defined in @@ -931,7 +931,7 @@ ___ • `Const` **INT16\_MIN**: `bigint` = `-BigInt('0x8000')` -The minimum value a [INT16](/reference/schemas/modules/ethereum.md#int16) can be. +The minimum value a [INT16](ethereum.md#int16) can be. [Solidity docs](https://docs.soliditylang.org/en/latest/types.html#integers) #### Defined in @@ -944,7 +944,7 @@ ___ • `Const` **INT256\_MAX**: `bigint` -The maximum value a [INT256](/reference/schemas/modules/ethereum.md#int256) can be. +The maximum value a [INT256](ethereum.md#int256) can be. [Solidity docs](https://docs.soliditylang.org/en/latest/types.html#integers) #### Defined in @@ -957,7 +957,7 @@ ___ • `Const` **INT256\_MIN**: `bigint` = `-BigInt( '0x7FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF',)` -The minimum value a [INT256](/reference/schemas/modules/ethereum.md#int256) can be. +The minimum value a [INT256](ethereum.md#int256) can be. [Solidity docs](https://docs.soliditylang.org/en/latest/types.html#integers) #### Defined in @@ -970,7 +970,7 @@ ___ • `Const` **INT32\_MAX**: `bigint` -The maximum value a [INT32](/reference/schemas/modules/ethereum.md#int32) can be. +The maximum value a [INT32](ethereum.md#int32) can be. [Solidity docs](https://docs.soliditylang.org/en/latest/types.html#integers) #### Defined in @@ -983,7 +983,7 @@ ___ • `Const` **INT32\_MIN**: `bigint` = `-BigInt('0x80000000')` -The minimum value a [INT32](/reference/schemas/modules/ethereum.md#int32) can be. +The minimum value a [INT32](ethereum.md#int32) can be. [Solidity docs](https://docs.soliditylang.org/en/latest/types.html#integers) #### Defined in @@ -996,7 +996,7 @@ ___ • `Const` **INT64\_MAX**: `bigint` -The maximum value a [INT64](/reference/schemas/modules/ethereum.md#int64) can be. +The maximum value a [INT64](ethereum.md#int64) can be. [Solidity docs](https://docs.soliditylang.org/en/latest/types.html#integers) #### Defined in @@ -1009,7 +1009,7 @@ ___ • `Const` **INT64\_MIN**: `bigint` = `-BigInt('0x8000000000000000')` -The minimum value a [INT64](/reference/schemas/modules/ethereum.md#int64) can be. +The minimum value a [INT64](ethereum.md#int64) can be. [Solidity docs](https://docs.soliditylang.org/en/latest/types.html#integers) #### Defined in @@ -1022,7 +1022,7 @@ ___ • `Const` **INT8\_MAX**: `bigint` -The maximum value a [INT8](/reference/schemas/modules/ethereum.md#int8) can be. +The maximum value a [INT8](ethereum.md#int8) can be. [Solidity docs](https://docs.soliditylang.org/en/latest/types.html#integers) #### Defined in @@ -1035,7 +1035,7 @@ ___ • `Const` **INT8\_MIN**: `bigint` = `-BigInt('0x80')` -The minimum value a [INT8](/reference/schemas/modules/ethereum.md#int8) can be. +The minimum value a [INT8](ethereum.md#int8) can be. [Solidity docs](https://docs.soliditylang.org/en/latest/types.html#integers) #### Defined in @@ -1703,7 +1703,7 @@ ___ • `Const` **UINT128\_MAX**: `bigint` -The maximum value a [UINT128](/reference/schemas/modules/ethereum.md#uint128) can be. +The maximum value a [UINT128](ethereum.md#uint128) can be. [Solidity docs](https://docs.soliditylang.org/en/latest/types.html#integers) #### Defined in @@ -1716,7 +1716,7 @@ ___ • `Const` **UINT16\_MAX**: `bigint` -The maximum value a [UINT16](/reference/schemas/modules/ethereum.md#uint16) can be. +The maximum value a [UINT16](ethereum.md#uint16) can be. [Solidity docs](https://docs.soliditylang.org/en/latest/types.html#integers) #### Defined in @@ -1729,7 +1729,7 @@ ___ • `Const` **UINT256\_MAX**: `bigint` -The maximum value a [UINT256](/reference/schemas/modules/ethereum.md#uint256) can be. +The maximum value a [UINT256](ethereum.md#uint256) can be. [Solidity docs](https://docs.soliditylang.org/en/latest/types.html#integers) #### Defined in @@ -1742,7 +1742,7 @@ ___ • `Const` **UINT32\_MAX**: `bigint` -The maximum value a [UINT32](/reference/schemas/modules/ethereum.md#uint32) can be. +The maximum value a [UINT32](ethereum.md#uint32) can be. [Solidity docs](https://docs.soliditylang.org/en/latest/types.html#integers) #### Defined in @@ -1755,7 +1755,7 @@ ___ • `Const` **UINT64\_MAX**: `bigint` -The maximum value a [UINT64](/reference/schemas/modules/ethereum.md#uint64) can be. +The maximum value a [UINT64](ethereum.md#uint64) can be. [Solidity docs](https://docs.soliditylang.org/en/latest/types.html#integers) #### Defined in @@ -1768,7 +1768,7 @@ ___ • `Const` **UINT8\_MAX**: `bigint` -The maximum value a [UINT8](/reference/schemas/modules/ethereum.md#uint8) can be. +The maximum value a [UINT8](ethereum.md#uint8) can be. [Solidity docs](https://docs.soliditylang.org/en/latest/types.html#integers) #### Defined in @@ -3209,7 +3209,7 @@ ___ ### parseAddressSafe -▸ **parseAddressSafe**<`TAddress`\>(`address`): `Effect`<`never`, [`InvalidAddressError`](/reference/schemas/classes/ethereum.InvalidAddressError.md), `TAddress`\> +▸ **parseAddressSafe**<`TAddress`\>(`address`): `Effect`<`never`, [`InvalidAddressError`](../classes/ethereum.InvalidAddressError.md), `TAddress`\> Parses an Address safely into an effect. @@ -3227,7 +3227,7 @@ Parses an Address safely into an effect. #### Returns -`Effect`<`never`, [`InvalidAddressError`](/reference/schemas/classes/ethereum.InvalidAddressError.md), `TAddress`\> +`Effect`<`never`, [`InvalidAddressError`](../classes/ethereum.InvalidAddressError.md), `TAddress`\> - An effect that resolves to the parsed address. @@ -3343,7 +3343,7 @@ ___ ### parseBytes10Safe -▸ **parseBytes10Safe**<`TBytes10`\>(`bytes10`): `Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes10`\> +▸ **parseBytes10Safe**<`TBytes10`\>(`bytes10`): `Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes10`\> Safely parses a Bytes10 into an [Effect](https://www.effect.website/docs/essentials/effect-type). @@ -3361,7 +3361,7 @@ Safely parses a Bytes10 into an [Effect](https://www.effect.website/docs/essenti #### Returns -`Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes10`\> +`Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes10`\> #### Defined in @@ -3406,7 +3406,7 @@ ___ ### parseBytes11Safe -▸ **parseBytes11Safe**<`TBytes11`\>(`bytes11`): `Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes11`\> +▸ **parseBytes11Safe**<`TBytes11`\>(`bytes11`): `Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes11`\> Safely parses a Bytes11 into an [Effect](https://www.effect.website/docs/essentials/effect-type). @@ -3424,7 +3424,7 @@ Safely parses a Bytes11 into an [Effect](https://www.effect.website/docs/essenti #### Returns -`Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes11`\> +`Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes11`\> #### Defined in @@ -3469,7 +3469,7 @@ ___ ### parseBytes12Safe -▸ **parseBytes12Safe**<`TBytes12`\>(`bytes12`): `Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes12`\> +▸ **parseBytes12Safe**<`TBytes12`\>(`bytes12`): `Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes12`\> Safely parses a Bytes12 into an [Effect](https://www.effect.website/docs/essentials/effect-type). @@ -3487,7 +3487,7 @@ Safely parses a Bytes12 into an [Effect](https://www.effect.website/docs/essenti #### Returns -`Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes12`\> +`Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes12`\> #### Defined in @@ -3532,7 +3532,7 @@ ___ ### parseBytes13Safe -▸ **parseBytes13Safe**<`TBytes13`\>(`bytes13`): `Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes13`\> +▸ **parseBytes13Safe**<`TBytes13`\>(`bytes13`): `Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes13`\> Safely parses a Bytes13 into an [Effect](https://www.effect.website/docs/essentials/effect-type). @@ -3550,7 +3550,7 @@ Safely parses a Bytes13 into an [Effect](https://www.effect.website/docs/essenti #### Returns -`Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes13`\> +`Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes13`\> #### Defined in @@ -3595,7 +3595,7 @@ ___ ### parseBytes14Safe -▸ **parseBytes14Safe**<`TBytes14`\>(`bytes14`): `Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes14`\> +▸ **parseBytes14Safe**<`TBytes14`\>(`bytes14`): `Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes14`\> Safely parses a Bytes14 into an [Effect](https://www.effect.website/docs/essentials/effect-type). @@ -3613,7 +3613,7 @@ Safely parses a Bytes14 into an [Effect](https://www.effect.website/docs/essenti #### Returns -`Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes14`\> +`Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes14`\> #### Defined in @@ -3658,7 +3658,7 @@ ___ ### parseBytes15Safe -▸ **parseBytes15Safe**<`TBytes15`\>(`bytes15`): `Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes15`\> +▸ **parseBytes15Safe**<`TBytes15`\>(`bytes15`): `Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes15`\> Safely parses a Bytes15 into an [Effect](https://www.effect.website/docs/essentials/effect-type). @@ -3676,7 +3676,7 @@ Safely parses a Bytes15 into an [Effect](https://www.effect.website/docs/essenti #### Returns -`Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes15`\> +`Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes15`\> #### Defined in @@ -3721,7 +3721,7 @@ ___ ### parseBytes16Safe -▸ **parseBytes16Safe**<`TBytes16`\>(`bytes16`): `Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes16`\> +▸ **parseBytes16Safe**<`TBytes16`\>(`bytes16`): `Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes16`\> Safely parses a Bytes16 into an [Effect](https://www.effect.website/docs/essentials/effect-type). @@ -3739,7 +3739,7 @@ Safely parses a Bytes16 into an [Effect](https://www.effect.website/docs/essenti #### Returns -`Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes16`\> +`Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes16`\> #### Defined in @@ -3784,7 +3784,7 @@ ___ ### parseBytes17Safe -▸ **parseBytes17Safe**<`TBytes17`\>(`bytes17`): `Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes17`\> +▸ **parseBytes17Safe**<`TBytes17`\>(`bytes17`): `Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes17`\> Safely parses a Bytes17 into an [Effect](https://www.effect.website/docs/essentials/effect-type). @@ -3802,7 +3802,7 @@ Safely parses a Bytes17 into an [Effect](https://www.effect.website/docs/essenti #### Returns -`Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes17`\> +`Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes17`\> #### Defined in @@ -3847,7 +3847,7 @@ ___ ### parseBytes18Safe -▸ **parseBytes18Safe**<`TBytes18`\>(`bytes18`): `Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes18`\> +▸ **parseBytes18Safe**<`TBytes18`\>(`bytes18`): `Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes18`\> Safely parses a Bytes18 into an [Effect](https://www.effect.website/docs/essentials/effect-type). @@ -3865,7 +3865,7 @@ Safely parses a Bytes18 into an [Effect](https://www.effect.website/docs/essenti #### Returns -`Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes18`\> +`Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes18`\> #### Defined in @@ -3910,7 +3910,7 @@ ___ ### parseBytes19Safe -▸ **parseBytes19Safe**<`TBytes19`\>(`bytes19`): `Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes19`\> +▸ **parseBytes19Safe**<`TBytes19`\>(`bytes19`): `Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes19`\> Safely parses a Bytes19 into an [Effect](https://www.effect.website/docs/essentials/effect-type). @@ -3928,7 +3928,7 @@ Safely parses a Bytes19 into an [Effect](https://www.effect.website/docs/essenti #### Returns -`Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes19`\> +`Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes19`\> #### Defined in @@ -3938,7 +3938,7 @@ ___ ### parseBytes1Safe -▸ **parseBytes1Safe**<`TBytes1`\>(`bytes1`): `Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes1`\> +▸ **parseBytes1Safe**<`TBytes1`\>(`bytes1`): `Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes1`\> Safely parses a Bytes1 into an [Effect](https://www.effect.website/docs/essentials/effect-type). @@ -3956,7 +3956,7 @@ Safely parses a Bytes1 into an [Effect](https://www.effect.website/docs/essentia #### Returns -`Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes1`\> +`Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes1`\> #### Defined in @@ -4036,7 +4036,7 @@ ___ ### parseBytes20Safe -▸ **parseBytes20Safe**<`TBytes20`\>(`bytes20`): `Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes20`\> +▸ **parseBytes20Safe**<`TBytes20`\>(`bytes20`): `Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes20`\> Safely parses a Bytes20 into an [Effect](https://www.effect.website/docs/essentials/effect-type). @@ -4054,7 +4054,7 @@ Safely parses a Bytes20 into an [Effect](https://www.effect.website/docs/essenti #### Returns -`Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes20`\> +`Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes20`\> #### Defined in @@ -4099,7 +4099,7 @@ ___ ### parseBytes21Safe -▸ **parseBytes21Safe**<`TBytes21`\>(`bytes21`): `Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes21`\> +▸ **parseBytes21Safe**<`TBytes21`\>(`bytes21`): `Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes21`\> Safely parses a Bytes21 into an [Effect](https://www.effect.website/docs/essentials/effect-type). @@ -4117,7 +4117,7 @@ Safely parses a Bytes21 into an [Effect](https://www.effect.website/docs/essenti #### Returns -`Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes21`\> +`Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes21`\> #### Defined in @@ -4162,7 +4162,7 @@ ___ ### parseBytes22Safe -▸ **parseBytes22Safe**<`TBytes22`\>(`bytes22`): `Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes22`\> +▸ **parseBytes22Safe**<`TBytes22`\>(`bytes22`): `Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes22`\> Safely parses a Bytes22 into an [Effect](https://www.effect.website/docs/essentials/effect-type). @@ -4180,7 +4180,7 @@ Safely parses a Bytes22 into an [Effect](https://www.effect.website/docs/essenti #### Returns -`Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes22`\> +`Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes22`\> #### Defined in @@ -4225,7 +4225,7 @@ ___ ### parseBytes23Safe -▸ **parseBytes23Safe**<`TBytes23`\>(`bytes23`): `Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes23`\> +▸ **parseBytes23Safe**<`TBytes23`\>(`bytes23`): `Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes23`\> Safely parses a Bytes23 into an [Effect](https://www.effect.website/docs/essentials/effect-type). @@ -4243,7 +4243,7 @@ Safely parses a Bytes23 into an [Effect](https://www.effect.website/docs/essenti #### Returns -`Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes23`\> +`Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes23`\> #### Defined in @@ -4288,7 +4288,7 @@ ___ ### parseBytes24Safe -▸ **parseBytes24Safe**<`TBytes24`\>(`bytes24`): `Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes24`\> +▸ **parseBytes24Safe**<`TBytes24`\>(`bytes24`): `Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes24`\> Safely parses a Bytes24 into an [Effect](https://www.effect.website/docs/essentials/effect-type). @@ -4306,7 +4306,7 @@ Safely parses a Bytes24 into an [Effect](https://www.effect.website/docs/essenti #### Returns -`Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes24`\> +`Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes24`\> #### Defined in @@ -4351,7 +4351,7 @@ ___ ### parseBytes25Safe -▸ **parseBytes25Safe**<`TBytes25`\>(`bytes25`): `Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes25`\> +▸ **parseBytes25Safe**<`TBytes25`\>(`bytes25`): `Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes25`\> Safely parses a Bytes25 into an [Effect](https://www.effect.website/docs/essentials/effect-type). @@ -4369,7 +4369,7 @@ Safely parses a Bytes25 into an [Effect](https://www.effect.website/docs/essenti #### Returns -`Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes25`\> +`Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes25`\> #### Defined in @@ -4414,7 +4414,7 @@ ___ ### parseBytes26Safe -▸ **parseBytes26Safe**<`TBytes26`\>(`bytes26`): `Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes26`\> +▸ **parseBytes26Safe**<`TBytes26`\>(`bytes26`): `Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes26`\> Safely parses a Bytes26 into an [Effect](https://www.effect.website/docs/essentials/effect-type). @@ -4432,7 +4432,7 @@ Safely parses a Bytes26 into an [Effect](https://www.effect.website/docs/essenti #### Returns -`Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes26`\> +`Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes26`\> #### Defined in @@ -4477,7 +4477,7 @@ ___ ### parseBytes27Safe -▸ **parseBytes27Safe**<`TBytes27`\>(`bytes27`): `Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes27`\> +▸ **parseBytes27Safe**<`TBytes27`\>(`bytes27`): `Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes27`\> Safely parses a Bytes27 into an [Effect](https://www.effect.website/docs/essentials/effect-type). @@ -4495,7 +4495,7 @@ Safely parses a Bytes27 into an [Effect](https://www.effect.website/docs/essenti #### Returns -`Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes27`\> +`Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes27`\> #### Defined in @@ -4540,7 +4540,7 @@ ___ ### parseBytes28Safe -▸ **parseBytes28Safe**<`TBytes28`\>(`bytes28`): `Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes28`\> +▸ **parseBytes28Safe**<`TBytes28`\>(`bytes28`): `Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes28`\> Safely parses a Bytes28 into an [Effect](https://www.effect.website/docs/essentials/effect-type). @@ -4558,7 +4558,7 @@ Safely parses a Bytes28 into an [Effect](https://www.effect.website/docs/essenti #### Returns -`Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes28`\> +`Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes28`\> #### Defined in @@ -4603,7 +4603,7 @@ ___ ### parseBytes29Safe -▸ **parseBytes29Safe**<`TBytes29`\>(`bytes29`): `Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes29`\> +▸ **parseBytes29Safe**<`TBytes29`\>(`bytes29`): `Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes29`\> Safely parses a Bytes29 into an [Effect](https://www.effect.website/docs/essentials/effect-type). @@ -4621,7 +4621,7 @@ Safely parses a Bytes29 into an [Effect](https://www.effect.website/docs/essenti #### Returns -`Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes29`\> +`Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes29`\> #### Defined in @@ -4631,7 +4631,7 @@ ___ ### parseBytes2Safe -▸ **parseBytes2Safe**<`TBytes2`\>(`bytes2`): `Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes2`\> +▸ **parseBytes2Safe**<`TBytes2`\>(`bytes2`): `Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes2`\> Safely parses a Bytes2 into an [Effect](https://www.effect.website/docs/essentials/effect-type). @@ -4649,7 +4649,7 @@ Safely parses a Bytes2 into an [Effect](https://www.effect.website/docs/essentia #### Returns -`Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes2`\> +`Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes2`\> #### Defined in @@ -4729,7 +4729,7 @@ ___ ### parseBytes30Safe -▸ **parseBytes30Safe**<`TBytes30`\>(`bytes30`): `Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes30`\> +▸ **parseBytes30Safe**<`TBytes30`\>(`bytes30`): `Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes30`\> Safely parses a Bytes30 into an [Effect](https://www.effect.website/docs/essentials/effect-type). @@ -4747,7 +4747,7 @@ Safely parses a Bytes30 into an [Effect](https://www.effect.website/docs/essenti #### Returns -`Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes30`\> +`Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes30`\> #### Defined in @@ -4792,7 +4792,7 @@ ___ ### parseBytes31Safe -▸ **parseBytes31Safe**<`TBytes31`\>(`bytes31`): `Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes31`\> +▸ **parseBytes31Safe**<`TBytes31`\>(`bytes31`): `Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes31`\> Safely parses a Bytes31 into an [Effect](https://www.effect.website/docs/essentials/effect-type). @@ -4810,7 +4810,7 @@ Safely parses a Bytes31 into an [Effect](https://www.effect.website/docs/essenti #### Returns -`Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes31`\> +`Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes31`\> #### Defined in @@ -4855,7 +4855,7 @@ ___ ### parseBytes32Safe -▸ **parseBytes32Safe**<`TBytes32`\>(`bytes32`): `Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes32`\> +▸ **parseBytes32Safe**<`TBytes32`\>(`bytes32`): `Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes32`\> Safely parses a Bytes32 into an [Effect](https://www.effect.website/docs/essentials/effect-type). @@ -4873,7 +4873,7 @@ Safely parses a Bytes32 into an [Effect](https://www.effect.website/docs/essenti #### Returns -`Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes32`\> +`Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes32`\> #### Defined in @@ -4883,7 +4883,7 @@ ___ ### parseBytes3Safe -▸ **parseBytes3Safe**<`TBytes3`\>(`bytes3`): `Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes3`\> +▸ **parseBytes3Safe**<`TBytes3`\>(`bytes3`): `Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes3`\> Safely parses a Bytes3 into an [Effect](https://www.effect.website/docs/essentials/effect-type). @@ -4901,7 +4901,7 @@ Safely parses a Bytes3 into an [Effect](https://www.effect.website/docs/essentia #### Returns -`Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes3`\> +`Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes3`\> #### Defined in @@ -4946,7 +4946,7 @@ ___ ### parseBytes4Safe -▸ **parseBytes4Safe**<`TBytes4`\>(`bytes4`): `Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes4`\> +▸ **parseBytes4Safe**<`TBytes4`\>(`bytes4`): `Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes4`\> Safely parses a Bytes4 into an [Effect](https://www.effect.website/docs/essentials/effect-type). @@ -4964,7 +4964,7 @@ Safely parses a Bytes4 into an [Effect](https://www.effect.website/docs/essentia #### Returns -`Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes4`\> +`Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes4`\> #### Defined in @@ -5009,7 +5009,7 @@ ___ ### parseBytes5Safe -▸ **parseBytes5Safe**<`TBytes5`\>(`bytes5`): `Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes5`\> +▸ **parseBytes5Safe**<`TBytes5`\>(`bytes5`): `Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes5`\> Safely parses a Bytes5 into an [Effect](https://www.effect.website/docs/essentials/effect-type). @@ -5027,7 +5027,7 @@ Safely parses a Bytes5 into an [Effect](https://www.effect.website/docs/essentia #### Returns -`Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes5`\> +`Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes5`\> #### Defined in @@ -5072,7 +5072,7 @@ ___ ### parseBytes6Safe -▸ **parseBytes6Safe**<`TBytes6`\>(`bytes6`): `Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes6`\> +▸ **parseBytes6Safe**<`TBytes6`\>(`bytes6`): `Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes6`\> Safely parses a Bytes6 into an [Effect](https://www.effect.website/docs/essentials/effect-type). @@ -5090,7 +5090,7 @@ Safely parses a Bytes6 into an [Effect](https://www.effect.website/docs/essentia #### Returns -`Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes6`\> +`Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes6`\> #### Defined in @@ -5135,7 +5135,7 @@ ___ ### parseBytes7Safe -▸ **parseBytes7Safe**<`TBytes7`\>(`bytes7`): `Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes7`\> +▸ **parseBytes7Safe**<`TBytes7`\>(`bytes7`): `Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes7`\> Safely parses a Bytes7 into an [Effect](https://www.effect.website/docs/essentials/effect-type). @@ -5153,7 +5153,7 @@ Safely parses a Bytes7 into an [Effect](https://www.effect.website/docs/essentia #### Returns -`Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes7`\> +`Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes7`\> #### Defined in @@ -5198,7 +5198,7 @@ ___ ### parseBytes8Safe -▸ **parseBytes8Safe**<`TBytes8`\>(`bytes8`): `Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes8`\> +▸ **parseBytes8Safe**<`TBytes8`\>(`bytes8`): `Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes8`\> Safely parses a Bytes8 into an [Effect](https://www.effect.website/docs/essentials/effect-type). @@ -5216,7 +5216,7 @@ Safely parses a Bytes8 into an [Effect](https://www.effect.website/docs/essentia #### Returns -`Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes8`\> +`Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes8`\> #### Defined in @@ -5261,7 +5261,7 @@ ___ ### parseBytes9Safe -▸ **parseBytes9Safe**<`TBytes9`\>(`bytes9`): `Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes9`\> +▸ **parseBytes9Safe**<`TBytes9`\>(`bytes9`): `Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes9`\> Safely parses a Bytes9 into an [Effect](https://www.effect.website/docs/essentials/effect-type). @@ -5279,7 +5279,7 @@ Safely parses a Bytes9 into an [Effect](https://www.effect.website/docs/essentia #### Returns -`Effect`<`never`, [`InvalidBytesFixedError`](/reference/schemas/classes/ethereum.InvalidBytesFixedError.md), `TBytes9`\> +`Effect`<`never`, [`InvalidBytesFixedError`](../classes/ethereum.InvalidBytesFixedError.md), `TBytes9`\> #### Defined in @@ -5289,7 +5289,7 @@ ___ ### parseBytesSafe -▸ **parseBytesSafe**<`TBytes`\>(`value`): `Effect`<`never`, [`InvalidBytesError`](/reference/schemas/classes/ethereum.InvalidBytesError.md), `TBytes`\> +▸ **parseBytesSafe**<`TBytes`\>(`value`): `Effect`<`never`, [`InvalidBytesError`](../classes/ethereum.InvalidBytesError.md), `TBytes`\> Safely parses a Bytes into an [Effect](https://www.effect.website/docs/essentials/effect-type). @@ -5307,7 +5307,7 @@ Safely parses a Bytes into an [Effect](https://www.effect.website/docs/essential #### Returns -`Effect`<`never`, [`InvalidBytesError`](/reference/schemas/classes/ethereum.InvalidBytesError.md), `TBytes`\> +`Effect`<`never`, [`InvalidBytesError`](../classes/ethereum.InvalidBytesError.md), `TBytes`\> **`Example`** @@ -5324,7 +5324,7 @@ ___ ### parseINT128Safe -▸ **parseINT128Safe**<`TINT128`\>(`int128`): `Effect`<`never`, [`InvalidINTError`](/reference/schemas/classes/ethereum.InvalidINTError.md), `TINT128`\> +▸ **parseINT128Safe**<`TINT128`\>(`int128`): `Effect`<`never`, [`InvalidINTError`](../classes/ethereum.InvalidINTError.md), `TINT128`\> Safely parses an INT128 into an [Effect](https://www.effect.website/docs/essentials/effect-type). @@ -5342,7 +5342,7 @@ Safely parses an INT128 into an [Effect](https://www.effect.website/docs/essenti #### Returns -`Effect`<`never`, [`InvalidINTError`](/reference/schemas/classes/ethereum.InvalidINTError.md), `TINT128`\> +`Effect`<`never`, [`InvalidINTError`](../classes/ethereum.InvalidINTError.md), `TINT128`\> #### Defined in @@ -5352,7 +5352,7 @@ ___ ### parseINT16Safe -▸ **parseINT16Safe**<`TINT16`\>(`int16`): `Effect`<`never`, [`InvalidINTError`](/reference/schemas/classes/ethereum.InvalidINTError.md), `TINT16`\> +▸ **parseINT16Safe**<`TINT16`\>(`int16`): `Effect`<`never`, [`InvalidINTError`](../classes/ethereum.InvalidINTError.md), `TINT16`\> Safely parses an INT16 into an [Effect](https://www.effect.website/docs/essentials/effect-type). @@ -5370,7 +5370,7 @@ Safely parses an INT16 into an [Effect](https://www.effect.website/docs/essentia #### Returns -`Effect`<`never`, [`InvalidINTError`](/reference/schemas/classes/ethereum.InvalidINTError.md), `TINT16`\> +`Effect`<`never`, [`InvalidINTError`](../classes/ethereum.InvalidINTError.md), `TINT16`\> #### Defined in @@ -5380,7 +5380,7 @@ ___ ### parseINT256Safe -▸ **parseINT256Safe**<`TINT256`\>(`int256`): `Effect`<`never`, [`InvalidINTError`](/reference/schemas/classes/ethereum.InvalidINTError.md), `TINT256`\> +▸ **parseINT256Safe**<`TINT256`\>(`int256`): `Effect`<`never`, [`InvalidINTError`](../classes/ethereum.InvalidINTError.md), `TINT256`\> Safely parses an INT256 into an [Effect](https://www.effect.website/docs/essentials/effect-type). @@ -5398,7 +5398,7 @@ Safely parses an INT256 into an [Effect](https://www.effect.website/docs/essenti #### Returns -`Effect`<`never`, [`InvalidINTError`](/reference/schemas/classes/ethereum.InvalidINTError.md), `TINT256`\> +`Effect`<`never`, [`InvalidINTError`](../classes/ethereum.InvalidINTError.md), `TINT256`\> #### Defined in @@ -5408,7 +5408,7 @@ ___ ### parseINT32Safe -▸ **parseINT32Safe**<`TINT32`\>(`int32`): `Effect`<`never`, [`InvalidINTError`](/reference/schemas/classes/ethereum.InvalidINTError.md), `TINT32`\> +▸ **parseINT32Safe**<`TINT32`\>(`int32`): `Effect`<`never`, [`InvalidINTError`](../classes/ethereum.InvalidINTError.md), `TINT32`\> Safely parses an INT32 into an [Effect](https://www.effect.website/docs/essentials/effect-type). @@ -5426,7 +5426,7 @@ Safely parses an INT32 into an [Effect](https://www.effect.website/docs/essentia #### Returns -`Effect`<`never`, [`InvalidINTError`](/reference/schemas/classes/ethereum.InvalidINTError.md), `TINT32`\> +`Effect`<`never`, [`InvalidINTError`](../classes/ethereum.InvalidINTError.md), `TINT32`\> #### Defined in @@ -5436,7 +5436,7 @@ ___ ### parseINT64Safe -▸ **parseINT64Safe**<`TINT64`\>(`int64`): `Effect`<`never`, [`InvalidINTError`](/reference/schemas/classes/ethereum.InvalidINTError.md), `TINT64`\> +▸ **parseINT64Safe**<`TINT64`\>(`int64`): `Effect`<`never`, [`InvalidINTError`](../classes/ethereum.InvalidINTError.md), `TINT64`\> Safely parses an INT64 into an [Effect](https://www.effect.website/docs/essentials/effect-type). @@ -5454,7 +5454,7 @@ Safely parses an INT64 into an [Effect](https://www.effect.website/docs/essentia #### Returns -`Effect`<`never`, [`InvalidINTError`](/reference/schemas/classes/ethereum.InvalidINTError.md), `TINT64`\> +`Effect`<`never`, [`InvalidINTError`](../classes/ethereum.InvalidINTError.md), `TINT64`\> #### Defined in @@ -5464,7 +5464,7 @@ ___ ### parseINT8Safe -▸ **parseINT8Safe**<`TINT8`\>(`int8`): `Effect`<`never`, [`InvalidINTError`](/reference/schemas/classes/ethereum.InvalidINTError.md), `TINT8`\> +▸ **parseINT8Safe**<`TINT8`\>(`int8`): `Effect`<`never`, [`InvalidINTError`](../classes/ethereum.InvalidINTError.md), `TINT8`\> Safely parses an INT8 into an [Effect](https://www.effect.website/docs/essentials/effect-type). @@ -5482,7 +5482,7 @@ Safely parses an INT8 into an [Effect](https://www.effect.website/docs/essential #### Returns -`Effect`<`never`, [`InvalidINTError`](/reference/schemas/classes/ethereum.InvalidINTError.md), `TINT8`\> +`Effect`<`never`, [`InvalidINTError`](../classes/ethereum.InvalidINTError.md), `TINT8`\> #### Defined in @@ -5737,7 +5737,7 @@ ___ ### parseUINT128Safe -▸ **parseUINT128Safe**<`TUINT128`\>(`uint128`): `Effect`<`never`, [`InvalidUINTError`](/reference/schemas/classes/ethereum.InvalidUINTError.md), `TUINT128`\> +▸ **parseUINT128Safe**<`TUINT128`\>(`uint128`): `Effect`<`never`, [`InvalidUINTError`](../classes/ethereum.InvalidUINTError.md), `TUINT128`\> Safely parses a UINT128 into an [Effect](https://www.effect.website/docs/essentials/effect-type). @@ -5755,7 +5755,7 @@ Safely parses a UINT128 into an [Effect](https://www.effect.website/docs/essenti #### Returns -`Effect`<`never`, [`InvalidUINTError`](/reference/schemas/classes/ethereum.InvalidUINTError.md), `TUINT128`\> +`Effect`<`never`, [`InvalidUINTError`](../classes/ethereum.InvalidUINTError.md), `TUINT128`\> #### Defined in @@ -5800,7 +5800,7 @@ ___ ### parseUINT16Safe -▸ **parseUINT16Safe**<`TUINT16`\>(`uint16`): `Effect`<`never`, [`InvalidUINTError`](/reference/schemas/classes/ethereum.InvalidUINTError.md), `TUINT16`\> +▸ **parseUINT16Safe**<`TUINT16`\>(`uint16`): `Effect`<`never`, [`InvalidUINTError`](../classes/ethereum.InvalidUINTError.md), `TUINT16`\> Safely parses a UINT16 into an [Effect](https://www.effect.website/docs/essentials/effect-type). @@ -5818,7 +5818,7 @@ Safely parses a UINT16 into an [Effect](https://www.effect.website/docs/essentia #### Returns -`Effect`<`never`, [`InvalidUINTError`](/reference/schemas/classes/ethereum.InvalidUINTError.md), `TUINT16`\> +`Effect`<`never`, [`InvalidUINTError`](../classes/ethereum.InvalidUINTError.md), `TUINT16`\> #### Defined in @@ -5863,7 +5863,7 @@ ___ ### parseUINT256Safe -▸ **parseUINT256Safe**<`TUINT256`\>(`uint256`): `Effect`<`never`, [`InvalidUINTError`](/reference/schemas/classes/ethereum.InvalidUINTError.md), `TUINT256`\> +▸ **parseUINT256Safe**<`TUINT256`\>(`uint256`): `Effect`<`never`, [`InvalidUINTError`](../classes/ethereum.InvalidUINTError.md), `TUINT256`\> Safely parses a UINT256 into an [Effect](https://www.effect.website/docs/essentials/effect-type). @@ -5881,7 +5881,7 @@ Safely parses a UINT256 into an [Effect](https://www.effect.website/docs/essenti #### Returns -`Effect`<`never`, [`InvalidUINTError`](/reference/schemas/classes/ethereum.InvalidUINTError.md), `TUINT256`\> +`Effect`<`never`, [`InvalidUINTError`](../classes/ethereum.InvalidUINTError.md), `TUINT256`\> **`Example`** @@ -5933,7 +5933,7 @@ ___ ### parseUINT32Safe -▸ **parseUINT32Safe**<`TUINT32`\>(`uint32`): `Effect`<`never`, [`InvalidUINTError`](/reference/schemas/classes/ethereum.InvalidUINTError.md), `TUINT32`\> +▸ **parseUINT32Safe**<`TUINT32`\>(`uint32`): `Effect`<`never`, [`InvalidUINTError`](../classes/ethereum.InvalidUINTError.md), `TUINT32`\> Safely parses a UINT32 into an [Effect](https://www.effect.website/docs/essentials/effect-type). @@ -5951,7 +5951,7 @@ Safely parses a UINT32 into an [Effect](https://www.effect.website/docs/essentia #### Returns -`Effect`<`never`, [`InvalidUINTError`](/reference/schemas/classes/ethereum.InvalidUINTError.md), `TUINT32`\> +`Effect`<`never`, [`InvalidUINTError`](../classes/ethereum.InvalidUINTError.md), `TUINT32`\> #### Defined in @@ -5996,7 +5996,7 @@ ___ ### parseUINT64Safe -▸ **parseUINT64Safe**<`TUINT64`\>(`uint64`): `Effect`<`never`, [`InvalidUINTError`](/reference/schemas/classes/ethereum.InvalidUINTError.md), `TUINT64`\> +▸ **parseUINT64Safe**<`TUINT64`\>(`uint64`): `Effect`<`never`, [`InvalidUINTError`](../classes/ethereum.InvalidUINTError.md), `TUINT64`\> Safely parses a UINT64 into an [Effect](https://www.effect.website/docs/essentials/effect-type). @@ -6014,7 +6014,7 @@ Safely parses a UINT64 into an [Effect](https://www.effect.website/docs/essentia #### Returns -`Effect`<`never`, [`InvalidUINTError`](/reference/schemas/classes/ethereum.InvalidUINTError.md), `TUINT64`\> +`Effect`<`never`, [`InvalidUINTError`](../classes/ethereum.InvalidUINTError.md), `TUINT64`\> #### Defined in @@ -6059,7 +6059,7 @@ ___ ### parseUINT8Safe -▸ **parseUINT8Safe**<`TUINT8`\>(`uint8`): `Effect`<`never`, [`InvalidUINTError`](/reference/schemas/classes/ethereum.InvalidUINTError.md), `TUINT8`\> +▸ **parseUINT8Safe**<`TUINT8`\>(`uint8`): `Effect`<`never`, [`InvalidUINTError`](../classes/ethereum.InvalidUINTError.md), `TUINT8`\> Safely parses a UINT8 into an [Effect](https://www.effect.website/docs/essentials/effect-type). @@ -6077,7 +6077,7 @@ Safely parses a UINT8 into an [Effect](https://www.effect.website/docs/essential #### Returns -`Effect`<`never`, [`InvalidUINTError`](/reference/schemas/classes/ethereum.InvalidUINTError.md), `TUINT8`\> +`Effect`<`never`, [`InvalidUINTError`](../classes/ethereum.InvalidUINTError.md), `TUINT8`\> #### Defined in diff --git a/schemas/docs/modules/evmts.md b/schemas/docs/modules/evmts.md index 36cbf006fb..c45495ec32 100644 --- a/schemas/docs/modules/evmts.md +++ b/schemas/docs/modules/evmts.md @@ -1,4 +1,4 @@ -[@evmts/schemas](/reference/schemas/README.md) / [Modules](/reference/schemas/modules.md) / evmts +[@evmts/schemas](../README.md) / [Modules](../modules.md) / evmts # Module: evmts @@ -6,41 +6,41 @@ ### References -- [IsAddressBook](/reference/schemas/modules/evmts.md#isaddressbook) +- [IsAddressBook](evmts.md#isaddressbook) ### Classes -- [InvalidAddressBookError](/reference/schemas/classes/evmts.InvalidAddressBookError.md) +- [InvalidAddressBookError](../classes/evmts.InvalidAddressBookError.md) ### Interfaces -- [AddressBookEntry](/reference/schemas/interfaces/evmts.AddressBookEntry.md) +- [AddressBookEntry](../interfaces/evmts.AddressBookEntry.md) ### Type Aliases -- [AddressBook](/reference/schemas/modules/evmts.md#addressbook) +- [AddressBook](evmts.md#addressbook) ### Variables -- [SAddressBook](/reference/schemas/modules/evmts.md#saddressbook) +- [SAddressBook](evmts.md#saddressbook) ### Functions -- [isAddressBook](/reference/schemas/modules/evmts.md#isaddressbook-1) -- [parseAddressBook](/reference/schemas/modules/evmts.md#parseaddressbook) -- [parseAddressBookSafe](/reference/schemas/modules/evmts.md#parseaddressbooksafe) +- [isAddressBook](evmts.md#isaddressbook-1) +- [parseAddressBook](evmts.md#parseaddressbook) +- [parseAddressBookSafe](evmts.md#parseaddressbooksafe) ## References ### IsAddressBook -Re-exports [IsAddressBook](/reference/schemas/modules/types.md#isaddressbook) +Re-exports [IsAddressBook](types.md#isaddressbook) ## Type Aliases ### AddressBook -Ƭ **AddressBook**<\>: [`types`](/reference/schemas/modules/types.md) +Ƭ **AddressBook**<\>: [`types`](types.md) #### Defined in @@ -50,7 +50,7 @@ Re-exports [IsAddressBook](/reference/schemas/modules/types.md#isaddressbook) ### SAddressBook -• `Const` **SAddressBook**: `Schema`<[`types`](/reference/schemas/modules/types.md), [`types`](/reference/schemas/modules/types.md)\> +• `Const` **SAddressBook**: `Schema`<[`types`](types.md), [`types`](types.md)\> [Effect schema](https://github.com/Effect-TS/schema) for the AddressBook type. @@ -98,7 +98,7 @@ Parses an address book and returns the value if no errors. | Name | Type | | :------ | :------ | -| `TAddressBook` | extends [`types`](/reference/schemas/modules/types.md) | +| `TAddressBook` | extends [`types`](types.md) | #### Parameters @@ -130,7 +130,7 @@ ___ ### parseAddressBookSafe -▸ **parseAddressBookSafe**<`TAddressBook`\>(`addressBook`): `Effect`<`never`, [`InvalidAddressBookError`](/reference/schemas/classes/evmts.InvalidAddressBookError.md), `TAddressBook`\> +▸ **parseAddressBookSafe**<`TAddressBook`\>(`addressBook`): `Effect`<`never`, [`InvalidAddressBookError`](../classes/evmts.InvalidAddressBookError.md), `TAddressBook`\> Safely parses an address book into an [Effect](https://www.effect.website/docs/essentials/effect-type). @@ -138,7 +138,7 @@ Safely parses an address book into an [Effect](https://www.effect.website/docs/e | Name | Type | | :------ | :------ | -| `TAddressBook` | extends [`types`](/reference/schemas/modules/types.md) | +| `TAddressBook` | extends [`types`](types.md) | #### Parameters @@ -148,7 +148,7 @@ Safely parses an address book into an [Effect](https://www.effect.website/docs/e #### Returns -`Effect`<`never`, [`InvalidAddressBookError`](/reference/schemas/classes/evmts.InvalidAddressBookError.md), `TAddressBook`\> +`Effect`<`never`, [`InvalidAddressBookError`](../classes/evmts.InvalidAddressBookError.md), `TAddressBook`\> **`Example`** diff --git a/schemas/docs/modules/types.md b/schemas/docs/modules/types.md index 6603a0f1f3..87f3019c9f 100644 --- a/schemas/docs/modules/types.md +++ b/schemas/docs/modules/types.md @@ -1,4 +1,4 @@ -[@evmts/schemas](/reference/schemas/README.md) / [Modules](/reference/schemas/modules.md) / types +[@evmts/schemas](../README.md) / [Modules](../modules.md) / types # Module: types @@ -6,11 +6,11 @@ ### Type Aliases -- [AddressBook](/reference/schemas/modules/types.md#addressbook) -- [AddressBookEntry](/reference/schemas/modules/types.md#addressbookentry) -- [BlockNumber](/reference/schemas/modules/types.md#blocknumber) -- [IsAddressBook](/reference/schemas/modules/types.md#isaddressbook) -- [IsBlockNumber](/reference/schemas/modules/types.md#isblocknumber) +- [AddressBook](types.md#addressbook) +- [AddressBookEntry](types.md#addressbookentry) +- [BlockNumber](types.md#blocknumber) +- [IsAddressBook](types.md#isaddressbook) +- [IsBlockNumber](types.md#isblocknumber) ## Type Aliases diff --git a/schemas/typedoc.json b/schemas/typedoc.json index 590ff0f5dc..cc0bd6ce95 100644 --- a/schemas/typedoc.json +++ b/schemas/typedoc.json @@ -7,7 +7,6 @@ "./src/common/index.js", "./src/evmts/index.js" ], - "publicPath": "/reference/schemas/", "plugin": ["typedoc-plugin-markdown"], "gitRevision": "main" } diff --git a/solc/docs/README.md b/solc/docs/README.md index bd134a1ccd..9e4a7054ac 100644 --- a/solc/docs/README.md +++ b/solc/docs/README.md @@ -1,4 +1,4 @@ -@evmts/solc / [Modules](/reference/solc/modules.md) +@evmts/solc / [Modules](modules.md)

diff --git a/solc/docs/interfaces/types.ModuleInfo.md b/solc/docs/interfaces/types.ModuleInfo.md index e3c79067f3..0c4ecd672e 100644 --- a/solc/docs/interfaces/types.ModuleInfo.md +++ b/solc/docs/interfaces/types.ModuleInfo.md @@ -1,8 +1,8 @@ -[@evmts/solc](/reference/solc/README.md) / [Modules](/reference/solc/modules.md) / [types](/reference/solc/modules/types.md) / ModuleInfo +[@evmts/solc](../README.md) / [Modules](../modules.md) / [types](../modules/types.md) / ModuleInfo # Interface: ModuleInfo -[types](/reference/solc/modules/types.md).ModuleInfo +[types](../modules/types.md).ModuleInfo Copied from rollup (kinda) @@ -14,11 +14,11 @@ https://rollupjs.org/plugin-development/#this-getmoduleinfo ### Properties -- [code](/reference/solc/interfaces/types.ModuleInfo.md#code) -- [id](/reference/solc/interfaces/types.ModuleInfo.md#id) -- [importedIds](/reference/solc/interfaces/types.ModuleInfo.md#importedids) -- [rawCode](/reference/solc/interfaces/types.ModuleInfo.md#rawcode) -- [resolutions](/reference/solc/interfaces/types.ModuleInfo.md#resolutions) +- [code](types.ModuleInfo.md#code) +- [id](types.ModuleInfo.md#id) +- [importedIds](types.ModuleInfo.md#importedids) +- [rawCode](types.ModuleInfo.md#rawcode) +- [resolutions](types.ModuleInfo.md#resolutions) ## Properties @@ -64,7 +64,7 @@ ___ ### resolutions -• **resolutions**: [`ModuleInfo`](/reference/solc/interfaces/types.ModuleInfo.md)[] +• **resolutions**: [`ModuleInfo`](types.ModuleInfo.md)[] #### Defined in diff --git a/solc/docs/modules.md b/solc/docs/modules.md index 23eeacc4e9..841ce214d4 100644 --- a/solc/docs/modules.md +++ b/solc/docs/modules.md @@ -1,4 +1,4 @@ -[@evmts/solc](/reference/solc/README.md) / Modules +[@evmts/solc](README.md) / Modules # @evmts/solc @@ -6,7 +6,7 @@ ### Modules -- [resolveArtifacts](/reference/solc/modules/resolveArtifacts.md) -- [resolveArtifactsSync](/reference/solc/modules/resolveArtifactsSync.md) -- [solc](/reference/solc/modules/solc.md) -- [types](/reference/solc/modules/types.md) +- [resolveArtifacts](modules/resolveArtifacts.md) +- [resolveArtifactsSync](modules/resolveArtifactsSync.md) +- [solc](modules/solc.md) +- [types](modules/types.md) diff --git a/solc/docs/modules/resolveArtifacts.md b/solc/docs/modules/resolveArtifacts.md index d8bafa846b..34fb960200 100644 --- a/solc/docs/modules/resolveArtifacts.md +++ b/solc/docs/modules/resolveArtifacts.md @@ -1,4 +1,4 @@ -[@evmts/solc](/reference/solc/README.md) / [Modules](/reference/solc/modules.md) / resolveArtifacts +[@evmts/solc](../README.md) / [Modules](../modules.md) / resolveArtifacts # Module: resolveArtifacts @@ -6,7 +6,7 @@ ### Functions -- [resolveArtifacts](/reference/solc/modules/resolveArtifacts.md#resolveartifacts) +- [resolveArtifacts](resolveArtifacts.md#resolveartifacts) ## Functions @@ -22,10 +22,10 @@ Resolves artifacts with solc asyncronously | :------ | :------ | | `solFile` | `string` | | `basedir` | `string` | -| `logger` | [`Logger`](/reference/solc/modules/types.md#logger) | +| `logger` | [`Logger`](types.md#logger) | | `config` | `ResolvedCompilerConfig` | | `includeAst` | `boolean` | -| `fao` | [`FileAccessObject`](/reference/solc/modules/types.md#fileaccessobject) | +| `fao` | [`FileAccessObject`](types.md#fileaccessobject) | #### Returns @@ -33,9 +33,9 @@ Resolves artifacts with solc asyncronously | Name | Type | | :------ | :------ | -| `artifacts` | [`Artifacts`](/reference/solc/modules/types.md#artifacts) | +| `artifacts` | [`Artifacts`](types.md#artifacts) | | `asts` | `undefined` \| `Record`<`string`, `Node`\> | -| `modules` | `Record`<``"string"``, [`ModuleInfo`](/reference/solc/interfaces/types.ModuleInfo.md)\> | +| `modules` | `Record`<``"string"``, [`ModuleInfo`](../interfaces/types.ModuleInfo.md)\> | | `solcInput` | `SolcInputDescription` | | `solcOutput` | `SolcOutput` | diff --git a/solc/docs/modules/resolveArtifactsSync.md b/solc/docs/modules/resolveArtifactsSync.md index 814e931b67..2b2643e2b6 100644 --- a/solc/docs/modules/resolveArtifactsSync.md +++ b/solc/docs/modules/resolveArtifactsSync.md @@ -1,4 +1,4 @@ -[@evmts/solc](/reference/solc/README.md) / [Modules](/reference/solc/modules.md) / resolveArtifactsSync +[@evmts/solc](../README.md) / [Modules](../modules.md) / resolveArtifactsSync # Module: resolveArtifactsSync @@ -6,7 +6,7 @@ ### Functions -- [resolveArtifactsSync](/reference/solc/modules/resolveArtifactsSync.md#resolveartifactssync) +- [resolveArtifactsSync](resolveArtifactsSync.md#resolveartifactssync) ## Functions @@ -20,10 +20,10 @@ | :------ | :------ | | `solFile` | `string` | | `basedir` | `string` | -| `logger` | [`Logger`](/reference/solc/modules/types.md#logger) | +| `logger` | [`Logger`](types.md#logger) | | `config` | `ResolvedCompilerConfig` | | `includeAst` | `boolean` | -| `fao` | [`FileAccessObject`](/reference/solc/modules/types.md#fileaccessobject) | +| `fao` | [`FileAccessObject`](types.md#fileaccessobject) | #### Returns @@ -31,9 +31,9 @@ | Name | Type | | :------ | :------ | -| `artifacts` | [`Artifacts`](/reference/solc/modules/types.md#artifacts) | +| `artifacts` | [`Artifacts`](types.md#artifacts) | | `asts` | `undefined` \| `Record`<`string`, `Node`\> | -| `modules` | `Record`<``"string"``, [`ModuleInfo`](/reference/solc/interfaces/types.ModuleInfo.md)\> | +| `modules` | `Record`<``"string"``, [`ModuleInfo`](../interfaces/types.ModuleInfo.md)\> | | `solcInput` | `SolcInputDescription` | | `solcOutput` | `SolcOutput` | diff --git a/solc/docs/modules/solc.md b/solc/docs/modules/solc.md index a4357d9cb4..3a7d71532c 100644 --- a/solc/docs/modules/solc.md +++ b/solc/docs/modules/solc.md @@ -1,4 +1,4 @@ -[@evmts/solc](/reference/solc/README.md) / [Modules](/reference/solc/modules.md) / solc +[@evmts/solc](../README.md) / [Modules](../modules.md) / solc # Module: solc @@ -6,11 +6,11 @@ ### Variables -- [fileLevelOption](/reference/solc/modules/solc.md#fileleveloption) +- [fileLevelOption](solc.md#fileleveloption) ### Functions -- [solcCompile](/reference/solc/modules/solc.md#solccompile) +- [solcCompile](solc.md#solccompile) ## Variables diff --git a/solc/docs/modules/types.md b/solc/docs/modules/types.md index 409052b4d4..6ec070c77a 100644 --- a/solc/docs/modules/types.md +++ b/solc/docs/modules/types.md @@ -1,4 +1,4 @@ -[@evmts/solc](/reference/solc/README.md) / [Modules](/reference/solc/modules.md) / types +[@evmts/solc](../README.md) / [Modules](../modules.md) / types # Module: types @@ -6,14 +6,14 @@ ### Interfaces -- [ModuleInfo](/reference/solc/interfaces/types.ModuleInfo.md) +- [ModuleInfo](../interfaces/types.ModuleInfo.md) ### Type Aliases -- [Artifacts](/reference/solc/modules/types.md#artifacts) -- [CompiledContracts](/reference/solc/modules/types.md#compiledcontracts) -- [FileAccessObject](/reference/solc/modules/types.md#fileaccessobject) -- [Logger](/reference/solc/modules/types.md#logger) +- [Artifacts](types.md#artifacts) +- [CompiledContracts](types.md#compiledcontracts) +- [FileAccessObject](types.md#fileaccessobject) +- [Logger](types.md#logger) ## Type Aliases @@ -43,7 +43,7 @@ ___ | :------ | :------ | | `artifacts` | `SolcOutput`[``"contracts"``][`string`] \| `undefined` | | `asts` | `TIncludeAsts` extends ``true`` ? `Record`<`string`, `Node`\> : `undefined` | -| `modules` | `Record`<``"string"``, [`ModuleInfo`](/reference/solc/interfaces/types.ModuleInfo.md)\> | +| `modules` | `Record`<``"string"``, [`ModuleInfo`](../interfaces/types.ModuleInfo.md)\> | | `solcInput` | `SolcInputDescription` | | `solcOutput` | `SolcOutput` | diff --git a/solc/typedoc.json b/solc/typedoc.json index 186516b08a..96c3d8f76a 100644 --- a/solc/typedoc.json +++ b/solc/typedoc.json @@ -8,7 +8,6 @@ "./src/solcTypes.js", "./src/types.ts" ], - "publicPath": "/reference/solc/", "plugin": ["typedoc-plugin-markdown"], "gitRevision": "main" } diff --git a/ts-plugin/docs/README.md b/ts-plugin/docs/README.md index f524f64824..e4d6a31c03 100644 --- a/ts-plugin/docs/README.md +++ b/ts-plugin/docs/README.md @@ -1,4 +1,4 @@ -@evmts/ts-plugin / [Exports](/reference/ts-plugin/modules.md) +@evmts/ts-plugin / [Exports](modules.md) ## @evmts/ts-plugin diff --git a/ts-plugin/docs/modules.md b/ts-plugin/docs/modules.md index 006c56a807..cbe65499fa 100644 --- a/ts-plugin/docs/modules.md +++ b/ts-plugin/docs/modules.md @@ -1,4 +1,4 @@ -[@evmts/ts-plugin](/reference/ts-plugin/README.md) / Exports +[@evmts/ts-plugin](README.md) / Exports # @evmts/ts-plugin @@ -6,7 +6,7 @@ ### Functions -- [default](/reference/ts-plugin/modules.md#default) +- [default](modules.md#default) ## Functions diff --git a/ts-plugin/typedoc.json b/ts-plugin/typedoc.json index 946ace7465..93f5d67354 100644 --- a/ts-plugin/typedoc.json +++ b/ts-plugin/typedoc.json @@ -2,7 +2,6 @@ "$schema": "https://typedoc.org/schema.json", "out": "./docs", "entryPoints": ["./src/index.ts"], - "publicPath": "/reference/ts-plugin/", "plugin": ["typedoc-plugin-markdown"], "gitRevision": "main" }