@synonymdev/blocktank-lsp-http-client - npm Package Compare versions

Comparing version 0.3.2 to 0.6.0

CHANGELOG.md

 # Changelog
 
+## 0.6.0 - 05.10.2023
+
+- (feat) Added `maxClientBalanceSat` object to `IBtInfo.options`.
+
+## 0.5.0 - 03.10.2023
+
+- (feat) Added `close` object to `order.channel`.
+
+## 0.4.0 - 29.09.2023
+
+- (feat) Added `zeroReserve` options to `createOrder` method.
+
 ## 0.3.2 - 21.09.2023
 
-- (enhance) Added `turboChannel` options to `createOrder` method.
+- (feat) Added `turboChannel` options to `createOrder` method.
 
@@ -7,0 +19,0 @@ ## 0.3.1 - 12.09.2023

dist/BlocktankClient.d.ts

@@ -21,2 +21,6 @@ import { IBtInfo, IBtOrder, ICJitEntry } from './shared';
     turboChannel: boolean;
+    /**
+     * Allow the peer to have zero channel reserve (dust limit).
+     */
+    zeroReserve: boolean;
 }
@@ -23,0 +27,0 @@ export declare const defaultCreateOrderOptions: ICreateOrderOptions;

dist/BlocktankClient.js

@@ -12,3 +12,4 @@ "use strict";
     couponCode: '',
-    turboChannel: false
+    turboChannel: false,
+    zeroReserve: false
 };
@@ -15,0 +16,0 @@ class BlocktankClientError extends Error {

dist/shared/IBtChannel.d.ts

 import { BtOpenChannelState } from './BtOpenChannelState';
+import { IBtChannelClose } from './IBtChannelClose';
 export interface IBtChannel {
@@ -11,4 +12,14 @@ state: BtOpenChannelState;
     };
+    /**
+     * @deprecated Use close.txId instead.
+     */
     closingTxId?: string;
+    /**
+     * Only availabe if state === closed. Channels before Oct 2023 may have default values assigned that do not represent reality.
+     */
+    close?: IBtChannelClose;
+    /**
+     * Available as soon as the channel is confirmed.
+     */
     shortChannelId?: string;
 }

dist/shared/IBtInfo.d.ts

 import { ILspNode } from './ILspNode';
 export interface IBtInfo {
+    /**
+     * Current Blocktank version
+     */
     version: number;
+    /**
+     * Available nodes.
+     */
     nodes: ILspNode[];
     options: {
+        /**
+         * Minimum channel size
+         */
         minChannelSizeSat: number;
+        /**
+         * Maximum channel size
+         */
         maxChannelSizeSat: number;
+        /**
+         * Minimum channel lease time in weeks.
+         */
         minExpiryWeeks: number;
+        /**
+         * Maximum channel lease time in weeks.
+         */
         maxExpiryWeeks: number;
+        /**
+         * Minimum payment confirmation for safe payments.
+         */
         minPaymentConfirmations: number;
+        /**
+         * Minimum payment confirmations for high value payments.
+         */
         minHighRiskPaymentConfirmations: number;
+        /**
+         * Maximum clientBalanceSat that is accepted as 0conf/turbochannel.
+         */
         max0ConfClientBalanceSat: number;
+        /**
+         * Maximum clientBalanceSat in general.
+         */
+        maxClientBalanceSat: number;
     };
 }

dist/shared/IBtOrder.d.ts

@@ -12,2 +12,3 @@ import { IBtChannel } from "./IBtChannel";
     zeroConf: boolean;
+    zeroReserve: boolean;
     channelExpiryWeeks: number;
@@ -14,0 +15,0 @@ channelExpiresAt: string;

package.json

 {
   "name": "@synonymdev/blocktank-lsp-http-client",
-  "version": "0.3.2",
+  "version": "0.6.0",
   "description": "Blocktank Http Api Client",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

src/BlocktankClient.spec.ts

@@ -22,3 +22,3 @@ import {BlocktankClient} from './BlocktankClient'
             lspNodeId: firstNodeId,
-            turboChannel: true
+            turboChannel: true,
         })
@@ -25,0 +25,0 @@ expect(order.channelExpiryWeeks).toEqual(10)

src/BlocktankClient.ts

@@ -23,2 +23,6 @@ import axios from 'axios';
     turboChannel: boolean,
+    /**
+     * Allow the peer to have zero channel reserve (dust limit).
+     */
+    zeroReserve: boolean
 }
@@ -30,3 +34,4 @@
     couponCode: '',
-    turboChannel: false
+    turboChannel: false,
+    zeroReserve: false
 }
@@ -33,0 +38,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

52402

increased by4.73%

Number of package files

66

increased by4.76%

Lines of code

1006

increased by7.82%

No dependency changes