| Chain Name |
@@ -288,22 +35,8 @@ export function generateAllChainIdsTable(dc: cfg.DocChain[]): string {
`
);
- // Assemble the Testnet table data
- if (c.testnets.length > 1) {
- const orderedTestnets = c.testnets.sort((a, b) => {
- const aTitle =
- a.extraDetails && a.extraDetails.title ? a.extraDetails.title : 'N/A';
- const bTitle =
- b.extraDetails && b.extraDetails.title ? b.extraDetails.title : 'N/A';
-
- if (aTitle === 'Ethereum') return -1; // Ethereum should be first
- if (bTitle === 'Ethereum') return 1; // Ethereum should be first
- if (aTitle === 'Solana') return -1; // Solana should be second
- if (bTitle === 'Solana') return 1; // Solana should be second
- return aTitle.localeCompare(bTitle); // Sort the rest alphabetically
- });
-
- orderedTestnets.forEach((testnet) => {
+ function processTestnets(testnets: cfg.ChainDetails[]) {
+ testnets.forEach((testnet) => {
const testnetAlias = cfg.networkString(testnet.extraDetails?.testnet);
testNetTableBody.push(`
@@ -315,18 +48,14 @@ export function generateAllChainIdsTable(dc: cfg.DocChain[]): string {
${testnetAlias} |
`);
});
+ }
+
+ // Assemble the Testnet table data
+ if (c.testnets.length > 1) {
+ const orderedTestnets = sortTestnets(c.testnets);
+ processTestnets(orderedTestnets);
} else {
- c.testnets.forEach((testnet) => {
- const testnetAlias = cfg.networkString(testnet.extraDetails?.testnet);
- testNetTableBody.push(`
-
- | ${
- testnet.extraDetails ? testnet.extraDetails.title : testnet.name
- } |
- ${testnet.id} |
- ${testnetAlias} |
-
`);
- });
+ processTestnets(c.testnets);
}
}
@@ -342,9 +71,9 @@ export function generateAllChainIdsTable(dc: cfg.DocChain[]): string {
}
export function generateAllConsistencyLevelsTable(dc: cfg.DocChain[]): string {
- const orderedDc = sortChainNames(dc);
+ const orderedDc = sortMainnets(dc);
- const header = `
+ const tableHeader = `
Chain |
Instant |
@@ -355,7 +84,7 @@ export function generateAllConsistencyLevelsTable(dc: cfg.DocChain[]): string {
Details |
`;
- const rows: string[] = [];
+ const tableBody: string[] = [];
for (const c of orderedDc) {
if (!c.mainnet.extraDetails) {
console.log('No extra details for: ', c.mainnet.name);
@@ -383,7 +112,9 @@ export function generateAllConsistencyLevelsTable(dc: cfg.DocChain[]): string {
);
const finalized = fmtNum(f.finalized);
const otherwise = f.otherwise ? f.otherwise : '';
- const details = f.details ? `Details` : ' ';
+ const details = f.details
+ ? `Details`
+ : ' ';
let sdkChain: Chain;
try {
@@ -405,7 +136,7 @@ export function generateAllConsistencyLevelsTable(dc: cfg.DocChain[]): string {
const finalizationTime = `~ ${Math.ceil(
((finalizationBlocks + 1) * blockTime) / 1000
)}s`;
- rows.push(`
+ tableBody.push(`
| ${header} |
${instant} |
@@ -419,80 +150,55 @@ export function generateAllConsistencyLevelsTable(dc: cfg.DocChain[]): string {
}
}
- return formatHTMLTable(buildHTMLTable(header, rows.join('\n')))
+ return formatHTMLTable(buildHTMLTable(tableHeader, tableBody.join('\n')));
}
export function generateAllContractsTable(
- dc: cfg.DocChain[],
+ chains: cfg.DocChain[],
module: string
): string {
- // Create Mainnet Chain Table
- const orderedDc = sortChainNames(dc);
- const tableHeader =`
+ const orderedChains = sortMainnets(chains);
+ const tableHeader = `
Chain Name |
Contract Address |
`;
- let mainNetTableBody: string[] = [];
- let testNetTableBody: string[] = [];
- let devNetTableBody: string[] = [];
- const m = module as keyof cfg.Contracts;
-
- for (const c of orderedDc) {
- // Assemble the Mainnet table data
- mainNetTableBody.push(
- `
- | ${c.mainnet.extraDetails ? c.mainnet.extraDetails.title : c.mainnet.name} |
- ${fmtCodeStr(c.mainnet.contracts[m])} |
-
`
- )
+ // Helper function to generate table rows
+ const generateRows = (networks: cfg.ChainDetails[]): string[] => {
+ return networks
+ .filter((network) =>
+ module === 'cctp'
+ ? network.contracts?.[module]?.wormhole
+ : network.contracts?.[module]
+ )
+ .map(
+ (network) => `
+
+ | ${network.extraDetails?.title || network.name} |
+ ${fmtCodeStr(
+ module === 'cctp'
+ ? network.contracts?.[module]?.wormhole
+ : network.contracts?.[module]
+ )} |
+
`
+ );
+ };
- // Assemble the Testnet table data
- if (c.testnets.length > 1) {
- const orderedTestnets = c.testnets.sort((a, b) => {
- const aTitle =
- a.extraDetails && a.extraDetails.title ? a.extraDetails.title : 'N/A';
- const bTitle =
- b.extraDetails && b.extraDetails.title ? b.extraDetails.title : 'N/A';
-
- if (aTitle === 'Ethereum') return -1; // Ethereum should be first
- if (bTitle === 'Ethereum') return 1; // Ethereum should be first
- if (aTitle === 'Solana') return -1; // Solana should be second
- if (bTitle === 'Solana') return 1; // Solana should be second
- return aTitle.localeCompare(bTitle); // Sort the rest alphabetically
- });
+ // Generate table rows
+ const mainNetTableBody = orderedChains.flatMap((chain) =>
+ generateRows([chain.mainnet])
+ );
- orderedTestnets.forEach((testnet) => {
- testNetTableBody.push(`
-
- | ${testnet.extraDetails ? testnet.extraDetails.title : testnet.name} |
- ${fmtCodeStr(testnet.contracts[m])} |
-
`,
- );
- });
- } else {
- c.testnets.forEach((testnet) => {
- testNetTableBody.push(`
-
- | ${testnet.extraDetails ? testnet.extraDetails.title : testnet.name} |
- ${fmtCodeStr(testnet.contracts[m])} |
-
`,
- );
- });
- }
+ const testNetTableBody = orderedChains.flatMap((chain) =>
+ generateRows(sortTestnets(chain.testnets || []))
+ );
- // Assemble the Devnet table data
- c.devnets.forEach((devnet) => {
- devNetTableBody.push(`
-
- | ${devnet.extraDetails ? devnet.extraDetails.title : devnet.name} |
- ${fmtCodeStr(devnet.contracts[m])} |
-
`,
- );
- });
- }
+ const devNetTableBody = orderedChains.flatMap((chain) =>
+ generateRows(chain.devnets || [])
+ );
+ // Combine everything into the final table
return `
=== "Mainnet"
@@ -505,5 +211,147 @@ export function generateAllContractsTable(
=== "Devnet"
${formatHTMLTable(buildHTMLTable(tableHeader, devNetTableBody.join('')))}
-`;
+ `;
+}
+
+export function generateSupportedNetworksTable(dc: cfg.DocChain[]): string {
+ const orderedDc = sortChainTypes(dc);
+
+ // Group chains by their chainType
+ const chainsByType: Record = {};
+ for (const chain of orderedDc) {
+ if (!chainsByType[chain.chainType]) {
+ chainsByType[chain.chainType] = [];
+ }
+ chainsByType[chain.chainType].push(chain);
+ }
+
+ const tableHeader = `
+
+ Blockchain |
+ Environment |
+ Mainnet |
+ Testnet |
+ Quick Links |
+ `;
+
+ // Generate tables for each chain type
+ let tables: string[] = [];
+ for (const [chainType, chains] of Object.entries(chainsByType)) {
+ let tableBody: string[] = [];
+
+ for (const c of chains) {
+ const mainnetSupport =
+ c.mainnet.contracts.coreBridge || c.mainnet.contracts.gateway
+ ? ':white_check_mark:'
+ : ':x:';
+ const testnetSupport =
+ c.testnets[0]?.contracts.coreBridge || c.testnets[0]?.contracts.gateway
+ ? ':white_check_mark:'
+ : ':x:';
+
+ // Filter out unsupported chains that have chain IDs (i.e., if they were previously
+ // supported) but are no longer supported
+ if (mainnetSupport === ':x:' && testnetSupport === ':x:') {
+ continue;
+ }
+
+ const website = c.mainnet.extraDetails?.homepage
+ ? ':material-web: ' +
+ `Website`
+ : undefined;
+
+ const devDocs = c.mainnet.extraDetails?.devDocs
+ ? ':material-file-document: ' +
+ `Developer Docs`
+ : undefined;
+
+ const explorer = c.mainnet.extraDetails?.explorer
+ ? ':octicons-package-16: ' +
+ `Block Explorer`
+ : undefined;
+
+ tableBody.push(
+ `
+ | ${c.mainnet.extraDetails?.title ?? c.mainnet.name} |
+ ${c.chainType} |
+ ${mainnetSupport} |
+ ${testnetSupport} |
+
+ ${website ? website + '
' : ''}
+ ${devDocs ? devDocs + '
' : ''}
+ ${explorer ? explorer : ''}
+ |
+
`
+ );
+ }
+
+ tables.push(`### ${chainType}\n\n${formatHTMLTable(
+ buildHTMLTable(tableHeader, tableBody.join('\n'))
+ )}`);
+ }
+
+ // Combine all tables into one string
+ return `\n\n${tables.join(
+ '\n\n'
+ )}\n\n
`;
+}
+
+export function generateTestnetFaucetsTable(dc: cfg.DocChain[]): string {
+ const orderedDc = sortChainTypes(dc);
+
+ // Group chains by their chainType
+ const chainsByType: Record = {};
+ for (const chain of orderedDc) {
+ if (!chainsByType[chain.chainType]) {
+ chainsByType[chain.chainType] = [];
+ }
+ chainsByType[chain.chainType].push(chain);
+ }
+
+ const tableHeader = `
+
+ Testnet |
+ Environment |
+ Token |
+ Faucet |
+ `;
+
+ // Generate tables for each chain type
+ let tables: string[] = [];
+ for (const [chainType, chains] of Object.entries(chainsByType)) {
+ let tableBody: string[] = [];
+
+ for (const c of chains) {
+ for (const t of c.testnets) {
+ const token = t.extraDetails?.faucet
+ ? t.extraDetails.faucet.token
+ : 'N/A';
+
+ const faucet = t.extraDetails?.faucet
+ ? `${t.extraDetails.faucet.description}`
+ : undefined;
+
+ if (!faucet) continue;
+
+ tableBody.push(
+ `
+ | ${t.extraDetails?.title ?? t.name} |
+ ${c.chainType} |
+ ${token} |
+ ${faucet ? faucet : ''} |
+
`
+ );
+ }
+ }
+
+ tables.push(`### ${chainType}\n\n${formatHTMLTable(
+ buildHTMLTable(tableHeader, tableBody.join('\n'))
+ )}`);
+ }
+
+ // Combine all tables into one string
+ return `\n\n${tables.join(
+ '\n\n'
+ )}\n\n
`;
}
diff --git a/scripts/src/icons.ts b/scripts/src/icons.ts
deleted file mode 100644
index 9d5ff859..00000000
--- a/scripts/src/icons.ts
+++ /dev/null
@@ -1,39 +0,0 @@
-import { CHAINS } from "@certusone/wormhole-sdk";
-import { encoding, toChain } from "@wormhole-foundation/sdk";
-import { chainToIcon } from "@wormhole-foundation/sdk-icons";
-import * as fs from "fs";
-import path from "path";
-import sharp from "sharp";
-
-const WEBP_OUTPUT_PATH = path.join(__dirname, '../..', 'wormhole-docs/images/build/start-building/supported-networks');
-console.log(WEBP_OUTPUT_PATH)
-const prefix = "data:image/svg+xml;base64,";
-
-for (const [name, chainId] of Object.entries(CHAINS)) {
- if (chainId === 0) continue;
-
- // Define the output path for the WebP image
- const webpFilePath = `${WEBP_OUTPUT_PATH}/${name}.webp`;
-
- // Check if the WebP file already exists
- if (fs.existsSync(webpFilePath)) {
- console.log(`WebP icon for ${name} already exists. Skipping...`);
- continue; // Skip if the WebP file already exists
- }
-
- // Decode SVG from base64
- const svg = encoding.bytes.decode(
- encoding.b64.decode(chainToIcon(toChain(chainId)).slice(prefix.length))
- );
-
- // Convert SVG to WebP using sharp
- sharp(Buffer.from(svg))
- .webp()
- .toFile(webpFilePath)
- .then(() => {
- console.log(`Successfully converted ${name}.svg to WebP.`);
- })
- .catch((err) => {
- console.error(`Failed to convert ${name}.svg to WebP:`, err);
- });
-}
\ No newline at end of file
diff --git a/scripts/src/index.ts b/scripts/src/index.ts
index 90252937..a0245010 100644
--- a/scripts/src/index.ts
+++ b/scripts/src/index.ts
@@ -1,12 +1,11 @@
import * as cfg from './config';
import {
- chainDetailsPage,
- formatHTMLTable,
generateAllChainIdsTable,
generateAllConsistencyLevelsTable,
generateAllContractsTable,
+ generateSupportedNetworksTable,
+ generateTestnetFaucetsTable,
} from './details';
-import { chainCard } from './card';
import * as fs from 'fs';
// Matches for tag search
@@ -76,75 +75,45 @@ async function overwriteGenerated(tag: string, content: string) {
(async function () {
// Get each of the supported chains
- const chains = cfg.getDocChains();
-
- const supportedChains: string[] = [];
- const chainPages: Record = {};
-
- for (const chain of chains) {
- if (chain.mainnet.extraDetails !== undefined) {
- // Supported chains for intro page
- // Add chain card to the current row
- supportedChains.push(chainCard(chain.mainnet, chain.chainType));
-
- // Chain-specific pages
- chainPages[chain.mainnet.name] = chainDetailsPage(chain);
- }
- }
-
- const supportedChainsMarkdown = `
-
-${supportedChains.join('\n')}
-
- `;
+ const chains = await cfg.getDocChains();
// TODO: concurrent? will that wreck anything?
// find tags _first_ in one pass and come back to fill them in?
// currently this searches docs every time we call it
await overwriteGenerated(
'SUPPORTED_BLOCKCHAIN_CARDS',
- supportedChainsMarkdown
+ generateSupportedNetworksTable(chains)
);
-
- // TODO: Auto-generate each of the environment pages under Supported Networks
- // for (const [chainName, chainPage] of Object.entries(chainPages)) {
- // await overwriteGenerated(
- // `${chainName.toUpperCase()}_CHAIN_DETAILS`,
- // chainPage
- // );
- // }
-
// Contract addresses
await overwriteGenerated(
'CORE_ADDRESS',
- generateAllContractsTable(chains, 'core')
+ generateAllContractsTable(chains, 'coreBridge')
);
await overwriteGenerated(
'TOKEN_BRIDGE_ADDRESS',
- generateAllContractsTable(chains, 'token_bridge')
- );
- await overwriteGenerated(
- 'NFT_BRIDGE_ADDRESS',
- generateAllContractsTable(chains, 'nft_bridge')
+ generateAllContractsTable(chains, 'tokenBridge')
);
await overwriteGenerated(
'RELAYER_BRIDGE_ADDRESS',
- generateAllContractsTable(chains, 'wormholeRelayerAddress')
+ generateAllContractsTable(chains, 'relayer')
);
await overwriteGenerated(
'CCTP_ADDRESS',
generateAllContractsTable(chains, 'cctp')
);
- // await overwriteGenerated(
- // "GATEWAY_ADDRESS",
- // generateAllContractsTable(chains, "cctp")
- // );
+ // Consistency levels
await overwriteGenerated(
'CONSISTENCY_LEVELS',
generateAllConsistencyLevelsTable(chains)
);
+ // Testnet faucets
+ await overwriteGenerated(
+ 'TESTNET_FAUCETS',
+ generateTestnetFaucetsTable(chains)
+ );
+
await overwriteGenerated('CHAIN_IDS', generateAllChainIdsTable(chains));
})();
diff --git a/scripts/src/util.ts b/scripts/src/util.ts
index 31143c71..9d87e737 100644
--- a/scripts/src/util.ts
+++ b/scripts/src/util.ts
@@ -1,3 +1,5 @@
+import * as cfg from './config';
+
export function fmtNum(n?: number): string {
return n === undefined ? " " : n.toString();
}
@@ -9,3 +11,135 @@ export function fmtStr(s?: string): string {
export function fmtCodeStr(s?: string): string {
return s === undefined ? "-" : `${s}`;
}
+
+export function buildHTMLTable(tableHeader: string, tableBody: string): string {
+ if (tableBody.trim() == "") {
+ return 'N/A';
+ }
+
+ return `
+
+ ${tableHeader}
+
+ ${tableBody}
+
+
+ `;
+
+}
+
+// Function to format an HTML table string with consistent indentation and newlines
+export function formatHTMLTable(htmlTable: string): string {
+ const indentStep = ' '; // Define the indent step
+ let indentLevel = 0; // Initial indentation level
+
+ // Helper function to add proper indentation
+ function addIndentation(html: string): string {
+ return html
+ .split('\n')
+ .map((line) => indentStep.repeat(indentLevel) + line.trim())
+ .join('\n');
+ }
+
+ // Clean up extra spaces and newlines around tags
+ const cleanedHtmlTable = htmlTable
+ .replace(/>\s+<') // Remove spaces between tags
+ .replace(/(^|\n)\s+)/g, '$1') // Remove trailing spaces before closing tags
+ .trim(); // Remove leading and trailing whitespace
+
+ const lines = cleanedHtmlTable.split('\n');
+ const result: string[] = [];
+
+ for (const line of lines) {
+ // Handle opening and closing tags for indentation levels
+ if (line.match(/^<\/\w/)) {
+ indentLevel--; // Decrease indentation level for closing tags
+ }
+
+ result.push(addIndentation(line));
+
+ if (line.match(/^<\w[^>]*[^\/]>/)) {
+ indentLevel++; // Increase indentation level for opening tags
+ }
+ }
+
+ // Handle the case where the last line is not properly closed
+ return result.join('\n').trim();
+}
+
+export function sortMainnets(dc: cfg.DocChain[]): cfg.DocChain[] {
+ return dc.sort((a, b) => {
+ const aTitle =
+ a.mainnet.extraDetails && a.mainnet.extraDetails.title
+ ? a.mainnet.extraDetails.title
+ : 'N/A';
+ const bTitle =
+ b.mainnet.extraDetails && b.mainnet.extraDetails.title
+ ? b.mainnet.extraDetails.title
+ : 'N/A';
+
+ if (aTitle === 'Ethereum') return -1; // Ethereum should be first
+ if (bTitle === 'Ethereum') return 1; // Ethereum should be first
+ if (aTitle === 'Solana') return -1; // Solana should be second
+ if (bTitle === 'Solana') return 1; // Solana should be second
+ return aTitle.localeCompare(bTitle); // Sort the rest alphabetically
+ });
+}
+
+export function sortTestnets (
+ testnets: cfg.ChainDetails[]
+): cfg.ChainDetails[] {
+ return testnets.sort((a, b) => {
+ const aTitle = a.extraDetails?.title || 'N/A';
+ const bTitle = b.extraDetails?.title || 'N/A';
+ if (aTitle === 'Ethereum') return -1;
+ if (bTitle === 'Ethereum') return 1;
+ if (aTitle === 'Solana') return -1;
+ if (bTitle === 'Solana') return 1;
+ return aTitle.localeCompare(bTitle);
+ });
+}
+
+export function sortChainTypes(dc: cfg.DocChain[]): cfg.DocChain[] {
+ return dc.sort((a, b) => {
+ // Define chain type priorities
+ const chainTypePriority: Record = {
+ EVM: 1, // Highest priority
+ SVM: 2, // Second priority
+ // Other chain types are sorted alphabetically by type
+ };
+
+ // Get chain type priorities, default to a higher number for unknown types
+ const aPriority = chainTypePriority[a.chainType] ?? 99;
+ const bPriority = chainTypePriority[b.chainType] ?? 99;
+
+ // Primary sort by chain type priority
+ if (aPriority !== bPriority) {
+ return aPriority - bPriority;
+ }
+
+ // For chain types not explicitly prioritized, sort alphabetically by chain type
+ if (aPriority === 99 && bPriority === 99) {
+ return a.chainType.localeCompare(b.chainType);
+ }
+
+ // Secondary sort within the same chain type
+ const aTitle = a.mainnet.extraDetails?.title ?? 'N/A';
+ const bTitle = b.mainnet.extraDetails?.title ?? 'N/A';
+
+ // Special handling for prioritized chain names within types
+ if (a.chainType === 'EVM') {
+ if (aTitle === 'Ethereum') return -1;
+ if (bTitle === 'Ethereum') return 1;
+ }
+
+ if (a.chainType === 'SVM') {
+ if (aTitle === 'Solana') return -1;
+ if (bTitle === 'Solana') return 1;
+ }
+
+ // Sort alphabetically by title for other chains within the same type
+ return aTitle.localeCompare(bTitle);
+ });
+}
diff --git a/wormhole-docs b/wormhole-docs
index f8974eae..d0c01c08 160000
--- a/wormhole-docs
+++ b/wormhole-docs
@@ -1 +1 @@
-Subproject commit f8974eae31c4a03ef5e44ac265e69b3511529361
+Subproject commit d0c01c08c9c3407f00e78c225ecc22ae1600c65f