Update documentation

ApeWorX · Jan 13, 2025 · 3badfa8 · 3badfa8
1 parent ac3ba4a
commit 3badfa8
Show file tree

Hide file tree

Showing 22 changed files with 76 additions and 36 deletions.
diff --git a/latest/.doctrees/commands/networks.doctree b/latest/.doctrees/commands/networks.doctree
diff --git a/latest/.doctrees/environment.pickle b/latest/.doctrees/environment.pickle
diff --git a/latest/.doctrees/methoddocs/ape.doctree b/latest/.doctrees/methoddocs/ape.doctree
diff --git a/latest/.doctrees/methoddocs/ape_accounts.doctree b/latest/.doctrees/methoddocs/ape_accounts.doctree
diff --git a/latest/.doctrees/methoddocs/ape_compile.doctree b/latest/.doctrees/methoddocs/ape_compile.doctree
diff --git a/latest/.doctrees/methoddocs/ape_ethereum.doctree b/latest/.doctrees/methoddocs/ape_ethereum.doctree
diff --git a/latest/.doctrees/methoddocs/ape_node.doctree b/latest/.doctrees/methoddocs/ape_node.doctree
diff --git a/latest/.doctrees/methoddocs/ape_pm.doctree b/latest/.doctrees/methoddocs/ape_pm.doctree
diff --git a/latest/.doctrees/methoddocs/ape_test.doctree b/latest/.doctrees/methoddocs/ape_test.doctree
diff --git a/latest/.doctrees/methoddocs/api.doctree b/latest/.doctrees/methoddocs/api.doctree
diff --git a/latest/.doctrees/methoddocs/cli.doctree b/latest/.doctrees/methoddocs/cli.doctree
diff --git a/latest/.doctrees/methoddocs/contracts.doctree b/latest/.doctrees/methoddocs/contracts.doctree
diff --git a/latest/.doctrees/methoddocs/exceptions.doctree b/latest/.doctrees/methoddocs/exceptions.doctree
diff --git a/latest/.doctrees/methoddocs/managers.doctree b/latest/.doctrees/methoddocs/managers.doctree
diff --git a/latest/.doctrees/methoddocs/plugins.doctree b/latest/.doctrees/methoddocs/plugins.doctree
diff --git a/latest/.doctrees/methoddocs/types.doctree b/latest/.doctrees/methoddocs/types.doctree
diff --git a/latest/.doctrees/methoddocs/utils.doctree b/latest/.doctrees/methoddocs/utils.doctree
diff --git a/latest/.doctrees/userguides/config.doctree b/latest/.doctrees/userguides/config.doctree
diff --git a/latest/_sources/userguides/config.md.txt b/latest/_sources/userguides/config.md.txt
@@ -170,33 +170,28 @@ contract = project.MyContract.deployments[0]
 Ape does not add or edit deployments in your `ape-config.yaml` file.
 ```
 
-## Node
+## Name
 
-When using the `node` provider, you can customize its settings.
-For example, to change the URI for an Ethereum network, do:
+Configure the name of the project:
 
 ```toml
-[tool.ape.node.ethereum.mainnet]
-uri = "http://localhost:5030"
+[tool.ape]
+name = "ape-project"
 ```
 
-Or the equivalent YAML:
+If the name is not specified in `tool.ape` but is in `project`, Ape will use that as the project name:
 
-```yaml
-node:
-  ethereum:
-    mainnet:
-      uri: http://localhost:5030
+```toml
+[project]
+name = "ape-project"
 ```
 
-Now, the `ape-node` core plugin will use the URL `http://localhost:5030` to connect and make requests.
+To configure this name using an `ape-config.yaml` file, do:
 
