CreditAccount

CreditAccount increases the balance of an existing account in the account database.

Source: lit-accounts.proto

gRPC

rpc CreditAccount (CreditAccountRequest) returns (CreditAccountResponse);

REST

HTTP Method	Path
POST	/v1/accounts/credit/{account.id}

Code Samples

gRPC

Javascript

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

const GRPC_HOST = 'localhost:8443'
const MACAROON_PATH = 'LIT_DIR/regtest/lit.macaroon'
const TLS_PATH = 'LIT_DIR/tls.cert'

const loaderOptions = {
  keepCase: true,
  longs: String,
  enums: String,
  defaults: true,
  oneofs: true,
};
const packageDefinition = protoLoader.loadSync('lit-accounts.proto', loaderOptions);
const litrpc = grpc.loadPackageDefinition(packageDefinition).litrpc;
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 litrpc.Accounts(GRPC_HOST, creds);
let request = {
  account: <AccountIdentifier>,
  amount: <uint64>,
};
client.creditAccount(request, function(err, response) {
  console.log(response);
});
// Console output:
//  {
//    "account": <Account>,
//  }

Python

import codecs, grpc, os
# Generate the following 2 modules by compiling the lit-accounts.proto with the grpcio-tools.
# See https://github.com/lightningnetwork/lnd/blob/master/docs/grpc/python.md for instructions.
import lit-accounts_pb2 as litrpc, lit-accounts_pb2_grpc as lit-accountsstub

GRPC_HOST = 'localhost:8443'
MACAROON_PATH = 'LIT_DIR/regtest/lit.macaroon'
TLS_PATH = 'LIT_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 = lit-accountsstub.AccountsStub(channel)
request = litrpc.CreditAccountRequest(
  account=<AccountIdentifier>,
  amount=<uint64>,
)
response = stub.CreditAccount(request)
print(response)
# {
#    "account": <Account>,
# }

REST

Javascript

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

const REST_HOST = 'localhost:8443'
const MACAROON_PATH = 'LIT_DIR/regtest/lit.macaroon'

let requestBody = {
  account: <object>, // <AccountIdentifier> 
  amount: <unknown>, // <uint64> 
};
let options = {
  url: `https://${REST_HOST}/v1/accounts/credit/{account.id}`,
  // 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:
//  {
//    "account": <object>, // <Account> 
//  }

Python

import base64, codecs, json, requests

REST_HOST = 'localhost:8443'
MACAROON_PATH = 'LIT_DIR/regtest/lit.macaroon'
TLS_PATH = 'LIT_DIR/tls.cert'

url = f'https://{REST_HOST}/v1/accounts/credit/{account.id}'
macaroon = codecs.encode(open(MACAROON_PATH, 'rb').read(), 'hex')
headers = {'Grpc-Metadata-macaroon': macaroon}
data = {
  'account': <AccountIdentifier>,
  'amount': <uint64>,
}
r = requests.post(url, headers=headers, data=json.dumps(data), verify=TLS_PATH)
print(r.json())
# {
#    "account": <Account>,
# }

Shell

$ litcli accounts update credit --help

NAME:
   litcli accounts update credit - Increase an account's balance by the given amount.

USAGE:
   litcli accounts update credit [command options] [id | label] amount

DESCRIPTION:
   Increases an existing off-chain account's balance by the given amount.

OPTIONS:
   --id value      The ID of the account to credit.
   --label value   (optional) The unique label of the account.
   --amount value  The amount to credit the account. (default: 0)
   

Messages

litrpc.CreditAccountRequest

Source: lit-accounts.proto

Field	gRPC Type	REST Type	REST Placement
account The identifier of the account to credit. Nested REST Parameters account.id: string in path	AccountIdentifier	object	path
amount The amount by which the account's balance should be credited.	uint64	unknown	body

litrpc.CreditAccountResponse

Source: lit-accounts.proto

Field	gRPC Type	REST Type
account The credited account.	Account	object

Nested Messages

litrpc.Account

Field	gRPC Type	REST Type
id The ID of the account.	string	string
initial_balance The initial balance in satoshis that was set when the account was created.	uint64	string
current_balance The current balance in satoshis.	int64	string
last_update Timestamp of the last time the account was updated.	int64	string
expiration_date Timestamp of the account's expiration date. Zero means it does not expire.	int64	string
invoices The list of invoices created by the account. An invoice created by an account will credit the account balance if it is settled.	AccountInvoice[]	array
payments The list of payments made by the account. A payment made by an account will debit the account balance if it is settled.	AccountPayment[]	array
label An optional label to identify the account. If this is not empty, then it is guaranteed to be unique.	string	string

litrpc.AccountIdentifier

Field	gRPC Type	REST Type
id The ID of the account.	string	string
label The label of the account.	string	string

litrpc.AccountInvoice

Field	gRPC Type	REST Type
hash The payment hash of the invoice.	bytes	string

litrpc.AccountPayment

Field	gRPC Type	REST Type
hash The payment hash.	bytes	string
state The state of the payment as reported by lnd.	string	string
full_amount The full amount in satoshis reserved for this payment. This includes the routing fee estimated by the fee limit of the payment request. The actual debited amount will likely be lower if the fee is below the limit.	int64	string