#!/usr/bin/env node /** * Chain Page Generator * * Generates chain documentation pages from the chain-data.js configuration. * Also automatically updates docs.json navigation to include all CMS chains. * * Run with: node scripts/generate-chain-pages.js * * Options: * --dry-run Preview changes without writing files * --chain=X Only generate page for specific chain slug (skips nav update) * --partners Only generate partner pages * --other Only generate other network pages */ const fs = require('fs'); const path = require('path'); const { partnerChains, otherChains, allChains } = require('./chain-data.js'); // Chains with custom content that should NOT be auto-generated // These pages are manually maintained and will be skipped during generation // but still included in navigation const CUSTOM_CONTENT_CHAINS = [ 'arweave', // Custom "coming soon" page 'fogo', // Custom content 'kite-ai', // Custom subgraphs documentation (not in CMS) 'polymarket', // Custom Turbo pipelines documentation 'saga', // Custom subgraphs documentation (not in CMS) 'stellar', // Custom content 'sui', // Custom content ]; // Known non-EVM chains (use explicit list, assume everything else is EVM) const NON_EVM_CHAINS = ['sui', 'stellar', 'arweave', 'solana', 'bitcoin', 'near', 'starknet', 'tron', 'fogo']; // Parse command line arguments const args = process.argv.slice(2); const isDryRun = args.includes('--dry-run'); const specificChain = args.find(a => a.startsWith('--chain='))?.split('=')[1]; const partnersOnly = args.includes('--partners'); const otherOnly = args.includes('--other'); /** * Generate the MDX content for a chain page */ function generateChainPage(chain) { // Skip chains with custom content - they are manually maintained if (CUSTOM_CONTENT_CHAINS.includes(chain.slug)) { console.log(` ⏭️ Skipping ${chain.name} - has custom content (manually maintained)`); return null; } const hasMainnet = chain.mainnet !== null; const hasTestnet = chain.testnet !== null; // A chain is EVM-compatible unless it's in the known non-EVM list const isEVMCompatible = !NON_EVM_CHAINS.includes(chain.slug); // Build imports const imports = [ "import { ChainHeaderTabs } from '/snippets/chain-specific/chain-header-tabs.jsx';", "import { ChainOverview } from '/snippets/chain-specific/chain-overview.jsx';", ]; if (chain.isPartner) { imports.push("import ChainPartnershipSection from '/snippets/chain-specific/chain-partnership-section.mdx';"); } imports.push( "import ChainGettingStarted from '/snippets/chain-specific/chain-getting-started.mdx';", "import { ChainSubgraphsSection } from '/snippets/chain-specific/chain-subgraphs-section.jsx';", "import { ChainMirrorSection } from '/snippets/chain-specific/chain-mirror-section.jsx';", "import { ChainTurboSection } from '/snippets/chain-specific/chain-turbo-section.jsx';", "import { ChainEdgeSection } from '/snippets/chain-specific/chain-edge-section.jsx';", "import { ChainComposeSection } from '/snippets/chain-specific/chain-compose-section.jsx';", "import ChainSupportSection from '/snippets/chain-specific/chain-support-section.mdx';" ); // Build frontmatter const frontmatter = `--- title: "${chain.name}" "og:title": "${chain.name} - Goldsky Docs" sidebarTitle: "${chain.name}" public: true ---`; // Build ChainHeaderTabs props - only show if we have complete chain data from chainlist let headerTabsProps = []; const edgeMainnetSupported = chain.products?.edge?.mainnet || false; const edgeTestnetSupported = chain.products?.edge?.testnet || false; let hasChainData = false; // Only include mainnet if we have chainId, currency, AND explorerUrl (from chainlist enrichment) const hasCompleteMainnetData = hasMainnet && chain.mainnet.chainId && chain.mainnet.currency && chain.mainnet.explorerUrl; const hasCompleteTestnetData = hasTestnet && chain.testnet?.chainId && chain.testnet?.currency && chain.testnet?.explorerUrl; if (hasCompleteMainnetData) { hasChainData = true; headerTabsProps.push( ` primaryTitle="${chain.mainnet.title}"`, ` primaryChainId="${chain.mainnet.chainId}"`, ` primaryCurrency="${chain.mainnet.currency}"`, ` primaryExplorerUrl="${chain.mainnet.explorerUrl}"` ); } if (hasCompleteTestnetData) { hasChainData = true; headerTabsProps.push( ` secondaryTitle="${chain.testnet.title}"`, ` secondaryChainId="${chain.testnet.chainId}"`, ` secondaryCurrency="${chain.testnet.currency}"`, ` secondaryExplorerUrl="${chain.testnet.explorerUrl}"` ); } // Add Edge support flags only if we have chain data to display if (hasChainData) { headerTabsProps.push( ` edgeMainnetSupported={${edgeMainnetSupported}}`, ` edgeTestnetSupported={${edgeTestnetSupported}}` ); } // Build networks array for subgraphs/mirror const networks = []; if (hasMainnet && chain.mainnet.subgraphSlug) { networks.push(`["${chain.mainnet.title}", "${chain.mainnet.subgraphSlug}"]`); } if (hasTestnet && chain.testnet.subgraphSlug) { networks.push(`["${chain.testnet.title}", "${chain.testnet.subgraphSlug}"]`); } const networksArray = networks.length > 0 ? `[${networks.join(', ')}]` : '[]'; // Build content sections let content = `${frontmatter} ${imports.join('\n')} `; // Add ChainHeaderTabs only if we have chain ID data if (hasChainData) { content += ` `; } // Overview section content += `## Overview `; // Partnership section for partner chains if (chain.isPartner) { content += ` `; } // Getting started section content += `## Getting started `; // Subgraphs section content += `## Subgraphs `; // Mirror section content += `## Mirror `; // Turbo section const primarySlug = chain.mainnet?.mirrorSlug || chain.testnet?.mirrorSlug || ''; const secondarySlug = chain.testnet?.mirrorSlug || ''; content += `## Turbo `; // Edge section (shows "NOT COMPATIBLE" for non-EVM chains) content += `## RPC Edge `; // Compose section content += `## Compose `; // Support section content += `## Getting support `; return content; } /** * Write chain page to file */ function writeChainPage(chain, content) { const filePath = path.join(__dirname, '..', 'chains', `${chain.slug}.mdx`); if (isDryRun) { console.log(` 📄 Would write: ${filePath}`); return; } fs.writeFileSync(filePath, content, 'utf8'); console.log(` ✅ Written: ${filePath}`); } // Custom chains not in CMS that should be added to navigation // Format: { slug: 'partner' | 'other' } const CUSTOM_CHAINS_NAV = { 'kite-ai': 'partner', // Not in CMS, add to Partners 'saga': 'partner', // Not in CMS, add to Partners }; /** * Update docs.json navigation with chain pages from CMS */ function updateDocsJsonNavigation() { const docsJsonPath = path.join(__dirname, '..', 'docs.json'); if (isDryRun) { console.log('\n📋 Would update docs.json navigation'); return; } // Read current docs.json const docsJson = JSON.parse(fs.readFileSync(docsJsonPath, 'utf8')); // Find the Chains tab const chainsTab = docsJson.navigation?.tabs?.find(t => t.tab === 'Chains'); if (!chainsTab || !chainsTab.groups) { console.log('\n⚠️ Could not find Chains tab in docs.json navigation'); return; } // Build partner and other network pages from CMS data let partnerPages = partnerChains .map(c => `chains/${c.slug}`); let otherPages = otherChains .map(c => `chains/${c.slug}`); // Add custom chains not in CMS Object.entries(CUSTOM_CHAINS_NAV).forEach(([slug, group]) => { const page = `chains/${slug}`; if (group === 'partner' && !partnerPages.includes(page)) { partnerPages.push(page); } else if (group === 'other' && !otherPages.includes(page)) { otherPages.push(page); } }); // Sort alphabetically partnerPages.sort(); otherPages.sort(); // Update Partners group const partnersGroup = chainsTab.groups.find(g => g.group === 'Partners'); if (partnersGroup) { partnersGroup.pages = partnerPages; } // Update Other networks group const otherGroup = chainsTab.groups.find(g => g.group === 'Other networks'); if (otherGroup) { otherGroup.pages = otherPages; } // Write back fs.writeFileSync(docsJsonPath, JSON.stringify(docsJson, null, 2) + '\n'); console.log(`\n📋 Updated docs.json navigation:`); console.log(` Partners: ${partnerPages.length} chains`); console.log(` Other networks: ${otherPages.length} chains`); } /** * Generate the supported-chains-edge.mdx snippet from chain-data.js */ function generateEdgeSnippet() { const networks = []; for (const chain of allChains) { // Add mainnet if Edge is supported if (chain.products.edge.mainnet && chain.mainnet?.chainId) { networks.push({ name: chain.mainnet.title === 'Mainnet' ? chain.name : chain.mainnet.title, type: 'Mainnet', chainId: chain.mainnet.chainId, }); } // Add testnet if Edge is supported if (chain.products.edge.testnet && chain.testnet?.chainId) { networks.push({ name: chain.testnet.title, type: 'Testnet', chainId: chain.testnet.chainId, }); } } // Sort by name networks.sort((a, b) => a.name.localeCompare(b.name)); // Generate markdown table let content = `| Name | Type | Chain ID |\n| --- | --- | --- |\n`; for (const net of networks) { content += `| ${net.name} | ${net.type} | \`${net.chainId}\` |\n`; } content += `\nFor the full list of supported networks, visit the [RPC Edge documentation](/edge-rpc/introduction).\n`; // Write file const outputPath = path.join(__dirname, '..', 'snippets', 'supported-chains-edge.mdx'); if (isDryRun) { console.log(`\n📄 Would write Edge snippet (${networks.length} networks) to: ${outputPath}`); } else { fs.writeFileSync(outputPath, content, 'utf8'); console.log(`\n📄 Edge snippet written (${networks.length} networks): ${outputPath}`); } } // Main execution function main() { console.log('🚀 Chain Page Generator\n'); if (isDryRun) { console.log('🔍 DRY RUN MODE - no files will be written\n'); } let chainsToProcess = []; if (specificChain) { const chain = allChains.find(c => c.slug === specificChain); if (!chain) { console.error(`❌ Chain not found: ${specificChain}`); process.exit(1); } chainsToProcess = [chain]; } else if (partnersOnly) { chainsToProcess = partnerChains; } else if (otherOnly) { chainsToProcess = otherChains; } else { chainsToProcess = allChains; } console.log(`Processing ${chainsToProcess.length} chain(s)...\n`); let generated = 0; let skipped = 0; for (const chain of chainsToProcess) { console.log(`📦 ${chain.name} (${chain.slug})`); const content = generateChainPage(chain); if (content) { writeChainPage(chain, content); generated++; } else { skipped++; } } console.log(`\n✨ Done! Generated: ${generated}, Skipped: ${skipped}`); // Generate Edge snippet generateEdgeSnippet(); // Update docs.json navigation (unless generating specific chain only) if (!specificChain) { updateDocsJsonNavigation(); } } main();

Mirror

Guides

Reference

Subgraphs

Direct indexing