@node-lightning/wire
Version:
Lightning Network Wire Protocol
36 lines (35 loc) • 1.62 kB
TypeScript
/// <reference types="node" />
import { OutPoint } from "@node-lightning/core";
import { ChannelAnnouncementMessage } from "./ChannelAnnouncementMessage";
/**
* Decorator for the channel_announcement that includes the additional
* information provided by the on-chain validation. Specifically, the
* channel_announcement message only has a short_channel_id with block, tx num,
* and vout num. We need to obtain the txid as well as the outpoint value to
* determine the value of the channel.
*
* This information is stored in this decorator class which can be broadcast
* and used downstream by clients that need both sets of information. Additionally
* the use of this decorator allows us to store the on-chain data along side the
* channel_announcement data if so desired.
*/
export declare class ExtendedChannelAnnouncementMessage extends ChannelAnnouncementMessage {
/**
* Constructs a new ExtendedChannelAnnouncementMessage from the plain-jane
* ChannelAnnouncementMessage
*/
static fromMessage(msg: ChannelAnnouncementMessage): ExtendedChannelAnnouncementMessage;
static deserialize(payload: Buffer): ExtendedChannelAnnouncementMessage;
/**
* OutPoint for the channel that includes the transaction identifier as well
* as the vout index. This information is obtained by finding the transaction
* in a block based on the short_channel_id.
*/
outpoint: OutPoint;
/**
* Capacity of the funding transaction. This information is obtained from on-chain
* validation of the transaction.
*/
capacity: bigint;
serialize(): Buffer;
}