aiolabs/lightning-pub
2
0
Fork 0
Code Issues 9 Pull requests 4 Projects Releases Packages Wiki Activity Actions
lightning-pub/proto/autogenerated/client.md
boufni95 680cca6852 refund swap info
2026-04-02 14:46:15 -04:00

56 KiB
Raw Permalink Blame History

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

HTTP API DEFINITION

Supported HTTP Auths

These are the supported http auth types, to give different type of access to the API users

  • Admin:

    • expected context content
      • admin_id: string

  • App:

    • expected context content
      • app_id: string

  • Guest:

    • expected context content

  • GuestWithPub:

    • expected context content
      • app_id: string
      • pub: string

  • Metrics:

    • expected context content
      • app_id: string
      • operator_id: string

  • User:

    • expected context content
      • app_id: string
      • app_user_id: string
      • user_id: string

HTTP Methods

These are the http methods the client implements to communicate with the API

  • AddApp

    • auth type: Admin
    • http method: post
    • http route: /api/admin/app/add
    • input: AddAppRequest
    • output: AuthApp

  • AddAppInvoice

  • AddAppUser

  • AddAppUserInvoice

  • AddPeer

    • auth type: Admin
    • http method: post
    • http route: /api/admin/peer
    • input: AddPeerRequest
    • This methods has an empty response body

  • AddProduct

  • AddUserOffer

    • auth type: User
    • http method: post
    • http route: /api/user/offer/add
    • input: OfferConfig
    • output: OfferId

  • AuthApp

    • auth type: Admin
    • http method: post
    • http route: /api/admin/app/auth
    • input: AuthAppRequest
    • output: AuthApp

  • AuthorizeManage

  • BanDebit

    • auth type: User
    • http method: post
    • http route: /api/user/debit/ban
    • input: DebitOperation
    • This methods has an empty response body

  • BanUser

  • 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

  • BumpTx

    • auth type: Admin
    • http method: post
    • http route: /api/admin/tx/bump
    • input: BumpTx
    • This methods has an empty response body

  • CloseChannel

  • CreateOneTimeInviteLink

  • DecodeInvoice

  • DeleteUserOffer

    • auth type: User
    • http method: post
    • http route: /api/user/offer/delete
    • input: OfferId
    • This methods has an empty response body

  • EditDebit

    • auth type: User
    • http method: post
    • http route: /api/user/debit/edit
    • input: DebitAuthorizationRequest
    • This methods has an empty response body

  • EncryptionExchange

    • auth type: Guest
    • http method: post
    • http route: /api/encryption/exchange
    • input: EncryptionExchangeRequest
    • This methods has an empty response body

  • EnrollAdminToken

    • auth type: User
    • http method: post
    • http route: /api/guest/npub/enroll/admin
    • input: EnrollAdminTokenRequest
    • This methods has an empty response body

  • EnrollMessagingToken

    • auth type: User
    • http method: post
    • http route: /api/user/messaging/enroll
    • input: MessagingToken
    • This methods has an empty response body

  • GetAdminInvoiceSwapQuotes

  • GetAdminTransactionSwapQuotes

  • GetApp

    • auth type: App
    • http method: post
    • http route: /api/app/get
    • This methods has an empty request body
    • output: Application

  • GetAppUser

  • GetAppUserLNURLInfo

  • GetAppsMetrics

  • GetAssetsAndLiabilities

  • GetBundleMetrics

  • GetDebitAuthorizations

    • auth type: User
    • http method: get
    • http route: /api/user/debit/get
    • This methods has an empty request body
    • output: DebitAuthorizations

  • GetErrorStats

    • auth type: Metrics
    • http method: post
    • http route: /api/reports/errors
    • This methods has an empty request body
    • output: ErrorStats

  • GetHttpCreds

    • auth type: User
    • http method: post
    • http route: /api/user/http_creds
    • This methods has an empty request body
    • output: HttpCreds

  • GetInviteLinkState

  • GetLNURLChannelLink

    • auth type: User
    • http method: post
    • http route: /api/user/lnurl_channel/url
    • This methods has an empty request body
    • output: LnurlLinkResponse

  • GetLiveDebitRequests

    • auth type: User
    • http method: post
    • http route: /api/user/debit/sub
    • This methods has an empty request body
    • output: LiveDebitRequest

  • GetLiveManageRequests

    • auth type: User
    • http method: post
    • http route: /api/user/manage/sub
    • This methods has an empty request body
    • output: LiveManageRequest

  • GetLiveUserOperations

    • auth type: User
    • http method: post
    • http route: /api/user/operations/sub
    • This methods has an empty request body
    • output: LiveUserOperation

  • GetLndForwardingMetrics

  • GetLndMetrics

  • 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

  • GetLnurlPayLink

    • auth type: User
    • http method: get
    • http route: /api/user/lnurl_pay/link
    • This methods has an empty request body
    • output: LnurlLinkResponse

  • 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

  • GetLnurlWithdrawLink

    • auth type: User
    • http method: get
    • http route: /api/user/lnurl_withdraw/link
    • This methods has an empty request body
    • output: LnurlLinkResponse

  • GetManageAuthorizations

    • auth type: User
    • http method: get
    • http route: /api/user/manage/get
    • This methods has an empty request body
    • output: ManageAuthorizations

  • GetMigrationUpdate

    • auth type: User
    • http method: post
    • http route: /api/user/migrations/sub
    • This methods has an empty request body
    • output: MigrationUpdate

  • GetNPubLinkingState

  • GetPaymentState

  • GetProvidersDisruption

    • auth type: Metrics
    • http method: post
    • http route: /api/metrics/providers/disruption
    • This methods has an empty request body
    • output: ProvidersDisruption

  • GetSeed

    • auth type: Admin
    • http method: get
    • http route: /api/admin/seed
    • This methods has an empty request body
    • output: LndSeed

  • GetSingleBundleMetrics

  • GetSingleUsageMetrics

  • GetTransactionSwapQuotes

  • GetUsageMetrics

  • GetUserInfo

    • auth type: User
    • http method: post
    • http route: /api/user/info
    • This methods has an empty request body
    • output: UserInfo

  • GetUserOffer

    • auth type: User
    • http method: post
    • http route: /api/user/offer/get
    • input: OfferId
    • output: OfferConfig

  • GetUserOfferInvoices

  • GetUserOffers

    • auth type: User
    • http method: get
    • http route: /api/user/offers/get
    • This methods has an empty request body
    • output: UserOffers

  • GetUserOperations

  • 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

  • HandleLnurlPay

    • auth type: Guest
    • http method: get
    • http route: /api/guest/lnurl_pay/handle
    • the request url query can take the following string items:
      • amount
      • k1
      • lnurl
      • nostr
    • This methods has an empty request body
    • output: HandleLnurlPayResponse

  • 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

  • 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

  • LinkNPubThroughToken

    • auth type: GuestWithPub
    • http method: post
    • http route: /api/guest/npub/link
    • input: LinkNPubThroughTokenRequest
    • This methods has an empty response body

  • ListAdminInvoiceSwaps

    • auth type: Admin
    • http method: post
    • http route: /api/admin/swap/invoice/list
    • This methods has an empty request body
    • output: InvoiceSwapsList

  • ListAdminTxSwaps

    • auth type: Admin
    • http method: post
    • http route: /api/admin/swap/transaction/list
    • This methods has an empty request body
    • output: TxSwapsList

  • ListChannels

    • auth type: Admin
    • http method: get
    • http route: /api/admin/channels
    • This methods has an empty request body
    • output: LndChannels

  • ListTxSwaps

    • auth type: User
    • http method: post
    • http route: /api/user/swap/transaction/list
    • This methods has an empty request body
    • output: TxSwapsList

  • LndGetInfo

  • NewAddress

  • NewInvoice

  • 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

  • OpenChannel

  • PayAddress

  • PayAdminInvoiceSwap

  • PayAdminTransactionSwap

  • PayAppUserInvoice

  • PayInvoice

  • PingSubProcesses

    • auth type: Metrics
    • http method: post
    • http route: /api/metrics/ping
    • This methods has an empty request body
    • This methods has an empty response body

  • RefundAdminInvoiceSwap

  • RequestNPubLinkingToken

  • ResetDebit

    • auth type: User
    • http method: post
    • http route: /api/user/debit/reset
    • input: DebitOperation
    • This methods has an empty response body

  • ResetManage

    • auth type: User
    • http method: post
    • http route: /api/user/manage/reset
    • input: ManageOperation
    • This methods has an empty response body

  • ResetMetricsStorages

    • auth type: Metrics
    • http method: post
    • http route: /api/metrics/reset
    • This methods has an empty request body
    • This methods has an empty response body

  • ResetNPubLinkingToken

  • RespondToDebit

    • auth type: User
    • http method: post
    • http route: /api/user/debit/finish
    • input: DebitResponse
    • This methods has an empty response body

  • SendAppUserToAppPayment

  • SendAppUserToAppUserPayment

  • SetMockAppBalance

    • auth type: App
    • http method: post
    • http route: /api/app/mock/blance/set
    • input: SetMockAppBalanceRequest
    • This methods has an empty response body

  • SetMockAppUserBalance

    • auth type: App
    • http method: post
    • http route: /api/app/mock/user/blance/set
    • input: SetMockAppUserBalanceRequest
    • This methods has an empty response body

  • SetMockInvoiceAsPaid

    • auth type: Guest
    • http method: post
    • http route: /api/lnd/mock/invoice/paid
    • input: SetMockInvoiceAsPaidRequest
    • This methods has an empty response body

  • SubToWebRtcCandidates

    • auth type: Metrics
    • http method: post
    • http route: /api/upgrade/wrtc/candidates
    • This methods has an empty request body
    • output: WebRtcCandidate

  • SubmitWebRtcMessage

  • UpdateCallbackUrl

  • UpdateChannelPolicy

    • auth type: Admin
    • http method: post
    • http route: /api/admin/channel/policy/update
    • input: UpdateChannelPolicyRequest
    • This methods has an empty response body

  • UpdateUserOffer

    • auth type: User
    • http method: post
    • http route: /api/user/offer/update
    • input: OfferConfig
    • This methods has an empty response body

  • UseInviteLink

    • auth type: GuestWithPub
    • http method: post
    • http route: /api/guest/invite
    • input: UseInviteLinkRequest
    • 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
    • output: UserHealthState

  • ZipMetricsStorages

    • auth type: Metrics
    • http method: post
    • http route: /api/metrics/zip
    • This methods has an empty request body
    • output: ZippedMetrics

