Update documentation

ApeWorX · Dec 23, 2024 · 975ddc7 · 975ddc7
1 parent 61494c8
commit 975ddc7
Show file tree

Hide file tree

Showing 23 changed files with 41 additions and 11 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>avalanche | zora | wemix | polygon | gnosis | cronos | lumia | rootstock | soneium | astar | base | fraxtal | scroll | shape | abstract | moonbeam | kroma | xmtp | palm | bttc | optimism | celo | cronos-zkevm | mantle | berachain | fantom | metis | lens | unichain | apechain | arbitrum | polynomial | flow-evm | xai | shibarium | world-chain | linea | bsc | oort | polygon-zkevm | taiko | zksync | ethereum | geist | blast | zetachain | crossfi</p>
+<dd class="field-odd"><p>zksync | lumia | lens | ethereum | bttc | polynomial | wemix | xmtp | zetachain | polygon | unichain | bsc | metis | base | celo | blast | avalanche | mantle | berachain | gnosis | optimism | xai | crossfi | zora | shibarium | astar | fraxtal | cronos | kroma | moonbeam | geist | cronos-zkevm | palm | polygon-zkevm | soneium | taiko | linea | fantom | rootstock | abstract | scroll | apechain | shape | arbitrum | flow-evm | oort | world-chain</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>polter | puppynet-fork | cardona | nova-fork | polter-fork | sepolia-fork | chiado | goerli | mainnet-fork | curtis-fork | moonriver | donau-fork | holesky | mumbai-fork | minato | goerli-fork | fuji | alfajores-fork | mumbai | mainnet | cardona-fork | holesky-fork | chiado-fork | bartio | puppynet | opbnb | prism | fuji-fork | alfajores | hekla-fork | minato-fork | donau | opbnb-fork | amoy-fork | nova | moonbase-fork | testnet-fork | sepolia | prism-fork | dev | dev-fork | moonriver-fork | opbnb-testnet | local | testnet | amoy | curtis | opbnb-testnet-fork | hekla | bartio-fork | moonbase</p>
+<dd class="field-odd"><p>minato-fork | fuji | alfajores | local | cardona | sepolia-fork | sepolia | mumbai-fork | prism-fork | hekla-fork | donau-fork | opbnb-testnet-fork | nova | puppynet-fork | testnet | opbnb-testnet | moonriver-fork | mainnet | chiado | polter-fork | mumbai | curtis-fork | bartio | opbnb | holesky-fork | moonbase-fork | nova-fork | chiado-fork | amoy-fork | goerli-fork | prism | hekla | testnet-fork | puppynet | mainnet-fork | minato | opbnb-fork | moonriver | cardona-fork | donau | alfajores-fork | amoy | dev-fork | fuji-fork | polter | goerli | dev | holesky | moonbase | curtis | bartio-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
@@ -2477,8 +2477,12 @@ <h2 id="F">F</h2>
 <h2 id="G">G</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="methoddocs/ape_test.html#ape_test.config.ApeTestConfig.gas">gas (ape_test.config.ApeTestConfig attribute)</a>
+      <li><a href="methoddocs/api.html#ape.api.transactions.TransactionAPI.gas">gas (ape.api.transactions.TransactionAPI property)</a>
+
+      <ul>
+        <li><a href="methoddocs/ape_test.html#ape_test.config.ApeTestConfig.gas">(ape_test.config.ApeTestConfig attribute)</a>
 </li>
+      </ul></li>
       <li><a href="methoddocs/utils.html#ape.utils.trace.TraceStyles.GAS_COST">GAS_COST (ape.utils.trace.TraceStyles attribute)</a>
 </li>
       <li><a href="methoddocs/utils.html#ape.utils.misc.gas_estimation_error_message">gas_estimation_error_message() (in module ape.utils.misc)</a>
@@ -2774,6 +2778,8 @@ <h2 id="H">H</h2>
       <li><a href="methoddocs/api.html#ape.api.providers.BlockAPI.hash">hash (ape.api.providers.BlockAPI attribute)</a>
 
       <ul>
+        <li><a href="methoddocs/api.html#ape.api.transactions.TransactionAPI.hash">(ape.api.transactions.TransactionAPI property)</a>
+</li>
         <li><a href="methoddocs/ape_ethereum.html#ape_ethereum.ecosystem.Block.hash">(ape_ethereum.ecosystem.Block attribute)</a>
 </li>
       </ul></li>
@@ -2788,11 +2794,11 @@ <h2 id="H">H</h2>
       <li><a href="methoddocs/managers.html#ape.managers.converters.HexAddressConverter">HexAddressConverter (class in ape.managers.converters)</a>
 </li>
       <li><a href="methoddocs/managers.html#ape.managers.converters.HexConverter">HexConverter (class in ape.managers.converters)</a>
-</li>
-      <li><a href="methoddocs/types.html#ape.types.basic.HexInt">HexInt (in module ape.types.basic)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="methoddocs/types.html#ape.types.basic.HexInt">HexInt (in module ape.types.basic)</a>
+</li>
       <li><a href="methoddocs/managers.html#ape.managers.converters.HexIntConverter">HexIntConverter (class in ape.managers.converters)</a>
 </li>
       <li><a href="methoddocs/managers.html#ape.managers.converters.HexIterableConverter">HexIterableConverter (class in ape.managers.converters)</a>
@@ -3875,6 +3881,8 @@ <h2 id="R">R</h2>
         <li><a href="methoddocs/ape_ethereum.html#ape_ethereum.transactions.Receipt.raise_for_status">(ape_ethereum.transactions.Receipt method)</a>
 </li>
       </ul></li>
+      <li><a href="methoddocs/api.html#ape.api.transactions.TransactionAPI.raise_on_revert">raise_on_revert (ape.api.transactions.TransactionAPI property)</a>
+</li>
       <li><a href="methoddocs/utils.html#ape.utils.misc.raises_not_implemented">raises_not_implemented() (in module ape.utils.misc)</a>
 </li>
       <li><a href="methoddocs/api.html#ape.api.transactions.ReceiptAPI.ran_out_of_gas">ran_out_of_gas (ape.api.transactions.ReceiptAPI property)</a>
@@ -3945,6 +3953,8 @@ <h2 id="R">R</h2>
         <li><a href="methoddocs/ape_test.html#ape_test.config.GasConfig.reports">(ape_test.config.GasConfig attribute)</a>
 </li>
       </ul></li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="methoddocs/api.html#ape.api.networks.EcosystemAPI.request_header">request_header (ape.api.networks.EcosystemAPI attribute)</a>
 
       <ul>
@@ -3955,8 +3965,6 @@ <h2 id="R">R</h2>
         <li><a href="methoddocs/ape_ethereum.html#ape_ethereum.provider.EthereumNodeProvider.request_header">(ape_ethereum.provider.EthereumNodeProvider attribute)</a>
 </li>
       </ul></li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="methoddocs/api.html#ape.api.config.ApeConfig.request_headers">request_headers (ape.api.config.ApeConfig attribute)</a>
 
       <ul>