Module StreamrClientConfig

Type declaration

• auth: { apiKey?: string; ethereum?: EthereumConfig; password?: string; privateKey?: BytesLike; username?: string }

  Authentication: identity used by this StreamrClient instance. Can contain member privateKey or (window.)ethereum

  • Optional apiKey?: string

  • Optional ethereum?: EthereumConfig

  • Optional password?: string

  • Optional privateKey?: BytesLike

  • Optional username?: string

• autoConnect: boolean

  Automatically connect on first subscribe

• autoDisconnect: boolean

  Automatically disconnect on last unsubscribe

• cache: { maxAge: number; maxSize: number }

  • maxAge: number

  • maxSize: number

• dataUnion: { factoryMainnetAddress: EthereumAddress; factorySidechainAddress: EthereumAddress; minimumWithdrawTokenWei: BigNumber | number | string; payForTransport: boolean; templateMainnetAddress: EthereumAddress; templateSidechainAddress: EthereumAddress }

  • factoryMainnetAddress: EthereumAddress

  • factorySidechainAddress: EthereumAddress

  • minimumWithdrawTokenWei: BigNumber | number | string

    Threshold value set in AMB configs, smallest token amount to pass over the bridge if someone else pays for the gas when transporting the withdraw tx to mainnet; otherwise the client does the transport as self-service and pays the mainnet gas costs

  • payForTransport: boolean

  • templateMainnetAddress: EthereumAddress

  • templateSidechainAddress: EthereumAddress

• gapFillTimeout: number

• groupKeys: Todo

• Optional id?: string

  Custom human-readable debug id for client. Used in logging. Unique id will be generated regardless.

• keyExchange: Todo

• Optional mainnet?: ConnectionInfo | string

• maxGapRequests: number

• maxPublishQueueSize: number

• orderMessages: boolean

  Attempt to order messages

• publishWithSignature: Todo

• publisherStoreKeyHistory: boolean

• restUrl: string

  Core HTTP API calls go here

• retryResendAfter: number

• sidechain: ConnectionInfo & { chainId?: number }

• storageNode: { address: EthereumAddress; url: string }

  • address: EthereumAddress

  • url: string

• streamrNodeAddress: EthereumAddress

  joinPartAgent when using EE for join part handling

• tokenAddress: EthereumAddress

• tokenSidechainAddress: EthereumAddress

• url: string

  Websocket server to connect to

• verifySignatures: Todo