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 5, 2024
1 parent 40b341d commit ec5cb75
Show file tree
Hide file tree
Showing 26 changed files with 43 additions and 26 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: cfd04bff56aabddcbbbfc529955c293c
config: cdb26a03e7733749055fac13095ffbde
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>mainnet-fork | local | holesky | mainnet | sepolia-fork | holesky-fork | sepolia</p>
<dd class="field-odd"><p>mainnet | sepolia-fork | mainnet-fork | holesky-fork | holesky | sepolia | local</p>
</dd>
</dl>
</dd></dl>
Expand Down
18 changes: 11 additions & 7 deletions latest/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -1307,15 +1307,13 @@ <h2 id="B">B</h2>
<li><a href="methoddocs/ape_ethereum.html#ape_ethereum.SharedBlobReceipt.blob_gas_price">blob_gas_price (ape_ethereum.SharedBlobReceipt attribute)</a>
</li>
<li><a href="methoddocs/ape_ethereum.html#ape_ethereum.SharedBlobReceipt.blob_gas_used">blob_gas_used (ape_ethereum.SharedBlobReceipt attribute)</a>
</li>
<li><a href="methoddocs/ape_ethereum.html#ape_ethereum.SharedBlobTransaction.blob_versioned_hashes">blob_versioned_hashes (ape_ethereum.SharedBlobTransaction attribute)</a>
</li>
<li><a href="methoddocs/api.html#ape.api.query.ContractCreation.block">block (ape.api.query.ContractCreation attribute)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="methoddocs/ape_ethereum.html#ape_ethereum.Block">Block (class in ape_ethereum)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="methoddocs/types.html#ape.types.ContractLog.block_hash">block_hash (ape.types.ContractLog attribute)</a>
</li>
<li><a href="methoddocs/types.html#ape.types.ContractLog.block_number">block_number (ape.types.ContractLog attribute)</a>
Expand Down Expand Up @@ -3436,6 +3434,8 @@ <h2 id="R">R</h2>
<li><a href="methoddocs/ape_ethereum.html#ape_ethereum.Receipt">Receipt (class in ape_ethereum)</a>
</li>
<li><a href="methoddocs/api.html#ape.api.transactions.ReceiptAPI">ReceiptAPI (class in ape.api.transactions)</a>
</li>
<li><a href="methoddocs/ape_ethereum.html#ape_ethereum.SharedBlobTransaction.receiver">receiver (ape_ethereum.SharedBlobTransaction attribute)</a>
</li>
<li><a href="methoddocs/managers.html#ape.managers.project.Project.reconfigure">reconfigure() (ape.managers.project.Project method)</a>
</li>
Expand All @@ -3460,11 +3460,11 @@ <h2 id="R">R</h2>
<li><a href="methoddocs/managers.html#ape.managers.project.LocalProject.reload_config">reload_config() (ape.managers.project.LocalProject method)</a>
</li>
<li><a href="methoddocs/api.html#ape.api.providers.ProviderAPI.relock_account">relock_account() (ape.api.providers.ProviderAPI method)</a>
</li>
<li><a href="methoddocs/api.html#ape.api.accounts.AccountContainerAPI.remove">remove() (ape.api.accounts.AccountContainerAPI method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="methoddocs/api.html#ape.api.accounts.AccountContainerAPI.remove">remove() (ape.api.accounts.AccountContainerAPI method)</a>
</li>
<li><a href="methoddocs/ape_test.html#ape_test.CoverageConfig.reports">reports (ape_test.CoverageConfig attribute)</a>

<ul>
Expand Down Expand Up @@ -3833,13 +3833,17 @@ <h2 id="T">T</h2>
</li>
<li><a href="methoddocs/api.html#ape.api.providers.TestProviderAPI">TestProviderAPI (class in ape.api.providers)</a>
</li>
<li><a href="methoddocs/types.html#ape.types.ContractLog.timestamp">timestamp (ape.types.ContractLog property)</a>
<li><a href="methoddocs/api.html#ape.api.providers.BlockAPI.timestamp">timestamp (ape.api.providers.BlockAPI attribute)</a>

<ul>
<li><a href="methoddocs/types.html#ape.types.ContractLog.timestamp">(ape.types.ContractLog property)</a>
</li>
<li><a href="methoddocs/types.html#ape.types.coverage.CoverageReport.timestamp">(ape.types.coverage.CoverageReport attribute)</a>
</li>
</ul></li>
<li><a href="methoddocs/managers.html#ape.managers.converters.TimestampConverter">TimestampConverter (class in ape.managers.converters)</a>
</li>
<li><a href="methoddocs/utils.html#ape.utils.to_int">to_int() (in module ape.utils)</a>
</li>
<li><a href="methoddocs/api.html#ape.api.transactions.ReceiptAPI.total_fees_paid">total_fees_paid (ape.api.transactions.ReceiptAPI property)</a>

Expand Down
15 changes: 7 additions & 8 deletions latest/methoddocs/ape_ethereum.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions latest/methoddocs/ape_node.html

Large diffs are not rendered by default.

19 changes: 13 additions & 6 deletions latest/methoddocs/api.html
Original file line number Diff line number Diff line change
Expand Up @@ -438,6 +438,7 @@
<li class="toctree-l4"><a class="reference internal" href="#ape.api.providers.BlockAPI.number"><code class="docutils literal notranslate"><span class="pre">BlockAPI.number</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#ape.api.providers.BlockAPI.parent_hash"><code class="docutils literal notranslate"><span class="pre">BlockAPI.parent_hash</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#ape.api.providers.BlockAPI.size"><code class="docutils literal notranslate"><span class="pre">BlockAPI.size</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#ape.api.providers.BlockAPI.timestamp"><code class="docutils literal notranslate"><span class="pre">BlockAPI.timestamp</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#ape.api.providers.BlockAPI.transactions"><code class="docutils literal notranslate"><span class="pre">BlockAPI.transactions</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#ape.api.providers.BlockAPI.validate_size"><code class="docutils literal notranslate"><span class="pre">BlockAPI.validate_size()</span></code></a></li>
</ul>
Expand Down Expand Up @@ -2784,26 +2785,25 @@ <h1>ape.api<a class="headerlink" href="#ape-api" title="Permalink to this headin
<dl class="py attribute">
<dt class="sig sig-object py" id="ape.api.providers.BlockAPI.hash">
<span class="sig-name descname"><span class="pre">hash</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Any</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#ape.api.providers.BlockAPI.hash" title="Permalink to this definition"></a></dt>
<dd><p>The block number identifier.</p>
<dd><p>The block hash identifier.</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ape.api.providers.BlockAPI.num_transactions">
<span class="sig-name descname"><span class="pre">num_transactions</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.providers.BlockAPI.num_transactions" title="Permalink to this definition"></a></dt>
<dd><p>The block hash identifier.</p>
<dd><p>The number of transactions in the block.</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ape.api.providers.BlockAPI.number">
<span class="sig-name descname"><span class="pre">number</span></span><em class="property"><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">None</span></em><a class="headerlink" href="#ape.api.providers.BlockAPI.number" title="Permalink to this definition"></a></dt>
<dd><p>The preceeding block’s hash.</p>
<dd><p>The block number identifier.</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ape.api.providers.BlockAPI.parent_hash">
<span class="sig-name descname"><span class="pre">parent_hash</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Any</span></em><a class="headerlink" href="#ape.api.providers.BlockAPI.parent_hash" title="Permalink to this definition"></a></dt>
<dd><p>The timestamp the block was produced.
NOTE: The pending block uses the current timestamp.</p>
<dd><p>The preceeding block’s hash.</p>
</dd></dl>

<dl class="py property">
Expand All @@ -2816,6 +2816,13 @@ <h1>ape.api<a class="headerlink" href="#ape-api" title="Permalink to this headin
requests it (or during serialization of this model to disk).</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ape.api.providers.BlockAPI.timestamp">
<span class="sig-name descname"><span class="pre">timestamp</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.providers.BlockAPI.timestamp" title="Permalink to this definition"></a></dt>
<dd><p>The timestamp the block was produced.
NOTE: The pending block uses the current timestamp.</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="ape.api.providers.BlockAPI.transactions">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">transactions</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><a class="reference internal" href="#ape.api.transactions.TransactionAPI" title="ape.api.transactions.TransactionAPI"><span class="pre">ape.api.transactions.TransactionAPI</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#ape.api.providers.BlockAPI.transactions" title="Permalink to this definition"></a></dt>
Expand Down Expand Up @@ -3706,7 +3713,7 @@ <h1>ape.api<a class="headerlink" href="#ape-api" title="Permalink to this headin
<h2>Transactions<a class="headerlink" href="#transactions" title="Permalink to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="ape.api.transactions.ReceiptAPI">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ape.api.transactions.</span></span><span class="sig-name descname"><span class="pre">ReceiptAPI</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">contract_address</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ChecksumAddress</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>, <em class="sig-param"><span class="n"><span class="pre">block_number</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gas_used</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">logs</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">dict</span><span class="p"><span class="pre">]</span></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">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">txn_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="n"><span class="pre">transaction</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#ape.api.transactions.TransactionAPI" title="ape.api.transactions.TransactionAPI"><span class="pre">TransactionAPI</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ape.api.transactions.ReceiptAPI" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ape.api.transactions.</span></span><span class="sig-name descname"><span class="pre">ReceiptAPI</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">contract_address</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ChecksumAddress</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>, <em class="sig-param"><span class="n"><span class="pre">block_number</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gas_used</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">logs</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">dict</span><span class="p"><span class="pre">]</span></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">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">txn_hash</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">HexStr</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">transaction</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#ape.api.transactions.TransactionAPI" title="ape.api.transactions.TransactionAPI"><span class="pre">TransactionAPI</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ape.api.transactions.ReceiptAPI" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="utils.html#ape.utils.ExtraAttributesMixin" title="ape.utils.basemodel.ExtraAttributesMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">ExtraAttributesMixin</span></code></a>, <a class="reference internal" href="utils.html#ape.utils.BaseInterfaceModel" title="ape.utils.basemodel.BaseInterfaceModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseInterfaceModel</span></code></a></p>
<p>An abstract class to represent a transaction receipt. The receipt
contains information about the transaction, such as the status
Expand Down
7 changes: 7 additions & 0 deletions latest/methoddocs/utils.html
Original file line number Diff line number Diff line change
Expand Up @@ -292,6 +292,7 @@
</li>
<li class="toctree-l2"><a class="reference internal" href="#ape.utils.spawn"><code class="docutils literal notranslate"><span class="pre">spawn()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="#ape.utils.stream_response"><code class="docutils literal notranslate"><span class="pre">stream_response()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="#ape.utils.to_int"><code class="docutils literal notranslate"><span class="pre">to_int()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="#ape.utils.use_temp_sys_path"><code class="docutils literal notranslate"><span class="pre">use_temp_sys_path</span></code></a></li>
</ul>
</li>
Expand Down Expand Up @@ -1166,6 +1167,12 @@
</dl>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="ape.utils.to_int">
<span class="sig-prename descclassname"><span class="pre">ape.utils.</span></span><span class="sig-name descname"><span class="pre">to_int</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</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">int</span></span></span><a class="headerlink" href="#ape.utils.to_int" title="Permalink to this definition"></a></dt>
<dd><p>Convert the given value, such as hex-strs or hex-bytes, to an integer.</p>
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="ape.utils.use_temp_sys_path">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ape.utils.</span></span><span class="sig-name descname"><span class="pre">use_temp_sys_path</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</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">exclude</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">pathlib.Path</span><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">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.utils.use_temp_sys_path" 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 ec5cb75

Please sign in to comment.