Security News
ESLint Adds Official Support for Linting HTML
ESLint now supports HTML linting with 48 new rules, expanding its language plugin system to cover more of the modern web development stack.
By Sarah Gooding - May 13, 2025
🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more →
Elliptic curve cryptography functions (ECC)
Private Key, Public Key, Signature, AES, Encryption / Decryption
Import
import ecc from 'eosjs-ecc'
// or
const ecc = require('eosjs-ecc')
Include
- Install with:
yarn add eosjs-ecc - Html script tag, see releases for the correct version and its matching script integrity hash.
<html>
<head>
<meta charset="utf-8">
<!--
sha512-cL+IQQaQ586s9DrXfGtDheRpj5iDKh2M+xlpfwbhNjRIp4BGQ1fkM/vB4Ta8mc+f51YBW9sJiPcyMDIreJe6gQ== lib/eosjs-ecc.js
sha512-dYFDmK/d9r3/NCp6toLtfkwOjSMRBaEzaGAx1tfRItC0nsI0hVLERk05iNBQR7uDNI7ludYhcBI4vUiFHdjsTQ== lib/eosjs-ecc.min.js
sha512-eq1SCoSe38uR1UVuQMwR73VgY8qKTBDc87n2nIiC5WLhn1o2y1U6c5wY8lrigVX7INM8fM0PxDlMX5WvpghKig== lib/eosjs-ecc.min.js.map
-->
<script src="https://cdn.jsdelivr.net/npm/eosjs-ecc@4.0.4/lib/eosjs-ecc.min.js"
integrity="sha512-dYFDmK/d9r3/NCp6toLtfkwOjSMRBaEzaGAx1tfRItC0nsI0hVLERk05iNBQR7uDNI7ludYhcBI4vUiFHdjsTQ=="
crossorigin="anonymous"></script>
</head>
<body>
See console object: eosjs_ecc
</body>
</html>
Common API
Table of Contents
- wif
- ecc
- pubkey
wif
Type: string
ecc
initialize
Initialize by running some self-checking code. This should take a second to gather additional CPU entropy used during private key generation.
Initialization happens once even if called multiple times.
Returns Promise
unsafeRandomKey
Does not pause to gather CPU entropy.
Returns Promise<PrivateKey> test key
randomKey
Parameters
cpuEntropyBitsnumber gather additional entropy from a CPU mining algorithm. This will already happen once by default. (optional, default0)
Examples
ecc.randomKey().then(privateKey => {
console.log('Private Key:\t', privateKey) // wif
console.log('Public Key:\t', ecc.privateToPublic(privateKey)) // EOSkey...
})
seedPrivate
Parameters
seedstring any length string. This is private. The same seed produces the same private key every time. At least 128 random bits should be used to produce a good private key.
Examples
ecc.seedPrivate('secret') === wif
Returns wif
privateToPublic
Parameters
Examples
ecc.privateToPublic(wif) === pubkey
Returns pubkey
isValidPublic
Parameters
Examples
ecc.isValidPublic(pubkey) === true
Returns boolean valid
isValidPrivate
Parameters
wifwif
Examples
ecc.isValidPrivate(wif) === true
Returns boolean valid
sign
Create a signature using data or a hash.
Parameters
data(string | Buffer)privateKey(wif | PrivateKey)encodingString data encoding (if string) (optional, default'utf8')
Examples
ecc.sign('I am alive', wif)
Returns string string signature
signHash
Parameters
dataSha256(String | Buffer) sha256 hash 32 byte buffer or stringprivateKey(wif | PrivateKey)encodingString dataSha256 encoding (if string) (optional, default'hex')
Returns string string signature
verify
Verify signed data.
Parameters
signature(string | Buffer) buffer or hex stringdata(string | Buffer)pubkey(pubkey | PublicKey)encoding(optional, default'utf8')hashDataboolean sha256 hash data before verify (optional, defaulttrue)
Examples
ecc.verify(signature, 'I am alive', pubkey) === true
Returns boolean
recover
Recover the public key used to create the signature.
Parameters
signature(String | Buffer) (EOSbase58sig.., Hex, Buffer)data(String | Buffer) full dataencodingString data encoding (if data is a string) (optional, default'utf8')
Examples
ecc.recover(signature, 'I am alive') === pubkey
Returns pubkey
recoverHash
Parameters
signature(String | Buffer) (EOSbase58sig.., Hex, Buffer)dataSha256(String | Buffer) sha256 hash 32 byte buffer or hex stringencodingString dataSha256 encoding (if dataSha256 is a string) (optional, default'hex')
Returns PublicKey
sha256
Parameters
data(string | Buffer) always binary, you may need Buffer.from(data, 'hex')resultEncoding(optional, default'hex')encodingstring result encoding 'hex', 'binary' or 'base64' (optional, default'hex')
Examples
ecc.sha256('hashme') === '02208b..'
ecc.sha256(Buffer.from('02208b', 'hex')) === '29a23..'
Returns (string | Buffer) Buffer when encoding is null, or string
pubkey
EOSKey..
Type: string
Usage (Object API)
let {PrivateKey, PublicKey, Signature, Aes, key_utils, config} = require('eosjs-ecc')
// Create a new random private key
let privateWif
PrivateKey.randomKey().then(privateKey => privateWif = privateKey.toWif())
// Convert to a public key
pubkey = PrivateKey.fromString(privateWif).toPublic().toString()
Browser
git clone https://github.com/EOSIO/eosjs-ecc.git
cd eosjs-ecc
yarn
yarn build_browser
# builds: ./dist/eosjs-ecc.js
# Verify release hash
<script src=eosjs-ecc.js></script>
var ecc = eosjs_ecc
ecc.randomKey().then(privateWif => {
var pubkey = ecc.privateToPublic(privateWif)
console.log(pubkey)
})
FAQs
Elliptic curve cryptography functions
The npm package eosjs-ecc receives a total of 38,958 weekly downloads. As such, eosjs-ecc popularity was classified as popular.
We found that eosjs-ecc demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 8 open source maintainers collaborating on the project.
Package last updated on 23 Sep 2019
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Related posts
Security News
CISA Kills Off RSS Feeds for KEVs and Cyber Alerts
CISA is discontinuing official RSS support for KEV and cybersecurity alerts, shifting updates to email and social media, disrupting automation workflows.
By Sarah Gooding - May 12, 2025
Security News
MCP Community Begins Work on Official MCP Metaregistry
The MCP community is launching an official registry to standardize AI tool discovery and let agents dynamically find and install MCP servers.
By Sarah Gooding - May 09, 2025