Update documentation

ApeWorX · Nov 7, 2024 · 7f37cbe · 7f37cbe
1 parent 9f50e21
commit 7f37cbe
Show file tree

Hide file tree

Showing 221 changed files with 40,964 additions and 2,799 deletions.
diff --git a/index.html b/index.html
@@ -2,4 +2,4 @@
 <!DOCTYPE html>
 <meta charset="utf-8">
 <title>Redirecting...</title>
-<meta http-equiv="refresh" content="0; URL=./latest/userguides/quickstart.html">
+<meta http-equiv="refresh" content="0; URL=./stable/userguides/quickstart.html">
diff --git a/latest/.doctrees/commands/networks.doctree b/latest/.doctrees/commands/networks.doctree
diff --git a/latest/.doctrees/environment.pickle b/latest/.doctrees/environment.pickle
diff --git a/latest/.doctrees/methoddocs/ape.doctree b/latest/.doctrees/methoddocs/ape.doctree
diff --git a/latest/.doctrees/methoddocs/ape_ethereum.doctree b/latest/.doctrees/methoddocs/ape_ethereum.doctree
diff --git a/latest/.doctrees/methoddocs/ape_node.doctree b/latest/.doctrees/methoddocs/ape_node.doctree
diff --git a/latest/.doctrees/methoddocs/api.doctree b/latest/.doctrees/methoddocs/api.doctree
diff --git a/latest/.doctrees/methoddocs/cli.doctree b/latest/.doctrees/methoddocs/cli.doctree
diff --git a/latest/.doctrees/methoddocs/contracts.doctree b/latest/.doctrees/methoddocs/contracts.doctree
diff --git a/latest/.doctrees/methoddocs/exceptions.doctree b/latest/.doctrees/methoddocs/exceptions.doctree
diff --git a/latest/.doctrees/methoddocs/managers.doctree b/latest/.doctrees/methoddocs/managers.doctree
diff --git a/latest/.doctrees/methoddocs/plugins.doctree b/latest/.doctrees/methoddocs/plugins.doctree
diff --git a/latest/.doctrees/methoddocs/types.doctree b/latest/.doctrees/methoddocs/types.doctree
diff --git a/latest/.doctrees/methoddocs/utils.doctree b/latest/.doctrees/methoddocs/utils.doctree
diff --git a/latest/commands/networks.html b/latest/commands/networks.html
@@ -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>sepolia | mainnet-fork | goerli | holesky | sepolia-fork | local | mainnet | holesky-fork</p>
+<dd class="field-odd"><p>holesky | mainnet | local | goerli | holesky-fork | mainnet-fork | sepolia-fork | sepolia</p>
 </dd>
 </dl>
 </dd></dl>

diff --git a/latest/methoddocs/ape_node.html b/latest/methoddocs/ape_node.html
diff --git a/latest/searchindex.js b/latest/searchindex.js
diff --git a/stable/.doctrees/commands/console.doctree b/stable/.doctrees/commands/console.doctree
diff --git a/stable/.doctrees/commands/init.doctree b/stable/.doctrees/commands/init.doctree
diff --git a/stable/.doctrees/commands/networks.doctree b/stable/.doctrees/commands/networks.doctree
diff --git a/stable/.doctrees/environment.pickle b/stable/.doctrees/environment.pickle
diff --git a/stable/.doctrees/methoddocs/ape.doctree b/stable/.doctrees/methoddocs/ape.doctree
diff --git a/stable/.doctrees/methoddocs/ape_ethereum.doctree b/stable/.doctrees/methoddocs/ape_ethereum.doctree
diff --git a/stable/.doctrees/methoddocs/ape_node.doctree b/stable/.doctrees/methoddocs/ape_node.doctree
diff --git a/stable/.doctrees/methoddocs/api.doctree b/stable/.doctrees/methoddocs/api.doctree
diff --git a/stable/.doctrees/methoddocs/cli.doctree b/stable/.doctrees/methoddocs/cli.doctree
diff --git a/stable/.doctrees/methoddocs/contracts.doctree b/stable/.doctrees/methoddocs/contracts.doctree
diff --git a/stable/.doctrees/methoddocs/exceptions.doctree b/stable/.doctrees/methoddocs/exceptions.doctree
diff --git a/stable/.doctrees/methoddocs/managers.doctree b/stable/.doctrees/methoddocs/managers.doctree
diff --git a/stable/.doctrees/methoddocs/plugins.doctree b/stable/.doctrees/methoddocs/plugins.doctree
diff --git a/stable/.doctrees/methoddocs/types.doctree b/stable/.doctrees/methoddocs/types.doctree
diff --git a/stable/.doctrees/methoddocs/utils.doctree b/stable/.doctrees/methoddocs/utils.doctree
diff --git a/stable/.doctrees/userguides/console.doctree b/stable/.doctrees/userguides/console.doctree
diff --git a/stable/.doctrees/userguides/networks.doctree b/stable/.doctrees/userguides/networks.doctree
diff --git a/stable/_sources/methoddocs/utils.md.txt b/stable/_sources/methoddocs/utils.md.txt
@@ -1,8 +1,65 @@
 # ape.utils
 
