astra-lightning 1.1.3 → 1.1.4

package/lnd_methods/offchain/decode_asset_pay_req.d.ts

@@ -1,57 +1,98 @@
 import {
-  AuthenticatedLndClient,
-  AuthenticatedTprClient,
-  DecimalDisplay,
-  PaymentRequestDetails,
+  AuthenticatedLightningMethod,
+  LightningError,
 } from '../../typescript';
 
+/** Arguments for decodeAssetPayReq */
 export type DecodeAssetPayReqArgs = {
-  /** Asset ID Hex String */
-  asset_id: string;
-  /** Authenticated LND API Object */
-  lnd?: AuthenticatedLndClient;
+  /** Asset ID Hex String (mutually exclusive with group_key) */
+  asset_id?: string;
+  /** Group Key Hex String (mutually exclusive with asset_id) */
+  group_key?: string;
   /** BOLT 11 Payment Request String */
   pay_req_string: string;
+  /** Price Oracle Metadata JSON String */
+  price_oracle_metadata?: string;
   /** Authenticated TPR API Object */
-  tpr: AuthenticatedTprClient;
+  tpr: any;
+};
+
+/** Decimal display configuration */
+export type DecimalDisplay = {
+  /** Decimal Display Value */
+  decimal_display: number;
 };
 
+/** Asset group information from taprpc.AssetGroup */
 export type AssetGroup = {
-  /** Asset ID Hex Strings */
-  asset_ids: string[];
-  /** Tweaked Group Key String */
-  tweaked: string;
+  /** Raw Group Key Hex String */
+  raw_group_key?: string;
+  /** Tweaked Group Key Hex String */
+  tweaked_group_key?: string;
+  /** Asset Witness Hex String */
+  asset_witness?: string;
+  /** Tapscript Root Hex String */
+  tapscript_root?: string;
 };
 
+/** Asset type enum */
+export type AssetType = 'NORMAL' | 'COLLECTIBLE';
+
+/** Genesis information from taprpc.GenesisInfo */
 export type GenesisInfo = {
-  /** Asset ID Hex String */
-  asset_id: string;
+  /** Genesis Point (txid:vout) */
+  genesis_point: string;
+  /** Asset Name */
+  name: string;
   /** Meta Hash Hex String */
-  meta_hash: string;
+  meta_hash?: string;
+  /** Asset ID Hex String */
+  asset_id?: string;
+  /** Asset Type */
+  asset_type?: AssetType;
+  /** Output Index */
+  output_index?: number;
 };
 
+/** LND PayReq object from lnrpc.PayReq */
+export type PayReq = {
+  destination?: string;
+  payment_hash?: string;
+  num_satoshis?: string;
+  timestamp?: string;
+  expiry?: string;
+  description?: string;
+  description_hash?: string;
+  fallback_addr?: string;
+  cltv_expiry?: string;
+  route_hints?: any[];
+  payment_addr?: string;
+  num_msat?: string;
+  features?: Record<string, any>;
+};
+
+/** Result of decodeAssetPayReq */
 export type DecodeAssetPayReqResult = {
-  /** Invoice Amount in Asset Units Number */
-  asset_amount: number;
+  /** Invoice Amount in Asset Units (uint64 as string) */
+  asset_amount: string;
+  /** Decimal Display Configuration */
+  decimal_display?: DecimalDisplay;
   /** Asset Group Information */
   asset_group?: AssetGroup;
-  /** Decimal Display Configuration */
-  decimal_display: DecimalDisplay;
-  /** Genesis Information */
+  /** Genesis Information (only set when decoded with asset_id, not group_key) */
   genesis_info?: GenesisInfo;
-  /** Payment Request Details */
-  pay_req: PaymentRequestDetails;
+  /** LND PayReq Object */
+  pay_req: PayReq;
 };
 
 /**
  * Decode an asset payment request
  *
+ * Either `asset_id` or `group_key` is required (mutually exclusive)
+ *
  * Requires `offchain:read` permission
  */
