Skip to main content

CloseChannel

CloseChannel attempts to close an active channel identified by its channel outpoint (ChannelPoint). The actions of this method can additionally be augmented to attempt a force close after a timeout period in the case of an inactive peer. If a non-force close (cooperative closure) is requested, then the user can specify either a target number of blocks until the closure transaction is confirmed, or a manual fee rate. If neither are specified, then a default lax, block confirmation target is used.

Source: lightning.proto

gRPC

info

This is a server-streaming RPC

rpc CloseChannel (CloseChannelRequest) returns (stream CloseStatusUpdate);

REST

HTTP MethodPath
DELETE /v1/channels/{channel_point.funding_txid_str}/{channel_point.output_index}

Code Samples

const fs = require('fs');
const grpc = require('@grpc/grpc-js');
const protoLoader = require('@grpc/proto-loader');

const GRPC_HOST = 'localhost:10009'
const MACAROON_PATH = 'LND_DIR/data/chain/bitcoin/regtest/admin.macaroon'
const TLS_PATH = 'LND_DIR/tls.cert'

const loaderOptions = {
keepCase: true,
longs: String,
enums: String,
defaults: true,
oneofs: true,
};
const packageDefinition = protoLoader.loadSync('lightning.proto', loaderOptions);
const lnrpc = grpc.loadPackageDefinition(packageDefinition).lnrpc;
process.env.GRPC_SSL_CIPHER_SUITES = 'HIGH+ECDSA';
const tlsCert = fs.readFileSync(TLS_PATH);
const sslCreds = grpc.credentials.createSsl(tlsCert);
const macaroon = fs.readFileSync(MACAROON_PATH).toString('hex');
const macaroonCreds = grpc.credentials.createFromMetadataGenerator(function(args, callback) {
let metadata = new grpc.Metadata();
metadata.add('macaroon', macaroon);
callback(null, metadata);
});
let creds = grpc.credentials.combineChannelCredentials(sslCreds, macaroonCreds);
let client = new lnrpc.Lightning(GRPC_HOST, creds);
let request = {
channel_point: <ChannelPoint>,
force: <bool>,
target_conf: <int32>,
sat_per_byte: <int64>,
delivery_address: <string>,
sat_per_vbyte: <uint64>,
max_fee_per_vbyte: <uint64>,
};
let call = client.closeChannel(request);
call.on('data', function(response) {
// A response was received from the server.
console.log(response);
});
call.on('status', function(status) {
// The current status of the stream.
});
call.on('end', function() {
// The server has closed the stream.
});
// Console output:
// {
// "close_pending": <PendingUpdate>,
// "chan_close": <ChannelCloseUpdate>,
// }

Messages

lnrpc.CloseChannelRequest

Source: lightning.proto

FieldgRPC TypeREST TypeREST Placement
channel_point
ChannelPointobjectmixed
force
boolbooleanquery
target_conf
int32integerquery
sat_per_byte
int64stringquery
delivery_address
stringstringquery
sat_per_vbyte
uint64stringquery
max_fee_per_vbyte
uint64stringquery

lnrpc.CloseStatusUpdate

Source: lightning.proto

FieldgRPC TypeREST Type
close_pending
PendingUpdateobject
chan_close
ChannelCloseUpdateobject

Nested Messages

lnrpc.ChannelPoint

FieldgRPC TypeREST Type
funding_txid_bytes
bytesstring
funding_txid_str
stringstring
output_index
uint32integer

lnrpc.PendingUpdate

FieldgRPC TypeREST Type
txid
bytesstring
output_index
uint32integer

lnrpc.ChannelCloseUpdate

FieldgRPC TypeREST Type
closing_txid
bytesstring
success
boolboolean