INPUTS AND OUTPUTS

Messages

The content of requests and response from the methods

AddAppInvoiceRequest

AddAppRequest

  • allow_user_creation: boolean
  • name: string

AddAppUserInvoiceRequest

  • http_callback_url: string
  • invoice_req: NewInvoiceRequest
  • offer_string: string *this field is optional
  • payer_data: PayerData *this field is optional
  • payer_identifier: string
  • receiver_identifier: string
  • rejectUnauthorized: boolean *this field is optional
  • token: string *this field is optional

AddAppUserRequest

  • balance: number
  • fail_if_exists: boolean
  • identifier: string

AddPeerRequest

  • host: string
  • port: number
  • pubkey: string

AddProductRequest

  • name: string
  • price_sats: number

AdminInvoiceSwapResponse

  • tx_id: string

AdminTxSwapResponse

  • network_fee: number
  • tx_id: string

AppMetrics

  • app: Application
  • available: number
  • fees: number
  • invoices: number
  • operations: ARRAY of: UserOperation
  • received: number
  • spent: number
  • total_fees: number
  • users: UsersInfo

AppUsageMetrics

AppUser

  • identifier: string
  • info: UserInfo
  • max_withdrawable: number

Application

  • balance: number
  • id: string
  • name: string
  • npub: string

