Update documentation

latest/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: e193007b19772f90ae02fe85ce4f1367
+config: d7321c85d7f2ce606499c1fbaf3b0b93
 tags: 645f666f9bcd5a90fca523b33c5a78b7

latest/commands/run.html

@@ -139,7 +139,7 @@ <h2>run<a class="headerlink" href="#run" title="Permalink 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:geth | ethereum:mainnet:geth | :mainnet | ethereum:mainnet | :goerli:geth | ethereum:goerli:geth | :goerli | ethereum:goerli | :sepolia:geth | ethereum:sepolia:geth | :sepolia | ethereum:sepolia | ::geth | :local:geth | ethereum::geth | ethereum:local:geth | ::test | :local:test | ethereum::test | ethereum:local:test | :local | ethereum:local | ethereum</p>
+<dd class="field-odd"><p>:mainnet:geth | ethereum:mainnet:geth | :mainnet | ethereum:mainnet | :goerli:geth | ethereum:goerli:geth | :goerli | ethereum:goerli | :sepolia:geth | ethereum:sepolia:geth | :sepolia | ethereum:sepolia | ::test | :local:test | ethereum::test | ethereum:local:test | ::geth | :local:geth | ethereum::geth | ethereum:local:geth | :local | ethereum:local | ethereum</p>
 </dd>
 </dl>
 </dd></dl>

latest/genindex.html

@@ -113,8 +113,6 @@ <h1 id="index">Index</h1>
  | <a href="#A"><strong>A</strong></a>
  | <a href="#B"><strong>B</strong></a>
  | <a href="#C"><strong>C</strong></a>
- | <a href="#D"><strong>D</strong></a>
- | <a href="#G"><strong>G</strong></a>
  | <a href="#H"><strong>H</strong></a>
  | <a href="#I"><strong>I</strong></a>
  | <a href="#M"><strong>M</strong></a>
@@ -123,6 +121,7 @@ <h1 id="index">Index</h1>
  | <a href="#P"><strong>P</strong></a>
  | <a href="#R"><strong>R</strong></a>
  | <a href="#S"><strong>S</strong></a>
+ | <a href="#T"><strong>T</strong></a>
  | <a href="#W"><strong>W</strong></a>
 
 </div>
@@ -197,36 +196,20 @@ <h2 id="B">B</h2>
       <li><a href="methoddocs/runner.html#silverback.runner.BaseRunner">BaseRunner (class in silverback.runner)</a>
 </li>
   </ul></td>
-</tr></table>
-
-<h2 id="C">C</h2>
-<table style="width: 100%" class="indextable genindextable"><tr>
-  <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="methoddocs/exceptions.html#silverback.exceptions.CircuitBreaker">CircuitBreaker</a>
-</li>
-  </ul></td>
-</tr></table>
-
-<h2 id="D">D</h2>
-<table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="methoddocs/exceptions.html#silverback.exceptions.DuplicateHandlerError">DuplicateHandlerError</a>
+      <li><a href="methoddocs/application.html#silverback.application.SilverbackApp.broker_task_decorator">broker_task_decorator() (silverback.application.SilverbackApp method)</a>
 </li>
   </ul></td>
 </tr></table>
 
-<h2 id="G">G</h2>
+<h2 id="C">C</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="methoddocs/application.html#silverback.application.SilverbackApp.get_block_handler">get_block_handler() (silverback.application.SilverbackApp method)</a>
-</li>
-      <li><a href="methoddocs/application.html#silverback.application.SilverbackApp.get_event_handler">get_event_handler() (silverback.application.SilverbackApp method)</a>
+      <li><a href="methoddocs/exceptions.html#silverback.exceptions.CircuitBreaker">CircuitBreaker</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="methoddocs/application.html#silverback.application.SilverbackApp.get_shutdown_handler">get_shutdown_handler() (silverback.application.SilverbackApp method)</a>
-</li>
-      <li><a href="methoddocs/application.html#silverback.application.SilverbackApp.get_startup_handler">get_startup_handler() (silverback.application.SilverbackApp method)</a>
+      <li><a href="methoddocs/exceptions.html#silverback.exceptions.ContainerTypeMismatchError">ContainerTypeMismatchError</a>
 </li>
   </ul></td>
 </tr></table>
@@ -290,8 +273,6 @@ <h2 id="O">O</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="methoddocs/application.html#silverback.application.SilverbackApp.on_">on_() (silverback.application.SilverbackApp method)</a>
-</li>
-      <li><a href="methoddocs/middlewares.html#silverback.middlewares.SilverbackMiddleware.on_error">on_error() (silverback.middlewares.SilverbackMiddleware method)</a>
 </li>
       <li><a href="methoddocs/application.html#silverback.application.SilverbackApp.on_shutdown">on_shutdown() (silverback.application.SilverbackApp method)</a>
 </li>
