# @types/ed25519

> TypeScript definitions for ed25519

Latest version **0.0.3** (published 2023-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/ed25519
pnpm add @types/ed25519
yarn add @types/ed25519
bun add @types/ed25519
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2023-11-07 |
| First published | 2017-10-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51440 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/ed25519
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ed25519
- npm.io page: https://npm.io/package/@types/ed25519

## Dependencies (1)

- [@types/node](https://npm.io/package/@types/node.md) *

## Recent versions

- 0.0.3 (latest) — 2023-11-07
- 0.0.1 (ts4.3) — 2023-03-20
- 0.0.0 (ts2.0) — 2017-10-25
- 0.0.2 — 2023-10-18

## README

# Installation
> `npm install --save @types/ed25519`

# Summary
This package contains type definitions for ed25519 (https://github.com/dazoe/ed25519).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ed25519.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ed25519/index.d.ts)
````ts
// Main site: https://ed25519.cr.yp.to/
// Manually generated and maintained because the package is a
// veneer on an underlying C library; auto-generation won't work.
// The JavaScript-C interface is well described at
// https://github.com/dazoe/ed25519/blob/master/src/ed25519.cc

/// <reference types="node" />

/** The key material returned from a call to MakeKeypair(). */
export interface CurveKeyPair {
    /**
     * A Buffer containing the public portion of the Curve25519 key.
     */
    publicKey: Buffer;

    /**
     * A Buffer containing the private, secret portion of the Curve25519 key.
     */
    privateKey: Buffer;
}

/**
 * Uses the crytpographically strong random seed to generate a
 * Curve25519 key pair.
 * @return The public and private key pair.
 */
export function MakeKeypair(seed: Buffer): CurveKeyPair;

/**
 * Signs a plaintext message buffer using the private key generated using
 * MakeKeypair().
 * @return The signature calculated on the plaintext.
 */
export function Sign(message: Buffer, privateKeyOrKeyPair: Buffer | CurveKeyPair): Buffer;

/**
 * Verifies a signature for a message buffer using a
 * public key generated using MakeKeypair().
 * @return True if the signature validates correctly, false otherwise.
 */
export function Verify(message: Buffer, signature: Buffer, publicKey: Buffer): boolean;

````

### Additional Details
 * Last updated: Mon, 06 Nov 2023 22:41:05 GMT
 * Dependencies: [@types/node](https://npmjs.com/package/@types/node)

# Credits
These definitions were written by .

---
_Source: https://npm.io/package/@types/ed25519 · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._