@metamask/snaps-rpc-methods
Version:
MetaMask Snaps JSON-RPC method implementations
139 lines • 5.77 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.getBip32PublicKeyImplementation = exports.getBip32PublicKeyBuilder = exports.Bip32PublicKeyArgsStruct = 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 superstruct_1 = require("@metamask/superstruct");
const utils_1 = require("@metamask/utils");
const utils_2 = require("../utils.cjs");
const targetName = 'snap_getBip32PublicKey';
exports.Bip32PublicKeyArgsStruct = (0, snaps_utils_1.bip32entropy)((0, superstruct_1.object)({
path: snaps_utils_1.Bip32PathStruct,
curve: snaps_utils_1.CurveStruct,
compressed: (0, superstruct_1.optional)((0, superstruct_1.boolean)()),
source: (0, superstruct_1.optional)((0, superstruct_1.string)()),
}));
/**
* The specification builder for the `snap_getBip32PublicKey` permission.
* `snap_getBip32PublicKey` lets the Snap retrieve public keys for a particular
* BIP-32 node.
*
* @param options - The specification builder options.
* @param options.messenger - The messenger.
* @param options.methodHooks - The RPC method hooks needed by the method implementation.
* @returns The specification for the `snap_getBip32PublicKey` permission.
*/
const specificationBuilder = ({ methodHooks, messenger, }) => {
return {
permissionType: permission_controller_1.PermissionType.RestrictedMethod,
targetName,
allowedCaveats: [snaps_utils_1.SnapCaveatType.PermittedDerivationPaths],
methodImplementation: getBip32PublicKeyImplementation({
methodHooks,
messenger,
}),
validator: ({ caveats }) => {
if (caveats?.length !== 1 ||
caveats[0].type !== snaps_utils_1.SnapCaveatType.PermittedDerivationPaths) {
throw rpc_errors_1.rpcErrors.invalidParams({
message: `Expected a single "${snaps_utils_1.SnapCaveatType.PermittedDerivationPaths}" caveat.`,
});
}
},
subjectTypes: [permission_controller_1.SubjectType.Snap],
};
};
const methodHooks = {
getUnlockPromise: true,
getClientCryptography: true,
};
/**
* Gets the [BIP-32](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki)
* public key for the derivation path specified by the `path` parameter. Note
* that this returns the public key, not the extended public key (`xpub`), or
* Ethereum address.
*
* @example
* ```json name="Manifest"
* {
* "initialPermissions": {
* "snap_getBip32PublicKey": [
* {
* "path": ["m", "44'", "3'", "0'", "0", "0"],
* "curve": "secp256k1"
* }
* ]
* }
* }
* ```
* ```ts name="Usage"
* // This example uses Dogecoin, which has a derivation path starting with
* // "m / 44' / 3'".
* const dogecoinPublicKey = await snap.request({
* method: 'snap_getBip32PublicKey',
* params: {
* // The path and curve must be specified in the initial permissions.
* path: ['m', "44'", "3'", "0'", "0", "0"],
* curve: 'secp256k1',
* compressed: false,
* },
* })
*
* // '0x...'
* console.log(dogecoinPublicKey)
* ```
*/
exports.getBip32PublicKeyBuilder = Object.freeze({
targetName,
specificationBuilder,
methodHooks,
actionNames: ['KeyringController:withKeyringV2Unsafe'],
});
/**
* Builds the method implementation for `snap_getBip32PublicKey`.
*
* @param options - The options.
* @param options.messenger - The messenger.
* @param options.methodHooks - The RPC method hooks.
* @param options.methodHooks.getUnlockPromise - A function that resolves once the MetaMask extension is unlocked
* and prompts the user to unlock their MetaMask if it is locked.
* @param options.methodHooks.getClientCryptography - A function to retrieve the cryptographic
* functions to use for the client.
* @returns The method implementation which returns a public key.
* @throws If the params are invalid.
*/
function getBip32PublicKeyImplementation({ methodHooks: { getUnlockPromise, getClientCryptography }, messenger, }) {
return async function getBip32PublicKey(args) {
await getUnlockPromise(true);
(0, utils_1.assertStruct)(args.params, exports.Bip32PublicKeyArgsStruct, 'Invalid BIP-32 public key params', rpc_errors_1.rpcErrors.invalidParams);
const { params } = args;
// Using the seed is much faster, but we can only do it for these specific curves.
if (params.curve === 'secp256k1' || params.curve === 'ed25519') {
const seed = await (0, utils_2.getValueFromEntropySource)(utils_2.getMnemonicSeed.bind(null, messenger), params.source);
const node = await (0, utils_2.getNodeFromSeed)({
curve: params.curve,
path: params.path,
seed,
cryptographicFunctions: getClientCryptography(),
});
if (params.compressed) {
return node.compressedPublicKey;
}
return node.publicKey;
}
const secretRecoveryPhrase = await (0, utils_2.getValueFromEntropySource)(utils_2.getMnemonic.bind(null, messenger), params.source);
const node = await (0, utils_2.getNodeFromMnemonic)({
curve: params.curve,
path: params.path,
secretRecoveryPhrase,
cryptographicFunctions: getClientCryptography(),
});
if (params.compressed) {
return node.compressedPublicKey;
}
return node.publicKey;
};
}
exports.getBip32PublicKeyImplementation = getBip32PublicKeyImplementation;
//# sourceMappingURL=getBip32PublicKey.cjs.map