Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Mar 8, 2024
1 parent 936f806 commit 7832827
Show file tree
Hide file tree
Showing 18 changed files with 32 additions and 5 deletions.
2 changes: 1 addition & 1 deletion latest/.buildinfo
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: 65e0b9d8f939a03a5a65a465c0de98ce
config: 6b8909d33facec08adbf6bf0ac7c98c6
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified latest/.doctrees/commands/networks.doctree
Binary file not shown.
Binary file modified latest/.doctrees/environment.pickle
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/ape.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/ape_accounts.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/api.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/cli.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/contracts.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/exceptions.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/managers.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/plugins.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/types.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/utils.doctree
Binary file not shown.
2 changes: 1 addition & 1 deletion latest/commands/networks.html
Original file line number Diff line number Diff line change
Expand Up @@ -259,7 +259,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 | local | sepolia | mainnet-fork | mainnet | goerli | sepolia-fork</p>
<dd class="field-odd"><p>mainnet-fork | sepolia | local | sepolia-fork | goerli-fork | goerli | mainnet</p>
</dd>
</dl>
</dd></dl>
Expand Down
10 changes: 8 additions & 2 deletions latest/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -1487,6 +1487,10 @@ <h2 id="D">D</h2>
</li>
</ul></li>
<li><a href="methoddocs/managers.html#ape.managers.config.ConfigManager.DATA_FOLDER">DATA_FOLDER (ape.managers.config.ConfigManager attribute)</a>
</li>
<li><a href="methoddocs/api.html#ape.api.transactions.ReceiptAPI.debug_logs_lines">debug_logs_lines (ape.api.transactions.ReceiptAPI property)</a>
</li>
<li><a href="methoddocs/api.html#ape.api.transactions.ReceiptAPI.debug_logs_typed">debug_logs_typed (ape.api.transactions.ReceiptAPI property)</a>
</li>
<li><a href="methoddocs/api.html#ape.api.accounts.AccountAPI.declare">declare() (ape.api.accounts.AccountAPI method)</a>
</li>
Expand Down Expand Up @@ -1518,10 +1522,10 @@ <h2 id="D">D</h2>
<li><a href="methoddocs/managers.html#ape.managers.networks.NetworkManager.default_ecosystem">(ape.managers.networks.NetworkManager property)</a>
</li>
</ul></li>
<li><a href="methoddocs/utils.html#ape.utils.StructParser.default_name">default_name (ape.utils.StructParser property)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="methoddocs/utils.html#ape.utils.StructParser.default_name">default_name (ape.utils.StructParser property)</a>
</li>
<li><a href="methoddocs/api.html#ape.api.networks.EcosystemAPI.default_network_name">default_network_name (ape.api.networks.EcosystemAPI property)</a>
</li>
<li><a href="methoddocs/api.html#ape.api.networks.NetworkAPI.default_provider_name">default_provider_name (ape.api.networks.NetworkAPI property)</a>
Expand Down Expand Up @@ -2813,6 +2817,8 @@ <h2 id="S">S</h2>
</li>
</ul></li>
<li><a href="methoddocs/exceptions.html#ape.exceptions.Abort.show">show() (ape.exceptions.Abort method)</a>
</li>
<li><a href="methoddocs/api.html#ape.api.transactions.ReceiptAPI.show_debug_logs">show_debug_logs() (ape.api.transactions.ReceiptAPI method)</a>
</li>
<li><a href="methoddocs/api.html#ape.api.accounts.AccountAPI.sign_message">sign_message() (ape.api.accounts.AccountAPI method)</a>

