@metamask/network-controller
Version:
Provides an interface to the currently selected network via a MetaMask-compatible provider object
57 lines • 2.72 kB
text/typescript
import type { ServicePolicy } from "@metamask/controller-utils";
import type { Json, JsonRpcParams, JsonRpcRequest, JsonRpcResponse } from "@metamask/utils";
import type { CockatielEventToEventListenerWithData, ExcludeCockatielEventData, ExtendCockatielEventData, ExtractCockatielEventData, FetchOptions } from "./shared.cjs";
/**
* The interface for a service class responsible for making a request to a
* target, whether that is a single RPC endpoint or an RPC endpoint in an RPC
* service chain.
*/
export type RpcServiceRequestable = {
/**
* Listens for when the RPC service retries the request.
*
* @param listener - The callback to be called when the retry occurs.
* @returns What {@link ServicePolicy.onRetry} returns.
* @see {@link createServicePolicy}
*/
onRetry(listener: CockatielEventToEventListenerWithData<ServicePolicy['onRetry'], {
endpointUrl: string;
}>): ReturnType<ServicePolicy['onRetry']>;
/**
* Listens for when the RPC service retries the request too many times in a
* row.
*
* @param listener - The callback to be called when the circuit is broken.
* @returns What {@link ServicePolicy.onBreak} returns.
* @see {@link createServicePolicy}
*/
onBreak(listener: (data: ExcludeCockatielEventData<ExtendCockatielEventData<ExtractCockatielEventData<ServicePolicy['onBreak']>, {
endpointUrl: string;
}>, 'isolated'>) => void): ReturnType<ServicePolicy['onBreak']>;
/**
* Listens for when the policy underlying this RPC service detects a slow
* request.
*
* @param listener - The callback to be called when the request is slow.
* @returns What {@link ServicePolicy.onDegraded} returns.
* @see {@link createServicePolicy}
*/
onDegraded(listener: CockatielEventToEventListenerWithData<ServicePolicy['onDegraded'], {
endpointUrl: string;
}>): ReturnType<ServicePolicy['onDegraded']>;
/**
* Listens for when the policy underlying this RPC service is available.
*
* @param listener - The callback to be called when the request is available.
* @returns What {@link ServicePolicy.onDegraded} returns.
* @see {@link createServicePolicy}
*/
onAvailable(listener: CockatielEventToEventListenerWithData<ServicePolicy['onAvailable'], {
endpointUrl: string;
}>): ReturnType<ServicePolicy['onAvailable']>;
/**
* Makes a request to the target.
*/
request<Params extends JsonRpcParams, Result extends Json>(jsonRpcRequest: Readonly<JsonRpcRequest<Params>>, fetchOptions?: FetchOptions): Promise<JsonRpcResponse<Result | null>>;
};
//# sourceMappingURL=rpc-service-requestable.d.cts.map