@buildonspark/spark-sdk 0.0.14 → 0.0.16

package/src/graphql/objects/Connection.ts

@@ -0,0 +1,90 @@
+
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+
+import SparkTransferToLeavesConnection from './SparkTransferToLeavesConnection.js';
+import {PageInfoToJson} from './PageInfo.js';
+import {LeafToJson} from './Leaf.js';
+import {PageInfoFromJson} from './PageInfo.js';
+import { LightsparkException } from '@lightsparkdev/core';
+import {LeafFromJson} from './Leaf.js';
+import PageInfo from './PageInfo.js';
+
+
+interface Connection {
+
+
+    /**
+ * 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;
+
+    /** An object that holds pagination information about the objects in this connection. **/
+pageInfo: PageInfo;
+
+    /** The typename of the object **/
+typename: string;
+
+
+
+
+}
+
+export const ConnectionFromJson = (obj: any): Connection => {
+    if (obj["__typename"] == "SparkTransferToLeavesConnection") {
+        return {
+            count: obj["spark_transfer_to_leaves_connection_count"],
+            pageInfo: PageInfoFromJson(obj["spark_transfer_to_leaves_connection_page_info"]),
+            entities: obj["spark_transfer_to_leaves_connection_entities"].map((e) => LeafFromJson(e)),
+typename: "SparkTransferToLeavesConnection",
+        } as SparkTransferToLeavesConnection;
+
+}    throw new LightsparkException("DeserializationError", `Couldn't find a concrete type for interface Connection corresponding to the typename=${obj["__typename"]}`)
+}
+export const ConnectionToJson = (obj: Connection): any => {
+    if (obj.typename == "SparkTransferToLeavesConnection") {
+       const sparkTransferToLeavesConnection = obj as SparkTransferToLeavesConnection;
+return {
+__typename: "SparkTransferToLeavesConnection",spark_transfer_to_leaves_connection_count: sparkTransferToLeavesConnection.count,
+spark_transfer_to_leaves_connection_page_info: PageInfoToJson(sparkTransferToLeavesConnection.pageInfo),
+spark_transfer_to_leaves_connection_entities: sparkTransferToLeavesConnection.entities.map((e) => LeafToJson(e)),
+
+        }
+
+}    throw new LightsparkException("DeserializationError", `Couldn't find a concrete type for interface Connection corresponding to the typename=${obj.typename}`)
+}
+
+
+    export const FRAGMENT = `
+fragment ConnectionFragment on Connection {
+    __typename
+    ... on SparkTransferToLeavesConnection {
+        __typename
+        spark_transfer_to_leaves_connection_count: count
+        spark_transfer_to_leaves_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
+        }
+        spark_transfer_to_leaves_connection_entities: entities {
+            __typename
+            leaf_amount: amount {
+                __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
+            }
+            leaf_spark_node_id: spark_node_id
+        }
+    }
+}`;
+
+
+
+
+export default Connection;

package/src/graphql/objects/CoopExitFeeEstimateInput.ts

@@ -0,0 +1,41 @@
+
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+
+
+
+
+interface CoopExitFeeEstimateInput {
+
+
+    leafExternalIds: string[];
+
+    withdrawalAddress: string;
+
+
+
+
+}
+
+export const CoopExitFeeEstimateInputFromJson = (obj: any): CoopExitFeeEstimateInput => {
+    return {
+        leafExternalIds: obj["coop_exit_fee_estimate_input_leaf_external_ids"],
+        withdrawalAddress: obj["coop_exit_fee_estimate_input_withdrawal_address"],
+
+        } as CoopExitFeeEstimateInput;
+
+}
+export const CoopExitFeeEstimateInputToJson = (obj: CoopExitFeeEstimateInput): any => {
+return {
+coop_exit_fee_estimate_input_leaf_external_ids: obj.leafExternalIds,
+coop_exit_fee_estimate_input_withdrawal_address: obj.withdrawalAddress,
+
+        }
+
+}
+
+
+
+
+
+export default CoopExitFeeEstimateInput;

package/src/graphql/objects/CoopExitFeeEstimateOutput.ts

