eos-ecc

EOS-ECC

A universal JavaScript package for elliptic curve cryptography, operations for the EOSIO blockchain.

Features

• Signature generation & validation
• Public key from private key
• Generate cryptographic random key pair

Built from isomorphic-secp256k1 which has developed strategies to mitigate various side channel attacks.

Support

We support all browsers that can handle WebAssembly.

• Node.js ^12.20.1 || >= 13.2
• Browser defaults, no IE 11

NB For testing purposes you will need webcrypto a Node.js v15 feature.

API

Table of contents

• function generate_eos_signature
• function new_eos_keys
• function public_key_from_private
• function verify_eos_signature
• type KeyPair

function generate_eos_signature

Generate an EOS encoded signature.

Parameter	Type	Description
arg	object	Argument.
arg.hex	string	Message digest sha256 to sign.
arg.wif_private_key	string	An EOS wallet import format private key.

Returns: string — EOS encoded signature.

Examples

Ways to import.

import { generate_eos_signature } from 'eos-ecc'

import generate_eos_signature from 'eos-ecc/public/generate_eos_signature.js'

Ways to require.

const { generate_eos_signature } = require('eos-ecc')

const generate_eos_signature = require('eos-ecc/public/generate_eos_signature.js')

Usage of generate_eos_signature.

import crypto from 'crypto'

const message = 'hello'
const hex = new Uint8Array(
  crypto.createHash('sha256').update(message).digest()
)
generate_eos_signature({
  hex,
  wif_private_key: '5KQwrPbwdL6PhXujxW37FSSQZ1JiwsST4cqQzDeyXtP79zkvFD3'
}).then(console.log)

The logged output will be SIG_K1_JxMN(…)NJ.

---

function new_eos_keys

Generate a new cryptographically random EOS key pair.

Returns: KeyPair — Key pair.

Examples

Ways to import.

import { new_eos_keys } from 'eos-ecc'

import new_eos_keys from 'eos-ecc/public/new_eos_keys.js'

Ways to require.

const { new_eos_keys } = require('eos-ecc')

const new_eos_keys = require('eos-ecc/public/new_eos_keys.js')

Usage new_eos_keys.

new_eos_keys().then(console.log)

The logged output will be an object containing EOS wif public & private keys.

---

function public_key_from_private

Convert an EOS WIF private key to a WIF public key.

Parameter	Type	Description
wif_private_key	string	EOS wallet import format key.

Returns: string — EOS wallet import format public key.

Examples

Ways to import.

import { public_key_from_private } from 'eos-ecc'

import public_key_from_private from 'eos-ecc/public/public_key_from_private.js'

Ways to require.

const { public_key_from_private } = require('eos-ecc')

const public_key_from_private = require('eos-ecc/public/public_key_from_private.js')

Usage public_key_from_private.

public_key_from_private(
  '5KQwrPbwdL6PhXujxW37FSSQZ1JiwsST4cqQzDeyXtP79zkvFD3'
).then(console.log)

The logged output will be EOS6MRyAjQq8ud7hVNYcfnVPJqcVpscN5So8BhtHuGYqET5GDW5CV.

---

function verify_eos_signature

Validates and EOS signature from the message digest and public key.

Parameter	Type	Description
arg	object	Argument.
arg.wif_public_key	string	EOS public key.
arg.signature	string	EOS encoded signature.
arg.hash	string	The sha256 message digest.

Returns: boolena — Will be true & false for valid & invalid signatures respectively.

Examples

Ways to import.

import { verify_eos_signature } from 'eos-ecc'

import verify_eos_signature from 'eos-ecc/public/verify_eos_signature.js'

Ways to require.

const { verify_eos_signature } = require('eos-ecc')

const verify_eos_signature = require('eos-ecc/public/verify_eos_signature.js')

Usage verify_eos_signature.

const signature = 'SIG_K1_JxMNpqjt…yNJ'
const wif_public_key = 'EOS6MRyAjQq8ud7hVNYcfnVPJqcVpscN5So8BhtHuGYqET5GDW5CV'
const hash = new Uint8Array(
  crypto.createHash('sha256').update('hello').digest()
)

verify_eos_signature({ wif_public_key, signature, hash })

The logged output will return true.

---

type KeyPair

An EOS wallet import formatted (WIF) public & private key pair.

Property	Type	Description
public_key	string	EOS WIF public key.
private_key	string	EOS WIF private key.