Update documentation

ApeWorX · Oct 29, 2024 · f673582 · f673582
1 parent dfd4c71
commit f673582
Show file tree

Hide file tree

Showing 21 changed files with 58 additions and 58 deletions.
diff --git a/index.html b/index.html
@@ -2,4 +2,4 @@
 <!DOCTYPE html>
 <meta charset="utf-8">
 <title>Redirecting...</title>
-<meta http-equiv="refresh" content="0; URL=./stable/userguides/quickstart.html">
+<meta http-equiv="refresh" content="0; URL=./latest/userguides/quickstart.html">
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_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/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/commands/networks.html b/latest/commands/networks.html
@@ -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>local | sepolia | sepolia-fork | holesky | mainnet | mainnet-fork | holesky-fork</p>
+<dd class="field-odd"><p>mainnet | sepolia | holesky | sepolia-fork | local | holesky-fork | mainnet-fork</p>
 </dd>
 </dl>
 </dd></dl>
@@ -215,7 +215,7 @@ <h2>list<a class="headerlink" href="#networks-list" title="Link to this heading"
 <dd><p>Filter the results by provider</p>
 <dl class="field-list simple">
 <dt class="field-odd">Options<span class="colon">:</span></dt>
-<dd class="field-odd"><p>node | test</p>
+<dd class="field-odd"><p>test | node</p>
 </dd>
 </dl>
 </dd></dl>

diff --git a/latest/methoddocs/ape_ethereum.html b/latest/methoddocs/ape_ethereum.html
diff --git a/latest/methoddocs/ape_node.html b/latest/methoddocs/ape_node.html
diff --git a/latest/methoddocs/api.html b/latest/methoddocs/api.html
diff --git a/latest/methoddocs/managers.html b/latest/methoddocs/managers.html
@@ -1567,7 +1567,7 @@ <h2>Chain<a class="headerlink" href="#chain" title="Link to this heading"></a
 
 <dl class="py method">
 <dt class="sig sig-object py" id="ape.managers.chain.ChainManager.restore">
-<span class="sig-name descname"><span class="pre">restore</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">snapshot_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">bytes</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ape.managers.chain.ChainManager.restore" title="Link to this definition"></a></dt>
+<span class="sig-name descname"><span class="pre">restore</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">snapshot_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">SnapshotID</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ape.managers.chain.ChainManager.restore" title="Link to this definition"></a></dt>
 <dd><p>Regress the current call using the given snapshot ID.
 Allows developers to go back to a previous state.</p>
 <dl class="field-list simple">
@@ -1588,7 +1588,7 @@ <h2>Chain<a class="headerlink" href="#chain" title="Link to this heading"></a
 
 <dl class="py method">
 <dt class="sig sig-object py" id="ape.managers.chain.ChainManager.snapshot">
-<span class="sig-name descname"><span class="pre">snapshot</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">bytes</span></span></span><a class="headerlink" href="#ape.managers.chain.ChainManager.snapshot" title="Link to this definition"></a></dt>
+<span class="sig-name descname"><span class="pre">snapshot</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">SnapshotID</span></span></span><a class="headerlink" href="#ape.managers.chain.ChainManager.snapshot" title="Link to this definition"></a></dt>
 <dd><p>Record the current state of the blockchain with intent to later
 call the method <code class="xref py py-meth docutils literal notranslate"><span class="pre">revert()</span></code>
 to go back to this point. This method is for local networks only.</p>
@@ -2272,7 +2272,7 @@ <h2>Chain<a class="headerlink" href="#chain" title="Link to this heading"></a
 
 <dl class="py method">
 <dt class="sig sig-object py" id="ape.managers.networks.NetworkManager.create_custom_provider">
-<span class="sig-name descname"><span class="pre">create_custom_provider</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">connection_str:</span> <span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">provider_cls:</span> <span class="pre">type[~ape.api.providers.ProviderAPI]</span> <span class="pre">=</span> <span class="pre">&lt;class</span> <span class="pre">'ape_ethereum.provider.EthereumNodeProvider'&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">provider_name:</span> <span class="pre">str</span> <span class="pre">|</span> <span class="pre">None</span> <span class="pre">=</span> <span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="api.html#ape.api.providers.ProviderAPI" title="ape.api.providers.ProviderAPI"><span class="pre">ProviderAPI</span></a></span></span><a class="headerlink" href="#ape.managers.networks.NetworkManager.create_custom_provider" title="Link to this definition"></a></dt>
+<span class="sig-name descname"><span class="pre">create_custom_provider</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">connection_str:</span> <span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">provider_cls:</span> <span class="pre">type[ProviderAPI]</span> <span class="pre">=</span> <span class="pre">&lt;class</span> <span class="pre">'ape_ethereum.provider.EthereumNodeProvider'&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">provider_name:</span> <span class="pre">str</span> <span class="pre">|</span> <span class="pre">None</span> <span class="pre">=</span> <span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="api.html#ape.api.providers.ProviderAPI" title="ape.api.providers.ProviderAPI"><span class="pre">ProviderAPI</span></a></span></span><a class="headerlink" href="#ape.managers.networks.NetworkManager.create_custom_provider" title="Link to this definition"></a></dt>
 <dd><p>Create a custom connection to a URI using the EthereumNodeProvider provider.
 <strong>NOTE</strong>: This provider will assume EVM-like behavior and this is generally not recommended.
 Use plugins when possible!</p>
@@ -2442,7 +2442,7 @@ <h2>Chain<a class="headerlink" href="#chain" title="Link to this heading"></a
 
 <dl class="py method">
 <dt class="sig sig-object py" id="ape.managers.networks.NetworkManager.get_request_headers">
-<span class="sig-name descname"><span class="pre">get_request_headers</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ecosystem_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">network_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">provider_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="utils.html#ape.utils.RPCHeaders" title="ape.utils.rpc.RPCHeaders"><span class="pre">RPCHeaders</span></a></span></span><a class="headerlink" href="#ape.managers.networks.NetworkManager.get_request_headers" title="Link to this definition"></a></dt>
+<span class="sig-name descname"><span class="pre">get_request_headers</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ecosystem_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">network_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">provider_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="utils.html#ape.utils.RPCHeaders" title="ape.utils.RPCHeaders"><span class="pre">RPCHeaders</span></a></span></span><a class="headerlink" href="#ape.managers.networks.NetworkManager.get_request_headers" title="Link to this definition"></a></dt>
 <dd><p>All request headers to be used when connecting to this network.</p>
 </dd></dl>