Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Nov 26, 2024
1 parent 24976ee commit 7c5fcaa
Show file tree
Hide file tree
Showing 20 changed files with 10 additions and 10 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_ethereum.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.
Binary file modified latest/.doctrees/userguides/config.doctree
Binary file not shown.
Binary file modified latest/.doctrees/userguides/proxy.doctree
Binary file not shown.
2 changes: 1 addition & 1 deletion latest/_sources/userguides/config.md.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ There are two locations you can place config files.
1. In the root of your project
2. In your `$HOME/.ape` directory (global)

Project settings take precedent, but global settings allow you to configure preferences across all projects, such as your default mainnet provider (e.g. Alchemy versus running your own node).
Project settings take precedence, but global settings allow you to configure preferences across all projects, such as your default mainnet provider (e.g. Alchemy versus running your own node).

This guide serves as an index of some settings you can include in any `ape-config.yaml` file.
This guide is **PURPOSELY** alphabetized to facilitate easier look-up of keys.
Expand Down
4 changes: 2 additions & 2 deletions latest/_sources/userguides/proxy.md.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Proxy Contracts

Ape is able to detect proxy contracts so that it uses the target interface when interacting with a contract.
The following proxies are supporting in `ape-ethereum`:
The following proxies are supported in `ape-ethereum`:

| Proxy Type | Short Description |
| ------------ | --------------------------------- |
Expand All @@ -27,7 +27,7 @@ from ape import Contract
my_contract = Contract("0x...")
```

Ape will check the address you give it and detect if hosts a proxy contract.
Ape will check the address you give it and detect if it hosts a proxy contract.
In the case where it determines the address is a proxy contract, it resolves the address of the implementation (every proxy is different) and returns the interface for the implementation contract.
This allows you to still call methods as you normally do on proxy contracts.

Expand Down
6 changes: 3 additions & 3 deletions latest/commands/networks.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion latest/searchindex.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion latest/userguides/config.html
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ <h1>Configure Ape<a class="headerlink" href="#configure-ape" title="Link to this
<li><p>In the root of your project</p></li>
<li><p>In your <code class="docutils literal notranslate"><span class="pre">$HOME/.ape</span></code> directory (global)</p></li>
</ol>
<p>Project settings take precedent, but global settings allow you to configure preferences across all projects, such as your default mainnet provider (e.g. Alchemy versus running your own node).</p>
<p>Project settings take precedence, but global settings allow you to configure preferences across all projects, such as your default mainnet provider (e.g. Alchemy versus running your own node).</p>
<p>This guide serves as an index of some settings you can include in any <code class="docutils literal notranslate"><span class="pre">ape-config.yaml</span></code> file.
This guide is <strong>PURPOSELY</strong> alphabetized to facilitate easier look-up of keys.
Plugins for Ape may define their own configs.</p>
Expand Down
4 changes: 2 additions & 2 deletions latest/userguides/proxy.html
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@
<section id="proxy-contracts">
<h1>Proxy Contracts<a class="headerlink" href="#proxy-contracts" title="Link to this heading"></a></h1>
<p>Ape is able to detect proxy contracts so that it uses the target interface when interacting with a contract.
The following proxies are supporting in <code class="docutils literal notranslate"><span class="pre">ape-ethereum</span></code>:</p>
The following proxies are supported in <code class="docutils literal notranslate"><span class="pre">ape-ethereum</span></code>:</p>
<div class="table-wrapper colwidths-auto docutils container">
<table class="docutils align-default">
<thead>
Expand Down Expand Up @@ -210,7 +210,7 @@ <h1>Proxy Contracts<a class="headerlink" href="#proxy-contracts" title="Link to
</span><span data-line="3"><span class="n">my_contract</span> <span class="o">=</span> <span class="n">Contract</span><span class="p">(</span><span class="s2">&quot;0x...&quot;</span><span class="p">)</span>
</span></pre></div>
</div>
<p>Ape will check the address you give it and detect if hosts a proxy contract.
<p>Ape will check the address you give it and detect if it hosts a proxy contract.
In the case where it determines the address is a proxy contract, it resolves the address of the implementation (every proxy is different) and returns the interface for the implementation contract.
This allows you to still call methods as you normally do on proxy contracts.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span data-line="1"><span class="c1"># `my_contract` address points to a proxy with no methods in the interface</span>
Expand Down

0 comments on commit 7c5fcaa

Please sign in to comment.