Edky

Edky (pronounced ed-key) converts Ed25519 public keys between various encoding formats.

[Features] | [Prerequisites] | [Installation] | [Examples] | [Reference] | [Development]

✨ Features

• Available both as the command-line tool edky and a Rust library.
• Supports the Base16, Base32z, Base58, Base64, and Multibase encodings.
• Provides interop between ASIMOV, IPFS, Iroh, libp2p, NEAR, OpenSSH, etc.
• 100% pure and safe Rust with minimal dependencies and no bloat.
• Designed for #![no_std] environment compatibility from the get-go.
• Supports opting out of any feature using comprehensive feature flags.
• Adheres to the Rust API Guidelines in its naming conventions.
• Polyglot software also (soon!) available for Dart, Python, Ruby, and TypeScript.
• Cuts red tape: 100% free and unencumbered public domain software.

🛠️ Prerequisites

• Rust 1.97+

⬇️ Installation

Installation of the CLI

Installation via Cargo Binstall

cargo binstall -y edky

Installation via mise

mise use -g github:artob/edky

Installation via Cargo

cargo install edky --locked --features=cli

Downloading Release Tarballs

wget https://github.com/artob/edky/releases/download/0.1.1/edky-aarch64-apple-darwin.tar.xz
wget https://github.com/artob/edky/releases/download/0.1.1/edky-aarch64-unknown-linux-gnu.tar.xz
wget https://github.com/artob/edky/releases/download/0.1.1/edky-x86_64-apple-darwin.tar.xz
wget https://github.com/artob/edky/releases/download/0.1.1/edky-x86_64-pc-windows-msvc.zip
wget https://github.com/artob/edky/releases/download/0.1.1/edky-x86_64-unknown-linux-gnu.tar.xz

Installation of the Library

Installation from Crates.io

cargo add edky

Configuration in Cargo.toml

Enable all default features:

[dependencies]
edky = { version = "0" }

Enable only specific features:

[dependencies]
edky = { version = "0", default-features = false, features = ["alloc"] }

👉 Examples

Converting Ed25119 Public Keys via the CLI

$ edky convert -f iroh -t libp2p 47pjoycnsrfmxikm95jh13y88e8qnhzu5kungjpxyepgt7a8krpy
z6MktwupdmLXVVqTzCw4i46r4uGyosGXRnR3XjN4Zq7oMMsw

$ edky convert -f libp2p -t iroh z6MktwupdmLXVVqTzCw4i46r4uGyosGXRnR3XjN4Zq7oMMsw
47pjoycnsrfmxikm95jh13y88e8qnhzu5kungjpxyepgt7a8krpy

$ edky convert -f near -t hex ed25519:FVen3X669xLzsi6N2V91DoiyzHzg1uAgqiT8jZ9nS96Z
d75a980182b10ab7d54bfed3c964073a0ee172f3daa62325af021a68f707511a

$ edky convert -f hex -t near d75a980182b10ab7d54bfed3c964073a0ee172f3daa62325af021a68f707511a
ed25519:FVen3X669xLzsi6N2V91DoiyzHzg1uAgqiT8jZ9nS96Z

Importing the Library

use edky::{PublicKeyBytes, PublicKeyEncoding};

Decoding Ed25519 Public Keys

# fn main() -> Result<(), Box<dyn core::error::Error>> {
use edky::{decode, PublicKeyEncoding::*};

let key = decode(Asimov, "ⒶYFVen3X669xLzsi6N2V91DoiyzHzg1uAgqiT8jZ9nS96Z")?;
let key = decode(Base16, "d75a980182b10ab7d54bfed3c964073a0ee172f3daa62325af021a68f707511a")?;
let key = decode(Base32z, "47pjoycnsrfmxikm95jh13y88e8qnhzu5kungjpxyepgt7a8krpy")?;
let key = decode(Base58, "FVen3X669xLzsi6N2V91DoiyzHzg1uAgqiT8jZ9nS96Z")?;
let key = decode(Base64, "11qYAYKxCrfVS/7TyWQHOg7hcvPapiMlrwIaaPcHURo=")?;
let key = decode(Base64Url, "11qYAYKxCrfVS_7TyWQHOg7hcvPapiMlrwIaaPcHURo")?;
let key = decode(Multibase, "z6MktwupdmLXVVqTzCw4i46r4uGyosGXRnR3XjN4Zq7oMMsw")?;
let key = decode(Near, "ed25519:FVen3X669xLzsi6N2V91DoiyzHzg1uAgqiT8jZ9nS96Z")?;
let key = decode(OpenSsh, "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAINdamAGCsQq31Uv+08lkBzoO4XLz2qYjJa8CGmj3B1Ea")?;
# Ok(()) }

Encoding Ed25519 Public Keys

# fn main() -> Result<(), Box<dyn core::error::Error>> {
use edky::{PublicKeyBytes, PublicKeyEncoding::*};

let key = PublicKeyBytes::decode(Base16, "d75a980182b10ab7d54bfed3c964073a0ee172f3daa62325af021a68f707511a")?;

println!("{:?}", key.encode(Multibase));
# Ok(()) }

📚 Reference

docs.rs/edky

Command-Line Interface

$ edky
Edky converts Ed25519 public keys between various encoding formats

Usage: edky [OPTIONS] [COMMAND]

Commands:
  list     List the supported public key encoding formats
  convert  Convert Ed25519 public keys between various encoding formats
  parse    Parse Ed25519 public keys in various encoding formats
  help     Print this message or the help of the given subcommand(s)

Options:
      --color <COLOR>  Set the color output mode [default: auto] [possible values: auto, always,
                       never]
  -d, --debug          Enable debugging output
      --license        Show license information
  -v, --verbose...     Enable verbose output (may be repeated for more verbosity)
  -V, --version        Print version information
  -h, --help           Print help (see more with '--help')

edky list

$ edky list --help
List the supported public key encoding formats

Usage: edky list [OPTIONS]

Options:
      --color <COLOR>  Set the color output mode [default: auto] [possible values: auto, always,
                       never]
  -d, --debug          Enable debugging output
  -v, --verbose...     Enable verbose output (may be repeated for more verbosity)
  -h, --help           Print help

edky convert

$ edky convert --help
Convert Ed25519 public keys between various encoding formats

Usage: edky convert [OPTIONS] <INPUTS>...

Arguments:
  <INPUTS>...  The input strings to convert

Options:
      --color <COLOR>  Set the color output mode [default: auto] [possible values: auto, always,
                       never]
  -f, --from <FROM>    The input encoding format [default: hex]
  -d, --debug          Enable debugging output
  -t, --to <TO>        The output encoding format [default: hex]
  -v, --verbose...     Enable verbose output (may be repeated for more verbosity)
  -h, --help           Print help

edky parse

$ edky parse --help
Parse Ed25519 public keys in various encoding formats

Usage: edky parse [OPTIONS] <INPUTS>...

Arguments:
  <INPUTS>...  The input strings to parse

Options:
      --color <COLOR>  Set the color output mode [default: auto] [possible values: auto, always,
                       never]
  -f, --from <FROM>    The input encoding format [default: hex]
  -d, --debug          Enable debugging output
  -v, --verbose...     Enable verbose output (may be repeated for more verbosity)
  -h, --help           Print help

Encodings

Feature Flags

Interoperability

👨‍💻 Development

git clone https://github.com/artob/edky.git