diff --git a/latest/.doctrees/commands/networks.doctree b/latest/.doctrees/commands/networks.doctree index 2ddb83c6f2..512a8cf5e8 100644 Binary files a/latest/.doctrees/commands/networks.doctree and b/latest/.doctrees/commands/networks.doctree differ diff --git a/latest/.doctrees/environment.pickle b/latest/.doctrees/environment.pickle index 4b761df6bc..de444358ba 100644 Binary files a/latest/.doctrees/environment.pickle and b/latest/.doctrees/environment.pickle differ diff --git a/latest/.doctrees/methoddocs/ape.doctree b/latest/.doctrees/methoddocs/ape.doctree index ef5229ec0e..ae60cd2a1e 100644 Binary files a/latest/.doctrees/methoddocs/ape.doctree and b/latest/.doctrees/methoddocs/ape.doctree differ diff --git a/latest/.doctrees/methoddocs/ape_accounts.doctree b/latest/.doctrees/methoddocs/ape_accounts.doctree index 6f087ebe56..f8786acdc5 100644 Binary files a/latest/.doctrees/methoddocs/ape_accounts.doctree and b/latest/.doctrees/methoddocs/ape_accounts.doctree differ diff --git a/latest/.doctrees/methoddocs/ape_compile.doctree b/latest/.doctrees/methoddocs/ape_compile.doctree index 9a1041f7f4..48400f7f7a 100644 Binary files a/latest/.doctrees/methoddocs/ape_compile.doctree and b/latest/.doctrees/methoddocs/ape_compile.doctree differ diff --git a/latest/.doctrees/methoddocs/ape_ethereum.doctree b/latest/.doctrees/methoddocs/ape_ethereum.doctree index cfb0889432..2ee4e4d45c 100644 Binary files a/latest/.doctrees/methoddocs/ape_ethereum.doctree and b/latest/.doctrees/methoddocs/ape_ethereum.doctree differ diff --git a/latest/.doctrees/methoddocs/ape_node.doctree b/latest/.doctrees/methoddocs/ape_node.doctree index 1a1f4836f8..b72224bbe5 100644 Binary files a/latest/.doctrees/methoddocs/ape_node.doctree and b/latest/.doctrees/methoddocs/ape_node.doctree differ diff --git a/latest/.doctrees/methoddocs/ape_pm.doctree b/latest/.doctrees/methoddocs/ape_pm.doctree index 887136ac77..5b77e7ff59 100644 Binary files a/latest/.doctrees/methoddocs/ape_pm.doctree and b/latest/.doctrees/methoddocs/ape_pm.doctree differ diff --git a/latest/.doctrees/methoddocs/ape_test.doctree b/latest/.doctrees/methoddocs/ape_test.doctree index 3b982e7d0a..8d507eeffa 100644 Binary files a/latest/.doctrees/methoddocs/ape_test.doctree and b/latest/.doctrees/methoddocs/ape_test.doctree differ diff --git a/latest/.doctrees/methoddocs/api.doctree b/latest/.doctrees/methoddocs/api.doctree index aa4e929eb4..73f260b44c 100644 Binary files a/latest/.doctrees/methoddocs/api.doctree and b/latest/.doctrees/methoddocs/api.doctree differ diff --git a/latest/.doctrees/methoddocs/cli.doctree b/latest/.doctrees/methoddocs/cli.doctree index 0f1125fc33..e62035e820 100644 Binary files a/latest/.doctrees/methoddocs/cli.doctree and b/latest/.doctrees/methoddocs/cli.doctree differ diff --git a/latest/.doctrees/methoddocs/contracts.doctree b/latest/.doctrees/methoddocs/contracts.doctree index 1ffb372d13..31fc9406a8 100644 Binary files a/latest/.doctrees/methoddocs/contracts.doctree and b/latest/.doctrees/methoddocs/contracts.doctree differ diff --git a/latest/.doctrees/methoddocs/exceptions.doctree b/latest/.doctrees/methoddocs/exceptions.doctree index 037026ce36..e207a60dc9 100644 Binary files a/latest/.doctrees/methoddocs/exceptions.doctree and b/latest/.doctrees/methoddocs/exceptions.doctree differ diff --git a/latest/.doctrees/methoddocs/managers.doctree b/latest/.doctrees/methoddocs/managers.doctree index 9911000fbe..54f62cbbb9 100644 Binary files a/latest/.doctrees/methoddocs/managers.doctree and b/latest/.doctrees/methoddocs/managers.doctree differ diff --git a/latest/.doctrees/methoddocs/plugins.doctree b/latest/.doctrees/methoddocs/plugins.doctree index 85976c0889..a5f0f2ee55 100644 Binary files a/latest/.doctrees/methoddocs/plugins.doctree and b/latest/.doctrees/methoddocs/plugins.doctree differ diff --git a/latest/.doctrees/methoddocs/types.doctree b/latest/.doctrees/methoddocs/types.doctree index cac571047b..f56d83017c 100644 Binary files a/latest/.doctrees/methoddocs/types.doctree and b/latest/.doctrees/methoddocs/types.doctree differ diff --git a/latest/.doctrees/methoddocs/utils.doctree b/latest/.doctrees/methoddocs/utils.doctree index 3507901dcb..a4f26e5832 100644 Binary files a/latest/.doctrees/methoddocs/utils.doctree and b/latest/.doctrees/methoddocs/utils.doctree differ diff --git a/latest/.doctrees/userguides/config.doctree b/latest/.doctrees/userguides/config.doctree index e1638a960b..4b251d208c 100644 Binary files a/latest/.doctrees/userguides/config.doctree and b/latest/.doctrees/userguides/config.doctree differ diff --git a/latest/_sources/userguides/config.md.txt b/latest/_sources/userguides/config.md.txt index 447349c824..e61ecb6cdc 100644 --- a/latest/_sources/userguides/config.md.txt +++ b/latest/_sources/userguides/config.md.txt @@ -29,6 +29,27 @@ plugin: This helps keep your secrets out of Ape! +## Base Path + +Change the base path if it is different than your project root. +For example, imagine a project structure like: + +``` +project +└── src/ + └── contracts/ + └── MyContract.sol +``` + +In this case, you want to configure Ape like: + +```yaml +base_path: src +``` + +This way, `MyContract.vy`'s source ID will be `"contracts/Factory.vy"` and not `"src/contracts/Factory.vy"`. +Some dependencies, such as python-based ones like `snekmate`, use this structure. + ## Contracts Folder Specify a different path to your `contracts/` directory. diff --git a/latest/commands/networks.html b/latest/commands/networks.html index 8e05e724d6..37d413aa10 100644 --- a/latest/commands/networks.html +++ b/latest/commands/networks.html @@ -200,7 +200,7 @@
Filter the results by network
mainnet | local | holesky-fork | mainnet-fork | holesky | sepolia-fork | sepolia
+local | holesky-fork | sepolia | holesky | sepolia-fork | mainnet | mainnet-fork
Filter the results by provider
test | node
+node
Override the default network and provider. (see ape networks list for options)
:mainnet:node | ethereum:mainnet:node | :mainnet | ethereum:mainnet | :sepolia:node | ethereum:sepolia:node | :sepolia | ethereum:sepolia | :holesky:node | ethereum:holesky:node | :holesky | ethereum:holesky | ::node | :local:node | ethereum::node | ethereum:local:node | ::test | :local:test | ethereum::test | ethereum:local:test | :local | ethereum:local | ethereum
+:mainnet:node | ethereum:mainnet:node | :mainnet | ethereum:mainnet | :sepolia:node | ethereum:sepolia:node | :sepolia | ethereum:sepolia | :holesky:node | ethereum:holesky:node | :holesky | ethereum:holesky | ::node | :local:node | ethereum::node | ethereum:local:node | :local | ethereum:local | ethereum
Configure your node:
in Ape, the default provider
plugin for live-network nodes. Also, ape node
can
start-up a local development node for testing purposes.
__repr__()
__signature__
__str__()
base_path
contracts_folder
default_ecosystem
dependencies
The core schema of the model.
The pydantic-core SchemaSerializer used to dump instances of the model.
The pydantic-core SchemaValidator used to validate instances of the model.
The core schema of the model.
The pydantic-core SchemaSerializer used to dump instances of the model.
The pydantic-core SchemaValidator used to validate instances of the model.
The core schema of the model.
The pydantic-core SchemaSerializer used to dump instances of the model.
The pydantic-core SchemaValidator used to validate instances of the model.
The core schema of the model.
The pydantic-core SchemaSerializer used to dump instances of the model.
The pydantic-core SchemaValidator used to validate instances of the model.
The core schema of the model.
The pydantic-core SchemaSerializer used to dump instances of the model.
The pydantic-core SchemaValidator used to validate instances of the model.
Bases: ExtraAttributesMixin
, BaseSettings
, ManagerAccessMixin
The top-level config.
The core schema of the model.
Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.
The pydantic-core SchemaSerializer used to dump instances of the model.
The pydantic-core SchemaValidator used to validate instances of the model.
The synthesized __init__ [Signature][inspect.Signature] of the model.
Return str(self).
Use this when the project’s base-path is not the +root of the project.
+The core schema of the model.
The pydantic-core SchemaSerializer used to dump instances of the model.
The pydantic-core SchemaValidator used to validate instances of the model.
The core schema of the model.
The pydantic-core SchemaSerializer used to dump instances of the model.
The pydantic-core SchemaValidator used to validate instances of the model.
The core schema of the model.
The pydantic-core SchemaSerializer used to dump instances of the model.
The pydantic-core SchemaValidator used to validate instances of the model.
The core schema of the model.
Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.
The pydantic-core SchemaSerializer used to dump instances of the model.
The pydantic-core SchemaValidator used to validate instances of the model.
The core schema of the model.
The pydantic-core SchemaSerializer used to dump instances of the model.
The pydantic-core SchemaValidator used to validate instances of the model.
The core schema of the model.
The pydantic-core SchemaSerializer used to dump instances of the model.
The pydantic-core SchemaValidator used to validate instances of the model.
The core schema of the model.
The pydantic-core SchemaSerializer used to dump instances of the model.
The pydantic-core SchemaValidator used to validate instances of the model.
The core schema of the model.
Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.
The pydantic-core SchemaSerializer used to dump instances of the model.
The pydantic-core SchemaValidator used to validate instances of the model.
The core schema of the model.
Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.
The pydantic-core SchemaSerializer used to dump instances of the model.
The pydantic-core SchemaValidator used to validate instances of the model.
The core schema of the model.
The pydantic-core SchemaSerializer used to dump instances of the model.
The pydantic-core SchemaValidator used to validate instances of the model.
The core schema of the model.
The pydantic-core SchemaSerializer used to dump instances of the model.
The pydantic-core SchemaValidator used to validate instances of the model.
The core schema of the model.
The pydantic-core SchemaSerializer used to dump instances of the model.
The pydantic-core SchemaValidator used to validate instances of the model.
The core schema of the model.
Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.
The pydantic-core SchemaSerializer used to dump instances of the model.
The pydantic-core SchemaValidator used to validate instances of the model.
The core schema of the model.
Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.
The pydantic-core SchemaSerializer used to dump instances of the model.
The pydantic-core SchemaValidator used to validate instances of the model.
The core schema of the model.
The pydantic-core SchemaSerializer used to dump instances of the model.
The pydantic-core SchemaValidator used to validate instances of the model.
The core schema of the model.
The pydantic-core SchemaSerializer used to dump instances of the model.
The pydantic-core SchemaValidator used to validate instances of the model.