Expand Down
21 changes: 21 additions & 0 deletions latest/methoddocs/api.html
Original file line number Diff line number Diff line change
Expand Up @@ -446,13 +446,16 @@
<li class="toctree-l2"><a class="reference internal" href="#transactions">Transactions</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#ape.api.transactions.ReceiptAPI"><code class="docutils literal notranslate"><span class="pre">ReceiptAPI</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#ape.api.transactions.ReceiptAPI.await_confirmations"><code class="docutils literal notranslate"><span class="pre">ReceiptAPI.await_confirmations()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#ape.api.transactions.ReceiptAPI.debug_logs_lines"><code class="docutils literal notranslate"><span class="pre">ReceiptAPI.debug_logs_lines</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#ape.api.transactions.ReceiptAPI.debug_logs_typed"><code class="docutils literal notranslate"><span class="pre">ReceiptAPI.debug_logs_typed</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#ape.api.transactions.ReceiptAPI.decode_logs"><code class="docutils literal notranslate"><span class="pre">ReceiptAPI.decode_logs()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#ape.api.transactions.ReceiptAPI.events"><code class="docutils literal notranslate"><span class="pre">ReceiptAPI.events</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#ape.api.transactions.ReceiptAPI.failed"><code class="docutils literal notranslate"><span class="pre">ReceiptAPI.failed</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#ape.api.transactions.ReceiptAPI.method_called"><code class="docutils literal notranslate"><span class="pre">ReceiptAPI.method_called</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#ape.api.transactions.ReceiptAPI.raise_for_status"><code class="docutils literal notranslate"><span class="pre">ReceiptAPI.raise_for_status()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#ape.api.transactions.ReceiptAPI.ran_out_of_gas"><code class="docutils literal notranslate"><span class="pre">ReceiptAPI.ran_out_of_gas</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#ape.api.transactions.ReceiptAPI.return_value"><code class="docutils literal notranslate"><span class="pre">ReceiptAPI.return_value</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#ape.api.transactions.ReceiptAPI.show_debug_logs"><code class="docutils literal notranslate"><span class="pre">ReceiptAPI.show_debug_logs()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#ape.api.transactions.ReceiptAPI.total_fees_paid"><code class="docutils literal notranslate"><span class="pre">ReceiptAPI.total_fees_paid</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#ape.api.transactions.ReceiptAPI.trace"><code class="docutils literal notranslate"><span class="pre">ReceiptAPI.trace</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#ape.api.transactions.ReceiptAPI.track_coverage"><code class="docutils literal notranslate"><span class="pre">ReceiptAPI.track_coverage()</span></code></a></li>
Expand Down Expand Up @@ -2954,6 +2957,18 @@ <h2>Transactions<a class="headerlink" href="#transactions" title="Permalink to t
</dl>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="ape.api.transactions.ReceiptAPI.debug_logs_lines">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">debug_logs_lines</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">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#ape.api.transactions.ReceiptAPI.debug_logs_lines" title="Permalink to this definition"></a></dt>
<dd><p>Return any debug log data outputted by the transaction as strings suitable for printing</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="ape.api.transactions.ReceiptAPI.debug_logs_typed">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">debug_logs_typed</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">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#ape.api.transactions.ReceiptAPI.debug_logs_typed" title="Permalink to this definition"></a></dt>
<dd><p>Return any debug log data outputted by the transaction.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ape.api.transactions.ReceiptAPI.decode_logs">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">decode_logs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">abi</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">EventABI</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="contracts.html#ape.contracts.base.ContractEvent" title="ape.contracts.base.ContractEvent"><span class="pre">ContractEvent</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">EventABI</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="contracts.html#ape.contracts.base.ContractEvent" title="ape.contracts.base.ContractEvent"><span class="pre">ContractEvent</span></a><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> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">ContractLogContainer</span></span></span><a class="headerlink" href="#ape.api.transactions.ReceiptAPI.decode_logs" title="Permalink to this definition"></a></dt>
Expand Down Expand Up @@ -3017,6 +3032,12 @@ <h2>Transactions<a class="headerlink" href="#transactions" title="Permalink to t
since this is not available from the receipt object.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ape.api.transactions.ReceiptAPI.show_debug_logs">
<span class="sig-name descname"><span class="pre">show_debug_logs</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#ape.api.transactions.ReceiptAPI.show_debug_logs" title="Permalink to this definition"></a></dt>
<dd><p>Output debug logs to logging system</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="ape.api.transactions.ReceiptAPI.total_fees_paid">
<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">total_fees_paid</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#ape.api.transactions.ReceiptAPI.total_fees_paid" title="Permalink to this definition"></a></dt>
Expand Down
Binary file modified latest/objects.inv
Binary file not shown.
2 changes: 1 addition & 1 deletion latest/searchindex.js

Large diffs are not rendered by default.

0 comments on commit 7832827

Please sign in to comment.