Struct LightningGateway

pub struct LightningGateway {
    pub federation_index: u64,
    pub gateway_redeem_key: PublicKey,
    pub node_pub_key: PublicKey,
    pub lightning_alias: String,
    pub api: SafeUrl,
    pub route_hints: Vec<RouteHint>,
    pub fees: RoutingFees,
    pub gateway_id: PublicKey,
    pub supports_private_payments: bool,
}

Information a gateway registers with a federation

Fields

federation_index: u64

Unique per-federation identifier assigned by the gateway. All clients in this federation should use this value as short_channel_id when creating invoices to be settled by this gateway.

gateway_redeem_key: PublicKey

Key used to pay the gateway

node_pub_key: PublicKey

lightning_alias: String

api: SafeUrl

URL to the gateway’s versioned public API (e.g. https://gateway.example.com/v1)

route_hints: Vec<RouteHint>

Route hints to reach the LN node of the gateway.

These will be appended with the route hint of the recipient’s virtual channel. To keeps invoices small these should be used sparingly.

fees: RoutingFees

Gateway configured routing fees

gateway_id: PublicKey

supports_private_payments: bool

Indicates if the gateway supports private payments

Trait Implementations

impl Clone for LightningGateway

fn clone(&self) -> LightningGateway

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LightningGateway

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

Formats the value using the given formatter.

impl Decodable for LightningGateway

fn consensus_decode_from_finite_reader<D: Read>( d: &mut D, modules: &ModuleDecoderRegistry, ) -> Result<Self, DecodeError>

Decode Self from a size-limited reader.

fn consensus_decode_whole( slice: &[u8], modules: &ModuleRegistry<Decoder, DecodingMode>, ) -> Result<Self, DecodeError>

fn consensus_decode<R>( r: &mut R, modules: &ModuleRegistry<Decoder, DecodingMode>, ) -> Result<Self, DecodeError>

where R: Read,

Decode an object with a well-defined format.

fn consensus_decode_hex( hex: &str, modules: &ModuleRegistry<Decoder, DecodingMode>, ) -> Result<Self, DecodeError>

Decode an object from hex

fn consensus_decode_vec( bytes: Vec<u8>, modules: &ModuleRegistry<Decoder, DecodingMode>, ) -> Result<Self, DecodeError>

impl<'de> Deserialize<'de> for LightningGateway

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Encodable for LightningGateway

fn consensus_encode<W: Write>(&self, writer: &mut W) -> Result<usize, Error>

Encode an object with a well-defined format. Returns the number of bytes written on success.

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

Self::consensus_encode to newly allocated Vec<u8>

fn consensus_encode_to_hex(&self) -> String

Encode and convert to hex string representation

fn consensus_encode_to_len(&self) -> usize

Encode without storing the encoding, return the size

fn consensus_hash<H>(&self) -> H

where H: Hash, <H as Hash>::Engine: Write,

Generate a SHA256 hash of the consensus encoding using the default hash engine for H.

fn consensus_hash_sha256(&self) -> Hash

Self::consensus_hash for [bitcoin::hashes::sha256::Hash]

impl Hash for LightningGateway

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 LightningGateway

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for LightningGateway

impl StructuralPartialEq for LightningGateway