AppsMetrics

AppsMetricsRequest

  • from_unix: number *this field is optional
  • include_operations: boolean *this field is optional
  • to_unix: number *this field is optional

AssetOperation

AssetsAndLiabilities

AssetsAndLiabilitiesReq

  • limit_invoices: number *this field is optional
  • limit_payments: number *this field is optional
  • limit_providers: number *this field is optional

AuthApp

AuthAppRequest

  • allow_user_creation: boolean *this field is optional
  • name: string

BanUserRequest

  • user_id: string

BanUserResponse

BannedAppUser

  • app_id: string
  • app_name: string
  • nostr_pub: string
  • user_identifier: string

BeaconData

  • avatarUrl: string *this field is optional
  • fees: CumulativeFees *this field is optional
  • name: string
  • nextRelay: string *this field is optional
  • type: string

BumpTx

  • output_index: number
  • sat_per_vbyte: number
  • txid: string

BundleData

  • available_chunks: ARRAY of: number
  • base_64_data: ARRAY of: string
  • current_chunk: number

BundleMetric

  • app_bundles: MAP with key: string and value: BundleData

BundleMetrics

CallbackUrl

  • url: string

ChannelPolicy

  • base_fee_msat: number
  • fee_rate_ppm: number
  • max_htlc_msat: number
  • min_htlc_msat: number
  • timelock_delta: number

