Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@actions-user
actions-user committed Dec 22, 2023
1 parent a8a1cb9 commit 5bf44be
Show file tree
Hide file tree
Showing 198 changed files with 32,866 additions and 15 deletions.
2 changes: 1 addition & 1 deletion stable/.buildinfo
View file
Original file line number Diff line number Diff line change
@@ -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: e568de20d68e9e2a0a835fef1fb5e9a1
config: 0d8bff9d240ffda02270a66110e93b70
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified stable/.doctrees/commands/networks.doctree
View file
Binary file not shown.
Binary file modified stable/.doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified stable/.doctrees/methoddocs/ape.doctree
View file
Binary file not shown.
Binary file modified stable/.doctrees/methoddocs/api.doctree
View file
Binary file not shown.
Binary file modified stable/.doctrees/methoddocs/cli.doctree
View file
Binary file not shown.
Binary file modified stable/.doctrees/methoddocs/contracts.doctree
View file
Binary file not shown.
Binary file modified stable/.doctrees/methoddocs/exceptions.doctree
View file
Binary file not shown.
Binary file modified stable/.doctrees/methoddocs/managers.doctree
View file
Binary file not shown.
Binary file modified stable/.doctrees/methoddocs/plugins.doctree
View file
Binary file not shown.
Binary file modified stable/.doctrees/methoddocs/types.doctree
View file
Binary file not shown.
Binary file modified stable/.doctrees/methoddocs/utils.doctree
View file
Binary file not shown.
1 change: 1 addition & 0 deletions stable/commands/accounts.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.7.0">v0.7.0</option>
<option value="v0.6.27">v0.6.27</option>
<option value="v0.6.26">v0.6.26</option>
<option value="v0.6.25">v0.6.25</option>
Expand Down
1 change: 1 addition & 0 deletions stable/commands/compile.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.7.0">v0.7.0</option>
<option value="v0.6.27">v0.6.27</option>
<option value="v0.6.26">v0.6.26</option>
<option value="v0.6.25">v0.6.25</option>
Expand Down
1 change: 1 addition & 0 deletions stable/commands/console.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.7.0">v0.7.0</option>
<option value="v0.6.27">v0.6.27</option>
<option value="v0.6.26">v0.6.26</option>
<option value="v0.6.25">v0.6.25</option>
Expand Down
1 change: 1 addition & 0 deletions stable/commands/init.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.7.0">v0.7.0</option>
<option value="v0.6.27">v0.6.27</option>
<option value="v0.6.26">v0.6.26</option>
<option value="v0.6.25">v0.6.25</option>
Expand Down
5 changes: 3 additions & 2 deletions stable/commands/networks.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.7.0">v0.7.0</option>
<option value="v0.6.27">v0.6.27</option>
<option value="v0.6.26">v0.6.26</option>
<option value="v0.6.25">v0.6.25</option>
Expand Down Expand Up @@ -246,7 +247,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>sepolia | mainnet | mainnet-fork | goerli-fork | sepolia-fork | local | goerli</p>
<dd class="field-odd"><p>goerli-fork | mainnet | sepolia | local | goerli | sepolia-fork | mainnet-fork</p>
</dd>
</dl>
</dd></dl>
Expand All @@ -257,7 +258,7 @@ <h2>list<a class="headerlink" href="#networks-list" title="Permalink to this hea
<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>geth | test</p>
<dd class="field-odd"><p>test | geth</p>
</dd>
</dl>
</dd></dl>
Expand Down
1 change: 1 addition & 0 deletions stable/commands/plugins.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.7.0">v0.7.0</option>
<option value="v0.6.27">v0.6.27</option>
<option value="v0.6.26">v0.6.26</option>
<option value="v0.6.25">v0.6.25</option>
Expand Down
1 change: 1 addition & 0 deletions stable/commands/pm.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.7.0">v0.7.0</option>
<option value="v0.6.27">v0.6.27</option>
<option value="v0.6.26">v0.6.26</option>
<option value="v0.6.25">v0.6.25</option>
Expand Down
1 change: 1 addition & 0 deletions stable/commands/run.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.7.0">v0.7.0</option>
<option value="v0.6.27">v0.6.27</option>
<option value="v0.6.26">v0.6.26</option>
<option value="v0.6.25">v0.6.25</option>
Expand Down
1 change: 1 addition & 0 deletions stable/commands/test.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.7.0">v0.7.0</option>
<option value="v0.6.27">v0.6.27</option>
<option value="v0.6.26">v0.6.26</option>
<option value="v0.6.25">v0.6.25</option>
Expand Down
13 changes: 12 additions & 1 deletion stable/genindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.7.0">v0.7.0</option>
<option value="v0.6.27">v0.6.27</option>
<option value="v0.6.26">v0.6.26</option>
<option value="v0.6.25">v0.6.25</option>
Expand Down Expand Up @@ -638,6 +639,8 @@ <h2 id="A">A</h2>
<li><a href="methoddocs/api.html#ape.api.accounts.AccountContainerAPI">AccountContainerAPI (class in ape.api.accounts)</a>
</li>
<li><a href="methoddocs/managers.html#ape.managers.chain.AccountHistory">AccountHistory (class in ape.managers.chain)</a>
</li>
<li><a href="methoddocs/managers.html#ape.managers.converters.AccountIntConverter">AccountIntConverter (class in ape.managers.converters)</a>
</li>
<li><a href="methoddocs/managers.html#ape.managers.accounts.AccountManager">AccountManager (class in ape.managers.accounts)</a>
</li>
Expand Down Expand Up @@ -1298,7 +1301,7 @@ <h2 id="C">C</h2>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="methoddocs/api.html#ape.api.providers.UpstreamProvider.connection_str">connection_str (ape.api.providers.UpstreamProvider property)</a>
<li><a href="methoddocs/api.html#ape.api.providers.ProviderAPI.connection_str">connection_str (ape.api.providers.ProviderAPI property)</a>
</li>
<li>
console command line option
Expand Down Expand Up @@ -1377,6 +1380,8 @@ <h2 id="C">C</h2>
<li><a href="methoddocs/cli.html#ape.cli.choices.PromptChoice.convert">(ape.cli.choices.PromptChoice method)</a>
</li>
<li><a href="methoddocs/cli.html#ape.cli.paramtype.AllFilePaths.convert">(ape.cli.paramtype.AllFilePaths method)</a>
</li>
<li><a href="methoddocs/managers.html#ape.managers.converters.AccountIntConverter.convert">(ape.managers.converters.AccountIntConverter method)</a>
</li>
<li><a href="methoddocs/managers.html#ape.managers.converters.AddressAPIConverter.convert">(ape.managers.converters.AddressAPIConverter method)</a>
</li>
Expand Down Expand Up @@ -1846,6 +1851,8 @@ <h2 id="I">I</h2>
<li><a href="methoddocs/api.html#ape.api.convert.ConverterAPI.is_convertible">is_convertible() (ape.api.convert.ConverterAPI method)</a>

