lightning/lnd_methods/invoices/get_invoices.d.ts

Lightning Network client library

import {
  AuthenticatedLightningArgs,
  AuthenticatedLightningMethod,
  DateRangeFilterArgs,
  PaginationArgs,
} from '../../typescript';

export type GetInvoicesArgs = AuthenticatedLightningArgs<
  PaginationArgs & {
    /** Omit Canceled and Settled Invoices Bool */
    is_unconfirmed?: boolean;
  } & DateRangeFilterArgs
>;

export type GetInvoicesResult = {
  invoices: {
    /** Fallback Chain Address */
    chain_address?: string;
    /** Settled at ISO 8601 Date */
    confirmed_at?: string;
    /** ISO 8601 Date */
    created_at: string;
    /** Description */
    description: string;
    /** Description Hash Hex String */
    description_hash?: string;
    /** ISO 8601 Date */
    expires_at: string;
    features: {
      /** BOLT 09 Feature Bit */
      bit: number;
      /** Feature is Known */
      is_known: boolean;
      /** Feature Support is Required To Pay */
      is_required: boolean;
      /** Feature Type */
      type: string;
    }[];
    /** Payment Hash */
    id: string;
    /** Invoice is Canceled */
    is_canceled?: boolean;
    /** Invoice is Confirmed */
    is_confirmed: boolean;
    /** HTLC is Held */
    is_held?: boolean;
    /** Invoice is Private */
    is_private: boolean;
    /** Invoice is Push Payment */
    is_push?: boolean;
    /** Payment Identifying Secret Hex String */
    payment?: string;
    payments: {
      /** Payment Settled At ISO 8601 Date */
      confirmed_at?: string;
      /** Payment Held Since ISO 860 Date */
      created_at: string;
      /** Payment Held Since Block Height */
      created_height: number;
      /** Incoming Payment Through Channel Id */
      in_channel: string;
      /** Payment is Canceled */
      is_canceled: boolean;
      /** Payment is Confirmed */
      is_confirmed: boolean;
      /** Payment is Held */
      is_held: boolean;
      messages: {
        /** Message Type number */
        type: string;
        /** Raw Value Hex String */
        value: string;
      }[];
      /** Incoming Payment Millitokens */
      mtokens: string;
      /** Pending Payment Channel HTLC Index */
      pending_index?: number;
      /** Payment Tokens */
      tokens: number;
      /** Total Millitokens */
      total_mtokens?: string;
    }[];
    /** Received Tokens */
    received: number;
    /** Received Millitokens */
    received_mtokens: string;
    /** Bolt 11 Invoice */
    request?: string;
    /** Secret Preimage Hex String */
    secret: string;
    /** Tokens */
    tokens: number;
  }[];
  /** Next Opaque Paging Token */
  next?: string;
};

/**
 * Get all created invoices.
 *
 * If a next token is returned, pass it to get another page of invoices.
 *
 * Requires `invoices:read` permission
 *
 * Invoice `payment` is not supported on LND 0.11.1 and below
 */
export const getInvoices: AuthenticatedLightningMethod<
  GetInvoicesArgs,
  GetInvoicesResult
>;