Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Aug 7, 2024
1 parent ced7e41 commit 99cd2e6
Show file tree
Hide file tree
Showing 24 changed files with 26 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: 11bb88f635bb745f6a5ea3a37c1e72a5
config: 319534591741597fa829e3a2b9a0e64f
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/ape_compile.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/ape_ethereum.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/ape_node.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/ape_pm.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/ape_test.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 @@ -293,7 +293,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-fork | mainnet-fork | holesky-fork | sepolia | local | mainnet | holesky</p>
<dd class="field-odd"><p>sepolia-fork | mainnet | holesky-fork | sepolia | mainnet-fork | local | holesky</p>
</dd>
</dl>
</dd></dl>
Expand Down
2 changes: 2 additions & 0 deletions latest/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -2333,6 +2333,8 @@ <h2 id="G">G</h2>

<ul>
<li><a href="methoddocs/ape_ethereum.html#ape_ethereum.Web3Provider.get_transaction_trace">(ape_ethereum.Web3Provider method)</a>
</li>
<li><a href="methoddocs/ape_test.html#ape_test.LocalProvider.get_transaction_trace">(ape_test.LocalProvider method)</a>
</li>
</ul></li>
<li><a href="methoddocs/api.html#ape.api.explorers.ExplorerAPI.get_transaction_url">get_transaction_url() (ape.api.explorers.ExplorerAPI method)</a>
Expand Down
4 changes: 2 additions & 2 deletions latest/methoddocs/ape_node.html

Large diffs are not rendered by default.

19 changes: 19 additions & 0 deletions latest/methoddocs/ape_test.html
Original file line number Diff line number Diff line change
Expand Up @@ -258,6 +258,7 @@
<li class="toctree-l3"><a class="reference internal" href="#ape_test.LocalProvider.get_contract_logs"><code class="docutils literal notranslate"><span class="pre">LocalProvider.get_contract_logs()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#ape_test.LocalProvider.get_nonce"><code class="docutils literal notranslate"><span class="pre">LocalProvider.get_nonce()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#ape_test.LocalProvider.get_test_account"><code class="docutils literal notranslate"><span class="pre">LocalProvider.get_test_account()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#ape_test.LocalProvider.get_transaction_trace"><code class="docutils literal notranslate"><span class="pre">LocalProvider.get_transaction_trace()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#ape_test.LocalProvider.get_virtual_machine_error"><code class="docutils literal notranslate"><span class="pre">LocalProvider.get_virtual_machine_error()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#ape_test.LocalProvider.max_gas"><code class="docutils literal notranslate"><span class="pre">LocalProvider.max_gas</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#ape_test.LocalProvider.mine"><code class="docutils literal notranslate"><span class="pre">LocalProvider.mine()</span></code></a></li>
Expand Down Expand Up @@ -592,6 +593,24 @@
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ape_test.LocalProvider.get_transaction_trace">
<span class="sig-name descname"><span class="pre">get_transaction_trace</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">transaction_hash</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="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</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">TraceAPI</span></span></span><a class="headerlink" href="#ape_test.LocalProvider.get_transaction_trace" title="Permalink to this definition"></a></dt>
<dd><p>Provide a detailed description of opcodes.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>transaction_hash</strong> (<em>Union</em><em>[</em><em>HexBytes</em><em>, </em><em>str</em><em>]</em>) – The hash of a transaction
to trace.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>A transaction trace.</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">TraceAPI</span></code></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ape_test.LocalProvider.get_virtual_machine_error">
<span class="sig-name descname"><span class="pre">get_virtual_machine_error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">exception</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Exception</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</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="exceptions.html#ape.exceptions.VirtualMachineError" title="ape.exceptions.VirtualMachineError"><span class="pre">VirtualMachineError</span></a></span></span><a class="headerlink" href="#ape_test.LocalProvider.get_virtual_machine_error" 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 99cd2e6

Please sign in to comment.