+## ABI
+
+```{eval-rst}
+.. automodule:: ape.utils.abi
+    :members:
+    :show-inheritance:
+```
+
+## Basemodel
+
+```{eval-rst}
+.. automodule:: ape.utils.basemodel
+    :members:
+    :show-inheritance:
+```
+
+## Miscellaneous
+
+```{eval-rst}
+.. automodule:: ape.utils.misc
+    :members:
+    :show-inheritance:
+```
+
+## OS
+
+```{eval-rst}
+.. automodule:: ape.utils.os
+    :members:
+    :show-inheritance:
+```
+
+## Process
+
+```{eval-rst}
+.. automodule:: ape.utils.process
+    :members:
+    :show-inheritance:
+```
+
+## RPC
+
+```{eval-rst}
+.. automodule:: ape.utils.rpc
+    :members:
+    :show-inheritance:
+```
+
+## Testing
+
+```{eval-rst}
+.. automodule:: ape.utils.testing
+    :members:
+    :show-inheritance:
+```
+
+## Trace
+
 ```{eval-rst}
-.. automodule:: ape.utils
+.. automodule:: ape.utils.trace
     :members:
     :show-inheritance:
-    :exclude-members: abstractmethod, dataclass, __init__
 ```
diff --git a/stable/_sources/userguides/console.md.txt b/stable/_sources/userguides/console.md.txt
@@ -164,3 +164,18 @@ Out[3]: '0.00040634 ETH'
 In [4]: %bal 0xE3747e6341E0d3430e6Ea9e2346cdDCc2F8a4b5b
 Out[4]: '0.00040634 ETH'
 ```
+
+## Executing Code
+
+You can also use the `ape console` to execute programs directly from strings.
+This is similar to the `python -c|--code` option except it will display the output cell.
+Anything available in `ape console` is also available in `ape console --code`.
+
+```shell
+ape console -c 'project.name'
+Out[1]: 'my-project'
+ape console -c 'x = 3\nx + 1'
+Out[1]: 4
+ape console -c 'networks.active_provider.name'
+Out[1]: 'test'
+```
diff --git a/stable/_sources/userguides/networks.md.txt b/stable/_sources/userguides/networks.md.txt
@@ -1,8 +1,9 @@
 # Networks
 
 When interacting with a blockchain, you will have to select an ecosystem (e.g. Ethereum, Arbitrum, or Fantom), a network (e.g. Mainnet or Sepolia) and a provider (e.g. Eth-Tester, Node (Geth), or Alchemy).
-Networks are part of ecosystems and typically defined in plugins.
-For example, the `ape-ethereum` plugin comes with Ape and can be used for handling EVM-like behavior.
+The `ape-ethereum` ecosystem and network(s) plugin comes with Ape and can be used for handling EVM-like behavior.
+Networks are part of ecosystems and typically defined in plugins or custom-network configurations.
+However, Ape works out-of-the-box (in a limited way) with any network defined in the [evmchains](https://github.com/ApeWorX/evmchains) library.
 
 ## Selecting a Network
 
@@ -25,7 +26,7 @@ ape test --network ethereum:local:foundry
 ape console --network arbitrum:testnet:alchemy # NOTICE: All networks, even from other ecosystems, use this.
 ```
 
