@metamask/snaps-rpc-methods
Version:
MetaMask Snaps JSON-RPC method implementations
100 lines • 4.34 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.transactionInsightCaveatSpecifications = exports.getTransactionOriginCaveat = exports.getTransactionInsightCaveatMapper = exports.transactionInsightEndowmentBuilder = void 0;
const permission_controller_1 = require("@metamask/permission-controller");
const rpc_errors_1 = require("@metamask/rpc-errors");
const snaps_utils_1 = require("@metamask/snaps-utils");
const utils_1 = require("@metamask/utils");
const caveats_1 = require("./caveats/index.cjs");
const enum_1 = require("./enum.cjs");
const permissionName = enum_1.SnapEndowments.TransactionInsight;
/**
* `endowment:transaction-insight` returns nothing; it is intended to be used as a flag
* by the extension to detect whether the snap has the capability to show information on the transaction confirmation screen.
*
* @param _builderOptions - Optional specification builder options.
* @returns The specification for the transaction-insight endowment.
*/
const specificationBuilder = (_builderOptions) => {
return {
permissionType: permission_controller_1.PermissionType.Endowment,
targetName: permissionName,
allowedCaveats: [
snaps_utils_1.SnapCaveatType.TransactionOrigin,
snaps_utils_1.SnapCaveatType.MaxRequestTime,
],
endowmentGetter: (_getterOptions) => null,
validator: (0, caveats_1.createGenericPermissionValidator)([
{ type: snaps_utils_1.SnapCaveatType.TransactionOrigin, optional: true },
{ type: snaps_utils_1.SnapCaveatType.MaxRequestTime, optional: true },
]),
subjectTypes: [permission_controller_1.SubjectType.Snap],
};
};
exports.transactionInsightEndowmentBuilder = Object.freeze({
targetName: permissionName,
specificationBuilder,
});
/**
* Validates the type of the caveat value.
*
* @param caveat - The caveat to validate.
* @throws If the caveat value is invalid.
*/
function validateCaveat(caveat) {
if (!(0, utils_1.hasProperty)(caveat, 'value') || !(0, utils_1.isPlainObject)(caveat)) {
throw rpc_errors_1.rpcErrors.invalidParams({
message: 'Expected a plain object.',
});
}
const { value } = caveat;
(0, utils_1.assert)(typeof value === 'boolean', 'Expected caveat value to have type "boolean"');
}
/**
* Map a raw value from the `initialPermissions` to a caveat specification.
* Note that this function does not do any validation, that's handled by the
* PermissionsController when the permission is requested.
*
* @param value - The raw value from the `initialPermissions`.
* @returns The caveat specification.
*/
function getTransactionInsightCaveatMapper(value) {
if (!value ||
!(0, utils_1.isObject)(value) ||
((0, utils_1.isObject)(value) && Object.keys(value).length === 0)) {
return { caveats: null };
}
return {
caveats: [
{
type: snaps_utils_1.SnapCaveatType.TransactionOrigin,
value: (0, utils_1.hasProperty)(value, 'allowTransactionOrigin') &&
value.allowTransactionOrigin,
},
],
};
}
exports.getTransactionInsightCaveatMapper = getTransactionInsightCaveatMapper;
/**
* Getter function to get the transaction origin caveat from a permission.
*
* This does basic validation of the caveat, but does not validate the type or
* value of the namespaces object itself, as this is handled by the
* `PermissionsController` when the permission is requested.
*
* @param permission - The permission to get the transaction origin caveat from.
* @returns The transaction origin, or `null` if the permission does not have a
* transaction origin caveat.
*/
function getTransactionOriginCaveat(permission) {
const caveat = permission?.caveats?.find((permCaveat) => permCaveat.type === snaps_utils_1.SnapCaveatType.TransactionOrigin);
return caveat?.value ?? null;
}
exports.getTransactionOriginCaveat = getTransactionOriginCaveat;
exports.transactionInsightCaveatSpecifications = {
[snaps_utils_1.SnapCaveatType.TransactionOrigin]: Object.freeze({
type: snaps_utils_1.SnapCaveatType.TransactionOrigin,
validator: (caveat) => validateCaveat(caveat),
}),
};
//# sourceMappingURL=transaction-insight.cjs.map