Class StreamrClient

Hierarchy

StreamrClient

Constructors

constructor

new StreamrClient(options?: Partial<Omit<StrictStreamrClientConfig, "network" | "contracts" | "decryption"> & {
    contracts: Partial<{
        ethereumNetworks: Record<string, EthereumNetworkConfig>;
        mainChainRPCs?: ChainConnectionInfo;
        maxConcurrentCalls: number;
        storageNodeRegistryChainAddress: string;
        streamRegistryChainAddress: string;
        streamRegistryChainRPCs: ChainConnectionInfo;
        streamStorageRegistryChainAddress: string;
        theGraphUrl: string;
    }>;
    decryption: Partial<{
        keyRequestTimeout: number;
        maxKeyRequestsPerSecond: number;
    }>;
    network: Partial<Omit<NetworkNodeConfig, "trackers" | "metricsContext"> & {
        trackers: TrackerRegistryContract | TrackerRegistryRecord[];
    }>;
}>, parentContainer?: default): StreamrClient
Parameters
- options: Partial<Omit<StrictStreamrClientConfig, "network" | "contracts" | "decryption"> & {
      contracts: Partial<{
          ethereumNetworks: Record<string, EthereumNetworkConfig>;
          mainChainRPCs?: ChainConnectionInfo;
          maxConcurrentCalls: number;
          storageNodeRegistryChainAddress: string;
          streamRegistryChainAddress: string;
          streamRegistryChainRPCs: ChainConnectionInfo;
          streamStorageRegistryChainAddress: string;
          theGraphUrl: string;
      }>;
      decryption: Partial<{
          keyRequestTimeout: number;
          maxKeyRequestsPerSecond: number;
      }>;
      network: Partial<Omit<NetworkNodeConfig, "trackers" | "metricsContext"> & {
          trackers: TrackerRegistryContract | TrackerRegistryRecord[];
      }>;
  }> = {}
- parentContainer: default = rootContainer
Returns StreamrClient

Properties

connect

connect: ((...args: []) => Promise<void>) & {
isStarted(): boolean;
reset(): void;
} = ...

destroy

destroy: ((...args: []) => Promise<void>) & {
isStarted(): boolean;
reset(): void;
} = ...

`Readonly` id

id: string

`Static` `Readonly` generateEthereumAccount

generateEthereumAccount: (() => {
address: string;
privateKey: string;
}) = _generateEthereumAccount

Type declaration

- (): {
  address: string;
  privateKey: string;
  }
- Returns {
  address: string;
  privateKey: string;
  }
  - address: string
  - privateKey: string

Important Methods

createStream

createStream(propsOrStreamIdOrPath: string | Partial<StreamMetadata> & {
id: string;
}): Promise<Stream>
Parameters
- propsOrStreamIdOrPath: string | Partial<StreamMetadata> & {
  id: string;
  }
Returns Promise<Stream>

getOrCreateStream

getOrCreateStream(props: {
id: string;
partitions?: number;
}): Promise<Stream>
Parameters
- props: {
  id: string;
  partitions?: number;
  }
  - id: string
  - Optional partitions?: number
Returns Promise<Stream>

getStream

getStream(streamIdOrPath: string): Promise<Stream>
Parameters
- streamIdOrPath: string
Returns Promise<Stream>

getSubscriptions

getSubscriptions(streamDefinition?: StreamDefinition): Promise<Subscription<unknown>[]>
Get subscriptions matching streamId or streamId + streamPartition
Parameters
- Optional streamDefinition: StreamDefinition
Returns Promise<Subscription<unknown>[]>

publish

publish<T>(streamDefinition: StreamDefinition, content: T, metadata?: PublishMetadata): Promise<Message>
Type Parameters
- T
Parameters
- streamDefinition: StreamDefinition
- content: T
- Optional metadata: PublishMetadata
Returns Promise<Message>

resend

resend<T>(streamDefinition: StreamDefinition, options: ResendOptions, onMessage?: MessageListener<T, unknown>): Promise<MessageStream<T>>
Call last/from/range as appropriate based on arguments
Type Parameters
- T
Parameters
- streamDefinition: StreamDefinition
- options: ResendOptions
- Optional onMessage: MessageListener<T, unknown>
Returns Promise<MessageStream<T>>

subscribe<T>(options: Object, onMessage?: MessageListener<T, unknown>): Promise<Subscription<T>>
Type Parameters
- T
Parameters
- options: Object
- Optional onMessage: MessageListener<T, unknown>
Returns Promise<Subscription<T>>

unsubscribe

unsubscribe(streamDefinitionOrSubscription?: StreamDefinition | Subscription<unknown>): Promise<unknown>
Parameters
- Optional streamDefinitionOrSubscription: StreamDefinition | Subscription<unknown>
Returns Promise<unknown>

