Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Dec 12, 2024
1 parent d17165e commit be67c79
Show file tree
Hide file tree
Showing 25 changed files with 48 additions and 14 deletions.
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.
4 changes: 2 additions & 2 deletions latest/commands/networks.html
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ <h2>list<a class="headerlink" href="#networks-list" title="Link to this heading"
<dd><p>Filter the results by ecosystem</p>
<dl class="field-list simple">
<dt class="field-odd">Options<span class="colon">:</span></dt>
<dd class="field-odd"><p>base | gnosis | fraxtal | arbitrum | xai | palm | lumia | wemix | zetachain | abstract | flow-evm | metis | shibarium | xmtp | bttc | celo | moonbeam | oort | polygon | shape | mantle | lens | geist | cronos-zkevm | rootstock | cronos | ethereum | linea | scroll | unichain | zora | avalanche | world-chain | taiko | apechain | berachain | crossfi | blast | soneium | astar | bsc | zksync | polynomial | fantom | polygon-zkevm | optimism | kroma</p>
<dd class="field-odd"><p>celo | apechain | bttc | kroma | shibarium | gnosis | world-chain | zetachain | polygon | cronos | geist | palm | unichain | arbitrum | fraxtal | rootstock | ethereum | lumia | fantom | crossfi | blast | cronos-zkevm | flow-evm | xai | polygon-zkevm | optimism | scroll | bsc | xmtp | polynomial | moonbeam | taiko | zksync | abstract | base | astar | metis | wemix | berachain | avalanche | soneium | mantle | lens | shape | zora | oort | linea</p>
</dd>
</dl>
</dd></dl>
Expand All @@ -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>moonbase | bartio | holesky-fork | curtis-fork | nova | goerli | nova-fork | minato | mumbai | chiado-fork | minato-fork | chiado | moonriver | hekla-fork | mainnet | sepolia-fork | cardona-fork | hekla | opbnb | polter | opbnb-testnet | donau-fork | prism-fork | mumbai-fork | puppynet | amoy | prism | moonriver-fork | donau | amoy-fork | mainnet-fork | polter-fork | dev | bartio-fork | puppynet-fork | opbnb-fork | opbnb-testnet-fork | moonbase-fork | curtis | testnet | goerli-fork | alfajores | local | testnet-fork | sepolia | cardona | alfajores-fork | dev-fork | fuji | holesky | fuji-fork</p>
<dd class="field-odd"><p>opbnb-testnet-fork | mainnet-fork | fuji | chiado-fork | alfajores-fork | amoy | donau-fork | holesky-fork | hekla-fork | sepolia | polter-fork | moonriver-fork | fuji-fork | donau | dev-fork | sepolia-fork | moonriver | cardona-fork | curtis-fork | opbnb-fork | puppynet-fork | testnet | nova-fork | chiado | testnet-fork | nova | local | cardona | dev | prism-fork | opbnb-testnet | mumbai-fork | moonbase-fork | holesky | curtis | hekla | alfajores | minato-fork | goerli | minato | goerli-fork | puppynet | bartio-fork | prism | opbnb | amoy-fork | bartio | mumbai | moonbase | polter | 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 @@ -691,6 +691,8 @@ <h2 id="_">_</h2>
<li><a href="methoddocs/api.html#ape.api.networks.EcosystemAPI.__repr__">(ape.api.networks.EcosystemAPI method)</a>
</li>
<li><a href="methoddocs/api.html#ape.api.networks.NetworkAPI.__repr__">(ape.api.networks.NetworkAPI method)</a>
</li>
<li><a href="methoddocs/api.html#ape.api.networks.ProxyInfoAPI.__repr__">(ape.api.networks.ProxyInfoAPI method)</a>
</li>
<li><a href="methoddocs/contracts.html#ape.contracts.base.ContractContainer.__repr__">(ape.contracts.base.ContractContainer method)</a>
</li>
Expand Down Expand Up @@ -787,7 +789,11 @@ <h2 id="_">_</h2>
<h2 id="A">A</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="methoddocs/api.html#ape.api.networks.ProxyInfoAPI.abi">abi (ape.api.networks.ProxyInfoAPI property)</a>
</li>
<li><a href="methoddocs/ape_compile.html#ape_compile.config.OutputExtras.ABI">ABI (ape_compile.config.OutputExtras attribute)</a>
</li>
<li><a href="methoddocs/ape_ethereum.html#ape_ethereum.proxies.ProxyInfo.abi">abi (ape_ethereum.proxies.ProxyInfo property)</a>
</li>
<li><a href="methoddocs/exceptions.html#ape.exceptions.Abort">Abort</a>
</li>
Expand Down Expand Up @@ -1120,15 +1126,15 @@ <h2 id="A">A</h2>
<li><a href="methoddocs/exceptions.html#module-ape.exceptions">module</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li>
ape.managers.accounts