@@ -0,0 +1,52 @@
+
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+
+import {CurrencyAmountToJson} from './CurrencyAmount.js';
+import {CurrencyAmountFromJson} from './CurrencyAmount.js';
+import CurrencyAmount from './CurrencyAmount.js';
+
+
+interface CoopExitFeeEstimateOutput {
+
+
+    feeEstimate: CurrencyAmount;
+
+
+
+
+}
+
+export const CoopExitFeeEstimateOutputFromJson = (obj: any): CoopExitFeeEstimateOutput => {
+    return {
+        feeEstimate: CurrencyAmountFromJson(obj["coop_exit_fee_estimate_output_fee_estimate"]),
+
+        } as CoopExitFeeEstimateOutput;
+
+}
+export const CoopExitFeeEstimateOutputToJson = (obj: CoopExitFeeEstimateOutput): any => {
+return {
+coop_exit_fee_estimate_output_fee_estimate: CurrencyAmountToJson(obj.feeEstimate),
+
+        }
+
+}
+
+
+    export const FRAGMENT = `
+fragment CoopExitFeeEstimateOutputFragment on CoopExitFeeEstimateOutput {
+    __typename
+    coop_exit_fee_estimate_output_fee_estimate: fee_estimate {
+        __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 CoopExitFeeEstimateOutput;

package/src/graphql/objects/CoopExitRequest.ts

@@ -0,0 +1,118 @@
+
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+import Entity from './Entity.js';
+import {CurrencyAmountToJson} from './CurrencyAmount.js';
+import {CurrencyAmountFromJson} from './CurrencyAmount.js';
+import SparkCoopExitRequestStatus from './SparkCoopExitRequestStatus.js';
+import CurrencyAmount from './CurrencyAmount.js';
+import { Query, isObject } from '@lightsparkdev/core';
+
+
+interface CoopExitRequest {
+
+
+    /**
+ * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
+ * string.
+**/
+id: string;
+
+    /** The date and time when the entity was first created. **/
+createdAt: string;
+
+    /** The date and time when the entity was last updated. **/
+updatedAt: string;
+
+    /**
+ * The fee includes what user pays for the coop exit and the L1 broadcast fee. The amount user will
+ * receive on L1 is total_amount - fee.
+**/
+fee: CurrencyAmount;
+
+    /** The status of the request. **/
+status: SparkCoopExitRequestStatus;
+
+    /** The time when the coop exit request expires and the UTXOs are released. **/
+expiresAt: string;
+
+    /** The raw connector transaction. **/
+rawConnectorTransaction: string;
+
+    /** The typename of the object **/
+typename: string;
+
+
+
+
+}
+
+export const CoopExitRequestFromJson = (obj: any): CoopExitRequest => {
+    return {
+        id: obj["coop_exit_request_id"],
+        createdAt: obj["coop_exit_request_created_at"],
+        updatedAt: obj["coop_exit_request_updated_at"],
+        fee: CurrencyAmountFromJson(obj["coop_exit_request_fee"]),
+        status: SparkCoopExitRequestStatus[obj["coop_exit_request_status"]] ?? SparkCoopExitRequestStatus.FUTURE_VALUE,
+        expiresAt: obj["coop_exit_request_expires_at"],
+        rawConnectorTransaction: obj["coop_exit_request_raw_connector_transaction"],
+typename: "CoopExitRequest",
+        } as CoopExitRequest;
+
+}
+export const CoopExitRequestToJson = (obj: CoopExitRequest): any => {
+return {
+__typename: "CoopExitRequest",coop_exit_request_id: obj.id,
+coop_exit_request_created_at: obj.createdAt,
+coop_exit_request_updated_at: obj.updatedAt,
+coop_exit_request_fee: CurrencyAmountToJson(obj.fee),
+coop_exit_request_status: obj.status,
+coop_exit_request_expires_at: obj.expiresAt,
+coop_exit_request_raw_connector_transaction: obj.rawConnectorTransaction,
+
+        }
+
+}
+
+
+    export const FRAGMENT = `
+fragment CoopExitRequestFragment on CoopExitRequest {
+    __typename
+    coop_exit_request_id: id
+    coop_exit_request_created_at: created_at
+    coop_exit_request_updated_at: updated_at
+    coop_exit_request_fee: fee {
+        __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
+    }
+    coop_exit_request_status: status
+    coop_exit_request_expires_at: expires_at
+    coop_exit_request_raw_connector_transaction: raw_connector_transaction
+}`;
+
+
+
+    export const getCoopExitRequestQuery = (id: string): Query<CoopExitRequest> => {
+        return {
+            queryPayload: `
+query GetCoopExitRequest($id: ID!) {
+    entity(id: $id) {
+        ... on CoopExitRequest {
+            ...CoopExitRequestFragment
+        }
+    }
+}
+
+${FRAGMENT}    
+`,
+            variables: {id},
+            constructObject: (data: unknown) => isObject(data) && "entity" in data && isObject(data.entity) ? CoopExitRequestFromJson(data.entity) : null,
+        }
+    }
+
+
+export default CoopExitRequest;

package/src/graphql/objects/CurrencyAmount.ts

@@ -0,0 +1,74 @@
+
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+
+import CurrencyUnit from './CurrencyUnit.js';
+
+/** This object represents the value and unit for an amount of currency. **/
+interface CurrencyAmount {
+
+
+    /** The original numeric value for this CurrencyAmount. **/
+originalValue: number;
+
+    /** The original unit of currency for this CurrencyAmount. **/
+originalUnit: CurrencyUnit;
+
+    /** The unit of user's preferred currency. **/
+preferredCurrencyUnit: CurrencyUnit;
+
+    /**
+ * The rounded numeric value for this CurrencyAmount in the very base level of user's preferred
+ * currency. For example, for USD, the value will be in cents.
+**/
+preferredCurrencyValueRounded: number;
+
+    /**
+ * The approximate float value for this CurrencyAmount in the very base level of user's preferred
+ * currency. For example, for USD, the value will be in cents.
+**/
+preferredCurrencyValueApprox: number;
+
+
+
+
+}
+
+export const CurrencyAmountFromJson = (obj: any): CurrencyAmount => {
+    return {
+        originalValue: obj["currency_amount_original_value"],
+        originalUnit: CurrencyUnit[obj["currency_amount_original_unit"]] ?? CurrencyUnit.FUTURE_VALUE,
+        preferredCurrencyUnit: CurrencyUnit[obj["currency_amount_preferred_currency_unit"]] ?? CurrencyUnit.FUTURE_VALUE,
+        preferredCurrencyValueRounded: obj["currency_amount_preferred_currency_value_rounded"],
+        preferredCurrencyValueApprox: obj["currency_amount_preferred_currency_value_approx"],
+
+        } as CurrencyAmount;
+
+}
+export const CurrencyAmountToJson = (obj: CurrencyAmount): any => {
+return {
+currency_amount_original_value: obj.originalValue,
+currency_amount_original_unit: obj.originalUnit,
+currency_amount_preferred_currency_unit: obj.preferredCurrencyUnit,
+currency_amount_preferred_currency_value_rounded: obj.preferredCurrencyValueRounded,
+currency_amount_preferred_currency_value_approx: obj.preferredCurrencyValueApprox,
+
+        }
+
+}
+
+
+    export const FRAGMENT = `
+fragment CurrencyAmountFragment on CurrencyAmount {
+    __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 CurrencyAmount;

package/src/graphql/objects/CurrencyUnit.ts

@@ -0,0 +1,32 @@
+
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+/** This enum identifies the unit of currency associated with a CurrencyAmount. **/
+export enum CurrencyUnit { 
+/**
+ * This is an enum value that represents values that could be added in the future.
+ * Clients should support unknown values as more of them could be added without notice.
+ */
+ FUTURE_VALUE = "FUTURE_VALUE",
+/** Bitcoin is the cryptocurrency native to the Bitcoin network. It is used as the native medium for value transfer for the Lightning Network. **/
+BITCOIN = "BITCOIN",
+/** 0.00000001 (10e-8) Bitcoin or one hundred millionth of a Bitcoin. This is the unit most commonly used in Lightning transactions. **/
+SATOSHI = "SATOSHI",
+/** 0.001 Satoshi, or 10e-11 Bitcoin. We recommend using the Satoshi unit instead when possible. **/
+MILLISATOSHI = "MILLISATOSHI",
+/** United States Dollar. **/
+USD = "USD",
+/** Mexican Peso. **/
+MXN = "MXN",
+/** Philippine Peso. **/
+PHP = "PHP",
+/** 0.000000001 (10e-9) Bitcoin or a billionth of a Bitcoin. We recommend using the Satoshi unit instead when possible. **/
+NANOBITCOIN = "NANOBITCOIN",
+/** 0.000001 (10e-6) Bitcoin or a millionth of a Bitcoin. We recommend using the Satoshi unit instead when possible. **/
+MICROBITCOIN = "MICROBITCOIN",
+/** 0.001 (10e-3) Bitcoin or a thousandth of a Bitcoin. We recommend using the Satoshi unit instead when possible. **/
+MILLIBITCOIN = "MILLIBITCOIN",
+
+}
+
+export default CurrencyUnit;

package/src/graphql/objects/Entity.ts

@@ -0,0 +1,202 @@
+
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+
+import { Query, isObject } from '@lightsparkdev/core';
+
+/** This interface is used by all the entities in the Lightspark system. It defines a few core fields that are available everywhere. Any object that implements this interface can be queried using the `entity` query and its ID. **/
+interface Entity {
+
+
+    /**
+ * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
+ * string.
+**/
+id: string;
+
+    /** The date and time when the entity was first created. **/
+createdAt: string;
+
+    /** The date and time when the entity was last updated. **/
+updatedAt: string;
+
+    /** The typename of the object **/
+typename: string;
+
+
+
+
+}
+
+
+
+
+
+    export const FRAGMENT = `
+fragment EntityFragment on Entity {
+    __typename
+    ... on CoopExitRequest {
+        __typename
+        coop_exit_request_id: id
+        coop_exit_request_created_at: created_at
+        coop_exit_request_updated_at: updated_at
+        coop_exit_request_fee: fee {
+            __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
+        }
+        coop_exit_request_status: status
+        coop_exit_request_expires_at: expires_at
+        coop_exit_request_raw_connector_transaction: raw_connector_transaction
+    }
+    ... on LeavesSwapRequest {
+        __typename
+        leaves_swap_request_id: id
+        leaves_swap_request_created_at: created_at
+        leaves_swap_request_updated_at: updated_at
+        leaves_swap_request_status: status
+        leaves_swap_request_total_amount: total_amount {
+            __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
+        }
+        leaves_swap_request_target_amount: target_amount {
+            __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
+        }
+        leaves_swap_request_fee: fee {
+            __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
+        }
+        leaves_swap_request_inbound_transfer: inbound_transfer {
+            __typename
+            transfer_total_amount: total_amount {
+                __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
+            }
+            transfer_spark_id: spark_id
+        }
+        leaves_swap_request_outbound_transfer: outbound_transfer {
+            __typename
+            transfer_total_amount: total_amount {
+                __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
+            }
+            transfer_spark_id: spark_id
+        }
+        leaves_swap_request_expires_at: expires_at
+        leaves_swap_request_swap_leaves: swap_leaves {
+            __typename
+            swap_leaf_leaf_id: leaf_id
+            swap_leaf_raw_unsigned_refund_transaction: raw_unsigned_refund_transaction
+            swap_leaf_adaptor_signed_signature: adaptor_signed_signature
+        }
+    }
+    ... on LightningReceiveRequest {
+        __typename
+        lightning_receive_request_id: id
+        lightning_receive_request_created_at: created_at
+        lightning_receive_request_updated_at: updated_at
+        lightning_receive_request_invoice: invoice {
+            __typename
+            invoice_encoded_envoice: encoded_envoice
+            invoice_bitcoin_network: bitcoin_network
+            invoice_payment_hash: payment_hash
+            invoice_amount: amount {
+                __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
+            }
+            invoice_created_at: created_at
+            invoice_expires_at: expires_at
+            invoice_memo: memo
+        }
+        lightning_receive_request_fee: fee {
+            __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
+        }
+        lightning_receive_request_status: status
+        lightning_receive_request_transfer: transfer {
+            __typename
+            transfer_total_amount: total_amount {
+                __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
+            }
+            transfer_spark_id: spark_id
+        }
+    }
+    ... on LightningSendRequest {
+        __typename
+        lightning_send_request_id: id
+        lightning_send_request_created_at: created_at
+        lightning_send_request_updated_at: updated_at
+        lightning_send_request_encoded_invoice: encoded_invoice
+        lightning_send_request_fee: fee {
+            __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
+        }
+        lightning_send_request_idempotency_key: idempotency_key
+        lightning_send_request_status: status
+        lightning_send_request_transfer: transfer {
+            __typename
+            transfer_total_amount: total_amount {
+                __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
+            }
+            transfer_spark_id: spark_id
+        }
+    }
+    ... on SparkWalletUser {
+        __typename
+        spark_wallet_user_id: id
+        spark_wallet_user_created_at: created_at
+        spark_wallet_user_updated_at: updated_at
+        spark_wallet_user_identity_public_key: identity_public_key
+    }
+}`;
+
+
+
+
+export default Entity;

package/src/graphql/objects/GetChallengeInput.ts

@@ -0,0 +1,37 @@
+
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+
+
+
+
+interface GetChallengeInput {
+
+
+    publicKey: string;
+
+
+
+
+}
+
+export const GetChallengeInputFromJson = (obj: any): GetChallengeInput => {
+    return {
+        publicKey: obj["get_challenge_input_public_key"],
+
+        } as GetChallengeInput;
+
+}
+export const GetChallengeInputToJson = (obj: GetChallengeInput): any => {
+return {
+get_challenge_input_public_key: obj.publicKey,
+
+        }
+
+}
+
+
+
+
+
+export default GetChallengeInput;

package/src/graphql/objects/GetChallengeOutput.ts

@@ -0,0 +1,43 @@
+
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+
+
+
+
+interface GetChallengeOutput {
+
+
+    protectedChallenge: string;
+
+
+
+
+}
+
+export const GetChallengeOutputFromJson = (obj: any): GetChallengeOutput => {
+    return {
+        protectedChallenge: obj["get_challenge_output_protected_challenge"],
+
+        } as GetChallengeOutput;
+
+}
+export const GetChallengeOutputToJson = (obj: GetChallengeOutput): any => {
+return {
+get_challenge_output_protected_challenge: obj.protectedChallenge,
+
+        }
+
+}
+
+
+    export const FRAGMENT = `
+fragment GetChallengeOutputFragment on GetChallengeOutput {
+    __typename
+    get_challenge_output_protected_challenge: protected_challenge
+}`;
+
+
+
+
+export default GetChallengeOutput;