https://github.com/ronickg/react-native-bls-signatures
React Native wrapper for BLS Signatures
https://github.com/ronickg/react-native-bls-signatures
bls12-381 chia cpp jini jsi react react-native
Last synced: 14 days ago
JSON representation
React Native wrapper for BLS Signatures
- Host: GitHub
- URL: https://github.com/ronickg/react-native-bls-signatures
- Owner: ronickg
- License: mit
- Created: 2023-09-07T14:59:52.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-20T13:15:44.000Z (over 1 year ago)
- Last Synced: 2025-08-16T05:36:09.390Z (about 2 months ago)
- Topics: bls12-381, chia, cpp, jini, jsi, react, react-native
- Language: C
- Homepage: https://www.npmjs.com/package/react-native-bls-signatures
- Size: 28.7 MB
- Stars: 16
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# React Native BLS Signatures
This is a React Native wrapper for [BLS Signatures](https://github.com/Chia-Network/bls-signatures) that offers quick and direct bindings to the native C++ library, accessible through a user-friendly TypeScript API.
## Installation
To use this library in your React Native project run the following command:
```sh
yarn add react-native-bls-signatures
```
or
```sh
npm install react-native-bls-signatures
```
## Example
```typescript
const seed = Uint8Array.from([
0, 50, 6, 244, 24, 199, 1, 25, 52, 88, 192, 19, 18, 12, 89, 6, 220, 18, 102,
58, 209, 82, 12, 62, 89, 110, 182, 9, 44, 20, 254, 22,
]).buffer;
const sk = AugSchemeMPL.keyGen(seed);
const pk = sk.getG1();
const message = Uint8Array.from([1, 2, 3, 4, 5]).buffer;
const signature = AugSchemeMPL.sign(sk, message);
const ok = AugSchemeMPL.verify(pk, message, signature);
console.log(ok); // true
```
## Documentation
- [AugSchemeMPL](#augschemempl)
- [BasicSchemeMPL](#basicschemempl)
- [PopSchemeMPL](#popschemempl)
- [PrivateKey](#privatekey)
- [G1Element](#g1element)
- [G2Element](#g2element)
- [Utils](#utils)
## AugSchemeMPL
### Static Methods:
- **skToG1**(_sk:_ `PrivateKey`) -> `G1Element`
- **keyGen**(_seed:_ `ArrayBuffer`) -> `PrivateKey`
- **sign**(_sk:_ `PrivateKey`, _msg:_ `ArrayBuffer`) -> `G2Element`
- **signPrepend**(_sk:_ `PrivateKey`, _msg:_ `ArrayBuffer`, _prependPk:_ `G1Element`) -> `G2Element`
- **verify**(_pk:_ `G1Element`, _msg:_ `ArrayBuffer`, _sig:_ `G2Element`) -> `boolean`
- **aggregate**(_g2Elements:_ `G2Element[]`) -> `G2Element`
- **aggregateVerify**(_pks:_ `G1Element[]`, _msgs:_ `ArrayBuffer[]`, _sig:_ `G2Element`) -> `boolean`
- **deriveChildSk**(_sk:_ `PrivateKey`, _index:_ `number`) -> `PrivateKey`
- **deriveChildSkUnhardened**(_sk:_ `PrivateKey`, _index:_ `number`) -> `PrivateKey`
- **deriveChildPkUnhardened**(_pk:_ `G1Element`, _index:_ `number`) -> `G1Element`
## BasicSchemeMPL
### Static Methods:
- **skToG1**(_sk:_ `PrivateKey`) -> `G1Element`
- **keyGen**(_seed:_ `ArrayBuffer`) -> `PrivateKey`
- **sign**(_sk:_ `PrivateKey`, _msg:_ `ArrayBuffer`) -> `G2Element`
- **verify**(_pk:_ `G1Element`, _msg:_ `ArrayBuffer`, _sig:_ `G2Element`) -> `boolean`
- **aggregate**(_g2Elements:_ `G2Element[]`) -> `G2Element`
- **aggregateVerify**(_pks:_ `G1Element[]`, _msgs:_ `ArrayBuffer[]`, _sig:_ `G2Element`) -> `boolean`
- **deriveChildSk**(_sk:_ `PrivateKey`, _index:_ `number`) -> `PrivateKey`
- **deriveChildSkUnhardened**(_sk:_ `PrivateKey`, _index:_ `number`) -> `PrivateKey`
- **deriveChildPkUnhardened**(_pk:_ `G1Element`, _index:_ `number`) -> `G1Element`
## PopSchemeMPL
### Static Methods:
- **skToG1**(_sk:_ `PrivateKey`) -> `G1Element`
- **keyGen**(_seed:_ `ArrayBuffer`) -> `PrivateKey`
- **sign**(_sk:_ `PrivateKey`, _msg:_ `ArrayBuffer`) -> `G2Element`
- **verify**(_pk:_ `G1Element`, _msg:_ `ArrayBuffer`, _sig:_ `G2Element`) -> `boolean`
- **aggregate**(_g2Elements:_ `G2Element[]`) -> `G2Element`
- **aggregateVerify**(_pks:_ `G1Element[]`, _msgs:_ `ArrayBuffer[]`, _sig:_ `G2Element`) -> `boolean`
- **deriveChildSk**(_sk:_ `PrivateKey`, _index:_ `number`) -> `PrivateKey`
- **deriveChildSkUnhardened**(_sk:_ `PrivateKey`, _index:_ `number`) -> `PrivateKey`
- **deriveChildPkUnhardened**(_pk:_ `G1Element`, _index:_ `number`) -> `G1Element`
- **popVerify**(_pk:_ `G1Element`, _sigProof:_ `G2Element`) -> `boolean`
- **popProve**(_sk:_ `PrivateKey`) -> `G2Element`
- **fastAggregateVerify**(_pks:_ `G1Element[]`, _msg:_ `ArrayBuffer`, _sig:_ `G2Element`) -> `boolean`
## PrivateKey
### Static Methods:
- **fromBytes**(_bytes:_ `ArrayBuffer`, _modOrder_?: `boolean`) -> `PrivateKey`
- **fromHex**(_hex:_ `string`) -> `PrivateKey`
- **aggregate**(_pks:_ `PrivateKey[]`) -> `PrivateKey`
### Methods:
- **toBytes()** -> `ArrayBuffer`
- **toHex()** -> `string`
- **toString()** -> `string`
- **equals**(_sk:_ `PrivateKey`) -> `boolean`
- **getG1()** -> `G1Element`
- **getG2()** -> `G2Element`
## G1Element
### Static Methods:
- **fromBytes**(_bytes:_ `ArrayBuffer`) -> `G1Element`
- **fromHex**(_hex:_ `string`) -> `G1Element`
### Methods:
- **toBytes()** -> `ArrayBuffer`
- **toHex()** -> `string`
- **getFingerPrint()** -> `number`
- **add**(_g1e:_ `G1Element`) -> `G1Element`
- **negate()** -> `G1Element`
- **equals**(_g1e:_ `G1Element`) -> `boolean`
## G2Element
### Static Methods:
- **fromBytes**(_bytes:_ `ArrayBuffer`) -> `G2Element`
- **fromHex**(_hex:_ `string`) -> `G2Element`
### Methods:
- **toBytes()** -> `ArrayBuffer`
- **toHex()** -> `string`
- **add**(_g2e:_ `G2Element`) -> `G2Element`
- **negate()** -> `G2Element`
- **equals**(_g2e:_ `G2Element`) -> `boolean`
## Utils
- **hash256**(_msg:_ `ArrayBuffer`) -> `ArrayBuffer`
- **toHex**(_bytes:_ `ArrayBuffer`) -> `string`
- **fromHex**(_hex:_ `string`) -> `ArrayBuffer`
- **getRandomSeed()** -> `ArrayBuffer` Only use if sodium is enabled!
## Libsodium license
The libsodium static library is licensed under the ISC license which requires
the following copyright notice.
> ISC License
>
> Copyright (c) 2013-2020
> Frank Denis \
>
> Permission to use, copy, modify, and/or distribute this software for any
> purpose with or without fee is hereby granted, provided that the above
> copyright notice and this permission notice appear in all copies.
>
> THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
> WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
> MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
> ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
> WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
> ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
> OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
## BLST license
BLST is used with the
[Apache 2.0 license](https://github.com/supranational/blst/blob/master/LICENSE)
## Resources
- [Chia-Network/bls-signatures](https://github.com/Chia-Network/bls-signatures) code for bls
- [Marc Rousavy](https://github.com/mrousavy) thanks for all the examples
- [animo/react-native-bbs-signatures](https://github.com/animo/react-native-bbs-signatures) also great example