Options
All
  • Public
  • Public/Protected
  • All
Menu

Module Config

Index

Interfaces

Type aliases Important

Type aliases Other

Variables Important

Variables Other

Functions

Important Type aliases

StrictStreamrClientConfig

StrictStreamrClientConfig: { auth: AuthConfig; cache: CacheConfig; dataUnion: DataUnionConfig; ensCacheChainAddress: EthereumAddress; id?: string; storageNodeRegistryChainAddress: EthereumAddress; streamRegistryChainAddress: EthereumAddress; streamStorageRegistryChainAddress: EthereumAddress; streamrNodeAddress: EthereumAddress } & (EthereumConfig & ConnectionConfig & SubscribeConfig & EncryptionConfig)

Other Type aliases

BrubeckClientConfig

BrubeckClientConfig: StreamrClientConfig & { debug?: Partial<DebugConfig>; network?: Omit<Partial<BrubeckNodeOptions>, "metricsContext"> }

BrubeckNodeOptions

BrubeckNodeOptions: Omit<NetworkNodeConfig, "trackers"> & { trackers: SmartContractRecord[] | TrackerRegistrySmartContract }

CacheConfig

CacheConfig: { maxAge: number; maxSize: number }

Type declaration

  • maxAge: number
  • maxSize: number

ConnectionConfig

ConnectionConfig: { autoConnect: boolean; autoDisconnect: boolean; restUrl: string; theGraphUrl: string }

Type declaration

  • autoConnect: boolean

    Automatically connect on first subscribe

  • autoDisconnect: boolean

    Automatically disconnect on last unsubscribe

  • restUrl: string

    Core HTTP API calls go here

  • theGraphUrl: string

    Some TheGraph instance, that indexes the streamr registries

DataUnionConfig

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

Type declaration

  • 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

DebugConfig

DebugConfig: { inspectOpts: InspectOptions }

Type declaration

  • inspectOpts: InspectOptions

StreamrClientConfig

StreamrClientConfig: Partial<Omit<StrictStreamrClientConfig, "dataUnion"> & { dataUnion: Partial<StrictStreamrClientConfig["dataUnion"]> }>

StrictBrubeckClientConfig

StrictBrubeckClientConfig: StrictStreamrClientConfig & { debug: DebugConfig; network: BrubeckNodeOptions }

SubscribeConfig

SubscribeConfig: { gapFill: boolean; gapFillTimeout: number; maxGapRequests: number; maxRetries: number; orderMessages: boolean; retryResendAfter: number; verifySignatures: "auto" | "always" | "never" }

Type declaration

  • gapFill: boolean
  • gapFillTimeout: number
  • maxGapRequests: number
  • maxRetries: number
  • orderMessages: boolean

    Attempt to order messages

  • retryResendAfter: number
  • verifySignatures: "auto" | "always" | "never"

TrackerRegistrySmartContract

TrackerRegistrySmartContract: { contractAddress: string; jsonRpcProvider?: ConnectionInfo }

Type declaration

  • contractAddress: string
  • Optional jsonRpcProvider?: ConnectionInfo

Important Variables

STREAM_CLIENT_DEFAULTS

STREAM_CLIENT_DEFAULTS: StrictStreamrClientConfig = ...

Other Variables

Config

Config: { Auth: symbol; Cache: symbol; Connection: symbol; Encryption: symbol; Ethereum: symbol; Network: symbol; Publish: symbol; Root: symbol; StorageNodeRegistry: symbol; Subscribe: symbol } = ...

DI Injection tokens for pieces of config. tsyringe needs a concrete value to use as the injection token. In the case of interfaces & types, these have no runtime value so we have to introduce some token to use for their injection. These symbols represent subsections of the full config.

For example: config.ethereum can be injected with a token like: @inject(Config.Ethereum)

Type declaration

  • Auth: symbol
  • Cache: symbol
  • Connection: symbol
  • Encryption: symbol
  • Ethereum: symbol
  • Network: symbol
  • Publish: symbol
  • Root: symbol
  • StorageNodeRegistry: symbol
  • Subscribe: symbol

DEFAULTS

DEFAULTS: { debug: { inspectOpts: { depth: number; maxStringLength: number } }; network: { acceptProxyConnections: boolean; trackers: { contractAddress: string } } } = ...

Type declaration

  • debug: { inspectOpts: { depth: number; maxStringLength: number } }
    • inspectOpts: { depth: number; maxStringLength: number }
      • depth: number
      • maxStringLength: number
  • network: { acceptProxyConnections: boolean; trackers: { contractAddress: string } }
    • acceptProxyConnections: boolean
    • trackers: { contractAddress: string }
      • contractAddress: string

STREAMR_STORAGE_NODE_GERMANY

STREAMR_STORAGE_NODE_GERMANY: "0x31546eEA76F2B2b3C5cC06B1c93601dc35c9D916" = '0x31546eEA76F2B2b3C5cC06B1c93601dc35c9D916'

Functions

default

Const validateConfig

  • validateConfig(data: unknown): void

Generated using TypeDoc