Struct SdkNodeInfo

pub struct SdkNodeInfo {
    pub version: Version,
    pub measurement: Measurement,
    pub user_pk: UserPk,
    pub node_pk: NodePk,
    pub balance: Amount,
    pub lightning_balance: Amount,
    pub lightning_sendable_balance: Amount,
    pub lightning_max_sendable_balance: Amount,
    pub onchain_balance: Amount,
    pub onchain_trusted_balance: Amount,
    pub num_channels: usize,
    pub num_usable_channels: usize,
}

Information about a Lexe node.

Fields

version: Version

The node’s current semver version, e.g. 0.6.9.

measurement: Measurement

The hex-encoded SGX ‘measurement’ of the current node. The measurement is the hash of the enclave binary.

user_pk: UserPk

The hex-encoded ed25519 user public key used to identify a Lexe user. The user keypair is derived from the root seed.

node_pk: NodePk

The hex-encoded secp256k1 Lightning node public key; the node_id.

balance: Amount

The sum of our lightning_balance and our onchain_balance, in sats.

lightning_balance: Amount

Total Lightning balance in sats, summed over all of our channels.

lightning_sendable_balance: Amount

An estimated upper bound, in sats, on how much of our Lightning balance we can send to most recipients on the Lightning Network, accounting for Lightning limits such as our channel reserve, pending HTLCs, fees, etc. You should usually be able to spend this amount.

lightning_max_sendable_balance: Amount

A hard upper bound on how much of our Lightning balance can be spent right now, in sats. This is always >= lightning_sendable_balance. Generally it is only possible to spend exactly this amount if the recipient is a Lexe user.

onchain_balance: Amount

Total on-chain balance in sats, including unconfirmed funds.

onchain_trusted_balance: Amount

Trusted on-chain balance in sats, including only confirmed funds and unconfirmed outputs originating from our own wallet.

num_channels: usize

The total number of Lightning channels.

num_usable_channels: usize

The number of channels which are currently usable, i.e. channel_ready messages have been exchanged and the channel peer is online. Is always less than or equal to num_channels.

Trait Implementations

impl Clone for SdkNodeInfo

fn clone(&self) -> SdkNodeInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SdkNodeInfo

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SdkNodeInfo

fn deserialize<__D>( __deserializer: __D, ) -> Result<SdkNodeInfo, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<NodeInfo> for SdkNodeInfo

fn from(info: NodeInfo) -> SdkNodeInfo

Converts to this type from the input type.

impl Serialize for SdkNodeInfo

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

where __S: Serializer,

Serialize this value into the given Serde serializer.