Class BlindedPayInfo


  • public class BlindedPayInfo
    extends Object
    Information needed to route a payment across a [`BlindedPath`].
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      BlindedPayInfo clone()
      Creates a copy of the BlindedPayInfo
      boolean eq​(BlindedPayInfo b)
      Checks if two BlindedPayInfos contain equal inner contents.
      boolean equals​(Object o)  
      protected void finalize()  
      short get_cltv_expiry_delta()
      Number of blocks subtracted from an incoming HTLC's `cltv_expiry` for the entire blinded path.
      BlindedHopFeatures get_features()
      Features set in `encrypted_data_tlv` for the `encrypted_recipient_data` TLV record in an onion payload.
      int get_fee_base_msat()
      Base fee charged (in millisatoshi) for the entire blinded path.
      int get_fee_proportional_millionths()
      Liquidity fee charged (in millionths of the amount transferred) for the entire blinded path (i.e., 10,000 is 1%).
      long get_htlc_maximum_msat()
      The maximum HTLC value (in millisatoshi) that is acceptable to all channel peers on the blinded path from the introduction node to the recipient, accounting for any fees, i.e., as seen by the recipient.
      long get_htlc_minimum_msat()
      The minimum HTLC value (in millisatoshi) that is acceptable to all channel peers on the blinded path from the introduction node to the recipient, accounting for any fees, i.e., as seen by the recipient.
      long hash()
      Generates a non-cryptographic 64-bit hash of the BlindedPayInfo.
      int hashCode()  
      static BlindedPayInfo of​(int fee_base_msat_arg, int fee_proportional_millionths_arg, short cltv_expiry_delta_arg, long htlc_minimum_msat_arg, long htlc_maximum_msat_arg, BlindedHopFeatures features_arg)
      Constructs a new BlindedPayInfo given each field
      static Result_BlindedPayInfoDecodeErrorZ read​(byte[] ser)
      Read a BlindedPayInfo from a byte array, created by BlindedPayInfo_write
      void set_cltv_expiry_delta​(short val)
      Number of blocks subtracted from an incoming HTLC's `cltv_expiry` for the entire blinded path.
      void set_features​(BlindedHopFeatures val)
      Features set in `encrypted_data_tlv` for the `encrypted_recipient_data` TLV record in an onion payload.
      void set_fee_base_msat​(int val)
      Base fee charged (in millisatoshi) for the entire blinded path.
      void set_fee_proportional_millionths​(int val)
      Liquidity fee charged (in millionths of the amount transferred) for the entire blinded path (i.e., 10,000 is 1%).
      void set_htlc_maximum_msat​(long val)
      The maximum HTLC value (in millisatoshi) that is acceptable to all channel peers on the blinded path from the introduction node to the recipient, accounting for any fees, i.e., as seen by the recipient.
      void set_htlc_minimum_msat​(long val)
      The minimum HTLC value (in millisatoshi) that is acceptable to all channel peers on the blinded path from the introduction node to the recipient, accounting for any fees, i.e., as seen by the recipient.
      byte[] write()
      Serialize the BlindedPayInfo object into a byte array which can be read by BlindedPayInfo_read
    • Method Detail

      • get_fee_base_msat

        public int get_fee_base_msat()
        Base fee charged (in millisatoshi) for the entire blinded path.
      • set_fee_base_msat

        public void set_fee_base_msat​(int val)
        Base fee charged (in millisatoshi) for the entire blinded path.
      • get_fee_proportional_millionths

        public int get_fee_proportional_millionths()
        Liquidity fee charged (in millionths of the amount transferred) for the entire blinded path (i.e., 10,000 is 1%).
      • set_fee_proportional_millionths

        public void set_fee_proportional_millionths​(int val)
        Liquidity fee charged (in millionths of the amount transferred) for the entire blinded path (i.e., 10,000 is 1%).
      • get_cltv_expiry_delta

        public short get_cltv_expiry_delta()
        Number of blocks subtracted from an incoming HTLC's `cltv_expiry` for the entire blinded path.
      • set_cltv_expiry_delta

        public void set_cltv_expiry_delta​(short val)
        Number of blocks subtracted from an incoming HTLC's `cltv_expiry` for the entire blinded path.
      • get_htlc_minimum_msat

        public long get_htlc_minimum_msat()
        The minimum HTLC value (in millisatoshi) that is acceptable to all channel peers on the blinded path from the introduction node to the recipient, accounting for any fees, i.e., as seen by the recipient.
      • set_htlc_minimum_msat

        public void set_htlc_minimum_msat​(long val)
        The minimum HTLC value (in millisatoshi) that is acceptable to all channel peers on the blinded path from the introduction node to the recipient, accounting for any fees, i.e., as seen by the recipient.
      • get_htlc_maximum_msat

        public long get_htlc_maximum_msat()
        The maximum HTLC value (in millisatoshi) that is acceptable to all channel peers on the blinded path from the introduction node to the recipient, accounting for any fees, i.e., as seen by the recipient.
      • set_htlc_maximum_msat

        public void set_htlc_maximum_msat​(long val)
        The maximum HTLC value (in millisatoshi) that is acceptable to all channel peers on the blinded path from the introduction node to the recipient, accounting for any fees, i.e., as seen by the recipient.
      • get_features

        public BlindedHopFeatures get_features()
        Features set in `encrypted_data_tlv` for the `encrypted_recipient_data` TLV record in an onion payload.
      • set_features

        public void set_features​(BlindedHopFeatures val)
        Features set in `encrypted_data_tlv` for the `encrypted_recipient_data` TLV record in an onion payload.
      • of

        public static BlindedPayInfo of​(int fee_base_msat_arg,
                                        int fee_proportional_millionths_arg,
                                        short cltv_expiry_delta_arg,
                                        long htlc_minimum_msat_arg,
                                        long htlc_maximum_msat_arg,
                                        BlindedHopFeatures features_arg)
        Constructs a new BlindedPayInfo given each field
      • hash

        public long hash()
        Generates a non-cryptographic 64-bit hash of the BlindedPayInfo.
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object
      • eq

        public boolean eq​(BlindedPayInfo b)
        Checks if two BlindedPayInfos contain equal inner contents. This ignores pointers and is_owned flags and looks at the values in fields. Two objects with NULL inner values will be considered "equal" here.
      • write

        public byte[] write()
        Serialize the BlindedPayInfo object into a byte array which can be read by BlindedPayInfo_read