@types/elliptic

What is @types/elliptic?

@types/elliptic provides TypeScript type definitions for the elliptic library, which is a JavaScript implementation of elliptic curve cryptography. This package allows developers to use elliptic with TypeScript, ensuring type safety and better development experience.

What are @types/elliptic's main functionalities?

Elliptic Curve Key Generation

This feature allows you to generate a new elliptic curve key pair using the secp256k1 curve. The code sample demonstrates how to create a key pair and extract the public and private keys in hexadecimal format.

const elliptic = require('elliptic');
const EC = new elliptic.ec('secp256k1');
const keyPair = EC.genKeyPair();
const publicKey = keyPair.getPublic('hex');
const privateKey = keyPair.getPrivate('hex');
console.log('Public Key:', publicKey);
console.log('Private Key:', privateKey);

Signing a Message

This feature allows you to sign a message using an elliptic curve key pair. The code sample demonstrates how to hash a message and sign it using the private key, then output the signature in DER format.

const elliptic = require('elliptic');
const EC = new elliptic.ec('secp256k1');
const keyPair = EC.genKeyPair();
const msg = 'Hello, world!';
const msgHash = EC.hash().update(msg).digest();
const signature = keyPair.sign(msgHash);
console.log('Signature:', signature.toDER('hex'));

Verifying a Signature

This feature allows you to verify a signature using an elliptic curve public key. The code sample demonstrates how to hash a message, sign it, and then verify the signature using the public key.

const elliptic = require('elliptic');
const EC = new elliptic.ec('secp256k1');
const keyPair = EC.genKeyPair();
const msg = 'Hello, world!';
const msgHash = EC.hash().update(msg).digest();
const signature = keyPair.sign(msgHash);
const isValid = keyPair.verify(msgHash, signature);
console.log('Signature valid:', isValid);

Other packages similar to @types/elliptic

secp256k1

The secp256k1 package provides bindings to the secp256k1 elliptic curve functions from the Bitcoin Core library. It is highly optimized for performance and is commonly used in cryptocurrency applications. Unlike @types/elliptic, it is a native module and requires compilation.

tweetnacl

TweetNaCl is a cryptographic library that provides high-level cryptographic functions, including elliptic curve cryptography. It is known for its simplicity and security. While it does not offer the same level of customization as elliptic, it is easier to use for common cryptographic tasks.

noble-secp256k1

Noble-secp256k1 is a JavaScript implementation of the secp256k1 elliptic curve. It is designed to be fast and secure, with a focus on simplicity and auditability. It provides similar functionalities to elliptic but is more lightweight and easier to audit.

README

Installation

npm install --save @types/elliptic

Summary

This package contains type definitions for elliptic (https://github.com/indutny/elliptic).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/elliptic.

Additional Details

• Last updated: Mon, 20 Nov 2023 23:36:24 GMT
• Dependencies: @types/bn.js

Credits

These definitions were written by Daniel Byrne, and Gaylor Bosson.