@ethersproject/signing-key

What is @ethersproject/signing-key?

@ethersproject/signing-key is a part of the ethers.js library, which provides utilities for handling cryptographic signing keys. It allows you to create, manage, and use signing keys for cryptographic operations, particularly in the context of Ethereum and other blockchain technologies.

What are @ethersproject/signing-key's main functionalities?

Creating a Signing Key

This feature allows you to create a new signing key from a given private key. The SigningKey object can then be used for various cryptographic operations.

const { SigningKey } = require('@ethersproject/signing-key');
const privateKey = '0x0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef';
const signingKey = new SigningKey(privateKey);
console.log(signingKey);

Signing a Message

This feature allows you to sign a message using the signing key. The message is first hashed, and then the hash is signed to produce a signature.

const { SigningKey } = require('@ethersproject/signing-key');
const privateKey = '0x0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef';
const signingKey = new SigningKey(privateKey);
const message = 'Hello, world!';
const messageHash = ethers.utils.keccak256(ethers.utils.toUtf8Bytes(message));
const signature = signingKey.signDigest(messageHash);
console.log(signature);

Recovering a Public Key

This feature allows you to recover the public key from a signed message. This can be useful for verifying the authenticity of a message.

const { SigningKey } = require('@ethersproject/signing-key');
const privateKey = '0x0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef';
const signingKey = new SigningKey(privateKey);
const message = 'Hello, world!';
const messageHash = ethers.utils.keccak256(ethers.utils.toUtf8Bytes(message));
const signature = signingKey.signDigest(messageHash);
const recoveredPublicKey = SigningKey.recoverPublicKey(messageHash, signature);
console.log(recoveredPublicKey);

Other packages similar to @ethersproject/signing-key

elliptic

The elliptic package is a widely-used library for elliptic curve cryptography in JavaScript. It provides a comprehensive set of tools for working with elliptic curves, including key generation, signing, and verification. Compared to @ethersproject/signing-key, elliptic is more general-purpose and not specifically tailored for Ethereum.

secp256k1

The secp256k1 package is a native binding to the secp256k1 library used in Bitcoin and Ethereum for elliptic curve cryptography. It offers high-performance cryptographic operations but requires native compilation. Unlike @ethersproject/signing-key, it is more low-level and may require more effort to integrate into applications.

noble-secp256k1

The noble-secp256k1 package is a pure JavaScript implementation of the secp256k1 elliptic curve. It is designed to be fast and secure, with no dependencies. It provides similar functionalities to @ethersproject/signing-key but is focused on being lightweight and easy to use in various environments.

README

Signing Key

This sub-module is part of the ethers project.

It is responsible for secp256-k1 signing, verifying and recovery operations.

For more information, see the documentation.

Importing

Most users will prefer to use the umbrella package, but for those with more specific needs, individual components can be imported.

const {

    SigningKey,

    computePublicKey,
    recoverPublicKey

} = require("@ethersproject/signing-key");

License

MIT License