diff --git a/docs/conf.py b/docs/conf.py index e25594d30f..060bda05ae 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -82,7 +82,10 @@ # Set some default to avoid unnecessary repetitious directives. autodoc_default_options = { - "exclude-members": "__repr__,__weakref__,__metaclass__,__init__,model_config,model_fields,model_post_init" + "exclude-members": ( + "__repr__, __weakref__, __metaclass__, __init__, " + "model_config, model_fields, model_post_init, model_computed_fields" + ) } # -- Doctest configuration ------------------------------------------------- diff --git a/docs/index.md b/docs/index.md index 502dcc6606..8c79974237 100644 --- a/docs/index.md +++ b/docs/index.md @@ -67,5 +67,8 @@ methoddocs/ape_accounts.md methoddocs/ape_compile.md + methoddocs/ape_ethereum.md + methoddocs/ape_node.md methoddocs/ape_pm.md + methoddocs/ape_test.md ``` diff --git a/docs/methoddocs/ape_ethereum.md b/docs/methoddocs/ape_ethereum.md new file mode 100644 index 0000000000..bbd95a504c --- /dev/null +++ b/docs/methoddocs/ape_ethereum.md @@ -0,0 +1,15 @@ +# ape-ethereum + +```{eval-rst} +.. automodule:: ape_ethereum + :members: +``` + +# ape-ethereum.multicall + +```{eval-rst} +.. automodule:: ape_ethereum.multicall + :members: + :show-inheritance: + :special-members: +``` diff --git a/docs/methoddocs/ape_node.md b/docs/methoddocs/ape_node.md new file mode 100644 index 0000000000..af5df2262b --- /dev/null +++ b/docs/methoddocs/ape_node.md @@ -0,0 +1,6 @@ +# ape-node + +```{eval-rst} +.. automodule:: ape_node + :members: +``` diff --git a/docs/methoddocs/ape_test.md b/docs/methoddocs/ape_test.md new file mode 100644 index 0000000000..312210351e --- /dev/null +++ b/docs/methoddocs/ape_test.md @@ -0,0 +1,6 @@ +# ape-test + +```{eval-rst} +.. automodule:: ape_test + :members: +``` diff --git a/src/ape_cache/__init__.py b/src/ape_cache/__init__.py index 57cceb55f0..4bea9fd8ea 100644 --- a/src/ape_cache/__init__.py +++ b/src/ape_cache/__init__.py @@ -16,3 +16,8 @@ def config_class(): @plugins.register(plugins.QueryPlugin) def query_engines(): return CacheQueryProvider + + +__all__ = [ + "CacheQueryProvider", +] diff --git a/src/ape_ethereum/__init__.py b/src/ape_ethereum/__init__.py index d8c85de747..41dbf86131 100644 --- a/src/ape_ethereum/__init__.py +++ b/src/ape_ethereum/__init__.py @@ -3,8 +3,29 @@ from ape.api.networks import LOCAL_NETWORK_NAME from ._converters import WeiConversions -from .ecosystem import NETWORKS, Ethereum, EthereumConfig +from .ecosystem import ( + NETWORKS, + BaseEthereumConfig, + Block, + Ethereum, + EthereumConfig, + ForkedNetworkConfig, + NetworkConfig, +) +from .provider import EthereumNodeProvider, Web3Provider, assert_web3_provider_uri_env_var_not_set from .query import EthereumQueryProvider +from .trace import CallTrace, Trace, TransactionTrace +from .transactions import ( + AccessListTransaction, + BaseTransaction, + DynamicFeeTransaction, + Receipt, + SharedBlobReceipt, + SharedBlobTransaction, + StaticFeeTransaction, + TransactionStatusEnum, + TransactionType, +) @plugins.register(plugins.Config) @@ -35,3 +56,28 @@ def networks(): @plugins.register(plugins.QueryPlugin) def query_engines(): yield EthereumQueryProvider + + +__all__ = [ + "Ethereum", + "EthereumConfig", + "NetworkConfig", + "ForkedNetworkConfig", + "BaseEthereumConfig", + "Block", + "assert_web3_provider_uri_env_var_not_set", + "Web3Provider", + "EthereumNodeProvider", + "Trace", + "TransactionTrace", + "CallTrace", + "TransactionStatusEnum", + "TransactionType", + "BaseTransaction", + "StaticFeeTransaction", + "AccessListTransaction", + "DynamicFeeTransaction", + "SharedBlobTransaction", + "Receipt", + "SharedBlobReceipt", +] diff --git a/src/ape_ethereum/multicall/__init__.py b/src/ape_ethereum/multicall/__init__.py index d634e32109..fea2747acb 100644 --- a/src/ape_ethereum/multicall/__init__.py +++ b/src/ape_ethereum/multicall/__init__.py @@ -1,6 +1,7 @@ -from .handlers import Call, Transaction +from .handlers import BaseMulticall, Call, Transaction __all__ = [ + "BaseMulticall", "Call", "Transaction", ] diff --git a/src/ape_node/__init__.py b/src/ape_node/__init__.py index 5130027b6e..0fa660812d 100644 --- a/src/ape_node/__init__.py +++ b/src/ape_node/__init__.py @@ -23,3 +23,12 @@ def providers(): @plugins.register(plugins.QueryPlugin) def query_engines(): yield OtterscanQueryEngine + + +__all__ = [ + "EthereumNetworkConfig", + "EthereumNodeConfig", + "GethDev", + "Node", + "OtterscanQueryEngine", +] diff --git a/src/ape_test/__init__.py b/src/ape_test/__init__.py index 1212a7f7bb..f3f511253a 100644 --- a/src/ape_test/__init__.py +++ b/src/ape_test/__init__.py @@ -159,3 +159,16 @@ def account_types(): @plugins.register(plugins.ProviderPlugin) def providers(): yield "ethereum", LOCAL_NETWORK_NAME, LocalProvider + + +__all__ = [ + "TestAccountContainer", + "TestAccount", + "EthTesterProviderConfig", + "LocalProvider", + "GasExclusion", + "GasConfig", + "CoverageReportsConfig", + "CoverageConfig", + "ApeTestConfig", +]