Update documentation

ApeWorX · Feb 21, 2024 · 332dd24 · 332dd24
1 parent 75c3506
commit 332dd24
Show file tree

Hide file tree

Showing 209 changed files with 35,528 additions and 5 deletions.
diff --git a/stable/.buildinfo b/stable/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 3efcc2a0fe2667f97a9179c4406d7d81
+config: 4309f1024d4d890d392967fc36dd1ce9
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/stable/.doctrees/commands/networks.doctree b/stable/.doctrees/commands/networks.doctree
diff --git a/stable/.doctrees/environment.pickle b/stable/.doctrees/environment.pickle
diff --git a/stable/.doctrees/methoddocs/ape.doctree b/stable/.doctrees/methoddocs/ape.doctree
diff --git a/stable/.doctrees/methoddocs/ape_accounts.doctree b/stable/.doctrees/methoddocs/ape_accounts.doctree
diff --git a/stable/.doctrees/methoddocs/api.doctree b/stable/.doctrees/methoddocs/api.doctree
diff --git a/stable/.doctrees/methoddocs/cli.doctree b/stable/.doctrees/methoddocs/cli.doctree
diff --git a/stable/.doctrees/methoddocs/contracts.doctree b/stable/.doctrees/methoddocs/contracts.doctree
diff --git a/stable/.doctrees/methoddocs/exceptions.doctree b/stable/.doctrees/methoddocs/exceptions.doctree
diff --git a/stable/.doctrees/methoddocs/managers.doctree b/stable/.doctrees/methoddocs/managers.doctree
diff --git a/stable/.doctrees/methoddocs/plugins.doctree b/stable/.doctrees/methoddocs/plugins.doctree
diff --git a/stable/.doctrees/methoddocs/types.doctree b/stable/.doctrees/methoddocs/types.doctree
diff --git a/stable/.doctrees/methoddocs/utils.doctree b/stable/.doctrees/methoddocs/utils.doctree
diff --git a/stable/.doctrees/userguides/compile.doctree b/stable/.doctrees/userguides/compile.doctree
diff --git a/stable/_sources/userguides/compile.md.txt b/stable/_sources/userguides/compile.md.txt
@@ -85,7 +85,23 @@ compile:
 ## Settings
 
 Generally, configure compiler plugins using your `ape-config.yaml` file.
