Skip to main content

PortfolioStreamManager

@totemsdk/realtime


@totemsdk/realtime / PortfolioStreamManager

Class: PortfolioStreamManager

Constructors​

Constructor​

new PortfolioStreamManager(deps, config): PortfolioStreamManager

Parameters​

deps​

PortfolioStreamDependencies

config​

PortfolioStreamConfig

Returns​

PortfolioStreamManager

Methods​

addListener()​

addListener(listener): void

Parameters​

listener​

PortfolioStreamListener

Returns​

void


dispose()​

dispose(): void

Returns​

void


forceRefresh()​

forceRefresh(): Promise<void>

Force an immediate HTTP portfolio fetch. Rate-limited to once every 5 seconds.

Returns​

Promise<void>


getCachedPortfolio()​

getCachedPortfolio(address): Promise<PortfolioEntry[] | null>

Parameters​

address​

string

Returns​

Promise<PortfolioEntry[] | null>


getConnectionState()​

getConnectionState(): ConnectionState

Returns​

ConnectionState


getSnapshot()​

getSnapshot(addresses?): Promise<{ connectionState: ConnectionState; error?: string; portfolios: Record<string, PortfolioEntry[]>; }>

Get a snapshot of cached portfolios for a set of addresses.

Parameters​

addresses?​

string[]

Returns​

Promise<{ connectionState: ConnectionState; error?: string; portfolios: Record<string, PortfolioEntry[]>; }>


isCurrentlyStreaming()​

isCurrentlyStreaming(): boolean

Returns​

boolean


removeListener()​

removeListener(listener): void

Parameters​

listener​

PortfolioStreamListener

Returns​

void


start()​

start(addresses): Promise<void>

Parameters​

addresses​

string[]

Returns​

Promise<void>


stop()​

stop(): void

Returns​

void


triggerReplay()​

triggerReplay(): Promise<void>

Replay the current cache to all listeners without triggering a new subscription.

Returns​

Promise<void>


updateAddresses()​

updateAddresses(addresses): Promise<void>

Parameters​

addresses​

string[]

Returns​

Promise<void>