Merge branch 'master' into userOperation-and-bolt11memo

proto/autogenerated/client.md

@@ -13,6 +13,11 @@ The nostr server will send back a message response, and inside the body there wi
 ## NOSTR Methods
 ### These are the nostr methods the client implements to communicate with the API via nostr
 
+- UserHealth
+  - auth type: __User__
+  - This methods has an __empty__ __request__ body
+  - This methods has an __empty__ __response__ body
+
 - GetUserInfo
   - auth type: __User__
   - This methods has an __empty__ __request__ body
@@ -313,6 +318,13 @@ The nostr server will send back a message response, and inside the body there wi
   - input: [SetMockAppBalanceRequest](#SetMockAppBalanceRequest)
   - This methods has an __empty__ __response__ body
 
+- UserHealth
+  - auth type: __User__
+  - http method: __post__
+  - http route: __/api/user/health__
+  - This methods has an __empty__ __request__ body
+  - This methods has an __empty__ __response__ body
+
 - GetUserInfo
   - auth type: __User__
   - http method: __post__
@@ -432,16 +444,51 @@ 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
 
+<<<<<<< HEAD
 ### OpenChannelResponse
   - __channelId__: _string_
 
 ### HandleLnurlPayResponse
   - __pr__: _string_
   - __routes__: ARRAY of: _[Empty](#Empty)_
+=======
+### DecodeInvoiceRequest
+  - __invoice__: _string_
+
+### ChannelBalanceEvent
+  - __block_height__: _number_
+  - __channel_id__: _string_
+  - __local_balance_sats__: _number_
+  - __remote_balance_sats__: _number_
+
+### NewInvoiceRequest
+  - __amountSats__: _number_
+  - __memo__: _string_
+
+### GetUserOperationsRequest
+  - __latestIncomingInvoice__: _number_
+  - __latestOutgoingInvoice__: _number_
+  - __latestIncomingTx__: _number_
+  - __latestOutgoingTx__: _number_
+  - __latestIncomingUserToUserPayment__: _number_
+  - __latestOutgoingUserToUserPayment__: _number_
+
+### UserOperation
+  - __paidAtUnix__: _number_
+  - __type__: _[UserOperationType](#UserOperationType)_
+  - __inbound__: _boolean_
+  - __amount__: _number_
+  - __identifier__: _string_
+  - __operationId__: _string_
+  - __service_fee__: _number_
+  - __network_fee__: _number_
+  - __confirmed__: _boolean_
+>>>>>>> master
 
 ### NewAddressRequest
   - __addressType__: _[AddressType](#AddressType)_
 
+<<<<<<< HEAD
 ### UsageMetric
   - __processed_at_ms__: _number_
   - __parsed_in_nano__: _number_
@@ -452,6 +499,188 @@ The nostr server will send back a message response, and inside the body there wi
   - __batch__: _boolean_
   - __nostr__: _boolean_
   - __batch_size__: _number_
+=======
+### OpenChannelRequest
+  - __destination__: _string_
+  - __fundingAmount__: _number_
+  - __pushAmount__: _number_
+  - __closeAddress__: _string_
+
+### OpenChannelResponse
+  - __channelId__: _string_
+
+### GetAppUserLNURLInfoRequest
+  - __user_identifier__: _string_
+  - __base_url_override__: _string_
+
+### LndGetInfoRequest
+  - __nodeId__: _number_
+
+### AuthAppRequest
+  - __name__: _string_
+  - __allow_user_creation__: _boolean_ *this field is optional
+
+### AppUser
+  - __identifier__: _string_
+  - __info__: _[UserInfo](#UserInfo)_
+  - __max_withdrawable__: _number_
+
+### LnurlLinkResponse
+  - __lnurl__: _string_
+  - __k1__: _string_
+
+### UsersInfo
+  - __total__: _number_
+  - __no_balance__: _number_
+  - __negative_balance__: _number_
+  - __always_been_inactive__: _number_
+  - __balance_avg__: _number_
+  - __balance_median__: _number_
+
+### SetMockAppBalanceRequest
+  - __amount__: _number_
+
+### PayInvoiceRequest
+  - __invoice__: _string_
+  - __amount__: _number_
+
+### ChainBalanceEvent
+  - __block_height__: _number_
+  - __confirmed_balance__: _number_
+  - __unconfirmed_balance__: _number_
+  - __total_balance__: _number_
+
+### LnurlPayInfoResponse
+  - __tag__: _string_
+  - __callback__: _string_
+  - __maxSendable__: _number_
+  - __minSendable__: _number_
+  - __metadata__: _string_
+  - __allowsNostr__: _boolean_
+  - __nostrPubkey__: _string_
+
+### SendAppUserToAppUserPaymentRequest
+  - __from_user_identifier__: _string_
+  - __to_user_identifier__: _string_
+  - __amount__: _number_
+
+### OpenChannel
+  - __channel_id__: _string_
+  - __capacity__: _number_
+  - __active__: _boolean_
+  - __lifetime__: _number_
+  - __local_balance__: _number_
+  - __remote_balance__: _number_
+
+### AppMetrics
+  - __app__: _[Application](#Application)_
+  - __users__: _[UsersInfo](#UsersInfo)_
+  - __total_received__: _number_
+  - __total_spent__: _number_
+  - __total_available__: _number_
+  - __unpaid_invoices__: _number_
+  - __operations__: ARRAY of: _[UserOperation](#UserOperation)_
+
+### AppsMetrics
+  - __apps__: ARRAY of: _[AppMetrics](#AppMetrics)_
+
+### LndMetricsRequest
+  - __from_unix__: _number_ *this field is optional
+  - __to_unix__: _number_ *this field is optional
+
+### AuthApp
+  - __app__: _[Application](#Application)_
+  - __auth_token__: _string_
+
+### SetMockAppUserBalanceRequest
+  - __user_identifier__: _string_
+  - __amount__: _number_
+
+### EncryptionExchangeRequest
+  - __publicKey__: _string_
+  - __deviceId__: _string_
+
+### NewAddressResponse
+  - __address__: _string_
+
+### GetProductBuyLinkResponse
+  - __link__: _string_
+
+### SendAppUserToAppPaymentRequest
+  - __from_user_identifier__: _string_
+  - __amount__: _number_
+
+### PayInvoiceResponse
+  - __preimage__: _string_
+  - __amount_paid__: _number_
+  - __operation_id__: _string_
+  - __service_fee__: _number_
+  - __network_fee__: _number_
+
+### UserInfo
+  - __userId__: _string_
+  - __balance__: _number_
+  - __max_withdrawable__: _number_
+  - __user_identifier__: _string_
+
+### AddProductRequest
+  - __name__: _string_
+  - __price_sats__: _number_
+
+### DecodeInvoiceResponse
+  - __amount__: _number_
+
+### AppsMetricsRequest
+  - __from_unix__: _number_ *this field is optional
+  - __to_unix__: _number_ *this field is optional
+  - __include_operations__: _boolean_ *this field is optional
+
+### ClosedChannel
+  - __channel_id__: _string_
+  - __capacity__: _number_
+  - __closed_height__: _number_
+
+### AddAppRequest
+  - __name__: _string_
+  - __allow_user_creation__: _boolean_
+
+### Application
+  - __name__: _string_
+  - __id__: _string_
+  - __balance__: _number_
+  - __npub__: _string_
+
+### AddAppUserInvoiceRequest
+  - __receiver_identifier__: _string_
+  - __payer_identifier__: _string_
+  - __http_callback_url__: _string_
+  - __invoice_req__: _[NewInvoiceRequest](#NewInvoiceRequest)_
+
+### GetAppUserRequest
+  - __user_identifier__: _string_
+
+### UsageMetrics
+  - __metrics__: ARRAY of: _[UsageMetric](#UsageMetric)_
+
+### LndGetInfoResponse
+  - __alias__: _string_
+
+### LnurlWithdrawInfoResponse
+  - __tag__: _string_
+  - __callback__: _string_
+  - __k1__: _string_
+  - __defaultDescription__: _string_
+  - __minWithdrawable__: _number_
+  - __maxWithdrawable__: _number_
+  - __balanceCheck__: _string_
+  - __payLink__: _string_
+
+### MigrationUpdate
+  - __closure__: _[ClosureMigration](#ClosureMigration)_ *this field is optional
+  - __relays__: _[RelaysMigration](#RelaysMigration)_ *this field is optional
+
+### Empty
+>>>>>>> master
 
 ### RoutingEvent
   - __incoming_channel_id__: _number_
@@ -467,9 +696,12 @@ The nostr server will send back a message response, and inside the body there wi
   - __offchain__: _boolean_
   - __forward_fail_event__: _boolean_
 
-### LndGetInfoRequest
-  - __nodeId__: _number_
+### AddAppInvoiceRequest
+  - __payer_identifier__: _string_
+  - __http_callback_url__: _string_
+  - __invoice_req__: _[NewInvoiceRequest](#NewInvoiceRequest)_
 
+<<<<<<< HEAD
 ### GetUserOperationsRequest
   - __latestIncomingInvoice__: _number_
   - __latestOutgoingInvoice__: _number_
@@ -481,13 +713,73 @@ The nostr server will send back a message response, and inside the body there wi
 ### EncryptionExchangeRequest
   - __publicKey__: _string_
   - __deviceId__: _string_
+=======
+### NewInvoiceResponse
+  - __invoice__: _string_
 
-### ChainBalanceEvent
-  - __block_height__: _number_
-  - __confirmed_balance__: _number_
-  - __unconfirmed_balance__: _number_
-  - __total_balance__: _number_
+### Product
+  - __id__: _string_
+  - __name__: _string_
+  - __price_sats__: _number_
 
+### UsageMetric
+  - __processed_at_ms__: _number_
+  - __parsed_in_nano__: _number_
+  - __auth_in_nano__: _number_
+  - __validate_in_nano__: _number_
+  - __handle_in_nano__: _number_
+  - __rpc_name__: _string_
+  - __batch__: _boolean_
+  - __nostr__: _boolean_
+  - __batch_size__: _number_
+
+### AddAppUserRequest
+  - __identifier__: _string_
+  - __fail_if_exists__: _boolean_
+  - __balance__: _number_
+
+### HandleLnurlPayResponse
+  - __pr__: _string_
+  - __routes__: ARRAY of: _[Empty](#Empty)_
+
+### GetUserOperationsResponse
+  - __latestOutgoingInvoiceOperations__: _[UserOperations](#UserOperations)_
+  - __latestIncomingInvoiceOperations__: _[UserOperations](#UserOperations)_
+  - __latestOutgoingTxOperations__: _[UserOperations](#UserOperations)_
+  - __latestIncomingTxOperations__: _[UserOperations](#UserOperations)_
+  - __latestOutgoingUserToUserPayemnts__: _[UserOperations](#UserOperations)_
+  - __latestIncomingUserToUserPayemnts__: _[UserOperations](#UserOperations)_
+
+### LiveUserOperation
+  - __operation__: _[UserOperation](#UserOperation)_
+
+### ClosureMigration
+  - __closes_at_unix__: _number_
+
+### RelaysMigration
+  - __relays__: ARRAY of: _string_
+>>>>>>> master
+
+### LndNodeMetrics
+  - __channels_balance_events__: ARRAY of: _[ChannelBalanceEvent](#ChannelBalanceEvent)_
+  - __chain_balance_events__: ARRAY of: _[ChainBalanceEvent](#ChainBalanceEvent)_
+  - __routing_events__: ARRAY of: _[RoutingEvent](#RoutingEvent)_
+  - __offline_channels__: _number_
+  - __online_channels__: _number_
+  - __pending_channels__: _number_
+  - __closing_channels__: _number_
+  - __open_channels__: ARRAY of: _[OpenChannel](#OpenChannel)_
+  - __closed_channels__: ARRAY of: _[ClosedChannel](#ClosedChannel)_
+
+<<<<<<< HEAD
+=======
+### PayAddressResponse
+  - __txId__: _string_
+  - __operation_id__: _string_
+  - __service_fee__: _number_
+  - __network_fee__: _number_
+
+>>>>>>> master
 ### LndMetrics
   - __nodes__: ARRAY of: _[LndNodeMetrics](#LndNodeMetrics)_
 
@@ -495,6 +787,7 @@ The nostr server will send back a message response, and inside the body there wi
   - __app__: _[Application](#Application)_
   - __auth_token__: _string_
 
+<<<<<<< HEAD
 ### AddAppInvoiceRequest
   - __payer_identifier__: _string_
   - __http_callback_url__: _string_
@@ -545,12 +838,19 @@ The nostr server will send back a message response, and inside the body there wi
 ### SetMockAppUserBalanceRequest
   - __user_identifier__: _string_
   - __amount__: _number_
+=======
+### PayAddressRequest
+  - __address__: _string_
+  - __amoutSats__: _number_
+  - __satsPerVByte__: _number_
+>>>>>>> master
 
 ### UserOperations
   - __fromIndex__: _number_
   - __toIndex__: _number_
   - __operations__: ARRAY of: _[UserOperation](#UserOperation)_
 
+<<<<<<< HEAD
 ### AppMetrics
   - __app__: _[Application](#Application)_
   - __users__: _[UsersInfo](#UsersInfo)_
@@ -732,6 +1032,11 @@ The nostr server will send back a message response, and inside the body there wi
   - __latestIncomingTxOperations__: _[UserOperations](#UserOperations)_
   - __latestOutgoingUserToUserPayemnts__: _[UserOperations](#UserOperations)_
   - __latestIncomingUserToUserPayemnts__: _[UserOperations](#UserOperations)_
+=======
+### SetMockInvoiceAsPaidRequest
+  - __invoice__: _string_
+  - __amount__: _number_
+>>>>>>> master
 ## Enums
 ### The enumerators used in the messages
 

proto/autogenerated/ts/express_server.ts

@@ -559,6 +559,25 @@ 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.UserHealth) throw new Error('method: UserHealth is not implemented')
+    app.post('/api/user/health', async (req, res) => {
+        const info: Types.RequestInfo = { rpcName: 'UserHealth', batch: false, nostr: false, batchSize: 0}
+        const stats: Types.RequestStats = { startMs:req.startTimeMs || 0, start:req.startTime || 0n, parse: process.hrtime.bigint(), guard: 0n, validate: 0n, handle: 0n }
+        let authCtx: Types.AuthContext = {}
+        try {
+            if (!methods.UserHealth) throw new Error('method: UserHealth is not implemented')
+            const authContext = await opts.UserAuthGuard(req.headers['authorization'])
+            authCtx = authContext
+            stats.guard = process.hrtime.bigint()
+            stats.validate = stats.guard
+            const query = req.query
+            const params = req.params
+             await methods.UserHealth({rpcName:'UserHealth', ctx:authContext })
+            stats.handle = process.hrtime.bigint()
+            res.json({status: 'OK'})
+            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.GetUserInfo) throw new Error('method: GetUserInfo is not implemented')
     app.post('/api/user/info', async (req, res) => {
         const info: Types.RequestInfo = { rpcName: 'GetUserInfo', batch: false, nostr: false, batchSize: 0}
@@ -851,6 +870,16 @@ export default (methods: Types.ServerMethods, opts: ServerOptions) => {
                 const opStats: Types.RequestStats = { startMs:req.startTimeMs || 0, start:req.startTime || 0n, parse: stats.parse, guard: stats.guard, validate: 0n, handle: 0n }
                 try {
                     switch(operation.rpcName) {
+                        case 'UserHealth':
+                            if (!methods.UserHealth) {
+                                throw new Error('method UserHealth not found' )
+                            } else {
+                                opStats.validate = opStats.guard
+                                await methods.UserHealth({...operation, ctx}); responses.push({ status: 'OK' })
+                                opStats.handle = process.hrtime.bigint()
+                                callsMetrics.push({ ...opInfo, ...opStats, ...ctx })
+                            }
+                            break
                         case 'GetUserInfo':
                             if (!methods.GetUserInfo) {
                                 throw new Error('method GetUserInfo not found' )

proto/autogenerated/ts/http_client.ts

@@ -351,6 +351,17 @@ export default (params: ClientParams) => ({
         }
         return { status: 'ERROR', reason: 'invalid response' }
     },
+    UserHealth: async (): Promise<ResultError | ({ status: 'OK' })> => {
+        const auth = await params.retrieveUserAuth()
+        if (auth === null) throw new Error('retrieveUserAuth() returned null')
+        let finalRoute = '/api/user/health'
+        const { data } = await axios.post(params.baseUrl + finalRoute, {}, { headers: { 'authorization': auth } })
+        if (data.status === 'ERROR' && typeof data.reason === 'string') return data
+        if (data.status === 'OK') { 
+            return data
+        }
+        return { status: 'ERROR', reason: 'invalid response' }
+    },
     GetUserInfo: async (): Promise<ResultError | ({ status: 'OK' }& Types.UserInfo)> => {
         const auth = await params.retrieveUserAuth()
         if (auth === null) throw new Error('retrieveUserAuth() returned null')

proto/autogenerated/ts/nostr_client.ts

@@ -9,6 +9,17 @@ export type NostrClientParams = {
     checkResult?: true
 }
 export default (params: NostrClientParams,  send: (to:string, message: NostrRequest) => Promise<any>, subscribe: (to:string, message: NostrRequest, cb:(res:any)=> void) => void) => ({
+    UserHealth: async (): Promise<ResultError | ({ status: 'OK' })> => {
+        const auth = await params.retrieveNostrUserAuth()
+        if (auth === null) throw new Error('retrieveNostrUserAuth() returned null')
+        const nostrRequest: NostrRequest = {}
+        const data = await send(params.pubDestination, {rpcName:'UserHealth',authIdentifier:auth, ...nostrRequest }) 
+        if (data.status === 'ERROR' && typeof data.reason === 'string') return data
+        if (data.status === 'OK') { 
+            return data
+        }
+        return { status: 'ERROR', reason: 'invalid response' }
+    },
     GetUserInfo: async (): Promise<ResultError | ({ status: 'OK' }& Types.UserInfo)> => {
         const auth = await params.retrieveNostrUserAuth()
         if (auth === null) throw new Error('retrieveNostrUserAuth() returned null')

proto/autogenerated/ts/nostr_transport.ts

@@ -29,6 +29,19 @@ export default (methods: Types.ServerMethods, opts: NostrOptions) => {
         const stats: Types.RequestStats = { startMs, start: startTime, parse: process.hrtime.bigint(), guard: 0n, validate: 0n, handle: 0n }
         let authCtx: Types.AuthContext = {}
         switch (req.rpcName) {
+            case 'UserHealth':
+                try {
+                    if (!methods.UserHealth) throw new Error('method: UserHealth is not implemented')
+                    const authContext = await opts.NostrUserAuthGuard(req.appId, req.authIdentifier)
+                    stats.guard = process.hrtime.bigint()
+                    authCtx = authContext
+                    stats.validate = stats.guard
+                    await methods.UserHealth({rpcName:'UserHealth', ctx:authContext })
+                    stats.handle = process.hrtime.bigint()
+                    res({status: 'OK'})
+                    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 }
+                break
             case 'GetUserInfo':
                 try {
                     if (!methods.GetUserInfo) throw new Error('method: GetUserInfo is not implemented')
@@ -267,6 +280,16 @@ export default (methods: Types.ServerMethods, opts: NostrOptions) => {
                         const opStats: Types.RequestStats = { startMs, start: startTime, parse: stats.parse, guard: stats.guard, validate: 0n, handle: 0n }
                         try {
                             switch(operation.rpcName) {
+                                case 'UserHealth':
+                                    if (!methods.UserHealth) {
+                                        throw new Error('method not defined: UserHealth')
+                                    } else {
+                                        opStats.validate = opStats.guard
+                                        await methods.UserHealth({...operation, ctx}); responses.push({ status: 'OK' })
+                                        opStats.handle = process.hrtime.bigint()
+                                        callsMetrics.push({ ...opInfo, ...opStats, ...ctx })
+                                    }
+                                    break
                                 case 'GetUserInfo':
                                     if (!methods.GetUserInfo) {
                                         throw new Error('method not defined: GetUserInfo')