@gala-chain/launchpad-mcp-server 1.14.1 → 1.14.2

package/src/prompts/utils/workflowTemplates.ts

@@ -0,0 +1,344 @@
+/**
+ * Workflow Template Utilities
+ *
+ * Reusable templates for common workflow patterns in prompts.
+ * Reduces duplication and ensures consistency across slash commands.
+ */
+
+import { MCP_TOOLS } from '../../constants/mcpToolNames.js';
+
+/**
+ * Configuration for trading workflow generation
+ */
+export interface TradingWorkflowConfig {
+  operation: 'buy' | 'sell' | 'graduate';
+  tokenName: string;
+  amount?: string;
+  amountType?: 'gala' | 'tokens';
+  slippage?: string;
+}
+
+/**
+ * Create a complete trading workflow with all standard steps
+ *
+ * @param config - Trading workflow configuration
+ * @returns Formatted workflow text with numbered steps
+ *
+ * @example
+ * ```typescript
+ * const workflow = createTradingWorkflow({
+ *   operation: 'buy',
+ *   tokenName: 'anime',
+ *   amount: '100',
+ *   amountType: 'gala',
+ *   slippage: '1'
+ * });
+ * ```
+ */
+export function createTradingWorkflow(config: TradingWorkflowConfig): string {
+  const { operation, tokenName, amount, amountType, slippage = '1' } = config;
+
+  switch (operation) {
+    case 'buy':
+      return createBuyWorkflow(tokenName, amount!, amountType!, slippage);
+    case 'sell':
+      return createSellWorkflow(tokenName, amount!, slippage);
+    case 'graduate':
+      return createGraduationWorkflow(tokenName, slippage);
+    default:
+      throw new Error(`Unknown operation: ${operation}`);
+  }
+}
+
+/**
+ * Create buy tokens workflow
+ */
+function createBuyWorkflow(
+  tokenName: string,
+  amount: string,
+  amountType: 'gala' | 'tokens',
+  slippage: string
+): string {
+  const slippageFactor = parseFloat(slippage) / 100;
+  const typeParam = amountType === 'gala' ? 'native' : 'exact';
+  const amountLabel = amountType === 'gala' ? 'GALA to spend' : 'Tokens to buy';
+
+  return `Help me buy tokens on Gala Launchpad:
+
+Token: ${tokenName}
+${amountLabel}: ${amount}
+Slippage tolerance: ${slippage}%
+
+Please follow this workflow:
+
+1. Calculate buy amount using ${MCP_TOOLS.CALCULATE_BUY_AMOUNT}:
+   - tokenName: "${tokenName}"
+   - amount: "${amount}"
+   - type: "${typeParam}" (${amountType === 'gala' ? 'spending GALA' : 'buying exact tokens'})
+
+2. Show me the breakdown:
+   - Tokens I'll receive
+   - Transaction fee
+   - Gas fee
+   - Reverse bonding curve fee
+   - Total cost
+
+3. Ask for confirmation before executing
+
+4. If I confirm, execute the buy using ${MCP_TOOLS.BUY_TOKENS} with:
+   - expectedAmount from calculation
+   - maxAcceptableReverseBondingCurveFee from calculation
+   - slippageToleranceFactor: ${slippageFactor}
+
+5. After purchase, show transaction ID and verify balance`;
+}
+
+/**
+ * Create sell tokens workflow
+ */
+function createSellWorkflow(
+  tokenName: string,
+  amount: string,
+  slippage: string
+): string {
+  const slippageFactor = parseFloat(slippage) / 100;
+
+  return `Help me sell tokens on Gala Launchpad:
+
+Token: ${tokenName}
+Tokens to sell: ${amount}
+Slippage tolerance: ${slippage}%
+
+Please follow this workflow:
+
+1. Check my token balance using ${MCP_TOOLS.FETCH_TOKEN_BALANCE}
+
+2. Calculate sell amount using ${MCP_TOOLS.CALCULATE_SELL_AMOUNT}:
+   - tokenName: "${tokenName}"
+   - amount: "${amount}"
+   - type: "exact" (selling exact token amount)
+
+3. Show me the breakdown:
+   - GALA I'll receive
+   - Transaction fee
+   - Gas fee
+   - Reverse bonding curve fee
+   - Net proceeds
+
+4. Ask for confirmation before executing
+
+5. If I confirm, execute the sell using ${MCP_TOOLS.SELL_TOKENS} with:
+   - expectedAmount from calculation
+   - maxAcceptableReverseBondingCurveFee from calculation
+   - slippageToleranceFactor: ${slippageFactor}
+
+6. After sale, show transaction ID and verify updated balance`;
+}
+
+/**
+ * Create token graduation workflow
+ */
+function createGraduationWorkflow(tokenName: string, slippage: string): string {
+  const slippageFactor = parseFloat(slippage) / 100;
+
+  return `Help me graduate the token "${tokenName}" on Gala Launchpad:
+
+Slippage tolerance: ${slippage}%
+
+Please follow this workflow:
+
+1. Check if token is already graduated using ${MCP_TOOLS.FETCH_POOL_DETAILS}
+   - If saleStatus is "Completed", inform me it's already graduated
+
+2. Fetch optimized pool details using ${MCP_TOOLS.FETCH_POOL_DETAILS_FOR_CALCULATION}
+
+3. Calculate graduation cost using ${MCP_TOOLS.CALCULATE_BUY_AMOUNT_FOR_GRADUATION} with:
+   - calculateAmountMode: "local"
+   - currentSupply from pool details
+
+4. Show me the breakdown:
+   - GALA required to graduate: [amount field - this is GALA cost, NOT token quantity!]
+   - Transaction fee
+   - Gas fee
+   - Total cost
+
+5. Check my GALA balance using ${MCP_TOOLS.FETCH_GALA_BALANCE}
+   - Verify I have enough GALA for graduation
+
+6. Ask for confirmation before executing
+
+7. If I confirm, execute graduation using ${MCP_TOOLS.GRADUATE_TOKEN} with:
+   - tokenName: "${tokenName}"
+   - slippageToleranceFactor: ${slippageFactor}
+   - calculateAmountMode: "local"
+   - currentSupply from pool details (optimization!)
+
+8. After graduation:
+   - Show transaction ID
+   - Verify pool status changed to "Completed"
+   - Get frontend URL using ${MCP_TOOLS.GET_URL_BY_TOKEN_NAME}
+
+IMPORTANT: The "amount" field in graduation calculations is GALA cost, not token quantity!`;
+}
+
+/**
+ * Format a list of steps with numbers
+ *
+ * @param steps - Array of step descriptions
+ * @returns Formatted steps with numbering
+ *
+ * @example
+ * ```typescript
+ * formatWorkflowSteps([
+ *   'Fetch pool details',
+ *   'Calculate price',
+ *   'Show results'
+ * ]);
+ * // Returns:
+ * // "1. Fetch pool details
+ * // 2. Calculate price
+ * // 3. Show results"
+ * ```
+ */
+export function formatWorkflowSteps(steps: string[]): string {
+  return steps.map((step, index) => `${index + 1}. ${step}`).join('\n\n');
+}
+
+/**
+ * Create a standard confirmation step for destructive operations
+ *
+ * @param operation - Operation name (e.g., 'buy', 'sell', 'graduate')
+ * @returns Confirmation step text
+ */
+export function createConfirmationStep(operation: string): string {
+  return `Ask for confirmation before executing the ${operation} operation`;
+}
+
+/**
+ * Create a standard verification step after transaction
+ *
+ * @param operation - Operation name
+ * @param verifications - Array of verification checks to perform
+ * @returns Verification step text
+ */
+export function createVerificationStep(
+  operation: string,
+  verifications: string[]
+): string {
+  const checks = verifications
+    .map((check, index) => `   ${String.fromCharCode(97 + index)}. ${check}`)
+    .join('\n');
+
+  return `After ${operation} completes:\n${checks}`;
+}
+
+/**
+ * Create an optimized performance note for LOCAL calculations
+ *
+ * @returns Performance optimization guidance text
+ */
+export function createPerformanceNote(): string {
+  return `Use the performance optimization pattern from SDK v3.9.0 to minimize network calls.`;
+}
+
+/**
+ * Create a cost breakdown display template
+ *
+ * @param operation - Operation type for context
+ * @returns Cost breakdown template text
+ */
+export function createCostBreakdown(operation: 'buy' | 'sell' | 'graduate'): string {
+  switch (operation) {
+    case 'buy':
+      return `Show me the breakdown:
+   - Tokens I'll receive
+   - Transaction fee
+   - Gas fee
+   - Reverse bonding curve fee
+   - Total cost`;
+    case 'sell':
+      return `Show me the breakdown:
+   - GALA I'll receive
+   - Transaction fee
+   - Gas fee
+   - Reverse bonding curve fee
+   - Net proceeds`;
+    case 'graduate':
+      return `Show me the breakdown:
+   - GALA required to graduate
+   - Transaction fee
+   - Gas fee
+   - Total cost`;
+  }
+}
+
+/**
+ * Create a balance check step
+ *
+ * @param assetType - Type of asset to check ('GALA' or token name)
+ * @returns Balance check step text
+ */
+export function createBalanceCheckStep(assetType: 'GALA' | string): string {
+  if (assetType === 'GALA') {
+    return `Check my GALA balance using ${MCP_TOOLS.FETCH_GALA_BALANCE}`;
+  }
+  return `Check my ${assetType} token balance using ${MCP_TOOLS.FETCH_TOKEN_BALANCE}`;
+}
+
+/**
+ * Create analysis workflow for token evaluation
+ *
+ * @param tokenName - Token to analyze
+ * @returns Complete analysis workflow
+ */
+export function createAnalysisWorkflow(tokenName: string): string {
+  return `Analyze the token "${tokenName}" using the Gala Launchpad MCP server:
+
+1. Fetch optimized pool details using ${MCP_TOOLS.FETCH_POOL_DETAILS_FOR_CALCULATION}
+2. Calculate current USD spot price using LOCAL mode with the currentSupply
+3. Calculate graduation cost using LOCAL mode with the currentSupply
+4. Show remaining tokens and pool status (saleStatus)
+5. Calculate pool progress percentage: (currentSupply / maxSupply * 100)
+
+${createPerformanceNote()}
+
+Provide a brief analysis including:
+- Current token price in USD
+- Total GALA required to graduate the pool
+- How close the token is to graduation (percentage)
+- Whether this would be a good time to buy or wait`;
+}
+
+/**
+ * Create portfolio analysis workflow
+ *
+ * @returns Complete portfolio analysis workflow
+ */
+export function createPortfolioWorkflow(): string {
+  return `Analyze my complete Gala Launchpad portfolio:
+
+1. Get GALA balance using ${MCP_TOOLS.FETCH_GALA_BALANCE}
+
+2. Get all tokens I'm holding using ${MCP_TOOLS.FETCH_TOKENS_HELD}
+   - Use pagination if needed to get all tokens
+
+3. For each token, calculate USD value using optimized pattern:
+   a. Fetch pool details once: ${MCP_TOOLS.FETCH_POOL_DETAILS_FOR_CALCULATION}
+   b. Calculate spot price: ${MCP_TOOLS.FETCH_LAUNCHPAD_TOKEN_SPOT_PRICE} with LOCAL mode
+   c. Multiply token balance by spot price for USD value
+
+4. Calculate GALA USD value using ${MCP_TOOLS.FETCH_GALA_SPOT_PRICE}
+
+5. Present a comprehensive portfolio summary:
+   - GALA balance and USD value
+   - Each token holding with:
+     * Token name
+     * Balance
+     * USD spot price
+     * Total USD value
+   - Total portfolio value in USD
+   - Top 3 holdings by value
+   - Number of different tokens held
+
+${createPerformanceNote()}`;
+}