Update documentation

ApeWorX · Oct 29, 2024 · dfd4c71 · dfd4c71
1 parent 482df2a
commit dfd4c71
Show file tree

Hide file tree

Showing 209 changed files with 41,558 additions and 353 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>mainnet-fork | holesky-fork | sepolia-fork | holesky | sepolia | mainnet | local</p>
+<dd class="field-odd"><p>local | sepolia | sepolia-fork | holesky | mainnet | mainnet-fork | holesky-fork</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/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_accounts.doctree b/stable/.doctrees/methoddocs/ape_accounts.doctree
diff --git a/stable/.doctrees/methoddocs/ape_compile.doctree b/stable/.doctrees/methoddocs/ape_compile.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/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>mainnet | sepolia | holesky-fork | sepolia-fork | holesky | local | mainnet-fork</p>
+<dd class="field-odd"><p>local | sepolia | sepolia-fork | holesky | mainnet | mainnet-fork | holesky-fork</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>test | node</p>
+<dd class="field-odd"><p>node | test</p>
 </dd>
 </dl>
 </dd></dl>

diff --git a/stable/genindex.html b/stable/genindex.html
@@ -68,7 +68,6 @@ <h1 id="index">Index</h1>
  | <a href="#H"><strong>H</strong></a>
  | <a href="#I"><strong>I</strong></a>
  | <a href="#J"><strong>J</strong></a>
- | <a href="#K"><strong>K</strong></a>
  | <a href="#L"><strong>L</strong></a>
  | <a href="#M"><strong>M</strong></a>
  | <a href="#N"><strong>N</strong></a>
@@ -678,8 +677,6 @@ <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/ape_compile.html#ape_compile.OutputExtras.ABI">ABI (ape_compile.OutputExtras attribute)</a>
-</li>
       <li><a href="methoddocs/exceptions.html#ape.exceptions.Abort">Abort</a>
 </li>
       <li><a href="methoddocs/cli.html#ape.cli.options.ApeCliContextObject.abort">abort() (ape.cli.options.ApeCliContextObject static method)</a>
@@ -695,8 +692,6 @@ <h2 id="A">A</h2>
       <li><a href="methoddocs/cli.html#ape.cli.choices.AccountAliasPromptChoice">AccountAliasPromptChoice (class in ape.cli.choices)</a>
 </li>
       <li><a href="methoddocs/api.html#ape.api.accounts.AccountAPI">AccountAPI (class in ape.api.accounts)</a>
-</li>
-      <li><a href="methoddocs/ape_accounts.html#ape_accounts.AccountContainer">AccountContainer (class in ape_accounts)</a>
 </li>
       <li><a href="methoddocs/api.html#ape.api.accounts.AccountContainerAPI">AccountContainerAPI (class in ape.api.accounts)</a>
 </li>
@@ -712,8 +707,6 @@ <h2 id="A">A</h2>
 
       <ul>
         <li><a href="methoddocs/api.html#ape.api.accounts.AccountContainerAPI.accounts">(ape.api.accounts.AccountContainerAPI property)</a>
-</li>
-        <li><a href="methoddocs/ape_accounts.html#ape_accounts.AccountContainer.accounts">(ape_accounts.AccountContainer property)</a>
 </li>
       </ul></li>
       <li>
@@ -832,8 +825,6 @@ <h2 id="A">A</h2>
         <li><a href="methoddocs/managers.html#ape.managers.chain.AccountHistory.address">(ape.managers.chain.AccountHistory attribute)</a>
 </li>
         <li><a href="methoddocs/utils.html#ape.utils.GeneratedDevAccount.address">(ape.utils.GeneratedDevAccount attribute)</a>
-</li>
-        <li><a href="methoddocs/ape_accounts.html#ape_accounts.KeyfileAccount.address">(ape_accounts.KeyfileAccount property)</a>
 </li>
       </ul></li>
       <li><a href="methoddocs/api.html#ape.api.address.Address">Address (class in ape.api.address)</a>
@@ -858,11 +849,7 @@ <h2 id="A">A</h2>
 </li>
       </ul></li>
       <li><a href="methoddocs/api.html#ape.api.accounts.AccountAPI.alias">alias (ape.api.accounts.AccountAPI property)</a>
