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 * /
2022-01-21 00:10:54 +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 = "AMPInvoiceState$.html" title = "" class = "object" > < / a > < a href = "AMPInvoiceState.html" title = "" class = "class" > < / a > < a href = "AMPInvoiceState.html" title = "" > AMPInvoiceState< / 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 = "BakeMac
2021-06-21 21:43:03 +00:00
A manual fee rate set in sat/vbyte that should be used when crafting the
funding transaction.< / p > < / dd > < dt class = "param" > nodePubkey< / dt > < dd class = "cmt" > < p >
2021-05-01 18:33:34 +00:00
The pubkey of the node to open a channel with. When using REST, this field
must be encoded as base64.< / p > < / dd > < dt class = "param" > nodePubkeyString< / dt > < dd class = "cmt" > < p >
The hex encoded pubkey of the node to open a channel with. Deprecated now
that the REST gateway supports base64 encoding of bytes fields.< / p > < / dd > < dt class = "param" > localFundingAmount< / dt > < dd class = "cmt" > < p >
The number of satoshis the wallet should commit to the channel< / p > < / dd > < dt class = "param" > pushSat< / dt > < dd class = "cmt" > < p >
The number of satoshis to push to the remote side as part of the initial
commitment state< / p > < / dd > < dt class = "param" > targetConf< / dt > < dd class = "cmt" > < p >
The target number of blocks that the funding transaction should be
confirmed by.< / p > < / dd > < dt class = "param" > satPerByte< / dt > < dd class = "cmt" > < p >
2021-06-21 21:43:03 +00:00
Deprecated, use sat_per_vbyte.
A manual fee rate set in sat/vbyte that should be used when crafting the
2021-05-01 18:33:34 +00:00
funding transaction.< / p > < / dd > < dt class = "param" > private< / dt > < dd class = "cmt" > < p >
Whether this channel should be private, not announced to the greater
network.< / p > < / dd > < dt class = "param" > minHtlcMsat< / dt > < dd class = "cmt" > < p >
The minimum value in millisatoshi we will require for incoming HTLCs on
the channel.< / p > < / dd > < dt class = "param" > remoteCsvDelay< / dt > < dd class = "cmt" > < p >
The delay we require on the remote's commitment transaction. If this is
not set, it will be scaled automatically with the channel size.< / p > < / dd > < dt class = "param" > minConfs< / dt > < dd class = "cmt" > < p >
The minimum number of confirmations each one of your outputs used for
the funding transaction must satisfy.< / p > < / dd > < dt class = "param" > spendUnconfirmed< / dt > < dd class = "cmt" > < p >
Whether unconfirmed outputs should be used as inputs for the funding
transaction.< / p > < / dd > < dt class = "param" > closeAddress< / dt > < dd class = "cmt" > < p >
Close address is an optional address which specifies the address to which
funds should be paid out to upon cooperative close. This field may only be
set if the peer supports the option upfront feature bit (call listpeers
to check). The remote peer will only accept cooperative closes to this
address if it is set.
Note: If this value is set on channel creation, you will *not* be able to
cooperatively close out to a different address.< / p > < / dd > < dt class = "param" > fundingShim< / dt > < dd class = "cmt" > < p >
Funding shims are an optional argument that allow the caller to intercept
certain funding functionality. For example, a shim can be provided to use a
particular key for the commitment key (ideally cold) rather than use one
that is generated by the wallet as normal, or signal that signing will be
carried out in an interactive manner (PSBT based).< / p > < / dd > < dt class = "param" > remoteMaxValueInFlightMsat< / dt > < dd class = "cmt" > < p >
The maximum amount of coins in millisatoshi that can be pending within
the channel. It only applies to the remote party.< / p > < / dd > < dt class = "param" > remoteMaxHtlcs< / dt > < dd class = "cmt" > < p >
The maximum number of concurrent HTLCs we will allow the remote party to add
to the commitment transaction.< / p > < / dd > < dt class = "param" > maxLocalCsv< / dt > < dd class = "cmt" > < p >
Max local csv is the maximum csv delay we will allow for our own commitment
2021-11-19 13:25:19 +00:00
transaction.< / p > < / dd > < dt class = "param" > commitmentType< / dt > < dd class = "cmt" > < p >
The explicit commitment type to use. Note this field will only be used if
2022-01-21 00:10:54 +00:00
the remote peer supports explicit channel negotiation.< / 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.8/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name = "scalapb.lenses.Updatable" id = "scalapb.lenses.Updatable" class = "extype" > Updatable< / a > [< a href = "" name = "lnrpc.OpenChannelRequest" id = "lnrpc.OpenChannelRequest" class = "extype" > OpenChannelRequest< / a > ], < a href = "https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.8/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.8/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.8/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.8/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.OpenChannelRequest" > < span > OpenChannelRequest< / 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.OpenChannelRequest#<init>" group = "Ungrouped" fullComment = "yes" data-isabs = "false" visbl = "pub" > < a id = "<init>(satPerVbyte:Long,nodePubkey:com.google.protobuf.ByteString,nodePubkeyString:String,localFundingAmount:Long,pushSat:Long,targetConf:Int,satPerByte:Long,private:Boolean,minHtlcMsat:Long,remoteCsvDelay:Int,minConfs:Int,spendUnconfirmed:Boolean,closeAddress:String,fundingShim:Option[lnrpc.FundingShim],remoteMaxValueInFlightMsat:Long,remoteMaxHtlcs:Int,maxLocalCsv:Int,commitmentType:lnrpc.CommitmentType,unknownFields:scalapb.UnknownFieldSet):lnrpc.OpenChannelRequest" class = "anchorToMember" > < / a > < a id = "<init>:OpenChannelRequest" class = "anchorToMember" > < / a > < span class = "permalink" > < a href = "../lnrpc/OpenChannelRequest.html#<init>(satPerVbyte:Long,nodePubkey:com.google.protobuf.ByteString,nodePubkeyString:String,lo
2021-06-21 21:43:03 +00:00
A manual fee rate set in sat/vbyte that should be used when crafting the
funding transaction.< / p > < / dd > < dt class = "param" > nodePubkey< / dt > < dd class = "cmt" > < p >
2021-05-01 18:33:34 +00:00
The pubkey of the node to open a channel with. When using REST, this field
must be encoded as base64.< / p > < / dd > < dt class = "param" > nodePubkeyString< / dt > < dd class = "cmt" > < p >
The hex encoded pubkey of the node to open a channel with. Deprecated now
that the REST gateway supports base64 encoding of bytes fields.< / p > < / dd > < dt class = "param" > localFundingAmount< / dt > < dd class = "cmt" > < p >
The number of satoshis the wallet should commit to the channel< / p > < / dd > < dt class = "param" > pushSat< / dt > < dd class = "cmt" > < p >
The number of satoshis to push to the remote side as part of the initial
commitment state< / p > < / dd > < dt class = "param" > targetConf< / dt > < dd class = "cmt" > < p >
The target number of blocks that the funding transaction should be
confirmed by.< / p > < / dd > < dt class = "param" > satPerByte< / dt > < dd class = "cmt" > < p >
2021-06-21 21:43:03 +00:00
Deprecated, use sat_per_vbyte.
A manual fee rate set in sat/vbyte that should be used when crafting the
2021-05-01 18:33:34 +00:00
funding transaction.< / p > < / dd > < dt class = "param" > private< / dt > < dd class = "cmt" > < p >
Whether this channel should be private, not announced to the greater
network.< / p > < / dd > < dt class = "param" > minHtlcMsat< / dt > < dd class = "cmt" > < p >
The minimum value in millisatoshi we will require for incoming HTLCs on
the channel.< / p > < / dd > < dt class = "param" > remoteCsvDelay< / dt > < dd class = "cmt" > < p >
The delay we require on the remote's commitment transaction. If this is
not set, it will be scaled automatically with the channel size.< / p > < / dd > < dt class = "param" > minConfs< / dt > < dd class = "cmt" > < p >
The minimum number of confirmations each one of your outputs used for
the funding transaction must satisfy.< / p > < / dd > < dt class = "param" > spendUnconfirmed< / dt > < dd class = "cmt" > < p >
Whether unconfirmed outputs should be used as inputs for the funding
transaction.< / p > < / dd > < dt class = "param" > closeAddress< / dt > < dd class = "cmt" > < p >
Close address is an optional address which specifies the address to which
funds should be paid out to upon cooperative close. This field may only be
set if the peer supports the option upfront feature bit (call listpeers
to check). The remote peer will only accept cooperative closes to this
address if it is set.
Note: If this value is set on channel creation, you will *not* be able to
cooperatively close out to a different address.< / p > < / dd > < dt class = "param" > fundingShim< / dt > < dd class = "cmt" > < p >
Funding shims are an optional argument that allow the caller to intercept
certain funding functionality. For example, a shim can be provided to use a
particular key for the commitment key (ideally cold) rather than use one
that is generated by the wallet as normal, or signal that signing will be
carried out in an interactive manner (PSBT based).< / p > < / dd > < dt class = "param" > remoteMaxValueInFlightMsat< / dt > < dd class = "cmt" > < p >
The maximum amount of coins in millisatoshi that can be pending within
the channel. It only applies to the remote party.< / p > < / dd > < dt class = "param" > remoteMaxHtlcs< / dt > < dd class = "cmt" > < p >
The maximum number of concurrent HTLCs we will allow the remote party to add
to the commitment transaction.< / p > < / dd > < dt class = "param" > maxLocalCsv< / dt > < dd class = "cmt" > < p >
Max local csv is the maximum csv delay we will allow for our own commitment
2021-11-19 13:25:19 +00:00
transaction.< / p > < / dd > < dt class = "param" > commitmentType< / dt > < dd class = "cmt" > < p >
The explicit commitment type to use. Note this field will only be used if
2022-01-21 00:10:54 +00:00
the remote peer supports explicit channel negotiation.< / 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/OpenChannelRequest.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.8/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.8/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/OpenChannelRequest.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.8/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/OpenChannelRequest.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.8/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.8/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/OpenChannelRequest.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.OpenChannelRequest#clearFundingShim" group = "Ungrouped" fullComment = "no" data-isabs = "false" visbl = "pub" > < a id = "clearFundingShim:lnrpc.OpenChannelRequest" class = "anchorToMember" > < / a > < a id = "clearFundingShim:OpenChannelRequest" class = "anchorToMember" > < / a > < span class = "permalink" > < a href = "../lnrpc/OpenChannelRequest.html#clearFundingShim:lnrpc
