Class CardanoWsClient

Hierarchy

WsProvider
- CardanoWsClient

Constructors

constructor

new CardanoWsClient(deps: WsClientDependencies, cfg: WsClientConfiguration): CardanoWsClient
Parameters
- deps: WsClientDependencies
- cfg: WsClientConfiguration
Returns CardanoWsClient
Overrides WsProvider.constructor
- Defined in packages/cardano-services-client/src/WebSocket.ts:248

Properties

`Private` addresses

addresses: {
[key: PaymentAddress]: AddressStatus;
} = {}

Type declaration

[key: PaymentAddress]: AddressStatus

chainHistoryProvider

chainHistoryProvider: ChainHistoryProvider

WebSocket based ChainHistoryProvider implementation.

clientId

clientId: string = NOT_CONNECTED_ID

The client id, assigned by the server.

`Private` closePromise

closePromise: Promise<void>

`Private` closeResolver

closeResolver: (() => void)

Type declaration

- (): void
- Returns void

`Private` deferredRequests

deferredRequests: DeferredRequests = ...

epoch$

epoch$: Observable<EpochRollover>

Emits on epoch rollover.

`Private` epochSubject$

epochSubject$: Subject<EpochRollover>

`Private` handlers

handlers: Map<number, WSHandler> = ...

health$

health$: Observable<WSHealthCheckResponse>

Emits the health state.

`Private` heartbeatInterval

heartbeatInterval: number

`Private` heartbeatTimeout

heartbeatTimeout: undefined | Timeout

`Private` logger

logger: Logger

networkInfo

networkInfo: {
    eraSummaries$: Observable<EraSummary[]>;
    genesisParameters$: Observable<CompactGenesis>;
    ledgerTip$: Observable<PartialBlockHeader>;
    lovelaceSupply$: Observable<SupplySummary>;
    protocolParameters$: Observable<ProtocolParameters>;
    stake$: Observable<StakeSummary>;
}

The Observable form of NetworkInfoProvider.

Type declaration

eraSummaries$: Observable<EraSummary[]>
genesisParameters$: Observable<CompactGenesis>
ledgerTip$: Observable<PartialBlockHeader>
lovelaceSupply$: Observable<SupplySummary>
protocolParameters$: Observable<ProtocolParameters>
stake$: Observable<StakeSummary>

networkInfoProvider

networkInfoProvider: NetworkInfoProvider

WebSocket based NetworkInfoProvider implementation.

`Private` networkInfoSubjects

networkInfoSubjects: {
    eraSummaries$: ReplaySubject<EraSummary[]>;
    genesisParameters$: ReplaySubject<CompactGenesis>;
    ledgerTip$: ReplaySubject<PartialBlockHeader>;
    lovelaceSupply$: ReplaySubject<SupplySummary>;
    protocolParameters$: ReplaySubject<ProtocolParameters>;
    stake$: ReplaySubject<StakeSummary>;
} = ...

Type declaration

eraSummaries$: ReplaySubject<EraSummary[]>
genesisParameters$: ReplaySubject<CompactGenesis>
ledgerTip$: ReplaySubject<PartialBlockHeader>
lovelaceSupply$: ReplaySubject<SupplySummary>
protocolParameters$: ReplaySubject<ProtocolParameters>
stake$: ReplaySubject<StakeSummary>

`Private` requestId

requestId: number = 0

`Private` status

status: WSStatus = 'idle'

`Private` transactions

transactions: Txs = {}

`Private` url

url: URL

utxoProvider

utxoProvider: UtxoProvider

WebSocket based UtxoProvider implementation.

`Private` utxos

utxos: Txs = {}

`Private` ws

ws: WebSocket

Methods

close

close(): Promise<void>
Closes the WebSocket connection.

Returns Promise<void>
- Defined in packages/cardano-services-client/src/WebSocket.ts:461

`Private` connect

connect(): void
Returns void
- Defined in packages/cardano-services-client/src/WebSocket.ts:321

`Private` createNetworkInfoProviderMethod

createNetworkInfoProviderMethod<M>(method: M): (() => Promise<AsyncReturnType<NetworkInfoProvider[M]>>)
Type Parameters
- M extends NetworkInfoMethods
Parameters
- method: M
Returns (() => Promise<AsyncReturnType<NetworkInfoProvider[M]>>)
- - (): Promise<AsyncReturnType<NetworkInfoProvider[M]>>
  - Returns Promise<AsyncReturnType<NetworkInfoProvider[M]>>
- Defined in packages/cardano-services-client/src/WebSocket.ts:295

`Private` deferRequest

deferRequest(txsByAddresses: {
addresses: PaymentAddress[];
lower: BlockNo;
}, complete: ((error?: Error) => void)): void
Parameters
- txsByAddresses: {
  addresses: PaymentAddress[];
  lower: BlockNo;
  }
  - addresses: PaymentAddress[]
  - lower: BlockNo