<ul>
<li><a href="methoddocs/managers.html#ape.managers.converters.AccountIntConverter.is_convertible">(ape.managers.converters.AccountIntConverter method)</a>
</li>
<li><a href="methoddocs/managers.html#ape.managers.converters.AddressAPIConverter.is_convertible">(ape.managers.converters.AddressAPIConverter method)</a>
</li>
<li><a href="methoddocs/managers.html#ape.managers.converters.BytesAddressConverter.is_convertible">(ape.managers.converters.BytesAddressConverter method)</a>
Expand Down Expand Up @@ -2027,6 +2034,8 @@ <h2 id="M">M</h2>
<li><a href="methoddocs/managers.html#ape.managers.config.DeploymentConfig.model_config">(ape.managers.config.DeploymentConfig attribute)</a>
</li>
<li><a href="methoddocs/managers.html#ape.managers.config.DeploymentConfigCollection.model_config">(ape.managers.config.DeploymentConfigCollection attribute)</a>
</li>
<li><a href="methoddocs/managers.html#ape.managers.converters.AccountIntConverter.model_config">(ape.managers.converters.AccountIntConverter attribute)</a>
</li>
<li><a href="methoddocs/managers.html#ape.managers.converters.AddressAPIConverter.model_config">(ape.managers.converters.AddressAPIConverter attribute)</a>
</li>
Expand Down Expand Up @@ -2133,6 +2142,8 @@ <h2 id="M">M</h2>
<li><a href="methoddocs/managers.html#ape.managers.config.DeploymentConfig.model_fields">(ape.managers.config.DeploymentConfig attribute)</a>
</li>
<li><a href="methoddocs/managers.html#ape.managers.config.DeploymentConfigCollection.model_fields">(ape.managers.config.DeploymentConfigCollection attribute)</a>
</li>
<li><a href="methoddocs/managers.html#ape.managers.converters.AccountIntConverter.model_fields">(ape.managers.converters.AccountIntConverter attribute)</a>
</li>
<li><a href="methoddocs/managers.html#ape.managers.converters.AddressAPIConverter.model_fields">(ape.managers.converters.AddressAPIConverter attribute)</a>
</li>
Expand Down
1 change: 1 addition & 0 deletions stable/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.7.0">v0.7.0</option>
<option value="v0.6.27">v0.6.27</option>
<option value="v0.6.26">v0.6.26</option>
<option value="v0.6.25">v0.6.25</option>
Expand Down
1 change: 1 addition & 0 deletions stable/methoddocs/ape.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.7.0">v0.7.0</option>
<option value="v0.6.27">v0.6.27</option>
<option value="v0.6.26">v0.6.26</option>
<option value="v0.6.25">v0.6.25</option>
Expand Down
20 changes: 11 additions & 9 deletions stable/methoddocs/api.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.7.0">v0.7.0</option>
<option value="v0.6.27">v0.6.27</option>
<option value="v0.6.26">v0.6.26</option>
<option value="v0.6.25">v0.6.25</option>
Expand Down Expand Up @@ -419,6 +420,7 @@
<li class="toctree-l4"><a class="reference internal" href="#ape.api.providers.ProviderAPI.config"><code class="docutils literal notranslate"><span class="pre">ProviderAPI.config</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#ape.api.providers.ProviderAPI.connect"><code class="docutils literal notranslate"><span class="pre">ProviderAPI.connect()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#ape.api.providers.ProviderAPI.connection_id"><code class="docutils literal notranslate"><span class="pre">ProviderAPI.connection_id</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#ape.api.providers.ProviderAPI.connection_str"><code class="docutils literal notranslate"><span class="pre">ProviderAPI.connection_str</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#ape.api.providers.ProviderAPI.data_folder"><code class="docutils literal notranslate"><span class="pre">ProviderAPI.data_folder</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#ape.api.providers.ProviderAPI.disconnect"><code class="docutils literal notranslate"><span class="pre">ProviderAPI.disconnect()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#ape.api.providers.ProviderAPI.estimate_gas_cost"><code class="docutils literal notranslate"><span class="pre">ProviderAPI.estimate_gas_cost()</span></code></a></li>
Expand Down Expand Up @@ -474,7 +476,6 @@
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#ape.api.providers.UpstreamProvider"><code class="docutils literal notranslate"><span class="pre">UpstreamProvider</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#ape.api.providers.UpstreamProvider.connection_str"><code class="docutils literal notranslate"><span class="pre">UpstreamProvider.connection_str</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#ape.api.providers.UpstreamProvider.model_config"><code class="docutils literal notranslate"><span class="pre">UpstreamProvider.model_config</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#ape.api.providers.UpstreamProvider.model_fields"><code class="docutils literal notranslate"><span class="pre">UpstreamProvider.model_fields</span></code></a></li>
</ul>
Expand Down Expand Up @@ -2758,6 +2759,14 @@ <h1>ape.api<a class="headerlink" href="#ape-api" title="Permalink to this headin
providers of the same type, like multiple Geth –dev nodes.</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="ape.api.providers.ProviderAPI.connection_str">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">connection_str</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ape.api.providers.ProviderAPI.connection_str" title="Permalink to this definition"></a></dt>
<dd><p>The str representing how to connect
to the node, such as an HTTP URL
or an IPC path.</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ape.api.providers.ProviderAPI.data_folder">
<span class="sig-name descname"><span class="pre">data_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.api.providers.ProviderAPI.data_folder" title="Permalink to this definition"></a></dt>
Expand Down Expand Up @@ -3301,13 +3310,6 @@ <h1>ape.api<a class="headerlink" href="#ape-api" title="Permalink to this headin
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ape.api.providers.</span></span><span class="sig-name descname"><span class="pre">UpstreamProvider</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">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</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#ape.api.networks.NetworkAPI" title="ape.api.networks.NetworkAPI"><span class="pre">NetworkAPI</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">provider_settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</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">{}</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data_folder</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">request_header</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">block_page_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</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">100</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">concurrency</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</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">4</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ape.api.providers.UpstreamProvider" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#ape.api.providers.ProviderAPI" title="ape.api.providers.ProviderAPI"><code class="xref py py-class docutils literal notranslate"><span class="pre">ProviderAPI</span></code></a></p>
<p>A provider that can also be set as another provider’s upstream.</p>
<dl class="py property">
<dt class="sig sig-object py" id="ape.api.providers.UpstreamProvider.connection_str">
<em class="property"><span class="pre">abstract</span><span class="w"> </span><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">connection_str</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ape.api.providers.UpstreamProvider.connection_str" title="Permalink to this definition"></a></dt>
<dd><p>The str used by downstream providers to connect to this one.
For example, the URL for HTTP-based providers.</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ape.api.providers.UpstreamProvider.model_config">
<span class="sig-name descname"><span class="pre">model_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ClassVar</span><span class="p"><span class="pre">[</span></span><span class="pre">ConfigDict</span><span class="p"><span class="pre">]</span></span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'arbitrary_types_allowed':</span> <span class="pre">True}</span></em><a class="headerlink" href="#ape.api.providers.UpstreamProvider.model_config" title="Permalink to this definition"></a></dt>
Expand Down Expand Up @@ -3402,7 +3404,7 @@ <h2>Transactions<a class="headerlink" href="#transactions" title="Permalink to t

<dl class="py method">
<dt class="sig sig-object py" id="ape.api.transactions.ReceiptAPI.raise_for_status">
<span class="sig-name descname"><span class="pre">raise_for_status</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#ape.api.transactions.ReceiptAPI.raise_for_status" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">raise_for_status</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">NoReturn</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="headerlink" href="#ape.api.transactions.ReceiptAPI.raise_for_status" title="Permalink to this definition"></a></dt>
<dd><p>Handle provider-specific errors regarding a non-successful
<code class="xref py py-class docutils literal notranslate"><span class="pre">TransactionStatusEnum</span></code>.</p>
</dd></dl>
Expand Down
Loading

0 comments on commit 5bf44be

Please sign in to comment.