2021-05-01 18:33:34 +00:00
<!DOCTYPE html > < html > < head > < meta http-equiv = "X-UA-Compatible" content = "IE=edge" / > < meta content = "width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no" name = "viewport" / > < title > < / title > < meta content = "" name = "description" / > < meta content = "" name = "keywords" / > < meta http-equiv = "content-type" content = "text/html; charset=UTF-8" / > < link href = "../lib/index.css" media = "screen" type = "text/css" rel = "stylesheet" / > < link href = "../lib/template.css" media = "screen" type = "text/css" rel = "stylesheet" / > < link href = "../lib/print.css" media = "print" type = "text/css" rel = "stylesheet" / > < link href = "../lib/diagrams.css" media = "screen" type = "text/css" rel = "stylesheet" id = "diagrams-css" / > < script type = "text/javascript" src = "../lib/jquery.min.js" > < / script > < script type = "text/javascript" src = "../lib/index.js" > < / script > < script type = "text/javascript" src = "../index.js" > < / script > < script type = "text/javascript" src = "../lib/scheduler.js" > < / script > < script type = "text/javascript" src = "../lib/template.js" > < / script > < script type = "text/javascript" > / * t h i s v a r i a b l e c a n b e u s e d b y t h e J S t o d e t e r m i n e t h e p a t h t o t h e r o o t d o c u m e n t * /
2021-06-21 21:43:03 +00:00
var toRoot = '../';< / script > < / head > < body > < div id = "search" > < span id = "doc-title" > < span id = "doc-version" > < / span > < / span > < span class = "close-results" > < span class = "left" > < < / span > Back< / span > < div id = "textfilter" > < span class = "input" > < input autocapitalize = "none" placeholder = "Search" id = "index-input" type = "text" accesskey = "/" / > < i class = "clear material-icons" > < / i > < i id = "search-icon" class = "material-icons" > < / i > < / span > < / div > < / div > < div id = "search-results" > < div id = "search-progress" > < div id = "progress-fill" > < / div > < / div > < div id = "results-content" > < div id = "entity-results" > < / div > < div id = "member-results" > < / div > < / div > < / div > < div id = "content-scroll-container" style = "-webkit-overflow-scrolling: touch;" > < div id = "content-container" style = "-webkit-overflow-scrolling: touch;" > < div id = "subpackage-spacer" > < div id = "packages" > < h1 > Packages< / h1 > < ul > < li class = "indented0 " name = "_root_.root" group = "Ungrouped" fullComment = "yes" data-isabs = "false" visbl = "pub" > < a id = "_root_" class = "anchorToMember" > < / a > < a id = "root:_root_" class = "anchorToMember" > < / a > < span class = "permalink" > < a href = "../index.html" title = "Permalink" > < i class = "material-icons" > < / i > < / a > < / span > < span class = "modifier_kind" > < span class = "modifier" > < / span > < span class = "kind" > package< / span > < / span > < span class = "symbol" > < a href = "../index.html" title = "" > < span class = "name" > root< / span > < / a > < / span > < div class = "fullcomment" > < dl class = "attributes block" > < dt > Definition Classes< / dt > < dd > < a href = "../index.html" name = "_root_" id = "_root_" class = "extype" > root< / a > < / dd > < / dl > < / div > < / li > < li class = "indented1 " name = "_root_.lnrpc" group = "Ungrouped" fullComment = "yes" data-isabs = "false" visbl = "pub" > < a id = "lnrpc" class = "anchorToMember" > < / a > < a id = "lnrpc:lnrpc" class = "anchorToMember" > < / a > < span class = "permalink" > < a href = "../lnrpc/index.html" title = "Permalink" > < i class = "material-icons" > < / i > < / a > < / span > < span class = "modifier_kind" > < span class = "modifier" > < / span > < span class = "kind" > package< / span > < / span > < span class = "symbol" > < a href = "index.html" title = "" > < span class = "name" > lnrpc< / span > < / a > < / span > < div class = "fullcomment" > < dl class = "attributes block" > < dt > Definition Classes< / dt > < dd > < a href = "../index.html" name = "_root_" id = "_root_" class = "extype" > root< / a > < / dd > < / dl > < / div > < / li > < li class = "current-entities indented1" > < a href = "AMP$.html" title = "" class = "object" > < / a > < a href = "AMP.html" title = "Details specific to AMP HTLCs." class = "class" > < / a > < a href = "AMP.html" title = "Details specific to AMP HTLCs." > AMP< / a > < / li > < li class = "current-entities indented1" > < a href = "AMPRecord$.html" title = "" class = "object" > < / a > < a href = "AMPRecord.html" title = "" class = "class" > < / a > < a href = "AMPRecord.html" title = "" > AMPRecord< / a > < / li > < li class = "current-entities indented1" > < a href = "AbandonChannelRequest$.html" title = "" class = "object" > < / a > < a href = "AbandonChannelRequest.html" title = "" class = "class" > < / a > < a href = "AbandonChannelRequest.html" title = "" > AbandonChannelRequest< / a > < / li > < li class = "current-entities indented1" > < a href = "AbandonChannelResponse$.html" title = "" class = "object" > < / a > < a href = "AbandonChannelResponse.html" title = "" class = "class" > < / a > < a href = "AbandonChannelResponse.html" title = "" > AbandonChannelResponse< / a > < / li > < li class = "current-entities indented1" > < a href = "AddInvoiceResponse$.html" title = "" class = "object" > < / a > < a href = "AddInvoiceResponse.html" title = "" class = "class" > < / a > < a href = "AddInvoiceResponse.html" title = "" > AddInvoiceResponse< / a > < / li > < li class = "current-entities indented1" > < a href = "AddressType$.html" title = "" class = "object" > < / a > < a href = "AddressType.html" title = "AddressType has to be one of:" class = "class" > < / a > < a href = "AddressType.html" title = "AddressType has to be one of:" > AddressType< / a > < / li > < li class = "current-entities indented1" > < a href = "Amount$.html" title = "" class = "object" > < / a > < a href = "Amount.html" title = "" class = "class" > < / a > < a href = "Amount.html" title = "" > Amount< / a > < / li > < li class = "current-entities indented1" > < a href = "BakeMacaroonRequest$.html" title = "" class = "object" > < / a > < a href = "BakeMacaroonRequest.html" title = "" class = "class" > < / a > < a href = "BakeMacaroonRequest.html" title = "" > BakeMacaroonRequest< / a > < / li > < li class = "current-entities indented1" >
2021-05-01 18:33:34 +00:00
The signature that validates the announced data and proves the ownership
of node id.< / p > < / dd > < dt class = "param" > chainHash< / dt > < dd class = "cmt" > < p >
The target chain that this channel was opened within. This value
should be the genesis hash of the target chain. Along with the short
channel ID, this uniquely identifies the channel globally in a
blockchain.< / p > < / dd > < dt class = "param" > chanId< / dt > < dd class = "cmt" > < p >
The unique description of the funding transaction.< / p > < / dd > < dt class = "param" > timestamp< / dt > < dd class = "cmt" > < p >
A timestamp that allows ordering in the case of multiple announcements.
We should ignore the message if timestamp is not greater than the
last-received.< / p > < / dd > < dt class = "param" > messageFlags< / dt > < dd class = "cmt" > < p >
The bitfield that describes whether optional fields are present in this
update. Currently, the least-significant bit must be set to 1 if the
optional field MaxHtlc is present.< / p > < / dd > < dt class = "param" > channelFlags< / dt > < dd class = "cmt" > < p >
The bitfield that describes additional meta-data concerning how the
update is to be interpreted. Currently, the least-significant bit must be
set to 0 if the creating node corresponds to the first node in the
previously sent channel announcement and 1 otherwise. If the second bit
is set, then the channel is set to be disabled.< / p > < / dd > < dt class = "param" > timeLockDelta< / dt > < dd class = "cmt" > < p >
The minimum number of blocks this node requires to be added to the expiry
of HTLCs. This is a security parameter determined by the node operator.
This value represents the required gap between the time locks of the
incoming and outgoing HTLC's set to this node.< / p > < / dd > < dt class = "param" > htlcMinimumMsat< / dt > < dd class = "cmt" > < p >
The minimum HTLC value which will be accepted.< / p > < / dd > < dt class = "param" > baseFee< / dt > < dd class = "cmt" > < p >
The base fee that must be used for incoming HTLC's to this particular
channel. This value will be tacked onto the required for a payment
independent of the size of the payment.< / p > < / dd > < dt class = "param" > feeRate< / dt > < dd class = "cmt" > < p >
The fee rate that will be charged per millionth of a satoshi.< / p > < / dd > < dt class = "param" > htlcMaximumMsat< / dt > < dd class = "cmt" > < p >
The maximum HTLC value which will be accepted.< / p > < / dd > < dt class = "param" > extraOpaqueData< / dt > < dd class = "cmt" > < p >
The set of data that was appended to this message, some of which we may
not actually know how to iterate or parse. By holding onto this data, we
ensure that we're able to properly validate the set of signatures that
cover these new fields, and ensure we're able to make upgrades to the
2021-06-08 16:14:27 +00:00
network in a forwards compatible manner.< / p > < / dd > < / dl > < dl class = "attributes block" > < dt > Annotations< / dt > < dd > < span class = "name" > @SerialVersionUID< / span > < span class = "args" > ()< / span > < / dd > < / dl > < div class = "toggleContainer" > < div class = "toggle block" > < span > Linear Supertypes< / span > < div class = "superTypes hiddenContent" > < a href = "https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.3/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name = "scalapb.lenses.Updatable" id = "scalapb.lenses.Updatable" class = "extype" > Updatable< / a > [< a href = "" name = "lnrpc.ChannelUpdate" id = "lnrpc.ChannelUpdate" class = "extype" > ChannelUpdate< / a > ], < a href = "https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.3/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name = "scalapb.GeneratedMessage" id = "scalapb.GeneratedMessage" class = "extype" > GeneratedMessage< / a > , < a href = "https://docs.oracle.com/en/java/javase/11/docs/api/java/io/Serializable.html#java.io.Serializable" name = "java.io.Serializable" id = "java.io.Serializable" class = "extype" > Serializable< / a > , < a href = "https://www.scala-lang.org/api/2.13.6/scala/Product.html#scala.Product" name = "scala.Product" id = "scala.Product" class = "extype" > Product< / a > , < a href = "https://www.scala-lang.org/api/2.13.6/scala/Equals.html#scala.Equals" name = "scala.Equals" id = "scala.Equals" class = "extype" > Equals< / a > , < a href = "../scala/index.html#AnyRef=Object" name = "scala.AnyRef" id = "scala.AnyRef" class = "extmbr" > AnyRef< / a > , < a href = "https://www.scala-lang.org/api/2.13.6/scala/Any.html#scala.Any" name = "scala.Any" id = "scala.Any" class = "extype" > Any< / a > < / div > < / div > < / div > < / div > < div id = "mbrsel" > < div class = "toggle" > < / div > < div id = "memberfilter" > < i class = "material-icons arrow" > < / i > < span class = "input" > < input placeholder = "Filter all members" id = "mbrsel-input" type = "text" accesskey = "/" / > < / span > < i class = "clear material-icons" > < / i > < / div > < div id = "filterby" > < div id = "order" > < span class = "filtertype" > Ordering< / span > < ol > < li class = "alpha in" > < span > Alphabetic< / span > < / li > < li class = "inherit out" > < span > By Inheritance< / span > < / li > < / ol > < / div > < div class = "ancestors" > < span class = "filtertype" > Inherited< br / > < / span > < ol id = "linearization" > < li class = "in" name = "lnrpc.ChannelUpdate" > < span > ChannelUpdate< / span > < / li > < li class = "in" name = "scalapb.lenses.Updatable" > < span > Updatable< / span > < / li > < li class = "in" name = "scalapb.GeneratedMessage" > < span > GeneratedMessage< / span > < / li > < li class = "in" name = "java.io.Serializable" > < span > Serializable< / span > < / li > < li class = "in" name = "scala.Product" > < span > Product< / span > < / li > < li class = "in" name = "scala.Equals" > < span > Equals< / span > < / li > < li class = "in" name = "scala.AnyRef" > < span > AnyRef< / span > < / li > < li class = "in" name = "scala.Any" > < span > Any< / span > < / li > < / ol > < / div > < div class = "ancestors" > < span class = "filtertype" > < / span > < ol > < li class = "hideall out" > < span > Hide All< / span > < / li > < li class = "showall in" > < span > Show All< / span > < / li > < / ol > < / div > < div id = "visbl" > < span class = "filtertype" > Visibility< / span > < ol > < li class = "public in" > < span > Public< / span > < / li > < li class = "protected out" > < span > Protected< / span > < / li > < / ol > < / div > < / div > < / div > < div id = "template" > < div id = "allMembers" > < div id = "constructors" class = "members" > < h3 > Instance Constructors< / h3 > < ol > < li class = "indented0 " name = "lnrpc.ChannelUpdate#<init>" group = "Ungrouped" fullComment = "yes" data-isabs = "false" visbl = "pub" > < a id = "<init>(signature:com.google.protobuf.ByteString,chainHash:com.google.protobuf.ByteString,chanId:Long,timestamp:Int,messageFlags:Int,channelFlags:Int,timeLockDelta:Int,htlcMinimumMsat:Long,baseFee:Int,feeRate:Int,htlcMaximumMsat:Long,extraOpaqueData:com.google.protobuf.ByteString,unknownFields:scalapb.UnknownFieldSet):lnrpc.ChannelUpdate" class = "anchorToMember" > < / a > < a id = "<init>:ChannelUpdate" class = "anchorToMember" > < / a > < span class = "permalink" > < a href = "../lnrpc/ChannelUpdate.html#<init>(signature:com.google.protobuf.ByteString,chainHash:com.google.protobuf.ByteString,chanId:Long,timestamp:Int,messageFlags:Int,channelFlags:Int,timeLockDelta:Int,htlcMinimumMsat:Long,baseFee:Int,feeRate:Int,htlcMaximumMsat:Long,extraOpaqueData:com.google.protobuf.ByteString,
2021-05-01 18:33:34 +00:00
The signature that validates the announced data and proves the ownership
of node id.< / p > < / dd > < dt class = "param" > chainHash< / dt > < dd class = "cmt" > < p >
The target chain that this channel was opened within. This value
should be the genesis hash of the target chain. Along with the short
channel ID, this uniquely identifies the channel globally in a
blockchain.< / p > < / dd > < dt class = "param" > chanId< / dt > < dd class = "cmt" > < p >
The unique description of the funding transaction.< / p > < / dd > < dt class = "param" > timestamp< / dt > < dd class = "cmt" > < p >
A timestamp that allows ordering in the case of multiple announcements.
We should ignore the message if timestamp is not greater than the
last-received.< / p > < / dd > < dt class = "param" > messageFlags< / dt > < dd class = "cmt" > < p >
The bitfield that describes whether optional fields are present in this
update. Currently, the least-significant bit must be set to 1 if the
optional field MaxHtlc is present.< / p > < / dd > < dt class = "param" > channelFlags< / dt > < dd class = "cmt" > < p >
The bitfield that describes additional meta-data concerning how the
update is to be interpreted. Currently, the least-significant bit must be
set to 0 if the creating node corresponds to the first node in the
previously sent channel announcement and 1 otherwise. If the second bit
is set, then the channel is set to be disabled.< / p > < / dd > < dt class = "param" > timeLockDelta< / dt > < dd class = "cmt" > < p >
The minimum number of blocks this node requires to be added to the expiry
of HTLCs. This is a security parameter determined by the node operator.
This value represents the required gap between the time locks of the
incoming and outgoing HTLC's set to this node.< / p > < / dd > < dt class = "param" > htlcMinimumMsat< / dt > < dd class = "cmt" > < p >
The minimum HTLC value which will be accepted.< / p > < / dd > < dt class = "param" > baseFee< / dt > < dd class = "cmt" > < p >
The base fee that must be used for incoming HTLC's to this particular
channel. This value will be tacked onto the required for a payment
independent of the size of the payment.< / p > < / dd > < dt class = "param" > feeRate< / dt > < dd class = "cmt" > < p >
The fee rate that will be charged per millionth of a satoshi.< / p > < / dd > < dt class = "param" > htlcMaximumMsat< / dt > < dd class = "cmt" > < p >
The maximum HTLC value which will be accepted.< / p > < / dd > < dt class = "param" > extraOpaqueData< / dt > < dd class = "cmt" > < p >
The set of data that was appended to this message, some of which we may
not actually know how to iterate or parse. By holding onto this data, we
ensure that we're able to properly validate the set of signatures that
cover these new fields, and ensure we're able to make upgrades to the
2021-06-08 16:14:27 +00:00
network in a forwards compatible manner.< / p > < / dd > < / dl > < / div > < / li > < / ol > < / div > < div class = "values members" > < h3 > Value Members< / h3 > < ol > < li class = "indented0 " name = "scala.AnyRef#!=" group = "Ungrouped" fullComment = "yes" data-isabs = "false" visbl = "pub" > < a id = "!=(x$1:Any):Boolean" class = "anchorToMember" > < / a > < a id = "!=(Any):Boolean" class = "anchorToMember" > < / a > < span class = "permalink" > < a href = "../lnrpc/ChannelUpdate.html#!=(x$1:Any):Boolean" title = "Permalink" > < i class = "material-icons" > < / i > < / a > < / span > < span class = "modifier_kind" > < span class = "modifier" > final < / span > < span class = "kind" > def< / span > < / span > < span class = "symbol" > < span class = "name" title = "gt4s: $bang$eq" > !=< / span > < span class = "params" > (< span name = "arg0" > arg0: < a href = "https://www.scala-lang.org/api/2.13.6/scala/Any.html#scala.Any" name = "scala.Any" id = "scala.Any" class = "extype" > Any< / a > < / span > )< / span > < span class = "result" > : < a href = "https://www.scala-lang.org/api/2.13.6/scala/Boolean.html#scala.Boolean" name = "scala.Boolean" id = "scala.Boolean" class = "extype" > Boolean< / a > < / span > < / span > < div class = "fullcomment" > < dl class = "attributes block" > < dt > Definition Classes< / dt > < dd > AnyRef → Any< / dd > < / dl > < / div > < / li > < li class = "indented0 " name = "scala.AnyRef###" group = "Ungrouped" fullComment = "yes" data-isabs = "false" visbl = "pub" > < a id = "##:Int" class = "anchorToMember" > < / a > < span class = "permalink" > < a href = "../lnrpc/ChannelUpdate.html###:Int" title = "Permalink" > < i class = "material-icons" > < / i > < / a > < / span > < span class = "modifier_kind" > < span class = "modifier" > final < / span > < span class = "kind" > def< / span > < / span > < span class = "symbol" > < span class = "name" title = "gt4s: $hash$hash" > ##< / span > < span class = "result" > : < a href = "https://www.scala-lang.org/api/2.13.6/scala/Int.html#scala.Int" name = "scala.Int" id = "scala.Int" class = "extype" > Int< / a > < / span > < / span > < div class = "fullcomment" > < dl class = "attributes block" > < dt > Definition Classes< / dt > < dd > AnyRef → Any< / dd > < / dl > < / div > < / li > < li class = "indented0 " name = "scala.AnyRef#==" group = "Ungrouped" fullComment = "yes" data-isabs = "false" visbl = "pub" > < a id = "==(x$1:Any):Boolean" class = "anchorToMember" > < / a > < a id = "==(Any):Boolean" class = "anchorToMember" > < / a > < span class = "permalink" > < a href = "../lnrpc/ChannelUpdate.html#==(x$1:Any):Boolean" title = "Permalink" > < i class = "material-icons" > < / i > < / a > < / span > < span class = "modifier_kind" > < span class = "modifier" > final < / span > < span class = "kind" > def< / span > < / span > < span class = "symbol" > < span class = "name" title = "gt4s: $eq$eq" > ==< / span > < span class = "params" > (< span name = "arg0" > arg0: < a href = "https://www.scala-lang.org/api/2.13.6/scala/Any.html#scala.Any" name = "scala.Any" id = "scala.Any" class = "extype" > Any< / a > < / span > )< / span > < span class = "result" > : < a href = "https://www.scala-lang.org/api/2.13.6/scala/Boolean.html#scala.Boolean" name = "scala.Boolean" id = "scala.Boolean" class = "extype" > Boolean< / a > < / span > < / span > < div class = "fullcomment" > < dl class = "attributes block" > < dt > Definition Classes< / dt > < dd > AnyRef → Any< / dd > < / dl > < / div > < / li > < li class = "indented0 " name = "scala.Any#asInstanceOf" group = "Ungrouped" fullComment = "yes" data-isabs = "false" visbl = "pub" > < a id = "asInstanceOf[T0]:T0" class = "anchorToMember" > < / a > < span class = "permalink" > < a href = "../lnrpc/ChannelUpdate.html#asInstanceOf[T0]:T0" title = "Permalink" > < i class = "material-icons" > < / i > < / a > < / span > < span class = "modifier_kind" > < span class = "modifier" > final < / span > < span class = "kind" > def< / span > < / span > < span class = "symbol" > < span class = "name" > asInstanceOf< / span > < span class = "tparams" > [< span name = "T0" > T0< / span > ]< / span > < span class = "result" > : < span name = "scala.Any.asInstanceOf.T0" class = "extype" > T0< / span > < / span > < / span > < div class = "fullcomment" > < dl class = "attributes block" > < dt > Definition Classes< / dt > < dd > Any< / dd > < / dl > < / div > < / li > < li class = "indented0 " name = "lnrpc.ChannelUpdate#baseFee" group = "Ungrouped" fullComment = "no" data-isabs = "false" visbl = "pub" > < a id = "baseFee:Int" class = "anchorToMember" > < / a > < span class = "permalink" > < a href = "../lnrpc/ChannelUpdate.html#baseFee:Int" title = "Permalink" > < i class = "material-icons" > < / i > < / a > < / span > < span class = "modifier_kind" > < span class = "modifier" > < / span > < span class = "kind" > val< / span > < / span > < spa
