Skip to content

Commit

Permalink
Fix FVK doc comment
Browse files Browse the repository at this point in the history
  • Loading branch information
str4d committed Feb 3, 2021
1 parent aeddfb6 commit 1add6a7
Showing 1 changed file with 2 additions and 5 deletions.
7 changes: 2 additions & 5 deletions src/keys.rs
Original file line number Diff line number Diff line change
Expand Up @@ -52,11 +52,8 @@ impl From<&SpendingKey> for OutgoingViewingKey {

/// A key that provides the capability to view incoming and outgoing transactions.
///
/// This key is useful in situations where you only need the capability to detect inbound
/// payments, such as merchant terminals.
///
/// This key is not suitable for use in a wallet, as it cannot maintain accurate balance.
/// You should use a [`FullViewingKey`] instead.
/// This key is useful anywhere you need to maintain accurate balance, but do not want the
/// ability to spend funds (such as a view-only wallet).
///
/// TODO: Should we just define the FVK to include extended stuff like the diversifier key?
#[derive(Debug)]
Expand Down

0 comments on commit 1add6a7

Please sign in to comment.