-
-      <ul>
-        <li><a href="methoddocs/ape_accounts.html#ape_accounts.KeyfileAccount.alias">(ape_accounts.KeyfileAccount property)</a>
 </li>
-      </ul></li>
       <li><a href="methoddocs/cli.html#ape.cli.choices.Alias">Alias (class in ape.cli.choices)</a>
 </li>
       <li><a href="methoddocs/exceptions.html#ape.exceptions.AliasAlreadyInUseError">AliasAlreadyInUseError</a>
@@ -871,8 +858,6 @@ <h2 id="A">A</h2>
 
       <ul>
         <li><a href="methoddocs/managers.html#ape.managers.accounts.AccountManager.aliases">(ape.managers.accounts.AccountManager property)</a>
-</li>
-        <li><a href="methoddocs/ape_accounts.html#ape_accounts.AccountContainer.aliases">(ape_accounts.AccountContainer property)</a>
 </li>
       </ul></li>
       <li><a href="methoddocs/utils.html#ape.utils.allow_disconnected">allow_disconnected() (in module ape.utils)</a>
@@ -961,15 +946,15 @@ <h2 id="A">A</h2>
         <li><a href="methoddocs/cli.html#module-ape.cli.choices">module</a>
 </li>
       </ul></li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li>
     ape.cli.commands
 
       <ul>
         <li><a href="methoddocs/cli.html#module-ape.cli.commands">module</a>
 </li>
       </ul></li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li>
     ape.cli.options
 
@@ -1538,11 +1523,7 @@ <h2 id="C">C</h2>
 </li>
       </ul></li>
       <li><a href="methoddocs/plugins.html#ape.plugins.config.Config">Config (class in ape.plugins.config)</a>
-
-      <ul>
-        <li><a href="methoddocs/ape_compile.html#ape_compile.Config">(class in ape_compile)</a>
 </li>
-      </ul></li>
       <li><a href="methoddocs/plugins.html#ape.plugins.config.Config.config_class">config_class() (ape.plugins.config.Config method)</a>
 </li>
       <li><a href="methoddocs/api.html#ape.api.projects.DependencyAPI.config_override">config_override (ape.api.projects.DependencyAPI attribute)</a>
@@ -2007,8 +1988,6 @@ <h2 id="E">E</h2>
       <li><a href="methoddocs/ape_ethereum.html#ape_ethereum.EthereumNodeProvider">EthereumNodeProvider (class in ape_ethereum)</a>
 </li>
       <li><a href="methoddocs/api.html#ape.api.transactions.ReceiptAPI.events">events (ape.api.transactions.ReceiptAPI property)</a>
-</li>
-      <li><a href="methoddocs/ape_compile.html#ape_compile.Config.exclude">exclude (ape_compile.Config attribute)</a>
 </li>
       <li><a href="methoddocs/managers.html#ape.managers.project.LocalProject.exclusions">exclusions (ape.managers.project.LocalProject property)</a>
 </li>
@@ -2174,11 +2153,7 @@ <h2 id="G">G</h2>
       <li><a href="methoddocs/types.html#ape.types.trace.GasReport">GasReport (in module ape.types.trace)</a>
 </li>
       <li><a href="methoddocs/api.html#ape.api.accounts.TestAccountContainerAPI.generate_account">generate_account() (ape.api.accounts.TestAccountContainerAPI method)</a>
-
-      <ul>
-        <li><a href="methoddocs/ape_accounts.html#ape_accounts.generate_account">(in module ape_accounts)</a>
 </li>
-      </ul></li>
       <li><a href="methoddocs/utils.html#ape.utils.generate_dev_accounts">generate_dev_accounts() (in module ape.utils)</a>
 </li>
       <li><a href="methoddocs/utils.html#ape.utils.GeneratedDevAccount">GeneratedDevAccount (class in ape.utils)</a>
@@ -2460,18 +2435,12 @@ <h2 id="I">I</h2>
       <li><a href="methoddocs/managers.html#ape.managers.accounts.TestAccountManager.impersonate_account">impersonate_account() (ape.managers.accounts.TestAccountManager method)</a>
 </li>
       <li><a href="methoddocs/api.html#ape.api.accounts.ImpersonatedAccount">ImpersonatedAccount (class in ape.api.accounts)</a>
