ListStaticAddressDeposits

loop:listdeposits ListStaticAddressDeposits returns a list of filtered static address deposits.

Source: looprpc/client.proto

gRPC

rpc ListStaticAddressDeposits (ListStaticAddressDepositsRequest) returns (ListStaticAddressDepositsResponse);

REST

HTTP Method	Path
GET	/v1/staticaddr/deposits

Code Samples

gRPC

Javascript

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

const GRPC_HOST = 'localhost:11010'
const MACAROON_PATH = 'LOOP_DIR/regtest/loop.macaroon'
const TLS_PATH = 'LOOP_DIR/tls.cert'

const loaderOptions = {
  keepCase: true,
  longs: String,
  enums: String,
  defaults: true,
  oneofs: true,
};
const packageDefinition = protoLoader.loadSync('looprpc/client.proto', loaderOptions);
const looprpc = grpc.loadPackageDefinition(packageDefinition).looprpc;
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 looprpc.SwapClient(GRPC_HOST, creds);
let request = {
  state_filter: <DepositState>,
  outpoints: <string>,
};
client.listStaticAddressDeposits(request, function(err, response) {
  console.log(response);
});
// Console output:
//  {
//    "filtered_deposits": <Deposit>,
//  }

Python

import codecs, grpc, os
# Generate the following 2 modules by compiling the looprpc/client.proto with the grpcio-tools.
# See https://github.com/lightningnetwork/lnd/blob/master/docs/grpc/python.md for instructions.
import client_pb2 as looprpc, client_pb2_grpc as clientstub

GRPC_HOST = 'localhost:11010'
MACAROON_PATH = 'LOOP_DIR/regtest/loop.macaroon'
TLS_PATH = 'LOOP_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 = clientstub.SwapClientStub(channel)
request = looprpc.ListStaticAddressDepositsRequest(
  state_filter=<DepositState>,
  outpoints=<string>,
)
response = stub.ListStaticAddressDeposits(request)
print(response)
# {
#    "filtered_deposits": <Deposit>,
# }

REST

Javascript

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

const REST_HOST = 'localhost:8081'
const MACAROON_PATH = 'LOOP_DIR/regtest/loop.macaroon'

let options = {
  url: `https://${REST_HOST}/v1/staticaddr/deposits`,
  // Work-around for self-signed certificates.
  rejectUnauthorized: false,
  json: true,
  headers: {
    'Grpc-Metadata-macaroon': fs.readFileSync(MACAROON_PATH).toString('hex'),
  },
}
request.get(options, function(error, response, body) {
  console.log(body);
});
// Console output:
//  {
//    "filtered_deposits": <array>, // <Deposit> 
//  }

Python

import base64, codecs, json, requests

REST_HOST = 'localhost:8081'
MACAROON_PATH = 'LOOP_DIR/regtest/loop.macaroon'
TLS_PATH = 'LOOP_DIR/tls.cert'

url = f'https://{REST_HOST}/v1/staticaddr/deposits'
macaroon = codecs.encode(open(MACAROON_PATH, 'rb').read(), 'hex')
headers = {'Grpc-Metadata-macaroon': macaroon}
r = requests.get(url, headers=headers, verify=TLS_PATH)
print(r.json())
# {
#    "filtered_deposits": <Deposit>,
# }

Shell

# There is no CLI command for this RPC

Messages

looprpc.ListStaticAddressDepositsRequest

Source: looprpc/client.proto

Field	gRPC Type	REST Type	REST Placement
state_filter Filters the list of all stored deposits by deposit state. Nested REST Parameters state_filter: string in query	DepositState	object	query
outpoints Filters the list of all stored deposits by the outpoint.	string[]	array	query

looprpc.ListStaticAddressDepositsResponse

Source: looprpc/client.proto

Field	gRPC Type	REST Type
filtered_deposits A list of all deposits that match the filtered state.	Deposit[]	array

Nested Messages

looprpc.Deposit

Field	gRPC Type	REST Type
id The identifier of the deposit.	bytes	string
state The state of the deposit.	DepositState	string
outpoint The outpoint of the deposit in format txid:index.	string	string
value The value of the deposit in satoshis.	int64	string
confirmation_height The block height at which the deposit was confirmed.	int64	string
blocks_until_expiry The number of blocks that are left until the deposit cannot be used for a loop-in swap anymore.	int64	string
swap_hash The swap hash of the swap that this deposit is part of. This field is only set if the deposit is part of a loop-in swap.	bytes	string

Enums

looprpc.DepositState

Name	Number
UNKNOWN_STATE UNKNOWN_STATE is the default state of a deposit.	0
DEPOSITED DEPOSITED indicates that the deposit has been sufficiently confirmed on chain.	1
WITHDRAWING WITHDRAWING indicates that the deposit is currently being withdrawn. It flips to WITHDRAWN once the withdrawal transaction has been sufficiently confirmed.	2
WITHDRAWN WITHDRAWN indicates that the deposit has been withdrawn.	3
LOOPING_IN LOOPING_IN indicates that the deposit is currently being used in a static address loop-in swap.	4
LOOPED_IN LOOPED_IN indicates that the deposit was used in a static address loop-in swap.	5
SWEEP_HTLC_TIMEOUT SWEEP_HTLC_TIMEOUT indicates that the deposit is part of an active loop-in of which the respective htlc was published by the server and the timeout path has opened up for the client to sweep.	6
HTLC_TIMEOUT_SWEPT HTLC_TIMEOUT_SWEPT indicates that the timeout path of the htlc has been swept by the client.	7
PUBLISH_EXPIRED PUBLISH_EXPIRED indicates that the deposit has expired and the sweep transaction has been published.	8
WAIT_FOR_EXPIRY_SWEEP WAIT_FOR_EXPIRY_SWEEP indicates that the deposit has expired and the sweep transaction has not yet been sufficiently confirmed.	9
EXPIRED EXPIRED indicates that the deposit has expired and the sweep transaction has been sufficiently confirmed.	10