vincenzopalazzo
/
rust-silentpayments
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
24 Commits 1 Branch 0 Tags 138 KiB
Rust 100%
Go to file
cygnet 0d28b61730
Improve receiver interface (#16) 
* Copy recipient code structure from Sosthene00 fork

* Move SilentPayment struct to receiving

* Provide shared_secret as input argument for scan_for_outputs

Also refactors a number of things to enable this change: calculate A_sum
and outpoints_hash in the test code instead of the library, remove the
obsolete hash_outpoints function from the library move calculate_P_n
and calculate_t_n to utils.rs.

* Add debug trait implementation for Label

* Refactoring

* Add get_receiving_address function for getting sp-address per label

* Refactor scan_for_outputs and rename to scan_transaction

* Provide tweak data to scan_transaction function

* Expand README.me
 		2023-08-22 21:56:08 +02:00
src Improve receiver interface (#16) 2023-08-22 21:56:08 +02:00
tests Improve receiver interface (#16) 2023-08-22 21:56:08 +02:00
.gitignore Remove Cargo.lock from source control (#14) 2023-08-16 00:21:06 +02:00
Cargo.toml Downgrade secp256k1 to 0.24 (#15) 2023-08-17 15:28:32 +02:00
README.md Improve receiver interface (#16) 2023-08-22 21:56:08 +02:00

README.md

Silent Payments

A rust implementation of BIP352: Silent Payments.

Although this library passes all the tests provided in the silent payment BIP, it is still very new, so be careful when using this with real funds.

There are two parts to this library: a sender part and a recipient part.

Sender

For sending to a silent payment address, you can call the sender::generate_recipient_pubkeys function. This function takes a recipient: Vec<String> as an argument, where the String is a bech32m encoded silent payment address (sp1q... or tsp1q...).

This function additionally takes a ecdh_shared_secrets: HashMap<PublicKey, PublicKey> argument, which maps a Spend key to a shared secret. Since this shared secret derivation requires secret data, this library expects the user to provide the pre-computed result.

See the tests/vector_tests.rs and tests/common/utils.rs files for an example of how to compute the shared secrets.

Recipient

For receiving silent payments. We have use a struct called recipient::SilentPayment. After creating this struct with a spending and scanning secret key, you can call the scan_transaction function to look for any outputs in a transaction belonging to you.

The library also supports labels. You can optionally add labels before scanning by using the add_label function.

Tests

The tests/resources folder contains a copy of the test vectors as of August 4th 2023.

You can test the code using the test vectors by running cargo test.