-```{warning}
-Instead of using `ape-node` to connect to an Infura or Alchemy node, use the [ape-infura](https://github.com/ApeWorX/ape-infura) or [ape-alchemy](https://github.com/ApeWorX/ape-alchemy) provider plugins instead, which have their own way of managing API keys via environment variables.
+```yaml
+name: ape-project
 ```
 
-For more information on networking as a whole, see [this guide](./networks.html).
-
 ## Networks
 
 Set default network and network providers:
@@ -246,6 +241,33 @@ ethereum:
 
 For the local network configuration, the default is `"max"`. Otherwise, it is `"auto"`.
 
+## Node
+
+When using the `node` provider, you can customize its settings.
+For example, to change the URI for an Ethereum network, do:
+
+```toml
+[tool.ape.node.ethereum.mainnet]
+uri = "http://localhost:5030"
+```
+
+Or the equivalent YAML:
+
+```yaml
+node:
+  ethereum:
+    mainnet:
+      uri: http://localhost:5030
+```
+
+Now, the `ape-node` core plugin will use the URL `http://localhost:5030` to connect and make requests.
+
+```{warning}
+Instead of using `ape-node` to connect to an Infura or Alchemy node, use the [ape-infura](https://github.com/ApeWorX/ape-infura) or [ape-alchemy](https://github.com/ApeWorX/ape-alchemy) provider plugins instead, which have their own way of managing API keys via environment variables.
+```
+
+For more information on networking as a whole, see [this guide](./networks.html).
+
 ## Plugins
 
 Set which `ape` plugins you want to always use.

diff --git a/latest/commands/networks.html b/latest/commands/networks.html
@@ -193,7 +193,7 @@ <h2>list<a class="headerlink" href="#networks-list" title="Link to this heading"
 <dd><p>Filter the results by ecosystem</p>
 <dl class="field-list simple">
 <dt class="field-odd">Options<span class="colon">:</span></dt>
-<dd class="field-odd"><p>bsc | cronos-zkevm | astar | lens | moonbeam | flow-evm | polygon | celo | berachain | shibarium | zksync | blast | ethereum | optimism | world-chain | fantom | geist | base | palm | scroll | rootstock | metis | zora | unichain | linea | abstract | polygon-zkevm | apechain | shape | kroma | polynomial | arbitrum | lumia | gnosis | bttc | cronos | zetachain | mantle | fraxtal | avalanche | crossfi | oort | wemix | xai | xmtp | soneium | taiko</p>
+<dd class="field-odd"><p>crossfi | abstract | palm | zksync | oort | lens | geist | metis | bsc | bttc | flow-evm | polynomial | world-chain | lumia | berachain | wemix | moonbeam | cronos | ethereum | scroll | zetachain | base | astar | soneium | zora | optimism | taiko | shibarium | gnosis | blast | linea | rootstock | apechain | avalanche | mantle | fraxtal | kroma | arbitrum | polygon | celo | xai | cronos-zkevm | fantom | polygon-zkevm | shape | unichain | xmtp</p>
 </dd>
 </dl>
 </dd></dl>
@@ -204,7 +204,7 @@ <h2>list<a class="headerlink" href="#networks-list" title="Link to this heading"
 <dd><p>Filter the results by network</p>
 <dl class="field-list simple">
 <dt class="field-odd">Options<span class="colon">:</span></dt>
