Class Client

constructor

• new Client(
      auth: string | AuthClient,
      requestOptions?: Partial<RequestOptions>,
  ): Client

  Parameters

  • auth: string | AuthClient
  • OptionalrequestOptions: Partial<RequestOptions>

  Returns Client

auth

OptionaldefaultRequestOptions

accountBalance

• accountBalance(
      params: {},
      request_options?: Partial<RequestOptions>,
  ): Promise<GetAccountBalanceResponse>

  Parameters

  • params: {}
  • Optionalrequest_options: Partial<RequestOptions>

  Returns Promise<GetAccountBalanceResponse>

accountInformation

• accountInformation(
      params: {},
      request_options?: Partial<RequestOptions>,
  ): Promise<GetAccountInformationResponse>

  Parameters

  • params: {}
  • Optionalrequest_options: Partial<RequestOptions>

  Returns Promise<GetAccountInformationResponse>

accountSummary

• accountSummary(
      params: {},
      request_options?: Partial<RequestOptions>,
  ): Promise<any>

  Parameters

  • params: {}
  • Optionalrequest_options: Partial<RequestOptions>

  Returns Promise<any>

accountValue4Value

• accountValue4Value(
      params: {},
      request_options?: Partial<RequestOptions>,
  ): Promise<any>

  Parameters

  • params: {}
  • Optionalrequest_options: Partial<RequestOptions>

  Returns Promise<any>

createInvoice

• createInvoice(
      invoice: InvoiceRequestParams,
      request_options?: Partial<RequestOptions>,
  ): Promise<Invoice>

  Parameters

  • invoice: InvoiceRequestParams
  • Optionalrequest_options: Partial<RequestOptions>

  Returns Promise<Invoice>

createSwap

• createSwap(
      params: CreateSwapParams,
      request_options?: Partial<RequestOptions>,
  ): Promise<CreateSwapResponse>

  Parameters

  • params: CreateSwapParams
  • Optionalrequest_options: Partial<RequestOptions>

  Returns Promise<CreateSwapResponse>

createWebhookEndpoint

• createWebhookEndpoint(
      params: CreateWebhookEndpointParams,
      request_options?: Partial<RequestOptions>,
  ): Promise<CreateWebhookEndpointResponse>

  Parameters

  • params: CreateWebhookEndpointParams
  • Optionalrequest_options: Partial<RequestOptions>

  Returns Promise<CreateWebhookEndpointResponse>

decodeInvoice

• decodeInvoice(
      paymentRequest: string,
      request_options?: Partial<RequestOptions>,
  ): Promise<DecodedInvoice>

  Parameters

  • paymentRequest: string
  • Optionalrequest_options: Partial<RequestOptions>

  Returns Promise<DecodedInvoice>

deleteWebhookEndpoint

• deleteWebhookEndpoint(
      id: string,
      request_options?: Partial<RequestOptions>,
  ): Promise<BaseWebhookEndpointResponse>

  Parameters

  • id: string
  • Optionalrequest_options: Partial<RequestOptions>

  Returns Promise<BaseWebhookEndpointResponse>

getInvoice

• getInvoice(
      paymentHash: string,
      request_options?: Partial<RequestOptions>,
  ): Promise<Invoice>

  Parameters

  • paymentHash: string
  • Optionalrequest_options: Partial<RequestOptions>

  Returns Promise<Invoice>

getSwapInfo

• getSwapInfo(
      request_options?: Partial<RequestOptions>,
  ): Promise<SwapInfoResponse>

  Parameters

  • Optionalrequest_options: Partial<RequestOptions>

  Returns Promise<SwapInfoResponse>

incomingInvoices

• incomingInvoices(
      params: GetInvoicesRequestParams,
      request_options?: Partial<RequestOptions>,
  ): Promise<Invoice[]>

  Parameters

  • params: GetInvoicesRequestParams
  • Optionalrequest_options: Partial<RequestOptions>

  Returns Promise<Invoice[]>

invoices

• invoices(
      params: GetInvoicesRequestParams,
      request_options?: Partial<RequestOptions>,
  ): Promise<Invoice[]>

  Parameters

  • params: GetInvoicesRequestParams
  • Optionalrequest_options: Partial<RequestOptions>

  Returns Promise<Invoice[]>

keysend

• keysend(
      args: KeysendRequestParams | KeysendRequestParams[],
      request_options?: Partial<RequestOptions>,
  ): Promise<SendPaymentResponse>

  Parameters

  • args: KeysendRequestParams | KeysendRequestParams[]
  • Optionalrequest_options: Partial<RequestOptions>

  Returns Promise<SendPaymentResponse>

outgoingInvoices

• outgoingInvoices(
      params: GetInvoicesRequestParams,
      request_options?: Partial<RequestOptions>,
  ): Promise<Invoice[]>

  Parameters

  • params: GetInvoicesRequestParams
  • Optionalrequest_options: Partial<RequestOptions>

  Returns Promise<Invoice[]>

sendBoostagram

• sendBoostagram(
      args: SendBoostagramRequestParams | SendBoostagramRequestParams[],
      request_options?: Partial<RequestOptions>,
  ): Promise<any>

  Parameters

  • args: SendBoostagramRequestParams | SendBoostagramRequestParams[]
  • Optionalrequest_options: Partial<RequestOptions>

  Returns Promise<any>

sendBoostagramToAlbyAccount

• sendBoostagramToAlbyAccount(
      args: SendBoostagramToAlbyRequestParams,
      request_options?: Partial<RequestOptions>,
  ): Promise<any>

  Parameters

  • args: SendBoostagramToAlbyRequestParams
  • Optionalrequest_options: Partial<RequestOptions>

  Returns Promise<any>

sendPayment

• sendPayment(
      params: SendPaymentRequestParams,
      request_options?: Partial<RequestOptions>,
  ): Promise<SendPaymentResponse>

  Parameters

  • params: SendPaymentRequestParams
  • Optionalrequest_options: Partial<RequestOptions>

  Returns Promise<SendPaymentResponse>

signMessage

• signMessage(
      message: SignMessageRequestParams,
      request_options?: Partial<RequestOptions>,
  ): Promise<SignMessageResponse>

  Parameters

  • message: SignMessageRequestParams
  • Optionalrequest_options: Partial<RequestOptions>

  Returns Promise<SignMessageResponse>