CloseChannelRequest

  • force: boolean
  • funding_txid: string
  • output_index: number
  • sat_per_v_byte: number

CloseChannelResponse

  • closing_txid: string

ClosedChannel

  • capacity: number
  • channel_id: string
  • close_tx_timestamp: number
  • closed_height: number

ClosureMigration

  • closes_at_unix: number

CreateOneTimeInviteLinkRequest

  • sats: number *this field is optional

CreateOneTimeInviteLinkResponse

  • invitation_link: string

CumulativeFees

  • serviceFeeBps: number
  • serviceFeeFloor: number

DebitAuthorization

  • authorized: boolean
  • debit_id: string
  • npub: string
  • rules: ARRAY of: DebitRule

DebitAuthorizationRequest

  • authorize_npub: string
  • request_id: string *this field is optional
  • rules: ARRAY of: DebitRule

DebitAuthorizations

DebitExpirationRule

  • expires_at_unix: number

DebitOperation

  • npub: string

DebitResponse

DebitRule

DebitToAuthorize

  • invoice: string *this field is optional
  • rules: ARRAY of: DebitRule

DecodeInvoiceRequest

  • invoice: string

DecodeInvoiceResponse

  • amount: number

Empty

EncryptionExchangeRequest

  • deviceId: string
  • publicKey: string

EnrollAdminTokenRequest

  • admin_token: string

ErrorStat

  • errors: number
  • from_unix: number
  • total: number

ErrorStats

FrequencyRule

  • amount: number
  • interval: IntervalType
  • number_of_intervals: number

GetAppUserLNURLInfoRequest

  • base_url_override: string
  • user_identifier: string

GetAppUserRequest

  • user_identifier: string

GetInviteTokenStateRequest

  • invite_token: string

GetInviteTokenStateResponse

  • used: boolean

GetNPubLinking

  • user_identifier: string

GetPaymentStateRequest

  • invoice: string

GetProductBuyLinkResponse

  • link: string

GetUserOfferInvoicesReq

  • include_unpaid: boolean
  • offer_id: string

GetUserOperationsRequest

GetUserOperationsResponse

GraphPoint

  • x: number
  • y: number

HandleLnurlPayResponse

  • pr: string
  • routes: ARRAY of: Empty

HttpCreds

  • token: string
  • url: string

InvoiceSwapOperation

  • completed_at_unix: number *this field is optional
  • failure_reason: string *this field is optional
  • operation_payment: UserOperation *this field is optional
  • quote: InvoiceSwapQuote
  • refund_address: string *this field is optional
  • refund_at_unix: number *this field is optional
  • refund_tx_id: string *this field is optional

InvoiceSwapQuote

  • address: string
  • chain_fee_sats: number
  • expires_at_block_height: number
  • invoice: string
  • invoice_amount_sats: number
  • paid_at_unix: number
  • service_fee_sats: number
  • service_url: string
  • swap_fee_sats: number
  • swap_operation_id: string
  • transaction_amount_sats: number
  • tx_id: string

InvoiceSwapQuoteList

InvoiceSwapRequest

  • amount_sats: number

InvoiceSwapsList

LatestBundleMetricReq

  • limit: number *this field is optional

LatestUsageMetricReq

  • limit: number *this field is optional

LinkNPubThroughTokenRequest

  • token: string

LiquidityAssetProvider

LiveDebitRequest

LiveManageRequest

  • npub: string
  • request_id: string

LiveUserOperation

LndAssetProvider

LndChannels

LndForwardingEvent

  • amt_in: number
  • amt_out: number
  • at_unix: number
  • chan_id_in: string
  • chan_id_out: string
  • fee: number

LndForwardingMetrics

LndGetInfoRequest

  • nodeId: number

LndGetInfoResponse

  • alias: string
  • synced_to_chain: boolean
  • synced_to_graph: boolean
  • watchdog_barking: boolean

LndMetrics

LndMetricsRequest

  • from_unix: number *this field is optional
  • to_unix: number *this field is optional