@@ -424,6 +405,14 @@ <h2 id="S">S</h2>
   </ul></td>
 </tr></table>
 
+<h2 id="T">T</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="methoddocs/application.html#silverback.application.TaskData">TaskData (class in silverback.application)</a>
+</li>
+  </ul></td>
+</tr></table>
+
 <h2 id="W">W</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>

latest/methoddocs/application.html

@@ -79,17 +79,15 @@
 <ul class="current">
 <li class="toctree-l1 current"><a class="current reference internal" href="#">silverback.application</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#silverback.application.SilverbackApp"><code class="docutils literal notranslate"><span class="pre">SilverbackApp</span></code></a><ul>
-<li class="toctree-l3"><a class="reference internal" href="#silverback.application.SilverbackApp.get_block_handler"><code class="docutils literal notranslate"><span class="pre">SilverbackApp.get_block_handler()</span></code></a></li>
-<li class="toctree-l3"><a class="reference internal" href="#silverback.application.SilverbackApp.get_event_handler"><code class="docutils literal notranslate"><span class="pre">SilverbackApp.get_event_handler()</span></code></a></li>
-<li class="toctree-l3"><a class="reference internal" href="#silverback.application.SilverbackApp.get_shutdown_handler"><code class="docutils literal notranslate"><span class="pre">SilverbackApp.get_shutdown_handler()</span></code></a></li>
-<li class="toctree-l3"><a class="reference internal" href="#silverback.application.SilverbackApp.get_startup_handler"><code class="docutils literal notranslate"><span class="pre">SilverbackApp.get_startup_handler()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="#silverback.application.SilverbackApp.broker_task_decorator"><code class="docutils literal notranslate"><span class="pre">SilverbackApp.broker_task_decorator()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#silverback.application.SilverbackApp.on_"><code class="docutils literal notranslate"><span class="pre">SilverbackApp.on_()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#silverback.application.SilverbackApp.on_shutdown"><code class="docutils literal notranslate"><span class="pre">SilverbackApp.on_shutdown()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#silverback.application.SilverbackApp.on_startup"><code class="docutils literal notranslate"><span class="pre">SilverbackApp.on_startup()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#silverback.application.SilverbackApp.on_worker_shutdown"><code class="docutils literal notranslate"><span class="pre">SilverbackApp.on_worker_shutdown()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#silverback.application.SilverbackApp.on_worker_startup"><code class="docutils literal notranslate"><span class="pre">SilverbackApp.on_worker_startup()</span></code></a></li>
 </ul>
 </li>
+<li class="toctree-l2"><a class="reference internal" href="#silverback.application.TaskData"><code class="docutils literal notranslate"><span class="pre">TaskData</span></code></a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="runner.html">silverback.runner</a></li>
@@ -141,63 +139,25 @@ <h1>silverback.application<a class="headerlink" href="#silverback-application" t
 </pre></div>
 </div>
 <dl class="py method">
-<dt class="sig sig-object py" id="silverback.application.SilverbackApp.get_block_handler">
-<span class="sig-name descname"><span class="pre">get_block_handler</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">AsyncTaskiqDecoratedTask</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="headerlink" href="#silverback.application.SilverbackApp.get_block_handler" title="Permalink to this definition"></a></dt>
-<dd><p>Get access to the handler for <cite>block</cite> events.</p>
-<dl class="field-list simple">
-<dt class="field-odd">Returns<span class="colon">:</span></dt>
-<dd class="field-odd"><p>Returns decorated task, if one has been created.</p>
-</dd>
-<dt class="field-even">Return type<span class="colon">:</span></dt>
-<dd class="field-even"><p>Optional[AsyncTaskiqDecoratedTask]</p>
-</dd>
-</dl>
-</dd></dl>
-
-<dl class="py method">
-<dt class="sig sig-object py" id="silverback.application.SilverbackApp.get_event_handler">
-<span class="sig-name descname"><span class="pre">get_event_handler</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">event_target</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ChecksumAddress</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">event_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">AsyncTaskiqDecoratedTask</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="headerlink" href="#silverback.application.SilverbackApp.get_event_handler" title="Permalink to this definition"></a></dt>
-<dd><p>Get access to the handler for <cite>&lt;event_target&gt;:&lt;event_name&gt;</cite> events.</p>
+<dt class="sig sig-object py" id="silverback.application.SilverbackApp.broker_task_decorator">
+<span class="sig-name descname"><span class="pre">broker_task_decorator</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">task_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">TaskType</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">container</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">BlockContainer</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">ContractEvent</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">AsyncTaskiqDecoratedTask</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#silverback.application.SilverbackApp.broker_task_decorator" title="Permalink to this definition"></a></dt>
+<dd><p>Dynamically create a new broker task that handles tasks of <code class="docutils literal notranslate"><span class="pre">task_type</span></code>.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
-<li><p><strong>event_target</strong> (<em>AddressType</em>) – The contract address of the target.</p></li>
-<li><p><strong>event_name</strong> – (str): The name of the event emitted by <code class="docutils literal notranslate"><span class="pre">event_target</span></code>.</p></li>
+<li><p><strong>task_type</strong> – <code class="xref py py-class docutils literal notranslate"><span class="pre">TaskType</span></code>: The type of task to create.</p></li>
+<li><p><strong>container</strong> – (Union[BlockContainer, ContractEvent]): The event source to watch.</p></li>
 </ul>
 </dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>
