Merge pull request #130 from bennyhodl/store-transactions

feat: Add payments claimed to storage

Author: Jasonvdb

example/App.tsx

@@ -410,6 +410,15 @@ const App = (): ReactElement => {
 						}}
 					/>
 
+					<Button
+						title={'Get claimed payments'}
+						onPress={async (): Promise<void> => {
+							setMessage('Getting all LDK payments...');
+							const res = await lm.getLdkPaymentsClaimed();
+							setMessage(JSON.stringify(res));
+						}}
+					/>
+
 					<Button
 						title={'Create invoice'}
 						onPress={async (): Promise<void> => {

lib/src/lightning-manager.ts

@@ -891,6 +891,7 @@ class LightningManager {
 					broadcasted_transactions: await this.getLdkBroadcastedTxs(),
 					payment_ids: await this.getLdkPaymentIds(),
 					spendable_outputs: await this.getLdkSpendableOutputs(),
+					payments_claimed: await this.getLdkPaymentsClaimed(),
 					timestamp: Date.now(),
 				},
 				package_version: require('../package.json').version,
@@ -1133,6 +1134,40 @@ class LightningManager {
 		});
 	};
 
+	/**
+	 * Adds payment claimed to storage.
+	 * @param payment {@link TChannelManagerClaim}
+	 * @returns void
+	 */
+	private appendLdkPaymentsClaimed = async (
+		payment: TChannelManagerClaim,
+	): Promise<void> => {
+		let paymentsClaimed = await this.getLdkPaymentsClaimed();
+		if (paymentsClaimed.includes(payment)) {
+			return;
+		}
+
+		paymentsClaimed.push(payment);
+		await ldk.writeToFile({
+			fileName: ELdkFiles.payments_claimed,
+			content: JSON.stringify(paymentsClaimed),
+		});
+	};
+
+	/**
+	 * Returns the payments claimed in storage.
+	 * @returns {@link TChannelManagerClaim[]}
+	 */
+	getLdkPaymentsClaimed = async (): Promise<TChannelManagerClaim[]> => {
+		const res = await ldk.readFromFile({
+			fileName: ELdkFiles.payments_claimed,
+		});
+		if (res.isOk()) {
+			return parseData(res.value.content, DefaultLdkDataShape.payments_claimed);
+		}
+		return DefaultLdkDataShape.payments_claimed;
+	};
+
 	/**
 	 * Returns previously confirmed outputs from storage.
 	 * @returns {Promise<TLdkConfirmedOutputs>}
@@ -1564,8 +1599,11 @@ class LightningManager {
 		console.log(`onChannelManagerDiscardFunding: ${JSON.stringify(res)}`); //TODO
 	}
 
-	private onChannelManagerPaymentClaimed(res: TChannelManagerClaim): void {
+	private async onChannelManagerPaymentClaimed(
+		res: TChannelManagerClaim,
+	): Promise<void> {
 		// Payment Received/Invoice Paid.
+		await this.appendLdkPaymentsClaimed(res);
 		console.log(`onChannelManagerPaymentClaimed: ${JSON.stringify(res)}`);
 		this.syncLdk().then();
 	}

lib/src/utils/types.ts

@@ -429,6 +429,7 @@ export enum ELdkFiles {
 	broadcasted_transactions = 'broadcasted_transactions.json',
 	payment_ids = 'payment_ids.json',
 	spendable_outputs = 'spendable_outputs.json',
+	payments_claimed = 'payments_claimed.json', // JSON file saved from JS
 }
 
 export enum ELdkData {
@@ -441,6 +442,7 @@ export enum ELdkData {
 	payment_ids = 'payment_ids',
 	timestamp = 'timestamp',
 	spendable_outputs = 'spendable_outputs',
+	payments_claimed = 'payments_claimed',
 }
 
 export type TLdkData = {
@@ -453,6 +455,7 @@ export type TLdkData = {
 	[ELdkData.payment_ids]: TLdkPaymentIds;
 	[ELdkData.timestamp]: number;
 	[ELdkData.spendable_outputs]: TLdkSpendableOutputs;
+	[ELdkData.payments_claimed]: TChannelManagerClaim[];
 };
 
 export type TAccountBackup = {
@@ -484,6 +487,7 @@ export const DefaultLdkDataShape: TLdkData = {
 	[ELdkData.payment_ids]: [],
 	[ELdkData.timestamp]: 0,
 	[ELdkData.spendable_outputs]: [],
+	[ELdkData.payments_claimed]: [],
 };
 
 export type TAvailableNetworks =