Class NamedPipeIpcClient

Namespace

NLightning.Client.Ipc

Assembly

NLightning.Client.dll

public sealed class NamedPipeIpcClient : IAsyncDisposable

Inheritance

object

NamedPipeIpcClient

Implements

IAsyncDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

NamedPipeIpcClient(string, string, string)

public NamedPipeIpcClient(string namedPipeFilePath, string cookieFilePath, string server = ".")

Parameters

namedPipeFilePath string

cookieFilePath string

server string

Methods

ConnectPeerAsync(string, CancellationToken)

public Task<ConnectPeerIpcResponse> ConnectPeerAsync(string address, CancellationToken ct = default)

Parameters

address string

ct CancellationToken

Returns

Task<ConnectPeerIpcResponse>

DisposeAsync()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources asynchronously.

public ValueTask DisposeAsync()

Returns

ValueTask

A task that represents the asynchronous dispose operation.

GetAddressAsync(string?, CancellationToken)

public Task<GetAddressIpcResponse> GetAddressAsync(string? addressTypeString, CancellationToken ct = default)

Parameters

addressTypeString string

ct CancellationToken

Returns

Task<GetAddressIpcResponse>

GetNodeInfoAsync(CancellationToken)

public Task<NodeInfoIpcResponse> GetNodeInfoAsync(CancellationToken ct = default)

Parameters

ct CancellationToken

Returns

Task<NodeInfoIpcResponse>

GetWalletBalance(CancellationToken)

public Task<WalletBalanceIpcResponse> GetWalletBalance(CancellationToken ct)

Parameters

ct CancellationToken

Returns

Task<WalletBalanceIpcResponse>

ListPeersAsync(CancellationToken)

public Task<ListPeersIpcResponse> ListPeersAsync(CancellationToken ct = default)

Parameters

ct CancellationToken

Returns

Task<ListPeersIpcResponse>

OpenChannelAsync(string, string, CancellationToken)

public Task<OpenChannelIpcResponse> OpenChannelAsync(string nodeInfo, string amountSats, CancellationToken ct = default)

Parameters

nodeInfo string

amountSats string

ct CancellationToken

Returns

Task<OpenChannelIpcResponse>

OpenChannelSubscriptionAsync(ChannelId, CancellationToken)

public Task<OpenChannelSubscriptionIpcResponse> OpenChannelSubscriptionAsync(ChannelId channelId, CancellationToken ct = default)

Parameters

channelId ChannelId

ct CancellationToken

Returns

Task<OpenChannelSubscriptionIpcResponse>