Skip to content

Latest commit

 

History

History
335 lines (199 loc) · 12.3 KB

CHANGELOG.md

File metadata and controls

335 lines (199 loc) · 12.3 KB
Raw

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

@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)
    • Stream#getPartitionCount()
    • Stream#getDescription() and Stream#setDescription()
    • Stream#getStorageDayCount() and Stream#setStorageDayCount()
  • 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
  • Upgrade StreamRegistry from v4 to v5 (#2780)
  • Network-level changes:
    • avoid routing through proxy connections (#2801)
    • internal record StreamPartitionInfo format changed (#2738, #2790)

Deprecated

Removed

  • BREAKING CHANGE: Remove Stream#detectFields() method (#2864)
  • BREAKING CHANGE: Remove Stream#delete() method (#2863)
    • use StreamrClient#deleteStream() instead
  • 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)

Security

@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

Deprecated

Removed

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

Fixed

  • Fix operator flag voting behavior when using custom gas estimation (#2784)

Security

@streamr/cli-tools

Added

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

Deprecated

Removed

Fixed

Security

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 NodeJS v18 compatibility (#2462)

@streamr/node

Changed

  • Update Docker runtime to NodeJS 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)