-To see all possible values for `--network`, run the command:
+To see all networks that work with the `--network` flag (besides those _only_ defined in `evmchains`), run the command:
 
 ```shell
 ape networks list
@@ -100,6 +101,20 @@ ape networks list
 
 In the remainder of this guide, any example below using Ethereum, you can replace with an L2 ecosystem's name and network combination.
 
+## evmchains Networks
+
+If a network is in the [evmchains](https://github.com/ApeWorX/evmchains) library, it will work in Ape automatically, even without a plugin or any custom configuration for that network.
+
+```shell
+ape console --network moonbeam
+```
+
+This works because the `moonbeam` network data is available in the `evmchains` library, and Ape is able to look it up.
+
+```{warning}
+Support for networks from evm-chains alone may be limited and require additional configuration to work in production use-cases.
+```
+
 ## Custom Network Connection
 
 You can add custom networks to Ape without creating a plugin.

diff --git a/stable/commands/console.html b/stable/commands/console.html
@@ -172,6 +172,12 @@ <h2>console<a class="headerlink" href="#console" title="Link to this heading">
 <dd><p>One of ERROR, WARNING, SUCCESS, INFO, or DEBUG</p>
 </dd></dl>
 
+<dl class="std option">
+<dt class="sig sig-object std" id="cmdoption-console-c">
+<span id="cmdoption-console-code"></span><span class="sig-name descname"><span class="pre">-c</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--code</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;code&gt;</span></span><a class="headerlink" href="#cmdoption-console-c" title="Link to this definition"></a></dt>
+<dd><p>Program passed in as a string</p>
+</dd></dl>
+
 </section>
 </section>
 

diff --git a/stable/commands/init.html b/stable/commands/init.html
@@ -174,6 +174,12 @@ <h1>init<a class="headerlink" href="#init" title="Link to this heading"></a><
 <dd><p>Clone a template from Github</p>
 </dd></dl>
 
+<dl class="std option">
+<dt class="sig sig-object std" id="cmdoption-init-name">
+<span class="sig-name descname"><span class="pre">--name</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;project_name&gt;</span></span><a class="headerlink" href="#cmdoption-init-name" title="Link to this definition"></a></dt>
+<dd><p>A project name</p>
+</dd></dl>
+
 </section>
 
         </article><button class="back-to-top" type="button">

diff --git a/stable/commands/networks.html b/stable/commands/networks.html
@@ -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>local | sepolia | sepolia-fork | holesky | mainnet | mainnet-fork | holesky-fork</p>
+<dd class="field-odd"><p>holesky | mainnet | local | goerli | holesky-fork | mainnet-fork | sepolia-fork | sepolia</p>
 </dd>
 </dl>
 </dd></dl>
@@ -215,7 +215,7 @@ <h2>list<a class="headerlink" href="#networks-list" title="Link to this heading"
 <dd><p>Filter the results by provider</p>
 <dl class="field-list simple">
 <dt class="field-odd">Options<span class="colon">:</span></dt>
-<dd class="field-odd"><p>node | test</p>
+<dd class="field-odd"><p>test | node</p>
 </dd>
 </dl>
 </dd></dl>
@@ -241,7 +241,7 @@ <h2>run<a class="headerlink" href="#networks-run" title="Link to this heading">
 <dd><p>Override the default network and provider. (see <cite>ape networks list</cite> for options)</p>
 <dl class="field-list simple">
 <dt class="field-odd">Options<span class="colon">:</span></dt>
-<dd class="field-odd"><p>:mainnet:node | ethereum:mainnet:node | :mainnet | ethereum:mainnet | :sepolia:node | ethereum:sepolia:node | :sepolia | ethereum:sepolia | :holesky:node | ethereum:holesky:node | :holesky | ethereum:holesky | ::node | :local:node | ethereum::node | ethereum:local:node | ::test | :local:test | ethereum::test | ethereum:local:test | :local | ethereum:local | ethereum</p>
+<dd class="field-odd"><p>:goerli:node | ethereum:goerli:node | :goerli | ethereum:goerli | :mainnet:node | ethereum:mainnet:node | :mainnet | ethereum:mainnet | :sepolia:node | ethereum:sepolia:node | :sepolia | ethereum:sepolia | :holesky:node | ethereum:holesky:node | :holesky | ethereum:holesky | ::node | :local:node | ethereum::node | ethereum:local:node | ::test | :local:test | ethereum::test | ethereum:local:test | :local | ethereum:local | ethereum</p>
 </dd>
 </dl>
 </dd></dl>