EOS-ECC
A lightweight (~6 KB) universal JavaScript Antelope and EOSIO digital signature and cryptokey utilty package.
Installation
For Node.js, to install eos-ecc run:
npm install eos-eccExamples
Signing a packed transaction.
import sign_packed_txn from "eos-ecc/sign_packed_txn.mjs";
sign_packed_txn({
chain_id: "2a02a0053…",
transaction_header: "fa123232…",
transaction_body: "fa45ffa2…",
wif_private_key: "5f…",
}).then(console.log);The logged output will be SIG_K1_…
An example of creating new pair of crypto keys.
import new_keys from "eos-ecc/new_keys.mjs";
new_keys().then(console.log);The logged output will be an object containing PUB_K1 and PVT_K1 wif keys.
Recover public key from signature.
import recover_public_key from "eos-ecc/recover_public_key.mjs";
recover_public_key({
signature: "SIG_K1_…", // Signature
data: "ff", // Data that was used to create signature.
}).then(console.log);The logged output will be PUB_K1….
Ways to require in CJS
Note
As this package is ESM if you need to require it in a Common JS package, then you can require like this:
(async function () {
const { default: new_keys } = await import("eos-ecc/new_keys.mjs");
const key_pair = await new_keys();
console.log(key_pair);
})();the logged output was: { public_key: PUB_K1_6…, private_key: PVT_K1_ge…}
Requirements
Supported runtime environments:
-
Node.js versions
>=16.0.0. - Browsers matching the Browserslist query
> 0.5%, not OperaMini all, not dead.
Exports
The npm package eos-ecc features optimal JavaScript module design. It doesn’t have a main index module, so use deep imports from the ECMAScript modules that are exported via the package.json field exports:
legacy_to_private_key.mjslegacy_to_public_key.mjsnew_eos_keys.mjsnew_keys.mjspublic_key_to_wif.mjspublic_key_from_private.mjsrandom_bytes.mjsrecover_public_key_from_signature.mjssign_packed_txn.mjssign_txn.mjsvalidate_private_key.mjsvalidate_public_key.mjswif_to_private_key.mjswif_to_public_key.mjs