JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 25371
  • Score
    100M100P100Q141826F
  • License MIT

TypeScript definitions for eccrypto

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@types/eccrypto) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    Installation

    npm install --save @types/eccrypto

    Summary

    This package contains type definitions for eccrypto (https://github.com/bitchan/eccrypto).

    Details

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

    index.d.ts

    /// <reference types="node" />
    export as namespace eccrypto;
    
    // Generate a new valid private key. Will use crypto.randomBytes as source.
    export function generatePrivate(): Buffer;
    
    // Compute the public key for a given private key.
    export function getPublic(privateKey: Buffer): Buffer;
    
    // Compute the compressed public key for a given private key.
    export function getPublicCompressed(privateKey: Buffer): Buffer;
    
    // Create an ECDSA signature.
    export function sign(key: Buffer, msg: Buffer): Promise<Buffer>;
    
    // Verify an ECDSA signature.
    export function verify(publicKey: Buffer, msg: Buffer, sig: Buffer): Promise<null>;
    
    // Derive shared secret for given private and public keys.
    export function derive(privateKeyA: Buffer, publicKeyB: Buffer): Promise<Buffer>;
    
    // Input/output structure for ECIES operations.
    export interface Ecies {
        iv: Buffer;
        ephemPublicKey: Buffer;
        ciphertext: Buffer;
        mac: Buffer;
    }
    
    // Encrypt message for given recepient's public key.
    export function encrypt(
        publicKeyTo: Buffer,
        msg: Buffer,
        opts?: { iv?: Buffer | undefined; ephemPrivateKey?: Buffer | undefined },
    ): Promise<Ecies>;
    
    // Decrypt message using given private key.
    export function decrypt(privateKey: Buffer, opts: Ecies): Promise<Buffer>;
    

    Additional Details

    Credits

    These definitions were written by Random Nerd.