Enhanced ChatGPT Clone: Features Agents, MCP, Skills, DeepSeek, Anthropic, AWS, OpenAI, Responses API, Azure, Groq, o1, GPT-5, Mistral, OpenRouter, Vertex AI, Gemini, Artifacts, AI model switching, message search, Code Interpreter, langchain, DALL-E-3, OpenAPI Actions, Functions, Secure Multi-User Auth, Presets, open-source for self-hosting. Active
TypeScript aianthropicartifactsawsazurechatgptchatgpt-cloneclaudeclonedeepseekgeminigooglegpt-5librechatmcpo1openairesponses-apivisionwebui
import type { TxData, TransactionResult } from './transaction';
import logger from '~/config/winston';
/** Base transaction context passed by callers — does not include fields added internally */
export interface SpendTxData {
user: string | import('mongoose').Types.ObjectId;
conversationId?: string;
model?: string;
context?: string;
endpointTokenConfig?: Record<string, Record<string, number>> | null;
balance?: { enabled?: boolean };
transactions?: { enabled?: boolean };
valueKey?: string;
}
export function createSpendTokensMethods(
_mongoose: typeof import('mongoose'),
transactionMethods: {
createTransaction: (txData: TxData) => Promise<TransactionResult | undefined>;
createStructuredTransaction: (txData: TxData) => Promise<TransactionResult | undefined>;
},
): {
spendTokens: (
txData: SpendTxData,
tokenUsage: { promptTokens?: number; completionTokens?: number },
) => Promise<void>;
spendStructuredTokens: (
txData: SpendTxData,
tokenUsage: {
promptTokens?: { input?: number; write?: number; write1h?: number; read?: number };
completionTokens?: number;
},
) => Promise<{
prompt: TransactionResult | undefined;
completion: TransactionResult | undefined;
}>;
} {
/**
* Creates up to two transactions to record the spending of tokens.
*/
async function spendTokens(
txData: SpendTxData,
tokenUsage: { promptTokens?: number; completionTokens?: number },
): Promise<void> {
const { promptTokens, completionTokens } = tokenUsage;
logger.debug(
`[spendTokens] conversationId: ${txData.conversationId}${
txData?.context ? ` | Context: ${txData?.context}` : ''
} | Token usage: `,
{ promptTokens, completionTokens },
);
let prompt: TransactionResult | undefined, completion: TransactionResult | undefined;
const normalizedPromptTokens = Math.max(promptTokens ?? 0, 0);
try {
if (promptTokens !== undefined) {
prompt = await transactionMethods.createTransaction({
...txData,
tokenType: 'prompt',
rawAmount: promptTokens === 0 ? 0 : -normalizedPromptTokens,
inputTokenCount: normalizedPromptTokens,
});
}
if (completionTokens !== undefined) {
completion = await transactionMethods.createTransaction({
...txData,
tokenType: 'completion',
rawAmount: completionTokens === 0 ? 0 : -Math.max(completionTokens, 0),
inputTokenCount: normalizedPromptTokens,
});
}
if (prompt || completion) {
logger.debug('[spendTokens] Transaction data record against balance:', {
user: txData.user,
prompt: prompt?.prompt,
promptRate: prompt?.rate,
completion: completion?.completion,
completionRate: completion?.rate,
balance: completion?.balance ?? prompt?.balance,
});
} else {
logger.debug('[spendTokens] No transactions incurred against balance');
}
} catch (err) {
logger.error('[spendTokens]', err);
}
}
/**
* Creates transactions to record the spending of structured tokens.
*/
async function spendStructuredTokens(
txData: SpendTxData,
tokenUsage: {
promptTokens?: { input?: number; write?: number; write1h?: number; read?: number };
completionTokens?: number;
},
): Promise<{
prompt: TransactionResult | undefined;
completion: TransactionResult | undefined;
}> {
const { promptTokens, completionTokens } = tokenUsage;
logger.debug(
`[spendStructuredTokens] conversationId: ${txData.conversationId}${
txData?.context ? ` | Context: ${txData?.context}` : ''
} | Token usage: `,
{ promptTokens, completionTokens },
);
let prompt: TransactionResult | undefined, completion: TransactionResult | undefined;
try {
if (promptTokens) {
const input = Math.max(promptTokens.input ?? 0, 0);
const write = Math.max(promptTokens.write ?? 0, 0);
const write1h = Math.min(Math.max(promptTokens.write1h ?? 0, 0), write);
const read = Math.max(promptTokens.read ?? 0, 0);
const totalInputTokens = input + write + read;
prompt = await transactionMethods.createStructuredTransaction({
...txData,
tokenType: 'prompt',
inputTokens: -input,
writeTokens: -write,
...(write1h > 0 && { write1hTokens: -write1h }),
readTokens: -read,
inputTokenCount: totalInputTokens,
});
}
if (completionTokens) {
const totalInputTokens = promptTokens
? Math.max(promptTokens.input ?? 0, 0) +
Math.max(promptTokens.write ?? 0, 0) +
Math.max(promptTokens.read ?? 0, 0)
: undefined;
completion = await transactionMethods.createTransaction({
...txData,
tokenType: 'completion',
rawAmount: -Math.max(completionTokens, 0),
inputTokenCount: totalInputTokens,
});
}
if (prompt || completion) {
logger.debug('[spendStructuredTokens] Transaction data record against balance:', {
user: txData.user,
prompt: prompt?.prompt,
promptRate: prompt?.rate,
completion: completion?.completion,
completionRate: completion?.rate,
balance: completion?.balance ?? prompt?.balance,
});
} else {
logger.debug('[spendStructuredTokens] No transactions incurred against balance');
}
} catch (err) {
logger.error('[spendStructuredTokens]', err);
}
return { prompt, completion };
}
return { spendTokens, spendStructuredTokens };
}
export type SpendTokensMethods = ReturnType<typeof createSpendTokensMethods>;