Skip to content

CHANGELOG.md

Latest commit

 

History

History
698 lines (427 loc) · 26.7 KB

CHANGELOG.md

File metadata and controls

698 lines (427 loc) · 26.7 KB

Changelog

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.

Changes before Tatum release are not documented in this file.

Unreleased

Breaking Changes

General

Added

Changed

@streamr/sdk

Added

Changed

Fixed

@streamr/node

Added

Changed

Deprecated

Removed

Fixed

Security

@streamr/cli-tools

Added

Changed

Deprecated

Removed

Fixed

Security

103.3.1 - 2026-02-03

General

Added

  • Add timers-browserify polyfill to @streamr/dht for standalone browser usage (#3379)

103.3.0 - 2026-01-29

Breaking Changes

  • BREAKING CHANGE: The following packages no longer include all source files in dist. They now export bundled artifacts for ESM, CJS, and TypeScript declarations only:

    • @streamr/sdk
    • @streamr/utils
    • @streamr/dht
    • @streamr/proto-rpc
    • @streamr/test-utils
    • @streamr/autocertifier-client
    • @streamr/trackerless-network

    If you previously relied on importing internal files directly from dist, you must update your imports to use the package's public exports.

General

Added

  • Expose cross-environment cryptographic utilities from @streamr/utils for both browser and Node.js (#3342):
    • AES cipher utilities: createCipheriv, createDecipheriv
    • Hash functions: computeMd5, computeSha1
    • RSA utilities: publicEncrypt, privateDecrypt
    • Random bytes: randomBytes (re-exported from @noble/post-quantum/utils)
    • Types: CryptoKey, Jwk
  • Bundle a limited browser-compatible version of autocertifier-client (#3340)

Changed

@streamr/sdk

Added

  • Bundle @streamr/sdk for browser (no polyfills required!) and for Node.js (#3358)

Changed

  • BREAKING CHANGE: The package no longer provides a default export. Use named imports instead: import { StreamrClient } from '@streamr/sdk'. The UMD bundle remains accessible via window.StreamrClient. (#3358)
  • Use named StreamrClient export and explicit type import syntax (#3369)
  • Use named imports for EventEmitter from eventemitter3 (#3366)

Fixed

  • Resolve circular dependencies in the SDK package (#3361, #3367)
  • Clean-up tsyringe setup (#3362)
  • Fix ES module compatibility for migrations URL resolution (#3373)

@streamr/browser-test-runner

Added

  • Support TypeScript karma-setup files (#3368)

103.2.2 - 2026-01-19

General

Changed

  • Update package lock files

103.2.1 - 2026-01-19

General

Fixed

  • Fix outdated GitHub URLs referencing old network-monorepo repository instead of network (#3348)

@streamr/sdk

Changed

  • Resolve selected circular dependencies in the SDK package (#3351)

@streamr/utils

Changed

  • Make executeSafePromise work in browsers without polyfills (#3310)
  • Use explicit logger scopes instead of NodeJS-specific module (#3309, #3317)

Fixed

  • Fix logger id type handling after minimization

@streamr/autocertifier-server

Added

  • Delete unused DNS records in batches from Route53 (#3346)

Fixed

  • Wait for acme-challenge record to propagate (#3347)
  • Add error handling for delete records operation (#3349)
  • Only delete existing records from Route53 (#3350)

103.2.0 - 2025-12-18

@streamr/sdk

Added

  • Proxy connections now support bidirectionality and it is the default behavior (#3260)
  • Add StreamrClient#findProxyNodes() function for discovering proxy nodes via Operator nodes (#3257)
  • Add StreamrClient#publishRaw() for publishing raw messages (#3280)
  • Add new keys configuration to the encryption section (#3284)
  • Add new validation configuration section (#3302)
  • Add new configuration options for controlling content delivery buffering (#3305)

Removed

  • Remove StreamrClient#findOperators() function which was marked as internal (#3257)

@streamr/node

Changed

  • Bump autostaker's fixed gas limit for actions from 500k gas to 750k gas

@streamr/cli-tools

Added

  • Add --partition flag to stream publish (#3262)
  • Add --with-metadata flag to stream publish (#3265)
  • Add --binary flag to stream publish and stream subcribe (#3282)
  • Add --raw flag to stream publish (#3282)

Fixed

  • Signature output in subscribe --with-metadata (#3245)
  • Error handling of --partition flag in subscribe (#3263)

103.1.2 - 2025-11-21

@streamr/sdk

Changed

  • Update default list of JSON RPC urls for Polygon (removed a dead one)

@streamr/node

Changed

Autostaker changes:

  • transaction timeouts (#3236)
  • queries filter by required block number (#3238)
  • autostaker fixes and optimizations (#3237)

103.1.1 - 2025-11-11

@streamr/sdk

Changed

  • Update default list of JSON RPC urls for Polygon (replace a dead one with a working one) (#3227)

@streamr/node

Changed

  • Autostaker changes: (#3227)
    • bump gas limit on stake/unstake calls by 20% to defend against too low estimates in case contract change rapidly changes
    • retry actions that fail in preflight check
    • guard against subgraph not being up to date when a new sponsorship event is seen on chain
    • broadcast autostaker stake/unstake transactions in parallel to speed up action execution

103.1.0 - 2025-10-14

@streamr/sdk

Added

  • Add support for using the plumtree optimization in stream partitions (#3147)
  • Add listenable event sponsorshipCreated (#3191)
  • Add config option contracts.sponsorshipFactoryChainAddress (#3191)

Changed

  • Optimize StreamrClient#searchStreams() (#3132)

103.0.0 - 2025-06-10

@streamr/sdk

Added

  • Add support for quantum resistant key exchange using ML-KEM (#3060)
  • Add support for quantum resistant signatures using ML-DSA (#3074)
  • Add support for ECDSA on secp256r1 curve (#3088)
  • Add new storage node address STREAMR_STORAGE_NODE_ADDRESS (#3020)
  • Add peaq environment (#3111)
  • Add iotex environment (#3142)

Changed

  • BREAKING CHANGE: Browser exports improved, but polyfills now required
  • BREAKING CHANGE: The string values in Message.signatureType now correspond with the KeyType values. This means the previously output value SECP256K1 is now ECDSA_SECP256K1_EVM.
  • BREAKING CHANGE: Rename groupKeyId field encryptionKeyId in Message interface (#3084)
  • BREAKING CHANGE: Node.js v20 or higher is required (#3138)

Deprecated

  • Deprecate storage node address STREAMR_STORAGE_NODE_GERMANY (#3020)

Removed

  • BREAKING CHANGE: Remove lit protocol integration and related config options encryption.litProtocolEnabled and encryption.litProtocolLogging (#3036)
  • BREAKING CHANGE: Remove StreamrClient#generateEthereumAccount() in favour of EthereumKeyPairIdentity#generate()
  • BREAKING CHANGE: Remove orderBy parameter from StreamrClient#searchStreams() (#3131)

Fixed

  • Fix memory leak in DhtNode (#3065)

@streamr/node

Added

  • Add experimental autostaker plugin that manages sponsorship staking and unstaking automatically for operators (#3086)

Changed

  • BREAKING CHANGE: Node.js v20 or higher is required (#3138)

@streamr/cli-tools

Added

  • CLI tool allows generating key pairs with streamr identity generate --key-type [...] (#3074)

Changed

  • BREAKING CHANGE: CLI tool command streamr wallet whoami is now streamr identity whoami (#3074)
  • BREAKING CHANGE: Node.js v20 or higher is required (#3138)

102.1.1 - 2025-04-29

@streamr/sdk

Changed

  • Update internal list of JSON RPC urls for Polygon

102.1.0 - 2025-02-19

@streamr/node

Fixed

  • Fix false flagging issue (#3006)

@streamr/cli-tools

Added

  • Add new sub command streamr storage-node register to register a storage node (#2982)
  • Add new sub command streamr storage-node unregister to unregister a storage node (#2982)
  • Add new sub command streamr storage-node show to display the metadata of a storage node (#2982)

102.0.0 - 2025-01-27

@streamr/sdk

Added

  • Add support for arbitrary length user IDs: (#2774, #2780)
    • it is supported for PUBLISH and SUBSCRIBE permissions
    • new StreamrClient#getUserId() method
  • Method StreamrClient#getDiagnosticInfo() provides diagnostic info about network (#2740, #2741)
  • Add accessors for stream metadata fields: (#2825, #2845, #2883)
    • Stream#getPartitionCount()
    • Stream#getDescription() and Stream#setDescription()
    • Stream#getStorageDayCount() and Stream#setStorageDayCount()
  • Add method StreamrClient#getStreamMetadata() (#2883)
  • Add validation for public permissions (#2819)
  • Add opts parameter to StreamrClient#addStreamToStorageNode (#2858)
    • controls how long to wait for storage node to pick up on assignment

Changed

  • BREAKING CHANGE: Rename user to userId in these interfaces: (#2811)
    • UserPermissionAssignment
      • used in grantPermissions(), revokePermissions(), getPermissions() and setPermissions()
    • UserPermissionQuery
      • used in hasPermission()
    • SearchStreamsPermissionFilter
      • used in searchStreams()
  • BREAKING CHANGE: Type StreamMetadata is Record<string, unknown> (#2825, #2845)
    • some new accessors available, see above
    • no default values are injected (#2851)
  • BREAKING CHANGE: Method Stream#addToStorageNode() doesn't wait for acknowledgment by default (#2810)
  • BREAKING CHANGE: Replace methods StreamrClient#updateStream() and Stream#update(): (#2826, #2855, #2859, #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 (#2883)
  • BREAKING CHANGE: Rename event streamRemovedFromFromStorageNode to streamRemovedFromStorageNode (#2930)
  • BREAKING CHANGE: Replace custom errors with StreamrClientError: (#2895, #2927)
    • StreamrClientError contains MessageID instead of StreamMessage
  • Caching changes:
    • storage node addresses (#2877, #2878)
    • stream metadata and permissions (#2889)
  • Upgrade StreamRegistry from v4 to v5 (#2780)
  • Network-level changes:
    • avoid routing through proxy connections (#2801)
    • internal record StreamPartitionInfo format changed (#2738, #2790)

Removed

  • BREAKING CHANGE: Remove Stream#detectFields() method (#2864)
  • BREAKING CHANGE: Remove Stream#delete() method (#2863)
    • use StreamrClient#deleteStream() instead
  • BREAKING CHANGE: Remove StreamrClient#findOperators() method (#2876)
  • Remove support for legacy encryption keys (#2757)
  • Remove obsolete config options:
    • network.node.id (#2777)
    • network.controlLayer.webNewrtcConnectionTimeout (#2776)

Fixed

  • Fix WebRTC connections in Firefox (#2746)
  • Fix flag expiration time in Operator#getExpiredFlags() (#2739)
  • Network-level fixes:
    • fix node discover in small topologies (e.g. ~2 nodes) (#2786)
    • fix to time-to-data spike scenarios (#2802)
    • make network node stop faster (#2736)
    • reject requests after disconnection events (#2760)
    • fix geoip database file validation (#2783)

@streamr/node

Added

  • Add new operator plugin config options (for testing purposes) (#2742)

Changed

  • The environment config option now applies additional settings if dev2 value is used (#2813)
    • e.g. disables entryPointDiscovery and metrics

Removed

  • BREAKING CHANGE: Remove deprecated bin/config-wizard script (i.e. the streamr-broker-init command) (#2830)
    • use streamr-node-init command instead
  • BREAKING CHANGE: Remove deprecated command streamr-broker (#2881)
    • use streamr-node command instead

Fixed

  • Fix operator flag voting behavior when using custom gas estimation (#2784)
  • Fix a bug causing the inspection process to freeze (#2893)
  • Fix analysis of WebRTC private address probing warning (#3070)

@streamr/cli-tools

Added

  • Add binary data support to streamr stream publish (#2947)
  • Add binary data support to streamr stream susbcribe (#2948)
  • Add binary data support to streamr mock-data generate command (#2946)

Changed

  • BREAKING CHANGE: Replace --dev flag with --env flag (#2817, #2834)
    • the --env flag supports multiple environments
    • if there is a value for environment in a config file, this overrides it
    • use --env dev2 for the development environment

101.1.2 - 2024-09-04

@streamr/sdk

Fixed

  • Fixed gas estimation in Operator#voteOnFlag (#2734)

101.1.1 - 2024-08-29

@streamr/sdk

Changed

  • Numerous improvements to time-to-data (#2723, #2724, #2726, #2727)
  • Reduce message propagation cache TTL from 30 seconds to 10 seconds (#2732)

@streamr/node

Changed

  • Optimize the "operator value breach" task to be less demanding on EVM RPCs (#2721)

Fixed

  • Add better checks to the "expired flag closing" task so that the likelihood of submitting reverting transactions to the blockchain is reduced (#2725)

101.1.0 - 2024-08-13

@streamr/sdk

Added

  • Add method findOperators to client (#2703)

Fixed

  • Fix operator review request event parsing (#2714)

@streamr/node

Added

  • Operators now register external RPC endpoints for accelerated stream entrypoint discovery (#2702)

Fixed

  • Fix propagation buffer TTL issue (#2682)
  • Fix operator review request event parsing (#2714)

101.0.1 - 2024-07-09

@streamr/sdk

Changed

101.0.0 - 2024-07-08

@streamr/sdk

Changed

  • Update ethers.js library to v6 (#2506)
  • Restructure contracts config section (#2581)
  • Improve reliability of JSON RPC interactions by adding retry redundancy (#2562, #2601)
  • Rename events (#2604, #2605) as denoted below
    • createStream => streamCreated
    • addToStorageNode => streamAddedToStorageNode
    • removeFromStorageNode => streamRemovedFromFromStorageNode
    • resendComplete => resendCompleted (on instances of Subscription)

Removed

  • Remove obsolete RPC provider options (#2583)

@streamr/node

Changed

  • Improve reliability of JSON RPC interactions by adding retry redundancy (#2562, #2601)

Deprecated

  • Deprecate command streamr-broker. Use streamr-node instead. (#2626)
  • Deprecate command streamr-broker-init. Use streamr-node-init instead. (#2626)

Fixed

  • Fix memory leak in SubscriberPlugin (#2578)

100.2.4 - 2024-05-06

@streamr/sdk

Added

  • New geolocation detection by Nodes improves start up times and the decentralization of the network (#2465)
  • Improved rejoining streams after losing internet connection (#2502)
  • Discovering stream neighbors is more efficient as offline nodes are cleaned-up by sending pings (#2501)

Fixed

  • Hanging connection issue with WebSocket clients (#2519)

@streamr/node

Added

  • Nodes provide geolocation detection for newly joining nodes (#2465)

@streamr/cli-tools

Removed

  • Removed `governance vote' command (#2538)

100.2.3 - 2024-04-15

@streamr/sdk

Fixed

100.2.2 - 2024-04-03

@streamr/sdk

Changed

  • Update internal list of JSON RPC urls for Polygon

100.2.1 - 2024-04-02

@streamr/sdk

Added

  • Add node ID to metrics messages (#2464)

Changed

  • Change the way in which the partition of the metrics stream is calculated (based on node ID) (#2468)

Fixed

  • Fix Node.js v18 compatibility (#2462)

@streamr/node

Changed

  • Update Docker runtime to Node.js v20 (#2466)

100.2.0 - 2024-03-28

@streamr/sdk

Added

100.1.2 - 2024-03-27

@streamr/sdk

Fixed

  • Update internal list of JSON RPC urls for Mumbai testnet

100.1.1 - 2024-03-26

@streamr/sdk

Fixed

  • Update internal list of JSON RPC urls for Polygon

100.1.0 - 2024-03-25

@streamr/sdk

Added

  • Add support for publishing messages on behalf of an ERC-1271 contract (#2423)
  • Add fields signatureType and groupKeyId to Message interface (#2423)
  • Add ability to disable websocket server (#2425)

Changed

  • Change websocket client library implementation used in Node.js (#2384)