Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
actions-user committed Dec 20, 2024
1 parent b8ca57d commit beca74f
Showing 24 changed files with 54 additions and 7 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
@@ -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>polynomial | ethereum | flow-evm | lumia | bttc | optimism | moonbeam | apechain | avalanche | zksync | shape | xai | arbitrum | cronos-zkevm | fraxtal | oort | geist | blast | linea | berachain | palm | crossfi | astar | polygon | lens | rootstock | gnosis | mantle | unichain | bsc | kroma | zora | celo | shibarium | wemix | taiko | cronos | world-chain | xmtp | scroll | metis | base | polygon-zkevm | soneium | fantom | abstract | zetachain</p>
<dd class="field-odd"><p>cronos | astar | xai | xmtp | taiko | polygon-zkevm | soneium | abstract | metis | zetachain | bttc | shape | geist | optimism | zora | base | oort | rootstock | wemix | unichain | apechain | arbitrum | fantom | lumia | blast | linea | scroll | bsc | mantle | polynomial | zksync | lens | palm | moonbeam | celo | avalanche | cronos-zkevm | ethereum | kroma | polygon | flow-evm | shibarium | crossfi | world-chain | berachain | gnosis | fraxtal</p>
</dd>
</dl>
</dd></dl>
@@ -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>puppynet-fork | mainnet-fork | moonbase | polter-fork | cardona-fork | polter | holesky | goerli-fork | mainnet | alfajores-fork | nova-fork | fuji-fork | mumbai-fork | amoy-fork | curtis | amoy | hekla-fork | chiado | opbnb | opbnb-testnet-fork | donau-fork | alfajores | fuji | bartio-fork | prism | opbnb-fork | prism-fork | local | dev-fork | donau | sepolia-fork | cardona | puppynet | hekla | moonriver | mumbai | curtis-fork | sepolia | chiado-fork | minato-fork | goerli | moonriver-fork | moonbase-fork | nova | opbnb-testnet | testnet-fork | testnet | bartio | dev | minato | holesky-fork</p>
<dd class="field-odd"><p>prism | testnet | minato | donau | chiado | mainnet-fork | local | polter-fork | donau-fork | puppynet-fork | opbnb | sepolia-fork | curtis | moonriver-fork | amoy | testnet-fork | cardona | goerli-fork | amoy-fork | mainnet | opbnb-testnet-fork | alfajores | bartio-fork | sepolia | opbnb-fork | dev-fork | moonbase-fork | dev | alfajores-fork | chiado-fork | hekla-fork | cardona-fork | curtis-fork | nova-fork | polter | hekla | fuji-fork | mumbai | goerli | nova | prism-fork | holesky-fork | fuji | mumbai-fork | minato-fork | holesky | opbnb-testnet | puppynet | moonbase | bartio | moonriver</p>
</dd>
</dl>
</dd></dl>
12 changes: 10 additions & 2 deletions latest/genindex.html
Original file line number Diff line number Diff line change
@@ -2591,6 +2591,14 @@ <h2 id="G">G</h2>
</li>
<li><a href="methoddocs/managers.html#ape.managers.project.DependencyManager.get_dependency">get_dependency() (ape.managers.project.DependencyManager method)</a>
</li>
<li><a href="methoddocs/api.html#ape.api.accounts.AccountAPI.get_deployment_address">get_deployment_address() (ape.api.accounts.AccountAPI method)</a>

<ul>
<li><a href="methoddocs/api.html#ape.api.networks.EcosystemAPI.get_deployment_address">(ape.api.networks.EcosystemAPI method)</a>
</li>
<li><a href="methoddocs/ape_ethereum.html#ape_ethereum.ecosystem.Ethereum.get_deployment_address">(ape_ethereum.ecosystem.Ethereum method)</a>
</li>
</ul></li>
<li><a href="methoddocs/managers.html#ape.managers.chain.ContractCache.get_deployments">get_deployments() (ape.managers.chain.ContractCache method)</a>
</li>
<li><a href="methoddocs/managers.html#ape.managers.networks.NetworkManager.get_ecosystem">get_ecosystem() (ape.managers.networks.NetworkManager method)</a>
@@ -2611,10 +2619,10 @@ <h2 id="G">G</h2>
<li><a href="methoddocs/managers.html#ape.managers.compilers.CompilerManager.get_imports">(ape.managers.compilers.CompilerManager method)</a>
</li>
</ul></li>
<li><a href="methoddocs/managers.html#ape.managers.project.PackagesCache.get_manifest_path">get_manifest_path() (ape.managers.project.PackagesCache method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="methoddocs/managers.html#ape.managers.project.PackagesCache.get_manifest_path">get_manifest_path() (ape.managers.project.PackagesCache method)</a>
</li>
<li><a href="methoddocs/cli.html#ape.cli.choices.NetworkChoice.get_metavar">get_metavar() (ape.cli.choices.NetworkChoice method)</a>
</li>
<li><a href="methoddocs/api.html#ape.api.networks.EcosystemAPI.get_method_selector">get_method_selector() (ape.api.networks.EcosystemAPI method)</a>
9 changes: 9 additions & 0 deletions latest/methoddocs/ape_ethereum.html
Original file line number Diff line number Diff line change
@@ -153,6 +153,7 @@
<li><a class="reference internal" href="#ape_ethereum.ecosystem.Ethereum.encode_transaction"><code class="docutils literal notranslate">.encode_transaction()</span></code></a></li>
<li><a class="reference internal" href="#ape_ethereum.ecosystem.Ethereum.enrich_trace"><code class="docutils literal notranslate">.enrich_trace()</span></code></a></li>
<li><a class="reference internal" href="#ape_ethereum.ecosystem.Ethereum.fee_token_symbol"><code class="docutils literal notranslate">.fee_token_symbol</span></code></a></li>
<li><a class="reference internal" href="#ape_ethereum.ecosystem.Ethereum.get_deployment_address"><code class="docutils literal notranslate">.get_deployment_address()</span></code></a></li>
<li><a class="reference internal" href="#ape_ethereum.ecosystem.Ethereum.get_proxy_info"><code class="docutils literal notranslate">.get_proxy_info()</span></code></a></li>
<li><a class="reference internal" href="#ape_ethereum.ecosystem.Ethereum.get_python_types"><code class="docutils literal notranslate">.get_python_types()</span></code></a></li>
</ul>
@@ -691,6 +692,14 @@
<dd><p>The token symbol for the currency that pays for fees, such as ETH.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ape_ethereum.ecosystem.Ethereum.get_deployment_address">
<span class="sig-name descname"><span class="pre">get_deployment_address</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">address</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">nonce</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</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">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></span><a class="headerlink" href="#ape_ethereum.ecosystem.Ethereum.get_deployment_address" title="Link to this definition"></a></dt>
<dd><p>Calculate the deployment address of a contract before it is deployed.
This is useful if the address is an argument to another contract’s deployment
and you have not yet deployed the first contract yet.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ape_ethereum.ecosystem.Ethereum.get_proxy_info">
<span class="sig-name descname"><span class="pre">get_proxy_info</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">address</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><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="#ape_ethereum.proxies.ProxyInfo" title="ape_ethereum.proxies.ProxyInfo"><span class="pre">ProxyInfo</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><a class="headerlink" href="#ape_ethereum.ecosystem.Ethereum.get_proxy_info" title="Link to this definition"></a></dt>
Loading

0 comments on commit beca74f

Please sign in to comment.