Struct VelocityControl

pub struct VelocityControl {
    pub start_sec: u64,
    pub bucket_interval: u32,
    pub buckets: Vec<u64>,
    pub limit: u64,
}

Limit velocity per unit time.

We track velocity in intervals instead of tracking each send, to keep storage requirements constant.

Fields

start_sec: u64

start second for the current velocity epoch

bucket_interval: u32

the number of seconds represented by a bucket

buckets: Vec<u64>

each bucket entry is the total velocity detected in that interval, in satoshi

limit: u64

the limit, or MAX if the control is disabled

Implementations

impl VelocityControl

pub fn new_with_intervals( limit_msat: u64, bucket_interval: u32, num_buckets: usize, ) -> Self

Create a velocity control with arbitrary specified intervals current_sec: the current second num_buckets: how many buckets to keep track of bucket_interval: each bucket represents this number of seconds limit: the total velocity limit when summing the buckets

pub fn new_unlimited(bucket_interval: u32, num_buckets: usize) -> Self

Create an unlimited velocity control (i.e. no actual control)

pub fn new(spec: VelocityControlSpec) -> Self

Create a velocity control with the given interval type

pub fn spec_matches(&self, spec: &VelocityControlSpec) -> bool

Whether the spec matches this control

pub fn update_spec(&mut self, spec: &VelocityControlSpec)

Update this control to match the given spec. If the spec does not match the previous spec, the control is reset.

pub fn load_from_state( spec: VelocityControlSpec, state: (u64, Vec<u64>), ) -> Self

Load from persistence

pub fn get_state(&self) -> (u64, Vec<u64>)

Get the state for persistence

pub fn is_unlimited(&self) -> bool

Whether this instance is unlimited (no control)

pub fn insert(&mut self, current_sec: u64, velocity_msat: u64) -> bool

Update the velocity given the passage of time given by current_sec and the given velocity. If the limit would be exceeded, the given velocity is not inserted and false is returned.

pub fn clear(&mut self)

Clear the control (e.g. when the user manually approves)

pub fn velocity(&self) -> u64

The total msat velocity in the tracked interval.

If this is an unlimited control, zero is always returned.

Trait Implementations

impl Clone for VelocityControl

fn clone(&self) -> VelocityControl

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VelocityControl

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

Formats the value using the given formatter.