REVERT: postpone operation_unfiltered release (#537)

Author: droserasprout

CHANGELOG.md

@@ -4,13 +4,12 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog], and this project adheres to [Semantic Versioning].
 
-## [Unreleased]
+## [6.3.0] - 2022-11-15
 
 ### Added
 
 - context: Added `execute_sql_query` method to run queries from `sql` project directory.
 - context: `execute_sql` method now accepts arbitrary arguments to format SQL script (unsafe, use with caution).
-- index: New index kind `operation_unfiltered`.
 - index: New filters for `token_transfer` index.
 
 ### Fixed

demos/demo-tzbtc-transfers/src/demo_tzbtc_transfers/handlers/on_token_transfer.py

@@ -20,5 +20,5 @@ async def on_token_transfer(
     if not amount:
         return
 
-    await on_balance_update(address=from_, balance_update=-amount, timestamp=token_transfer.timestamp)
-    await on_balance_update(address=to, balance_update=amount, timestamp=token_transfer.timestamp)
+    await on_balance_update(from_, -amount, token_transfer.timestamp)
+    await on_balance_update(to, amount, token_transfer.timestamp)

docs/SUMMARY.md

@@ -18,7 +18,6 @@
   * [Contract events](indexes/event.md)
   * [Head blocks](indexes/head.md)
   * [Operations](indexes/operation.md)
-  * [Unfiltered operations](indexes/operation_unfiltered.md)
   * [Token transfers](indexes/token_transfer.md)
 * [Advanced usage](advanced/README.md)
   * [Datasources](advanced/datasources.md)

docs/config/indexes.md

@@ -0,0 +1 @@
+*See {{ #summary indexes/README.md }} character*

docs/config/reference.md

@@ -132,7 +132,7 @@ inheritance.</p>
 
 <dl class="py class">
 <dt class="sig sig-object py" id="dipdup.config.DipDupConfig">
-<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">dipdup.config.</span></span><span class="sig-name descname"><span class="pre">DipDupConfig</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spec_version:</span> <span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">package:</span> <span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">datasources:</span> <span class="pre">dict[str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dipdup.config.TzktDatasourceConfig</span> <span class="pre">|</span> <span class="pre">dipdup.config.CoinbaseDatasourceConfig</span> <span class="pre">|</span> <span class="pre">dipdup.config.MetadataDatasourceConfig</span> <span class="pre">|</span> <span class="pre">dipdup.config.IpfsDatasourceConfig</span> <span class="pre">|</span> <span class="pre">dipdup.config.HttpDatasourceConfig]</span> <span class="pre">=</span> <span class="pre">&lt;factory&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">database:</span> <span class="pre">dipdup.config.SqliteDatabaseConfig</span> <span class="pre">|</span> <span class="pre">dipdup.config.PostgresDatabaseConfig</span> <span class="pre">=</span> <span class="pre">SqliteDatabaseConfig(kind='sqlite'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path=':memory:')</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">contracts:</span> <span class="pre">dict[str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dipdup.config.ContractConfig]</span> <span class="pre">=</span> <span class="pre">&lt;factory&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">indexes:</span> <span class="pre">dict[str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dipdup.config.OperationIndexConfig</span> <span class="pre">|</span> <span class="pre">dipdup.config.BigMapIndexConfig</span> <span class="pre">|</span> <span class="pre">dipdup.config.HeadIndexConfig</span> <span class="pre">|</span> <span class="pre">dipdup.config.TokenTransferIndexConfig</span> <span class="pre">|</span> <span class="pre">dipdup.config.OperationUnfilteredIndexConfig</span> <span class="pre">|</span> <span class="pre">dipdup.config.EventIndexConfig</span> <span class="pre">|</span> <span class="pre">dipdup.config.IndexTemplateConfig]</span> <span class="pre">=</span> <span class="pre">&lt;factory&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">templates:</span> <span class="pre">dict[str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dipdup.config.OperationIndexConfig</span> <span class="pre">|</span> <span class="pre">dipdup.config.BigMapIndexConfig</span> <span class="pre">|</span> <span class="pre">dipdup.config.HeadIndexConfig</span> <span class="pre">|</span> <span class="pre">dipdup.config.TokenTransferIndexConfig</span> <span class="pre">|</span> <span class="pre">dipdup.config.OperationUnfilteredIndexConfig</span> <span class="pre">|</span> <span class="pre">dipdup.config.EventIndexConfig]</span> <span class="pre">=</span> <span class="pre">&lt;factory&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">jobs:</span> <span class="pre">dict[str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dipdup.config.JobConfig]</span> <span class="pre">=</span> <span class="pre">&lt;factory&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hooks:</span> <span class="pre">dict[str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dipdup.config.HookConfig]</span> <span class="pre">=</span> <span class="pre">&lt;factory&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hasura:</span> <span class="pre">~typing.Optional[~dipdup.config.HasuraConfig]</span> <span class="pre">=</span> <span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sentry:</span> <span class="pre">~typing.Optional[~dipdup.config.SentryConfig]</span> <span class="pre">=</span> <span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prometheus:</span> <span class="pre">~typing.Optional[~dipdup.config.PrometheusConfig]</span> <span class="pre">=</span> <span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">advanced:</span> <span class="pre">~dipdup.config.AdvancedConfig</span> <span class="pre">=</span> <span class="pre">AdvancedConfig(reindex={}</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scheduler=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">postpone_jobs=False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">early_realtime=False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">merge_subscriptions=False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata_interface=False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">skip_version_check=False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rollback_depth=2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">crash_reporting=False)</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">custom:</span> <span class="pre">dict[str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">typing.Any]</span> <span class="pre">=</span> <span class="pre">&lt;factory&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">logging:</span> <span class="pre">~dipdup.enums.LoggingValues</span> <span class="pre">=</span> <span class="pre">LoggingValues.default</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#dipdup.config.DipDupConfig" title="Permalink to this definition">¶</a></dt>
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">dipdup.config.</span></span><span class="sig-name descname"><span class="pre">DipDupConfig</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">spec_version:</span> <span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">package:</span> <span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">datasources:</span> <span class="pre">dict[str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dipdup.config.TzktDatasourceConfig</span> <span class="pre">|</span> <span class="pre">dipdup.config.CoinbaseDatasourceConfig</span> <span class="pre">|</span> <span class="pre">dipdup.config.MetadataDatasourceConfig</span> <span class="pre">|</span> <span class="pre">dipdup.config.IpfsDatasourceConfig</span> <span class="pre">|</span> <span class="pre">dipdup.config.HttpDatasourceConfig]</span> <span class="pre">=</span> <span class="pre">&lt;factory&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">database:</span> <span class="pre">dipdup.config.SqliteDatabaseConfig</span> <span class="pre">|</span> <span class="pre">dipdup.config.PostgresDatabaseConfig</span> <span class="pre">=</span> <span class="pre">SqliteDatabaseConfig(kind='sqlite'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path=':memory:')</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">contracts:</span> <span class="pre">dict[str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dipdup.config.ContractConfig]</span> <span class="pre">=</span> <span class="pre">&lt;factory&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">indexes:</span> <span class="pre">dict[str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dipdup.config.OperationIndexConfig</span> <span class="pre">|</span> <span class="pre">dipdup.config.BigMapIndexConfig</span> <span class="pre">|</span> <span class="pre">dipdup.config.HeadIndexConfig</span> <span class="pre">|</span> <span class="pre">dipdup.config.TokenTransferIndexConfig</span> <span class="pre">|</span> <span class="pre">dipdup.config.EventIndexConfig</span> <span class="pre">|</span> <span class="pre">dipdup.config.IndexTemplateConfig]</span> <span class="pre">=</span> <span class="pre">&lt;factory&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">templates:</span> <span class="pre">dict[str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dipdup.config.OperationIndexConfig</span> <span class="pre">|</span> <span class="pre">dipdup.config.BigMapIndexConfig</span> <span class="pre">|</span> <span class="pre">dipdup.config.HeadIndexConfig</span> <span class="pre">|</span> <span class="pre">dipdup.config.TokenTransferIndexConfig</span> <span class="pre">|</span> <span class="pre">dipdup.config.EventIndexConfig]</span> <span class="pre">=</span> <span class="pre">&lt;factory&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">jobs:</span> <span class="pre">dict[str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dipdup.config.JobConfig]</span> <span class="pre">=</span> <span class="pre">&lt;factory&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hooks:</span> <span class="pre">dict[str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dipdup.config.HookConfig]</span> <span class="pre">=</span> <span class="pre">&lt;factory&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hasura:</span> <span class="pre">~typing.Optional[~dipdup.config.HasuraConfig]</span> <span class="pre">=</span> <span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sentry:</span> <span class="pre">~typing.Optional[~dipdup.config.SentryConfig]</span> <span class="pre">=</span> <span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prometheus:</span> <span class="pre">~typing.Optional[~dipdup.config.PrometheusConfig]</span> <span class="pre">=</span> <span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">advanced:</span> <span class="pre">~dipdup.config.AdvancedConfig</span> <span class="pre">=</span> <span class="pre">AdvancedConfig(reindex={}</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scheduler=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">postpone_jobs=False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">early_realtime=False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">merge_subscriptions=False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata_interface=False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">skip_version_check=False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rollback_depth=2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">crash_reporting=False)</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">custom:</span> <span class="pre">dict[str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">typing.Any]</span> <span class="pre">=</span> <span class="pre">&lt;factory&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">logging:</span> <span class="pre">~dipdup.enums.LoggingValues</span> <span class="pre">=</span> <span class="pre">LoggingValues.default</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#dipdup.config.DipDupConfig" title="Permalink to this definition">¶</a></dt>
 <dd><p>Main indexer config</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
@@ -463,27 +463,6 @@ http: HTTP client configuration</p>
 
 </dd></dl>
 
-<dl class="py class">
-<dt class="sig sig-object py" id="dipdup.config.OperationUnfilteredHandlerConfig">
-<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">dipdup.config.</span></span><span class="sig-name descname"><span class="pre">OperationUnfilteredHandlerConfig</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">callback</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="s"><span class="pre">'str'</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#dipdup.config.OperationUnfilteredHandlerConfig" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="py class">
-<dt class="sig sig-object py" id="dipdup.config.OperationUnfilteredIndexConfig">
-<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">dipdup.config.</span></span><span class="sig-name descname"><span class="pre">OperationUnfilteredIndexConfig</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">kind:</span> <span class="pre">~typing.Literal['operation_unfiltered'],</span> <span class="pre">datasource:</span> <span class="pre">str</span> <span class="pre">|</span> <span class="pre">dipdup.config.TzktDatasourceConfig,</span> <span class="pre">handlers:</span> <span class="pre">tuple[dipdup.config.OperationUnfilteredHandlerConfig,</span> <span class="pre">...],</span> <span class="pre">types:</span> <span class="pre">tuple[dipdup.enums.OperationType,</span> <span class="pre">...]</span> <span class="pre">=</span> <span class="pre">(&lt;OperationType.origination:</span> <span class="pre">'origination'&gt;,),</span> <span class="pre">first_level:</span> <span class="pre">int</span> <span class="pre">=</span> <span class="pre">0,</span> <span class="pre">last_level:</span> <span class="pre">int</span> <span class="pre">=</span> <span class="pre">0</span></em><span class="sig-paren">)</span><a class="headerlink" href="#dipdup.config.OperationUnfilteredIndexConfig" title="Permalink to this definition">¶</a></dt>
-<dd><p>Operation index config</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>kind</strong> – always <cite>operation_unfiltered</cite></p></li>
-<li><p><strong>handlers</strong> – List of indexer handlers</p></li>
-<li><p><strong>first_level</strong> – Level to start indexing from</p></li>
-<li><p><strong>last_level</strong> – Level to stop indexing at (DipDup will terminate at this level)</p></li>
-</ul>
-</dd>
-</dl>
-</dd></dl>
-
 <dl class="py class">
 <dt class="sig sig-object py" id="dipdup.config.ParameterTypeMixin">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">dipdup.config.</span></span><span class="sig-name descname"><span class="pre">ParameterTypeMixin</span></span><a class="headerlink" href="#dipdup.config.ParameterTypeMixin" title="Permalink to this definition">¶</a></dt>

docs/indexes/operation_unfiltered.md

@@ -6,6 +6,15 @@ This index allows indexing token transfers of contracts compatible with [FA1.2](
 {{ #include ../../demos/demo-tzbtc-transfers/dipdup.yml }}
 ```
 
+You can also filter transfers by token ID or sender/receiver address.
+
+```yaml
+    handlers:
+      - callback: on_token_transfer
+        token_id: 1
+        to: tzbtc_mainnet
+```
+
 Callback receives `TokenTransferData` model that optionally contains the transfer sender, receiver, amount, and token metadata.
 
 ```python