Merge branch 'master' into npub-linking-through-expirable-tokens
This commit is contained in:
Mothana
commit
0963f94989
23 changed files with 321 additions and 4551 deletions
|
|
@ -1,825 +0,0 @@
|
|||
# NOSTR API DEFINITION
|
||||
|
||||
|
||||
A nostr request will take the same parameter and give the same response as an http request, but it will use nostr as transport, to do that it will send encrypted events to the server public key, in the event 6 thing are required:
|
||||
- __rpcName__: string containing the name of the method
|
||||
- __params__: a map with the all the url params for the method
|
||||
- __query__: a map with the the url query for the method
|
||||
- __body__: the body of the method request
|
||||
- __requestId__: id of the request to be able to get a response
|
||||
|
||||
The nostr server will send back a message response, and inside the body there will also be a __requestId__ to identify the request this response is answering
|
||||
|
||||
## NOSTR Methods
|
||||
### These are the nostr methods the client implements to communicate with the API via nostr
|
||||
|
||||
- LinkNPubThroughToken
|
||||
- auth type: __User__
|
||||
- input: [LinkNPubThroughTokenRequest](#LinkNPubThroughTokenRequest)
|
||||
- This methods has an __empty__ __response__ body
|
||||
|
||||
- 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
|
||||
- output: [UserInfo](#UserInfo)
|
||||
|
||||
- AddProduct
|
||||
- auth type: __User__
|
||||
- input: [AddProductRequest](#AddProductRequest)
|
||||
- output: [Product](#Product)
|
||||
|
||||
- NewProductInvoice
|
||||
- auth type: __User__
|
||||
- the request url __query__ can take the following string items:
|
||||
- id
|
||||
- This methods has an __empty__ __request__ body
|
||||
- output: [NewInvoiceResponse](#NewInvoiceResponse)
|
||||
|
||||
- GetUserOperations
|
||||
- auth type: __User__
|
||||
- input: [GetUserOperationsRequest](#GetUserOperationsRequest)
|
||||
- output: [GetUserOperationsResponse](#GetUserOperationsResponse)
|
||||
|
||||
- NewAddress
|
||||
- auth type: __User__
|
||||
- input: [NewAddressRequest](#NewAddressRequest)
|
||||
- output: [NewAddressResponse](#NewAddressResponse)
|
||||
|
||||
- PayAddress
|
||||
- auth type: __User__
|
||||
- input: [PayAddressRequest](#PayAddressRequest)
|
||||
- output: [PayAddressResponse](#PayAddressResponse)
|
||||
|
||||
- NewInvoice
|
||||
- auth type: __User__
|
||||
- input: [NewInvoiceRequest](#NewInvoiceRequest)
|
||||
- output: [NewInvoiceResponse](#NewInvoiceResponse)
|
||||
|
||||
- DecodeInvoice
|
||||
- auth type: __User__
|
||||
- input: [DecodeInvoiceRequest](#DecodeInvoiceRequest)
|
||||
- output: [DecodeInvoiceResponse](#DecodeInvoiceResponse)
|
||||
|
||||
- PayInvoice
|
||||
- auth type: __User__
|
||||
- input: [PayInvoiceRequest](#PayInvoiceRequest)
|
||||
- output: [PayInvoiceResponse](#PayInvoiceResponse)
|
||||
|
||||
- OpenChannel
|
||||
- auth type: __User__
|
||||
- input: [OpenChannelRequest](#OpenChannelRequest)
|
||||
- output: [OpenChannelResponse](#OpenChannelResponse)
|
||||
|
||||
- GetLnurlWithdrawLink
|
||||
- auth type: __User__
|
||||
- This methods has an __empty__ __request__ body
|
||||
- output: [LnurlLinkResponse](#LnurlLinkResponse)
|
||||
|
||||
- GetLnurlPayLink
|
||||
- auth type: __User__
|
||||
- This methods has an __empty__ __request__ body
|
||||
- output: [LnurlLinkResponse](#LnurlLinkResponse)
|
||||
|
||||
- GetLNURLChannelLink
|
||||
- auth type: __User__
|
||||
- This methods has an __empty__ __request__ body
|
||||
- output: [LnurlLinkResponse](#LnurlLinkResponse)
|
||||
|
||||
- GetLiveUserOperations
|
||||
- auth type: __User__
|
||||
- This methods has an __empty__ __request__ body
|
||||
- output: [LiveUserOperation](#LiveUserOperation)
|
||||
|
||||
- GetMigrationUpdate
|
||||
- auth type: __User__
|
||||
- This methods has an __empty__ __request__ body
|
||||
- output: [MigrationUpdate](#MigrationUpdate)
|
||||
|
||||
- BatchUser
|
||||
- auth type: __User__
|
||||
- This methods has an __empty__ __request__ body
|
||||
- This methods has an __empty__ __response__ body
|
||||
|
||||
# HTTP API DEFINITION
|
||||
|
||||
## Supported HTTP Auths
|
||||
### These are the supported http auth types, to give different type of access to the API users
|
||||
|
||||
- __Guest__:
|
||||
- expected context content
|
||||
|
||||
- __User__:
|
||||
- expected context content
|
||||
- __user_id__: _string_
|
||||
- __app_id__: _string_
|
||||
- __app_user_id__: _string_
|
||||
|
||||
- __Admin__:
|
||||
- expected context content
|
||||
- __admin_id__: _string_
|
||||
|
||||
- __Metrics__:
|
||||
- expected context content
|
||||
- __operator_id__: _string_
|
||||
|
||||
- __App__:
|
||||
- expected context content
|
||||
- __app_id__: _string_
|
||||
|
||||
## HTTP Methods
|
||||
### These are the http methods the client implements to communicate with the API
|
||||
|
||||
- LndGetInfo
|
||||
- auth type: __Admin__
|
||||
- http method: __post__
|
||||
- http route: __/api/admin/lnd/getinfo__
|
||||
- input: [LndGetInfoRequest](#LndGetInfoRequest)
|
||||
- output: [LndGetInfoResponse](#LndGetInfoResponse)
|
||||
|
||||
- AddApp
|
||||
- auth type: __Admin__
|
||||
- http method: __post__
|
||||
- http route: __/api/admin/app/add__
|
||||
- input: [AddAppRequest](#AddAppRequest)
|
||||
- output: [AuthApp](#AuthApp)
|
||||
|
||||
- AuthApp
|
||||
- auth type: __Admin__
|
||||
- http method: __post__
|
||||
- http route: __/api/admin/app/auth__
|
||||
- input: [AuthAppRequest](#AuthAppRequest)
|
||||
- output: [AuthApp](#AuthApp)
|
||||
|
||||
- GetUsageMetrics
|
||||
- auth type: __Metrics__
|
||||
- http method: __post__
|
||||
- http route: __/api/reports/usage__
|
||||
- This methods has an __empty__ __request__ body
|
||||
- output: [UsageMetrics](#UsageMetrics)
|
||||
|
||||
- GetAppsMetrics
|
||||
- auth type: __Metrics__
|
||||
- http method: __post__
|
||||
- http route: __/api/reports/apps__
|
||||
- input: [AppsMetricsRequest](#AppsMetricsRequest)
|
||||
- output: [AppsMetrics](#AppsMetrics)
|
||||
|
||||
- GetLndMetrics
|
||||
- auth type: __Metrics__
|
||||
- http method: __post__
|
||||
- http route: __/api/reports/lnd__
|
||||
- input: [LndMetricsRequest](#LndMetricsRequest)
|
||||
- output: [LndMetrics](#LndMetrics)
|
||||
|
||||
- Health
|
||||
- auth type: __Guest__
|
||||
- http method: __get__
|
||||
- http route: __/api/health__
|
||||
- This methods has an __empty__ __request__ body
|
||||
- This methods has an __empty__ __response__ body
|
||||
|
||||
- EncryptionExchange
|
||||
- auth type: __Guest__
|
||||
- http method: __post__
|
||||
- http route: __/api/encryption/exchange__
|
||||
- input: [EncryptionExchangeRequest](#EncryptionExchangeRequest)
|
||||
- This methods has an __empty__ __response__ body
|
||||
|
||||
- SetMockInvoiceAsPaid
|
||||
- auth type: __Guest__
|
||||
- http method: __post__
|
||||
- http route: __/api/lnd/mock/invoice/paid__
|
||||
- input: [SetMockInvoiceAsPaidRequest](#SetMockInvoiceAsPaidRequest)
|
||||
- This methods has an __empty__ __response__ body
|
||||
|
||||
- GetLnurlWithdrawInfo
|
||||
- auth type: __Guest__
|
||||
- http method: __get__
|
||||
- http route: __/api/guest/lnurl_withdraw/info__
|
||||
- the request url __query__ can take the following string items:
|
||||
- k1
|
||||
- This methods has an __empty__ __request__ body
|
||||
- output: [LnurlWithdrawInfoResponse](#LnurlWithdrawInfoResponse)
|
||||
|
||||
- HandleLnurlWithdraw
|
||||
- auth type: __Guest__
|
||||
- http method: __get__
|
||||
- http route: __/api/guest/lnurl_withdraw/handle__
|
||||
- the request url __query__ can take the following string items:
|
||||
- k1
|
||||
- pr
|
||||
- This methods has an __empty__ __request__ body
|
||||
- This methods has an __empty__ __response__ body
|
||||
|
||||
- GetLnurlPayInfo
|
||||
- auth type: __Guest__
|
||||
- http method: __get__
|
||||
- http route: __/api/guest/lnurl_pay/info__
|
||||
- the request url __query__ can take the following string items:
|
||||
- k1
|
||||
- This methods has an __empty__ __request__ body
|
||||
- output: [LnurlPayInfoResponse](#LnurlPayInfoResponse)
|
||||
|
||||
- HandleLnurlPay
|
||||
- auth type: __Guest__
|
||||
- http method: __get__
|
||||
- http route: __/api/guest/lnurl_pay/handle__
|
||||
- the request url __query__ can take the following string items:
|
||||
- k1
|
||||
- amount
|
||||
- nostr
|
||||
- lnurl
|
||||
- This methods has an __empty__ __request__ body
|
||||
- output: [HandleLnurlPayResponse](#HandleLnurlPayResponse)
|
||||
|
||||
- HandleLnurlAddress
|
||||
- auth type: __Guest__
|
||||
- http method: __get__
|
||||
- http route: __/.well-known/lnurlp/:address_name__
|
||||
- the request url __params__ are the following string items:
|
||||
- address_name
|
||||
- This methods has an __empty__ __request__ body
|
||||
- output: [LnurlPayInfoResponse](#LnurlPayInfoResponse)
|
||||
|
||||
- LinkNPubThroughToken
|
||||
- auth type: __User__
|
||||
- http method: __post__
|
||||
- http route: __/api/guest/npub/link__
|
||||
- input: [LinkNPubThroughTokenRequest](#LinkNPubThroughTokenRequest)
|
||||
- This methods has an __empty__ __response__ body
|
||||
|
||||
- GetApp
|
||||
- auth type: __App__
|
||||
- http method: __post__
|
||||
- http route: __/api/app/get__
|
||||
- This methods has an __empty__ __request__ body
|
||||
- output: [Application](#Application)
|
||||
|
||||
- AddAppUser
|
||||
- auth type: __App__
|
||||
- http method: __post__
|
||||
- http route: __/api/app/user/add__
|
||||
- input: [AddAppUserRequest](#AddAppUserRequest)
|
||||
- output: [AppUser](#AppUser)
|
||||
|
||||
- AddAppInvoice
|
||||
- auth type: __App__
|
||||
- http method: __post__
|
||||
- http route: __/api/app/add/invoice__
|
||||
- input: [AddAppInvoiceRequest](#AddAppInvoiceRequest)
|
||||
- output: [NewInvoiceResponse](#NewInvoiceResponse)
|
||||
|
||||
- AddAppUserInvoice
|
||||
- auth type: __App__
|
||||
- http method: __post__
|
||||
- http route: __/api/app/user/add/invoice__
|
||||
- input: [AddAppUserInvoiceRequest](#AddAppUserInvoiceRequest)
|
||||
- output: [NewInvoiceResponse](#NewInvoiceResponse)
|
||||
|
||||
- GetAppUser
|
||||
- auth type: __App__
|
||||
- http method: __post__
|
||||
- http route: __/api/app/user/get__
|
||||
- input: [GetAppUserRequest](#GetAppUserRequest)
|
||||
- output: [AppUser](#AppUser)
|
||||
|
||||
- PayAppUserInvoice
|
||||
- auth type: __App__
|
||||
- http method: __post__
|
||||
- http route: __/api/app/invoice/pay__
|
||||
- input: [PayAppUserInvoiceRequest](#PayAppUserInvoiceRequest)
|
||||
- output: [PayInvoiceResponse](#PayInvoiceResponse)
|
||||
|
||||
- SendAppUserToAppUserPayment
|
||||
- auth type: __App__
|
||||
- http method: __post__
|
||||
- http route: __/api/app/user/internal/pay__
|
||||
- input: [SendAppUserToAppUserPaymentRequest](#SendAppUserToAppUserPaymentRequest)
|
||||
- This methods has an __empty__ __response__ body
|
||||
|
||||
- SendAppUserToAppPayment
|
||||
- auth type: __App__
|
||||
- http method: __post__
|
||||
- http route: __/api/app/internal/pay__
|
||||
- input: [SendAppUserToAppPaymentRequest](#SendAppUserToAppPaymentRequest)
|
||||
- This methods has an __empty__ __response__ body
|
||||
|
||||
- GetAppUserLNURLInfo
|
||||
- auth type: __App__
|
||||
- http method: __post__
|
||||
- http route: __/api/app/user/lnurl/pay/info__
|
||||
- input: [GetAppUserLNURLInfoRequest](#GetAppUserLNURLInfoRequest)
|
||||
- output: [LnurlPayInfoResponse](#LnurlPayInfoResponse)
|
||||
|
||||
- SetMockAppUserBalance
|
||||
- auth type: __App__
|
||||
- http method: __post__
|
||||
- http route: __/api/app/mock/user/blance/set__
|
||||
- input: [SetMockAppUserBalanceRequest](#SetMockAppUserBalanceRequest)
|
||||
- This methods has an __empty__ __response__ body
|
||||
|
||||
- SetMockAppBalance
|
||||
- auth type: __App__
|
||||
- http method: __post__
|
||||
- http route: __/api/app/mock/blance/set__
|
||||
- input: [SetMockAppBalanceRequest](#SetMockAppBalanceRequest)
|
||||
- This methods has an __empty__ __response__ body
|
||||
|
||||
- RequestNPubLinkingToken
|
||||
- auth type: __App__
|
||||
- http method: __post__
|
||||
- http route: __/api/app/user/npub/token__
|
||||
- input: [RequestNPubLinkingTokenRequest](#RequestNPubLinkingTokenRequest)
|
||||
- output: [RequestNPubLinkingTokenResponse](#RequestNPubLinkingTokenResponse)
|
||||
|
||||
- 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__
|
||||
- http route: __/api/user/info__
|
||||
- This methods has an __empty__ __request__ body
|
||||
- output: [UserInfo](#UserInfo)
|
||||
|
||||
- AddProduct
|
||||
- auth type: __User__
|
||||
- http method: __post__
|
||||
- http route: __/api/user/product/add__
|
||||
- input: [AddProductRequest](#AddProductRequest)
|
||||
- output: [Product](#Product)
|
||||
|
||||
- NewProductInvoice
|
||||
- auth type: __User__
|
||||
- http method: __get__
|
||||
- http route: __/api/user/product/get/invoice__
|
||||
- the request url __query__ can take the following string items:
|
||||
- id
|
||||
- This methods has an __empty__ __request__ body
|
||||
- output: [NewInvoiceResponse](#NewInvoiceResponse)
|
||||
|
||||
- GetUserOperations
|
||||
- auth type: __User__
|
||||
- http method: __post__
|
||||
- http route: __/api/user/operations__
|
||||
- input: [GetUserOperationsRequest](#GetUserOperationsRequest)
|
||||
- output: [GetUserOperationsResponse](#GetUserOperationsResponse)
|
||||
|
||||
- NewAddress
|
||||
- auth type: __User__
|
||||
- http method: __post__
|
||||
- http route: __/api/user/chain/new__
|
||||
- input: [NewAddressRequest](#NewAddressRequest)
|
||||
- output: [NewAddressResponse](#NewAddressResponse)
|
||||
|
||||
- PayAddress
|
||||
- auth type: __User__
|
||||
- http method: __post__
|
||||
- http route: __/api/user/chain/pay__
|
||||
- input: [PayAddressRequest](#PayAddressRequest)
|
||||
- output: [PayAddressResponse](#PayAddressResponse)
|
||||
|
||||
- NewInvoice
|
||||
- auth type: __User__
|
||||
- http method: __post__
|
||||
- http route: __/api/user/invoice/new__
|
||||
- input: [NewInvoiceRequest](#NewInvoiceRequest)
|
||||
- output: [NewInvoiceResponse](#NewInvoiceResponse)
|
||||
|
||||
- DecodeInvoice
|
||||
- auth type: __User__
|
||||
- http method: __post__
|
||||
- http route: __/api/user/invoice/decode__
|
||||
- input: [DecodeInvoiceRequest](#DecodeInvoiceRequest)
|
||||
- output: [DecodeInvoiceResponse](#DecodeInvoiceResponse)
|
||||
|
||||
- PayInvoice
|
||||
- auth type: __User__
|
||||
- http method: __post__
|
||||
- http route: __/api/user/invoice/pay__
|
||||
- input: [PayInvoiceRequest](#PayInvoiceRequest)
|
||||
- output: [PayInvoiceResponse](#PayInvoiceResponse)
|
||||
|
||||
- OpenChannel
|
||||
- auth type: __User__
|
||||
- http method: __post__
|
||||
- http route: __/api/user/open/channel__
|
||||
- input: [OpenChannelRequest](#OpenChannelRequest)
|
||||
- output: [OpenChannelResponse](#OpenChannelResponse)
|
||||
|
||||
- GetLnurlWithdrawLink
|
||||
- auth type: __User__
|
||||
- http method: __get__
|
||||
- http route: __/api/user/lnurl_withdraw/link__
|
||||
- This methods has an __empty__ __request__ body
|
||||
- output: [LnurlLinkResponse](#LnurlLinkResponse)
|
||||
|
||||
- GetLnurlPayLink
|
||||
- auth type: __User__
|
||||
- http method: __get__
|
||||
- http route: __/api/user/lnurl_pay/link__
|
||||
- This methods has an __empty__ __request__ body
|
||||
- output: [LnurlLinkResponse](#LnurlLinkResponse)
|
||||
|
||||
- GetLNURLChannelLink
|
||||
- auth type: __User__
|
||||
- http method: __post__
|
||||
- http route: __/api/user/lnurl_channel/url__
|
||||
- This methods has an __empty__ __request__ body
|
||||
- output: [LnurlLinkResponse](#LnurlLinkResponse)
|
||||
|
||||
- GetLiveUserOperations
|
||||
- auth type: __User__
|
||||
- http method: __post__
|
||||
- http route: __/api/user/operations/sub__
|
||||
- This methods has an __empty__ __request__ body
|
||||
- output: [LiveUserOperation](#LiveUserOperation)
|
||||
|
||||
- GetMigrationUpdate
|
||||
- auth type: __User__
|
||||
- http method: __post__
|
||||
- http route: __/api/user/migrations/sub__
|
||||
- This methods has an __empty__ __request__ body
|
||||
- output: [MigrationUpdate](#MigrationUpdate)
|
||||
|
||||
- BatchUser
|
||||
- auth type: __User__
|
||||
- http method: __post__
|
||||
- http route: __/api/user/batch__
|
||||
- This methods has an __empty__ __request__ body
|
||||
- This methods has an __empty__ __response__ body
|
||||
|
||||
# INPUTS AND OUTPUTS
|
||||
|
||||
## Messages
|
||||
### The content of requests and response from the methods
|
||||
|
||||
### Application
|
||||
- __name__: _string_
|
||||
- __id__: _string_
|
||||
- __balance__: _number_
|
||||
- __npub__: _string_
|
||||
|
||||
### ClosureMigration
|
||||
- __closes_at_unix__: _number_
|
||||
|
||||
### LinkNPubThroughTokenRequest
|
||||
- __token__: _string_
|
||||
- __nostr_pub__: _string_
|
||||
|
||||
### EncryptionExchangeRequest
|
||||
- __publicKey__: _string_
|
||||
- __deviceId__: _string_
|
||||
|
||||
### UsersInfo
|
||||
- __total__: _number_
|
||||
- __no_balance__: _number_
|
||||
- __negative_balance__: _number_
|
||||
- __always_been_inactive__: _number_
|
||||
- __balance_avg__: _number_
|
||||
- __balance_median__: _number_
|
||||
|
||||
### HandleLnurlPayResponse
|
||||
- __pr__: _string_
|
||||
- __routes__: ARRAY of: _[Empty](#Empty)_
|
||||
|
||||
### MigrationUpdate
|
||||
- __closure__: _[ClosureMigration](#ClosureMigration)_ *this field is optional
|
||||
- __relays__: _[RelaysMigration](#RelaysMigration)_ *this field is optional
|
||||
|
||||
### AppMetrics
|
||||
- __app__: _[Application](#Application)_
|
||||
- __users__: _[UsersInfo](#UsersInfo)_
|
||||
- __received__: _number_
|
||||
- __spent__: _number_
|
||||
- __available__: _number_
|
||||
- __fees__: _number_
|
||||
- __invoices__: _number_
|
||||
- __total_fees__: _number_
|
||||
- __operations__: ARRAY of: _[UserOperation](#UserOperation)_
|
||||
|
||||
### NewInvoiceResponse
|
||||
- __invoice__: _string_
|
||||
|
||||
### LndMetrics
|
||||
- __nodes__: ARRAY of: _[LndNodeMetrics](#LndNodeMetrics)_
|
||||
|
||||
### AddProductRequest
|
||||
- __name__: _string_
|
||||
- __price_sats__: _number_
|
||||
|
||||
### PayAddressRequest
|
||||
- __address__: _string_
|
||||
- __amoutSats__: _number_
|
||||
- __satsPerVByte__: _number_
|
||||
|
||||
### UserOperation
|
||||
- __paidAtUnix__: _number_
|
||||
- __type__: _[UserOperationType](#UserOperationType)_
|
||||
- __inbound__: _boolean_
|
||||
- __amount__: _number_
|
||||
- __identifier__: _string_
|
||||
- __operationId__: _string_
|
||||
- __service_fee__: _number_
|
||||
- __network_fee__: _number_
|
||||
- __confirmed__: _boolean_
|
||||
- __tx_hash__: _string_
|
||||
- __internal__: _boolean_
|
||||
|
||||
### GetUserOperationsResponse
|
||||
- __latestOutgoingInvoiceOperations__: _[UserOperations](#UserOperations)_
|
||||
- __latestIncomingInvoiceOperations__: _[UserOperations](#UserOperations)_
|
||||
- __latestOutgoingTxOperations__: _[UserOperations](#UserOperations)_
|
||||
- __latestIncomingTxOperations__: _[UserOperations](#UserOperations)_
|
||||
- __latestOutgoingUserToUserPayemnts__: _[UserOperations](#UserOperations)_
|
||||
- __latestIncomingUserToUserPayemnts__: _[UserOperations](#UserOperations)_
|
||||
|
||||
### AuthAppRequest
|
||||
- __name__: _string_
|
||||
- __allow_user_creation__: _boolean_ *this field is optional
|
||||
|
||||
### AddAppUserRequest
|
||||
- __identifier__: _string_
|
||||
- __fail_if_exists__: _boolean_
|
||||
- __balance__: _number_
|
||||
|
||||
### SetMockAppBalanceRequest
|
||||
- __amount__: _number_
|
||||
|
||||
### DecodeInvoiceResponse
|
||||
- __amount__: _number_
|
||||
|
||||
### UserOperations
|
||||
- __fromIndex__: _number_
|
||||
- __toIndex__: _number_
|
||||
- __operations__: ARRAY of: _[UserOperation](#UserOperation)_
|
||||
|
||||
### RelaysMigration
|
||||
- __relays__: ARRAY of: _string_
|
||||
|
||||
### LndNodeMetrics
|
||||
- __channels_balance_events__: ARRAY of: _[ChannelBalanceEvent](#ChannelBalanceEvent)_
|
||||
- __chain_balance_events__: ARRAY of: _[ChainBalanceEvent](#ChainBalanceEvent)_
|
||||
- __offline_channels__: _number_
|
||||
- __online_channels__: _number_
|
||||
- __pending_channels__: _number_
|
||||
- __closing_channels__: _number_
|
||||
- __open_channels__: ARRAY of: _[OpenChannel](#OpenChannel)_
|
||||
- __closed_channels__: ARRAY of: _[ClosedChannel](#ClosedChannel)_
|
||||
- __channel_routing__: ARRAY of: _[ChannelRouting](#ChannelRouting)_
|
||||
|
||||
### AddAppUserInvoiceRequest
|
||||
- __receiver_identifier__: _string_
|
||||
- __payer_identifier__: _string_
|
||||
- __http_callback_url__: _string_
|
||||
- __invoice_req__: _[NewInvoiceRequest](#NewInvoiceRequest)_
|
||||
|
||||
### ClosedChannel
|
||||
- __channel_id__: _string_
|
||||
- __capacity__: _number_
|
||||
- __closed_height__: _number_
|
||||
|
||||
### AddAppRequest
|
||||
- __name__: _string_
|
||||
- __allow_user_creation__: _boolean_
|
||||
|
||||
### LnurlLinkResponse
|
||||
- __lnurl__: _string_
|
||||
- __k1__: _string_
|
||||
|
||||
### UsageMetrics
|
||||
- __metrics__: ARRAY of: _[UsageMetric](#UsageMetric)_
|
||||
|
||||
### ChainBalanceEvent
|
||||
- __block_height__: _number_
|
||||
- __confirmed_balance__: _number_
|
||||
- __unconfirmed_balance__: _number_
|
||||
- __total_balance__: _number_
|
||||
|
||||
### Product
|
||||
- __id__: _string_
|
||||
- __name__: _string_
|
||||
- __price_sats__: _number_
|
||||
|
||||
### ChannelBalanceEvent
|
||||
- __block_height__: _number_
|
||||
- __channel_id__: _string_
|
||||
- __local_balance_sats__: _number_
|
||||
- __remote_balance_sats__: _number_
|
||||
|
||||
### AuthApp
|
||||
- __app__: _[Application](#Application)_
|
||||
- __auth_token__: _string_
|
||||
|
||||
### AppsMetrics
|
||||
- __apps__: ARRAY of: _[AppMetrics](#AppMetrics)_
|
||||
|
||||
### 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_
|
||||
|
||||
### AddAppInvoiceRequest
|
||||
- __payer_identifier__: _string_
|
||||
- __http_callback_url__: _string_
|
||||
- __invoice_req__: _[NewInvoiceRequest](#NewInvoiceRequest)_
|
||||
|
||||
### LnurlWithdrawInfoResponse
|
||||
- __tag__: _string_
|
||||
- __callback__: _string_
|
||||
- __k1__: _string_
|
||||
- __defaultDescription__: _string_
|
||||
- __minWithdrawable__: _number_
|
||||
- __maxWithdrawable__: _number_
|
||||
- __balanceCheck__: _string_
|
||||
- __payLink__: _string_
|
||||
|
||||
### LndGetInfoRequest
|
||||
- __nodeId__: _number_
|
||||
|
||||
### AppUser
|
||||
- __identifier__: _string_
|
||||
- __info__: _[UserInfo](#UserInfo)_
|
||||
- __max_withdrawable__: _number_
|
||||
|
||||
### PayAppUserInvoiceRequest
|
||||
- __user_identifier__: _string_
|
||||
- __invoice__: _string_
|
||||
- __amount__: _number_
|
||||
|
||||
### OpenChannelRequest
|
||||
- __destination__: _string_
|
||||
- __fundingAmount__: _number_
|
||||
- __pushAmount__: _number_
|
||||
- __closeAddress__: _string_
|
||||
|
||||
### LnurlPayInfoResponse
|
||||
- __tag__: _string_
|
||||
- __callback__: _string_
|
||||
- __maxSendable__: _number_
|
||||
- __minSendable__: _number_
|
||||
- __metadata__: _string_
|
||||
- __allowsNostr__: _boolean_
|
||||
- __nostrPubkey__: _string_
|
||||
|
||||
### GetProductBuyLinkResponse
|
||||
- __link__: _string_
|
||||
|
||||
### Empty
|
||||
|
||||
### ChannelRouting
|
||||
- __channel_id__: _string_
|
||||
- __send_errors__: _number_
|
||||
- __receive_errors__: _number_
|
||||
- __forward_errors_as_input__: _number_
|
||||
- __forward_errors_as_output__: _number_
|
||||
- __missed_forward_fee_as_input__: _number_
|
||||
- __missed_forward_fee_as_output__: _number_
|
||||
- __forward_fee_as_input__: _number_
|
||||
- __forward_fee_as_output__: _number_
|
||||
- __events_number__: _number_
|
||||
|
||||
### OpenChannel
|
||||
- __channel_id__: _string_
|
||||
- __capacity__: _number_
|
||||
- __active__: _boolean_
|
||||
- __lifetime__: _number_
|
||||
- __local_balance__: _number_
|
||||
- __remote_balance__: _number_
|
||||
|
||||
### RequestNPubLinkingTokenResponse
|
||||
- __token__: _string_
|
||||
|
||||
### SendAppUserToAppPaymentRequest
|
||||
- __from_user_identifier__: _string_
|
||||
- __amount__: _number_
|
||||
|
||||
### NewInvoiceRequest
|
||||
- __amountSats__: _number_
|
||||
- __memo__: _string_
|
||||
|
||||
### DecodeInvoiceRequest
|
||||
- __invoice__: _string_
|
||||
|
||||
### GetUserOperationsRequest
|
||||
- __latestIncomingInvoice__: _number_
|
||||
- __latestOutgoingInvoice__: _number_
|
||||
- __latestIncomingTx__: _number_
|
||||
- __latestOutgoingTx__: _number_
|
||||
- __latestIncomingUserToUserPayment__: _number_
|
||||
- __latestOutgoingUserToUserPayment__: _number_
|
||||
- __max_size__: _number_
|
||||
|
||||
### LiveUserOperation
|
||||
- __operation__: _[UserOperation](#UserOperation)_
|
||||
|
||||
### 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_
|
||||
|
||||
### LndMetricsRequest
|
||||
- __from_unix__: _number_ *this field is optional
|
||||
- __to_unix__: _number_ *this field is optional
|
||||
|
||||
### GetAppUserRequest
|
||||
- __user_identifier__: _string_
|
||||
|
||||
### SendAppUserToAppUserPaymentRequest
|
||||
- __from_user_identifier__: _string_
|
||||
- __to_user_identifier__: _string_
|
||||
- __amount__: _number_
|
||||
|
||||
### PayAddressResponse
|
||||
- __txId__: _string_
|
||||
- __operation_id__: _string_
|
||||
- __service_fee__: _number_
|
||||
- __network_fee__: _number_
|
||||
|
||||
### OpenChannelResponse
|
||||
- __channelId__: _string_
|
||||
|
||||
### RequestNPubLinkingTokenRequest
|
||||
- __user_identifier__: _string_
|
||||
|
||||
### SetMockInvoiceAsPaidRequest
|
||||
- __invoice__: _string_
|
||||
- __amount__: _number_
|
||||
|
||||
### LndGetInfoResponse
|
||||
- __alias__: _string_
|
||||
|
||||
### UserInfo
|
||||
- __userId__: _string_
|
||||
- __balance__: _number_
|
||||
- __max_withdrawable__: _number_
|
||||
- __user_identifier__: _string_
|
||||
|
||||
### AppsMetricsRequest
|
||||
- __from_unix__: _number_ *this field is optional
|
||||
- __to_unix__: _number_ *this field is optional
|
||||
- __include_operations__: _boolean_ *this field is optional
|
||||
|
||||
### GetAppUserLNURLInfoRequest
|
||||
- __user_identifier__: _string_
|
||||
- __base_url_override__: _string_
|
||||
|
||||
### PayInvoiceRequest
|
||||
- __invoice__: _string_
|
||||
- __amount__: _number_
|
||||
|
||||
### PayInvoiceResponse
|
||||
- __preimage__: _string_
|
||||
- __amount_paid__: _number_
|
||||
- __operation_id__: _string_
|
||||
- __service_fee__: _number_
|
||||
- __network_fee__: _number_
|
||||
|
||||
### SetMockAppUserBalanceRequest
|
||||
- __user_identifier__: _string_
|
||||
- __amount__: _number_
|
||||
|
||||
### NewAddressResponse
|
||||
- __address__: _string_
|
||||
|
||||
### NewAddressRequest
|
||||
- __addressType__: _[AddressType](#AddressType)_
|
||||
## Enums
|
||||
### The enumerators used in the messages
|
||||
|
||||
### AddressType
|
||||
- __WITNESS_PUBKEY_HASH__
|
||||
- __NESTED_PUBKEY_HASH__
|
||||
- __TAPROOT_PUBKEY__
|
||||
|
||||
### UserOperationType
|
||||
- __INCOMING_TX__
|
||||
- __OUTGOING_TX__
|
||||
- __INCOMING_INVOICE__
|
||||
- __OUTGOING_INVOICE__
|
||||
- __OUTGOING_USER_TO_USER__
|
||||
- __INCOMING_USER_TO_USER__
|
||||
File diff suppressed because it is too large
Load diff
|
|
@ -99,6 +99,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.BanUser) throw new Error('method: BanUser is not implemented')
|
||||
app.post('/api/admin/user/ban', async (req, res) => {
|
||||
const info: Types.RequestInfo = { rpcName: 'BanUser', 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.BanUser) throw new Error('method: BanUser 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.BanUserRequestValidate(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.BanUser({rpcName:'BanUser', 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.GetUsageMetrics) throw new Error('method: GetUsageMetrics is not implemented')
|
||||
app.post('/api/reports/usage', async (req, res) => {
|
||||
const info: Types.RequestInfo = { rpcName: 'GetUsageMetrics', batch: false, nostr: false, batchSize: 0}
|
||||
|
|
|
|||
|
|
@ -58,6 +58,20 @@ export default (params: ClientParams) => ({
|
|||
}
|
||||
return { status: 'ERROR', reason: 'invalid response' }
|
||||
},
|
||||
BanUser: async (request: Types.BanUserRequest): Promise<ResultError | ({ status: 'OK' }& Types.BanUserResponse)> => {
|
||||
const auth = await params.retrieveAdminAuth()
|
||||
if (auth === null) throw new Error('retrieveAdminAuth() returned null')
|
||||
let finalRoute = '/api/admin/user/ban'
|
||||
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.BanUserResponseValidate(result)
|
||||
if (error === null) { return { status: 'OK', ...result } } else return { status: 'ERROR', reason: error.message }
|
||||
}
|
||||
return { status: 'ERROR', reason: 'invalid response' }
|
||||
},
|
||||
GetUsageMetrics: async (): Promise<ResultError | ({ status: 'OK' }& Types.UsageMetrics)> => {
|
||||
const auth = await params.retrieveMetricsAuth()
|
||||
if (auth === null) throw new Error('retrieveMetricsAuth() returned null')
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue