@lightsparkdev/lightspark-sdk 0.4.10 → 1.0.0

package/src/objects/RegisterPaymentOutput.ts

@@ -0,0 +1,23 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+type RegisterPaymentOutput = {
+  paymentId: string;
+};
+
+export const RegisterPaymentOutputFromJson = (
+  obj: any,
+): RegisterPaymentOutput => {
+  return {
+    paymentId: obj["register_payment_output_payment"].id,
+  } as RegisterPaymentOutput;
+};
+
+export const FRAGMENT = `
+fragment RegisterPaymentOutputFragment on RegisterPaymentOutput {
+    __typename
+    register_payment_output_payment: payment {
+        id
+    }
+}`;
+
+export default RegisterPaymentOutput;

package/src/objects/ReleaseChannelPerCommitmentSecretInput.ts

@@ -0,0 +1,23 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+type ReleaseChannelPerCommitmentSecretInput = {
+  channelId: string;
+
+  perCommitmentSecret: string;
+
+  perCommitmentIndex: number;
+};
+
+export const ReleaseChannelPerCommitmentSecretInputFromJson = (
+  obj: any,
+): ReleaseChannelPerCommitmentSecretInput => {
+  return {
+    channelId: obj["release_channel_per_commitment_secret_input_channel_id"],
+    perCommitmentSecret:
+      obj["release_channel_per_commitment_secret_input_per_commitment_secret"],
+    perCommitmentIndex:
+      obj["release_channel_per_commitment_secret_input_per_commitment_index"],
+  } as ReleaseChannelPerCommitmentSecretInput;
+};
+
+export default ReleaseChannelPerCommitmentSecretInput;

package/src/objects/ReleaseChannelPerCommitmentSecretOutput.ts

@@ -0,0 +1,23 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+type ReleaseChannelPerCommitmentSecretOutput = {
+  channelId: string;
+};
+
+export const ReleaseChannelPerCommitmentSecretOutputFromJson = (
+  obj: any,
+): ReleaseChannelPerCommitmentSecretOutput => {
+  return {
+    channelId: obj["release_channel_per_commitment_secret_output_channel"].id,
+  } as ReleaseChannelPerCommitmentSecretOutput;
+};
+
+export const FRAGMENT = `
+fragment ReleaseChannelPerCommitmentSecretOutputFragment on ReleaseChannelPerCommitmentSecretOutput {
+    __typename
+    release_channel_per_commitment_secret_output_channel: channel {
+        id
+    }
+}`;
+
+export default ReleaseChannelPerCommitmentSecretOutput;

package/src/objects/ReleasePaymentPreimageInput.ts

@@ -0,0 +1,20 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+type ReleasePaymentPreimageInput = {
+  /** The invoice the preimage belongs to. **/
+  invoiceId: string;
+
+  /** The preimage to release. **/
+  paymentPreimage: string;
+};
+
+export const ReleasePaymentPreimageInputFromJson = (
+  obj: any,
+): ReleasePaymentPreimageInput => {
+  return {
+    invoiceId: obj["release_payment_preimage_input_invoice_id"],
+    paymentPreimage: obj["release_payment_preimage_input_payment_preimage"],
+  } as ReleasePaymentPreimageInput;
+};
+
+export default ReleasePaymentPreimageInput;

package/src/objects/ReleasePaymentPreimageOutput.ts

@@ -0,0 +1,23 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+type ReleasePaymentPreimageOutput = {
+  invoiceId: string;
+};
+
+export const ReleasePaymentPreimageOutputFromJson = (
+  obj: any,
+): ReleasePaymentPreimageOutput => {
+  return {
+    invoiceId: obj["release_payment_preimage_output_invoice"].id,
+  } as ReleasePaymentPreimageOutput;
+};
+
+export const FRAGMENT = `
+fragment ReleasePaymentPreimageOutputFragment on ReleasePaymentPreimageOutput {
+    __typename
+    release_payment_preimage_output_invoice: invoice {
+        id
+    }
+}`;
+
+export default ReleasePaymentPreimageOutput;

package/src/objects/RemoteSigningSubEventType.ts

