Silent Payments Dev Kit

Warning

SPDK currently relies on cryptography that is not professionally reviewed. Be mindful of this when using SPDK with real funds.

SPDK is a library that can be used to build silent payment-based wallets. It consists of 4 sub-crates:

• spdk-core, an internal library that is used for organizing crates within this workspace.
  • Defines a ChainBackend trait, that can be used be consumers (e.g. backend-blindbit-v1) to provide chain data.
  • Defines an Updater trait, that can be used by wallets to receive updates while scanning the chain.
• backend-blindbit-v1, a chain backend that implements a bip352 light client.
• silentpayments, the cryptography library that implements silent-payment related operations. Note: although this library passes the test vectors from the BIP, it is not professionally reviewed for security.
• spdk-wallet, a high-level crate that implements a Client and a Scanner. These can be used to scan the chain for incoming payments, and creating and signing transactions.

How to use

If you want to build a silent payments wallet, add spdk-wallet to your Cargo.toml:

[dependencies]
spdk-wallet = { git = "https://github.com/cygnet3/spdk", branch = "master" }

The other crates don't need to be imported directly. By default, this library will use backend-blindbit-v1 as a chain backend.

Examples

SPDK is currently being used by Dana, a flutter-based silent payments wallet.