6.5 end-of-life release (#941)

dipdup-io · Mar 7, 2024 · 43c9308 · 43c9308
1 parent bd60888
commit 43c9308
Show file tree

Hide file tree

Showing 56 changed files with 1,593 additions and 1,514 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,22 @@ 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].
 
+## [6.5.16] - 2024-03-05
+
+This is the last release in the 6.5 branch. Please update to 7.x to get the latest features and bug fixes.
+
+### Fixed
+
+- tzkt: Don't use deprecated `/events` WebSockets endpoint.
+
+### Other
+
+- deps: Updated pytezos to 3.11.3.
+
+### Other
+
+- metadata: Added `oxfordnet` to supported networks.
+
 ## [6.5.15] - 2023-12-01
 
 ### Other
@@ -1074,7 +1090,7 @@ This release contains no changes except for the version number.
 [semantic versioning]: https://semver.org/spec/v2.0.0.html
 
 <!-- Versions -->
-[Unreleased]: https://github.com/dipdup-io/dipdup/compare/6.5.15...HEAD
+[6.5.16]: https://github.com/dipdup-io/dipdup/compare/6.5.15...6.5.16
 [6.5.15]: https://github.com/dipdup-io/dipdup/compare/6.5.14...6.5.15
 [6.5.14]: https://github.com/dipdup-io/dipdup/compare/6.5.13...6.5.14
 [6.5.13]: https://github.com/dipdup-io/dipdup/compare/6.5.12...6.5.13

diff --git a/demos/demo-big-maps/src/demo_big_maps/handlers/on_update_records.py b/demos/demo-big-maps/src/demo_big_maps/handlers/on_update_records.py
@@ -33,9 +33,9 @@ async def on_update_records(
                 defaults={
                     'tld_id': record_path[-1],
                     'owner': store_records.value.owner,
-                    'token_id': int(store_records.value.tzip12_token_id)
-                    if store_records.value.tzip12_token_id
-                    else None,
+                    'token_id': (
+                        int(store_records.value.tzip12_token_id) if store_records.value.tzip12_token_id else None
+                    ),
                 },
             )
 

diff --git a/demos/demo-events/src/demo_events/handlers/on_move_event.py b/demos/demo-events/src/demo_events/handlers/on_move_event.py
@@ -7,5 +7,4 @@
 async def on_move_event(
     ctx: HandlerContext,
     event: Event[MovePayload],
-) -> None:
-    ...
+) -> None: ...
diff --git a/demos/demo-events/src/demo_events/handlers/on_other_event.py b/demos/demo-events/src/demo_events/handlers/on_other_event.py
@@ -6,5 +6,4 @@
 async def on_other_event(
     ctx: HandlerContext,
     event: UnknownEvent,
-) -> None:
-    ...
+) -> None: ...
diff --git a/demos/demo-events/src/demo_events/handlers/on_roll_event.py b/demos/demo-events/src/demo_events/handlers/on_roll_event.py
@@ -7,5 +7,4 @@
 async def on_roll_event(
     ctx: HandlerContext,
     event: Event[RollPayload],
-) -> None:
-    ...
+) -> None: ...
diff --git a/demos/demo-head/src/demo_head/handlers/on_mainnet_head.py b/demos/demo-head/src/demo_head/handlers/on_mainnet_head.py
@@ -6,5 +6,4 @@
 async def on_mainnet_head(
     ctx: HandlerContext,
     head: HeadBlockData,
-) -> None:
-    ...
+) -> None: ...
diff --git a/docs/advanced/reindexing.md b/docs/advanced/reindexing.md
@@ -8,15 +8,15 @@ In some cases, DipDup can't proceed with indexing without a full wipe. Several r
 |`migration`|Applied migration requires reindexing. Check release notes before switching between major DipDup versions to be prepared.|
 |`rollback`|Reorg message received from TzKT can not be processed.|
 |`config_modified`|One of the index configs has been modified.|
