Enum Scope

pub enum Scope {
    ReadInfo,
    ReadPayments,
    Read,
    Receive,
    ManageChannels,
    Spend,
    Full,
}

A named bundle of permissions to grant a ClientCredentials.

Variants

ReadInfo

Read basic info: user identity, node version, balance, and channels.

ReadPayments

Read all payments.

Read

Read everything: ReadInfo + ReadPayments, plus on-chain descriptors, Lexe SDK clients, and other miscellaneous data. Cannot read any secrets that would allow spending funds.

Receive

Create invoices, offers, and addresses to receive to, resync the node, and cancel payments. Cannot determine if invoices or offers were actually paid.

ManageChannels

Open and close channels.

Spend

Pay invoices, offers, and on-chain addresses; update payment notes.

Full

Full admin access: every permission granted by other scopes, plus signing with the identity pubkey, managing and revoking SDK clients, reading encrypted files, and updating the user’s Human Bitcoin Address and node settings.

Implementations

impl Scope

pub fn children(self) -> Vec<Scope>

The other scopes this scope fully covers, i.e. its “children”. Granting a scope implies each child, so granting a child alongside its parent is redundant (but harmless).

pub fn recommended(self) -> Vec<Scope>

Scopes recommended to be granted alongside this one, but not implied by it: e.g. most Receive clients also want the basic reads.

Trait Implementations

impl Clone for Scope

fn clone(&self) -> Scope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Scope

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Scope

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Scope> for Scope

fn from(scope: Scope) -> Self

Converts to this type from the input type.

impl Ord for Scope

fn cmp(&self, other: &Scope) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Scope

fn eq(&self, other: &Scope) -> 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 PartialOrd for Scope

fn partial_cmp(&self, other: &Scope) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Scope

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Scope

impl Eq for Scope

impl StructuralPartialEq for Scope