@@ -0,0 +1,26 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+/** This is an enum of the potential sub-event types for Remote Signing webook events. **/
+export enum RemoteSigningSubEventType {
+  /**
+   * 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",
+
+  ECDH = "ECDH",
+
+  GET_PER_COMMITMENT_POINT = "GET_PER_COMMITMENT_POINT",
+
+  RELEASE_PER_COMMITMENT_SECRET = "RELEASE_PER_COMMITMENT_SECRET",
+
+  SIGN_INVOICE = "SIGN_INVOICE",
+
+  DERIVE_KEY_AND_SIGN = "DERIVE_KEY_AND_SIGN",
+
+  RELEASE_PAYMENT_PREIMAGE = "RELEASE_PAYMENT_PREIMAGE",
+
+  REQUEST_INVOICE_PAYMENT_HASH = "REQUEST_INVOICE_PAYMENT_HASH",
+}
+
+export default RemoteSigningSubEventType;

package/src/objects/RequestWithdrawalInput.ts

@@ -20,7 +20,7 @@ type RequestWithdrawalInput = {
 };
 
 export const RequestWithdrawalInputFromJson = (
-  obj: any
+  obj: any,
 ): RequestWithdrawalInput => {
   return {
     nodeId: obj["request_withdrawal_input_node_id"],

package/src/objects/RequestWithdrawalOutput.ts

@@ -6,7 +6,7 @@ type RequestWithdrawalOutput = {
 };
 
 export const RequestWithdrawalOutputFromJson = (
-  obj: any
+  obj: any,
 ): RequestWithdrawalOutput => {
   return {
     requestId: obj["request_withdrawal_output_request"].id,

package/src/objects/RoutingTransaction.ts

@@ -130,7 +130,7 @@ fragment RoutingTransactionFragment on RoutingTransaction {
 }`;
 
 export const getRoutingTransactionQuery = (
-  id: string
+  id: string,
 ): Query<RoutingTransaction> => {
   return {
     queryPayload: `

package/src/objects/ScreenNodeInput.ts

@@ -0,0 +1,20 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+import ComplianceProvider from "./ComplianceProvider.js";
+
+type ScreenNodeInput = {
+  provider: ComplianceProvider;
+
+  nodePubkey: string;
+};
+
+export const ScreenNodeInputFromJson = (obj: any): ScreenNodeInput => {
+  return {
+    provider:
+      ComplianceProvider[obj["screen_node_input_provider"]] ??
+      ComplianceProvider.FUTURE_VALUE,
+    nodePubkey: obj["screen_node_input_node_pubkey"],
+  } as ScreenNodeInput;
+};
+
+export default ScreenNodeInput;

package/src/objects/ScreenNodeOutput.ts

@@ -0,0 +1,22 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+import RiskRating from "./RiskRating.js";
+
+type ScreenNodeOutput = {
+  rating: RiskRating;
+};
+
+export const ScreenNodeOutputFromJson = (obj: any): ScreenNodeOutput => {
+  return {
+    rating:
+      RiskRating[obj["screen_node_output_rating"]] ?? RiskRating.FUTURE_VALUE,
+  } as ScreenNodeOutput;
+};
+
+export const FRAGMENT = `
+fragment ScreenNodeOutputFragment on ScreenNodeOutput {
+    __typename
+    screen_node_output_rating: rating
+}`;
+
+export default ScreenNodeOutput;

package/src/objects/SetInvoicePaymentHashInput.ts

@@ -0,0 +1,24 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+type SetInvoicePaymentHashInput = {
+  /** The invoice that needs to be updated. **/
+  invoiceId: string;
+
+  /** The 32-byte hash of the payment preimage. **/
+  paymentHash: string;
+
+  /** The 32-byte nonce used to generate the invoice preimage. **/
+  preimageNonce: string;
+};
+
+export const SetInvoicePaymentHashInputFromJson = (
+  obj: any,
+): SetInvoicePaymentHashInput => {
+  return {
+    invoiceId: obj["set_invoice_payment_hash_input_invoice_id"],
+    paymentHash: obj["set_invoice_payment_hash_input_payment_hash"],
+    preimageNonce: obj["set_invoice_payment_hash_input_preimage_nonce"],
+  } as SetInvoicePaymentHashInput;
+};
+
+export default SetInvoicePaymentHashInput;