-For example, when using the `vyper` plugin, you can configure settings under the `vyper` key:
+One setting that applies to many compiler plugins is `cache_folder`, which holds dependency source files the compiler uses when compiling your contracts.
+By default, the folder is in your `contracts/.cache` folder but there are times you may want to move this to another location.
+Paths are relative to the project directory.
+For instance, to move the dependency cahce to the root project directory:
+
+```yaml
+compile:
+   cache_folder: .cache
+```
+
+```{caution}
+Changing the location of the dependency cache folder may alter the the output bytecode of your contracts from some compilers.
+Specifically, the [solc compiler will apend a hash of the input metadata to the contract bytecode](https://docs.soliditylang.org/en/latest/metadata.html#encoding-of-the-metadata-hash-in-the-bytecode) which will change with contract path or compiler settings changes.
+This may impact things like contract verification on existing projects.
+```
+
+As another example, when using the `vyper` plugin, you can configure settings under the `vyper` key:
 
 ```yaml
 vyper:

diff --git a/stable/commands/accounts.html b/stable/commands/accounts.html
@@ -50,6 +50,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.7.9">v0.7.9</option>
                 <option value="v0.7.8">v0.7.8</option>
                 <option value="v0.7.7">v0.7.7</option>
                 <option value="v0.7.6">v0.7.6</option>

diff --git a/stable/commands/compile.html b/stable/commands/compile.html
@@ -50,6 +50,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.7.9">v0.7.9</option>
                 <option value="v0.7.8">v0.7.8</option>
                 <option value="v0.7.7">v0.7.7</option>
                 <option value="v0.7.6">v0.7.6</option>

diff --git a/stable/commands/console.html b/stable/commands/console.html
@@ -50,6 +50,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.7.9">v0.7.9</option>
                 <option value="v0.7.8">v0.7.8</option>
                 <option value="v0.7.7">v0.7.7</option>
                 <option value="v0.7.6">v0.7.6</option>

diff --git a/stable/commands/init.html b/stable/commands/init.html
@@ -50,6 +50,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.7.9">v0.7.9</option>
                 <option value="v0.7.8">v0.7.8</option>
                 <option value="v0.7.7">v0.7.7</option>
                 <option value="v0.7.6">v0.7.6</option>

diff --git a/stable/commands/networks.html b/stable/commands/networks.html
@@ -50,6 +50,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.7.9">v0.7.9</option>
                 <option value="v0.7.8">v0.7.8</option>
                 <option value="v0.7.7">v0.7.7</option>
                 <option value="v0.7.6">v0.7.6</option>
@@ -257,7 +258,7 @@ <h2>list<a class="headerlink" href="#networks-list" title="Permalink to this hea
 <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-fork | goerli | sepolia-fork | sepolia | local | mainnet-fork | mainnet</p>
+<dd class="field-odd"><p>mainnet-fork | goerli-fork | sepolia-fork | goerli | mainnet | local | sepolia</p>
 </dd>
 </dl>
 </dd></dl>

diff --git a/stable/commands/plugins.html b/stable/commands/plugins.html
@@ -50,6 +50,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.7.9">v0.7.9</option>
                 <option value="v0.7.8">v0.7.8</option>
                 <option value="v0.7.7">v0.7.7</option>
                 <option value="v0.7.6">v0.7.6</option>

diff --git a/stable/commands/pm.html b/stable/commands/pm.html
@@ -50,6 +50,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.7.9">v0.7.9</option>
                 <option value="v0.7.8">v0.7.8</option>
                 <option value="v0.7.7">v0.7.7</option>
                 <option value="v0.7.6">v0.7.6</option>

diff --git a/stable/commands/run.html b/stable/commands/run.html
@@ -50,6 +50,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.7.9">v0.7.9</option>
                 <option value="v0.7.8">v0.7.8</option>
                 <option value="v0.7.7">v0.7.7</option>
                 <option value="v0.7.6">v0.7.6</option>

diff --git a/stable/commands/test.html b/stable/commands/test.html
@@ -50,6 +50,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.7.9">v0.7.9</option>
                 <option value="v0.7.8">v0.7.8</option>
                 <option value="v0.7.7">v0.7.7</option>
                 <option value="v0.7.6">v0.7.6</option>

diff --git a/stable/genindex.html b/stable/genindex.html
@@ -47,6 +47,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.7.9">v0.7.9</option>
                 <option value="v0.7.8">v0.7.8</option>
                 <option value="v0.7.7">v0.7.7</option>
                 <option value="v0.7.6">v0.7.6</option>
@@ -1274,6 +1275,8 @@ <h2 id="C">C</h2>
 </li>
       </ul></li>
       <li><a href="methoddocs/managers.html#ape.managers.compilers.CompilerManager.compile_source">compile_source() (ape.managers.compilers.CompilerManager method)</a>
+</li>
+      <li><a href="methoddocs/managers.html#ape.managers.project.manager.ProjectManager.compiler_cache_folder">compiler_cache_folder (ape.managers.project.manager.ProjectManager property)</a>
 </li>
       <li><a href="methoddocs/managers.html#ape.managers.project.manager.ProjectManager.compiler_data">compiler_data (ape.managers.project.manager.ProjectManager property)</a>
 </li>

diff --git a/stable/index.html b/stable/index.html
@@ -49,6 +49,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.7.9">v0.7.9</option>
                 <option value="v0.7.8">v0.7.8</option>
                 <option value="v0.7.7">v0.7.7</option>
                 <option value="v0.7.6">v0.7.6</option>

diff --git a/stable/methoddocs/ape.html b/stable/methoddocs/ape.html
@@ -50,6 +50,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.7.9">v0.7.9</option>
                 <option value="v0.7.8">v0.7.8</option>
                 <option value="v0.7.7">v0.7.7</option>
                 <option value="v0.7.6">v0.7.6</option>

diff --git a/stable/methoddocs/ape_accounts.html b/stable/methoddocs/ape_accounts.html
@@ -50,6 +50,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.7.9">v0.7.9</option>
                 <option value="v0.7.8">v0.7.8</option>
                 <option value="v0.7.7">v0.7.7</option>
                 <option value="v0.7.6">v0.7.6</option>

diff --git a/stable/methoddocs/api.html b/stable/methoddocs/api.html
@@ -50,6 +50,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.7.9">v0.7.9</option>
                 <option value="v0.7.8">v0.7.8</option>
                 <option value="v0.7.7">v0.7.7</option>
                 <option value="v0.7.6">v0.7.6</option>

diff --git a/stable/methoddocs/cli.html b/stable/methoddocs/cli.html
@@ -50,6 +50,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.7.9">v0.7.9</option>
                 <option value="v0.7.8">v0.7.8</option>
                 <option value="v0.7.7">v0.7.7</option>
                 <option value="v0.7.6">v0.7.6</option>

diff --git a/stable/methoddocs/contracts.html b/stable/methoddocs/contracts.html
@@ -50,6 +50,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.7.9">v0.7.9</option>
                 <option value="v0.7.8">v0.7.8</option>
                 <option value="v0.7.7">v0.7.7</option>
                 <option value="v0.7.6">v0.7.6</option>

diff --git a/stable/methoddocs/exceptions.html b/stable/methoddocs/exceptions.html
@@ -50,6 +50,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.7.9">v0.7.9</option>
                 <option value="v0.7.8">v0.7.8</option>
                 <option value="v0.7.7">v0.7.7</option>
                 <option value="v0.7.6">v0.7.6</option>

diff --git a/stable/methoddocs/managers.html b/stable/methoddocs/managers.html
@@ -50,6 +50,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.7.9">v0.7.9</option>
                 <option value="v0.7.8">v0.7.8</option>
                 <option value="v0.7.7">v0.7.7</option>
                 <option value="v0.7.6">v0.7.6</option>
@@ -374,6 +375,7 @@
 <li class="toctree-l3"><a class="reference internal" href="#ape.managers.project.manager.ProjectManager"><code class="docutils literal notranslate"><span class="pre">ProjectManager</span></code></a><ul>
 <li class="toctree-l4"><a class="reference internal" href="#ape.managers.project.manager.ProjectManager.__getattr__"><code class="docutils literal notranslate"><span class="pre">ProjectManager.__getattr__()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#ape.managers.project.manager.ProjectManager.__str__"><code class="docutils literal notranslate"><span class="pre">ProjectManager.__str__()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#ape.managers.project.manager.ProjectManager.compiler_cache_folder"><code class="docutils literal notranslate"><span class="pre">ProjectManager.compiler_cache_folder</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#ape.managers.project.manager.ProjectManager.compiler_data"><code class="docutils literal notranslate"><span class="pre">ProjectManager.compiler_data</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#ape.managers.project.manager.ProjectManager.contracts"><code class="docutils literal notranslate"><span class="pre">ProjectManager.contracts</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#ape.managers.project.manager.ProjectManager.contracts_folder"><code class="docutils literal notranslate"><span class="pre">ProjectManager.contracts_folder</span></code></a></li>
@@ -2407,6 +2409,12 @@ <h2>Chain<a class="headerlink" href="#chain" title="Permalink to this heading">
 <dd><p>Return str(self).</p>
 </dd></dl>
 
+<dl class="py property">
+<dt class="sig sig-object py" id="ape.managers.project.manager.ProjectManager.compiler_cache_folder">
+<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">compiler_cache_folder</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Path</span></em><a class="headerlink" href="#ape.managers.project.manager.ProjectManager.compiler_cache_folder" title="Permalink to this definition"></a></dt>
+<dd><p>The path to the project’s compiler source cache folder.</p>
+</dd></dl>
+
 <dl class="py property">
 <dt class="sig sig-object py" id="ape.managers.project.manager.ProjectManager.compiler_data">
 <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">compiler_data</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">Compiler</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#ape.managers.project.manager.ProjectManager.compiler_data" title="Permalink to this definition"></a></dt>

diff --git a/stable/methoddocs/plugins.html b/stable/methoddocs/plugins.html
@@ -50,6 +50,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.7.9">v0.7.9</option>
                 <option value="v0.7.8">v0.7.8</option>
                 <option value="v0.7.7">v0.7.7</option>
                 <option value="v0.7.6">v0.7.6</option>

diff --git a/stable/methoddocs/types.html b/stable/methoddocs/types.html
@@ -50,6 +50,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.7.9">v0.7.9</option>
                 <option value="v0.7.8">v0.7.8</option>
                 <option value="v0.7.7">v0.7.7</option>
                 <option value="v0.7.6">v0.7.6</option>

diff --git a/stable/methoddocs/utils.html b/stable/methoddocs/utils.html
@@ -49,6 +49,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.7.9">v0.7.9</option>
                 <option value="v0.7.8">v0.7.8</option>
                 <option value="v0.7.7">v0.7.7</option>
                 <option value="v0.7.6">v0.7.6</option>

diff --git a/stable/objects.inv b/stable/objects.inv
diff --git a/stable/py-modindex.html b/stable/py-modindex.html
@@ -50,6 +50,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.7.9">v0.7.9</option>
                 <option value="v0.7.8">v0.7.8</option>
                 <option value="v0.7.7">v0.7.7</option>
                 <option value="v0.7.6">v0.7.6</option>

diff --git a/stable/search.html b/stable/search.html
@@ -50,6 +50,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.7.9">v0.7.9</option>
                 <option value="v0.7.8">v0.7.8</option>
                 <option value="v0.7.7">v0.7.7</option>
                 <option value="v0.7.6">v0.7.6</option>

diff --git a/stable/searchindex.js b/stable/searchindex.js
diff --git a/stable/userguides/accounts.html b/stable/userguides/accounts.html
@@ -50,6 +50,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.7.9">v0.7.9</option>
                 <option value="v0.7.8">v0.7.8</option>
                 <option value="v0.7.7">v0.7.7</option>
                 <option value="v0.7.6">v0.7.6</option>

diff --git a/stable/userguides/clis.html b/stable/userguides/clis.html
@@ -50,6 +50,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.7.9">v0.7.9</option>
                 <option value="v0.7.8">v0.7.8</option>
                 <option value="v0.7.7">v0.7.7</option>
                 <option value="v0.7.6">v0.7.6</option>

diff --git a/stable/userguides/compile.html b/stable/userguides/compile.html
@@ -50,6 +50,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.7.9">v0.7.9</option>
                 <option value="v0.7.8">v0.7.8</option>
                 <option value="v0.7.7">v0.7.7</option>
                 <option value="v0.7.6">v0.7.6</option>
@@ -291,7 +292,21 @@ <h2>Dependencies<a class="headerlink" href="#dependencies" title="Permalink to t
 <section id="settings">
 <h2>Settings<a class="headerlink" href="#settings" title="Permalink to this heading"></a></h2>
 <p>Generally, configure compiler plugins using your <code class="docutils literal notranslate"><span class="pre">ape-config.yaml</span></code> file.
-For example, when using the <code class="docutils literal notranslate"><span class="pre">vyper</span></code> plugin, you can configure settings under the <code class="docutils literal notranslate"><span class="pre">vyper</span></code> key:</p>
+One setting that applies to many compiler plugins is <code class="docutils literal notranslate"><span class="pre">cache_folder</span></code>, which holds dependency source files the compiler uses when compiling your contracts.
+By default, the folder is in your <code class="docutils literal notranslate"><span class="pre">contracts/.cache</span></code> folder but there are times you may want to move this to another location.
+Paths are relative to the project directory.
+For instance, to move the dependency cahce to the root project directory:</p>
+<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">compile</span><span class="p">:</span>
+<span class="w">   </span><span class="nt">cache_folder</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">.cache</span>
+</pre></div>
+</div>
+<div class="admonition caution">
+<p class="admonition-title">Caution</p>
+<p>Changing the location of the dependency cache folder may alter the the output bytecode of your contracts from some compilers.
+Specifically, the <a class="reference external" href="https://docs.soliditylang.org/en/latest/metadata.html#encoding-of-the-metadata-hash-in-the-bytecode">solc compiler will apend a hash of the input metadata to the contract bytecode</a> which will change with contract path or compiler settings changes.
+This may impact things like contract verification on existing projects.</p>
+</div>
+<p>As another example, when using the <code class="docutils literal notranslate"><span class="pre">vyper</span></code> plugin, you can configure settings under the <code class="docutils literal notranslate"><span class="pre">vyper</span></code> key:</p>
 <div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">vyper</span><span class="p">:</span>
 <span class="w">  </span><span class="nt">version</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">0.3.10</span>
 </pre></div>

diff --git a/stable/userguides/config.html b/stable/userguides/config.html
@@ -50,6 +50,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.7.9">v0.7.9</option>
                 <option value="v0.7.8">v0.7.8</option>
                 <option value="v0.7.7">v0.7.7</option>
                 <option value="v0.7.6">v0.7.6</option>

diff --git a/stable/userguides/console.html b/stable/userguides/console.html
@@ -50,6 +50,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.7.9">v0.7.9</option>
                 <option value="v0.7.8">v0.7.8</option>
                 <option value="v0.7.7">v0.7.7</option>
                 <option value="v0.7.6">v0.7.6</option>

diff --git a/stable/userguides/contracts.html b/stable/userguides/contracts.html
@@ -50,6 +50,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.7.9">v0.7.9</option>
                 <option value="v0.7.8">v0.7.8</option>
                 <option value="v0.7.7">v0.7.7</option>
                 <option value="v0.7.6">v0.7.6</option>