Class HttpTransport

Low-level JSON-RPC 2.0 HTTP transport.

All Synapse SDK RPC calls flow through this class. It is instantiated once by SynapseClient and shared by every sub-module.

Since

1.0.0

Index

Constructors

Methods

Constructors

constructor

new HttpTransport(cfg): HttpTransport
Parameters
- cfg: TransportConfig
Returns HttpTransport
- Defined in src/core/transport.ts:79

Methods

batch

batch<T>(requests, opts?): Promise<T[]>
Execute a batch of JSON-RPC 2.0 calls in a single HTTP request.
Type Parameters
- T = unknown
  Expected result type for each call.
Parameters
- requests: {
  method: string;
  params?: unknown[];
  }[]
  Array of { method, params } objects.
- opts: CallOptions = {}
  Per-call overrides (applied to the batch request).
Returns Promise<T[]>
Array of results in the same order as requests.

Throws
If the batch exceeds the timeout.

Throws
On HTTP / network failures.

Since
1.0.0
- Defined in src/core/transport.ts:152

request

request<T>(method, params?, opts?): Promise<T>
Execute a single JSON-RPC 2.0 call.

Retries transparently on method-not-allowed (code -32601) up to maxRetries times, rotating upstreams if configured.
Type Parameters
- T = unknown
  Expected result type.
Parameters
- method: string
  RPC method name (e.g. 'getBalance').
- params: Record<string, unknown> | unknown[] = []
  Positional parameters array.
- opts: CallOptions = {}
  Per-call overrides.
Returns Promise<T>
The JSON-RPC result payload, typed as T.

Throws
If the request exceeds the timeout.

Throws
On HTTP / network failures.

Throws
If the upstream returns an RPC error with upstream metadata.

Throws
For all other RPC errors.

Since
1.0.0
- Defined in src/core/transport.ts:109