-|`schema_modified`|Database schema has been modified. Try to avoid manual schema modifications in favor of {{ #summary advanced/sql.md }}.
+|`schema_modified`|Database schema has been modified. Try to avoid manual schema modifications in favor of {{ #summary advanced/sql.md }}.|
 
 It is possible to configure desirable action on reindexing triggered by a specific reason.
 
 |action|description|
 |-|-|
 |`exception` (default)|Raise `ReindexingRequiredError` and quit with error code. The safest option since you can trigger reindexing accidentally, e.g., by a typo in config. Don't forget to set up the correct restart policy when using it with containers. |
 |`wipe`|Drop the whole database and start indexing from scratch. Be careful with this option!|
-|`ignore`|Ignore the event and continue indexing as usual. It can lead to unexpected side-effects up to data corruption; make sure you know what you are doing.
+|`ignore`|Ignore the event and continue indexing as usual. It can lead to unexpected side-effects up to data corruption; make sure you know what you are doing.|
 
 To configure actions for each reason, add the following section to the DipDup config:
 

diff --git a/docs/book.css b/docs/book.css
@@ -51,4 +51,12 @@ img.logo {
 /* less ugly autodoc references */
 dd .field-odd {
     margin: 0;
+}
+
+#deprecated {
+    top: 0px;
+    position: sticky;
+    color: var(--text-color);
+    background-color: var(--sidebar-bg);
+    padding: 1em;
 }
diff --git a/docs/book.toml b/docs/book.toml
@@ -22,4 +22,4 @@ after = [ "links" ]
 
 [preprocessor.admonish]
 command = "mdbook-admonish"
-assets_version = "2.0.0" # do not edit: managed by `mdbook-admonish install`
+assets_version = "3.0.2" # do not edit: managed by `mdbook-admonish install`
diff --git a/docs/cli-reference.md b/docs/cli-reference.md
@@ -1,4 +1,5 @@
 <!-- markdownlint-disable first-line-h1 -->
+
   <section id="dipdup">
 <h1>dipdup<a class="headerlink" href="#dipdup" title="Link to this heading">¶</a></h1>
 <p>Manage and run DipDup indexers.</p>

diff --git a/docs/config/reference.md b/docs/config/reference.md
@@ -1,4 +1,5 @@
 <!-- markdownlint-disable first-line-h1 no-space-in-emphasis -->
+
   <dl class="py class">
 <dt class="sig sig-object py" id="DipDupConfig">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre"></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></em>, <em class="sig-param"><span class="n"><span class="pre">package</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">datasources=&lt;factory&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">database=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=&lt;factory&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">indexes=&lt;factory&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">templates=&lt;factory&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">jobs=&lt;factory&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hooks=&lt;factory&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hasura=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sentry=SentryConfig(dsn=''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">environment=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">server_name=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">release=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_id=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">debug=False)</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prometheus=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">advanced=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">decimal_precision=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">alt_operation_matcher=False)</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">custom=&lt;factory&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">logging=LoggingValues.default</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#DipDupConfig" title="Link to this definition">¶</a></dt>

diff --git a/docs/deployment/database-engines.md b/docs/deployment/database-engines.md
@@ -5,7 +5,7 @@ DipDup officially supports the following databases: SQLite, PostgreSQL, Timescal
 | | SQLite | PostgreSQL | TimescaleDB |
 | -: | :-: | :-: | :-: |
 | Supported versions | `latest` | `13`, `14` | `pg13`, `pg14` |
-| Best application | development | general usage | working with timeseries
+| Best application | development | general usage | working with timeseries|
 | SQL scripts | ✅ | ✅ | ✅ |
 | Immune tables | ❌ | ✅ | ✅ |
 | Hasura integration | ❌ | ✅ | ✅ |

diff --git a/docs/include/context-reference.md b/docs/include/context-reference.md
@@ -1,4 +1,5 @@
 <!-- markdownlint-disable first-line-h1 -->
+
   <dl class="py class">
 <dt class="sig sig-object py" id="dipdup.context.DipDupContext">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">dipdup.context.</span></span><span class="sig-name descname"><span class="pre">DipDupContext</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">datasources</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">config</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">callbacks</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">transactions</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#dipdup.context.DipDupContext" title="Link to this definition">¶</a></dt>