@lightsparkdev/lightspark-sdk 0.2.1 → 0.2.2

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @lightsparkdev/lightspark-sdk
 
+## 0.2.2
+
+### Patch Changes
+
+- Add bindings to lightspark-sdk for managing connected wallets.
+
 ## 0.2.1
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lightsparkdev/lightspark-sdk",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "description": "Lightspark JS SDK",
   "author": "Lightspark Inc.",
   "keywords": [

package/src/objects/Account.ts

@@ -18,6 +18,9 @@ import AccountToPaymentRequestsConnection, {
 import AccountToTransactionsConnection, {
   AccountToTransactionsConnectionFromJson,
 } from "./AccountToTransactionsConnection.js";
+import AccountToWalletsConnection, {
+  AccountToWalletsConnectionFromJson,
+} from "./AccountToWalletsConnection.js";
 import BitcoinNetwork from "./BitcoinNetwork.js";
 import BlockchainBalance, {
   BlockchainBalanceFromJson,
@@ -1181,6 +1184,73 @@ query FetchAccountToPaymentRequestsConnection($first: Int, $after: String, $afte
     }))!;
   }
 
+  public async getWallets(
+    client: LightsparkClient,
+    first: number | undefined = undefined
+  ): Promise<AccountToWalletsConnection> {
+    return (await client.executeRawQuery({
+      queryPayload: ` 
+query FetchAccountToWalletsConnection($first: Int) {
+    current_account {
+        ... on Account {
+            wallets(, first: $first) {
+                __typename
+                account_to_wallets_connection_page_info: page_info {
+                    __typename
+                    page_info_has_next_page: has_next_page
+                    page_info_has_previous_page: has_previous_page
+                    page_info_start_cursor: start_cursor
+                    page_info_end_cursor: end_cursor
+                }
+                account_to_wallets_connection_count: count
+                account_to_wallets_connection_entities: entities {
+                    __typename
+                    wallet_id: id
+                    wallet_created_at: created_at
+                    wallet_updated_at: updated_at
+                    wallet_last_login_at: last_login_at
+                    wallet_balances: balances {
+                        __typename
+                        balances_owned_balance: owned_balance {
+                            __typename
+                            currency_amount_original_value: original_value
+                            currency_amount_original_unit: original_unit
+                            currency_amount_preferred_currency_unit: preferred_currency_unit
+                            currency_amount_preferred_currency_value_rounded: preferred_currency_value_rounded
+                            currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
+                        }
+                        balances_available_to_send_balance: available_to_send_balance {
+                            __typename
+                            currency_amount_original_value: original_value
+                            currency_amount_original_unit: original_unit
+                            currency_amount_preferred_currency_unit: preferred_currency_unit
+                            currency_amount_preferred_currency_value_rounded: preferred_currency_value_rounded
+                            currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
+                        }
+                        balances_available_to_withdraw_balance: available_to_withdraw_balance {
+                            __typename
+                            currency_amount_original_value: original_value
+                            currency_amount_original_unit: original_unit
+                            currency_amount_preferred_currency_unit: preferred_currency_unit
+                            currency_amount_preferred_currency_value_rounded: preferred_currency_value_rounded
+                            currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
+                        }
+                    }
+                    wallet_third_party_identifier: third_party_identifier
+                }
+            }
+        }
+    }
+}
+`,
+      variables: { first: first },
+      constructObject: (json) => {
+        const connection = json["current_account"]["wallets"];
+        return AccountToWalletsConnectionFromJson(connection);
+      },
+    }))!;
+  }
+
   static getAccountQuery(): Query<Account> {
     return {
       queryPayload: `

package/src/objects/AccountToWalletsConnection.ts

@@ -0,0 +1,48 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+import PageInfo, { PageInfoFromJson } from "./PageInfo.js";
+import Wallet, { WalletFromJson } from "./Wallet.js";
+
+type AccountToWalletsConnection = {
+  /** An object that holds pagination information about the objects in this connection. **/
+  pageInfo: PageInfo;
+
+  /**
+   * The total count of objects in this connection, using the current filters. It is different from the
+   * number of objects returned in the current page (in the `entities` field).
+   **/
+  count: number;
+
+  /** The wallets for the current page of this connection. **/
+  entities: Wallet[];
+};
+
+export const AccountToWalletsConnectionFromJson = (
+  obj: any
+): AccountToWalletsConnection => {
+  return {
+    pageInfo: PageInfoFromJson(obj["account_to_wallets_connection_page_info"]),
+    count: obj["account_to_wallets_connection_count"],
+    entities: obj["account_to_wallets_connection_entities"].map((e) =>
+      WalletFromJson(e)
+    ),
+  } as AccountToWalletsConnection;
+};
+
+export const FRAGMENT = `
+fragment AccountToWalletsConnectionFragment on AccountToWalletsConnection {
+    __typename
+    account_to_wallets_connection_page_info: page_info {
+        __typename
+        page_info_has_next_page: has_next_page
+        page_info_has_previous_page: has_previous_page
+        page_info_start_cursor: start_cursor
+        page_info_end_cursor: end_cursor
+    }
+    account_to_wallets_connection_count: count
+    account_to_wallets_connection_entities: entities {
+        id
+    }
+}`;
+
+export default AccountToWalletsConnection;

package/src/objects/Balances.ts

@@ -0,0 +1,71 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+import CurrencyAmount, { CurrencyAmountFromJson } from "./CurrencyAmount.js";
+
+type Balances = {
+  /**
+   * This represents the balance that should be displayed when asked "how much do I own right now?". It
+   * represents the amount currently owned, including things that may not be owned soon (e.g. in-flight
+   * outgoing payments, in-flight withdrawals, commit fees, etc.). It really is a snapshot of what is
+   * officially owned at this instant.
+   **/
+  ownedBalance: CurrencyAmount;
+
+  /**
+   * This represents the balance that should be displayed when asked "how much can I send on Lightning
+   * right now?". It represents the amount currently available to be sent on the Lightning network. We
+   * remove from the balance all the funds that are temporarily locked (e.g. channel reserves).
+   **/
+  availableToSendBalance: CurrencyAmount;
+
+  /**
+   * This represents the balance that should be displayed when asked "how much money can I withdraw on
+   * the Bitcoin network right now?". It represents the amount currently available to withdraw and is
+   * usually equal to the `owned_balance` but it does not include in-flight operations (which would
+   * likely succeed and therefore likely make your withdrawal fail).
+   **/
+  availableToWithdrawBalance: CurrencyAmount;
+};
+
+export const BalancesFromJson = (obj: any): Balances => {
+  return {
+    ownedBalance: CurrencyAmountFromJson(obj["balances_owned_balance"]),
+    availableToSendBalance: CurrencyAmountFromJson(
+      obj["balances_available_to_send_balance"]
+    ),
+    availableToWithdrawBalance: CurrencyAmountFromJson(
+      obj["balances_available_to_withdraw_balance"]
+    ),
+  } as Balances;
+};
+
+export const FRAGMENT = `
+fragment BalancesFragment on Balances {
+    __typename
+    balances_owned_balance: owned_balance {
+        __typename
+        currency_amount_original_value: original_value
+        currency_amount_original_unit: original_unit
+        currency_amount_preferred_currency_unit: preferred_currency_unit
+        currency_amount_preferred_currency_value_rounded: preferred_currency_value_rounded
+        currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
+    }
+    balances_available_to_send_balance: available_to_send_balance {
+        __typename
+        currency_amount_original_value: original_value
+        currency_amount_original_unit: original_unit
+        currency_amount_preferred_currency_unit: preferred_currency_unit
+        currency_amount_preferred_currency_value_rounded: preferred_currency_value_rounded
+        currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
+    }
+    balances_available_to_withdraw_balance: available_to_withdraw_balance {
+        __typename
+        currency_amount_original_value: original_value
+        currency_amount_original_unit: original_unit
+        currency_amount_preferred_currency_unit: preferred_currency_unit
+        currency_amount_preferred_currency_value_rounded: preferred_currency_value_rounded
+        currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
+    }
+}`;
+
+export default Balances;

package/src/objects/Entity.ts

@@ -810,6 +810,41 @@ fragment EntityFragment on Entity {
         }
         routing_transaction_failure_reason: failure_reason
     }
+    ... on Wallet {
+        __typename
+        wallet_id: id
+        wallet_created_at: created_at
+        wallet_updated_at: updated_at
+        wallet_last_login_at: last_login_at
+        wallet_balances: balances {
+            __typename
+            balances_owned_balance: owned_balance {
+                __typename
+                currency_amount_original_value: original_value
+                currency_amount_original_unit: original_unit
+                currency_amount_preferred_currency_unit: preferred_currency_unit
+                currency_amount_preferred_currency_value_rounded: preferred_currency_value_rounded
+                currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
+            }
+            balances_available_to_send_balance: available_to_send_balance {
+                __typename
+                currency_amount_original_value: original_value
+                currency_amount_original_unit: original_unit
+                currency_amount_preferred_currency_unit: preferred_currency_unit
+                currency_amount_preferred_currency_value_rounded: preferred_currency_value_rounded
+                currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
+            }
+            balances_available_to_withdraw_balance: available_to_withdraw_balance {
+                __typename
+                currency_amount_original_value: original_value
+                currency_amount_original_unit: original_unit
+                currency_amount_preferred_currency_unit: preferred_currency_unit
+                currency_amount_preferred_currency_value_rounded: preferred_currency_value_rounded
+                currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
+            }
+        }
+        wallet_third_party_identifier: third_party_identifier
+    }
     ... on Withdrawal {
         __typename
         withdrawal_id: id

package/src/objects/Wallet.ts

@@ -0,0 +1,159 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+import { Query } from "@lightsparkdev/core";
+import autoBind from "auto-bind";
+import LightsparkClient from "../client.js";
+import Balances, { BalancesFromJson } from "./Balances.js";
+import CurrencyAmount, { CurrencyAmountFromJson } from "./CurrencyAmount.js";
+import Entity from "./Entity.js";
+
+class Wallet implements Entity {
+  constructor(
+    public readonly id: string,
+    public readonly createdAt: string,
+    public readonly updatedAt: string,
+    public readonly thirdPartyIdentifier: string,
+    public readonly typename: string,
+    public readonly lastLoginAt?: string,
+    public readonly balances?: Balances
+  ) {
+    autoBind(this);
+  }
+
+  public async getTotalAmountReceived(
+    client: LightsparkClient,
+    createdAfterDate: string | undefined = undefined,
+    createdBeforeDate: string | undefined = undefined
+  ): Promise<CurrencyAmount> {
+    return (await client.executeRawQuery({
+      queryPayload: ` 
+query FetchWalletTotalAmountReceived($created_after_date: DateTime, $created_before_date: DateTime) {
+    current_wallet {
+        ... on Wallet {
+            total_amount_received(, created_after_date: $created_after_date, created_before_date: $created_before_date) {
+                __typename
+                currency_amount_original_value: original_value
+                currency_amount_original_unit: original_unit
+                currency_amount_preferred_currency_unit: preferred_currency_unit
+                currency_amount_preferred_currency_value_rounded: preferred_currency_value_rounded
+                currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
+            }
+        }
+    }
+}
+`,
+      variables: {
+        created_after_date: createdAfterDate,
+        created_before_date: createdBeforeDate,
+      },
+      constructObject: (json) => {
+        const connection = json["current_wallet"]["total_amount_received"];
+        return CurrencyAmountFromJson(connection);
+      },
+    }))!;
+  }
+
+  public async getTotalAmountSent(
+    client: LightsparkClient,
+    createdAfterDate: string | undefined = undefined,
+    createdBeforeDate: string | undefined = undefined
+  ): Promise<CurrencyAmount> {
+    return (await client.executeRawQuery({
+      queryPayload: ` 
+query FetchWalletTotalAmountSent($created_after_date: DateTime, $created_before_date: DateTime) {
+    current_wallet {
+        ... on Wallet {
+            total_amount_sent(, created_after_date: $created_after_date, created_before_date: $created_before_date) {
+                __typename
+                currency_amount_original_value: original_value
+                currency_amount_original_unit: original_unit
+                currency_amount_preferred_currency_unit: preferred_currency_unit
+                currency_amount_preferred_currency_value_rounded: preferred_currency_value_rounded
+                currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
+            }
+        }
+    }
+}
+`,
+      variables: {
+        created_after_date: createdAfterDate,
+        created_before_date: createdBeforeDate,
+      },
+      constructObject: (json) => {
+        const connection = json["current_wallet"]["total_amount_sent"];
+        return CurrencyAmountFromJson(connection);
+      },
+    }))!;
+  }
+
+  static getWalletQuery(): Query<Wallet> {
+    return {
+      queryPayload: `
+query GetWallet {
+    current_wallet {
+        ... on Wallet {
+            ...WalletFragment
+        }
+    }
+}
+
+${FRAGMENT}    
+`,
+      variables: {},
+      constructObject: (data: any) => WalletFromJson(data.current_wallet),
+    };
+  }
+}
+
+export const WalletFromJson = (obj: any): Wallet => {
+  return new Wallet(
+    obj["wallet_id"],
+    obj["wallet_created_at"],
+    obj["wallet_updated_at"],
+    obj["wallet_third_party_identifier"],
+    "Wallet",
+    obj["wallet_last_login_at"],
+    !!obj["wallet_balances"]
+      ? BalancesFromJson(obj["wallet_balances"])
+      : undefined
+  );
+};
+
+export const FRAGMENT = `
+fragment WalletFragment on Wallet {
+    __typename
+    wallet_id: id
+    wallet_created_at: created_at
+    wallet_updated_at: updated_at
+    wallet_last_login_at: last_login_at
+    wallet_balances: balances {
+        __typename
+        balances_owned_balance: owned_balance {
+            __typename
+            currency_amount_original_value: original_value
+            currency_amount_original_unit: original_unit
+            currency_amount_preferred_currency_unit: preferred_currency_unit
+            currency_amount_preferred_currency_value_rounded: preferred_currency_value_rounded
+            currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
+        }
+        balances_available_to_send_balance: available_to_send_balance {
+            __typename
+            currency_amount_original_value: original_value
+            currency_amount_original_unit: original_unit
+            currency_amount_preferred_currency_unit: preferred_currency_unit
+            currency_amount_preferred_currency_value_rounded: preferred_currency_value_rounded
+            currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
+        }
+        balances_available_to_withdraw_balance: available_to_withdraw_balance {
+            __typename
+            currency_amount_original_value: original_value
+            currency_amount_original_unit: original_unit
+            currency_amount_preferred_currency_unit: preferred_currency_unit
+            currency_amount_preferred_currency_value_rounded: preferred_currency_value_rounded
+            currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
+        }
+    }
+    wallet_third_party_identifier: third_party_identifier
+}`;
+
+export default Wallet;

package/src/objects/index.ts

@@ -4,7 +4,9 @@ export { default as AccountToChannelsConnection } from "./AccountToChannelsConne
 export { default as AccountToNodesConnection } from "./AccountToNodesConnection.js";
 export { default as AccountToPaymentRequestsConnection } from "./AccountToPaymentRequestsConnection.js";
 export { default as AccountToTransactionsConnection } from "./AccountToTransactionsConnection.js";
+export { default as AccountToWalletsConnection } from "./AccountToWalletsConnection.js";
 export { default as ApiToken, getApiTokenQuery } from "./ApiToken.js";
+export { default as Balances } from "./Balances.js";
 export { default as BitcoinNetwork } from "./BitcoinNetwork.js";
 export { default as BlockchainBalance } from "./BlockchainBalance.js";
 export { default as Channel } from "./Channel.js";
@@ -98,6 +100,7 @@ export { default as TransactionFailures } from "./TransactionFailures.js";
 export { default as TransactionStatus } from "./TransactionStatus.js";
 export { default as TransactionType } from "./TransactionType.js";
 export { default as TransactionUpdate } from "./TransactionUpdate.js";
+export { default as Wallet } from "./Wallet.js";
 export { default as WalletDashboard } from "./WalletDashboard.js";
 export { default as WebhookEventType } from "./WebhookEventType.js";
 export { default as Withdrawal, getWithdrawalQuery } from "./Withdrawal.js";