@metamask/eth-sig-util

What is @metamask/eth-sig-util?

@metamask/eth-sig-util is a utility library for Ethereum signature operations. It provides functions for signing and verifying messages, encoding and decoding data, and other cryptographic operations related to Ethereum.

What are @metamask/eth-sig-util's main functionalities?

Sign Typed Data

This feature allows you to sign typed data using a private key. The `signTypedData` function takes a private key and a message parameter, and returns a signature.

const { signTypedData } = require('@metamask/eth-sig-util');
const privateKey = Buffer.from('your-private-key', 'hex');
const msgParams = {
  data: [{
    type: 'string',
    name: 'message',
    value: 'Hello, world!'
  }]
};
const signature = signTypedData({ privateKey, data: msgParams.data });
console.log(signature);

Recover Typed Signature

This feature allows you to recover the address that signed a typed data message. The `recoverTypedSignature` function takes a message parameter and a signature, and returns the address that signed the message.

const { recoverTypedSignature } = require('@metamask/eth-sig-util');
const msgParams = {
  data: [{
    type: 'string',
    name: 'message',
    value: 'Hello, world!'
  }]
};
const signature = 'your-signature';
const address = recoverTypedSignature({ data: msgParams.data, sig: signature });
console.log(address);

Encrypt and Decrypt Data

This feature allows you to encrypt and decrypt data using public and private keys. The `encrypt` function takes a public key and data, and returns encrypted data. The `decrypt` function takes a private key and encrypted data, and returns the decrypted data.

const { encrypt, decrypt } = require('@metamask/eth-sig-util');
const publicKey = 'recipient-public-key';
const data = 'Hello, world!';
const encryptedData = encrypt({ publicKey, data });
console.log(encryptedData);
const privateKey = Buffer.from('your-private-key', 'hex');
const decryptedData = decrypt({ privateKey, encryptedData });
console.log(decryptedData);

Other packages similar to @metamask/eth-sig-util

eth-sig-util

eth-sig-util is a utility library for Ethereum signature operations, similar to @metamask/eth-sig-util. It provides functions for signing and verifying messages, encoding and decoding data, and other cryptographic operations related to Ethereum. It is often used in conjunction with other Ethereum libraries.

ethereumjs-util

ethereumjs-util is a collection of utility functions for Ethereum. It includes functions for signing and verifying messages, encoding and decoding data, and other cryptographic operations. It is a more general-purpose library compared to @metamask/eth-sig-util, which is specifically focused on signature utilities.

ethers

ethers is a complete Ethereum library and wallet implementation. It includes utilities for signing and verifying messages, interacting with smart contracts, and managing wallets. While it offers similar functionalities to @metamask/eth-sig-util, it is a more comprehensive library for Ethereum development.

README

@metamask/eth-sig-util

A small collection of Ethereum signing functions.

You can find usage examples here

Available on NPM

Installation

yarn add @metamask/eth-sig-util

or

npm install @metamask/eth-sig-util

API

The full API documentation for the latest published version of this library is available here.

Contributing

Setup

• Install Node.js version 12
  • If you are using nvm (recommended) running nvm use will automatically choose the right node version for you.
• Install Yarn v1
• Run yarn setup to install dependencies and run any requried post-install scripts
  • Warning: Do not use the yarn / yarn install command directly. Use yarn setup instead. The normal install command will skip required post-install scripts, leaving your development environment in an invalid state.

Testing and Linting

Run yarn test to run the tests once. To run tests on file changes, run yarn test:watch.

Run yarn lint to run the linter, or run yarn lint:fix to run the linter and fix any automatically fixable issues.

Documentation

The API documentation can be generated with the command yarn docs, which saves it in the ./docs directory. Open the ./docs/index.html file to browse the documentation.

Release & Publishing

The project follows the same release process as the other libraries in the MetaMask organization. The GitHub Actions action-create-release-pr and action-publish-release are used to automate the release process; see those repositories for more information about how they work.

1. Choose a release version.

   • The release version should be chosen according to SemVer. Analyze the changes to see whether they include any breaking changes, new features, or deprecations, then choose the appropriate SemVer version. See the SemVer specification for more information.

2. If this release is backporting changes onto a previous release, then ensure there is a major version branch for that version (e.g. 1.x for a v1 backport release).

   • The major version branch should be set to the most recent release with that major version. For example, when backporting a v1.0.2 release, you'd want to ensure there was a 1.x branch that was set to the v1.0.1 tag.

3. Trigger the workflow_dispatch event manually for the Create Release Pull Request action to create the release PR.

   • For a backport release, the base branch should be the major version branch that you ensured existed in step 2. For a normal release, the base branch should be the main branch for that repository (which should be the default value).
   • This should trigger the action-create-release-pr workflow to create the release PR.

4. Update the changelog to move each change entry into the appropriate change category (See here for the full list of change categories, and the correct ordering), and edit them to be more easily understood by users of the package.

   • Generally any changes that don't affect consumers of the package (e.g. lockfile changes or development environment changes) are omitted. Exceptions may be made for changes that might be of interest despite not having an effect upon the published package (e.g. major test improvements, security improvements, improved documentation, etc.).
   • Try to explain each change in terms that users of the package would understand (e.g. avoid referencing internal variables/concepts).
   • Consolidate related changes into one change entry if it makes it easier to explain.
   • Run yarn auto-changelog validate --rc to check that the changelog is correctly formatted.

5. Review and QA the release.

   • If changes are made to the base branch, the release branch will need to be updated with these changes and review/QA will need to restart again. As such, it's probably best to avoid merging other PRs into the base branch while review is underway.

6. Squash & Merge the release.

   • This should trigger the action-publish-release workflow to tag the final release commit and publish the release on GitHub.

7. Publish the release on npm.

   • Be very careful to use a clean local environment to publish the release, and follow exactly the same steps used during CI.
   • Use npm publish --dry-run to examine the release contents to ensure the correct files are included. Compare to previous releases if necessary (e.g. using https://unpkg.com/browse/[package name]@[package version]/).
   • Once you are confident the release contents are correct, publish the release using npm publish.

Changelog

[5.0.0] [DEPRECATED]

Changed

• BREAKING: Removed support for Node v12 in favor of v14 (#137)
• Replace heavy crypto packages for lighter noble implementations via upgrading ethereumjs-util to latest (now called @ethereumjs/util) (#260)
• Migrate to Yarn 3 (#264)