LndNodeMetrics

  • chain_balance: ARRAY of: GraphPoint
  • channel_balance: ARRAY of: GraphPoint
  • closed_channels: ARRAY of: ClosedChannel
  • closing_channels: number
  • external_balance: ARRAY of: GraphPoint
  • forwarding_events: number
  • forwarding_fees: number
  • offline_channels: number
  • online_channels: number
  • open_channels: ARRAY of: OpenChannel
  • pending_channels: number
  • root_ops: ARRAY of: RootOperation

LndSeed

  • seed: ARRAY of: string

LnurlLinkResponse

  • k1: string
  • lnurl: string

LnurlPayInfoResponse

  • allowsNostr: boolean
  • callback: string
  • maxSendable: number
  • metadata: string
  • minSendable: number
  • nostrPubkey: string
  • tag: string

LnurlWithdrawInfoResponse

  • balanceCheck: string
  • callback: string
  • defaultDescription: string
  • k1: string
  • maxWithdrawable: number
  • minWithdrawable: number
  • payLink: string
  • tag: string

ManageAuthorization

  • authorized: boolean
  • manage_id: string
  • npub: string

ManageAuthorizationRequest

  • authorize_npub: string
  • ban: boolean
  • request_id: string *this field is optional

ManageAuthorizations

ManageOperation

  • npub: string

MessagingToken

  • device_id: string
  • firebase_messaging_token: string

MetricsFile

MigrationUpdate

NPubLinking

NewAddressRequest

NewAddressResponse

  • address: string

NewInvoiceRequest

  • amountSats: number
  • blind: boolean *this field is optional
  • expiry: number *this field is optional
  • memo: string
  • zap: string *this field is optional

NewInvoiceResponse

  • invoice: string

OfferConfig

  • blind: boolean *this field is optional
  • callback_url: string
  • createdAtUnix: number
  • default_offer: boolean
  • label: string
  • noffer: string
  • offer_id: string
  • payer_data: ARRAY of: string
  • price_sats: number
  • rejectUnauthorized: boolean
  • token: string
  • updatedAtUnix: number

OfferId

  • offer_id: string

OfferInvoice

  • amount: number
  • data: MAP with key: string and value: string
  • invoice: string
  • offer_id: string
  • paid_at_unix: number

OfferInvoices

OpenChannel

  • active: boolean
  • capacity: number
  • channel_id: string
  • channel_point: string
  • inactive_since_unix: number
  • label: string
  • lifetime: number
  • local_balance: number
  • policy: ChannelPolicy *this field is optional
  • remote_balance: number

OpenChannelRequest

  • close_address: string *this field is optional
  • local_funding_amount: number
  • node_pubkey: string
  • push_sat: number *this field is optional
  • sat_per_v_byte: number

OpenChannelResponse

  • channel_id: string

OperationsCursor

  • id: number
  • ts: number

PayAddressRequest

  • address: string
  • amountSats: number
  • satsPerVByte: number
  • swap_operation_id: string *this field is optional

PayAddressResponse

  • network_fee: number
  • operation_id: string
  • service_fee: number
  • txId: string

PayAdminInvoiceSwapRequest

  • no_claim: boolean *this field is optional
  • sat_per_v_byte: number
  • swap_operation_id: string

PayAdminTransactionSwapRequest

  • address: string
  • swap_operation_id: string

PayAppUserInvoiceRequest

  • amount: number
  • debit_npub: string *this field is optional
  • expected_fees: CumulativeFees *this field is optional
  • invoice: string
  • user_identifier: string

PayInvoiceRequest

  • amount: number
  • debit_npub: string *this field is optional
  • expected_fees: CumulativeFees *this field is optional
  • invoice: string

PayInvoiceResponse

  • amount_paid: number
  • latest_balance: number
  • network_fee: number
  • operation_id: string
  • preimage: string
  • service_fee: number

PayerData

  • data: MAP with key: string and value: string

PaymentState

  • amount: number
  • internal: boolean
  • network_fee: number
  • operation_id: string
  • paid_at_unix: number
  • service_fee: number

Product

  • id: string
  • name: string
  • noffer: string
  • price_sats: number

ProviderDisruption

  • provider_pubkey: string
  • provider_type: string
  • since_unix: number

ProvidersDisruption

PushNotificationEnvelope

  • app_npub_hex: string
  • encrypted_payload: string
  • topic_id: string

PushNotificationPayload

RefundAdminInvoiceSwapRequest

  • sat_per_v_byte: number
  • swap_operation_id: string

