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

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

function generate_eos_signature

Generate an EOS encoded signature.

Parameter	Type	Description
arg	object	Argument.
arg.hex	string | Uint8Array	Data 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'

Ways to require.

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

Usage of generate_eos_signature.

import crypto from 'crypto'

generate_eos_signature({
  data: hello,
  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.

Parameter	Type	Description
seed	Uint8Array?	A 32 byte array to seed a private key (seed < curve order n).

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.

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.