-<dd class="field-even"><p>Returns decorated task, if one has been created.</p>
+<dd class="field-even"><p>A function wrapper that will register the task handler.</p>
 </dd>
 <dt class="field-odd">Return type<span class="colon">:</span></dt>
-<dd class="field-odd"><p>Optional[AsyncTaskiqDecoratedTask]</p>
-</dd>
-</dl>
-</dd></dl>
-
-<dl class="py method">
-<dt class="sig sig-object py" id="silverback.application.SilverbackApp.get_shutdown_handler">
-<span class="sig-name descname"><span class="pre">get_shutdown_handler</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">AsyncTaskiqDecoratedTask</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="headerlink" href="#silverback.application.SilverbackApp.get_shutdown_handler" title="Permalink to this definition"></a></dt>
-<dd><p>Get access to the handler for <cite>silverback_shutdown</cite> events.</p>
-<dl class="field-list simple">
-<dt class="field-odd">Returns<span class="colon">:</span></dt>
-<dd class="field-odd"><p>Returns decorated task, if one has been created.</p>
-</dd>
-<dt class="field-even">Return type<span class="colon">:</span></dt>
-<dd class="field-even"><p>Optional[AsyncTaskiqDecoratedTask]</p>
-</dd>
-</dl>
-</dd></dl>
-
-<dl class="py method">
-<dt class="sig sig-object py" id="silverback.application.SilverbackApp.get_startup_handler">
-<span class="sig-name descname"><span class="pre">get_startup_handler</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">AsyncTaskiqDecoratedTask</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="headerlink" href="#silverback.application.SilverbackApp.get_startup_handler" title="Permalink to this definition"></a></dt>
-<dd><p>Get access to the handler for <cite>silverback_startup</cite> events.</p>
-<dl class="field-list simple">
-<dt class="field-odd">Returns<span class="colon">:</span></dt>
-<dd class="field-odd"><p>Returns decorated task, if one has been created.</p>
+<dd class="field-odd"><p>Callable[[Callable], <code class="xref py py-class docutils literal notranslate"><span class="pre">AsyncTaskiqDecoratedTask</span></code>]</p>
 </dd>
-<dt class="field-even">Return type<span class="colon">:</span></dt>
-<dd class="field-even"><p>Optional[AsyncTaskiqDecoratedTask]</p>
+<dt class="field-even">Raises<span class="colon">:</span></dt>
+<dd class="field-even"><p><a class="reference internal" href="exceptions.html#silverback.exceptions.ContainerTypeMismatchError" title="silverback.exceptions.ContainerTypeMismatchError"><strong>ContainerTypeMismatchError</strong></a> – If there is a mismatch between <cite>task_type</cite> and the <cite>container</cite>
+    type it should handle.</p>
 </dd>
 </dl>
 </dd></dl>
@@ -272,6 +232,12 @@ <h1>silverback.application<a class="headerlink" href="#silverback-application" t
 
 </dd></dl>
 
+<dl class="py class">
+<dt class="sig sig-object py" id="silverback.application.TaskData">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">silverback.application.</span></span><span class="sig-name descname"><span class="pre">TaskData</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">container</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ape.managers.chain.BlockContainer</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">ape.contracts.base.ContractEvent</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">NoneType</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">handler</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">taskiq.decor.AsyncTaskiqDecoratedTask</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#silverback.application.TaskData" title="Permalink to this definition"></a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
+</dd></dl>
+
 </section>