-</li>
-      <li><a href="methoddocs/ape_accounts.html#ape_accounts.import_account_from_mnemonic">import_account_from_mnemonic() (in module ape_accounts)</a>
-</li>
-      <li><a href="methoddocs/ape_accounts.html#ape_accounts.import_account_from_private_key">import_account_from_private_key() (in module ape_accounts)</a>
 </li>
       <li><a href="methoddocs/managers.html#ape.managers.project.LocalProject.in_tempdir">in_tempdir (ape.managers.project.LocalProject property)</a>
 </li>
       <li><a href="methoddocs/utils.html#ape.utils.in_tempdir">in_tempdir() (in module ape.utils)</a>
 </li>
       <li><a href="methoddocs/types.html#ape.types.coverage.ContractSourceCoverage.include">include() (ape.types.coverage.ContractSourceCoverage method)</a>
-</li>
-      <li><a href="methoddocs/ape_compile.html#ape_compile.Config.include_dependencies">include_dependencies (ape_compile.Config attribute)</a>
 </li>
       <li><a href="methoddocs/utils.html#ape.utils.ExtraModelAttributes.include_getattr">include_getattr (ape.utils.ExtraModelAttributes attribute)</a>
 </li>
@@ -2534,10 +2503,10 @@ <h2 id="I">I</h2>
 </li>
       <li><a href="methoddocs/api.html#ape.api.networks.NetworkAPI.is_adhoc">is_adhoc (ape.api.networks.NetworkAPI property)</a>
 </li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="methoddocs/utils.html#ape.utils.is_array">is_array() (in module ape.utils)</a>
 </li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="methoddocs/managers.html#ape.managers.project.Project.is_compiled">is_compiled (ape.managers.project.Project property)</a>
 </li>
       <li><a href="methoddocs/api.html#ape.api.providers.ProviderAPI.is_connected">is_connected (ape.api.providers.ProviderAPI property)</a>
@@ -2633,18 +2602,12 @@ <h2 id="J">J</h2>
   </ul></td>
 </tr></table>
 
-<h2 id="K">K</h2>
-<table style="width: 100%" class="indextable genindextable"><tr>
-  <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="methoddocs/ape_accounts.html#ape_accounts.KeyfileAccount">KeyfileAccount (class in ape_accounts)</a>
-</li>
-  </ul></td>
-</tr></table>
-
 <h2 id="L">L</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="methoddocs/types.html#ape.types.trace.SourceTraceback.last">last (ape.types.trace.SourceTraceback property)</a>
+</li>
+      <li><a href="methoddocs/cli.html#ape.cli.choices.LazyChoice">LazyChoice (class in ape.cli.choices)</a>
 </li>
       <li><a href="methoddocs/types.html#ape.types.trace.ControlFlow.line_numbers">line_numbers (ape.types.trace.ControlFlow property)</a>
 </li>
@@ -2672,6 +2635,8 @@ <h2 id="L">L</h2>
         <li><a href="methoddocs/types.html#ape.types.coverage.FunctionCoverage.lines_covered">(ape.types.coverage.FunctionCoverage property)</a>
 </li>
       </ul></li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="methoddocs/types.html#ape.types.coverage.ContractCoverage.lines_valid">lines_valid (ape.types.coverage.ContractCoverage property)</a>
 
       <ul>
@@ -2684,8 +2649,6 @@ <h2 id="L">L</h2>
         <li><a href="methoddocs/types.html#ape.types.coverage.FunctionCoverage.lines_valid">(ape.types.coverage.FunctionCoverage property)</a>
 </li>
       </ul></li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="methoddocs/managers.html#ape.managers.accounts.AccountManager.load">load() (ape.managers.accounts.AccountManager method)</a>
 </li>
       <li><a href="methoddocs/utils.html#ape.utils.load_config">load_config() (in module ape.utils)</a>
@@ -3061,16 +3024,12 @@ <h2 id="O">O</h2>
       <li><a href="methoddocs/managers.html#ape.managers.chain.AccountHistory.outgoing">outgoing (ape.managers.chain.AccountHistory property)</a>
 </li>
       <li><a href="methoddocs/exceptions.html#ape.exceptions.OutOfGasError">OutOfGasError</a>
-</li>
-      <li><a href="methoddocs/ape_compile.html#ape_compile.Config.output_extra">output_extra (ape_compile.Config attribute)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="methoddocs/cli.html#ape.cli.choices.output_format_choice">output_format_choice() (in module ape.cli.choices)</a>
 </li>
       <li><a href="methoddocs/cli.html#ape.cli.options.output_format_option">output_format_option() (in module ape.cli.options)</a>