-<dd class="field-odd"><p>goerli | amoy-fork | moonbase-fork | fuji-fork | bartio | chiado-fork | moonriver-fork | goerli-fork | fuji | mainnet | prism-fork | dev | mainnet-fork | hekla-fork | alfajores-fork | puppynet-fork | nova-fork | hekla | minato | moonbase | chiado | prism | testnet-fork | opbnb-testnet-fork | bartio-fork | testnet | sepolia | donau | mumbai-fork | moonriver | polter | opbnb-testnet | nova | cardona | opbnb | holesky | polter-fork | cardona-fork | amoy | puppynet | curtis-fork | holesky-fork | mumbai | sepolia-fork | dev-fork | local | alfajores | curtis | donau-fork | minato-fork | opbnb-fork</p>
+<dd class="field-odd"><p>hekla-fork | dev-fork | opbnb-testnet-fork | mumbai-fork | donau-fork | chiado-fork | nova | donau | chiado | cardona-fork | holesky-fork | opbnb | amoy-fork | alfajores-fork | bartio-fork | polter | moonriver | prism-fork | fuji-fork | opbnb-testnet | mainnet | bartio | goerli-fork | minato-fork | amoy | curtis-fork | goerli | local | curtis | alfajores | moonbase-fork | puppynet | minato | sepolia | fuji | hekla | holesky | moonbase | dev | testnet-fork | nova-fork | prism | cardona | testnet | sepolia-fork | puppynet-fork | polter-fork | opbnb-fork | moonriver-fork | mainnet-fork | mumbai</p>
 </dd>
 </dl>
 </dd></dl>

diff --git a/latest/searchindex.js b/latest/searchindex.js
diff --git a/latest/userguides/config.html b/latest/userguides/config.html
@@ -132,8 +132,9 @@
 <li><a class="reference internal" href="#default-ecosystem">Default Ecosystem</a></li>
 <li><a class="reference internal" href="#dependencies">Dependencies</a></li>
 <li><a class="reference internal" href="#deployments">Deployments</a></li>
-<li><a class="reference internal" href="#node">Node</a></li>
+<li><a class="reference internal" href="#name">Name</a></li>
 <li><a class="reference internal" href="#networks">Networks</a></li>
+<li><a class="reference internal" href="#node">Node</a></li>
 <li><a class="reference internal" href="#plugins">Plugins</a></li>
 <li><a class="reference internal" href="#request-headers">Request Headers</a></li>
 <li><a class="reference internal" href="#testing">Testing</a></li>
@@ -307,27 +308,22 @@ <h2>Deployments<a class="headerlink" href="#deployments" title="Link to this hea
 <p>Ape does not add or edit deployments in your <code class="docutils literal notranslate"><span class="pre">ape-config.yaml</span></code> file.</p>
 </div>
 </section>
-<section id="node">
-<h2>Node<a class="headerlink" href="#node" title="Link to this heading"></a></h2>
-<p>When using the <code class="docutils literal notranslate"><span class="pre">node</span></code> provider, you can customize its settings.
-For example, to change the URI for an Ethereum network, do:</p>
-<div class="highlight-toml notranslate"><div class="highlight"><pre><span></span><span data-line="1"><span class="k">[tool.ape.node.ethereum.mainnet]</span>
-</span><span data-line="2"><span class="n">uri</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">&quot;http://localhost:5030&quot;</span>
+<section id="name">
+<h2>Name<a class="headerlink" href="#name" title="Link to this heading"></a></h2>
+<p>Configure the name of the project:</p>
+<div class="highlight-toml notranslate"><div class="highlight"><pre><span></span><span data-line="1"><span class="k">[tool.ape]</span>
+</span><span data-line="2"><span class="n">name</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">&quot;ape-project&quot;</span>
 </span></pre></div>
 </div>
-<p>Or the equivalent YAML:</p>
-<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span data-line="1"><span class="nt">node</span><span class="p">:</span>
-</span><span data-line="2"><span class="w">  </span><span class="nt">ethereum</span><span class="p">:</span>
-</span><span data-line="3"><span class="w">    </span><span class="nt">mainnet</span><span class="p">:</span>
-</span><span data-line="4"><span class="w">      </span><span class="nt">uri</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">http://localhost:5030</span>
+<p>If the name is not specified in <code class="docutils literal notranslate"><span class="pre">tool.ape</span></code> but is in <code class="docutils literal notranslate"><span class="pre">project</span></code>, Ape will use that as the project name:</p>
+<div class="highlight-toml notranslate"><div class="highlight"><pre><span></span><span data-line="1"><span class="k">[project]</span>
+</span><span data-line="2"><span class="n">name</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">&quot;ape-project&quot;</span>
 </span></pre></div>
 </div>
