Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pur3miish/isomorphic-secp256k1-js
A ultra lightweight Universal JavaScript Elliptic Curve Digital Signature Algorithm (ECDSA) for the Koblitz secp256k1 curve.
https://github.com/pur3miish/isomorphic-secp256k1-js
blockchain javascript secp256k1 signature-verification
Last synced: 14 days ago
JSON representation
A ultra lightweight Universal JavaScript Elliptic Curve Digital Signature Algorithm (ECDSA) for the Koblitz secp256k1 curve.
- Host: GitHub
- URL: https://github.com/pur3miish/isomorphic-secp256k1-js
- Owner: pur3miish
- Created: 2022-10-23T23:23:07.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-09-05T05:10:30.000Z (about 1 year ago)
- Last Synced: 2024-08-11T11:17:32.109Z (3 months ago)
- Topics: blockchain, javascript, secp256k1, signature-verification
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/isomorphic-secp256k1-js
- Size: 76.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
Awesome Lists containing this project
README
# Isomorphic SEPC256K1 JS
[](https://www.npmjs.org/package/isomorphic-secp256k1-js) [](https://github.com/pur3miish/isomorphic-secp256k1-js/actions) [](https://github.com/pur3miish/isomorphic-secp256k1-js/blob/main/LICENSE)
An ultra lightweight (1.6kb minify + gzip) [Universal](https://en.wikipedia.org/wiki/Isomorphic_JavaScript) JavaScript [Elliptic Curve Digital Signature Algorithm](https://en.bitcoin.it/wiki/Elliptic_Curve_Digital_Signature_Algorithm) (ECDSA) for the Koblitz secp256k1 curve.
Cross platform support for [Node.js](https://nodejs.org) and [Deno](https://deno.land).
## Exports
The [npm](https://npmjs.com) package [`isomorphic-secp256k1-js`](https://npm.im/isomorphic-secp25k1-js) features [optimal JavaScript module design](https://jaydenseric.com/blog/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`](./package.json) field [`exports`](https://nodejs.org/api/packages.html#exports):
- [`recover_public_key.mjs`](./recover_public_key.mjs)
- [`sign.mjs`](./sign.mjs)
- [`get_public_key.mjs`](./get_public_key.mjs)
## Impact on your bundle
Using the [esbuild](https://esbuild.github.io/) minify and gzip you can generate a digital signature with less than **1.6kb** impact to your bundle.
```shell
cat dist/sign.mjs | wc
1 86 2898
cat dist/sign.mjs.zip | wc
10 59 1604
```
```shell
cat dist/get_public_key.mjs | wc
1 27 1389
cat dist/get_public_key.mjs.zip | wc
3 29 1006
```
```shell
cat dist/recover_public_key.mjs | wc
1 50 2055
cat dist/recover_public_key.mjs.zip | wc
4 38 1360
```
## Installation
For [Node.js](https://nodejs.org), to install [`isomorphic-secp256k1-js`](https://npm.im/isomorphic-secp256k1-js) run:
```sh
npm i isomorphic-secp256k1-js
```
For [Deno.js](https://deno.land/x/secp256k1js), at the root of your project add a `deno.json` file and include these import paths:
```json
{
"imports": {
"universal-sha256-js/": "https://deno.land/x/sha256js/",
"universal-hmac-sha256-js/": "https://deno.land/x/hmacsha256/",
"universal-hmac-sha256-js/hmac-sha256-node.mjs": "https://deno.land/x/hmacsha256/hmac-sha256-deno.mjs"
}
}
```
Then import:
```js
import recover_public_key from "https://deno.land/x/secp256k1js/recover_public_key.mjs";
import sign from "https://deno.land/x/secp256k1js/sign.mjs";
import get_public_key from "https://deno.land/x/secp256k1js/get_public_key.mjs";
```
## Examples
Recover public key from private key.
```js
const private_key = new Uint8Array([
210, 101, 63, 247, 203, 178, 216, 255, 18, 154, 194, 126, 245, 120, 28, 230,
139, 37, 88, 196, 26, 116, 175, 31, 45, 220, 166, 53, 203, 238, 240, 125,
]);
// Compressed public key.
console.log(get_public_key(private_key));
```
Generate a secp25k1 digital signature.
```js
const private_key = new Uint8Array([
210, 101, 63, 247, 203, 178, 216, 255, 18, 154, 194, 126, 245, 120, 28, 230,
139, 37, 88, 196, 26, 116, 175, 31, 45, 220, 166, 53, 203, 238, 240, 125,
]);
const data = Uint8Array.from([
0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21,
22, 23, 24, 25, 26, 27, 28, 29, 30, 31,
]);
sign({ data, private_key }).then(console.log);
```
> The logged output is { r: [23, …, 89], s: [111, …, 142], v: 1 }
> **Note**
>
> As this package is [ESM](https://nodejs.org/docs/latest-v16.x/api/esm.html) if you need to require it in a [Common JS](https://nodejs.org/docs/latest-v16.x/api/modules.html) package, then you can require like this:
```js
(async function () {
const { default: recover_public_key } = await import(
"isomorphic-secp256k1-js/recover_public_key.mjs"
);
const { number_to_array } = await import("./private/utils.mjs");
const key_pair = await recover_public_key({
data,
signature: {
r: number_to_array(
50172533143525448505731076092836454339589141171079665638497512992118311974590n
),
s: number_to_array(
3372897403575535231543296615264124933490702058654620386530787287980439847001n
),
v: 0,
},
});
console.log(key_pair);
})();
```
> Logged output was Uint8Array(33) [2,192,222,210,188,31,19,5,…
## Requirements
Supported runtime environments:
- [Node.js](https://nodejs.org) versions `>=16.0.0`.
- Browsers matching the [Browserslist](https://browsersl.ist) query [`> 0.5%, not OperaMini all, not dead`](https://browsersl.ist/?q=%3E+0.5%25%2C+not+OperaMini+all%2C+not+dead).
- [Deno](https://deno.land) versions `^1.0.0`.