Update documentation

ApeWorX · Jan 13, 2025 · 607c5e9 · 607c5e9
1 parent 3badfa8
commit 607c5e9
Show file tree

Hide file tree

Showing 22 changed files with 16 additions and 5 deletions.
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_accounts.doctree b/latest/.doctrees/methoddocs/ape_accounts.doctree
diff --git a/latest/.doctrees/methoddocs/ape_compile.doctree b/latest/.doctrees/methoddocs/ape_compile.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/ape_pm.doctree b/latest/.doctrees/methoddocs/ape_pm.doctree
diff --git a/latest/.doctrees/methoddocs/ape_test.doctree b/latest/.doctrees/methoddocs/ape_test.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
@@ -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>crossfi | abstract | palm | zksync | oort | lens | geist | metis | bsc | bttc | flow-evm | polynomial | world-chain | lumia | berachain | wemix | moonbeam | cronos | ethereum | scroll | zetachain | base | astar | soneium | zora | optimism | taiko | shibarium | gnosis | blast | linea | rootstock | apechain | avalanche | mantle | fraxtal | kroma | arbitrum | polygon | celo | xai | cronos-zkevm | fantom | polygon-zkevm | shape | unichain | xmtp</p>
+<dd class="field-odd"><p>moonbeam | optimism | xai | cronos-zkevm | avalanche | geist | bsc | polygon | zksync | blast | xmtp | polynomial | crossfi | shape | celo | linea | flow-evm | metis | shibarium | apechain | world-chain | cronos | base | mantle | gnosis | taiko | arbitrum | abstract | lumia | lens | palm | oort | zora | zetachain | rootstock | fraxtal | berachain | fantom | polygon-zkevm | soneium | unichain | scroll | bttc | kroma | astar | wemix | ethereum</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>hekla-fork | dev-fork | opbnb-testnet-fork | mumbai-fork | donau-fork | chiado-fork | nova | donau | chiado | cardona-fork | holesky-fork | opbnb | amoy-fork | alfajores-fork | bartio-fork | polter | moonriver | prism-fork | fuji-fork | opbnb-testnet | mainnet | bartio | goerli-fork | minato-fork | amoy | curtis-fork | goerli | local | curtis | alfajores | moonbase-fork | puppynet | minato | sepolia | fuji | hekla | holesky | moonbase | dev | testnet-fork | nova-fork | prism | cardona | testnet | sepolia-fork | puppynet-fork | polter-fork | opbnb-fork | moonriver-fork | mainnet-fork | mumbai</p>
+<dd class="field-odd"><p>chiado | polter | moonbase | puppynet-fork | cardona-fork | mainnet | prism | curtis | polter-fork | testnet | minato-fork | hekla-fork | goerli-fork | mainnet-fork | fuji-fork | opbnb | goerli | holesky | moonriver-fork | amoy-fork | mumbai | cardona | mumbai-fork | fuji | nova | opbnb-fork | dev | opbnb-testnet-fork | chiado-fork | moonriver | puppynet | holesky-fork | sepolia-fork | donau-fork | prism-fork | dev-fork | bartio | alfajores | amoy | sepolia | hekla | local | donau | moonbase-fork | minato | alfajores-fork | bartio-fork | curtis-fork | testnet-fork | opbnb-testnet | nova-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/latest/genindex.html b/latest/genindex.html
@@ -2793,8 +2793,12 @@ <h2 id="H">H</h2>
         <li><a href="methoddocs/ape_ethereum.html#ape_ethereum.ecosystem.Block.hash">(ape_ethereum.ecosystem.Block attribute)</a>
 </li>
       </ul></li>
-      <li><a href="methoddocs/ape_test.html#ape_test.config.ApeTestConfig.hd_path">hd_path (ape_test.config.ApeTestConfig attribute)</a>
+      <li><a href="methoddocs/managers.html#ape.managers.accounts.TestAccountManager.hd_path">hd_path (ape.managers.accounts.TestAccountManager property)</a>
+
+      <ul>
+        <li><a href="methoddocs/ape_test.html#ape_test.config.ApeTestConfig.hd_path">(ape_test.config.ApeTestConfig attribute)</a>
 </li>
+      </ul></li>
       <li><a href="methoddocs/managers.html#ape.managers.chain.BlockContainer.head">head (ape.managers.chain.BlockContainer property)</a>
 </li>
       <li><a href="methoddocs/types.html#ape.types.signatures.SignableMessage.header">header (ape.types.signatures.SignableMessage attribute)</a>

diff --git a/latest/methoddocs/managers.html b/latest/methoddocs/managers.html
@@ -145,6 +145,7 @@
 <li><a class="reference internal" href="#ape.managers.accounts.TestAccountManager.__iter__"><code class="docutils literal notranslate">__iter__()</span></code></a></li>
 <li><a class="reference internal" href="#ape.managers.accounts.TestAccountManager.__len__"><code class="docutils literal notranslate">__len__()</span></code></a></li>
 <li><a class="reference internal" href="#ape.managers.accounts.TestAccountManager.__repr__"><code class="docutils literal notranslate">__repr__()</span></code></a></li>
+<li><a class="reference internal" href="#ape.managers.accounts.TestAccountManager.hd_path"><code class="docutils literal notranslate">hd_path</span></code></a></li>
 <li><a class="reference internal" href="#ape.managers.accounts.TestAccountManager.impersonate_account"><code class="docutils literal notranslate">impersonate_account()</span></code></a></li>
 <li><a class="reference internal" href="#ape.managers.accounts.TestAccountManager.stop_impersonating"><code class="docutils literal notranslate">stop_impersonating()</span></code></a></li>
 </ul>
@@ -659,6 +660,12 @@ <h1>ape.managers<a class="headerlink" href="#ape-managers" title="Link to this h
 <dd><p>Return repr(self).</p>
 </dd></dl>
 
+<dl class="py property">
+<dt class="sig sig-object py" id="ape.managers.accounts.TestAccountManager.hd_path">
+<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">hd_path</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ape.managers.accounts.TestAccountManager.hd_path" title="Link to this definition"></a></dt>
+<dd><p>The HD path used for generating the test accounts.</p>
+</dd></dl>
+
 <dl class="py method">
 <dt class="sig sig-object py" id="ape.managers.accounts.TestAccountManager.impersonate_account">
 <span class="sig-name descname"><span class="pre">impersonate_account</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="api.html#ape.api.accounts.ImpersonatedAccount" title="ape.api.accounts.ImpersonatedAccount"><span class="pre">ImpersonatedAccount</span></a></span></span><a class="headerlink" href="#ape.managers.accounts.TestAccountManager.impersonate_account" title="Link to this definition"></a></dt>

diff --git a/latest/objects.inv b/latest/objects.inv
diff --git a/latest/searchindex.js b/latest/searchindex.js