-export declare const decodeAssetPayReq: (
+export const decodeAssetPayReq: (
   args: DecodeAssetPayReqArgs,
-  cbk?: (
-    err: Error | null,
-    result: DecodeAssetPayReqResult,
-  ) => void,
+  cbk?: (err: LightningError | null, result?: DecodeAssetPayReqResult) => void,
 ) => Promise<DecodeAssetPayReqResult>; 

package/lnd_methods/offchain/decode_asset_pay_req.js

@@ -1,78 +1,64 @@
 const asyncAuto = require('async/auto');
 const {returnResult} = require('asyncjs-util');
 
-const hexAsBuffer = (hex) => (!!hex ? Buffer.from(hex, "hex") : undefined);
-const bufferAsHex = (buffer) => (!!buffer ? buffer.toString("hex") : undefined);
+const bufferAsHex = buffer => !!buffer ? buffer.toString('hex') : undefined;
+const hexAsBuffer = hex => !!hex ? Buffer.from(hex, 'hex') : undefined;
 
 /** Decode an asset payment request
-  
+
   Requires `offchain:read` permission
 
+  Either `asset_id` or `group_key` is required (mutually exclusive)
+
   {
-    asset_id: <Asset ID Hex String>
-    lnd: <Authenticated LND API Object>
+    [asset_id]: <Asset ID Hex String>
+    [group_key]: <Group Key Hex String>
     pay_req_string: <BOLT 11 Payment Request String>
+    [price_oracle_metadata]: <Price Oracle Metadata JSON String>
     tpr: <Authenticated TPR API Object>
   }
 
   @returns via cbk or Promise
   {
-    asset_amount: <Invoice Amount in Asset Units Number>
-    asset_group: {
-      asset_ids: [<Asset Id Hex String>]
-      tweaked: <Tweaked Group Key String>
+    asset_amount: <Invoice Amount in Asset Units String>
+    [asset_group]: {
+      raw_group_key: <Raw Group Key Hex String>
+      tweaked_group_key: <Tweaked Group Key Hex String>
+      [asset_witness]: <Asset Witness Hex String>
+      [tapscript_root]: <Tapscript Root Hex String>
     }
-    decimal_display: {
-      decimal_places: <Amount in Decimal Places for Asset String>
-      type: <Asset Type String>
-      units: <Asset Unit Label String>
+    [decimal_display]: {
+      decimal_display: <Decimal Display Number>
     }
-    genesis_info: {
-      asset_id: <Asset ID Hex String>
+    [genesis_info]: {
+      genesis_point: <Genesis Point String>
+      name: <Asset Name String>
       meta_hash: <Meta Hash Hex String>
+      asset_id: <Asset ID Hex String>
+      asset_type: <Asset Type String>
+      output_index: <Output Index Number>
     }
-    pay_req: {
-      chain_address: <Fallback Chain Address String>
-      [cltv_delta]: <Final CLTV Delta Number>
-      created_at: <Payment Request Created At ISO 8601 Date String>
-      description: <Payment Description String>
-      description_hash: <Payment Longer Description Hash Hex String>
-      destination: <Public Key Hex String>
-      expires_at: <ISO 8601 Date String>
-      features: [{
-        bit: <BOLT 09 Feature Bit Number>
-        is_known: <Feature is Known Bool>
-        is_required: <Feature Support is Required To Pay Bool>
-        type: <Feature Type String>
-      }]
-      id: <Payment Hash Hex String>
-      is_expired: <Invoice is Expired Bool>
-      mtokens: <Requested Millitokens String>
-      [payment]: <Payment Identifier Hex Encoded String>
-      routes: [[{
-        [base_fee_mtokens]: <Base Routing Fee In Millitokens String>
-        [channel]: <Standard Format Channel Id String>
-        [cltv_delta]: <CLTV Blocks Delta Number>
-        [fee_rate]: <Fee Rate In Millitokens Per Million Number>
-        public_key: <Forward Edge Public Key Hex String>
-      }]]
-      safe_tokens: <Requested Tokens Rounded Up Number>
-      tokens: <Requested Tokens Rounded Down Number>
-    }
+    pay_req: <LND PayReq Object>
   }
 */
-module.exports = ({asset_id, pay_req_string, tpr}, cbk) => {
+module.exports = (args, cbk) => {
   return new Promise((resolve, reject) => {
     return asyncAuto({
       // Check arguments
       validate: cbk => {
-        if (!asset_id) {
-          return cbk([400, 'ExpectedAssetIdToDecodeAssetPayReq']);
+        if (!args.asset_id && !args.group_key) {
+          return cbk([400, 'ExpectedAssetIdOrGroupKeyToDecodeAssetPayReq']);
         }
-        if (!pay_req_string) {
+
+        if (!!args.asset_id && !!args.group_key) {
+          return cbk([400, 'ExpectedEitherAssetIdOrGroupKeyNotBoth']);
+        }
+
+        if (!args.pay_req_string) {
           return cbk([400, 'ExpectedPaymentRequestStringToDecodeAssetPayReq']);
         }
-        if (!tpr) {
+
+        if (!args.tpr) {
           return cbk([400, 'ExpectedTprToDecodeAssetPayReq']);
         }
 
@@ -80,12 +66,14 @@ module.exports = ({asset_id, pay_req_string, tpr}, cbk) => {
       },
 
       // Decode asset payment request
-      decode: ['validate', ({}, cbk) => {     
-        return tpr.taproot_asset_channels.decodeAssetPayReq({
-          asset_id: hexAsBuffer(asset_id),
-          pay_req_string: pay_req_string,
-        }, (err, res) => {
-        
+      decode: ['validate', ({}, cbk) => {
+        return args.tpr.taproot_asset_channels.decodeAssetPayReq({
+          asset_id: hexAsBuffer(args.asset_id),
+          group_key: hexAsBuffer(args.group_key),
+          pay_req_string: args.pay_req_string,
+          price_oracle_metadata: args.price_oracle_metadata || undefined,
+        },
+        (err, res) => {
           if (!!err) {
             return cbk([503, 'UnexpectedDecodeAssetPayReqError', {err}]);
           }
@@ -94,26 +82,31 @@ module.exports = ({asset_id, pay_req_string, tpr}, cbk) => {
             return cbk([503, 'ExpectedResponseFromDecodeAssetPayReq']);
           }
 
-          // Format the response
           const response = {
             asset_amount: res.asset_amount,
-            decimal_display: res.decimal_display,
+            decimal_display: res.decimal_display || undefined,
             pay_req: res.pay_req,
           };
 
-          // Add asset group if exists
+          // Add asset group if present
           if (!!res.asset_group) {
             response.asset_group = {
-              asset_ids: res.asset_group.asset_ids?.map(id => bufferAsHex(id)) || [],
-              tweaked: res.asset_group.tweaked ? bufferAsHex(res.asset_group.tweaked):null,
+              raw_group_key: bufferAsHex(res.asset_group.raw_group_key),
+              tweaked_group_key: bufferAsHex(res.asset_group.tweaked_group_key),
+              asset_witness: bufferAsHex(res.asset_group.asset_witness),
+              tapscript_root: bufferAsHex(res.asset_group.tapscript_root),
             };
           }
 
-          // Add genesis info if exists
+          // Add genesis info if present
           if (!!res.genesis_info) {
             response.genesis_info = {
-              asset_id: bufferAsHex(res.genesis_info.asset_id),
+              genesis_point: res.genesis_info.genesis_point,
+              name: res.genesis_info.name,
               meta_hash: bufferAsHex(res.genesis_info.meta_hash),
+              asset_id: bufferAsHex(res.genesis_info.asset_id),
+              asset_type: res.genesis_info.asset_type,
+              output_index: res.genesis_info.output_index,
             };
           }
 

package/lnd_methods/offchain/get_pending_channels.d.ts

@@ -69,6 +69,10 @@ export type GetPendingChannelsResult = {
     transaction_weight?: number;
     /** Channel Commitment Transaction Type */
     type?: string;
+    /** Funding Seen At Best Block Height */
+    opening_funding_height?: number;
+    /** Open Activation Waiting Blocks Count */
+    opening_waiting_blocks?: number;
   }[];
 };
 
@@ -79,6 +83,18 @@ export type GetPendingChannelsResult = {
 channel may be opening, closing, or active.
  * 
  * Requires `offchain:read` permission
+ * 
+ * `is_private` is not supported in LND 0.14.5 or before
+ *
+ * `description` is not supported in LND 0.16.4 or before
+ *
+ * `blocks_until_expiry` is not supported in LND 0.16.4 or before
+ *
+ * `close_transaction` is not supported in LND 0.17.5 or before
+ *
+ * `opening_funding_height` is not supported in LND 0.19.3 or before
+ *
+ * `opening_waiting_blocks` is not supported in LND 0.19.3 or before
  */
 export const getPendingChannels: AuthenticatedLightningMethod<
   {lnd: AuthenticatedLnd},

package/lnd_methods/offchain/get_pending_channels.js

@@ -25,6 +25,10 @@ const type = 'default';
 
   `close_transaction` is not supported in LND 0.17.5 or before
 
+  `opening_funding_height` is not supported in LND 0.19.3 or before
+
+  `opening_waiting_blocks` is not supported in LND 0.19.3 or before
+
   {
     lnd: <Authenticated LND API Object>
   }
@@ -45,6 +49,8 @@ const type = 'default';
       is_timelocked: <Channel Local Funds Constrained by Timelock Script Bool>
       local_balance: <Channel Local Tokens Balance Number>
       local_reserve: <Channel Local Reserved Tokens Number>
+      [opening_funding_height]: <Funding Seen At Best Block Height Number>
+      [opening_waiting_blocks]: <Open Activation Waiting Blocks Count Number>
       partner_public_key: <Channel Peer Public Key String>
       [pending_balance]: <Tokens Pending Recovery Number>
       [pending_payments]: [{

package/lnd_methods/offchain/get_routing_fee_estimate.d.ts

@@ -0,0 +1,32 @@
+import {AuthenticatedLnd} from '../../lnd_grpc';
+import {
+    AuthenticatedLightningArgs,
+    AuthenticatedLightningMethod
+} from '../../typescript';
+
+export type GetRoutingFeeEstimateRequest = AuthenticatedLightningArgs<{
+    lnd: AuthenticatedLnd;
+    /** BOLT 11 Encoded Payment Request */
+    request: string;
+    /** Optional Timeout in Milliseconds */
+    timeout?: number;
+}>;
+
+export type GetRoutingFeeEstimateResponse = {
+    /** (Minimum Routing Fee Millitokens) */
+    fee_mtokens: string;
+    /** Timeout (Time Lock Delay) */
+    timeout: number;
+};
+
+/**
+ * Estimate routing fees based on an invoice.
+ *
+ * Requires `offchain:read` permission
+ *
+ * This method is not supported before LND 0.18.4
+ */
+export const getRoutingFeeEstimate: AuthenticatedLightningMethod<
+  GetRoutingFeeEstimateRequest,
+  GetRoutingFeeEstimateResponse
+>;

package/lnd_methods/offchain/get_routing_fee_estimate.js

@@ -0,0 +1,86 @@
+const asyncAuto = require('async/auto');
+const {returnResult} = require('asyncjs-util');
+
+const {isLnd} = require('./../../lnd_requests');
+
+const defaultTimeoutSeconds = 60;
+const method = 'estimateRouteFee';
+const msAsSecs = ms => Math.round(ms / 1e3);
+const type = 'router';
+
+/** Estimate routing fees and timeout required to pay a payment request
+
+  Requires `offchain:read` permission
+
+  This method is not supported on LND 0.18.3 and below
+
+ {
+    lnd: <Authenticated LND API Object>
+    request: <BOLT 11 Payment Request String>
+    [timeout]: <Maximum Route Pathfinding Time in Milliseconds Number>
+  }
+
+  @returns via cbk or Promise
+  {
+    fee_mtokens: <Estimated Minimum Required Route Fee Millitokens String>
+    timeout: <Estimated Minimum Time Lock Block Height Delay Number>
+  }
+*/
+module.exports = ({lnd, request, timeout}, cbk) => {
+  return new Promise((resolve, reject) => {
+    return asyncAuto({
+      // Check arguments
+      validate: cbk => {
+        if (!isLnd({lnd, method, type})) {
+          return cbk([400, 'ExpectedAuthenticatedLndToGetRoutingFeeEstimate']);
+        }
+
+        if (!request) {
+          return cbk([400, 'ExpectedPaymentRequestToGetRoutingFeeEstimate']);
+        }
+
+        return cbk();
+      },
+
+      // Request a probe of the request to determine a needed fee and delay
+      getEstimate: ['validate', ({}, cbk) => {
+        return lnd[type][method]({
+          payment_request: request,
+          timeout: msAsSecs(timeout) || defaultTimeoutSeconds,
+        },
+        (err, res) => {
+          if (!!err) {
+            return cbk([503, 'UnexpectedGetRoutingFeeEstimateError', {err}]);
+          }
+
+          if (!res) {
+            return cbk([503, 'ExpectedGetRoutingFeeEstimateResponse']);
+          }
+
+          if (!res.routing_fee_msat) {
+            return cbk([503, 'ExpectedFeeInGetRoutingFeeEstimateResponse']);
+          }
+
+          if (!res.time_lock_delay) {
+            return cbk([503, 'ExpectedTimeoutInGetRouteFeeEstimateResponse']);
+          }
+
+          // Exit early with error when the estimate response has failure code
+          if (res.failure_reason !== 'FAILURE_REASON_NONE') {
+            return cbk([
+              404,
+              'RouteToDestinationNotFound',
+              {failure: res.failure_reason},
+            ]);
+          }
+
+          return cbk(null, {
+            fee_mtokens: res.routing_fee_msat,
+            timeout: Number(res.time_lock_delay),
+          });
+        });
+      }],
+    },
+    returnResult({reject, resolve, of: 'getEstimate'}, cbk));
+  });
+};

package/lnd_methods/offchain/index.d.ts

@@ -1,60 +1,60 @@
-export * from "./connect_watchtower";
-export * from "./decode_asset_pay_req";
-export * from "./decode_payment_request";
-export * from "./delete_failed_pay_attempts";
-export * from "./delete_failed_payments";
-export * from "./delete_forwarding_reputations";
-export * from "./delete_payment";
-export * from "./delete_payments";
-export * from "./delete_pending_channel";
-export * from "./disable_channel";
-export * from "./disconnect_watchtower";
-export * from "./enable_channel";
-export * from "./get_backup";
-export * from "./get_backups";
-export * from "./get_channel_balance";
-export * from "./get_channels";
-export * from "./get_closed_channels";
-export * from "./get_connected_watchtowers";
-export * from "./get_ephemeral_channel_ids";
-export * from "./get_failed_payments";
-export * from "./get_fee_rates";
-export * from "./get_forwarding_confidence";
-export * from "./get_forwarding_reputations";
-export * from "./get_forwards";
-export * from "./get_pathfinding_settings";
-export * from "./get_payment";
-export * from "./get_payments";
-export * from "./get_pending_channels";
-export * from "./get_pending_payments";
-export * from "./get_route_through_hops";
-export * from "./get_settlement_status";
-export * from "./is_destination_payable";
-export * from "./pay_via_payment_details";
-export * from "./pay_via_payment_request";
-export * from "./pay_via_routes";
-export * from "./pay";
-export * from "./pay_taproot_invoice";
-export * from "./probe_for_route";
-export * from "./recover_funds_from_channel";
-export * from "./recover_funds_from_channels";
-export * from "./send_message_to_peer";
-export * from "./subscribe_to_backups";
-export * from "./subscribe_to_channels";
-export * from "./subscribe_to_forward_requests";
-export * from "./subscribe_to_forwards";
-export * from "./subscribe_to_open_requests";
-export * from "./subscribe_to_past_payment";
-export * from "./subscribe_to_past_payments";
-export * from "./subscribe_to_pay_via_details";
-export * from "./subscribe_to_pay_via_request";
-export * from "./subscribe_to_pay_via_routes";
-export * from "./subscribe_to_payments";
-export * from "./subscribe_to_peer_messages";
-export * from "./subscribe_to_probe_for_route";
-export * from "./update_connected_watchtower";
-export * from "./update_pathfinding_settings";
-export * from "./update_routing_fees";
-export * from "./verify_backup";
-export * from "./verify_backups";
-export * from "./decode_asset_pay_req";
+export * from './connect_watchtower';
+export * from './decode_payment_request';
+export * from './delete_failed_pay_attempts';
+export * from './delete_failed_payments';
+export * from './delete_forwarding_reputations';
+export * from './delete_payment';
+export * from './delete_payments';
+export * from './delete_pending_channel';
+export * from './disable_channel';
+export * from './disconnect_watchtower';
+export * from './enable_channel';
+export * from './get_backup';
+export * from './get_backups';
+export * from './get_channel_balance';
+export * from './get_channels';
+export * from './get_closed_channels';
+export * from './get_connected_watchtowers';
+export * from './get_ephemeral_channel_ids';
+export * from './get_failed_payments';
+export * from './get_fee_rates';
+export * from './get_forwarding_confidence';
+export * from './get_forwarding_reputations';
+export * from './get_forwards';
+export * from './get_pathfinding_settings';
+export * from './get_payment';
+export * from './get_payments';
+export * from './get_pending_channels';
+export * from './get_pending_payments';
+export * from './get_route_through_hops';
+export * from './get_routing_fee_estimate';
+export * from './get_settlement_status';
+export * from './is_destination_payable';
+export * from './pay_via_payment_details';
+export * from './pay_via_payment_request';
+export * from './pay_via_routes';
+export * from './pay';
+export * from './probe_for_route';
+export * from './recover_funds_from_channel';
+export * from './recover_funds_from_channels';
+export * from './send_message_to_peer';
+export * from './subscribe_to_backups';
+export * from './subscribe_to_channels';
+export * from './subscribe_to_forward_requests';
+export * from './subscribe_to_forwards';
+export * from './subscribe_to_open_requests';
+export * from './subscribe_to_past_payment';
+export * from './subscribe_to_past_payments';
+export * from './subscribe_to_pay_via_details';
+export * from './subscribe_to_pay_via_request';
+export * from './subscribe_to_pay_via_routes';
+export * from './subscribe_to_payments';
+export * from './subscribe_to_peer_messages';
+export * from './subscribe_to_probe_for_route';
+export * from './update_connected_watchtower';
+export * from './update_pathfinding_settings';
+export * from './update_routing_fees';
+export * from './verify_backup';
+export * from './verify_backups';
+export * from './decode_asset_pay_req';
+export * from './pay_taproot_invoice';

package/lnd_methods/offchain/index.js

@@ -1,5 +1,4 @@
 const connectWatchtower = require('./connect_watchtower');
-const decodeAssetPayReq = require('./decode_asset_pay_req');
 const decodePaymentRequest = require('./decode_payment_request');
 const deleteFailedPayAttempts = require('./delete_failed_pay_attempts');
 const deleteFailedPayments = require('./delete_failed_payments');
@@ -28,10 +27,10 @@ const getPayments = require('./get_payments');
 const getPendingChannels = require('./get_pending_channels');
 const getPendingPayments = require('./get_pending_payments');
 const getRouteThroughHops = require('./get_route_through_hops');
+const getRoutingFeeEstimate = require('./get_routing_fee_estimate');
 const getSettlementStatus = require('./get_settlement_status');
 const isDestinationPayable = require('./is_destination_payable');
 const pay = require('./pay');
-const payTaprootInvoice = require('./pay_taproot_invoice');
 const payViaPaymentDetails = require('./pay_via_payment_details');
 const payViaPaymentRequest = require('./pay_via_payment_request');
 const payViaRoutes = require('./pay_via_routes');
@@ -57,10 +56,11 @@ const updatePathfindingSettings = require('./update_pathfinding_settings');
 const updateRoutingFees = require('./update_routing_fees');
 const verifyBackup = require('./verify_backup');
 const verifyBackups = require('./verify_backups');
+const decodeAssetPayReq = require('./decode_asset_pay_req');
+const payTaprootInvoice = require('./pay_taproot_invoice');
 
 module.exports = {
   connectWatchtower,
-  decodeAssetPayReq,
   decodePaymentRequest,
   deleteFailedPayAttempts,
   deleteFailedPayments,
@@ -89,10 +89,10 @@ module.exports = {
   getPendingChannels,
   getPendingPayments,
   getRouteThroughHops,
+  getRoutingFeeEstimate,
   getSettlementStatus,
   isDestinationPayable,
   pay,
-  payTaprootInvoice,
   payViaPaymentDetails,
   payViaPaymentRequest,
   payViaRoutes,
@@ -118,4 +118,6 @@ module.exports = {
   updateRoutingFees,
   verifyBackup,
   verifyBackups,
+  decodeAssetPayReq,
+  payTaprootInvoice,
 };

package/lnd_methods/offchain/pay_via_routes.d.ts

@@ -46,10 +46,14 @@ export type PayViaRoutesArgs = AuthenticatedLightningArgs<{
     }[];
     /** Total Millitokens To Pay */
     mtokens: string;
+    /** Payment Identifier Hex */
+    payment?: string;
     /** Expiration Block Height */
     timeout: number;
     /** Total Tokens To Pay */
     tokens: number;
+    /** Total Millitokens */
+    total_mtokens?: string;
   }[];
 }>;