<ul>
<li><a href="methoddocs/managers.html#module-ape.managers.accounts">module</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li>
ape.managers.compilers

Expand Down
16 changes: 13 additions & 3 deletions latest/methoddocs/ape_ethereum.html
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,10 @@
</ul>
</li>
<li><a class="reference internal" href="#ape_ethereum.provider.assert_web3_provider_uri_env_var_not_set"><code class="docutils literal notranslate"><span class="pre">assert_web3_provider_uri_env_var_not_set()</span></code></a></li>
<li><a class="reference internal" href="#ape_ethereum.proxies.ProxyInfo"><code class="docutils literal notranslate"><span class="pre">ProxyInfo</span></code></a></li>
<li><a class="reference internal" href="#ape_ethereum.proxies.ProxyInfo"><code class="docutils literal notranslate"><span class="pre">ProxyInfo</span></code></a><ul>
<li><a class="reference internal" href="#ape_ethereum.proxies.ProxyInfo.abi"><code class="docutils literal notranslate">.abi</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#ape_ethereum.proxies.ProxyType"><code class="docutils literal notranslate"><span class="pre">ProxyType</span></code></a></li>
<li><a class="reference internal" href="#ape_ethereum.trace.CallTrace"><code class="docutils literal notranslate"><span class="pre">CallTrace</span></code></a><ul>
<li><a class="reference internal" href="#ape_ethereum.trace.CallTrace.arguments"><code class="docutils literal notranslate">.arguments</span></code></a></li>
Expand Down Expand Up @@ -1416,8 +1419,15 @@

<dl class="py class" id="module-ape_ethereum.proxies">
<dt class="sig sig-object py" id="ape_ethereum.proxies.ProxyInfo">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ape_ethereum.proxies.</span></span><span class="sig-name descname"><span class="pre">ProxyInfo</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">target</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Annotated</span><span class="p"><span class="pre">[</span></span><span class="pre">ChecksumAddress</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">_AddressValidator</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#ape_ethereum.proxies.ProxyType" title="ape_ethereum.proxies.ProxyType"><span class="pre">ProxyType</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ape_ethereum.proxies.ProxyInfo" title="Link to this definition"></a></dt>
<dd></dd></dl>
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ape_ethereum.proxies.</span></span><span class="sig-name descname"><span class="pre">ProxyInfo</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">target</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Annotated</span><span class="p"><span class="pre">[</span></span><span class="pre">ChecksumAddress</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">_AddressValidator</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</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">type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#ape_ethereum.proxies.ProxyType" title="ape_ethereum.proxies.ProxyType"><span class="pre">ProxyType</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ape_ethereum.proxies.ProxyInfo" title="Link to this definition"></a></dt>
<dd><dl class="py property">
<dt class="sig sig-object py" id="ape_ethereum.proxies.ProxyInfo.abi">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">abi</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">MethodABI</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_ethereum.proxies.ProxyInfo.abi" title="Link to this definition"></a></dt>
<dd><p>Some proxies have special ABIs which may not exist in their
contract-types by default, such as Safe’s <code class="docutils literal notranslate"><span class="pre">masterCopy()</span></code>.</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="ape_ethereum.proxies.ProxyType">
Expand Down
Loading

0 comments on commit be67c79

Please sign in to comment.