https://github.com/vulpemventures/secp256k1-zkp
JavaScript bindings of libsecp256k1-zkp with support for pedersen commitments and range proofs.
https://github.com/vulpemventures/secp256k1-zkp
Last synced: 12 months ago
JSON representation
JavaScript bindings of libsecp256k1-zkp with support for pedersen commitments and range proofs.
- Host: GitHub
- URL: https://github.com/vulpemventures/secp256k1-zkp
- Owner: vulpemventures
- License: mit
- Created: 2020-01-17T18:04:00.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-01-05T13:36:38.000Z (over 2 years ago)
- Last Synced: 2025-06-22T16:17:50.994Z (12 months ago)
- Language: TypeScript
- Homepage:
- Size: 11.3 MB
- Stars: 17
- Watchers: 4
- Forks: 10
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/vulpemventures/secp256k1-zkp)
[](https://github.com/feross/standard)
# secp256k1-zkp
Essential methods of the secp256k1-zkp lib exported to JS for handling Elements confidential transactions
## Installation
Use the package manager yarn or npm to install secp256k1-zkp.
```bash
yarn add @vulpemventures/secp256k1-zkp
npm install @vulpemventures/secp256k1-zkp
```
## Usage
The library is exported as a function that returns a promise.
```ts
import secp256k1 from '@vulpemventures/secp256k1-zkp'
async function main() {
const lib = await secp256k1();
// use the library functions
}
```
## Documentation
Typedoc html page is available via:
```bash
yarn doc
```
## Development
Fetch submodules
```bash
git submodule update --init --recursive
```
Install dependencies
```bash
yarn install
```
Compile the WASM (writes ./lib/secp256k1-zkp.js file)
```bash
yarn compile
```
Build the library
```bash
yarn build
```
Run tests
```bash
yarn test
```
## Contributing
Pull requests are welcome. For major changes, please open an issue first
to discuss what you would like to change.
Please make sure to update tests as appropriate.
## License
[MIT](https://choosealicense.com/licenses/mit/)