@gala-chain/launchpad-mcp-server 1.4.0 → 1.5.1

package/dist/prompts/utils/workflowTemplates.js

@@ -0,0 +1,315 @@
+"use strict";
+/**
+ * Workflow Template Utilities
+ *
+ * Reusable templates for common workflow patterns in prompts.
+ * Reduces duplication and ensures consistency across slash commands.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createTradingWorkflow = createTradingWorkflow;
+exports.formatWorkflowSteps = formatWorkflowSteps;
+exports.createConfirmationStep = createConfirmationStep;
+exports.createVerificationStep = createVerificationStep;
+exports.createPerformanceNote = createPerformanceNote;
+exports.createCostBreakdown = createCostBreakdown;
+exports.createBalanceCheckStep = createBalanceCheckStep;
+exports.createAnalysisWorkflow = createAnalysisWorkflow;
+exports.createPortfolioWorkflow = createPortfolioWorkflow;
+const mcpToolNames_js_1 = require("../../constants/mcpToolNames.js");
+/**
+ * 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'
+ * });
+ * ```
+ */
+function createTradingWorkflow(config) {
+    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, amount, amountType, slippage) {
+    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 ${mcpToolNames_js_1.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 ${mcpToolNames_js_1.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, amount, slippage) {
+    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 ${mcpToolNames_js_1.MCP_TOOLS.FETCH_TOKEN_BALANCE}
+
+2. Calculate sell amount using ${mcpToolNames_js_1.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 ${mcpToolNames_js_1.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, slippage) {
+    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 ${mcpToolNames_js_1.MCP_TOOLS.FETCH_POOL_DETAILS}
+   - If saleStatus is "Completed", inform me it's already graduated
+
+2. Fetch optimized pool details using ${mcpToolNames_js_1.MCP_TOOLS.FETCH_POOL_DETAILS_FOR_CALCULATION}
+
+3. Calculate graduation cost using ${mcpToolNames_js_1.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 ${mcpToolNames_js_1.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 ${mcpToolNames_js_1.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 ${mcpToolNames_js_1.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"
+ * ```
+ */
+function formatWorkflowSteps(steps) {
+    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
+ */
+function createConfirmationStep(operation) {
+    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
+ */
+function createVerificationStep(operation, verifications) {
+    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
+ */
+function createPerformanceNote() {
+    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
+ */
+function createCostBreakdown(operation) {
+    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
+ */
+function createBalanceCheckStep(assetType) {
+    if (assetType === 'GALA') {
+        return `Check my GALA balance using ${mcpToolNames_js_1.MCP_TOOLS.FETCH_GALA_BALANCE}`;
+    }
+    return `Check my ${assetType} token balance using ${mcpToolNames_js_1.MCP_TOOLS.FETCH_TOKEN_BALANCE}`;
+}
+/**
+ * Create analysis workflow for token evaluation
+ *
+ * @param tokenName - Token to analyze
+ * @returns Complete analysis workflow
+ */
+function createAnalysisWorkflow(tokenName) {
+    return `Analyze the token "${tokenName}" using the Gala Launchpad MCP server:
+
+1. Fetch optimized pool details using ${mcpToolNames_js_1.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
+ */
+function createPortfolioWorkflow() {
+    return `Analyze my complete Gala Launchpad portfolio:
+
+1. Get GALA balance using ${mcpToolNames_js_1.MCP_TOOLS.FETCH_GALA_BALANCE}
+
+2. Get all tokens I'm holding using ${mcpToolNames_js_1.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: ${mcpToolNames_js_1.MCP_TOOLS.FETCH_POOL_DETAILS_FOR_CALCULATION}
+   b. Calculate spot price: ${mcpToolNames_js_1.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 ${mcpToolNames_js_1.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()}`;
+}
+//# sourceMappingURL=workflowTemplates.js.map

package/dist/prompts/utils/workflowTemplates.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflowTemplates.js","sourceRoot":"","sources":["../../../src/prompts/utils/workflowTemplates.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;AAgCH,sDAaC;AAwJD,kDAEC;AAQD,wDAEC;AASD,wDASC;AAOD,sDAEC;AAQD,kDAuBC;AAQD,wDAKC;AAQD,wDAgBC;AAOD,0DA2BC;AAhVD,qEAA4D;AAa5D;;;;;;;;;;;;;;;;GAgBG;AACH,SAAgB,qBAAqB,CAAC,MAA6B;IACjE,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,QAAQ,GAAG,GAAG,EAAE,GAAG,MAAM,CAAC;IAE5E,QAAQ,SAAS,EAAE,CAAC;QAClB,KAAK,KAAK;YACR,OAAO,iBAAiB,CAAC,SAAS,EAAE,MAAO,EAAE,UAAW,EAAE,QAAQ,CAAC,CAAC;QACtE,KAAK,MAAM;YACT,OAAO,kBAAkB,CAAC,SAAS,EAAE,MAAO,EAAE,QAAQ,CAAC,CAAC;QAC1D,KAAK,UAAU;YACb,OAAO,wBAAwB,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QACvD;YACE,MAAM,IAAI,KAAK,CAAC,sBAAsB,SAAS,EAAE,CAAC,CAAC;IACvD,CAAC;AACH,CAAC;AAED;;GAEG;AACH,SAAS,iBAAiB,CACxB,SAAiB,EACjB,MAAc,EACd,UAA6B,EAC7B,QAAgB;IAEhB,MAAM,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC,GAAG,GAAG,CAAC;IAClD,MAAM,SAAS,GAAG,UAAU,KAAK,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC;IAC7D,MAAM,WAAW,GAAG,UAAU,KAAK,MAAM,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,eAAe,CAAC;IAE9E,OAAO;;SAEA,SAAS;EAChB,WAAW,KAAK,MAAM;sBACF,QAAQ;;;;gCAIE,2BAAS,CAAC,oBAAoB;mBAC3C,SAAS;gBACZ,MAAM;cACR,SAAS,MAAM,UAAU,KAAK,MAAM,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,qBAAqB;;;;;;;;;;;yCAWnD,2BAAS,CAAC,UAAU;;;gCAG7B,cAAc;;0DAEY,CAAC;AAC3D,CAAC;AAED;;GAEG;AACH,SAAS,kBAAkB,CACzB,SAAiB,EACjB,MAAc,EACd,QAAgB;IAEhB,MAAM,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC,GAAG,GAAG,CAAC;IAElD,OAAO;;SAEA,SAAS;kBACA,MAAM;sBACF,QAAQ;;;;kCAII,2BAAS,CAAC,mBAAmB;;iCAE9B,2BAAS,CAAC,qBAAqB;mBAC7C,SAAS;gBACZ,MAAM;;;;;;;;;;;;0CAYoB,2BAAS,CAAC,WAAW;;;gCAG/B,cAAc;;8DAEgB,CAAC;AAC/D,CAAC;AAED;;GAEG;AACH,SAAS,wBAAwB,CAAC,SAAiB,EAAE,QAAgB;IACnE,MAAM,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC,GAAG,GAAG,CAAC;IAElD,OAAO,+BAA+B,SAAS;;sBAE3B,QAAQ;;;;+CAIiB,2BAAS,CAAC,kBAAkB;;;wCAGnC,2BAAS,CAAC,kCAAkC;;qCAE/C,2BAAS,CAAC,mCAAmC;;;;;;;;;;iCAUjD,2BAAS,CAAC,kBAAkB;;;;;4CAKjB,2BAAS,CAAC,cAAc;mBACjD,SAAS;gCACI,cAAc;;;;;;;8BAOhB,2BAAS,CAAC,qBAAqB;;2FAE8B,CAAC;AAC5F,CAAC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,SAAgB,mBAAmB,CAAC,KAAe;IACjD,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,KAAK,GAAG,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;AAC1E,CAAC;AAED;;;;;GAKG;AACH,SAAgB,sBAAsB,CAAC,SAAiB;IACtD,OAAO,6CAA6C,SAAS,YAAY,CAAC;AAC5E,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,sBAAsB,CACpC,SAAiB,EACjB,aAAuB;IAEvB,MAAM,MAAM,GAAG,aAAa;SACzB,GAAG,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,MAAM,MAAM,CAAC,YAAY,CAAC,EAAE,GAAG,KAAK,CAAC,KAAK,KAAK,EAAE,CAAC;SACxE,IAAI,CAAC,IAAI,CAAC,CAAC;IAEd,OAAO,SAAS,SAAS,gBAAgB,MAAM,EAAE,CAAC;AACpD,CAAC;AAED;;;;GAIG;AACH,SAAgB,qBAAqB;IACnC,OAAO,qFAAqF,CAAC;AAC/F,CAAC;AAED;;;;;GAKG;AACH,SAAgB,mBAAmB,CAAC,SAAsC;IACxE,QAAQ,SAAS,EAAE,CAAC;QAClB,KAAK,KAAK;YACR,OAAO;;;;;gBAKG,CAAC;QACb,KAAK,MAAM;YACT,OAAO;;;;;kBAKK,CAAC;QACf,KAAK,UAAU;YACb,OAAO;;;;gBAIG,CAAC;IACf,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,SAAgB,sBAAsB,CAAC,SAA0B;IAC/D,IAAI,SAAS,KAAK,MAAM,EAAE,CAAC;QACzB,OAAO,+BAA+B,2BAAS,CAAC,kBAAkB,EAAE,CAAC;IACvE,CAAC;IACD,OAAO,YAAY,SAAS,wBAAwB,2BAAS,CAAC,mBAAmB,EAAE,CAAC;AACtF,CAAC;AAED;;;;;GAKG;AACH,SAAgB,sBAAsB,CAAC,SAAiB;IACtD,OAAO,sBAAsB,SAAS;;wCAEA,2BAAS,CAAC,kCAAkC;;;;;;EAMlF,qBAAqB,EAAE;;;;;;mDAM0B,CAAC;AACpD,CAAC;AAED;;;;GAIG;AACH,SAAgB,uBAAuB;IACrC,OAAO;;4BAEmB,2BAAS,CAAC,kBAAkB;;sCAElB,2BAAS,CAAC,iBAAiB;;;;iCAIhC,2BAAS,CAAC,kCAAkC;8BAC/C,2BAAS,CAAC,gCAAgC;;;oCAGpC,2BAAS,CAAC,qBAAqB;;;;;;;;;;;;;EAajE,qBAAqB,EAAE,EAAE,CAAC;AAC5B,CAAC"}

package/dist/schemas/common-schemas.d.ts

@@ -10,42 +10,75 @@
  */
 /**
  * Token name schema - used in 11+ tools
- * Generated from SDK tokenNameSchema
+ *
+ * @description Generated from SDK tokenNameSchema
+ * @pattern ^[a-zA-Z0-9]{3,20}$
+ * @minLength 3
+ * @maxLength 20
+ * @example "boba", "testtoken", "mytoken123"
  */
 export declare const TOKEN_NAME_SCHEMA: any;
 /**
  * Token symbol schema - used in creation tools
- * Generated from SDK tokenSymbolSchema
+ *
+ * @description Generated from SDK tokenSymbolSchema
+ * @pattern ^[A-Z]{1,8}$
+ * @minLength 1
+ * @maxLength 8
+ * @example "GALA", "TEST", "MTK"
  */
 export declare const TOKEN_SYMBOL_SCHEMA: any;
 /**
  * Token description schema
- * Generated from SDK tokenDescriptionSchema
+ *
+ * @description Generated from SDK tokenDescriptionSchema
+ * @minLength 1
+ * @maxLength 500
+ * @example "A revolutionary new token for decentralized gaming"
  */
 export declare const TOKEN_DESCRIPTION_SCHEMA: any;
 /**
  * Private key schema - used in 18+ tools
- * Generated from SDK privateKeySchema
+ *
+ * @description Generated from SDK privateKeySchema
+ * @pattern ^0x[a-fA-F0-9]{64}$
+ * @example "0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890"
+ * @security Sensitive - should never be logged or exposed
  */
 export declare const PRIVATE_KEY_SCHEMA: any;
 /**
  * Wallet address schema - supports both Ethereum (0x...) and GalaChain (eth|...) formats
- * Generated from SDK flexibleAddressSchema
+ *
+ * @description Generated from SDK flexibleAddressSchema
+ * @example "0x1234567890abcdef1234567890abcdef12345678"
+ * @example "eth|1234567890abcdef1234567890abcdef12345678"
  */
 export declare const ADDRESS_SCHEMA: any;
 /**
  * Decimal amount schema - used in trading and transfer tools
- * Generated from SDK positiveDecimalStringSchema
+ *
+ * @description Generated from SDK positiveDecimalStringSchema
+ * @pattern ^\d+(\.\d+)?$
+ * @example "100", "1.5", "0.001"
+ * @note Must be positive (greater than zero)
  */
 export declare const DECIMAL_AMOUNT_SCHEMA: any;
 /**
  * Pre-buy quantity schema - used in token creation
- * Generated from SDK nonNegativeDecimalStringSchema
+ *
+ * @description Generated from SDK nonNegativeDecimalStringSchema
+ * @pattern ^\d+(\.\d+)?$
+ * @example "0", "100", "1500.5"
+ * @note Can be zero or positive (non-negative)
  */
 export declare const PRE_BUY_QUANTITY_SCHEMA: any;
 /**
  * Integer amount schema - used in token transfers
- * Pattern: positive integer string
+ *
+ * @description Manual schema (not from SDK primitives)
+ * @pattern ^[0-9]+$
+ * @example "100", "1000", "5000000"
+ * @note Integer only (no decimals) - for token transfer operations
  */
 export declare const INTEGER_AMOUNT_SCHEMA: {
     type: "string";
@@ -54,42 +87,81 @@ export declare const INTEGER_AMOUNT_SCHEMA: {
 };
 /**
  * URL schema - used for social URLs and token images
- * Generated from SDK urlSchema
+ *
+ * @description Generated from SDK urlSchema
+ * @pattern ^https?:\/\/
+ * @format uri
+ * @example "https://example.com", "https://twitter.com/username"
+ * @note Must start with http:// or https://
  */
 export declare const URL_SCHEMA: any;
 /**
  * Comment message schema
- * Generated from SDK commentMessageSchema
+ *
+ * @description Generated from SDK commentMessageSchema
+ * @minLength 1
+ * @maxLength 500
+ * @example "Great token!", "Looking forward to this project"
  */
 export declare const COMMENT_MESSAGE_SCHEMA: any;
 /**
  * Profile name schema
- * Generated from SDK fullNameSchema
+ *
+ * @description Generated from SDK fullNameSchema
+ * @pattern ^[a-zA-Z\s]+$
+ * @minLength 1
+ * @maxLength 100
+ * @example "John Doe", "Alice Smith"
+ * @note Only letters and spaces allowed
  */
 export declare const FULL_NAME_SCHEMA: any;
 /**
  * Search query schema - used in user tools
- * Generated from SDK searchQuerySchema
+ *
+ * @description Generated from SDK searchQuerySchema
+ * @minLength 1
+ * @maxLength 100
+ * @example "dragon", "test", "my token"
+ * @note Fuzzy match - case-insensitive, partial matching
  */
 export declare const SEARCH_SCHEMA: any;
 /**
  * Transaction ID schema - used for getBundlerTransactionResult
- * Generated from SDK transactionIdSchema
+ *
+ * @description Generated from SDK transactionIdSchema
+ * @pattern ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
+ * @format uuid
+ * @example "550e8400-e29b-41d4-a716-446655440000"
+ * @note UUID v4 format - returned from buy(), sell(), launchToken()
  */
 export declare const TRANSACTION_ID_SCHEMA: any;
 /**
  * Idempotency key schema - used in transfer tools
- * Generated from SDK uniqueKeySchema
+ *
+ * @description Generated from SDK uniqueKeySchema
+ * @pattern ^galaconnect-operation-[a-z0-9-]+$
+ * @example "galaconnect-operation-abc123-def456"
+ * @note Prevents duplicate transactions - optional but recommended
  */
 export declare const UNIQUE_KEY_SCHEMA: any;
 /**
  * Date-time schema - used in trade and volume queries
- * Generated from SDK isoDateStringSchema
+ *
+ * @description Generated from SDK isoDateStringSchema
+ * @format date-time
+ * @example "2024-01-15T14:30:25", "2024-01-15T14:30:25Z"
+ * @note ISO 8601 format
  */
 export declare const DATE_TIME_SCHEMA: any;
 /**
  * Page number schema - used in ~15 tools
- * Generated from SDK pageNumberSchema
+ *
+ * @description Generated from SDK pageNumberSchema
+ * @type number
+ * @minimum 1
+ * @maximum 1000
+ * @example 1, 2, 50
+ * @note Default: 1 (first page)
  */
 export declare const PAGE_SCHEMA: any;
 /**
@@ -108,6 +180,13 @@ export declare function createLimitSchema(operationType: 'trade' | 'user' | 'poo
 };
 /**
  * Slippage tolerance factor schema
+ *
+ * @description Manual schema (not from SDK primitives)
+ * @type number
+ * @minimum 0
+ * @maximum 1
+ * @example 0.01 (1%), 0.05 (5%), 0.1 (10%)
+ * @note Decimal format - protects against price movements during transaction
  */
 export declare const SLIPPAGE_TOLERANCE_SCHEMA: {
     type: "number";
@@ -117,6 +196,13 @@ export declare const SLIPPAGE_TOLERANCE_SCHEMA: {
 };
 /**
  * Reverse bonding curve fee slippage schema
+ *
+ * @description Manual schema (not from SDK primitives)
+ * @type number
+ * @minimum 0
+ * @maximum 1
+ * @example 0.01 (1% - default), 0.02 (2%), 0.05 (5%)
+ * @note Applied to maxAcceptableReverseBondingCurveFee for additional protection
  */
 export declare const RBC_FEE_SLIPPAGE_SCHEMA: {
     type: "number";
@@ -126,6 +212,12 @@ export declare const RBC_FEE_SLIPPAGE_SCHEMA: {
 };
 /**
  * Sort order schema
+ *
+ * @description Manual schema (not from SDK primitives)
+ * @type string
+ * @enum ['ASC', 'DESC']
+ * @example "ASC" (oldest first), "DESC" (newest first - default)
+ * @note Default: DESC (descending, newest first)
  */
 export declare const SORT_ORDER_SCHEMA: {
     type: "string";
@@ -134,6 +226,13 @@ export declare const SORT_ORDER_SCHEMA: {
 };
 /**
  * Calculation mode schema - for calculateAmountMode parameter
+ *
+ * @description Manual schema (not from SDK primitives)
+ * @type string
+ * @enum ['local', 'external']
+ * @example "local" (instant client-side), "external" (network-based GalaChain)
+ * @note Default: SDK's calculateAmountMode setting
+ * @note Local mode: <1ms, 99.99% accurate | External mode: ~200ms, 100% accurate
  */
 export declare const CALCULATION_MODE_SCHEMA: {
     type: "string";
@@ -142,6 +241,12 @@ export declare const CALCULATION_MODE_SCHEMA: {
 };
 /**
  * Current supply schema - for performance optimization
+ *
+ * @description Extends DECIMAL_AMOUNT_SCHEMA
+ * @pattern ^\d+(\.\d+)?$
+ * @example "1000000", "5000000.5"
+ * @note Performance optimization: provide to avoid fetching pool details twice
+ * @note Only used in local calculation mode - auto-fetched if missing
  */
 export declare const CURRENT_SUPPLY_SCHEMA: any;
 //# sourceMappingURL=common-schemas.d.ts.map

package/dist/schemas/common-schemas.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"common-schemas.d.ts","sourceRoot":"","sources":["../../src/schemas/common-schemas.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAkDH;;;GAGG;AACH,eAAO,MAAM,iBAAiB,KAA6C,CAAC;AAE5E;;;GAGG;AACH,eAAO,MAAM,mBAAmB,KAAiD,CAAC;AAElF;;;GAGG;AACH,eAAO,MAAM,wBAAwB,KAGpC,CAAC;AAMF;;;GAGG;AACH,eAAO,MAAM,kBAAkB,KAG9B,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,cAAc,KAAuD,CAAC;AAMnF;;;GAGG;AACH,eAAO,MAAM,qBAAqB,KAGjC,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,uBAAuB,KAGnC,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,qBAAqB;;;;CAIjC,CAAC;AAMF;;;GAGG;AACH,eAAO,MAAM,UAAU,KAAyB,CAAC;AAEjD;;;GAGG;AACH,eAAO,MAAM,sBAAsB,KAGlC,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,gBAAgB,KAA2C,CAAC;AAEzE;;;GAGG;AACH,eAAO,MAAM,aAAa,KAGzB,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,qBAAqB,KAGjC,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,iBAAiB,KAA2D,CAAC;AAE1F;;;GAGG;AACH,eAAO,MAAM,gBAAgB,KAAmC,CAAC;AAMjE;;;GAGG;AACH,eAAO,MAAM,WAAW,KAA4D,CAAC;AAErF;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAC/B,aAAa,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,EACpD,YAAY,GAAE,MAAW,GACxB;IACD,IAAI,EAAE,QAAQ,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;CACrB,CAqBA;AAMD;;GAEG;AACH,eAAO,MAAM,yBAAyB;;;;;CAKrC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,uBAAuB;;;;;CAMnC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,iBAAiB;;;;CAI7B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,uBAAuB;;;;CAMnC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,qBAAqB,KAGjC,CAAC"}
+{"version":3,"file":"common-schemas.d.ts","sourceRoot":"","sources":["../../src/schemas/common-schemas.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAkDH;;;;;;;;GAQG;AACH,eAAO,MAAM,iBAAiB,KAA6C,CAAC;AAE5E;;;;;;;;GAQG;AACH,eAAO,MAAM,mBAAmB,KAAiD,CAAC;AAElF;;;;;;;GAOG;AACH,eAAO,MAAM,wBAAwB,KAGpC,CAAC;AAMF;;;;;;;GAOG;AACH,eAAO,MAAM,kBAAkB,KAG9B,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,KAAuD,CAAC;AAMnF;;;;;;;GAOG;AACH,eAAO,MAAM,qBAAqB,KAGjC,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,uBAAuB,KAGnC,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,qBAAqB;;;;CAIjC,CAAC;AAMF;;;;;;;;GAQG;AACH,eAAO,MAAM,UAAU,KAAyB,CAAC;AAEjD;;;;;;;GAOG;AACH,eAAO,MAAM,sBAAsB,KAGlC,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,gBAAgB,KAA2C,CAAC;AAEzE;;;;;;;;GAQG;AACH,eAAO,MAAM,aAAa,KAGzB,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,qBAAqB,KAGjC,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,iBAAiB,KAA2D,CAAC;AAE1F;;;;;;;GAOG;AACH,eAAO,MAAM,gBAAgB,KAAmC,CAAC;AAMjE;;;;;;;;;GASG;AACH,eAAO,MAAM,WAAW,KAA4D,CAAC;AAErF;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAC/B,aAAa,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,EACpD,YAAY,GAAE,MAAW,GACxB;IACD,IAAI,EAAE,QAAQ,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;CACrB,CAqBA;AAMD;;;;;;;;;GASG;AACH,eAAO,MAAM,yBAAyB;;;;;CAKrC,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,uBAAuB;;;;;CAMnC,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,iBAAiB;;;;CAI7B,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,uBAAuB;;;;CAMnC,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,qBAAqB,KAGjC,CAAC"}