Class NodeOptions

Namespace

NLightning.Bolts

Assembly

NLightning.Bolts.dll

Represents the options for a node.

public sealed class NodeOptions

Inheritance

object

NodeOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

NodeOptions()

Initializes a new instance of the NodeOptions class.

public NodeOptions()

Remarks

The key pair is generated automatically.

NodeOptions(Key)

Initializes a new instance of the NodeOptions class.

public NodeOptions(Key p)

Parameters

p Key

The private key of the node.

Remarks

The key pair is generated from the private key.

Fields

ChainHashes

The chain hashes of the node.

public IEnumerable<ChainHash> ChainHashes

Field Value

IEnumerable<ChainHash>

Remarks

Initialized as Mainnet if not set.

EnableAnchorOutputs

Enable anchor outputs.

public bool EnableAnchorOutputs

Field Value

bool

Remarks

This will be added to the features of the node as OPTIONAL.

EnableBasicMpp

Enable basic MPP.

public bool EnableBasicMpp

Field Value

bool

Remarks

This will be added to the features of the node as OPTIONAL.

EnableBeyondSegwitShutdown

Enable beyond segwit shutdown.

public bool EnableBeyondSegwitShutdown

Field Value

bool

Remarks

This will be added to the features of the node as OPTIONAL.

EnableChannelType

Enable channel type.

public bool EnableChannelType

Field Value

bool

Remarks

This will be added to the features of the node as OPTIONAL.

EnableDataLossProtect

Enable data loss protection.

public bool EnableDataLossProtect

Field Value

bool

Remarks

This will be added to the features of the node as OPTIONAL.

EnableDualFund

Enable dual fund.

public bool EnableDualFund

Field Value

bool

Remarks

This will be added to the features of the node as OPTIONAL.

EnableExpandedGossipQueries

Enable expanded gossip queries.

public bool EnableExpandedGossipQueries

Field Value

bool

Remarks

This will be added to the features of the node as OPTIONAL.

EnableGossipQueries

Enable gossip queries.

public bool EnableGossipQueries

Field Value

bool

Remarks

This will be added to the features of the node as OPTIONAL.

EnableInitialRoutingSync

Enable initial routing sync.

public bool EnableInitialRoutingSync

Field Value

bool

Remarks

This will be added to the features of the node as OPTIONAL.

EnableLargeChannels

Enable large channels.

public bool EnableLargeChannels

Field Value

bool

Remarks

This will be added to the features of the node as OPTIONAL.

EnableOnionMessages

Enable onion messages.

public bool EnableOnionMessages

Field Value

bool

Remarks

This will be added to the features of the node as OPTIONAL.

EnablePaymentMetadata

Enable payment metadata.

public bool EnablePaymentMetadata

Field Value

bool

Remarks

This will be added to the features of the node as OPTIONAL.

EnablePaymentSecret

Enable payment secret.

public bool EnablePaymentSecret

Field Value

bool

Remarks

This will be added to the features of the node as OPTIONAL.

EnableRouteBlinding

Enable route blinding.

public bool EnableRouteBlinding

Field Value

bool

Remarks

This will be added to the features of the node as OPTIONAL.

EnableScidAlias

Enable scid alias.

public bool EnableScidAlias

Field Value

bool

Remarks

This will be added to the features of the node as OPTIONAL.

EnableStaticRemoteKey

Enable static remote key.

public bool EnableStaticRemoteKey

Field Value

bool

Remarks

This will be added to the features of the node as OPTIONAL.

EnableUpfrontShutdownScript

Enable upfront shutdown script.

public bool EnableUpfrontShutdownScript

Field Value

bool

Remarks

This will be added to the features of the node as OPTIONAL.

EnableZeroConf

Enable zero conf.

public bool EnableZeroConf

Field Value

bool

Remarks

This will be added to the features of the node as OPTIONAL.

EnableZeroFeeAnchorTx

Enable zero fee anchor tx.

public bool EnableZeroFeeAnchorTx

Field Value

bool

Remarks

This will be added to the features of the node as OPTIONAL.

NetworkTimeout

Global network timeout.

public TimeSpan NetworkTimeout

Field Value

TimeSpan

Remarks

The global network timeout is used for all network operations.

RemoteAddress

The remote address of the node.

public IPAddress? RemoteAddress

Field Value

IPAddress

Remarks

This is used to connect to our node.