Skip to content

Commit

Permalink
add README
Browse files Browse the repository at this point in the history
Signed-off-by: Ignacio Hagopian <jsign.uy@gmail.com>
  • Loading branch information
jsign committed Dec 17, 2023
1 parent 511fa7f commit 0fed61c
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 1 deletion.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Ethereum stealth addresses (ERC-5564) library
This repository is a Zig implementation of the Ethereum stealth addresses ([ERC-5564](https://eips.ethereum.org/EIPS/eip-5564#specification)).

The implementation has zero dependencies (i.e: only relies on Zig standard library).

**Note: this library hasn't been audited, use it at your own risk.**

## What are stealth addresses?
> **Stealth addresses** are a way of protecting the **privacy of recipients** in cryptocurrency transactions.
They allow a sender to **non-interactively** generate a new address for the recipient, making it look like as if the sender interacted with some random account.

## Where I can find more resources about stealth addresses?
- [ERC-5564](https://eips.ethereum.org/EIPS/eip-5564#specification) and [ERC-6538](https://eips.ethereum.org/EIPS/eip-6538).
- [Stealth Addresses tutorial](https://nerolation.github.io/stealth-utils/) by Toni Wahrstätter.
- [An incomplete guide to stealth addresses](https://vitalik.eth.limo/general/2023/01/20/stealth.html) by Vitalik.
- Web-based [Stealth wallet](https://stealth-wallet.xyz/) by Toni Wahrstätter.

## How can I use this library?
You can use this library as a dependency in your Zig project by adding it as a dependency to your `build.zig.zon` file.

See the [library tests](https://github.com/jsign/zig-stealth-addresses/blob/511fa7f14875675a8565ecf156d1125b6ca3dfd8/src/stealth_address.zig#L94-L147) for some examples of how to use the defined APIs.

In the future, this repo might include a CLI tool to generate and interact with stealth addresses.

## License
MIT.
2 changes: 1 addition & 1 deletion build.zig.zon
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.{
.name = "zig-stealth-addresses",
.version = "0.0.1",
.version = "0.1.0",
.minimum_zig_version = "0.11.0",
.dependencies = .{},
.paths = .{""},
Expand Down

0 comments on commit 0fed61c

Please sign in to comment.