Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Channel

Hierarchy

  • Message
    • Channel

Index

Type aliases

Properties

Methods

Type aliases

Static AsObject

AsObject: { active: boolean; capacity: number; chanId: string; chanStatusFlags: string; channelPoint: string; closeAddress: string; commitFee: number; commitWeight: number; csvDelay: number; feePerKw: number; initiator: boolean; lifetime: number; localBalance: number; localChanReserveSat: number; numUpdates: number; pb_private: boolean; pendingHtlcsList: Array<AsObject>; remoteBalance: number; remoteChanReserveSat: number; remotePubkey: string; staticRemoteKey: boolean; totalSatoshisReceived: number; totalSatoshisSent: number; unsettledBalance: number; uptime: number }

Type declaration

  • active: boolean
  • capacity: number
  • chanId: string
  • chanStatusFlags: string
  • channelPoint: string
  • closeAddress: string
  • commitFee: number
  • commitWeight: number
  • csvDelay: number
  • feePerKw: number
  • initiator: boolean
  • lifetime: number
  • localBalance: number
  • localChanReserveSat: number
  • numUpdates: number
  • pb_private: boolean
  • pendingHtlcsList: Array<AsObject>
  • remoteBalance: number
  • remoteChanReserveSat: number
  • remotePubkey: string
  • staticRemoteKey: boolean
  • totalSatoshisReceived: number
  • totalSatoshisSent: number
  • unsettledBalance: number
  • uptime: number

Static MessageArray

MessageArray: any[]

Static StaticToObject

