@buildonspark/spark-sdk 0.1.41 → 0.1.43

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@buildonspark/spark-sdk",
-  "version": "0.1.41",
+  "version": "0.1.43",
   "author": "",
   "license": "Apache-2.0",
   "main": "./dist/index.js",
@@ -140,7 +140,7 @@
     "prettier": "^3.5.1",
     "publint": "^0.3.9",
     "react": "19.0.0",
-    "react-native": "^0.79.2",
+    "react-native": "0.79.4",
     "react-native-get-random-values": "^1.11.0",
     "ts-jest": "^29.2.5",
     "tsup": "^8.4.0",
@@ -149,8 +149,8 @@
   "dependencies": {
     "@bitcoinerlab/secp256k1": "^1.1.1",
     "@bufbuild/protobuf": "^2.2.5",
-    "@buildonspark/lrc20-sdk": "0.0.57",
-    "@lightsparkdev/core": "^1.4.1",
+    "@buildonspark/lrc20-sdk": "0.0.58",
+    "@lightsparkdev/core": "^1.4.2",
     "@noble/curves": "^1.8.0",
     "@noble/hashes": "^1.7.1",
     "@opentelemetry/api": "^1.9.0",

package/src/constants.ts

@@ -1,4 +1,25 @@
+import { isNode } from "@lightsparkdev/core";
+
 export const isReactNative =
   typeof navigator !== "undefined" && navigator.product === "ReactNative";
 
 export const isBun = globalThis.Bun !== undefined;
+
+declare const __PACKAGE_VERSION__: string;
+
+export const packageVersion =
+  typeof __PACKAGE_VERSION__ !== "undefined" ? __PACKAGE_VERSION__ : "unknown";
+
+let baseEnvStr = "unknown";
+if (isNode) {
+  baseEnvStr = `node/${process.version}`;
+} else if (isReactNative) {
+  baseEnvStr = "react-native";
+} else {
+  const userAgent =
+    (typeof navigator !== "undefined" && navigator.userAgent) ||
+    "unknown-user-agent";
+  baseEnvStr = `browser/${userAgent}`;
+}
+
+export const clientEnv = `js-spark-sdk/${packageVersion} ${baseEnvStr}`;

package/src/errors/base.ts

@@ -1,3 +1,5 @@
+import { bytesToHex } from "@noble/hashes/utils";
+
 export class SparkSDKError extends Error {
   public readonly context: Record<string, unknown>;
   public readonly originalError?: Error;
@@ -45,7 +47,7 @@ function getMessage(
   originalError?: Error,
 ) {
   const contextStr = Object.entries(context)
-    .map(([key, value]) => `${key}: ${JSON.stringify(value)}`)
+    .map(([key, value]) => `${key}: ${safeStringify(value)}`)
     .join(", ");
 
   const originalErrorStr = originalError
@@ -54,3 +56,43 @@ function getMessage(
 
   return `SparkSDKError: ${message}${contextStr ? `\nContext: ${contextStr}` : ""}${originalErrorStr}`;
 }
+
+function safeStringify(value: unknown): string {
+  const replacer = (_: string, v: unknown) => {
+    /* Handle BigInt explicitly because JSON.stringify throws a TypeError when encountering it at any depth. */
+    if (typeof v === "bigint") {
+      return v.toString();
+    }
+    if (v instanceof Uint8Array) {
+      return formatUint8Array(v);
+    }
+    return v;
+  };
+
+  /* If the value itself is a BigInt (top-level), stringify will still throw, so convert beforehand. */
+  if (typeof value === "bigint") {
+    return `"${value.toString()}"`;
+  }
+
+  /* Format Uint8Array as hex instead of record */
+  if (value instanceof Uint8Array) {
+    return `"${formatUint8Array(value)}"`;
+  }
+
+  try {
+    const result = JSON.stringify(value, replacer);
+    /* JSON.stringify returns undefined for unsupported types like undefined, function, or symbol.
+       In those cases, fall back to String(value) for a more informative output. */
+    return result === undefined ? String(value) : result;
+  } catch {
+    try {
+      return String(value);
+    } catch {
+      return "[Unserializable]";
+    }
+  }
+}
+
+function formatUint8Array(arr: Uint8Array): string {
+  return `Uint8Array(0x${bytesToHex(arr)})`;
+}

package/src/graphql/client.ts

@@ -169,11 +169,13 @@ export default class SspClient {
 
   async getLightningSendFeeEstimate(
     encodedInvoice: string,
+    amountSats?: number,
   ): Promise<LightningSendFeeEstimateOutput | null> {
     return await this.executeRawQuery({
       queryPayload: LightningSendFeeEstimate,
       variables: {
         encoded_invoice: encodedInvoice,
+        amount_sats: amountSats,
       },
       constructObject: (response: { lightning_send_fee_estimate: any }) => {
         return LightningSendFeeEstimateOutputFromJson(
@@ -276,12 +278,14 @@ export default class SspClient {
   async requestLightningSend({
     encodedInvoice,
     idempotencyKey,
+    amountSats,
   }: RequestLightningSendInput): Promise<LightningSendRequest | null> {
     return await this.executeRawQuery({
       queryPayload: RequestLightningSend,
       variables: {
         encoded_invoice: encodedInvoice,
         idempotency_key: idempotencyKey,
+        amount_sats: amountSats,
       },
       constructObject: (response: { request_lightning_send: any }) => {
         return LightningSendRequestFromJson(

package/src/graphql/mutations/RequestLightningSend.ts

@@ -3,10 +3,12 @@ export const RequestLightningSend = `
   mutation RequestLightningSend(
     $encoded_invoice: String!
     $idempotency_key: String!
+    $amount_sats: Long
   ) {
     request_lightning_send(input: {
       encoded_invoice: $encoded_invoice
       idempotency_key: $idempotency_key
+      amount_sats: $amount_sats
     }) {
       request {
         ...LightningSendRequestFragment

package/src/graphql/objects/ClaimStaticDepositInput.ts

@@ -2,8 +2,8 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
 
-import ClaimStaticDepositRequestType from './ClaimStaticDepositRequestType.js';
 import BitcoinNetwork from './BitcoinNetwork.js';
+import ClaimStaticDepositRequestType from './ClaimStaticDepositRequestType.js';
 
 
 interface ClaimStaticDepositInput {

package/src/graphql/objects/ClaimStaticDepositStatus.ts

@@ -21,10 +21,12 @@ REFUND_SIGNING_FAILED = "REFUND_SIGNING_FAILED",
 
 UTXO_SWAPPING_FAILED = "UTXO_SWAPPING_FAILED",
 
-TRANSFER_FAILED = "TRANSFER_FAILED",
-
 TRANSFER_COMPLETED = "TRANSFER_COMPLETED",
 
+SPEND_TX_CREATED = "SPEND_TX_CREATED",
+
+SPEND_TX_BROADCAST = "SPEND_TX_BROADCAST",
+
 }
 
 export default ClaimStaticDepositStatus;

package/src/graphql/objects/Connection.ts

@@ -2,16 +2,16 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
 
-import SparkWalletUserToUserRequestsConnection from './SparkWalletUserToUserRequestsConnection.js';
-import { LightsparkException } from '@lightsparkdev/core';
-import {PageInfoToJson} from './PageInfo.js';
+import {UserRequestFromJson} from './UserRequest.js';
+import PageInfo from './PageInfo.js';
 import {PageInfoFromJson} from './PageInfo.js';
 import {LeafFromJson} from './Leaf.js';
-import PageInfo from './PageInfo.js';
-import {LeafToJson} from './Leaf.js';
-import SparkTransferToLeavesConnection from './SparkTransferToLeavesConnection.js';
+import { LightsparkException } from '@lightsparkdev/core';
+import SparkWalletUserToUserRequestsConnection from './SparkWalletUserToUserRequestsConnection.js';
+import {PageInfoToJson} from './PageInfo.js';
 import {UserRequestToJson} from './UserRequest.js';
-import {UserRequestFromJson} from './UserRequest.js';
+import SparkTransferToLeavesConnection from './SparkTransferToLeavesConnection.js';
+import {LeafToJson} from './Leaf.js';
 
 
 interface Connection {

package/src/graphql/objects/CoopExitFeeEstimate.ts

@@ -2,9 +2,9 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
 
+import CurrencyAmount from './CurrencyAmount.js';
 import {CurrencyAmountFromJson} from './CurrencyAmount.js';
 import {CurrencyAmountToJson} from './CurrencyAmount.js';
-import CurrencyAmount from './CurrencyAmount.js';
 
 
 interface CoopExitFeeEstimate {

package/src/graphql/objects/CoopExitFeeQuote.ts

@@ -0,0 +1,202 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+import { Query, isObject } from "@lightsparkdev/core";
+import BitcoinNetwork from "./BitcoinNetwork.js";
+import CurrencyAmount, {
+  CurrencyAmountFromJson,
+  CurrencyAmountToJson,
+} from "./CurrencyAmount.js";
+
+interface CoopExitFeeQuote {
+  /**
+   * 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 network the coop exit fee quote is on. **/
+  network: BitcoinNetwork;
+
+  /** The total currency amount of all the nodes user swapped for the coop exit quote. **/
+  totalAmount: CurrencyAmount;
+
+  /** The fee user pays for the coop exit not including the L1 broadcast fee when exit speed is fast. **/
+  userFeeFast: CurrencyAmount;
+
+  /** The fee user pays for the coop exit not including the L1 broadcast fee when exit speed is medium. **/
+  userFeeMedium: CurrencyAmount;
+
+  /** The fee user pays for the coop exit not including the L1 broadcast fee when exit speed is slow. **/
+  userFeeSlow: CurrencyAmount;
+
+  /** The L1 broadcast fee user pays for the coop exit when exit speed is fast. **/
+  l1BroadcastFeeFast: CurrencyAmount;
+
+  /** The L1 broadcast fee user pays for the coop exit when exit speed is medium. **/
+  l1BroadcastFeeMedium: CurrencyAmount;
+
+  /** The L1 broadcast fee user pays for the coop exit when exit speed is slow. **/
+  l1BroadcastFeeSlow: CurrencyAmount;
+
+  /** The time when the coop exit fee quote expires. **/
+  expiresAt: string;
+
+  /** The typename of the object **/
+  typename: string;
+}
+
+export const CoopExitFeeQuoteFromJson = (obj: any): CoopExitFeeQuote => {
+  return {
+    id: obj["coop_exit_fee_quote_id"],
+    createdAt: obj["coop_exit_fee_quote_created_at"],
+    updatedAt: obj["coop_exit_fee_quote_updated_at"],
+    network:
+      BitcoinNetwork[obj["coop_exit_fee_quote_network"]] ??
+      BitcoinNetwork.FUTURE_VALUE,
+    totalAmount: CurrencyAmountFromJson(
+      obj["coop_exit_fee_quote_total_amount"],
+    ),
+    userFeeFast: CurrencyAmountFromJson(
+      obj["coop_exit_fee_quote_user_fee_fast"],
+    ),
+    userFeeMedium: CurrencyAmountFromJson(
+      obj["coop_exit_fee_quote_user_fee_medium"],
+    ),
+    userFeeSlow: CurrencyAmountFromJson(
+      obj["coop_exit_fee_quote_user_fee_slow"],
+    ),
+    l1BroadcastFeeFast: CurrencyAmountFromJson(
+      obj["coop_exit_fee_quote_l1_broadcast_fee_fast"],
+    ),
+    l1BroadcastFeeMedium: CurrencyAmountFromJson(
+      obj["coop_exit_fee_quote_l1_broadcast_fee_medium"],
+    ),
+    l1BroadcastFeeSlow: CurrencyAmountFromJson(
+      obj["coop_exit_fee_quote_l1_broadcast_fee_slow"],
+    ),
+    expiresAt: obj["coop_exit_fee_quote_expires_at"],
+    typename: "CoopExitFeeQuote",
+  } as CoopExitFeeQuote;
+};
+export const CoopExitFeeQuoteToJson = (obj: CoopExitFeeQuote): any => {
+  return {
+    __typename: "CoopExitFeeQuote",
+    coop_exit_fee_quote_id: obj.id,
+    coop_exit_fee_quote_created_at: obj.createdAt,
+    coop_exit_fee_quote_updated_at: obj.updatedAt,
+    coop_exit_fee_quote_network: obj.network,
+    coop_exit_fee_quote_total_amount: CurrencyAmountToJson(obj.totalAmount),
+    coop_exit_fee_quote_user_fee_fast: CurrencyAmountToJson(obj.userFeeFast),
+    coop_exit_fee_quote_user_fee_medium: CurrencyAmountToJson(
+      obj.userFeeMedium,
+    ),
+    coop_exit_fee_quote_user_fee_slow: CurrencyAmountToJson(obj.userFeeSlow),
+    coop_exit_fee_quote_l1_broadcast_fee_fast: CurrencyAmountToJson(
+      obj.l1BroadcastFeeFast,
+    ),
+    coop_exit_fee_quote_l1_broadcast_fee_medium: CurrencyAmountToJson(
+      obj.l1BroadcastFeeMedium,
+    ),
+    coop_exit_fee_quote_l1_broadcast_fee_slow: CurrencyAmountToJson(
+      obj.l1BroadcastFeeSlow,
+    ),
+    coop_exit_fee_quote_expires_at: obj.expiresAt,
+  };
+};
+
+export const FRAGMENT = `
+fragment CoopExitFeeQuoteFragment on CoopExitFeeQuote {
+    __typename
+    coop_exit_fee_quote_id: id
+    coop_exit_fee_quote_created_at: created_at
+    coop_exit_fee_quote_updated_at: updated_at
+    coop_exit_fee_quote_network: network
+    coop_exit_fee_quote_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
+    }
+    coop_exit_fee_quote_user_fee_fast: user_fee_fast {
+        __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_fee_quote_user_fee_medium: user_fee_medium {
+        __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_fee_quote_user_fee_slow: user_fee_slow {
+        __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_fee_quote_l1_broadcast_fee_fast: l1_broadcast_fee_fast {
+        __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_fee_quote_l1_broadcast_fee_medium: l1_broadcast_fee_medium {
+        __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_fee_quote_l1_broadcast_fee_slow: l1_broadcast_fee_slow {
+        __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_fee_quote_expires_at: expires_at
+}`;
+
+export const getCoopExitFeeQuoteQuery = (
+  id: string,
+): Query<CoopExitFeeQuote> => {
+  return {
+    queryPayload: `
+query GetCoopExitFeeQuote($id: ID!) {
+    entity(id: $id) {
+        ... on CoopExitFeeQuote {
+            ...CoopExitFeeQuoteFragment
+        }
+    }
+}
+
+${FRAGMENT}    
+`,
+    variables: { id },
+    constructObject: (data: unknown) =>
+      isObject(data) && "entity" in data && isObject(data.entity)
+        ? CoopExitFeeQuoteFromJson(data.entity)
+        : null,
+  };
+};
+
+export default CoopExitFeeQuote;

package/src/graphql/objects/CoopExitFeeQuoteInput.ts

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

package/src/graphql/objects/CoopExitFeeQuoteOutput.ts

@@ -0,0 +1,45 @@
+
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+
+
+
+
+interface CoopExitFeeQuoteOutput {
+
+
+    quoteId: string;
+
+
+
+
+}
+
+export const CoopExitFeeQuoteOutputFromJson = (obj: any): CoopExitFeeQuoteOutput => {
+    return {
+        quoteId: obj["coop_exit_fee_quote_output_quote"].id,
+
+        } as CoopExitFeeQuoteOutput;
+
+}
+export const CoopExitFeeQuoteOutputToJson = (obj: CoopExitFeeQuoteOutput): any => {
+return {
+coop_exit_fee_quote_output_quote: { id: obj.quoteId },
+
+        }
+
+}
+
+
+    export const FRAGMENT = `
+fragment CoopExitFeeQuoteOutputFragment on CoopExitFeeQuoteOutput {
+    __typename
+    coop_exit_fee_quote_output_quote: quote {
+        id
+    }
+}`;
+
+
+
+
+export default CoopExitFeeQuoteOutput;

package/src/graphql/objects/CoopExitRequest.ts

@@ -6,6 +6,7 @@ import CurrencyAmount, {
   CurrencyAmountFromJson,
   CurrencyAmountToJson,
 } from "./CurrencyAmount.js";
+import ExitSpeed from "./ExitSpeed.js";
 import SparkCoopExitRequestStatus from "./SparkCoopExitRequestStatus.js";
 import Transfer, { TransferFromJson } from "./Transfer.js";
 
@@ -49,6 +50,12 @@ interface CoopExitRequest {
   /** The typename of the object **/
   typename: string;
 
+  /** The fee quote user requested for this coop exit. **/
+  feeQuoteId?: string | undefined;
+
+  /** The exit speed user requested for this coop exit. **/
+  exitSpeed?: ExitSpeed | undefined;
+
   /** The swap transfer. **/
   transfer?: Transfer | undefined;
 }
@@ -73,6 +80,11 @@ export const CoopExitRequestFromJson = (obj: any): CoopExitRequest => {
     rawCoopExitTransaction: obj["coop_exit_request_raw_coop_exit_transaction"],
     coopExitTxid: obj["coop_exit_request_coop_exit_txid"],
     typename: "CoopExitRequest",
+    feeQuoteId: obj["coop_exit_request_fee_quote"]?.id ?? undefined,
+    exitSpeed: !!obj["coop_exit_request_exit_speed"]
+      ? (ExitSpeed[obj["coop_exit_request_exit_speed"]] ??
+        ExitSpeed.FUTURE_VALUE)
+      : null,
     transfer: !!obj["coop_exit_request_transfer"]
       ? TransferFromJson(obj["coop_exit_request_transfer"])
       : undefined,
@@ -89,6 +101,8 @@ export const CoopExitRequestToJson = (obj: CoopExitRequest): any => {
     coop_exit_request_l1_broadcast_fee: CurrencyAmountToJson(
       obj.l1BroadcastFee,
     ),
+    coop_exit_request_fee_quote: { id: obj.feeQuoteId },
+    coop_exit_request_exit_speed: obj.exitSpeed,
     coop_exit_request_status: obj.status,
     coop_exit_request_expires_at: obj.expiresAt,
     coop_exit_request_raw_connector_transaction: obj.rawConnectorTransaction,
@@ -123,6 +137,10 @@ fragment CoopExitRequestFragment on CoopExitRequest {
         currency_amount_preferred_currency_value_rounded: preferred_currency_value_rounded
         currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
     }
+    coop_exit_request_fee_quote: fee_quote {
+        id
+    }
+    coop_exit_request_exit_speed: exit_speed
     coop_exit_request_status: status
     coop_exit_request_expires_at: expires_at
     coop_exit_request_raw_connector_transaction: raw_connector_transaction
@@ -139,6 +157,9 @@ fragment CoopExitRequestFragment on CoopExitRequest {
             currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
         }
         transfer_spark_id: spark_id
+        transfer_user_request: user_request {
+            id
+        }
     }
 }`;
 

package/src/graphql/objects/CurrencyUnit.ts

@@ -1,34 +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",
-/** Euro. **/
-EUR = "EUR",
-/** 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 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",
+  /** Euro. **/
+  EUR = "EUR",
+  /** 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;