{"_id":"@aguycalled/bls-signatures","_rev":"4-e8a9ef6142e62f1490de6016794fbe35","name":"@aguycalled/bls-signatures","dist-tags":{"latest":"0.2.1-beta.3"},"versions":{"0.2.1-beta.0":{"name":"@aguycalled/bls-signatures","version":"0.2.1-beta.0","description":"The most advanced BLS library for JavaScript","main":"blsjs.js","types":"blsjs.d.ts","directories":{"test":"tests"},"scripts":{"test":"npm run test:node && npm run test:browser","test:typings":"tsc --esModuleInterop ./tests/typings.spec.ts","test:node":"npm run test:typings && mocha ./tests/*.spec.js","test:browser":"npm run test:typings && ./node_modules/.bin/karma start ./tests/karma.conf.js --single-run"},"repository":{"type":"git","url":"git+ssh://git@github.com/Chia-Network/bls-signatures.git"},"homepage":"https://github.com/Chia-Network/bls-signatures/tree/master/js-bindings","author":{"name":"Anton Suprunchuk","email":"antouhou@gmail.com","url":"https://github.com/antouhou"},"keywords":["bls","BLS","threshold","signature","crypto","cryptography"],"devDependencies":{"@types/mocha":"^5.2.7","@types/node":"^11.15.18","assert":"^2.0.0","babel-polyfill":"^6.26.0","buffer":"^6.0.3","crypto-browserify":"^3.12.0","karma":"^6.3.4","karma-firefox-launcher":"^1.3.0","karma-mocha":"^2.0.1","karma-mocha-reporter":"^2.2.5","karma-webpack":"^5.0.0","mime":"1.4.1","mocha":"^8.4.0","path-browserify":"^1.0.1","process":"^0.11.10","stream-browserify":"^3.0.0","typescript":"^3.6.5","webpack":"^5.39.0"},"dependencies":{"binascii":"0.0.2"},"bugs":{"url":"https://github.com/Chia-Network/bls-signatures/issues"},"_id":"@aguycalled/bls-signatures@0.2.1-beta.0","_nodeVersion":"14.15.5","_npmVersion":"6.14.11","dist":{"integrity":"sha512-jsfgsto44cX/kUZ/lqS5TxOScW256l+A51QdpK0kQdi4tQvKm5cn19ZcZSgqX/O1hrP8JS4dMJRcJze54GfIsw==","shasum":"d58dfb1154ea969415026b16950195a4241896b4","tarball":"https://registry.npmjs.org/@aguycalled/bls-signatures/-/bls-signatures-0.2.1-beta.0.tgz","fileCount":5,"unpackedSize":307904,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCRqwB+Lsit8le/z9WFn/Dy+n0DEjlhGJV+Sz3ViuMK3AIgEXbA6d6leOeUpJGzZPyxfCCxLfbBYmO4HsoBmypPcbk="}]},"_npmUser":{"name":"aguycalled","email":"alex@nav.community"},"maintainers":[{"name":"aguycalled","email":"alex@nav.community"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/bls-signatures_0.2.1-beta.0_1634830224528_0.94928472518904"},"_hasShrinkwrap":false},"0.2.1-beta.1":{"name":"@aguycalled/bls-signatures","version":"0.2.1-beta.1","description":"The most advanced BLS library for JavaScript","main":"blsjs.js","types":"blsjs.d.ts","directories":{"test":"tests"},"scripts":{"test":"npm run test:node && npm run test:browser","test:typings":"tsc --esModuleInterop ./tests/typings.spec.ts","test:node":"npm run test:typings && mocha ./tests/*.spec.js","test:browser":"npm run test:typings && ./node_modules/.bin/karma start ./tests/karma.conf.js --single-run"},"repository":{"type":"git","url":"git+ssh://git@github.com/Chia-Network/bls-signatures.git"},"homepage":"https://github.com/Chia-Network/bls-signatures/tree/master/js-bindings","author":{"name":"Anton Suprunchuk","email":"antouhou@gmail.com","url":"https://github.com/antouhou"},"keywords":["bls","BLS","threshold","signature","crypto","cryptography"],"devDependencies":{"@types/mocha":"^5.2.7","@types/node":"^11.15.18","assert":"^2.0.0","babel-polyfill":"^6.26.0","buffer":"^6.0.3","crypto-browserify":"^3.12.0","karma":"^6.3.4","karma-firefox-launcher":"^1.3.0","karma-mocha":"^2.0.1","karma-mocha-reporter":"^2.2.5","karma-webpack":"^5.0.0","mime":"1.4.1","mocha":"^8.4.0","path-browserify":"^1.0.1","process":"^0.11.10","stream-browserify":"^3.0.0","typescript":"^3.6.5","webpack":"^5.39.0"},"dependencies":{"binascii":"0.0.2"},"bugs":{"url":"https://github.com/Chia-Network/bls-signatures/issues"},"_id":"@aguycalled/bls-signatures@0.2.1-beta.1","_nodeVersion":"14.15.5","_npmVersion":"6.14.11","dist":{"integrity":"sha512-Ft2xtbRPXn4k6oi3rcweiiEvx63BJBhmhCPYqACQG0f16dZvcXu9G4XMYH9TVDO0CecLzE0i58X5leJOaO35gQ==","shasum":"5209244efd3c136d9464d15694c33347702ee3da","tarball":"https://registry.npmjs.org/@aguycalled/bls-signatures/-/bls-signatures-0.2.1-beta.1.tgz","fileCount":5,"unpackedSize":310029,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQD9WH4CpNDGrGszOv4MgNXYGf5Zm+vQnnlTg/qpMGIsCQIgfh6JEHVgmoar0XhDj5ZD18GtgMtDUXJX6huMwa9KUNQ="}]},"_npmUser":{"name":"aguycalled","email":"alex@nav.community"},"maintainers":[{"name":"aguycalled","email":"alex@nav.community"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/bls-signatures_0.2.1-beta.1_1636043933787_0.9751002928761316"},"_hasShrinkwrap":false},"0.2.1-beta.3":{"name":"@aguycalled/bls-signatures","version":"0.2.1-beta.3","description":"The most advanced BLS library for JavaScript","main":"blsjs.js","types":"blsjs.d.ts","directories":{"test":"tests"},"scripts":{"test":"npm run test:node && npm run test:browser","test:typings":"tsc --esModuleInterop ./tests/typings.spec.ts","test:node":"npm run test:typings && mocha ./tests/*.spec.js","test:browser":"npm run test:typings && ./node_modules/.bin/karma start ./tests/karma.conf.js --single-run"},"repository":{"type":"git","url":"git+ssh://git@github.com/Chia-Network/bls-signatures.git"},"homepage":"https://github.com/Chia-Network/bls-signatures/tree/master/js-bindings","author":{"name":"Anton Suprunchuk","email":"antouhou@gmail.com","url":"https://github.com/antouhou"},"keywords":["bls","BLS","threshold","signature","crypto","cryptography"],"devDependencies":{"@types/mocha":"^5.2.7","@types/node":"^11.15.18","assert":"^2.0.0","babel-polyfill":"^6.26.0","buffer":"^6.0.3","crypto-browserify":"^3.12.0","karma":"^6.3.4","karma-firefox-launcher":"^1.3.0","karma-mocha":"^2.0.1","karma-mocha-reporter":"^2.2.5","karma-webpack":"^5.0.0","mime":"1.4.1","mocha":"^8.4.0","path-browserify":"^1.0.1","process":"^0.11.10","stream-browserify":"^3.0.0","typescript":"^3.6.5","webpack":"^5.39.0"},"dependencies":{"binascii":"0.0.2"},"bugs":{"url":"https://github.com/Chia-Network/bls-signatures/issues"},"_id":"@aguycalled/bls-signatures@0.2.1-beta.3","_nodeVersion":"14.15.5","_npmVersion":"6.14.11","dist":{"integrity":"sha512-naVM35mIzZU7FmipWe3vzWbb9Yy8BGX+xccCr+zTXyFul4qxxkdsLD9w7h0JXuLgpZoolMbW3ehmnqOOHbO34g==","shasum":"998a6a6d303a8d487070c374eb6846a7433bba35","tarball":"https://registry.npmjs.org/@aguycalled/bls-signatures/-/bls-signatures-0.2.1-beta.3.tgz","fileCount":5,"unpackedSize":310082,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhwvUzCRA9TVsSAnZWagAAy/4P/2DJcALxYR047DfuXt3d\nZiX72LYZvfO4AiH41lMFE2OIiWokYyOoZ29GnN/U3+cp3pqL+F6VxXloCA2P\nupzJM1mNsKQfuKub82BsINxvLgMEHkaYdlGbb10tCTwcHX7iffjZhXWE+ZIP\nCqgwH01ECYeEDwHjTLs27md493RzCr8+NodwTaaGX0Afnh6/RsebF3ybn2AY\ntEBwxFYIzkM5zAOTYaEY87Hgucndb822M0h4gT1QLx9A1qT34BGf1DC2P3pl\nAp0RIzD0wCgzx5CPxPz3cuEOKSnyRTo7CeoWpEXFTPVpe+/I+1VUZCRh9q/t\nhKcTt9qlYGVy++flNqrnAMe5agBk6jOGWDP50aTzQ5LsnCyGwz8MbBAa53GI\nq9TSCajIyGWI5TELF7zxa7ot5IhyGHc+yRuPg4yHp/U3JFIwkGb2l+fUOLCK\nUYkxI3nn8bAb6MJRqtJaKVDKIysq7vVuilVkwyyVPrk3ldG4MtNrLSliJSz0\nhgn3qFVondPKritm2w8r3hqoYTMl4ia7UxaYiXDbaAwLiqRFQ4w6aIor6gB2\nq8sHTp6+qimP1RohN0eGZUmO5xhu0VOIL3cuoiZPZLqWGz9NVoXE1f/J17p8\nv6A6mG2kidwHDwdHXLHZU2qV0yjT0mlZLfMw0/zHtB+ChjmDFVGw1ixDZFoT\nfT8x\r\n=565X\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCICe7dQvapJVqzR+It0ecNYDSJTvJfWA3L4pMvGA4wSwHAiEArBQRXSgzCLZ/6dtghOVhdyi5NT7miDFYasKR1oudwVI="}]},"_npmUser":{"name":"aguycalled","email":"alex@nav.community"},"maintainers":[{"name":"aguycalled","email":"alex@nav.community"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/bls-signatures_0.2.1-beta.3_1636193231175_0.39553113604395507"},"_hasShrinkwrap":false}},"time":{"created":"2021-10-21T15:30:24.441Z","0.2.1-beta.0":"2021-10-21T15:30:24.714Z","modified":"2022-04-04T12:08:56.797Z","0.2.1-beta.1":"2021-11-04T16:38:54.004Z","0.2.1-beta.3":"2021-11-06T10:07:11.356Z"},"maintainers":[{"name":"aguycalled","email":"alex@nav.community"}],"description":"The most advanced BLS library for JavaScript","homepage":"https://github.com/Chia-Network/bls-signatures/tree/master/js-bindings","keywords":["bls","BLS","threshold","signature","crypto","cryptography"],"repository":{"type":"git","url":"git+ssh://git@github.com/Chia-Network/bls-signatures.git"},"author":{"name":"Anton Suprunchuk","email":"antouhou@gmail.com","url":"https://github.com/antouhou"},"bugs":{"url":"https://github.com/Chia-Network/bls-signatures/issues"},"readme":"## bls-signatures\n\nJavaScript library that implements BLS signatures with aggregation as in [Boneh, Drijvers, Neven 2018](https://crypto.stanford.edu/~dabo/pubs/papers/BLSmultisig.html), using the relic toolkit for cryptographic primitives (pairings, EC, hashing).\n\nThis library is a JavaScript port of the [Chia Network's BLS lib](https://github.com/Chia-Network/bls-signatures). We also have typings, so you can use it with TypeScript too!\n\n### Usage\n\n```bash\nnpm i bls-signatures --save # or yarn add bls-signatures\n```\n\n### Creating keys and signatures\n```javascript\n  var loadBls = require(\"bls-signatures\");\n  var BLS = await loadBls();\n  \n  var seed = Uint8Array.from([\n    0,  50, 6,  244, 24,  199, 1,  25,  52,  88,  192,\n    19, 18, 12, 89,  6,   220, 18, 102, 58,  209, 82,\n    12, 62, 89, 110, 182, 9,   44, 20,  254, 22\n  ]);\n  \n  var sk = BLS.AugSchemeMPL.key_gen(seed);\n  var pk = sk.get_g1();\n  \n  var message = Uint8Array.from([1,2,3,4,5]);\n  var signature = BLS.AugSchemeMPL.sign(sk, message);\n  \n  let ok = BLS.AugSchemeMPL.verify(pk, message, signature);\n  console.log(ok); // true\n```\n\n### Serializing keys and signatures to bytes\n```javascript  \n  var skBytes = sk.serialize();\n  var pkBytes = pk.serialize();\n  var signatureBytes = signature.serialize();\n  \n  console.log(BLS.Util.hex_str(skBytes));\n  console.log(BLS.Util.hex_str(pkBytes));\n  console.log(BLS.Util.hex_str(signatureBytes));\n  \n```\n\n### Loading keys and signatures from bytes\n```javascript\n  var skc = BLS.PrivateKey.from_bytes(skBytes, false);\n  var pk = BLS.G1Element.from_bytes(pkBytes);\n\n  var signature = BLS.G2Element.from_bytes(signatureBytes);\n```\n\n### Create aggregate signatures\n```javascript\n  // Generate some more private keys\n  seed[0] = 1;\n  var sk1 = BLS.AugSchemeMPL.key_gen(seed);\n  seed[0] = 2;\n  var sk2 = BLS.AugSchemeMPL.key_gen(seed);\n  var message2 = Uint8Array.from([1,2,3,4,5,6,7]);\n  \n  // Generate first sig\n  var pk1 = sk1.get_g1();\n  var sig1 = BLS.AugSchemeMPL.sign(sk1, message);\n  \n  // Generate second sig\n  var pk2 = sk2.get_g1();\n  var sig2 = BLS.AugSchemeMPL.sign(sk2, message2);\n  \n  // Signatures can be non-interactively combined by anyone\n  var aggSig = BLS.AugSchemeMPL.aggregate([sig1, sig2]);\n  \n  ok = BLS.AugSchemeMPL.aggregate_verify([pk1, pk2], [message, message2], aggSig);\n  console.log(ok); // true\n  \n```\n\n### Arbitrary trees of aggregates\n```javascript\n  seed[0] = 3;\n  var sk3 = BLS.AugSchemeMPL.key_gen(seed);\n  var pk3 = sk3.get_g1();\n  var message3 = Uint8Array.from([100, 2, 254, 88, 90, 45, 23]);\n  var sig3 = BLS.AugSchemeMPL.sign(sk3, message3);\n  \n  var aggSigFinal = BLS.AugSchemeMPL.aggregate([aggSig, sig3]);\n  ok = BLS.AugSchemeMPL.aggregate_verify([pk1, pk2, pk3], [message, message2, message3], aggSigFinal);\n  console.log(ok); // true\n```\n\n### Very fast verification with Proof of Possession scheme\n```javascript\n\n  // If the same message is signed, you can use Proof of Posession (PopScheme) for efficiency\n  // A proof of possession MUST be passed around with the PK to ensure security.\n  var popSig1 = BLS.PopSchemeMPL.sign(sk1, message);\n  var popSig2 = BLS.PopSchemeMPL.sign(sk2, message);\n  var popSig3 = BLS.PopSchemeMPL.sign(sk3, message);\n  var pop1 = BLS.PopSchemeMPL.pop_prove(sk1);\n  var pop2 = BLS.PopSchemeMPL.pop_prove(sk2);\n  var pop3 = BLS.PopSchemeMPL.pop_prove(sk3);\n  \n  ok = BLS.PopSchemeMPL.pop_verify(pk1, pop1);\n  console.log(ok); // true\n  ok = BLS.PopSchemeMPL.pop_verify(pk2, pop2);\n  console.log(ok); // true\n  ok = BLS.PopSchemeMPL.pop_verify(pk3, pop3);\n  console.log(ok); // true\n  \n  var popSigAgg = BLS.PopSchemeMPL.aggregate([popSig1, popSig2, popSig3]);\n  ok = BLS.PopSchemeMPL.fast_aggregate_verify([pk1, pk2, pk3], message, popSigAgg);\n  console.log(ok); // true\n  \n  // Aggregate public key, indistinguishable from a single public key\n  var popAggPk = pk1.add(pk2).add(pk3);\n  ok = BLS.PopSchemeMPL.verify(popAggPk, message, popSigAgg);\n  console.log(ok); // true\n  \n  // Aggregate private keys\n  var aggSk = BLS.PrivateKey.aggregate([sk1, sk2, sk3]);\n  ok = (BLS.PopSchemeMPL.sign(aggSk, message).equal_to(popSigAgg));\n  console.log(ok); // true\n```\n\n### HD keys using [EIP-2333](https://github.com/ethereum/EIPs/pull/2333)\n```javascript\n  // You can derive 'child' keys from any key, to create arbitrary trees. 4 byte indeces are used.\n  // Hardened (more secure, but no parent pk -> child pk)\n  var masterSk = BLS.AugSchemeMPL.key_gen(seed);\n  var child = BLS.AugSchemeMPL.derive_child_sk(masterSk, 152);\n  var grandChild = BLS.AugSchemeMPL.derive_child_sk(child, 952);\n  \n  // Unhardened (less secure, but can go from parent pk -> child pk), BIP32 style\n  var masterPk = masterSk.get_g1();\n  var childU = BLS.AugSchemeMPL.derive_child_sk_unhardened(masterSk, 22);\n  var grandchildU = BLS.AugSchemeMPL.derive_child_sk_unhardened(childU, 0);\n  \n  var childUPk = BLS.AugSchemeMPL.derive_child_pk_unhardened(masterPk, 22);\n  var grandchildUPk = BLS.AugSchemeMPL.derive_child_pk_unhardened(childUPk, 0);\n  \n  ok = (grandchildUPk.equal_to(grandchildU.get_g1()));\n  console.log(ok); // true\n```\n\nPlease refer to the library's [typings](./blsjs.d.ts) for detailed API information. Use cases can be found in the [original lib's readme](../README.md).\n\n__Important note on usage:__ Since this library is a WebAssembly port of the c++ library, JavaScript's automatic memory management isn't available. Please, delete all objects manually if they are not needed anymore by calling the delete method on them, as shown in the example below.\n\n```javascript\n  sk.delete();\n  // ...\n  pk.delete();\n  // ...\n  sig1.delete();\n  // ...\n```\n\n### Build\n\nBuilding requires Node.js (with npm) and [Emscripten](https://emscripten.org/docs/getting_started/downloads.html) to be installed.\nThe build process is the same as for the c++ lib, with one additional step: pass the Emscripten toolchain file as an option to CMake.\nFrom the project root directory, run:\n```\n#git submodule update --init --recursive\nmkdir js_build\ncd js_build\ncmake ../ -DCMAKE_TOOLCHAIN_FILE={path_to_your_emscripten_installation}/emsdk/upstream/emscripten/cmake/Modules/Platform/Emscripten.cmake\ncmake --build . --\n```\n\nRun the build after any changes to the library, including readme and tests, as the library will be deployed from the build directory, and the build system copies all the files from the source dir.\n### Run tests\nTests are run in node.js and Firefox, therefore you need to install node.js and Firefox.\nTo run tests, build the library, then go to the `js_bindings` folder in the build directory and run\n```bash\nnpm test\n```\n","readmeFilename":"README.md"}