Skip to content

hazae41/ed25519.wasm

Repository files navigation

ed25519.wasm

WebAssembly port of Ed25519

npm i @hazae41/ed25519.wasm

Node Package 📦

Features

  • Reproducible building
  • Pre-bundled and streamed
  • Zero-copy memory slices

Modules

  • ed25519-dalek

Algorithms

  • Ed25519

Usage

import { Ed25519Wasm, Ed25519Keypair } from "@hazae41/ed25519.wasm";

// Wait for WASM to load
await Ed25519Wasm.initBundled();

// Generate an identity
using keypair = new Ed25519Keypair();
using identity = keypair.public(); // Ed25519PublicKey

// Define bytes to sign
const bytes = new TextEncoder().encode("hello world"); // Uint8Array

// Sign and verify
using proof = keypair.sign(bytes); // Ed25519Signature
const verified = identity.verify(bytes, proof); // boolean

You can serialize and deserialize to Uint8Array

using memory = new Ed25519Keypair().to_bytes();
const keypair = Ed25519Keypair.from_bytes(memory.bytes);
using memory = keypair.public().to_bytes();
const identity = Ed25519PublicKey.from_bytes(memory.bytes);
using memory = keypair.sign(input).to_bytes();
const proof = Ed25519Signature.from_bytes(memory.bytes);

Building

Unreproducible building

You need to install Rust

Then, install wasm-pack

cargo install wasm-pack

Finally, do a clean install and build

npm ci && npm run build

Reproducible building

You can build the exact same bytecode using Docker, just be sure you're on a linux/amd64 host

docker compose up --build

Then check that all the files are the same using git status

git status --porcelain

If the output is empty then the bytecode is the same as the one I commited

Automated checks

Each time I commit to the repository, the GitHub's CI does the following:

  • Clone the repository
  • Reproduce the build using docker compose up --build
  • Throw an error if the git status --porcelain output is not empty

Each time I release a new version tag on GitHub, the GitHub's CI does the following:

  • Clone the repository
  • Do not reproduce the build, as it's already checked by the task above
  • Throw an error if there is a npm diff between the cloned repository and the same version tag on NPM

If a version is present on NPM but not on GitHub, do not use!