SendMany

SendMany handles a request for a transaction that creates multiple specified outputs in parallel. If neither target_conf, or sat_per_vbyte are set, then the internal wallet will consult its fee model to determine a fee for the default confirmation target.

Source: lightning.proto

gRPC

rpc SendMany (SendManyRequest) returns (SendManyResponse);

REST

HTTP Method	Path
POST	/v1/transactions/many

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', 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 = {
  AddrToAmount: <AddrToAmountEntry>,
  target_conf: <int32>,
  sat_per_vbyte: <uint64>,
  sat_per_byte: <int64>,
  label: <string>,
  min_confs: <int32>,
  spend_unconfirmed: <bool>,
  coin_selection_strategy: <CoinSelectionStrategy>,
};
client.sendMany(request, function(err, response) {
  console.log(response);
});
// Console output:
//  {
//    "txid": <string>,
//  }

Python

import codecs, grpc, os
# Generate the following 2 modules by compiling the lightning.proto with the grpcio-tools.
# See https://github.com/lightningnetwork/lnd/blob/master/docs/grpc/python.md for instructions.
import lightning_pb2 as lnrpc, lightning_pb2_grpc as lightningstub

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 = lightningstub.LightningStub(channel)
request = lnrpc.SendManyRequest(
  AddrToAmount=<AddrToAmountEntry>,
  target_conf=<int32>,
  sat_per_vbyte=<uint64>,
  sat_per_byte=<int64>,
  label=<string>,
  min_confs=<int32>,
  spend_unconfirmed=<bool>,
  coin_selection_strategy=<CoinSelectionStrategy>,
)
response = stub.SendMany(request)
print(response)
# {
#    "txid": <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 = {
  AddrToAmount: <object>, // <AddrToAmountEntry> 
  target_conf: <integer>, // <int32> 
  sat_per_vbyte: <string>, // <uint64> 
  sat_per_byte: <string>, // <int64> 
  label: <string>, // <string> 
  min_confs: <integer>, // <int32> 
  spend_unconfirmed: <boolean>, // <bool> 
  coin_selection_strategy: <string>, // <CoinSelectionStrategy> 
};
let options = {
  url: `https://${REST_HOST}/v1/transactions/many`,
  // 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:
//  {
//    "txid": <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}/v1/transactions/many'
macaroon = codecs.encode(open(MACAROON_PATH, 'rb').read(), 'hex')
headers = {'Grpc-Metadata-macaroon': macaroon}
data = {
  'AddrToAmount': <AddrToAmountEntry>,
  'target_conf': <int32>,
  'sat_per_vbyte': <uint64>,
  'sat_per_byte': <int64>,
  'label': <string>,
  'min_confs': <int32>,
  'spend_unconfirmed': <bool>,
  'coin_selection_strategy': <CoinSelectionStrategy>,
}
r = requests.post(url, headers=headers, data=json.dumps(data), verify=TLS_PATH)
print(r.json())
# {
#    "txid": <string>,
# }

Shell

$ lncli sendmany --help

NAME:
   lncli sendmany - Send bitcoin on-chain to multiple addresses.

USAGE:
   lncli sendmany [command options] send-json-string [--conf_target=N] [--sat_per_vbyte=P]

CATEGORY:
   On-chain

DESCRIPTION:
   
  Create and broadcast a transaction paying the specified amount(s) to the passed address(es).

  The send-json-string' param decodes addresses and the amount to send
  respectively in the following format:

      '{"ExampleAddr": NumCoinsInSatoshis, "SecondAddr": NumCoins}'
  

OPTIONS:
   --conf_target value              (optional) the number of blocks that the transaction *should* confirm in, will be used for fee estimation (default: 0)
   --sat_per_vbyte value            (optional) a manual fee expressed in sat/vbyte that should be used when crafting the transaction (default: 0)
   --min_confs value                (optional) the minimum number of confirmations each one of your outputs used for the transaction must satisfy (default: 1)
   --coin_selection_strategy value  (optional) the strategy to use for selecting coins. Possible values are 'largest', 'random', or 'global-config'. If either 'largest' or 'random' is specified, it will override the globally configured strategy in lnd.conf (default: "global-config")
   --label value                    (optional) a label for the transaction
   

Messages

lnrpc.SendManyRequest

Source: lightning.proto

Field	gRPC Type	REST Type	REST Placement
AddrToAmount The map from addresses to amounts	AddrToAmountEntry[]	object	body
target_conf The target number of blocks that this transaction should be confirmed by.	int32	integer	body
sat_per_vbyte A manual fee rate set in sat/vbyte that should be used when crafting the transaction.	uint64	string	body
sat_per_bytedeprecated Deprecated, use sat_per_vbyte. A manual fee rate set in sat/vbyte that should be used when crafting the transaction.	int64	string	body
label An optional label for the transaction, limited to 500 characters.	string	string	body
min_confs The minimum number of confirmations each one of your outputs used for the transaction must satisfy.	int32	integer	body
spend_unconfirmed Whether unconfirmed outputs should be used as inputs for the transaction.	bool	boolean	body
coin_selection_strategy The strategy to use for selecting coins during sending many requests.	CoinSelectionStrategy	string	body

lnrpc.SendManyResponse

Source: lightning.proto

Field	gRPC Type	REST Type
txid The id of the transaction	string	string

Nested Messages

lnrpc.SendManyRequest.AddrToAmountEntry

Field	gRPC Type	REST Type
key	string	unknown
value	int64	unknown

Enums

lnrpc.CoinSelectionStrategy

Name	Number
STRATEGY_USE_GLOBAL_CONFIG Use the coin selection strategy defined in the global configuration (lnd.conf).	0
STRATEGY_LARGEST Select the largest available coins first during coin selection.	1
STRATEGY_RANDOM Randomly select the available coins during coin selection.	2