Struct RevocationKey

pub struct RevocationKey(pub PublicKey);

The revocation key is used to allow a channel party to revoke their state - giving their counterparty the required material to claim all of their funds if they broadcast that state.

Each commitment transaction has a revocation key based on the basepoint and per_commitment_point which is used in both commitment and HTLC transactions.

See [the BOLT spec for derivation details] https://github.com/lightning/bolts/blob/master/03-transactions.md#revocationpubkey-derivation

Tuple Fields

0: PublicKey

Implementations

impl RevocationKey

pub fn from_basepoint<T: Verification>( secp_ctx: &Secp256k1<T>, countersignatory_basepoint: &RevocationBasepoint, per_commitment_point: &PublicKey, ) -> Self

Derives a per-commitment-transaction revocation public key from one party’s per-commitment point and the other party’s RevocationBasepoint. This is the public equivalent of chan_utils::derive_private_revocation_key - using only public keys to derive a public key instead of private keys.

Note that this is infallible iff we trust that at least one of the two input keys are randomly generated (ie our own).

pub fn to_public_key(&self) -> PublicKey

Get inner Public Key

Trait Implementations

impl Clone for RevocationKey

fn clone(&self) -> RevocationKey

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RevocationKey

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for RevocationKey

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for RevocationKey

fn eq(&self, other: &RevocationKey) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Readable for RevocationKey

fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError>

Reads a Self in from the given Read.

impl Writeable for RevocationKey

fn write<W: Writer>(&self, w: &mut W) -> Result<(), Error>

Writes self out to the given Writer.

fn encode(&self) -> Vec<u8>

Writes self out to a Vec<u8>.

fn serialized_length(&self) -> usize

Gets the length of this object after it has been serialized. This can be overridden to optimize cases where we prepend an object with its length.

impl Copy for RevocationKey

impl Eq for RevocationKey

impl StructuralPartialEq for RevocationKey