# @digitalcredentials/ed25519-signature-2020

> Ed25519Signature2020 Linked Data Proof suite for use with jsonld-signatures.

Latest version **7.0.0** (published 2025-04-30) · BSD-3-Clause license · 0 weekly downloads

## Install

```sh
npm install @digitalcredentials/ed25519-signature-2020
pnpm add @digitalcredentials/ed25519-signature-2020
yarn add @digitalcredentials/ed25519-signature-2020
bun add @digitalcredentials/ed25519-signature-2020
```

## Health

**Score 30/100 (F)** — status: maintenance-mode.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 7.0.0 |
| Published | 2025-04-30 |
| First published | 2021-05-19 |
| Weekly downloads | 0 |
| License | BSD-3-Clause |
| TypeScript types | none |
| Module format | ESM |
| Node | >=18 |
| Dependencies | 6 |
| Unpacked size | 16.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Maintainers | codenamedmitri, kimhd, uligall, alexander.muehle, stuartf, jchartrand, kiliankae, klemoie, kezike |

## Links

- npm: https://www.npmjs.com/package/@digitalcredentials/ed25519-signature-2020
- Repository: https://github.com/digitalcredentials/ed25519-signature-2020
- Issues: https://github.com/digitalcredentials/ed25519-signature-2020/issues
- npm.io page: https://npm.io/package/@digitalcredentials/ed25519-signature-2020

## Dependencies (6)

