DOCSEARCHbyAlgolia
Submit Docs

Streamr Network Documentation

website·Indexed 35 days ago

https://docs.streamr.network/

Documentation for the Streamr Network, covering the Streamr SDK, stream publishing and subscribing, data storage and retrieval, message ordering, and partitioning. Includes API references for stream management, identity, and smart contract pub/sub using ERC-1271.

Tokens
44.9K
Snippets
273
Records
427
Agent score
63%

What's inside Streamr

  1. Overview of Streamr end-to-end encryption

    The Streamr Network ensures confidentiality for private streams using end-to-end encryption. Messages published to non-public streams are automatically encrypted by the Streamr SDK using AES-256. For public streams, encryption is skipped. The publisher controls data access by sharing symmetric keys with authorized subscribers via a secure key exchange using RSA or ML-KEM-1024.

  2. Overview of Streamr stream permissions

    Stream permissions control who can read, write, and edit streams on the Network. These permissions are enforced by the on-chain stream registry, meaning updates require a small amount of POL tokens to fund the transaction. Permissions are assigned to a user's cryptographic Identity (public/private key pair). The stream creator typically holds all permissions by default.

    Available permissions:

    • PUBLISH: Ability to write data to a stream.
    • SUBSCRIBE: Ability to read data from a stream.
    • EDIT: Ability to modify stream details.
    • DELETE: Ability to delete the stream.
    • GRANT: Ability to share stream permissions with others.

  3. Overview of the DATA token utility

    The DATA token is an ERC-20 token used within the Streamr Network for project governance, incentivizing node operators, delegating stake, and for payments and visibility on the Streamr Hub dApp. While native to the Ethereum mainnet, it can be bridged to Polygon, BNB Chain, and Gnosis Chain. Staking and delegation specifically occur on the Polygon network.

  4. Overview of the Streamr Decentralized Data Network

    Streamr is an open-source, vendor-neutral peer-to-peer (P2P) network designed to replace centralized message brokers for real-time data transmission. It implements a publish/subscribe (pub-sub) protocol that allows humans, AI, and connected machines to share and monetize data across a scalable, permissionless infrastructure secured by a cryptographic ledger. It is primarily targeted at IoT, smart cities, business consortia, and Web 3.0 data economies.

  5. Overview of supported Streamr key types

    Streamr uses cryptographic keys to determine a user's identity and the signature algorithm used to ensure data authenticity and integrity. The choice of key type affects whether the identity can be used for stream management (smart contract interactions) and whether it provides quantum resistance.
    Key TypeIdentity ImplementationPub/SubStream ManagementQuantum Resistance
    ECDSA_SECP256K1_EVMEthereumKeyPairIdentity✅✅❌
    ECDSA_SECP256R1ECDSAKeyPairIdentity✅❌❌
    ML_DSA_87MLDSAKeyPairIdentity✅❌✅

  6. Understand the role and rewards of a Streamr Delegator

    Delegators are DATA token holders who provide liquidity to Operators. Instead of running their own nodes, Delegators delegate their tokens to Operators, who use them to stake into Sponsorships. In return, Delegators earn a share of the rewards generated by the Operator's work. This allows technically capable node runners to access more tokens for staking while allowing token holders to earn passive income.

  7. SponsorshipCreatedEvent interface properties

    The SponsorshipCreatedEvent provides details about a sponsorship creation event. It contains two read-only properties: sponsorshipContractAddress, which is the Ethereum address of the sponsorship contract, and streamId, which identifies the associated stream.
    interface SponsorshipCreatedEvent {
  readonly sponsorshipContractAddress: EthereumAddress;
  readonly streamId: StreamID;
}

  8. Understand the role of a Publisher in the Streamr Network

    A Publisher is a node that acts as the entry point for data into the Streamr network. Data typically originates from an adjacent application that interfaces with the Streamr node. The Publisher's primary goal is to deliver this data to Subscribers by relaying messages to other connected nodes in the network.

  9. Connect to Streamr nodes using supported protocols

    Streamr nodes include a plugin architecture that provides native support for HTTP, Websocket, and MQTT protocols. Because these protocols are widely supported across almost all programming languages, they can be used to publish and subscribe to data on the Streamr Network regardless of the application's language. Additionally, the plugin architecture allows nodes to perform tasks such as joining stream Sponsorships to relay data and earn DATA tokens.

  10. StreamCreationEvent interface properties

    The StreamCreationEvent interface provides details about a stream creation event, including the blockchain block number where it occurred, the stream's metadata, and its unique identifier.
    interface StreamCreationEvent {
  readonly blockNumber: number;
  readonly metadata: StreamMetadata;
  readonly streamId: StreamID;
}

  11. Understand Streamr network architecture and blockchain usage

    Streamr is not a blockchain; it is a P2P network of nodes that pipe real-time data streams (similar to BitTorrent). However, it utilizes the Polygon network (EVM contracts) to manage its stream registry, access control policies, and incentive mechanisms.

  12. Understand the Streamr Network decentralization and governance

    The Streamr Network is decentralized, allowing anyone to run a node or create a stream without permission. Governance is managed through improvement proposals, which are voted on by holders of the DATA token.