Class SynapseClient

Name

SynapseClient

Description

The core client for interacting with the Synapse RPC Gateway. This class handles all low-level communication with the gateway, including request serialization, response deserialization, and error handling.

Author

SteveTheHead

Author

0xArmorer

Hierarchy

EventEmitter
- SynapseClient

Index

Constructors

constructor

new SynapseClient(config): SynapseClient
Parameters
- config: SynapseConfig
Returns SynapseClient
Overrides EventEmitter.constructor
- Defined in packages/synapse-client-sdk/src/client.ts:26

Properties

`Static`prefixed

prefixed: string | boolean

Accessors

apiKey

get apiKey(): undefined | string
Get API key

Returns undefined | string
- Defined in packages/synapse-client-sdk/src/client.ts:60

endpoint

get endpoint(): string
Get endpoint URL

Returns string
- Defined in packages/synapse-client-sdk/src/client.ts:53

Methods

addListener

addListener<T>(event, fn, context?): this
Type Parameters
- T extends string | symbol
Parameters
- event: T
- fn: ((...args: any[]) => void)
  - - (...args): void
    - Parameters
      Rest...args: any[]
      Returns void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.addListener
- Defined in node_modules/.pnpm/eventemitter3@5.0.1/node_modules/eventemitter3/index.d.ts:45

batch

batch<T>(requests, options?): Promise<T[]>
Make multiple RPC calls in batch
Type Parameters
- T = any
Parameters
- requests: {
  method: string;
  params?: any[];
  }[]
- options: RequestOptions = {}
Returns Promise<T[]>
- Defined in packages/synapse-client-sdk/src/client.ts:197

call

call<T>(method, params?, options?): Promise<T>
Make a single RPC call Uses zero-copy operations, early returns, and minimal branching
Type Parameters
- T = any
Parameters
- method: string
- params: any = []
- options: RequestOptions = {}
Returns Promise<T>
- Defined in packages/synapse-client-sdk/src/client.ts:68

emit

emit<T>(event, ...args): boolean
Calls each of the listeners registered for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
- Rest...args: any[]
Returns boolean
Inherited from EventEmitter.emit
- Defined in node_modules/.pnpm/eventemitter3@5.0.1/node_modules/eventemitter3/index.d.ts:32

eventNames

eventNames(): (string | symbol)[]
Return an array listing the events for which the emitter has registered listeners.

Returns (string | symbol)[]
Inherited from EventEmitter.eventNames
- Defined in node_modules/.pnpm/eventemitter3@5.0.1/node_modules/eventemitter3/index.d.ts:15

getGatewayMetrics

getGatewayMetrics(): Promise<any>
Get gateway performance metrics

Returns Promise<any>
- Defined in packages/synapse-client-sdk/src/client.ts:353

getSignatureForAddress

getSignatureForAddress(address, options?): Promise<SignatureInfo[]>
Get a signature for a given address and message.
Parameters
- address: string
  The base-58 encoded account address (required).
- Optionaloptions: {
      before?: string;
      commitment?: string;
      limit?: number;
      minContextSlot?: number;
      until?: string;
  }
  Optional configuration object:
  - commitment: string
  - minContextSlot: number
  - limit: number
  - before: string
  - until: string
  - Optionalbefore?: string
  - Optionalcommitment?: string
  - Optionallimit?: number
  - OptionalminContextSlot?: number
  - Optionaluntil?: string
Returns Promise<SignatureInfo[]>
The signature info array.
- Defined in packages/synapse-client-sdk/src/client.ts:284

getStats

getStats(): ClientStats
Get client statistics

Returns ClientStats
- Defined in packages/synapse-client-sdk/src/client.ts:310

healthCheck

healthCheck(): Promise<boolean>
Health check

Returns Promise<boolean>
- Defined in packages/synapse-client-sdk/src/client.ts:335

listenerCount

listenerCount(event): number
Return the number of listeners listening to a given event.
Parameters
- event: string | symbol
Returns number
Inherited from EventEmitter.listenerCount
- Defined in node_modules/.pnpm/eventemitter3@5.0.1/node_modules/eventemitter3/index.d.ts:27

listeners

listeners<T>(event): ((...args: any[]) => void)[]
Return the listeners registered for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
Returns ((...args: any[]) => void)[]
Inherited from EventEmitter.listeners
- Defined in node_modules/.pnpm/eventemitter3@5.0.1/node_modules/eventemitter3/index.d.ts:20

off

off<T>(event, fn?, context?, once?): this
Type Parameters
- T extends string | symbol
Parameters
- event: T
- Optionalfn: ((...args: any[]) => void)
  - - (...args): void
    - Parameters
      Rest...args: any[]
      Returns void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from EventEmitter.off
- Defined in node_modules/.pnpm/eventemitter3@5.0.1/node_modules/eventemitter3/index.d.ts:69

on

on<T>(event, fn, context?): this
Add a listener for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
- fn: ((...args: any[]) => void)
  - - (...args): void
    - Parameters
      Rest...args: any[]
      Returns void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.on
- Defined in node_modules/.pnpm/eventemitter3@5.0.1/node_modules/eventemitter3/index.d.ts:40

once

once<T>(event, fn, context?): this
Add a one-time listener for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
- fn: ((...args: any[]) => void)
  - - (...args): void
    - Parameters
      Rest...args: any[]
      Returns void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.once
- Defined in node_modules/.pnpm/eventemitter3@5.0.1/node_modules/eventemitter3/index.d.ts:54

removeAllListeners

removeAllListeners(event?): this
Remove all listeners, or those of the specified event.
Parameters
- Optionalevent: string | symbol
Returns this
Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/.pnpm/eventemitter3@5.0.1/node_modules/eventemitter3/index.d.ts:79

removeListener

removeListener<T>(event, fn?, context?, once?): this
Remove the listeners of a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
- Optionalfn: ((...args: any[]) => void)
  - - (...args): void
    - Parameters
      Rest...args: any[]
      Returns void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from EventEmitter.removeListener
- Defined in node_modules/.pnpm/eventemitter3@5.0.1/node_modules/eventemitter3/index.d.ts:63

resetStats

resetStats(): void
Reset statistics

Returns void
- Defined in packages/synapse-client-sdk/src/client.ts:320

Class SynapseClient

Name

Description

Author

Author

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SynapseClient

Properties

Staticprefixed

Accessors

apiKey

Returns undefined | string

endpoint

Returns string

Methods

addListener

Type Parameters

Parameters

Parameters

Returns void

Returns this

batch

Type Parameters

Parameters

Returns Promise<T[]>

call

Type Parameters

Parameters

Returns Promise<T>

emit

Type Parameters

Parameters

Returns boolean

eventNames

Returns (string | symbol)[]

getGatewayMetrics

Returns Promise<any>

getSignatureForAddress

Parameters

Optionalbefore?: string

Optionalcommitment?: string

Optionallimit?: number

OptionalminContextSlot?: number

Optionaluntil?: string

Returns Promise<SignatureInfo[]>

getStats

Returns ClientStats

healthCheck

Returns Promise<boolean>

listenerCount

Parameters

Returns number

listeners

Type Parameters

Parameters

Returns ((...args: any[]) => void)[]

off

Type Parameters

Parameters

Parameters

Returns void

Returns this

on

Type Parameters

Parameters

Parameters

Returns void

Returns this

once

Type Parameters

Parameters

Parameters

`Static`prefixed

`Optional`before?: string

`Optional`commitment?: string

`Optional`limit?: number

`Optional`minContextSlot?: number

`Optional`until?: string