Merge branch 'main' into bump-typescript-5.6

Author: teogeb

.github/workflows/docker-build.yml

@@ -45,7 +45,7 @@ jobs:
         with:
           ref: ${{ inputs.branch }}
       - name: Cache Docker layers
-        uses: actions/[email protected].1
+        uses: actions/[email protected].2
         with:
           path: /tmp/.buildx-cache
           key: ${{ runner.os }}-buildx-v1-${{ github.sha }}
@@ -75,7 +75,7 @@ jobs:
 
       - name: Docker meta
         id: docker_meta_success
-        uses: docker/metadata-action@v5.5.1
+        uses: docker/metadata-action@v5.6.1
         if: ${{inputs.push_image}}
         with:
           images: ${{inputs.image_name}}
@@ -89,7 +89,7 @@ jobs:
 
       - name: Build
         if: ${{!inputs.push_image}}
-        uses: docker/build-push-action@v6.7.0
+        uses: docker/build-push-action@v6.10.0
         with:
           context: .
           file: ${{inputs.docker_file}}
@@ -114,7 +114,7 @@ jobs:
 
       - name: Build & Push
         if: ${{inputs.push_image}}
-        uses: docker/build-push-action@v6.7.0
+        uses: docker/build-push-action@v6.10.0
         with:
           context: .
           file: ${{inputs.docker_file}}

CHANGELOG.md

@@ -16,10 +16,11 @@ Changes before Tatum release are not documented in this file.
   - it is supported for `PUBLISH` and `SUBSCRIBE` permissions
   - new `StreamrClient#getUserId()` method
 - Method `StreamrClient#getDiagnosticInfo()` provides diagnostic info about network (https://github.com/streamr-dev/network/pull/2740, https://github.com/streamr-dev/network/pull/2741)
-- Add accessors for stream metadata fields: (https://github.com/streamr-dev/network/pull/2825, https://github.com/streamr-dev/network/pull/2845)
+- Add accessors for stream metadata fields: (https://github.com/streamr-dev/network/pull/2825, https://github.com/streamr-dev/network/pull/2845, https://github.com/streamr-dev/network/pull/2883)
   - `Stream#getPartitionCount()`
   - `Stream#getDescription()` and `Stream#setDescription()`
   - `Stream#getStorageDayCount()` and `Stream#setStorageDayCount()`
+- Add method `StreamrClient#getStreamMetadata()` (https://github.com/streamr-dev/network/pull/2883)
 - Add validation for public permissions (https://github.com/streamr-dev/network/pull/2819)
 - Add `opts` parameter to `StreamrClient#addStreamToStorageNode` (https://github.com/streamr-dev/network/pull/2858)
   - controls how long to wait for storage node to pick up on assignment
@@ -40,6 +41,10 @@ Changes before Tatum release are not documented in this file.
 - **BREAKING CHANGE:** Replace methods `StreamrClient#updateStream()` and `Stream#update()`: (https://github.com/streamr-dev/network/pull/2826, https://github.com/streamr-dev/network/pull/2855, https://github.com/streamr-dev/network/pull/2859, https://github.com/streamr-dev/network/pull/2862)
   - use `StreamrClient#setStreamMetadata()` and `Stream#setMetadata()` instead
   - both methods overwrite metadata instead of merging it
+- **BREAKING CHANGE:** Methods `Stream#getMetadata()` and `Stream#getStreamParts()` are async (https://github.com/streamr-dev/network/pull/2883)
+- Caching changes:
+  - storage node addresses (https://github.com/streamr-dev/network/pull/2877, https://github.com/streamr-dev/network/pull/2878)
+  - stream metadata and permissions (https://github.com/streamr-dev/network/pull/2889)
 - Upgrade `StreamRegistry` from v4 to v5 (https://github.com/streamr-dev/network/pull/2780)
 - Network-level changes:
   - avoid routing through proxy connections (https://github.com/streamr-dev/network/pull/2801) 
@@ -52,6 +57,7 @@ Changes before Tatum release are not documented in this file.
 - **BREAKING CHANGE:** Remove `Stream#detectFields()` method (https://github.com/streamr-dev/network/pull/2864)
 - **BREAKING CHANGE:** Remove `Stream#delete()` method (https://github.com/streamr-dev/network/pull/2863)
   - use `StreamrClient#deleteStream()` instead
+- **BREAKING CHANGE:** Remove `StreamrClient#findOperators()` method (https://github.com/streamr-dev/network/pull/2876)
 - Remove support for legacy encryption keys (https://github.com/streamr-dev/network/pull/2757)
 - Remove obsolete config options:
   - `network.node.id` (https://github.com/streamr-dev/network/pull/2777)
@@ -85,12 +91,15 @@ Changes before Tatum release are not documented in this file.
 
 #### Removed
 
-- **BREAKING CHANGE:** Remove deprecated `bin/config-wizard` script (i.e. the `streamr-broker-init` command)
+- **BREAKING CHANGE:** Remove deprecated `bin/config-wizard` script (i.e. the `streamr-broker-init` command) (https://github.com/streamr-dev/network/pull/2830)
   - use `streamr-node-init` command instead
+- **BREAKING CHANGE:** Remove deprecated command `streamr-broker` (https://github.com/streamr-dev/network/pull/2881)
+  - use `streamr-node` command instead
 
 #### Fixed
 
 - Fix operator flag voting behavior when using custom gas estimation (https://github.com/streamr-dev/network/pull/2784)
+- Fix a bug causing the inspection process to freeze (https://github.com/streamr-dev/network/pull/2893)
 
 #### Security
 

bin/run-nodes.sh

@@ -19,8 +19,8 @@ run_application() {
         { print "\033[38;2;" color "m" substr($0, 1, 1) substr($0, index($0, " "), length($0)); color = default_color }'
 }
 
-run_application node ./dist/bin/broker.js S1 '136;136;255' configs/development-1.env.json &
-run_application node ./dist/bin/broker.js B1 '0;136;255' configs/development-2.env.json &
-run_application node ./dist/bin/broker.js B2 '136;204;255' configs/development-3.env.json &
+run_application node ./dist/bin/streamr-node.js S1 '136;136;255' configs/development-1.env.json &
+run_application node ./dist/bin/streamr-node.js B1 '0;136;255' configs/development-2.env.json &
+run_application node ./dist/bin/streamr-node.js B2 '136;204;255' configs/development-3.env.json &
 
 wait

docs/.gitignore

@@ -7,7 +7,6 @@
 # Generated files
 .docusaurus
 .cache-loader
-/docs/usage/sdk/api
 
 # Misc
 .DS_Store
@@ -20,3 +19,6 @@ npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
 /.vscode
+
+# Autogenerated API documentation
+/docs/usage/sdk/api

docs/.nvmrc

@@ -10,5 +10,9 @@ For ease of use, small changes can be suggested by editing the markdown file on
 ### Run it locally
 Simply, `npm ci` & `npm start`
 
-## Streamr core devs
-Deployments are automatically made after every commit to `main`, therefore editing markdown files directly on `main` will be reflected in production within a minute or two.
+### Create & serve production build locally
+Simply, `npm ci` & `npm run build` & `npm run serve`
+
+### Clean & clear build folder
+Simply, `npm run clear`
+