package/src/objects/SetInvoicePaymentHashOutput.ts

@@ -0,0 +1,23 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+type SetInvoicePaymentHashOutput = {
+  invoiceId: string;
+};
+
+export const SetInvoicePaymentHashOutputFromJson = (
+  obj: any,
+): SetInvoicePaymentHashOutput => {
+  return {
+    invoiceId: obj["set_invoice_payment_hash_output_invoice"].id,
+  } as SetInvoicePaymentHashOutput;
+};
+
+export const FRAGMENT = `
+fragment SetInvoicePaymentHashOutputFragment on SetInvoicePaymentHashOutput {
+    __typename
+    set_invoice_payment_hash_output_invoice: invoice {
+        id
+    }
+}`;
+
+export default SetInvoicePaymentHashOutput;

package/src/objects/SignInvoiceInput.ts

@@ -0,0 +1,19 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+type SignInvoiceInput = {
+  invoiceId: string;
+
+  signature: string;
+
+  recoveryId: number;
+};
+
+export const SignInvoiceInputFromJson = (obj: any): SignInvoiceInput => {
+  return {
+    invoiceId: obj["sign_invoice_input_invoice_id"],
+    signature: obj["sign_invoice_input_signature"],
+    recoveryId: obj["sign_invoice_input_recovery_id"],
+  } as SignInvoiceInput;
+};
+
+export default SignInvoiceInput;

package/src/objects/SignInvoiceOutput.ts

@@ -0,0 +1,21 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+type SignInvoiceOutput = {
+  invoiceId: string;
+};
+
+export const SignInvoiceOutputFromJson = (obj: any): SignInvoiceOutput => {
+  return {
+    invoiceId: obj["sign_invoice_output_invoice"].id,
+  } as SignInvoiceOutput;
+};
+
+export const FRAGMENT = `
+fragment SignInvoiceOutputFragment on SignInvoiceOutput {
+    __typename
+    sign_invoice_output_invoice: invoice {
+        id
+    }
+}`;
+
+export default SignInvoiceOutput;

package/src/objects/SignMessagesInput.ts

@@ -0,0 +1,18 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+import type IdAndSignature from "./IdAndSignature.js";
+import { IdAndSignatureFromJson } from "./IdAndSignature.js";
+
+type SignMessagesInput = {
+  signatures: IdAndSignature[];
+};
+
+export const SignMessagesInputFromJson = (obj: any): SignMessagesInput => {
+  return {
+    signatures: obj["sign_messages_input_signatures"].map((e) =>
+      IdAndSignatureFromJson(e),
+    ),
+  } as SignMessagesInput;
+};
+
+export default SignMessagesInput;

package/src/objects/SignMessagesOutput.ts

@@ -0,0 +1,26 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+import type SignablePayload from "./SignablePayload.js";
+import { SignablePayloadFromJson } from "./SignablePayload.js";
+
+type SignMessagesOutput = {
+  signedPayloads: SignablePayload[];
+};
+
+export const SignMessagesOutputFromJson = (obj: any): SignMessagesOutput => {
+  return {
+    signedPayloads: obj["sign_messages_output_signed_payloads"].map((e) =>
+      SignablePayloadFromJson(e),
+    ),
+  } as SignMessagesOutput;
+};
+
+export const FRAGMENT = `
+fragment SignMessagesOutputFragment on SignMessagesOutput {
+    __typename
+    sign_messages_output_signed_payloads: signed_payloads {
+        id
+    }
+}`;
+
+export default SignMessagesOutput;

package/src/objects/Signable.ts

@@ -0,0 +1,58 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+import { type Query } from "@lightsparkdev/core";
+import type Entity from "./Entity.js";
+
+type Signable = 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 SignableFromJson = (obj: any): Signable => {
+  return {
+    id: obj["signable_id"],
+    createdAt: obj["signable_created_at"],
+    updatedAt: obj["signable_updated_at"],
+    typename: "Signable",
+  } as Signable;
+};
+
+export const FRAGMENT = `
+fragment SignableFragment on Signable {
+    __typename
+    signable_id: id
+    signable_created_at: created_at
+    signable_updated_at: updated_at
+}`;
+
+export const getSignableQuery = (id: string): Query<Signable> => {
+  return {
+    queryPayload: `
+query GetSignable($id: ID!) {
+    entity(id: $id) {
+        ... on Signable {
+            ...SignableFragment
+        }
+    }
+}
+
+${FRAGMENT}    
+`,
+    variables: { id },
+    constructObject: (data: any) => SignableFromJson(data.entity),
+  };
+};
+
+export default Signable;

