Interface Hop

Hierarchy

  • Hop

Properties

ampRecord: undefined | AMPRecord

An optional TLV record that signals the use of an AMP payment. If present, the receiver will treat all received payments including the same (payment_addr, set_id) pair as being part of one logical payment. The payment will be settled by XORing the root_share's together and deriving the child hashes and preimages according to BOLT XX. Must be used in conjunction with mpp_record.

amtToForwardMsat: string | number
chanId: string | number

The unique channel ID for the channel. The first 3 bytes are the block height, the next 3 the index within the block, and the last 2 bytes are the output index for the channel.

expiry: string | number
feeMsat: string | number
mppRecord: undefined | MPPRecord

An optional TLV record that signals the use of an MPP payment. If present, the receiver will enforce that the same mpp_record is included in the final hop payload of all non-zero payments in the HTLC set. If empty, a regular single-shot payment is or was attempted.

pubKey: string

An optional public key of the hop. If the public key is given, the payment can be executed without relying on a copy of the channel graph.

tlvPayload: boolean

If set to true, then this hop will be encoded using the new variable length TLV format. Note that if any custom tlv_records below are specified, then this field MUST be set to true for them to be encoded properly.

Generated using TypeDoc