Search
Preparing search index...
The search index is not available
lightning-rpc - v1.0.0
Options
All
Public
Public/Protected
All
Inherited
Menu
Globals
GetInfoResponse
Class GetInfoResponse
Hierarchy
Message
GetInfoResponse
Index
Type aliases
As
Object
Message
Array
Static
ToObject
Properties
extensions
extensions
Binary
Methods
add
Chains
add
Uris
clear
Chains
List
clear
Features
Map
clear
Uris
List
clone
clone
Message
get
Alias
get
Best
Header
Timestamp
get
Block
Hash
get
Block
Height
get
Chains
List
get
Color
get
Extension
get
Features
Map
get
Identity
Pubkey
get
JsPb
Message
Id
get
Num
Active
Channels
get
Num
Inactive
Channels
get
Num
Peers
get
Num
Pending
Channels
get
Synced
ToChain
get
Synced
ToGraph
get
Testnet
get
Uris
List
get
Version
read
Binary
Extension
serialize
Binary
serialize
Binary
Extensions
set
Alias
set
Best
Header
Timestamp
set
Block
Hash
set
Block
Height
set
Chains
List
set
Color
set
Extension
set
Identity
Pubkey
set
Num
Active
Channels
set
Num
Inactive
Channels
set
Num
Peers
set
Num
Pending
Channels
set
Synced
ToChain
set
Synced
ToGraph
set
Testnet
set
Uris
List
set
Version
to
Array
to
Object
to
String
add
ToRepeated
Field
add
ToRepeated
Wrapper
Field
bytes
AsB64
bytes
AsU8
bytes
List
AsB64
bytes
List
AsU8
clone
clone
Message
compare
Extensions
compare
Fields
compute
Oneof
Case
copy
Into
deserialize
Binary
deserialize
Binary
From
Reader
difference
equals
get
Field
get
Field
With
Default
get
Map
Field
get
Optional
Floating
Point
Field
get
Repeated
Floating
Point
Field
get
Repeated
Wrapper
Field
get
Wrapper
Field
initialize
register
Message
Type
serialize
Binary
ToWriter
set
Field
set
Oneof
Field
set
Oneof
Wrapper
Field
set
Repeated
Wrapper
Field
set
Wrapper
Field
to
Map
to
Object
to
Object
Extension
to
Object
List
Type aliases
Static
As
Object
As
Object
:
{
alias
:
string
;
bestHeaderTimestamp
:
number
;
blockHash
:
string
;
blockHeight
:
number
;
chainsList
:
Array
<
AsObject
>
;
color
:
string
;
featuresMap
:
Array
<
[
number
,
AsObject
]
>
;
identityPubkey
:
string
;
numActiveChannels
:
number
;
numInactiveChannels
:
number
;
numPeers
:
number
;
numPendingChannels
:
number
;
syncedToChain
:
boolean
;
syncedToGraph
:
boolean
;
testnet
:
boolean
;
urisList
:
Array
<
string
>
;
version
:
string
}
Type declaration
alias
:
string
best
Header
Timestamp
:
number
block
Hash
:
string
block
Height
:
number
chains
List
:
Array
<
AsObject
>
color
:
string
features
Map
:
Array
<
[
number
,
AsObject
]
>
identity
Pubkey
:
string
num
Active
Channels
:
number
num
Inactive
Channels
:
number
num
Peers
:
number
num
Pending
Channels
:
number
synced
ToChain
:
boolean
synced
ToGraph
:
boolean
testnet
:
boolean
uris
List
:
Array
<
string
>
version
:
string
Static
Message
Array
Message
Array
:
any
[]
Static
Static
ToObject
Static
ToObject
:
(
includeInstance
:
boolean
, msg
:
Message
)
=>
{}
Type declaration
(
includeInstance
:
boolean
, msg
:
Message
)
:
{}
Parameters
includeInstance:
boolean
msg:
Message
Returns
{}
Properties
Static
extensions
extensions
:
{}
Type declaration
[
key:
number
]:
ExtensionFieldInfo
<
Message
>
Static
extensions
Binary
extensions
Binary
:
{}
Type declaration
[
key:
number
]:
ExtensionFieldBinaryInfo
<
Message
>
Methods
add
Chains
add
Chains
(
value
?:
Chain
, index
?:
undefined
|
number
)
:
Chain
Parameters
Optional
value:
Chain
Optional
index:
undefined
|
number
Returns
Chain
add
Uris
add
Uris
(
value
:
string
, index
?:
undefined
|
number
)
:
string
Parameters
value:
string
Optional
index:
undefined
|
number
Returns
string
clear
Chains
List
clear
Chains
List
(
)
:
void
Returns
void
clear
Features
Map
clear
Features
Map
(
)
:
void
Returns
void
clear
Uris
List
clear
Uris
List
(
)
:
void
Returns
void
clone
clone
(
)
:
this
Returns
this
clone
Message
clone
Message
(
)
:
this
Returns
this
get
Alias
get
Alias
(
)
:
string
Returns
string
get
Best
Header
Timestamp
get
Best
Header
Timestamp
(
)
:
number
Returns
number
get
Block
Hash
get
Block
Hash
(
)
:
string
Returns
string
get
Block
Height
get
Block
Height
(
)
:
number
Returns
number
get
Chains
List
get
Chains
List
(
)
:
Array
<
Chain
>
Returns
Array
<
Chain
>
get
Color
get
Color
(
)
:
string
Returns
string
get
Extension
get
Extension<T>
(
fieldInfo
:
ExtensionFieldInfo
<
T
>
)
:
T
Type parameters
T
Parameters
fieldInfo:
ExtensionFieldInfo
<
T
>
Returns
T
get
Features
Map
get
Features
Map
(
)
:
Map
<
number
,
Feature
>
Returns
Map
<
number
,
Feature
>
get
Identity
Pubkey
get
Identity
Pubkey
(
)
:
string
Returns
string
get
JsPb
Message
Id
get
JsPb
Message
Id
(
)
:
undefined
|
string
Returns
undefined
|
string
get
Num
Active
Channels
get
Num
Active
Channels
(
)
:
number
Returns
number
get
Num
Inactive
Channels
get
Num
Inactive
Channels
(
)
:
number
Returns
number
get
Num
Peers
get
Num
Peers
(
)
:
number
Returns
number
get
Num
Pending
Channels
get
Num
Pending
Channels
(
)
:
number
Returns
number
get
Synced
ToChain
get
Synced
ToChain
(
)
:
boolean
Returns
boolean
get
Synced
ToGraph
get
Synced
ToGraph
(
)
:
boolean
Returns
boolean
get
Testnet
get
Testnet
(
)
:
boolean
Returns
boolean
get
Uris
List
get
Uris
List
(
)
:
Array
<
string
>
Returns
Array
<
string
>
get
Version
get
Version
(
)
:
string
Returns
string
read
Binary
Extension
read
Binary
Extension
(
proto
:
Message
, reader
:
BinaryReader
, extensions
:
{}
, setExtensionFn
:
<T>
(
fieldInfo
:
ExtensionFieldInfo
<
T
>
, val
:
T
)
=>
void
)
:
void
Parameters
proto:
Message
reader:
BinaryReader
extensions:
{}
[
key:
number
]:
ExtensionFieldBinaryInfo
<
Message
>
setExtensionFn: <T>
(
fieldInfo
:
ExtensionFieldInfo
<
T
>
, val
:
T
)
=>
void
<T>
(
fieldInfo
:
ExtensionFieldInfo
<
T
>
, val
:
T
)
:
void
Type parameters
T
Parameters
fieldInfo:
ExtensionFieldInfo
<
T
>
val:
T
Returns
void
Returns
void
serialize
Binary
serialize
Binary
(
)
:
Uint8Array
Returns
Uint8Array
serialize
Binary
Extensions
serialize
Binary
Extensions
(
proto
:
Message
, writer
:
BinaryWriter
, extensions
:
{}
, getExtensionFn
:
<T>
(
fieldInfo
:
ExtensionFieldInfo
<
T
>
)
=>
T
)
:
void
Parameters
proto:
Message
writer:
BinaryWriter
extensions:
{}
[
key:
number
]:
ExtensionFieldBinaryInfo
<
Message
>
getExtensionFn: <T>
(
fieldInfo
:
ExtensionFieldInfo
<
T
>
)
=>
T
<T>
(
fieldInfo
:
ExtensionFieldInfo
<
T
>
)
:
T
Type parameters
T
Parameters
fieldInfo:
ExtensionFieldInfo
<
T
>
Returns
T
Returns
void
set
Alias
set
Alias
(
value
:
string
)
:
void
Parameters
value:
string
Returns
void
set
Best
Header
Timestamp
set
Best
Header
Timestamp
(
value
:
number
)
:
void
Parameters
value:
number
Returns
void
set
Block
Hash
set
Block
Hash
(
value
:
string
)
:
void
Parameters
value:
string
Returns
void
set
Block
Height
set
Block
Height
(
value
:
number
)
:
void
Parameters
value:
number
Returns
void
set
Chains
List
set
Chains
List
(
value
:
Array
<
Chain
>
)
:
void
Parameters
value:
Array
<
Chain
>
Returns
void
set
Color
set
Color
(
value
:
string
)
:
void
Parameters
value:
string
Returns
void
set
Extension
set
Extension<T>
(
fieldInfo
:
ExtensionFieldInfo
<
T
>
, value
:
T
)
:
void
Type parameters
T
Parameters
fieldInfo:
ExtensionFieldInfo
<
T
>
value:
T
Returns
void
set
Identity
Pubkey
set
Identity
Pubkey
(
value
:
string
)
:
void
Parameters
value:
string
Returns
void
set
Num
Active
Channels
set
Num
Active
Channels
(
value
:
number
)
:
void
Parameters
value:
number
Returns
void
set
Num
Inactive
Channels
set
Num
Inactive
Channels
(
value
:
number
)
:
void
Parameters
value:
number
Returns
void
set
Num
Peers
set
Num
Peers
(
value
:
number
)
:
void
Parameters
value:
number
Returns
void
set
Num
Pending
Channels
set
Num
Pending
Channels
(
value
:
number
)
:
void
Parameters
value:
number
Returns
void
set
Synced
ToChain
set
Synced
ToChain
(
value
:
boolean
)
:
void
Parameters
value:
boolean
Returns
void
set
Synced
ToGraph
set
Synced
ToGraph
(
value
:
boolean
)
:
void
Parameters
value:
boolean
Returns
void
set
Testnet
set
Testnet
(
value
:
boolean
)
:
void
Parameters
value:
boolean
Returns
void
set
Uris
List
set
Uris
List
(
value
:
Array
<
string
>
)
:
void
Parameters
value:
Array
<
string
>
Returns
void
set
Version
set
Version
(
value
:
string
)
:
void
Parameters
value:
string
Returns
void
to
Array
to
Array
(
)
:
Message.MessageArray
Returns
Message.MessageArray
to
Object
to
Object
(
includeInstance
?:
undefined
|
false
|
true
)
:
AsObject
Parameters
Optional
includeInstance:
undefined
|
false
|
true
Returns
AsObject
to
String
to
String
(
)
:
string
Returns
string
Static
add
ToRepeated
Field
add
ToRepeated
Field
(
msg
:
Message
, fieldNumber
:
number
, value
:
any
, index
?:
undefined
|
number
)
:
void
Parameters
msg:
Message
fieldNumber:
number
value:
any
Optional
index:
undefined
|
number
Returns
void
Static
add
ToRepeated
Wrapper
Field
add
ToRepeated
Wrapper
Field<T>
(
msg
:
Message
, fieldNumber
:
number
, value
:
T
|
undefined
, ctor
:
{
constructor
:
any
}
, index
?:
undefined
|
number
)
:
T
Type parameters
T
:
Message
Parameters
msg:
Message
fieldNumber:
number
value:
T
|
undefined
ctor:
{
constructor
:
any
}
constructor
:
function
new __type
(
)
:
T
Returns
T
Optional
index:
undefined
|
number
Returns
T
Static
bytes
AsB64
bytes
AsB64
(
bytes
:
Uint8Array
)
:
string
Parameters
bytes:
Uint8Array
Returns
string
Static
bytes
AsU8
bytes
AsU8
(
str
:
string
)
:
Uint8Array
Parameters
str:
string
Returns
Uint8Array
Static
bytes
List
AsB64
bytes
List
AsB64
(
bytesList
:
Uint8Array
[]
)
:
string
[]
Parameters
bytesList:
Uint8Array
[]
Returns
string
[]
Static
bytes
List
AsU8
bytes
List
AsU8
(
strList
:
string
[]
)
:
Uint8Array
[]
Parameters
strList:
string
[]
Returns
Uint8Array
[]
Static
clone
clone<T>
(
msg
:
T
)
:
T
Type parameters
T
:
Message
Parameters
msg:
T
Returns
T
Static
clone
Message
clone
Message<T>
(
msg
:
T
)
:
T
Type parameters
T
:
Message
Parameters
msg:
T
Returns
T
Static
compare
Extensions
compare
Extensions
(
extension1
:
{}
, extension2
:
{}
)
:
boolean
Parameters
extension1:
{}
extension2:
{}
Returns
boolean
Static
compare
Fields
compare
Fields
(
field1
:
any
, field2
:
any
)
:
boolean
Parameters
field1:
any
field2:
any
Returns
boolean
Static
compute
Oneof
Case
compute
Oneof
Case
(
msg
:
Message
, oneof
:
number
[]
)
:
number
Parameters
msg:
Message
oneof:
number
[]
Returns
number
Static
copy
Into
copy
Into
(
fromMessage
:
Message
, toMessage
:
Message
)
:
void
Parameters
fromMessage:
Message
toMessage:
Message
Returns
void
Static
deserialize
Binary
deserialize
Binary
(
bytes
:
Uint8Array
)
:
GetInfoResponse
Parameters
bytes:
Uint8Array
Returns
GetInfoResponse
Static
deserialize
Binary
From
Reader
deserialize
Binary
From
Reader
(
message
:
GetInfoResponse
, reader
:
BinaryReader
)
:
GetInfoResponse
Parameters
message:
GetInfoResponse
reader:
BinaryReader
Returns
GetInfoResponse
Static
difference
difference<T>
(
m1
:
T
, m2
:
T
)
:
T
Type parameters
T
:
Message
Parameters
m1:
T
m2:
T
Returns
T
Static
equals
equals
(
m1
:
Message
, m2
:
Message
)
:
boolean
Parameters
m1:
Message
m2:
Message
Returns
boolean
Static
get
Field
get
Field
(
msg
:
Message
, fieldNumber
:
number
)
:
FieldValue
|
null
Parameters
msg:
Message
fieldNumber:
number
Returns
FieldValue
|
null
Static
get
Field
With
Default
get
Field
With
Default<T>
(
msg
:
Message
, fieldNumber
:
number
, defaultValue
:
T
)
:
T
Type parameters
T
Parameters
msg:
Message
fieldNumber:
number
defaultValue:
T
Returns
T
Static
get
Map
Field
get
Map
Field
(
msg
:
Message
, fieldNumber
:
number
, noLazyCreate
:
boolean
, valueCtor
:
typeof
Message
)
:
Map
<
any
,
any
>
Parameters
msg:
Message
fieldNumber:
number
noLazyCreate:
boolean
valueCtor:
typeof
Message
Returns
Map
<
any
,
any
>
Static
get
Optional
Floating
Point
Field
get
Optional
Floating
Point
Field
(
msg
:
Message
, fieldNumber
:
number
)
:
number
|
undefined
Parameters
msg:
Message
fieldNumber:
number
Returns
number
|
undefined
Static
get
Repeated
Floating
Point
Field
get
Repeated
Floating
Point
Field
(
msg
:
Message
, fieldNumber
:
number
)
:
number
[]
Parameters
msg:
Message
fieldNumber:
number
Returns
number
[]
Static
get
Repeated
Wrapper
Field
get
Repeated
Wrapper
Field<T>
(
msg
:
Message
, ctor
:
{
constructor
:
any
}
, fieldNumber
:
number
)
:
T
[]
Type parameters
T
:
Message
Parameters
msg:
Message
ctor:
{
constructor
:
any
}
constructor
:
function
new __type
(
)
:
T
Returns
T
fieldNumber:
number
Returns
T
[]
Static
get
Wrapper
Field
get
Wrapper
Field<T>
(
msg
:
Message
, ctor
:
{
constructor
:
any
}
, fieldNumber
:
number
, required
?:
undefined
|
number
)
:
T
Type parameters
T
:
Message
Parameters
msg:
Message
ctor:
{
constructor
:
any
}
constructor
:
function
new __type
(
)
:
T
Returns
T
fieldNumber:
number
Optional
required:
undefined
|
number
Returns
T
Static
initialize
initialize
(
msg
:
Message
, data
:
Message.MessageArray
, messageId
:
string
|
number
, suggestedPivot
:
number
, repeatedFields
?:
number
[]
, oneofFields
?:
number
[]
[]
|
null
)
:
void
Parameters
msg:
Message
data:
Message.MessageArray
messageId:
string
|
number
suggestedPivot:
number
Optional
repeatedFields:
number
[]
Optional
oneofFields:
number
[]
[]
|
null
Returns
void
Static
register
Message
Type
register
Message
Type
(
id
:
number
, constructor
:
typeof
Message
)
:
void
Parameters
id:
number
constructor:
typeof
Message
Returns
void
Static
serialize
Binary
ToWriter
serialize
Binary
ToWriter
(
message
:
GetInfoResponse
, writer
:
BinaryWriter
)
:
void
Parameters
message:
GetInfoResponse
writer:
BinaryWriter
Returns
void
Static
set
Field
set
Field
(
msg
:
Message
, fieldNumber
:
number
, value
:
FieldValue
)
:
void
Parameters
msg:
Message
fieldNumber:
number
value:
FieldValue
Returns
void
Static
set
Oneof
Field
set
Oneof
Field
(
msg
:
Message
, fieldNumber
:
number
, oneof
:
number
[]
, value
:
FieldValue
)
:
void
Parameters
msg:
Message
fieldNumber:
number
oneof:
number
[]
value:
FieldValue
Returns
void
Static
set
Oneof
Wrapper
Field
set
Oneof
Wrapper
Field
(
msg
:
Message
, fieldNumber
:
number
, oneof
:
number
[]
, value
:
any
)
:
void
Parameters
msg:
Message
fieldNumber:
number
oneof:
number
[]
value:
any
Returns
void
Static
set
Repeated
Wrapper
Field
set
Repeated
Wrapper
Field<T>
(
msg
:
Message
, fieldNumber
:
number
, value
?:
T
[]
)
:
void
Type parameters
T
:
Message
Parameters
msg:
Message
fieldNumber:
number
Optional
value:
T
[]
Returns
void
Static
set
Wrapper
Field
set
Wrapper
Field<T>
(
msg
:
Message
, fieldNumber
:
number
, value
?:
undefined
|
Map
<
any
,
any
>
|
T
)
:
void
Type parameters
T
:
Message
Parameters
msg:
Message
fieldNumber:
number
Optional
value:
undefined
|
Map
<
any
,
any
>
|
T
Returns
void
Static
to
Map
to
Map
(
field
:
any
[]
, mapKeyGetterFn
:
(
field
:
any
)
=>
string
, toObjectFn
?:
Message.StaticToObject
, includeInstance
?:
undefined
|
false
|
true
)
:
void
Parameters
field:
any
[]
mapKeyGetterFn:
(
field
:
any
)
=>
string
(
field
:
any
)
:
string
Parameters
field:
any
Returns
string
Optional
toObjectFn:
Message.StaticToObject
Optional
includeInstance:
undefined
|
false
|
true
Returns
void
Static
to
Object
to
Object
(
includeInstance
:
boolean
, msg
:
GetInfoResponse
)
:
AsObject
Parameters
includeInstance:
boolean
msg:
GetInfoResponse
Returns
AsObject
Static
to
Object
Extension
to
Object
Extension
(
msg
:
Message
, obj
:
{}
, extensions
:
{}
, getExtensionFn
:
(
fieldInfo
:
ExtensionFieldInfo
<
Message
>
)
=>
Message
, includeInstance
?:
undefined
|
false
|
true
)
:
void
Parameters
msg:
Message
obj:
{}
extensions:
{}
[
key:
number
]:
ExtensionFieldInfo
<
Message
>
getExtensionFn:
(
fieldInfo
:
ExtensionFieldInfo
<
Message
>
)
=>
Message
(
fieldInfo
:
ExtensionFieldInfo
<
Message
>
)
:
Message
Parameters
fieldInfo:
ExtensionFieldInfo
<
Message
>
Returns
Message
Optional
includeInstance:
undefined
|
false
|
true
Returns
void
Static
to
Object
List
to
Object
List<T>
(
field
:
T
[]
, toObjectFn
:
(
includeInstance
:
boolean
, data
:
T
)
=>
{}
, includeInstance
?:
undefined
|
false
|
true
)
:
Array
<
{}
>
Type parameters
T
:
Message
Parameters
field:
T
[]
toObjectFn:
(
includeInstance
:
boolean
, data
:
T
)
=>
{}
(
includeInstance
:
boolean
, data
:
T
)
:
{}
Parameters
includeInstance:
boolean
data:
T
Returns
{}
Optional
includeInstance:
undefined
|
false
|
true
Returns
Array
<
{}
>
Globals
Get
Info
Response
As
Object
Message
Array
Static
ToObject
extensions
extensions
Binary
add
Chains
add
Uris
clear
Chains
List
clear
Features
Map
clear
Uris
List
clone
clone
Message
get
Alias
get
Best
Header
Timestamp
get
Block
Hash
get
Block
Height
get
Chains
List
get
Color
get
Extension
get
Features
Map
get
Identity
Pubkey
get
JsPb
Message
Id
get
Num
Active
Channels
get
Num
Inactive
Channels
get
Num
Peers
get
Num
Pending
Channels
get
Synced
ToChain
get
Synced
ToGraph
get
Testnet
get
Uris
List
get
Version
read
Binary
Extension
serialize
Binary
serialize
Binary
Extensions
set
Alias
set
Best
Header
Timestamp
set
Block
Hash
set
Block
Height
set
Chains
List
set
Color
set
Extension
set
Identity
Pubkey
set
Num
Active
Channels
set
Num
Inactive
Channels
set
Num
Peers
set
Num
Pending
Channels
set
Synced
ToChain
set
Synced
ToGraph
set
Testnet
set
Uris
List
set
Version
to
Array
to
Object
to
String
add
ToRepeated
Field
add
ToRepeated
Wrapper
Field
bytes
AsB64
bytes
AsU8
bytes
List
AsB64
bytes
List
AsU8
clone
clone
Message
compare
Extensions
compare
Fields
compute
Oneof
Case
copy
Into
deserialize
Binary
deserialize
Binary
From
Reader
difference
equals
get
Field
get
Field
With
Default
get
Map
Field
get
Optional
Floating
Point
Field
get
Repeated
Floating
Point
Field
get
Repeated
Wrapper
Field
get
Wrapper
Field
initialize
register
Message
Type
serialize
Binary
ToWriter
set
Field
set
Oneof
Field
set
Oneof
Wrapper
Field
set
Repeated
Wrapper
Field
set
Wrapper
Field
to
Map
to
Object
to
Object
Extension
to
Object
List
Generated using
TypeDoc