StaticToObject: (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 extensionsBinary

extensionsBinary: {}

Type declaration

  • [key: number]: ExtensionFieldBinaryInfo<Message>

Methods

addPendingHtlcs

  • addPendingHtlcs(value?: HTLC, index?: undefined | number): HTLC

clearPendingHtlcsList

  • clearPendingHtlcsList(): void

clone

  • clone(): this

  • Returns this

cloneMessage

  • cloneMessage(): this

getActive

  • getActive(): boolean

getCapacity

  • getCapacity(): number

getChanId

  • getChanId(): string

getChanStatusFlags

  • getChanStatusFlags(): string

getChannelPoint

  • getChannelPoint(): string

getCloseAddress

  • getCloseAddress(): string

getCommitFee

  • getCommitFee(): number

getCommitWeight

  • getCommitWeight(): number

getCsvDelay

  • getCsvDelay(): number

getExtension

  • getExtension<T>(fieldInfo: ExtensionFieldInfo<T>): T

  • Type parameters

    • T

    Parameters

    • fieldInfo: ExtensionFieldInfo<T>

    Returns T

getFeePerKw

  • getFeePerKw(): number

getInitiator

  • getInitiator(): boolean

getJsPbMessageId

  • getJsPbMessageId(): undefined | string

getLifetime

  • getLifetime(): number

getLocalBalance

  • getLocalBalance(): number

getLocalChanReserveSat

  • getLocalChanReserveSat(): number

getNumUpdates

  • getNumUpdates(): number

getPendingHtlcsList

  • getPendingHtlcsList(): Array<HTLC>

getPrivate

  • getPrivate(): boolean

getRemoteBalance

  • getRemoteBalance(): number

getRemoteChanReserveSat

  • getRemoteChanReserveSat(): number

getRemotePubkey

  • getRemotePubkey(): string

getStaticRemoteKey

  • getStaticRemoteKey(): boolean

getTotalSatoshisReceived

  • getTotalSatoshisReceived(): number

getTotalSatoshisSent

  • getTotalSatoshisSent(): number

getUnsettledBalance

  • getUnsettledBalance(): number

getUptime

  • getUptime(): number

readBinaryExtension

  • readBinaryExtension(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

serializeBinary

  • serializeBinary(): Uint8Array

serializeBinaryExtensions

  • serializeBinaryExtensions(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

setActive

  • setActive(value: boolean): void

setCapacity

  • setCapacity(value: number): void

setChanId

  • setChanId(value: string): void

setChanStatusFlags

  • setChanStatusFlags(value: string): void

setChannelPoint

  • setChannelPoint(value: string): void

setCloseAddress

  • setCloseAddress(value: string): void

setCommitFee

  • setCommitFee(value: number): void

setCommitWeight

  • setCommitWeight(value: number): void

setCsvDelay

  • setCsvDelay(value: number): void

setExtension

  • setExtension<T>(fieldInfo: ExtensionFieldInfo<T>, value: T): void

  • Type parameters

    • T

    Parameters

    • fieldInfo: ExtensionFieldInfo<T>
    • value: T

    Returns void

setFeePerKw

  • setFeePerKw(value: number): void

setInitiator

  • setInitiator(value: boolean): void

setLifetime

  • setLifetime(value: number): void

setLocalBalance

  • setLocalBalance(value: number): void

setLocalChanReserveSat

  • setLocalChanReserveSat(value: number): void

setNumUpdates

  • setNumUpdates(value: number): void

setPendingHtlcsList

  • setPendingHtlcsList(value: Array<HTLC>): void

setPrivate

  • setPrivate(value: boolean): void

setRemoteBalance

  • setRemoteBalance(value: number): void

setRemoteChanReserveSat

  • setRemoteChanReserveSat(value: number): void

setRemotePubkey

  • setRemotePubkey(value: string): void

setStaticRemoteKey

  • setStaticRemoteKey(value: boolean): void

setTotalSatoshisReceived

  • setTotalSatoshisReceived(value: number): void

setTotalSatoshisSent

  • setTotalSatoshisSent(value: number): void

setUnsettledBalance

  • setUnsettledBalance(value: number): void

setUptime

  • setUptime(value: number): void

toArray

  • toArray(): Message.MessageArray

  • Returns Message.MessageArray

toObject

  • toObject(includeInstance?: undefined | false | true): AsObject

toString

  • toString(): string

  • Returns string

Static addToRepeatedField

  • addToRepeatedField(msg: Message, fieldNumber: number, value: any, index?: undefined | number): void

  • Parameters

    • msg: Message
    • fieldNumber: number
    • value: any
    • Optional index: undefined | number

    Returns void

Static addToRepeatedWrapperField

  • addToRepeatedWrapperField<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 bytesAsB64

  • bytesAsB64(bytes: Uint8Array): string

  • Parameters

    • bytes: Uint8Array

    Returns string

Static bytesAsU8

  • bytesAsU8(str: string): Uint8Array

  • Parameters

    • str: string

    Returns Uint8Array

Static bytesListAsB64

  • bytesListAsB64(bytesList: Uint8Array[]): string[]

  • Parameters

    • bytesList: Uint8Array[]

    Returns string[]

Static bytesListAsU8

  • bytesListAsU8(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 cloneMessage

  • cloneMessage<T>(msg: T): T

  • Type parameters

    • T: Message

    Parameters

    • msg: T

    Returns T

Static compareExtensions

  • compareExtensions(extension1: {}, extension2: {}): boolean

  • Parameters

    • extension1: {}
    • extension2: {}

    Returns boolean

Static compareFields

  • compareFields(field1: any, field2: any): boolean

  • Parameters

    • field1: any
    • field2: any

    Returns boolean

Static computeOneofCase

  • computeOneofCase(msg: Message, oneof: number[]): number

  • Parameters

    • msg: Message
    • oneof: number[]

    Returns number

Static copyInto

  • copyInto(fromMessage: Message, toMessage: Message): void

  • Parameters

    • fromMessage: Message
    • toMessage: Message

    Returns void

Static deserializeBinary

  • deserializeBinary(bytes: Uint8Array): Channel

Static deserializeBinaryFromReader

  • deserializeBinaryFromReader(message: Channel, reader: BinaryReader): Channel

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 getField

  • getField(msg: Message, fieldNumber: number): FieldValue | null

  • Parameters

    • msg: Message
    • fieldNumber: number

    Returns FieldValue | null

Static getFieldWithDefault

  • getFieldWithDefault<T>(msg: Message, fieldNumber: number, defaultValue: T): T

  • Type parameters

    • T

    Parameters

    • msg: Message
    • fieldNumber: number
    • defaultValue: T

    Returns T

Static getMapField

  • getMapField(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 getOptionalFloatingPointField

  • getOptionalFloatingPointField(msg: Message, fieldNumber: number): number | undefined

Static getRepeatedFloatingPointField

  • getRepeatedFloatingPointField(msg: Message, fieldNumber: number): number[]

Static getRepeatedWrapperField

  • getRepeatedWrapperField<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 getWrapperField

  • getWrapperField<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 registerMessageType

  • registerMessageType(id: number, constructor: typeof Message): void

  • Parameters

    • id: number
    • constructor: typeof Message

    Returns void

Static serializeBinaryToWriter

  • serializeBinaryToWriter(message: Channel, writer: BinaryWriter): void

Static setField

  • setField(msg: Message, fieldNumber: number, value: FieldValue): void

  • Parameters

    • msg: Message
    • fieldNumber: number
    • value: FieldValue

    Returns void

Static setOneofField

  • setOneofField(msg: Message, fieldNumber: number, oneof: number[], value: FieldValue): void

  • Parameters

    • msg: Message
    • fieldNumber: number
    • oneof: number[]
    • value: FieldValue

    Returns void

Static setOneofWrapperField

  • setOneofWrapperField(msg: Message, fieldNumber: number, oneof: number[], value: any): void

  • Parameters

    • msg: Message
    • fieldNumber: number
    • oneof: number[]
    • value: any

    Returns void

Static setRepeatedWrapperField

  • setRepeatedWrapperField<T>(msg: Message, fieldNumber: number, value?: T[]): void

  • Type parameters

    • T: Message

    Parameters

    • msg: Message
    • fieldNumber: number
    • Optional value: T[]

    Returns void

Static setWrapperField

  • setWrapperField<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 toMap

  • toMap(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 toObject

Static toObjectExtension

  • toObjectExtension(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 toObjectList

  • toObjectList<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<{}>

Generated using TypeDoc