package/src/objects/SignablePayload.ts

@@ -0,0 +1,93 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+import { type Query } from "@lightsparkdev/core";
+import type Entity from "./Entity.js";
+import SignablePayloadStatus from "./SignablePayloadStatus.js";
+
+type SignablePayload = 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 payload that needs to be signed. **/
+  payload: string;
+
+  /** The consistent method for generating the same set of accounts and wallets for a given private key **/
+  derivationPath: string;
+
+  /** The status of the payload. **/
+  status: SignablePayloadStatus;
+
+  /** The signable this payload belongs to. **/
+  signableId: string;
+
+  /** The typename of the object **/
+  typename: string;
+
+  /** The tweak value to add. **/
+  addTweak?: string;
+
+  /** The tweak value to multiply. **/
+  mulTweak?: string;
+};
+
+export const SignablePayloadFromJson = (obj: any): SignablePayload => {
+  return {
+    id: obj["signable_payload_id"],
+    createdAt: obj["signable_payload_created_at"],
+    updatedAt: obj["signable_payload_updated_at"],
+    payload: obj["signable_payload_payload"],
+    derivationPath: obj["signable_payload_derivation_path"],
+    status:
+      SignablePayloadStatus[obj["signable_payload_status"]] ??
+      SignablePayloadStatus.FUTURE_VALUE,
+    signableId: obj["signable_payload_signable"].id,
+    typename: "SignablePayload",
+    addTweak: obj["signable_payload_add_tweak"],
+    mulTweak: obj["signable_payload_mul_tweak"],
+  } as SignablePayload;
+};
+
+export const FRAGMENT = `
+fragment SignablePayloadFragment on SignablePayload {
+    __typename
+    signable_payload_id: id
+    signable_payload_created_at: created_at
+    signable_payload_updated_at: updated_at
+    signable_payload_payload: payload
+    signable_payload_derivation_path: derivation_path
+    signable_payload_status: status
+    signable_payload_add_tweak: add_tweak
+    signable_payload_mul_tweak: mul_tweak
+    signable_payload_signable: signable {
+        id
+    }
+}`;
+
+export const getSignablePayloadQuery = (id: string): Query<SignablePayload> => {
+  return {
+    queryPayload: `
+query GetSignablePayload($id: ID!) {
+    entity(id: $id) {
+        ... on SignablePayload {
+            ...SignablePayloadFragment
+        }
+    }
+}
+
+${FRAGMENT}    
+`,
+    variables: { id },
+    constructObject: (data: any) => SignablePayloadFromJson(data.entity),
+  };
+};
+
+export default SignablePayload;

package/src/objects/SignablePayloadStatus.ts

@@ -0,0 +1,17 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+export enum SignablePayloadStatus {
+  /**
+   * 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",
+
+  CREATED = "CREATED",
+
+  SIGNED = "SIGNED",
+
+  VALIDATION_FAILED = "VALIDATION_FAILED",
+}
+
+export default SignablePayloadStatus;

package/src/objects/SingleNodeDashboard.ts

@@ -1,6 +1,5 @@
 import type { Maybe } from "@lightsparkdev/core";
 import type CurrencyAmount from "./CurrencyAmount.js";
-import type LightsparkNodePurpose from "./LightsparkNodePurpose.js";
 import type LightsparkNodeStatus from "./LightsparkNodeStatus.js";
 import type NodeAddressType from "./NodeAddressType.js";
 import type Transaction from "./Transaction.js";
@@ -8,7 +7,6 @@ import type Transaction from "./Transaction.js";
 type SingleNodeDashboard = {
   id: string;
   displayName: string;
-  purpose: Maybe<LightsparkNodePurpose>;
   color: Maybe<string>;
   publicKey: Maybe<string>;
   status: Maybe<LightsparkNodeStatus>;