Other Methods

addEncryptionKey

addEncryptionKey(key: EncryptionKey, streamIdOrPath: string): Promise<void>
Parameters
- key: EncryptionKey
- streamIdOrPath: string
Returns Promise<void>

addStreamToStorageNode

addStreamToStorageNode(streamIdOrPath: string, nodeAddress: string): Promise<void>
Parameters
- streamIdOrPath: string
- nodeAddress: string
Returns Promise<void>

closeProxyConnections

closeProxyConnections(streamDefinition: StreamDefinition, nodeIds: string[], direction: ProxyDirection): Promise<void>
Parameters
- streamDefinition: StreamDefinition
- nodeIds: string[]
- direction: ProxyDirection
Returns Promise<void>

deleteStream

deleteStream(streamIdOrPath: string): Promise<void>
Parameters
- streamIdOrPath: string
Returns Promise<void>

getAddress

getAddress(): Promise<EthereumAddress>
Returns Promise<EthereumAddress>

getNode

getNode(): Promise<NetworkNodeStub>
Get started network node

Deprecated
This in an internal method

Returns Promise<NetworkNodeStub>

getPermissions

getPermissions(streamIdOrPath: string): Promise<PermissionAssignment[]>
Parameters
- streamIdOrPath: string
Returns Promise<PermissionAssignment[]>

getStorageNodeMetadata

getStorageNodeMetadata(nodeAddress: string): Promise<StorageNodeMetadata>
Parameters
- nodeAddress: string
Returns Promise<StorageNodeMetadata>

getStorageNodes

getStorageNodes(streamIdOrPath?: string): Promise<EthereumAddress[]>
Parameters
- Optional streamIdOrPath: string
Returns Promise<EthereumAddress[]>

getStoredStreams

getStoredStreams(nodeAddress: string): Promise<{
blockNumber: number;
streams: Stream[];
}>
Parameters
- nodeAddress: string
Returns Promise<{
blockNumber: number;
streams: Stream[];
}>

getStreamPublishers

getStreamPublishers(streamIdOrPath: string): AsyncIterable<EthereumAddress>
Parameters
- streamIdOrPath: string
Returns AsyncIterable<EthereumAddress>

getStreamSubscribers

getStreamSubscribers(streamIdOrPath: string): AsyncIterable<EthereumAddress>
Parameters
- streamIdOrPath: string
Returns AsyncIterable<EthereumAddress>

grantPermissions

grantPermissions(streamIdOrPath: string, ...assignments: PermissionAssignment[]): Promise<void>
Parameters
- streamIdOrPath: string
- Rest ...assignments: PermissionAssignment[]
Returns Promise<void>

hasPermission

hasPermission(query: PermissionQuery): Promise<boolean>
Parameters
- query: PermissionQuery
Returns Promise<boolean>

isStoredStream

isStoredStream(streamIdOrPath: string, nodeAddress: string): Promise<boolean>
Parameters
- streamIdOrPath: string
- nodeAddress: string
Returns Promise<boolean>

isStreamPublisher

isStreamPublisher(streamIdOrPath: string, userAddress: string): Promise<boolean>
Parameters
- streamIdOrPath: string
- userAddress: string
Returns Promise<boolean>

isStreamSubscriber

isStreamSubscriber(streamIdOrPath: string, userAddress: string): Promise<boolean>
Parameters
- streamIdOrPath: string
- userAddress: string
Returns Promise<boolean>

off

off<T>(eventName: T, listener: StreamrClientEvents[T]): void
Type Parameters
- T extends keyof StreamrClientEvents
Parameters
- eventName: T
- listener: StreamrClientEvents[T]
Returns void

on

on<T>(eventName: T, listener: StreamrClientEvents[T]): void
Type Parameters
- T extends keyof StreamrClientEvents
Parameters
- eventName: T
- listener: StreamrClientEvents[T]
Returns void

once

once<T>(eventName: T, listener: StreamrClientEvents[T]): void
Type Parameters
- T extends keyof StreamrClientEvents
Parameters
- eventName: T
- listener: StreamrClientEvents[T]
Returns void

openProxyConnections

openProxyConnections(streamDefinition: StreamDefinition, nodeIds: string[], direction: ProxyDirection): Promise<void>
Parameters
- streamDefinition: StreamDefinition
- nodeIds: string[]
- direction: ProxyDirection
Returns Promise<void>

removeStreamFromStorageNode

removeStreamFromStorageNode(streamIdOrPath: string, nodeAddress: string): Promise<void>
Parameters
- streamIdOrPath: string
- nodeAddress: string
Returns Promise<void>

revokePermissions

