@metamask/snaps-rpc-methods
Version:
MetaMask Snaps JSON-RPC method implementations
75 lines • 2.57 kB
JavaScript
import { rpcErrors } from "@metamask/rpc-errors";
import { boolean, number, record, union, create, object, string, StructError, exactOptional } from "@metamask/superstruct";
import { JsonStruct } from "@metamask/utils";
const hookNames = {
startTrace: true,
};
const StartTraceParametersStruct = object({
data: exactOptional(record(string(), union([string(), number(), boolean()]))),
id: exactOptional(string()),
name: string(),
parentContext: exactOptional(JsonStruct),
startTime: exactOptional(number()),
tags: exactOptional(record(string(), union([string(), number(), boolean()]))),
});
/**
* Handler for the `snap_startTrace` method.
*
* @internal
*/
export const startTraceHandler = {
implementation: getStartTraceImplementation,
hookNames,
actionNames: ['SnapController:getSnap'],
};
/**
* The `snap_startTrace` method implementation. This method is used to start a
* performance trace in Sentry. It is only available to preinstalled Snaps.
*
* @param request - The JSON-RPC request object.
* @param response - The JSON-RPC response object.
* @param _next - The `json-rpc-engine` "next" callback. Not used by this
* function.
* @param end - The `json-rpc-engine` "end" callback.
* @param hooks - The RPC method hooks.
* @param hooks.startTrace - The hook function to start a performance trace.
* @param messenger - The messenger used to call controller actions.
* @returns Nothing.
*/
function getStartTraceImplementation(request, response, _next, end, { startTrace }, messenger) {
const snap = messenger.call('SnapController:getSnap', request.origin);
if (!snap?.preinstalled) {
return end(rpcErrors.methodNotFound());
}
const { params } = request;
try {
const validatedParams = getValidatedParams(params);
response.result = startTrace(validatedParams);
}
catch (error) {
return end(error);
}
return end();
}
/**
* Validate the parameters for the `snap_startTrace` method.
*
* @param params - Parameters to validate.
* @returns Validated parameters.
* @throws Throws RPC error if validation fails.
*/
function getValidatedParams(params) {
try {
return create(params, StartTraceParametersStruct);
}
catch (error) {
if (error instanceof StructError) {
throw rpcErrors.invalidParams({
message: `Invalid params: ${error.message}.`,
});
}
/* istanbul ignore next */
throw rpcErrors.internal();
}
}
//# sourceMappingURL=startTrace.mjs.map