-</li>
-      <li><a href="methoddocs/ape_compile.html#ape_compile.OutputExtras">OutputExtras (class in ape_compile)</a>
 </li>
       <li><a href="methoddocs/cli.html#ape.cli.choices.OutputFormat">OutputFormat (class in ape.cli.choices)</a>
 </li>
@@ -3592,8 +3551,6 @@ <h2 id="S">S</h2>
         <li><a href="methoddocs/ape_ethereum.html#ape_ethereum.Web3Provider.send_transaction">(ape_ethereum.Web3Provider method)</a>
 </li>
       </ul></li>
-      <li><a href="methoddocs/ape_compile.html#ape_compile.Config.serialize_exclude">serialize_exclude() (ape_compile.Config method)</a>
-</li>
       <li><a href="methoddocs/api.html#ape.api.networks.EcosystemAPI.serialize_transaction">serialize_transaction() (ape.api.networks.EcosystemAPI method)</a>
 
       <ul>
@@ -3603,8 +3560,6 @@ <h2 id="S">S</h2>
 </li>
       </ul></li>
       <li><a href="methoddocs/managers.html#ape.managers.chain.AccountHistory.sessional">sessional (ape.managers.chain.AccountHistory attribute)</a>
-</li>
-      <li><a href="methoddocs/ape_accounts.html#ape_accounts.KeyfileAccount.set_autosign">set_autosign() (ape_accounts.KeyfileAccount method)</a>
 </li>
       <li><a href="methoddocs/api.html#ape.api.providers.ProviderAPI.set_balance">set_balance() (ape.api.providers.ProviderAPI method)</a>
 </li>
@@ -3670,22 +3625,14 @@ <h2 id="S">S</h2>
 
       <ul>
         <li><a href="methoddocs/api.html#ape.api.accounts.ImpersonatedAccount.sign_message">(ape.api.accounts.ImpersonatedAccount method)</a>
-</li>
-        <li><a href="methoddocs/ape_accounts.html#ape_accounts.KeyfileAccount.sign_message">(ape_accounts.KeyfileAccount method)</a>
 </li>
       </ul></li>
       <li><a href="methoddocs/api.html#ape.api.accounts.AccountAPI.sign_raw_msghash">sign_raw_msghash() (ape.api.accounts.AccountAPI method)</a>
-
-      <ul>
-        <li><a href="methoddocs/ape_accounts.html#ape_accounts.KeyfileAccount.sign_raw_msghash">(ape_accounts.KeyfileAccount method)</a>
 </li>
-      </ul></li>
       <li><a href="methoddocs/api.html#ape.api.accounts.AccountAPI.sign_transaction">sign_transaction() (ape.api.accounts.AccountAPI method)</a>
 
       <ul>
         <li><a href="methoddocs/api.html#ape.api.accounts.ImpersonatedAccount.sign_transaction">(ape.api.accounts.ImpersonatedAccount method)</a>
-</li>
-        <li><a href="methoddocs/ape_accounts.html#ape_accounts.KeyfileAccount.sign_transaction">(ape_accounts.KeyfileAccount method)</a>
 </li>
       </ul></li>
       <li><a href="methoddocs/types.html#ape.types.signatures.SignableMessage">SignableMessage (class in ape.types.signatures)</a>
@@ -3694,14 +3641,14 @@ <h2 id="S">S</h2>
 </li>
       <li><a href="methoddocs/utils.html#ape.utils.singledispatchmethod">singledispatchmethod (class in ape.utils)</a>
 </li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="methoddocs/api.html#ape.api.providers.BlockAPI.size">size (ape.api.providers.BlockAPI property)</a>
 
       <ul>
         <li><a href="methoddocs/ape_ethereum.html#ape_ethereum.Block.size">(ape_ethereum.Block property)</a>
 </li>
       </ul></li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="methoddocs/cli.html#ape.cli.options.skip_confirmation_option">skip_confirmation_option() (in module ape.cli.options)</a>
 </li>
       <li><a href="methoddocs/api.html#ape.api.providers.ProviderAPI.snapshot">snapshot() (ape.api.providers.ProviderAPI method)</a>