RelaysMigration

  • relays: ARRAY of: string

RequestNPubLinkingTokenRequest

  • user_identifier: string

RequestNPubLinkingTokenResponse

  • token: string

RootOperation

  • amount: number
  • created_at_unix: number
  • op_id: string
  • op_type: OperationType

RoutingEvent

  • event_type: string
  • failure_string: string
  • forward_fail_event: boolean
  • incoming_amt_msat: number
  • incoming_channel_id: number
  • incoming_htlc_id: number
  • offchain: boolean
  • outgoing_amt_msat: number
  • outgoing_channel_id: number
  • outgoing_htlc_id: number
  • settled: boolean
  • timestamp_ns: number

SendAppUserToAppPaymentRequest

  • amount: number
  • from_user_identifier: string

SendAppUserToAppUserPaymentRequest

  • amount: number
  • from_user_identifier: string
  • to_user_identifier: string

SetMockAppBalanceRequest

  • amount: number

SetMockAppUserBalanceRequest

  • amount: number
  • user_identifier: string

SetMockInvoiceAsPaidRequest

  • amount: number
  • invoice: string

SingleMetricReq

  • app_id: string
  • metric_type: SingleMetricType
  • metrics_name: string
  • page: number
  • request_id: number *this field is optional

TrackedLiquidityProvider

TrackedLndProvider

TrackedOperation

TransactionSwapQuote

  • chain_fee_sats: number
  • completed_at_unix: number
  • expires_at_block_height: number
  • invoice_amount_sats: number
  • paid_at_unix: number
  • service_fee_sats: number
  • service_url: string
  • swap_fee_sats: number
  • swap_operation_id: string
  • transaction_amount_sats: number

TransactionSwapQuoteList

TransactionSwapRequest

  • transaction_amount_sats: number

TxSwapOperation

  • address_paid: string *this field is optional
  • failure_reason: string *this field is optional
  • operation_payment: UserOperation *this field is optional
  • quote: TransactionSwapQuote
  • tx_id: string *this field is optional

TxSwapsList

UpdateChannelPolicyRequest

UsageMetric

  • app_id: string *this field is optional
  • auth_in_nano: number
  • batch: boolean
  • batch_size: number
  • handle_in_nano: number
  • nostr: boolean
  • parsed_in_nano: number
  • processed_at_ms: number
  • rpc_name: string
  • success: boolean
  • validate_in_nano: number

UsageMetricTlv

  • available_chunks: ARRAY of: number
  • base_64_tlvs: ARRAY of: string
  • current_chunk: number

UsageMetrics

UseInviteLinkRequest

  • invite_token: string

UserHealthState

  • downtime_reason: string

UserInfo

  • balance: number
  • bridge_url: string
  • callback_url: string
  • max_withdrawable: number
  • ndebit: string
  • network_max_fee_bps: number
  • network_max_fee_fixed: number
  • nmanage: string
  • noffer: string
  • service_fee_bps: number
  • topic_id: string
  • userId: string
  • user_identifier: string

UserOffers

UserOperation

  • amount: number
  • confirmed: boolean
  • identifier: string
  • inbound: boolean
  • internal: boolean
  • network_fee: number
  • operationId: string
  • paidAtUnix: number
  • service_fee: number
  • tx_hash: string
  • type: UserOperationType

UserOperations

UsersInfo

  • always_been_inactive: number
  • balance_avg: number
  • balance_median: number
  • negative_balance: number
  • no_balance: number
  • total: number

WebRtcAnswer

  • answer: string *this field is optional

WebRtcCandidate

  • candidate: string

WebRtcMessage

ZippedMetrics

  • path: string

Enums

The enumerators used in the messages

AddressType

  • NESTED_PUBKEY_HASH
  • TAPROOT_PUBKEY
  • WITNESS_PUBKEY_HASH

IntervalType

  • DAY
  • MONTH
  • WEEK

OperationType

  • CHAIN_OP
  • INVOICE_OP

SingleMetricType

  • BUNDLE_METRIC
  • USAGE_METRIC

TrackedOperationType

  • ROOT
  • USER

UserOperationType

  • INCOMING_INVOICE
  • INCOMING_TX
  • INCOMING_USER_TO_USER
  • OUTGOING_INVOICE
  • OUTGOING_TX
  • OUTGOING_USER_TO_USER