Docs: (827d972) feat: allow specific snapshot chunk ratio (#212)

* feat: allow specific snapshot chunk ratio

* feat(network): add snapshotNumChunks config option to setupMUDNetwork and SyncWorker

Co-authored-by: alvrs <alvarius@lattice.xyz>

docs/network/classes/SyncWorker.html

@@ -31,7 +31,7 @@ <h4>Implements</h4>
 <ul class="tsd-hierarchy">
 <li><span class="tsd-signature-type">DoWork</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/SyncWorkerConfig.html" class="tsd-signature-type" data-tsd-kind="Type alias">SyncWorkerConfig</a><span class="tsd-signature-symbol">, </span><a href="../types/NetworkEvent.html" class="tsd-signature-type" data-tsd-kind="Type alias">NetworkEvent</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">C</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/latticexyz/mud/blob/b9e8909/packages/network/src/workers/SyncWorker.ts#L39">network/src/workers/SyncWorker.ts:39</a></li></ul></aside>
+<li>Defined in <a href="https://github.com/latticexyz/mud/blob/827d972/packages/network/src/workers/SyncWorker.ts#L39">network/src/workers/SyncWorker.ts:39</a></li></ul></aside>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -67,24 +67,24 @@ <h4 class="tsd-type-parameters-title">Type Parameters</h4>
 <h4>C<span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">Components</span></h4></li></ul></div>
 <h4 class="tsd-returns-title">Returns <a href="SyncWorker.html" class="tsd-signature-type" data-tsd-kind="Class">SyncWorker</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">C</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/latticexyz/mud/blob/b9e8909/packages/network/src/workers/SyncWorker.ts#L44">network/src/workers/SyncWorker.ts:44</a></li></ul></aside></li></ul></section></section>
+<li>Defined in <a href="https://github.com/latticexyz/mud/blob/827d972/packages/network/src/workers/SyncWorker.ts#L44">network/src/workers/SyncWorker.ts:44</a></li></ul></aside></li></ul></section></section>
 <section class="tsd-panel-group tsd-member-group">
 <h2>Properties</h2>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="input_" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>input$</span><a href="#input_" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature">input$<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Subject</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/SyncWorkerConfig.html" class="tsd-signature-type" data-tsd-kind="Type alias">SyncWorkerConfig</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/latticexyz/mud/blob/b9e8909/packages/network/src/workers/SyncWorker.ts#L40">network/src/workers/SyncWorker.ts:40</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/latticexyz/mud/blob/827d972/packages/network/src/workers/SyncWorker.ts#L40">network/src/workers/SyncWorker.ts:40</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="output_" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>output$</span><a href="#output_" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature">output$<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Subject</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/NetworkEvent.html" class="tsd-signature-type" data-tsd-kind="Type alias">NetworkEvent</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">C</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/latticexyz/mud/blob/b9e8909/packages/network/src/workers/SyncWorker.ts#L41">network/src/workers/SyncWorker.ts:41</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/latticexyz/mud/blob/827d972/packages/network/src/workers/SyncWorker.ts#L41">network/src/workers/SyncWorker.ts:41</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="syncState" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>sync<wbr/>State</span><a href="#syncState" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature">sync<wbr/>State<span class="tsd-signature-symbol">:</span> <a href="../types/SyncStateStruct.html" class="tsd-signature-type" data-tsd-kind="Type alias">SyncStateStruct</a><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/latticexyz/mud/blob/b9e8909/packages/network/src/workers/SyncWorker.ts#L42">network/src/workers/SyncWorker.ts:42</a></li></ul></aside></section></section>
+<li>Defined in <a href="https://github.com/latticexyz/mud/blob/827d972/packages/network/src/workers/SyncWorker.ts#L42">network/src/workers/SyncWorker.ts:42</a></li></ul></aside></section></section>
 <section class="tsd-panel-group tsd-member-group">
 <h2>Methods</h2>
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="init" class="tsd-anchor"></a>
@@ -107,7 +107,7 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code>
 </div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/latticexyz/mud/blob/b9e8909/packages/network/src/workers/SyncWorker.ts#L88">network/src/workers/SyncWorker.ts:88</a></li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/latticexyz/mud/blob/827d972/packages/network/src/workers/SyncWorker.ts#L88">network/src/workers/SyncWorker.ts:88</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="setLoadingState" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>set<wbr/>Loading<wbr/>State</span><a href="#setLoadingState" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
@@ -127,7 +127,7 @@ <h5>blockNumber: <span class="tsd-signature-type">number</span><span class="tsd-
 </div></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/latticexyz/mud/blob/b9e8909/packages/network/src/workers/SyncWorker.ts#L56">network/src/workers/SyncWorker.ts:56</a></li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/latticexyz/mud/blob/827d972/packages/network/src/workers/SyncWorker.ts#L56">network/src/workers/SyncWorker.ts:56</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="work" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>work</span><a href="#work" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -141,7 +141,7 @@ <h5>input$: <span class="tsd-signature-type">Observable</span><span class="tsd-s
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Observable</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/NetworkEvent.html" class="tsd-signature-type" data-tsd-kind="Type alias">NetworkEvent</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">C</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
 <p>Implementation of DoWork.work</p>
 <ul>
-<li>Defined in <a href="https://github.com/latticexyz/mud/blob/b9e8909/packages/network/src/workers/SyncWorker.ts#L252">network/src/workers/SyncWorker.ts:252</a></li></ul></aside></li></ul></section></section></div>
+<li>Defined in <a href="https://github.com/latticexyz/mud/blob/827d972/packages/network/src/workers/SyncWorker.ts#L256">network/src/workers/SyncWorker.ts:256</a></li></ul></aside></li></ul></section></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

docs/network/enums/ConnectionState.html

@@ -18,7 +18,7 @@
 <li><a href="ConnectionState.html">ConnectionState</a></li></ul>
 <h1>Enumeration ConnectionState</h1></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/latticexyz/mud/blob/b9e8909/packages/network/src/createProvider.ts#L38">network/src/createProvider.ts:38</a></li></ul></aside>
+<li>Defined in <a href="https://github.com/latticexyz/mud/blob/827d972/packages/network/src/createProvider.ts#L38">network/src/createProvider.ts:38</a></li></ul></aside>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -36,17 +36,17 @@ <h2>Enumeration Members</h2>
 <h3 class="tsd-anchor-link"><span>CONNECTED</span><a href="#CONNECTED" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></h3>
 <div class="tsd-signature">CONNECTED<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">2</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/latticexyz/mud/blob/b9e8909/packages/network/src/createProvider.ts#L41">network/src/createProvider.ts:41</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/latticexyz/mud/blob/827d972/packages/network/src/createProvider.ts#L41">network/src/createProvider.ts:41</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="CONNECTING" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>CONNECTING</span><a href="#CONNECTING" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature">CONNECTING<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">1</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/latticexyz/mud/blob/b9e8909/packages/network/src/createProvider.ts#L40">network/src/createProvider.ts:40</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/latticexyz/mud/blob/827d972/packages/network/src/createProvider.ts#L40">network/src/createProvider.ts:40</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="DISCONNECTED" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>DISCONNECTED</span><a href="#DISCONNECTED" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature">DISCONNECTED<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">0</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/latticexyz/mud/blob/b9e8909/packages/network/src/createProvider.ts#L39">network/src/createProvider.ts:39</a></li></ul></aside></section></section></div>
+<li>Defined in <a href="https://github.com/latticexyz/mud/blob/827d972/packages/network/src/createProvider.ts#L39">network/src/createProvider.ts:39</a></li></ul></aside></section></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">