PrivacyMapConversion

PrivacyMapConversion can be used map real values to their pseudo counterpart and vice versa.

Source: firewall.proto

gRPC

rpc PrivacyMapConversion (PrivacyMapConversionRequest) returns (PrivacyMapConversionResponse);

REST

HTTP Method	Path
POST	/v1/firewall/privacy_map/convert

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('firewall.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.Firewall(GRPC_HOST, creds);
let request = {
  real_to_pseudo: <bool>,
  session_id: <bytes>,
  input: <string>,
  group_id: <bytes>,
};
client.privacyMapConversion(request, function(err, response) {
  console.log(response);
});
// Console output:
//  {
//    "output": <string>,
//  }

Python

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

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 = firewallstub.FirewallStub(channel)
request = litrpc.PrivacyMapConversionRequest(
  real_to_pseudo=<bool>,
  session_id=<bytes>,
  input=<string>,
  group_id=<bytes>,
)
response = stub.PrivacyMapConversion(request)
print(response)
# {
#    "output": <string>,
# }

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 = {
  real_to_pseudo: <boolean>, // <bool> 
  session_id: <string>, // <bytes> (base64 encoded)
  input: <string>, // <string> 
  group_id: <string>, // <bytes> (base64 encoded)
};
let options = {
  url: `https://${REST_HOST}/v1/firewall/privacy_map/convert`,
  // 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:
//  {
//    "output": <string>, // <string> 
//  }

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/firewall/privacy_map/convert'
macaroon = codecs.encode(open(MACAROON_PATH, 'rb').read(), 'hex')
headers = {'Grpc-Metadata-macaroon': macaroon}
data = {
  'real_to_pseudo': <bool>,
  'session_id': base64.b64encode(<bytes>),
  'input': <string>,
  'group_id': base64.b64encode(<bytes>),
}
r = requests.post(url, headers=headers, data=json.dumps(data), verify=TLS_PATH)
print(r.json())
# {
#    "output": <string>,
# }

Shell

$ litcli privacy --help

NAME:
   litcli privacy - Access the real-pseudo string pairs of the privacy mapper. To improve privacy around data sharing, channel ids, channel points and node pubkeys are obfuscated by litd through a system called the Privacy Mapper. The Privacy Mapper can convert both strings and uint64 to the pseudo counter part and back.

USAGE:
   litcli privacy command [command options] [arguments...]

COMMANDS:
   str, s     Convert a string to its real or pseudo counter part.
   uint64, u  Convert a uint64 to its real or pseudo counter part.

OPTIONS:
   --realtopseudo    Set to true if the input should be mapped to its pseudo counterpart. Otherwise the input will be taken as the pseudo value that should be mapped to its real counterpart.
   --group_id value  The ID of the session group who's privacy map DB should be queried.
   --help, -h        show help
   

Messages

litrpc.PrivacyMapConversionRequest

Source: firewall.proto

Field	gRPC Type	REST Type	REST Placement
real_to_pseudo If set to true, then the input string will be taken as the real value and the response will the the pseudo value it if exists. Otherwise, the input string will be assumed to be the pseudo value.	bool	boolean	body
session_iddeprecated Deprecated, use group_id. The session ID under which to search for the real-pseudo pair.	bytes	string	body
input The input to be converted into the real or pseudo value.	string	string	body
group_id The group ID under which to search for the real-pseudo pair.	bytes	string	body

litrpc.PrivacyMapConversionResponse

Source: firewall.proto

Field	gRPC Type	REST Type
output The resulting real or pseudo output.	string	string