Deployed d6b1452 with MkDocs version: 1.4.3

index.html

@@ -190,5 +190,5 @@ <h2 id="contributing">Contributing</h2>
 
 <!--
 MkDocs version : 1.4.3
-Build Date UTC : 2023-07-19 09:08:37.185017+00:00
+Build Date UTC : 2023-07-19 11:19:35.789648+00:00
 -->

mappings/index.html

@@ -109,45 +109,50 @@ <h1 id="mappings">Mappings</h1>
 different results, even if applied on the same data. An exception to this is the "no-cluster" mapping, which maps blocks to 
 coinbase addresses, so it doesn't perform any extra processing on the raw data.</p>
 <h2 id="pool-information">Pool Information</h2>
-<p>To assist the mapping process, the directory <code>helpers/pool_information/</code> contains files named <code>&lt;project_name&gt;.json</code>, with
-relevant pool information, structured as follows:</p>
+<p>To assist the mapping process, the directory <code>helpers/pool_information/</code> contains 
+pool information about the supported projects.</p>
+<p>There exist three subdirectories. In each subdirectory there exists a file for
+the corresponding ledger data, if such data exists.</p>
+<p><code>coinbase_tags</code> defines information about block creators. Each key
+corresponds to a tag or ticker, by which the pool is identifiable in its
+produced blocks. The value for each key is a dictionary of pool-related
+information, specifically its name, a url to its homepage, etc. Each file's
+structure is as follows:</p>
 <pre><code>{
-  &quot;clusters&quot;: {
-    &quot;&lt;cluster name&gt;&quot;: [
-      {&quot;name&quot;: &quot;&lt;pool name&gt;&quot;, &quot;from&quot;: &quot;&lt;from&gt;&quot;, &quot;to&quot;: &quot;&lt;to&gt;&quot;, &quot;source&quot;: &quot;&lt;source of information&gt;&quot;}
-    ]
+  &quot;P1&quot;: {
+      &quot;name&quot;: &quot;Pool P1&quot;,
+      &quot;homepage&quot;: &quot;example.com/p1&quot;
   },
-  &quot;coinbase_tags&quot;: {
-    &quot;&lt;pool tag&gt;&quot;: {
-      &quot;name&quot;: &quot;&lt;pool name&gt;&quot;,
-      &quot;link&quot;: &quot;&lt;pool website&gt;&quot;
-    }
-  },
-  &quot;pool_addresses&quot;: {
-    &quot;&lt;address&gt;&quot;: {&quot;name&quot;: &quot;&lt;pool name&gt;&quot;, &quot;source&quot;: &quot;&lt;source of information&gt;&quot;},
+  &quot;--P2--&quot;: {
+      &quot;name&quot;: &quot;Pool P2&quot;,
+      &quot;homepage&quot;: &quot;example.com/p2&quot;
   }
 }
 </code></pre>
-<p>In this file:</p>
-<ul>
-<li><code>clusters</code> refers to pools that share infrastructure:</li>
-<li>for each pool in a cluster, the following values should be defined:</li>
-<li><code>&lt;from&gt;</code> sets the beginning of the control of the pool by the cluster; the first
-    day of the timeframe is chosen; for example, if <code>2022</code>, then the beginning is set
-    to <code>2022-01-01</code>); if <code>&lt;from&gt;</code> is empty, then the control existed since the
-    pool's inception.</li>
-<li><code>&lt;to&gt;</code> sets the end of the control of the pool by the cluster; the end is
-    exclusive, i.e., it defines the beginning of the control transition; for
-    example, if <code>2022</code>, the end of the control is <code>31-12-2021</code>
-    if <code>&lt;to&gt;</code> is empty, then the control is still active.</li>
-<li><code>&lt;source of information&gt;</code> should be either (i) comma-separated keywords or (ii) a url with the clustering information; this information should be publicly-available and reproducible (for example, a link to a community or company, with information that cannot be verified independently, is not acceptable);<ul>
-<li>keywords: for Cardano, <code>homepage</code> can be used for pools that define the
-  same <code>homepage</code> in their metadata json file (published on0chain)</li>
-</ul>
-</li>
-<li><code>&lt;pool tag&gt;</code> is the tag that a pool inserts in a block's coinbase parameter, in order to claim a block as being mined by the pool; in projects that do not rely on the coinbase parameter (e.g., Cardano, Tezos) the tag is just the name of the pool (Tezos) or its ticker (Cardano).</li>
-<li><code>pool_addresses</code> define control of an address by a pool; the structure is the same as <code>clusters</code> without the timeframe.</li>
-</ul>
+<p><code>addresses</code> defines ownership information about addresses. As with
+clusters, for each address the pool ownership information defines the pool's
+name and a public source of information about the ownership.  Each file's
+structure is as follows:</p>
+<pre><code>{
+  &quot;address1&quot;: {&quot;name&quot;: &quot;Pool P2&quot;, &quot;source&quot;: &quot;example.com&quot;},
+}
+</code></pre>
+<p><code>clusters</code> defines information about pool clusters. This information is
+organized per cluster. For each cluster, an array of pool-related information is
+defined. Each item in the array defines the pool's name, the time window during
+which the pool belonged to the cluster (from the beginning of <code>from</code> until the
+beginning of <code>to</code> <em>excluding</em>), and the <em>publicly available</em> source of
+information, via which the link between the pool and the cluster is established.
+Each file's structure is as follows:</p>
+<pre><code>{
+  &quot;cluster A&quot;: [
+      {&quot;name&quot;: &quot;P1&quot;, &quot;from&quot;: &quot;&quot;, &quot;to&quot;: &quot;2023&quot;, &quot;source&quot;: &quot;example.com/link1&quot;}
+  ],
+  &quot;cluster B&quot;: [
+      {&quot;name&quot;: &quot;--P2--&quot;, &quot;from&quot;: &quot;&quot;, &quot;to&quot;: &quot;&quot;, &quot;source&quot;: &quot;example.com/link2&quot;}
+  ]
+}
+</code></pre>
 <h4 id="pool-ownership">Pool Ownership</h4>
 <p>The file <code>helpers/legal_links.json</code> defines legal links between pools and companies, based on off-chain information.
 For example, it defines ownership information of a pool by a company.