lightning/lnd_methods/unauthenticated/get_wallet_status.d.ts

Lightning Network client library

import {UnauthenticatedLnd} from '../../lnd_grpc';
import {UnauthenticatedLightningMethod} from '../../typescript';

export type GetWalletStatusResult = {
  /** Is Wallet Not Created Yet */
  is_absent?: boolean;

  /** Is Wallet Currently Active */
  is_active?: boolean;

  /** Is Wallet File Encrypted */
  is_locked?: boolean;

  /** Is Wallet Ready For All RPC Calls */
  is_ready?: boolean;

  /** Is Wallet Starting Up */
  is_starting?: boolean;

  /** Is Wallet Waiting To Start */
  is_waiting?: boolean;
};

/**
 * Get wallet status.
 *
 * This method is not supported on LND 0.12.1 and below
 *
 * `is_ready` is not supported on LND 0.13.4 and below
 */
export const getWalletStatus: UnauthenticatedLightningMethod<
  {lnd: UnauthenticatedLnd},
  GetWalletStatusResult
>;