revokePermissions(streamIdOrPath: string, ...assignments: PermissionAssignment[]): Promise<void>
Parameters
- streamIdOrPath: string
- Rest ...assignments: PermissionAssignment[]
Returns Promise<void>

searchStreams

searchStreams(term: undefined | string, permissionFilter: undefined | SearchStreamsPermissionFilter): AsyncIterable<Stream>
Parameters
- term: undefined | string
- permissionFilter: undefined | SearchStreamsPermissionFilter
Returns AsyncIterable<Stream>

setPermissions

setPermissions(...items: {
assignments: PermissionAssignment[];
streamId: string;
}[]): Promise<void>
Parameters
- Rest ...items: {
  assignments: PermissionAssignment[];
  streamId: string;
  }[]
Returns Promise<void>

setStorageNodeMetadata

setStorageNodeMetadata(metadata: undefined | StorageNodeMetadata): Promise<void>
Parameters
- metadata: undefined | StorageNodeMetadata
Returns Promise<void>

updateEncryptionKey

updateEncryptionKey(opts: UpdateEncryptionKeyOptions): Promise<void>
Parameters
- opts: UpdateEncryptionKeyOptions
Returns Promise<void>

updateStream

updateStream(props: Partial<StreamMetadata> & {
id: string;
}): Promise<Stream>
Parameters
- props: Partial<StreamMetadata> & {
  id: string;
  }
Returns Promise<Stream>

waitForStorage

waitForStorage(message: Message, options?: {
    count?: number;
    interval?: number;
    messageMatchFn?: ((msgTarget: Message, msgGot: Message) => boolean);
    timeout?: number;
}): Promise<void>
Parameters
- message: Message
- Optional options: {
      count?: number;
      interval?: number;
      messageMatchFn?: ((msgTarget: Message, msgGot: Message) => boolean);
      timeout?: number;
  }
  - Optional count?: number
  - Optional interval?: number
  - Optional messageMatchFn?: ((msgTarget: Message, msgGot: Message) => boolean)
    - (msgTarget: Message, msgGot: Message): boolean
      
      Parameters
      
      msgTarget: Message
      
      msgGot: Message
      
      Returns boolean
  - Optional timeout?: number
Returns Promise<void>

Class StreamrClient

Hierarchy

Index

Constructors

Properties

Methods - Important

Methods - Other

Constructors

constructor

Parameters

parentContainer: default = rootContainer

Returns StreamrClient

Properties

connect

destroy

Readonly id

Static Readonly generateEthereumAccount

Type declaration

Returns { address: string; privateKey: string; }

address: string

privateKey: string

Important Methods

createStream

Parameters

propsOrStreamIdOrPath: string | Partial<StreamMetadata> & { id: string; }

Returns Promise<Stream>

getOrCreateStream

Parameters

props: { id: string; partitions?: number; }

id: string

Optional partitions?: number

Returns Promise<Stream>

getStream

Parameters

streamIdOrPath: string

Returns Promise<Stream>

getSubscriptions

Parameters

Optional streamDefinition: StreamDefinition

Returns Promise<Subscription<unknown>[]>

publish

Type Parameters

T

Parameters

streamDefinition: StreamDefinition

content: T

Optional metadata: PublishMetadata

Returns Promise<Message>

resend

Type Parameters

T

Parameters

streamDefinition: StreamDefinition

options: ResendOptions

Optional onMessage: MessageListener<T, unknown>

Returns Promise<MessageStream<T>>

subscribe

Type Parameters

T

Parameters

options: Object

Optional onMessage: MessageListener<T, unknown>

Returns Promise<Subscription<T>>

unsubscribe

Parameters

Optional streamDefinitionOrSubscription: StreamDefinition | Subscription<unknown>

Returns Promise<unknown>

Other Methods

addEncryptionKey

Parameters

key: EncryptionKey

streamIdOrPath: string

Returns Promise<void>

addStreamToStorageNode

Parameters

streamIdOrPath: string

nodeAddress: string

Returns Promise<void>

closeProxyConnections

Parameters

`Readonly` id

`Static` `Readonly` generateEthereumAccount

Returns {
address: string;
privateKey: string;
}

propsOrStreamIdOrPath: string | Partial<StreamMetadata> & {
id: string;
}

props: {
id: string;
partitions?: number;
}

`Optional` partitions?: number

`Optional` streamDefinition: StreamDefinition

`Optional` metadata: PublishMetadata

`Optional` onMessage: MessageListener<T, unknown>

`Optional` onMessage: MessageListener<T, unknown>

`Optional` streamDefinitionOrSubscription: StreamDefinition | Subscription<unknown>

`Optional` streamIdOrPath: string

Returns Promise<{
blockNumber: number;
streams: Stream[];
}>

`Rest` ...assignments: PermissionAssignment[]