Gathering detailed insights and metrics for rn-eosjs-ecc
Gathering detailed insights and metrics for rn-eosjs-ecc
Installations
npm install rn-eosjs-eccDeveloper Guide
BETA
Typescript
No
Module System
CommonJS
Node Version
8.12.0
NPM Version
6.4.1
Releases
Unable to fetch releases
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
Maintainers
1
Package Meta Information
Latest Version
0.0.1
Package Id
rn-eosjs-ecc@0.0.1
Unpacked Size
51.77 kB
Size
13.44 kB
File Count
17
NPM Version
6.4.1
Node Version
8.12.0
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Elliptic curve cryptography functions (ECC)
Private Key, Public Key, Signature, AES, Encryption / Decryption
Import
1import ecc from 'eosjs-ecc' 2// or 3const ecc = require('eosjs-ecc')
Include
- Install with:
npm install eosjs-ecc - Html script tag, see releases for the correct version and its matching script integrity hash.
1<html> 2<head> 3 <meta charset="utf-8"> 4 <!-- 5 sha512-cL+IQQaQ586s9DrXfGtDheRpj5iDKh2M+xlpfwbhNjRIp4BGQ1fkM/vB4Ta8mc+f51YBW9sJiPcyMDIreJe6gQ== lib/eosjs-ecc.js 6 sha512-dYFDmK/d9r3/NCp6toLtfkwOjSMRBaEzaGAx1tfRItC0nsI0hVLERk05iNBQR7uDNI7ludYhcBI4vUiFHdjsTQ== lib/eosjs-ecc.min.js 7 sha512-eq1SCoSe38uR1UVuQMwR73VgY8qKTBDc87n2nIiC5WLhn1o2y1U6c5wY8lrigVX7INM8fM0PxDlMX5WvpghKig== lib/eosjs-ecc.min.js.map 8 --> 9 <script src="https://cdn.jsdelivr.net/npm/eosjs-ecc@4.0.4/lib/eosjs-ecc.min.js" 10 integrity="sha512-dYFDmK/d9r3/NCp6toLtfkwOjSMRBaEzaGAx1tfRItC0nsI0hVLERk05iNBQR7uDNI7ludYhcBI4vUiFHdjsTQ==" 11 crossorigin="anonymous"></script> 12 13</head> 14<body> 15 See console object: eosjs_ecc 16</body> 17</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
1ecc.randomKey().then(privateKey => { 2console.log('Private Key:\t', privateKey) // wif 3console.log('Public Key:\t', ecc.privateToPublic(privateKey)) // EOSkey... 4})
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
1ecc.seedPrivate('secret') === wif
Returns wif
privateToPublic
Parameters
Examples
1ecc.privateToPublic(wif) === pubkey
Returns pubkey
isValidPublic
Parameters
Examples
1ecc.isValidPublic(pubkey) === true
Returns boolean valid
isValidPrivate
Parameters
wifwif
Examples
1ecc.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
1ecc.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
1ecc.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
1ecc.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
1ecc.sha256('hashme') === '02208b..'
1ecc.sha256(Buffer.from('02208b', 'hex')) === '29a23..'
Returns (string | Buffer) Buffer when encoding is null, or string
pubkey
EOSKey..
Type: string
Usage (Object API)
1let {PrivateKey, PublicKey, Signature, Aes, key_utils, config} = require('eosjs-ecc')
2
3// Create a new random private key
4let privateWif
5PrivateKey.randomKey().then(privateKey => privateWif = privateKey.toWif())
6
7// Convert to a public key
8pubkey = PrivateKey.fromString(privateWif).toPublic().toString()Browser
1git clone https://github.com/EOSIO/eosjs-ecc.git 2cd eosjs-ecc 3npm install 4npm run build_browser 5# builds: ./dist/eosjs-ecc.js 6# Verify release hash
1<script src=eosjs-ecc.js></script>
1var ecc = eosjs_ecc 2 3ecc.randomKey().then(privateWif => { 4 var pubkey = ecc.privateToPublic(privateWif) 5 console.log(pubkey) 6})
No vulnerabilities found.
No security vulnerabilities found.