Skip to content

rpcPath

function rpcPath(
protocol,
method,
opts?
): string;

Defined in: src/http/common.ts:38

Build the HTTP path for one RPC call: {prefix}/{protocol}/{method}.

The protocol segment is a required faithful projection of the request’s vgi_rpc.protocol metadata – present so an edge device can act on the protocol without an Arrow parser. The metadata remains canonical; see createHttpHandler for what happens when the two disagree.

Parameter Type Description
protocol string Routing key of the hosted protocol (vgi_rpc.Identity.v1).
method string RPC method name.
opts? { prefix?: string; suffix?: string; } -
opts.prefix? string Server mount prefix ("" or "/vgi").
opts.suffix? string "/init" or "/exchange" for stream endpoints.

string