-<p>Now, the <code class="docutils literal notranslate"><span class="pre">ape-node</span></code> core plugin will use the URL <code class="docutils literal notranslate"><span class="pre">http://localhost:5030</span></code> to connect and make requests.</p>
-<div class="admonition warning">
-<p class="admonition-title">Warning</p>
-<p>Instead of using <code class="docutils literal notranslate"><span class="pre">ape-node</span></code> to connect to an Infura or Alchemy node, use the <a class="reference external" href="https://github.com/ApeWorX/ape-infura">ape-infura</a> or <a class="reference external" href="https://github.com/ApeWorX/ape-alchemy">ape-alchemy</a> provider plugins instead, which have their own way of managing API keys via environment variables.</p>
+<p>To configure this name using an <code class="docutils literal notranslate"><span class="pre">ape-config.yaml</span></code> file, do:</p>
+<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span data-line="1"><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ape-project</span>
+</span></pre></div>
 </div>
-<p>For more information on networking as a whole, see <a class="reference external" href="./networks.html">this guide</a>.</p>
 </section>
 <section id="networks">
 <h2>Networks<a class="headerlink" href="#networks" title="Link to this heading"></a></h2>
@@ -370,6 +366,28 @@ <h2>Networks<a class="headerlink" href="#networks" title="Link to this heading">
 </div>
 <p>For the local network configuration, the default is <code class="docutils literal notranslate"><span class="pre">&quot;max&quot;</span></code>. Otherwise, it is <code class="docutils literal notranslate"><span class="pre">&quot;auto&quot;</span></code>.</p>
 </section>
+<section id="node">
+<h2>Node<a class="headerlink" href="#node" title="Link to this heading"></a></h2>
+<p>When using the <code class="docutils literal notranslate"><span class="pre">node</span></code> provider, you can customize its settings.
+For example, to change the URI for an Ethereum network, do:</p>
+<div class="highlight-toml notranslate"><div class="highlight"><pre><span></span><span data-line="1"><span class="k">[tool.ape.node.ethereum.mainnet]</span>
+</span><span data-line="2"><span class="n">uri</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">&quot;http://localhost:5030&quot;</span>
+</span></pre></div>
+</div>
+<p>Or the equivalent YAML:</p>
+<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span data-line="1"><span class="nt">node</span><span class="p">:</span>
+</span><span data-line="2"><span class="w">  </span><span class="nt">ethereum</span><span class="p">:</span>
+</span><span data-line="3"><span class="w">    </span><span class="nt">mainnet</span><span class="p">:</span>
+</span><span data-line="4"><span class="w">      </span><span class="nt">uri</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">http://localhost:5030</span>
+</span></pre></div>
+</div>
+<p>Now, the <code class="docutils literal notranslate"><span class="pre">ape-node</span></code> core plugin will use the URL <code class="docutils literal notranslate"><span class="pre">http://localhost:5030</span></code> to connect and make requests.</p>
+<div class="admonition warning">
+<p class="admonition-title">Warning</p>
+<p>Instead of using <code class="docutils literal notranslate"><span class="pre">ape-node</span></code> to connect to an Infura or Alchemy node, use the <a class="reference external" href="https://github.com/ApeWorX/ape-infura">ape-infura</a> or <a class="reference external" href="https://github.com/ApeWorX/ape-alchemy">ape-alchemy</a> provider plugins instead, which have their own way of managing API keys via environment variables.</p>
+</div>
+<p>For more information on networking as a whole, see <a class="reference external" href="./networks.html">this guide</a>.</p>
+</section>
 <section id="plugins">
 <h2>Plugins<a class="headerlink" href="#plugins" title="Link to this heading"></a></h2>
 <p>Set which <code class="docutils literal notranslate"><span class="pre">ape</span></code> plugins you want to always use.</p>