LabelTransaction

LabelTransaction adds a label to a transaction. If the transaction already has a label the call will fail unless the overwrite bool is set. This will overwrite the existing transaction label. Labels must not be empty, and cannot exceed 500 characters.

Source: walletrpc/walletkit.proto

gRPC

rpc LabelTransaction (LabelTransactionRequest) returns (LabelTransactionResponse);

REST

HTTP Method	Path
POST	/v2/wallet/tx/label

Code Samples

gRPC

Javascript

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', 'walletrpc/walletkit.proto'], loaderOptions);
const walletrpc = grpc.loadPackageDefinition(packageDefinition).walletrpc;
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 walletrpc.WalletKit(GRPC_HOST, creds);
let request = {
  txid: <bytes>,
  label: <string>,
  overwrite: <bool>,
};
client.labelTransaction(request, function(err, response) {
  console.log(response);
});
// Console output:
//  {
//    "status": <string>,
//  }

Python

import codecs, grpc, os
# Generate the following 2 modules by compiling the walletrpc/walletkit.proto with the grpcio-tools.
# See https://github.com/lightningnetwork/lnd/blob/master/docs/grpc/python.md for instructions.
import walletkit_pb2 as walletrpc, walletkit_pb2_grpc as walletkitstub

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

# create macaroon credentials
macaroon = codecs.encode(open(MACAROON_PATH, 'rb').read(), 'hex')
def metadata_callback(context, callback):
  callback([('macaroon', macaroon)], None)
auth_creds = grpc.metadata_call_credentials(metadata_callback)
# create SSL credentials
os.environ['GRPC_SSL_CIPHER_SUITES'] = 'HIGH+ECDSA'
cert = open(TLS_PATH, 'rb').read()
ssl_creds = grpc.ssl_channel_credentials(cert)
# combine macaroon and SSL credentials
combined_creds = grpc.composite_channel_credentials(ssl_creds, auth_creds)
# make the request
channel = grpc.secure_channel(GRPC_HOST, combined_creds)
stub = walletkitstub.WalletKitStub(channel)
request = walletrpc.LabelTransactionRequest(
  txid=<bytes>,
  label=<string>,
  overwrite=<bool>,
)
response = stub.LabelTransaction(request)
print(response)
# {
#    "status": <string>,
# }

REST

Javascript

const fs = require('fs');
const request = require('request');

const REST_HOST = 'localhost:8080'
const MACAROON_PATH = 'LND_DIR/data/chain/bitcoin/regtest/admin.macaroon'

let requestBody = {
  txid: <string>, // <bytes> (base64 encoded)
  label: <string>, // <string> 
  overwrite: <boolean>, // <bool> 
};
let options = {
  url: `https://${REST_HOST}/v2/wallet/tx/label`,
  // Work-around for self-signed certificates.
  rejectUnauthorized: false,
  json: true,
  headers: {
    'Grpc-Metadata-macaroon': fs.readFileSync(MACAROON_PATH).toString('hex'),
  },
  form: JSON.stringify(requestBody),
}
request.post(options, function(error, response, body) {
  console.log(body);
});
// Console output:
//  {
//    "status": <string>, // <string> 
//  }

Python

import base64, codecs, json, requests

REST_HOST = 'localhost:8080'
MACAROON_PATH = 'LND_DIR/data/chain/bitcoin/regtest/admin.macaroon'
TLS_PATH = 'LND_DIR/tls.cert'

url = f'https://{REST_HOST}/v2/wallet/tx/label'
macaroon = codecs.encode(open(MACAROON_PATH, 'rb').read(), 'hex')
headers = {'Grpc-Metadata-macaroon': macaroon}
data = {
  'txid': base64.b64encode(<bytes>),
  'label': <string>,
  'overwrite': <bool>,
}
r = requests.post(url, headers=headers, data=json.dumps(data), verify=TLS_PATH)
print(r.json())
# {
#    "status": <string>,
# }

Shell

$ lncli wallet labeltx --help

NAME:
   lncli wallet labeltx - Adds a label to a transaction.

USAGE:
   lncli wallet labeltx [command options] txid label

DESCRIPTION:
   
  Add a label to a transaction. If the transaction already has a label, 
  this call will fail unless the overwrite option is set. The label is 
  limited to 500 characters. Note that multi word labels must be contained
  in quotation marks ("").
  

OPTIONS:
   --overwrite  set to overwrite existing labels
   

Messages

walletrpc.LabelTransactionRequest

Source: walletrpc/walletkit.proto

Field	gRPC Type	REST Type	REST Placement
txid The txid of the transaction to label. Note: When using gRPC, the bytes must be in little-endian (reverse) order.	bytes	string	body
label The label to add to the transaction, limited to 500 characters.	string	string	body
overwrite Whether to overwrite the existing label, if it is present.	bool	boolean	body

walletrpc.LabelTransactionResponse

Source: walletrpc/walletkit.proto

Field	gRPC Type	REST Type
status The status of the label operation.	string	string