- complete: ((error?: Error) => void)
  - - (error?: Error): void
    - Parameters
      
      Optional error: Error
      
      Returns void
Returns void
- Defined in packages/cardano-services-client/src/WebSocket.ts:564

`Protected` emitHealth

emitHealth(reason?: string | HealthCheckResponse, __namedParameters?: EmitHealthOptions): void
Parameters
- Optional reason: string | HealthCheckResponse
- __namedParameters: EmitHealthOptions = {}
Returns void
Inherited from WsProvider.emitHealth
- Defined in packages/cardano-services-client/src/WebSocket.ts:176

healthCheck

healthCheck(): Promise<WSHealthCheckResponse>
Returns Promise<WSHealthCheckResponse>
Inherited from WsProvider.healthCheck
- Defined in packages/cardano-services-client/src/WebSocket.ts:198

`Private` heartbeat

heartbeat(): void
Returns void
- Defined in packages/cardano-services-client/src/WebSocket.ts:447

`Private` request

request(request: WSMessage, handler?: WSHandler): boolean
Sends a request through WS to server.

Returns
true is sent, otherwise false.
Parameters
- request: WSMessage
  
  the request.
- Optional handler: WSHandler
Returns boolean
- Defined in packages/cardano-services-client/src/WebSocket.ts:474

`Private` transactionsByAddresses

transactionsByAddresses(args: TransactionsByAddressesArgs): Promise<Paginated<HydratedTx>>
Parameters
- args: TransactionsByAddressesArgs
Returns Promise<Paginated<HydratedTx>>
- Defined in packages/cardano-services-client/src/WebSocket.ts:491

`Private` utxoByAddresses

utxoByAddresses(__namedParameters: UtxoByAddressesArgs): Promise<[HydratedTxIn, TxOut][]>
Parameters
- __namedParameters: UtxoByAddressesArgs
Returns Promise<[HydratedTxIn, TxOut][]>
- Defined in packages/cardano-services-client/src/WebSocket.ts:590

Class CardanoWsClient

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

deps: WsClientDependencies

cfg: WsClientConfiguration

Returns CardanoWsClient

Properties

Private addresses

Type declaration

[key: PaymentAddress]: AddressStatus

chainHistoryProvider

clientId

Private closePromise

Private closeResolver

Type declaration

Returns void

Private deferredRequests

epoch$

Private epochSubject$

Private handlers

health$

Private heartbeatInterval

Private heartbeatTimeout

Private logger

networkInfo

Type declaration

eraSummaries$: Observable<EraSummary[]>

genesisParameters$: Observable<CompactGenesis>

ledgerTip$: Observable<PartialBlockHeader>

lovelaceSupply$: Observable<SupplySummary>

protocolParameters$: Observable<ProtocolParameters>

stake$: Observable<StakeSummary>

networkInfoProvider

Private networkInfoSubjects

Type declaration

eraSummaries$: ReplaySubject<EraSummary[]>

genesisParameters$: ReplaySubject<CompactGenesis>

ledgerTip$: ReplaySubject<PartialBlockHeader>

lovelaceSupply$: ReplaySubject<SupplySummary>

protocolParameters$: ReplaySubject<ProtocolParameters>

stake$: ReplaySubject<StakeSummary>

Private requestId

Private status

Private transactions

Private url

utxoProvider

Private utxos

Private ws

Methods

close

Returns Promise<void>

Private connect

Returns void

Private createNetworkInfoProviderMethod

Type Parameters

M extends NetworkInfoMethods

Parameters

method: M

Returns (() => Promise<AsyncReturnType<NetworkInfoProvider[M]>>)

Returns Promise<AsyncReturnType<NetworkInfoProvider[M]>>

Private deferRequest

Parameters

txsByAddresses: { addresses: PaymentAddress[]; lower: BlockNo; }

addresses: PaymentAddress[]

lower: BlockNo

complete: ((error?: Error) => void)

Parameters

Optional error: Error

Returns void

Returns void

Protected emitHealth

Parameters

Optional reason: string | HealthCheckResponse

__namedParameters: EmitHealthOptions = {}

`Private` addresses

`Private` closePromise

`Private` closeResolver

`Private` deferredRequests

`Private` epochSubject$

`Private` handlers

`Private` heartbeatInterval

`Private` heartbeatTimeout

`Private` logger

`Private` networkInfoSubjects

`Private` requestId

`Private` status

`Private` transactions

`Private` url

`Private` utxos

`Private` ws

`Private` connect

`Private` createNetworkInfoProviderMethod

`Private` deferRequest

txsByAddresses: {
addresses: PaymentAddress[];
lower: BlockNo;
}

`Optional` error: Error

`Protected` emitHealth

`Optional` reason: string | HealthCheckResponse

`Private` heartbeat

`Private` request

`Optional` handler: WSHandler

`Private` transactionsByAddresses

`Private` utxoByAddresses