- [ed25519-signature-2018-context](https://npm.io/package/ed25519-signature-2018-context.md) ^1.1.0
- [ed25519-signature-2020-context](https://npm.io/package/ed25519-signature-2020-context.md) ^1.0.1
- [@digitalcredentials/base58-universal](https://npm.io/package/@digitalcredentials/base58-universal.md) ^1.0.1
- [@digitalcredentials/ed25519-multikey](https://npm.io/package/@digitalcredentials/ed25519-multikey.md) ^1.4.0
- [@digitalcredentials/jsonld-signatures](https://npm.io/package/@digitalcredentials/jsonld-signatures.md) ^12.0.1
- [@digitalcredentials/ed25519-verification-key-2020](https://npm.io/package/@digitalcredentials/ed25519-verification-key-2020.md) ^3.1.1

## Recent versions

- 7.0.0 (latest) — 2025-04-30
- 7.0.0-beta.1 (beta) — 2025-03-14
- 6.0.0 — 2024-09-18
- 5.0.0 — 2024-08-04
- 4.0.0 — 2024-02-07
- 3.0.2 — 2021-09-21
- 3.0.1 — 2021-09-20
- 1.0.0 — 2021-05-19

## README

# Ed25519Signature2020 suite _(@digitalcredentials/ed25519-signature-2020)_

[![Build status](https://img.shields.io/github/workflow/status/digitalcredentials/ed25519-signature-2020/Node.js%20CI)](https://github.com/digitalcredentials/ed25519-signature-2020/actions?query=workflow%3A%22Node.js+CI%22)
[![NPM Version](https://img.shields.io/npm/v/@digitalcredentials/ed25519-signature-2020.svg)](https://npm.im/digitalcredentials/ed25519-signature-2020)

> Ed25519Signature2020 Linked Data Proof suite for use with jsonld-signatures.

## Table of Contents

- [Background](#background)
- [Security](#security)
- [Install](#install)
- [Usage](#usage)
- [Contribute](#contribute)
- [Commercial Support](#commercial-support)
- [License](#license)

## Background

(Forked from [`digitalbazaar/ed25519-signature-2020` v3.0.0](https://github.com/digitalbazaar/ed25519-verification-key-2020)
to provide TypeScript compatibility.)

For use with https://github.com/digitalbazaar/jsonld-signatures v9.0 and above.

See also related specs:

* [Ed25519Signature2020 Crypto Suite](https://w3c-ccg.github.io/di-eddsa-2020/#ed25519signature2020)

## Security

TBD

## Install

- Node.js 14+ is required.

To install locally (for development):

```
git clone https://github.com/digitalcredentials/ed25519-signature-2020.git
cd ed25519-signature-2020
npm install
```

## Usage

The following code snippet provides a complete example of digitally signing
a verifiable credential using this library:

```javascript
import jsigs from 'jsonld-signatures';
const {purposes: {AssertionProofPurpose}} = jsigs;
import {Ed25519VerificationKey2020} from
  '@digitalcredentials/ed25519-verification-key-2020';
import {Ed25519Signature2020, suiteContext} from
  '@digitalcredentials/ed25519-signature-2020';

// create the unsigned credential
const unsignedCredential = {
  '@context': [
    'https://www.w3.org/2018/credentials/v1',
    {
      AlumniCredential: 'https://schema.org#AlumniCredential',
      alumniOf: 'https://schema.org#alumniOf'
    }
  ],
  id: 'http://example.edu/credentials/1872',
  type: [ 'VerifiableCredential', 'AlumniCredential' ],
  issuer: 'https://example.edu/issuers/565049',
  issuanceDate: '2010-01-01T19:23:24Z',
  credentialSubject: {
    id: 'https://example.edu/students/alice',
    alumniOf: 'Example University'
  }
};

// create the keypair to use when signing
const controller = 'https://example.edu/issuers/565049';
const keyPair = await Ed25519VerificationKey2020.from({
  type: 'Ed25519VerificationKey2020',
  controller,
  id: controller + '#z6MknCCLeeHBUaHu4aHSVLDCYQW9gjVJ7a63FpMvtuVMy53T',
  publicKeyMultibase: 'z6MknCCLeeHBUaHu4aHSVLDCYQW9gjVJ7a63FpMvtuVMy53T',
  privateKeyMultibase: 'zrv2EET2WWZ8T1Jbg4fEH5cQxhbUS22XxdweypUbjWVzv1YD6VqYu' +
    'W6LH7heQCNYQCuoKaDwvv2qCWz3uBzG2xesqmf'
});

const suite = new Ed25519Signature2020({key: keyPair});
suite.date = '2010-01-01T19:23:24Z';

signedCredential = await jsigs.sign(unsignedCredential, {
  suite,
  purpose: new AssertionProofPurpose(),
  documentLoader
});

// results in the following signed VC
{
  "@context": [
    "https://www.w3.org/2018/credentials/v1",
    {
      "AlumniCredential": "https://schema.org#AlumniCredential",
      "alumniOf": "https://schema.org#alumniOf"
    },
    "https://w3id.org/security/suites/ed25519-2020/v1"
  ],
  "id": "http://example.edu/credentials/1872",
  "type": ["VerifiableCredential", "AlumniCredential"],
  "issuer": "https://example.edu/issuers/565049",
  "issuanceDate": "2010-01-01T19:23:24Z",
  "credentialSubject": {
    "id": "https://example.edu/students/alice",
    "alumniOf": "Example University"
  },
  "proof": {
    "type": "Ed25519Signature2020",
    "created": "2010-01-01T19:23:24Z",
    "verificationMethod": "https://example.edu/issuers/565049#z6MknCCLeeHBUaHu4aHSVLDCYQW9gjVJ7a63FpMvtuVMy53T",
    "proofPurpose": "assertionMethod",
    "proofValue": "z3MvGcVxzRzzpKF1HA11EjvfPZsN8NAb7kXBRfeTm3CBg2gcJLQM5hZNmj6Ccd9Lk4C1YueiFZvkSx4FuHVYVouQk"
  }
}
```

## Contribute

See [the contribute file](https://github.com/digitalbazaar/bedrock/blob/master/CONTRIBUTING.md)!

PRs accepted.

If editing the Readme, please conform to the
[standard-readme](https://github.com/RichardLitt/standard-readme) specification.

## License

* MIT License - DCC - TypeScript compatibility.
* New BSD License (3-clause) © 2020-2021 Digital Bazaar - Initial implementation.

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