lnd metrics

proto/autogenerated/client.md

@@ -105,9 +105,9 @@ The nostr server will send back a message response, and inside the body there wi
 
 - __User__:
   - expected context content
+    - __app_id__: _string_
     - __app_user_id__: _string_
     - __user_id__: _string_
-    - __app_id__: _string_
 
 - __Admin__:
   - expected context content
@@ -155,6 +155,13 @@ The nostr server will send back a message response, and inside the body there wi
   - input: [AppsMetricsRequest](#AppsMetricsRequest)
   - output: [AppsMetrics](#AppsMetrics)
 
+- GetLndMetrics
+  - auth type: __Admin__
+  - http method: __post__
+  - http route: __/api/admin/metrics/lnd__
+  - input: [LndMetricsRequest](#LndMetricsRequest)
+  - output: [LndMetrics](#LndMetrics)
+
 - Health
   - auth type: __Guest__
   - http method: __get__
@@ -421,42 +428,34 @@ The nostr server will send back a message response, and inside the body there wi
 ## Messages
 ### The content of requests and response from the methods
 
-### PayInvoiceResponse
-  - __preimage__: _string_
-  - __amount_paid__: _number_
-  - __operation_id__: _string_
-  - __service_fee__: _number_
-  - __network_fee__: _number_
+### AuthApp
+  - __app__: _[Application](#Application)_
+  - __auth_token__: _string_
 
-### OpenChannelRequest
-  - __destination__: _string_
-  - __fundingAmount__: _number_
-  - __pushAmount__: _number_
-  - __closeAddress__: _string_
+### PayAddressRequest
+  - __address__: _string_
+  - __amoutSats__: _number_
+  - __satsPerVByte__: _number_
 
-### LndGetInfoRequest
-  - __nodeId__: _number_
-
-### SendAppUserToAppPaymentRequest
-  - __from_user_identifier__: _string_
+### PayInvoiceRequest
+  - __invoice__: _string_
   - __amount__: _number_
 
-### SetMockAppBalanceRequest
-  - __amount__: _number_
+### GetUserOperationsResponse
+  - __latestOutgoingInvoiceOperations__: _[UserOperations](#UserOperations)_
+  - __latestIncomingInvoiceOperations__: _[UserOperations](#UserOperations)_
+  - __latestOutgoingTxOperations__: _[UserOperations](#UserOperations)_
+  - __latestIncomingTxOperations__: _[UserOperations](#UserOperations)_
+  - __latestOutgoingUserToUserPayemnts__: _[UserOperations](#UserOperations)_
+  - __latestIncomingUserToUserPayemnts__: _[UserOperations](#UserOperations)_
 
-### UserOperations
-  - __fromIndex__: _number_
-  - __toIndex__: _number_
-  - __operations__: ARRAY of: _[UserOperation](#UserOperation)_
+### AddAppUserRequest
+  - __identifier__: _string_
+  - __fail_if_exists__: _boolean_
+  - __balance__: _number_
 
-### GetAppUserLNURLInfoRequest
-  - __user_identifier__: _string_
-  - __base_url_override__: _string_
-
-### DecodeInvoiceResponse
-  - __amount__: _number_
-
-### AddProductRequest
+### Product
+  - __id__: _string_
   - __name__: _string_
   - __price_sats__: _number_
 
@@ -471,12 +470,131 @@ The nostr server will send back a message response, and inside the body there wi
   - __nostr__: _boolean_
   - __batch_size__: _number_
 
-### SetMockInvoiceAsPaidRequest
+### LndMetricsRequest
+  - __from_unix__: _number_ *this field is optional
+  - __to_unix__: _number_ *this field is optional
+
+### LndNodeMetrics
+  - __channels_balance_events__: ARRAY of: _[ChannelBalanceEvent](#ChannelBalanceEvent)_
+  - __chain_balance_events__: ARRAY of: _[ChainBalanceEvent](#ChainBalanceEvent)_
+  - __routing_events__: ARRAY of: _[RoutingEvent](#RoutingEvent)_
+
+### UsersInfo
+  - __total__: _number_
+  - __no_balance__: _number_
+  - __negative_balance__: _number_
+  - __always_been_inactive__: _number_
+  - __balance_avg__: _number_
+  - __balance_median__: _number_
+
+### NewInvoiceResponse
+  - __invoice__: _string_
+
+### PayInvoiceResponse
+  - __preimage__: _string_
+  - __amount_paid__: _number_
+  - __operation_id__: _string_
+  - __service_fee__: _number_
+  - __network_fee__: _number_
+
+### OpenChannelResponse
+  - __channelId__: _string_
+
+### LnurlLinkResponse
+  - __lnurl__: _string_
+  - __k1__: _string_
+
+### AddAppRequest
+  - __name__: _string_
+  - __allow_user_creation__: _boolean_
+
+### Application
+  - __name__: _string_
+  - __id__: _string_
+  - __balance__: _number_
+  - __npub__: _string_
+
+### SendAppUserToAppPaymentRequest
+  - __from_user_identifier__: _string_
+  - __amount__: _number_
+
+### DecodeInvoiceResponse
+  - __amount__: _number_
+
+### ClosureMigration
+  - __closes_at_unix__: _number_
+
+### SetMockAppBalanceRequest
+  - __amount__: _number_
+
+### HandleLnurlPayResponse
+  - __pr__: _string_
+  - __routes__: ARRAY of: _[Empty](#Empty)_
+
+### AppsMetrics
+  - __apps__: ARRAY of: _[AppMetrics](#AppMetrics)_
+
+### OpenChannelRequest
+  - __destination__: _string_
+  - __fundingAmount__: _number_
+  - __pushAmount__: _number_
+  - __closeAddress__: _string_
+
+### RelaysMigration
+  - __relays__: ARRAY of: _string_
+
+### GetAppUserRequest
+  - __user_identifier__: _string_
+
+### PayAppUserInvoiceRequest
+  - __user_identifier__: _string_
   - __invoice__: _string_
   - __amount__: _number_
 
-### LndGetInfoResponse
-  - __alias__: _string_
+### SendAppUserToAppUserPaymentRequest
+  - __from_user_identifier__: _string_
+  - __to_user_identifier__: _string_
+  - __amount__: _number_
+
+### NewAddressRequest
+  - __addressType__: _[AddressType](#AddressType)_
+
+### PayAddressResponse
+  - __txId__: _string_
+  - __operation_id__: _string_
+  - __service_fee__: _number_
+  - __network_fee__: _number_
+
+### AddProductRequest
+  - __name__: _string_
+  - __price_sats__: _number_
+
+### GetProductBuyLinkResponse
+  - __link__: _string_
+
+### RoutingEvent
+  - __incoming_channel_id__: _number_
+  - __incoming_htlc_id__: _number_
+  - __outgoing_channel_id__: _number_
+  - __outgoing_htlc_id__: _number_
+  - __timestamp_ns__: _number_
+  - __event_type__: _string_
+  - __incoming_amt_msat__: _number_
+  - __outgoing_amt_msat__: _number_
+  - __failure_string__: _string_
+  - __settled__: _boolean_
+  - __offchain__: _boolean_
+  - __forward_fail_event__: _boolean_
+
+### AppUser
+  - __identifier__: _string_
+  - __info__: _[UserInfo](#UserInfo)_
+  - __max_withdrawable__: _number_
+
+### AddAppInvoiceRequest
+  - __payer_identifier__: _string_
+  - __http_callback_url__: _string_
+  - __invoice_req__: _[NewInvoiceRequest](#NewInvoiceRequest)_
 
 ### AddAppUserInvoiceRequest
   - __receiver_identifier__: _string_
@@ -484,50 +602,72 @@ The nostr server will send back a message response, and inside the body there wi
   - __http_callback_url__: _string_
   - __invoice_req__: _[NewInvoiceRequest](#NewInvoiceRequest)_
 
-### GetProductBuyLinkResponse
-  - __link__: _string_
+### DecodeInvoiceRequest
+  - __invoice__: _string_
 
-### AppsMetrics
-  - __apps__: ARRAY of: _[AppMetrics](#AppMetrics)_
+### UserOperations
+  - __fromIndex__: _number_
+  - __toIndex__: _number_
+  - __operations__: ARRAY of: _[UserOperation](#UserOperation)_
 
-### MigrationUpdate
-  - __closure__: _[ClosureMigration](#ClosureMigration)_ *this field is optional
-  - __relays__: _[RelaysMigration](#RelaysMigration)_ *this field is optional
+### EncryptionExchangeRequest
+  - __publicKey__: _string_
+  - __deviceId__: _string_
 
-### Empty
+### GetUserOperationsRequest
+  - __latestIncomingInvoice__: _number_
+  - __latestOutgoingInvoice__: _number_
+  - __latestIncomingTx__: _number_
+  - __latestOutgoingTx__: _number_
+  - __latestIncomingUserToUserPayment__: _number_
+  - __latestOutgoingUserToUserPayment__: _number_
 
-### AddAppUserRequest
-  - __identifier__: _string_
-  - __fail_if_exists__: _boolean_
-  - __balance__: _number_
-
-### GetUserOperationsResponse
-  - __latestOutgoingInvoiceOperations__: _[UserOperations](#UserOperations)_
-  - __latestIncomingInvoiceOperations__: _[UserOperations](#UserOperations)_
-  - __latestOutgoingTxOperations__: _[UserOperations](#UserOperations)_
-  - __latestIncomingTxOperations__: _[UserOperations](#UserOperations)_
-  - __latestOutgoingUserToUserPayemnts__: _[UserOperations](#UserOperations)_
-  - __latestIncomingUserToUserPayemnts__: _[UserOperations](#UserOperations)_
-
-### AuthApp
+### AppMetrics
   - __app__: _[Application](#Application)_
-  - __auth_token__: _string_
+  - __users__: _[UsersInfo](#UsersInfo)_
+  - __total_received__: _number_
+  - __total_spent__: _number_
+  - __total_available__: _number_
+  - __unpaid_invoices__: _number_
+  - __operations__: ARRAY of: _[UserOperation](#UserOperation)_
 
-### AppUser
-  - __identifier__: _string_
-  - __info__: _[UserInfo](#UserInfo)_
-  - __max_withdrawable__: _number_
+### ChainBalanceEvent
+  - __block_height__: _number_
+  - __confirmed_balance__: _number_
+  - __unconfirmed_balance__: _number_
+  - __total_balance__: _number_
 
-### SendAppUserToAppUserPaymentRequest
-  - __from_user_identifier__: _string_
-  - __to_user_identifier__: _string_
+### AuthAppRequest
+  - __name__: _string_
+  - __allow_user_creation__: _boolean_ *this field is optional
+
+### SetMockAppUserBalanceRequest
+  - __user_identifier__: _string_
   - __amount__: _number_
 
 ### NewAddressResponse
   - __address__: _string_
 
-### DecodeInvoiceRequest
-  - __invoice__: _string_
+### LiveUserOperation
+  - __operation__: _[UserOperation](#UserOperation)_
+
+### Empty
+
+### ChannelBalanceEvent
+  - __block_height__: _number_
+  - __channel_id__: _string_
+  - __local_balance_sats__: _number_
+  - __remote_balance_sats__: _number_
+
+### LndMetrics
+  - __nodes__: ARRAY of: _[LndNodeMetrics](#LndNodeMetrics)_
+
+### LndGetInfoResponse
+  - __alias__: _string_
+
+### NewInvoiceRequest
+  - __amountSats__: _number_
+  - __memo__: _string_
 
 ### LnurlWithdrawInfoResponse
   - __tag__: _string_
@@ -539,91 +679,18 @@ The nostr server will send back a message response, and inside the body there wi
   - __balanceCheck__: _string_
   - __payLink__: _string_
 
-### HandleLnurlPayResponse
-  - __pr__: _string_
-  - __routes__: ARRAY of: _[Empty](#Empty)_
-
-### RelaysMigration
-  - __relays__: ARRAY of: _string_
-
-### Product
-  - __id__: _string_
-  - __name__: _string_
-  - __price_sats__: _number_
-
 ### UsageMetrics
   - __metrics__: ARRAY of: _[UsageMetric](#UsageMetric)_
 
-### AppsMetricsRequest
-  - __from_unix__: _number_ *this field is optional
-  - __to_unix__: _number_ *this field is optional
-  - __big_user_sats__: _number_ *this field is optional
-  - __huge_user_sats__: _number_ *this field is optional
-  - __include_operations__: _boolean_ *this field is optional
-
-### AppMetrics
-  - __app_name__: _string_
-  - __app_id__: _string_
-  - __app_npub__: _string_
-  - __app_balance__: _number_
-  - __total_received__: _number_
-  - __total_spent__: _number_
-  - __total_available__: _number_
-  - __total_users__: _number_
-  - __total_big_users__: _number_
-  - __total_huge_users__: _number_
-  - __unpaid_invoices__: _number_
-  - __operations__: ARRAY of: _[UserOperation](#UserOperation)_
-
-### AddAppRequest
-  - __name__: _string_
-  - __allow_user_creation__: _boolean_
-
-### OpenChannelResponse
-  - __channelId__: _string_
-
-### PayAddressRequest
-  - __address__: _string_
-  - __amoutSats__: _number_
-  - __satsPerVByte__: _number_
-
 ### UserInfo
   - __userId__: _string_
   - __balance__: _number_
   - __max_withdrawable__: _number_
 
-### LiveUserOperation
-  - __operation__: _[UserOperation](#UserOperation)_
-
-### ClosureMigration
-  - __closes_at_unix__: _number_
-
-### GetAppUserRequest
-  - __user_identifier__: _string_
-
-### GetUserOperationsRequest
-  - __latestIncomingInvoice__: _number_
-  - __latestOutgoingInvoice__: _number_
-  - __latestIncomingTx__: _number_
-  - __latestOutgoingTx__: _number_
-  - __latestIncomingUserToUserPayment__: _number_
-  - __latestOutgoingUserToUserPayment__: _number_
-
-### NewInvoiceRequest
-  - __amountSats__: _number_
-  - __memo__: _string_
-
-### AddAppInvoiceRequest
-  - __payer_identifier__: _string_
-  - __http_callback_url__: _string_
-  - __invoice_req__: _[NewInvoiceRequest](#NewInvoiceRequest)_
-
-### NewInvoiceResponse
-  - __invoice__: _string_
-
-### PayInvoiceRequest
-  - __invoice__: _string_
-  - __amount__: _number_
+### AppsMetricsRequest
+  - __from_unix__: _number_ *this field is optional
+  - __to_unix__: _number_ *this field is optional
+  - __include_operations__: _boolean_ *this field is optional
 
 ### LnurlPayInfoResponse
   - __tag__: _string_
@@ -634,34 +701,6 @@ The nostr server will send back a message response, and inside the body there wi
   - __allowsNostr__: _boolean_
   - __nostrPubkey__: _string_
 
-### LnurlLinkResponse
-  - __lnurl__: _string_
-  - __k1__: _string_
-
-### EncryptionExchangeRequest
-  - __publicKey__: _string_
-  - __deviceId__: _string_
-
-### AuthAppRequest
-  - __name__: _string_
-  - __allow_user_creation__: _boolean_ *this field is optional
-
-### Application
-  - __name__: _string_
-  - __id__: _string_
-  - __balance__: _number_
-  - __npub__: _string_
-
-### SetMockAppUserBalanceRequest
-  - __user_identifier__: _string_
-  - __amount__: _number_
-
-### PayAddressResponse
-  - __txId__: _string_
-  - __operation_id__: _string_
-  - __service_fee__: _number_
-  - __network_fee__: _number_
-
 ### UserOperation
   - __paidAtUnix__: _number_
   - __type__: _[UserOperationType](#UserOperationType)_
@@ -673,13 +712,20 @@ The nostr server will send back a message response, and inside the body there wi
   - __network_fee__: _number_
   - __confirmed__: _boolean_
 
-### PayAppUserInvoiceRequest
-  - __user_identifier__: _string_
+### MigrationUpdate
+  - __closure__: _[ClosureMigration](#ClosureMigration)_ *this field is optional
+  - __relays__: _[RelaysMigration](#RelaysMigration)_ *this field is optional
+
+### LndGetInfoRequest
+  - __nodeId__: _number_
+
+### SetMockInvoiceAsPaidRequest
   - __invoice__: _string_
   - __amount__: _number_
 
-### NewAddressRequest
-  - __addressType__: _[AddressType](#AddressType)_
+### GetAppUserLNURLInfoRequest
+  - __user_identifier__: _string_
+  - __base_url_override__: _string_
 ## Enums
 ### The enumerators used in the messages
 

proto/autogenerated/ts/express_server.ts

@@ -139,6 +139,28 @@ export default (methods: Types.ServerMethods, opts: ServerOptions) => {
             opts.metricsCallback([{ ...info, ...stats, ...authContext }])
         } catch (ex) { const e = ex as any; logErrorAndReturnResponse(e, e.message || e, res, logger, { ...info, ...stats, ...authCtx }, opts.metricsCallback); if (opts.throwErrors) throw e }
     })
+    if (!opts.allowNotImplementedMethods && !methods.GetLndMetrics) throw new Error('method: GetLndMetrics is not implemented')
+    app.post('/api/admin/metrics/lnd', async (req, res) => {
+        const info: Types.RequestInfo = { rpcName: 'GetLndMetrics', batch: false, nostr: false, batchSize: 0}
+        const stats: Types.RequestStats = { start:req.startTime || 0n, parse: process.hrtime.bigint(), guard: 0n, validate: 0n, handle: 0n }
+        let authCtx: Types.AuthContext = {}
+        try {
+            if (!methods.GetLndMetrics) throw new Error('method: GetLndMetrics is not implemented')
+            const authContext = await opts.AdminAuthGuard(req.headers['authorization'])
+            authCtx = authContext
+            stats.guard = process.hrtime.bigint()
+            const request = req.body
+            const error = Types.LndMetricsRequestValidate(request)
+            stats.validate = process.hrtime.bigint()
+            if (error !== null) return logErrorAndReturnResponse(error, 'invalid request body', res, logger, { ...info, ...stats, ...authContext }, opts.metricsCallback)
+            const query = req.query
+            const params = req.params
+            const response =  await methods.GetLndMetrics({rpcName:'GetLndMetrics', ctx:authContext , req: request})
+            stats.handle = process.hrtime.bigint()
+            res.json({status: 'OK', ...response})
+            opts.metricsCallback([{ ...info, ...stats, ...authContext }])
+        } catch (ex) { const e = ex as any; logErrorAndReturnResponse(e, e.message || e, res, logger, { ...info, ...stats, ...authCtx }, opts.metricsCallback); if (opts.throwErrors) throw e }
+    })
     if (!opts.allowNotImplementedMethods && !methods.Health) throw new Error('method: Health is not implemented')
     app.get('/api/health', async (req, res) => {
         const info: Types.RequestInfo = { rpcName: 'Health', batch: false, nostr: false, batchSize: 0}

proto/autogenerated/ts/http_client.ts

@@ -85,6 +85,20 @@ export default (params: ClientParams) => ({
         }
         return { status: 'ERROR', reason: 'invalid response' }
     },
+    GetLndMetrics: async (request: Types.LndMetricsRequest): Promise<ResultError | ({ status: 'OK' }& Types.LndMetrics)> => {
+        const auth = await params.retrieveAdminAuth()
+        if (auth === null) throw new Error('retrieveAdminAuth() returned null')
+        let finalRoute = '/api/admin/metrics/lnd'
+        const { data } = await axios.post(params.baseUrl + finalRoute, request, { headers: { 'authorization': auth } })
+        if (data.status === 'ERROR' && typeof data.reason === 'string') return data
+        if (data.status === 'OK') { 
+            const result = data
+            if(!params.checkResult) return { status: 'OK', ...result }
+            const error = Types.LndMetricsValidate(result)
+            if (error === null) { return { status: 'OK', ...result } } else return { status: 'ERROR', reason: error.message }
+        }
+        return { status: 'ERROR', reason: 'invalid response' }
+    },
     Health: async (): Promise<ResultError | ({ status: 'OK' })> => {
         const auth = await params.retrieveGuestAuth()
         if (auth === null) throw new Error('retrieveGuestAuth() returned null')