AtHeartEngineer/stealth-address-kit
1
0
Fork 0
mirror of https://github.com/vacp2p/stealth-address-kit.git synced 2026-01-09 14:48:08 -05:00
Code Issues Packages Projects Releases Wiki Activity

docs: update readme.md (#15)

Browse Source
This commit is contained in:
Aaryamann Challani
2024-06-18 11:08:02 +05:30
committed by GitHub
parent edea2c9e0d
commit 8de24395cb
1 changed files with 38 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
README.md
View File

@@ -1,8 +1,10 @@
# stealth-address-kit
# Stealth Address Kit
Uses the [arkworks-rs](https://github.com/arkworks-rs/curves) suite of libraries.
The Stealth Address Kit leverages the [arkworks-rs](https://github.com/arkworks-rs/curves) suite of libraries to provide a robust implementation of stealth addresses.
## Existing Implementations
## Supported Curves
The following curves are currently supported:
1. `ark_bn254`
2. `ark_bls_12_381`
@@ -14,17 +16,19 @@ Uses the [arkworks-rs](https://github.com/arkworks-rs/curves) suite of libraries
8. `bw6_761`
9. `baby_jub_jub`
## Usage
## Usage Example
Below is an example demonstrating how to use the Stealth Address Kit with the `ark_bn254` curve:
```rust
use stealth_address_kit::StealthAddressOnCurve;
use ark_bn254::Bn254; // or ark_bls_12_381::Bls12_381 or ark_bls_12_377::Bls12_377, stealth_address_kit::Secp256k1, stealth_address_kit::Secp256r1, etc
use ark_bn254::Bn254;
fn main() {
let (spending_key, spending_public_key) = Bn254::random_keypair();
let (viewing_key, viewing_public_key) = Bn254::random_keypair();
// generate ephemeral keypair
// Generate ephemeral keypair
let (ephemeral_private_key, ephemeral_public_key) = Bn254::random_keypair();
let (stealth_address, view_tag) = Bn254::generate_stealth_address(viewing_public_key, spending_public_key, ephemeral_private_key);
@@ -40,32 +44,44 @@ fn main() {
}
```
## Adding a new curve
## Adding a New Curve
1. Add the curve to the `Cargo.toml` file, as a feature
2. Create a new module in the `src` directory, with the curve name, suffixed by `_impl.rs`
3. Implement the `StealthAddressOnCurve` trait for the curve
4. Define the macro `define_curve_ffi`
5. Add the curve to the `lib.rs` file, in the `mod` declaration, as well as re-export if required
6. Add the curve to the README
7. Add the curve to the nightly release workflow
To add support for a new curve, follow these steps:
1. Add the curve to the `Cargo.toml` file as a feature.
2. Create a new module in the `src` directory with the curve name, suffixed by `_impl.rs`.
3. Implement the `StealthAddressOnCurve` trait for the curve.
4. Define the macro `define_curve_ffi`.
5. Add the curve to the `lib.rs` file in the `mod` declaration, and re-export if required.
6. Update the README to include the new curve.
7. Add the curve to the nightly release workflow.
## Building and Testing
1. Building
`cargo build --release --features <bn254/bls12_381/bls12_377/secp256k1/secp256r1/etc>`
### Building
2. Testing
`cargo test --release --features <bn254/bls12_381/bls12_377/secp256k1/secp256r1/etc>`
To build the project, use the following command:
## FFI Api
```sh
cargo build --release --features <bn254/bls12_381/bls12_377/secp256k1/secp256r1/etc>
```
### Testing
To run tests, use the following command:
```sh
cargo test --release --features <bn254/bls12_381/bls12_377/secp256k1/secp256r1/etc>
```
## FFI API
The exposed FFI API supports all curves, prefixed by the curve name. Ensure that the correct feature is enabled when building the library.
## Precompiled Libraries
Check out the nightly releases.
Precompiled libraries are available in the nightly releases.
## Attribution
## Acknowledgements
- Inspired by the [erc-5564](https://eips.ethereum.org/EIPS/eip-5564) eip and the [poc](https://github.com/nerolation/EIP-Stealth-Address-ERC/blob/main/minimal_poc.ipynb) by Nerolation.
This project is inspired by the [ERC-5564](https://eips.ethereum.org/EIPS/eip-5564) EIP and the [proof of concept](https://github.com/nerolation/EIP-Stealth-Address-ERC/blob/main/minimal_poc.ipynb) by Nerolation.