ModifyAccount

Source: auctioneerrpc/auctioneer.proto

gRPC

rpc ModifyAccount (ServerModifyAccountRequest) returns (ServerModifyAccountResponse);

Code Samples

gRPC

Javascript

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

const GRPC_HOST = 'localhost:12010'
const MACAROON_PATH = 'POOL_DIR/regtest/pool.macaroon'
const TLS_PATH = 'POOL_DIR/tls.cert'

const loaderOptions = {
  keepCase: true,
  longs: String,
  enums: String,
  defaults: true,
  oneofs: true,
};
const packageDefinition = protoLoader.loadSync('auctioneerrpc/auctioneer.proto', loaderOptions);
const poolrpc = grpc.loadPackageDefinition(packageDefinition).poolrpc;
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 poolrpc.ChannelAuctioneer(GRPC_HOST, creds);
let request = {
  trader_key: <bytes>,
  new_inputs: <ServerInput>,
  new_outputs: <ServerOutput>,
  new_params: <NewAccountParameters>,
  trader_nonces: <bytes>,
  prev_outputs: <TxOut>,
};
client.modifyAccount(request, function(err, response) {
  console.log(response);
});
// Console output:
//  {
//    "account_sig": <bytes>,
//    "server_nonces": <bytes>,
//  }

Python

import codecs, grpc, os
# Generate the following 2 modules by compiling the auctioneerrpc/auctioneer.proto with the grpcio-tools.
# See https://github.com/lightningnetwork/lnd/blob/master/docs/grpc/python.md for instructions.
import auctioneer_pb2 as poolrpc, auctioneer_pb2_grpc as auctioneerstub

GRPC_HOST = 'localhost:12010'
MACAROON_PATH = 'POOL_DIR/regtest/pool.macaroon'
TLS_PATH = 'POOL_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 = auctioneerstub.ChannelAuctioneerStub(channel)
request = poolrpc.ServerModifyAccountRequest(
  trader_key=<bytes>,
  new_inputs=<ServerInput>,
  new_outputs=<ServerOutput>,
  new_params=<NewAccountParameters>,
  trader_nonces=<bytes>,
  prev_outputs=<TxOut>,
)
response = stub.ModifyAccount(request)
print(response)
# {
#    "account_sig": <bytes>,
#    "server_nonces": <bytes>,
# }

Shell

# There is no CLI command for this RPC

Messages

poolrpc.ServerModifyAccountRequest

Source: auctioneerrpc/auctioneer.proto

Field	gRPC Type	REST Type	REST Placement
trader_key The trader's account key of the account to be modified.	bytes	unknown	unknown
new_inputs An additional set of inputs that can be included in the spending transaction of an account. These can be used to deposit more funds into an account. These must be under control of the backing lnd node's wallet.	ServerInput[]	unknown	unknown
new_outputs An additional set of outputs that can be included in the spending transaction of an account. These can be used to withdraw funds from an account.	ServerOutput[]	unknown	unknown
new_params The new parameters to apply for the account.	NewAccountParameters	unknown	unknown
trader_nonces A set of 66-byte nonces for each version 1 (Taproot enabled) account. The nonces can be used to produce a MuSig2 partial signature to spend the account using the key spend path, which is a MuSig2 combined key of the auctioneer key and the trader key.	bytes	unknown	unknown
prev_outputs The full list of UTXO information for each of the inputs being spent. This is required when spending a Taproot enabled (account version 1) output or when adding additional Taproot inputs.	TxOut[]	unknown	unknown

poolrpc.ServerModifyAccountResponse

Source: auctioneerrpc/auctioneer.proto

Field	gRPC Type	REST Type
account_sig The auctioneer's signature that allows a trader to broadcast a transaction spending from an account output. For version 1 (Taproot enabled) accounts, this merely represents a partial MuSig2 signature that can be combined into a full signature by the trader daemon by adding its own partial signature. A set of nonces will be provided by the server (in case this is a v1 account) to allow finalizing the MuSig2 signing session.	bytes	unknown
server_nonces An optional set of 66-byte nonces for a version 1 (Taproot enabled) account spend. The nonces can be used to produce a MuSig2 partial signature to spend the account using the key spend path, which is a MuSig2 combined key of the auctioneer key and the trader key.	bytes	unknown

Nested Messages

poolrpc.OutPoint

Field	gRPC Type	REST Type
txid Raw bytes representing the transaction id.	bytes	string
output_index The index of the output on the transaction.	uint32	integer

poolrpc.ServerInput

Field	gRPC Type	REST Type
outpoint The outpoint that the input corresponds to.	OutPoint	unknown
sig_script The signature script required by the input. This only applies to NP2WKH inputs.	bytes	unknown

poolrpc.ServerModifyAccountRequest.NewAccountParameters

Field	gRPC Type	REST Type
value The new value of the account.	uint64	unknown
expiry The new expiry of the account as an absolute height.	uint32	unknown
version The new version of the account.	uint32	unknown

poolrpc.ServerOutput

Field	gRPC Type	REST Type
value The value, in satoshis, of the output.	uint64	unknown
script The script of the output to send the value to.	bytes	unknown

poolrpc.TxOut

Field	gRPC Type	REST Type
value The value of the transaction output in satoshis.	uint64	unknown
pk_script The public key script of the output.	bytes	unknown