Changelog JSON and single-sourced release notes (smartcontractkit#1934)

* Single-source release notes

* Add TS interface for changelog entries

* Add anchor links to changelog entry headers

* Enforce network validity

* Add a Chainlink Local general release note

---------

Co-authored-by: Karim <[email protected]>

Author: dwightjl

public/changelog.json

@@ -0,0 +1,74 @@
+---
+import changelogData from "../../public/changelog.json"
+import { chainNames } from "./QuickLinks/data/productChainLinks"
+import { marked } from "marked"
+
+export type Props = {
+  topic: string
+  subTopic?: string
+}
+
+export interface ChangelogEntry {
+  category: string
+  changes?: string[]
+  date: string
+  description: string
+  relatedNetworks?: RelatedNetwork[]
+  relatedTokens?: string[]
+  title: string
+  topic: string
+  subTopic?: string
+  urls?: string[]
+}
+
+type RelatedNetwork = keyof typeof chainNames
+
+function isValidNetwork(entry: any): entry is ChangelogEntry {
+  if (entry.relatedNetworks) {
+    if (!Array.isArray(entry.relatedNetworks)) {
+      throw new Error(
+        `Invalid type for field "relatedNetworks" in entry "${
+          entry.title
+        }": expected array, received ${typeof entry.relatedNetworks}`
+      )
+    }
+    for (const network of entry.relatedNetworks) {
+      if (!(network in chainNames)) {
+        throw new Error(
+          `Invalid relatedNetwork "${network}" in entry "${entry.title}". Must be one of: ${Object.keys(
+            chainNames
+          ).join(", ")}`
+        )
+      }
+    }
+  }
+  return true
+}
+
+let changelog: ChangelogEntry[] = []
+
+if (Array.isArray(changelogData)) {
+  changelog = changelogData.filter(isValidNetwork)
+} else {
+  console.error("Changelog data is not an array.")
+}
+
+const { topic, subTopic } = Astro.props as Props
+
+const entries = changelog.filter(
+  (entry) => (entry.topic === topic && !subTopic) || (subTopic && entry.subTopic === subTopic)
+)
+---
+
+{
+  entries.map((entry) => (
+    <section>
+      <h2 id={entry.date + "-" + entry.title.toLowerCase().replace(/ /g, "-")}>
+        <a href={`#${entry.date}-${entry.title.toLowerCase().replace(/ /g, "-")}`}>
+          {entry.date} - {entry.title}
+        </a>
+      </h2>
+      <article set:html={marked.parse(entry.description)} />
+    </section>
+  ))
+}

src/components/ReleaseNotes.astro

@@ -11,6 +11,7 @@ export { default as CodeSample } from "./CodeSample/CodeSample.astro"
 export { default as Address } from "./Address"
 export { default as CopyText } from "./CopyText"
 export { default as Aside } from "./Aside.astro"
+export { default as ReleaseNotes } from "./ReleaseNotes.astro"
 export { default as Icon } from "./Icon.astro"
 export { default as ClickToZoom } from "./ClickToZoom.astro"
 export { default as PackageManagerTabs } from "./Tabs/PackageManagerTabs.astro"

src/components/index.ts

@@ -4,201 +4,6 @@ date: Last Modified
 title: "Chainlink CCIP Release Notes"
 ---
 
-import { Aside } from "@components"
+import { ReleaseNotes } from "@components"
 
-## Metis - 2024-08-08
-
-Chainlink CCIP is publicly available on Metis mainnet and testnet.
-
-## Blast - 2024-07-09
-
-Chainlink CCIP is publicly available on Blast mainnet and Sepolia testnet.
-
-## Mode - 2024-06-19
-
-Chainlink CCIP is publicly available on Mode mainnet and Sepolia testnet.
-
-## Gnosis mainnet - 2024-06-05
-
-Chainlink CCIP is publicly available on Gnosis mainnet.
-
-## Celo - 2024-05-29
-
-Chainlink CCIP is publicly available on Celo mainnet and Alfajores testnet.
-
-## Polygon Amoy - 2024-05-08
-
-Chainlink CCIP is publicly available on Polygon Amoy.
-
-See the [CCIP testnet configuration page](/ccip/supported-networks/testnet) for more information.
-
-## Chainlink CCIP is GA - 2024-04-24
-
-Chainlink CCIP is now Generally Available (GA) on mainnet and testnet.
-
-To support your development and implementation needs, we encourage you to reach out to our team of experts for guidance and support. For expert advice, visit the [Chainlink CCIP Contact form](https://chain.link/ccip-contact).
-
-Additionally, the [Chainlink CCIP local
-simulator](https://github.com/smartcontractkit/chainlink-local) is available to enhance your development workflow with CCIP. This tool allows you to simulate Chainlink CCIP functionality locally within your Hardhat and Foundry projects. The simulator is designed so you can test your contracts locally and transition smoothly to test networks without any modifications.
-
-## Support for WETH transfers and gas limit mainnet increase - 2024-04-11
-
-### WETH and support of _Lock and Unlock_ mechanism
-
-Chainlink's CCIP now supports WETH (Wrapped Ether) transfers through the _Lock and Unlock_ token mechanism. This feature allows CCIP to securely lock tokens on the source blockchain and subsequently release an equivalent amount of tokens on the destination blockchain, facilitating seamless cross-chain transfers of WETH.
-
-The introduction of this mechanism enables WETH transfers across several key lanes:
-
-- Ethereum Mainnet to/from Arbitrum Mainnet.
-- Ethereum Mainnet to/from Optimism Mainnet.
-- Arbitrum Mainnet to/from Optimism Mainnet.
-
-For a specific lane configuration, go to the [Mainnet Supported Networks](/ccip/supported-networks/v1_2_0/mainnet) page. For more detailed information on the _Lock and Unlock_ mechanism and its applications, read the [Token Pools](/ccip/architecture#token-pools) section.
-
-### Gas limit increase on mainnet
-
-The maximum [gasLimit](/ccip/api-reference/client#evmextraargsv1) that you can set for CCIP messages on mainnet has been increased to 3,000,000 gas units. The change has been documented in the [Service Limits](/ccip/service-limits) page.
-
-## v1.0.0 deprecated on mainnet - 2024-04-01
-
-CCIP v1.0.0 is no longer supported on **mainnet**. You must use the new router addresses listed in the [CCIP v1.2.0 configuration page](/ccip/supported-networks/v1_2_0/mainnet).
-
-## Wemix and Kroma - 2024-03-11
-
-Chainlink CCIP is publicly available on Wemix and Kroma for both mainnet and testnet.
-
-## v1.0.0 deprecated on testnet - 2024-02-07
-
-CCIP v1.0.0 is no longer supported on **testnet**. You must use the new router addresses listed in the [CCIP v1.2.0
-configuration page](/ccip/supported-networks/v1_2_0/testnet).
-
-## v1.2.0 release on mainnet - 2024-01-15
-
-<Aside type="caution" title="Deprecation Notice for CCIP v1.0.0 on Mainnet">
-  CCIP v1.0.0 has been deprecated on mainnet. You must use the new router addresses listed in this page **before March
-  31st, 2024**. Please note that there is no change to the router interface. The CCIP v1.0.0 mainnet routers will
-  continue to function in parallel **until March 31st, 2024**, but we highly recommend switching to the v1.2.0 routers
-  as soon as possible. If you currently use CCIP v1.0.0, use the [@chainlink/contracts-ccip npm package version
-  0.7.6](https://www.npmjs.com/package/@chainlink/contracts-ccip/v/0.7.6). To migrate to v1.2.0, use [version 1.2.1 of
-  the npm package](https://www.npmjs.com/package/@chainlink/contracts-ccip/v/1.2.1) or later. Please refer to the
-  [release notes](/ccip/release-notes) for a comprehensive overview of the enhancements and new features in v1.2.0.
-</Aside>
-
-- There is no change to the router interface, but you must use the new router addresses listed in the [CCIP v1.2.0
-  configuration page](/ccip/supported-networks/v1_2_0/mainnet).
-- Added support for USDC transfers. USDC transfers are currently supported on the following lanes:
-
-  - From Ethereum Mainnet to Avalanche Mainnet.
-  - From Ethereum Mainnet to Arbitrum Mainnet.
-  - From Ethereum Mainnet to Base Mainnet.
-  - From Ethereum Mainnet to Optimism Mainnet.
-  - From Optimism Mainnet to Base Mainnet.
-  - From Optimism Mainnet to Ethereum Mainnet.
-  - From Avalanche Mainnet to Ethereum Mainnet.
-  - From Base Mainnet to Arbitrum Mainnet.
-  - From Base Mainnet to Optimism Mainnet.
-  - From Base Mainnet to Ethereum Mainnet.
-
-  Refer to the [Supported Networks](/ccip/supported-networks/v1_2_0/mainnet) to get a specific lane's token addresses and rate limits.
-
-- We've simplified the message sequencing process in our CCIP message handling by removing the `strict` sequencing flag from the [extraArgs](/ccip/api-reference/client#evmextraargsv1) field in [CCIP messages](/ccip/api-reference/client#evm2anymessage).
-
-- The gas limit and maximum message data length for CCIP messages have been adjusted on mainnets. These changes are detailed in the [Service Limits](/ccip/service-limits) documentation.
-
-- To interact with CCIP v1.2.0 , use the [@chainlink/contract-ccip](https://www.npmjs.com/package/@chainlink/contracts-ccip) npm package.
-
-## Arbitrum Sepolia - 2023-12-15
-
-Chainlink CCIP is publicly available on Arbitrum Sepolia.
-
-See the [CCIP testnet configuration page](/ccip/supported-networks/testnet) for more information.
-
-## v1.2.0 release on testnet - 2023-12-08
-
-<Aside type="caution" title="Deprecation Notice for CCIP v1.0.0 on Testnet">
-  CCIP v1.0.0 has been deprecated on testnet. You must use the new router addresses listed in the [CCIP v1.2.0
-  configuration page](/ccip/supported-networks/v1_2_0/testnet) **before January 31st, 2024**. Please note that there is
-  no change to the router interface. The CCIP v1.0.0 testnet routers will continue to function in parallel **until
-  January 31st, 2024**, but we highly recommend switching to the v1.2.0 routers as soon as possible. If you currently
-  use CCIP v1.0.0, use the [@chainlink/contracts-ccip npm package version
-  0.7.6](https://www.npmjs.com/package/@chainlink/contracts-ccip/v/0.7.6). To migrate to v1.2.0, use [version 1.2.1 of
-  the npm package](https://www.npmjs.com/package/@chainlink/contracts-ccip/v/1.2.1) or later.
-</Aside>
-
-- There is no change to the router interface, but you must use the new router addresses listed in the [CCIP v1.2.0
-  configuration page](/ccip/supported-networks/v1_2_0/testnet).
-- Added support for USDC transfers. USDC transfers are currently supported on the following lanes:
-
-  - From Optimism Goerli to Avalanche Fuji.
-  - From Optimism Goerli to Base Goerli.
-  - From Avalanche Fuji to Optimism Goerli.
-  - From Avalanche Fuji to Base Goerli.
-  - From Base Goerli to Optimism Goerli.
-  - From Base Goerli to Avalanche Fuji.
-
-  Refer to the [Supported Networks](/ccip/supported-networks/v1_2_0/testnet) to get a specific lane's token addresses and rate limits.
-
-- We've simplified the message sequencing process in our CCIP message handling by removing the `strict` sequencing flag from the [extraArgs](/ccip/api-reference/client#evmextraargsv1) field in [CCIP messages](/ccip/api-reference/client#evm2anymessage).
-
-- The gas limit and maximum message data length for CCIP messages have been adjusted on testnets. These changes are detailed in the [Service Limits](/ccip/service-limits) documentation.
-
-- To interact with CCIP v1.2.0 , use the [@chainlink/contract-ccip](https://www.npmjs.com/package/@chainlink/contracts-ccip) npm package.
-
-## Arbitrum Goerli - 2023-11-17
-
-Arbitrum Goerli is no longer supported.
-
-Arbitrum Sepolia support will be added at a later date.
-
-## New mainnets - 2023-09-27
-
-Added BNB and Base mainnets:
-
-- BNB mainnet.
-- Base mainnet.
-
-See the [supported networks](/ccip/supported-networks) page for more information.
-
-## New mainnet - 2023-09-21
-
-Added Arbitrum mainnet:
-
-- Arbitrum mainnet.
-
-See the [supported networks](/ccip/supported-networks) page for more information.
-
-## New testnets - 2023-08-25
-
-Added BNB and Base testnets:
-
-- BNB testnet.
-- Base Goerli.
-
-See the [supported networks](/ccip/supported-networks) page for more information.
-
-## Testnet GA release - 2023-07-20
-
-Chainlink CCIP is publicly available on the following testnet chains:
-
-- Ethereum Sepolia.
-- Optimism Goerli.
-- Avalanche Fuji.
-- Arbitrum Goerli.
-- Polygon Mumbai.
-
-See the [supported networks](/ccip/supported-networks) page for more information.
-
-## Mainnet Early Access - 2023-07-17
-
-<Aside type="note" title="Mainnet Access">
-  [Apply for Mainnet Early Access](https://chainlinkcommunity.typeform.com/ccip-form?#ref_id=ccip_docs) to get started.
-</Aside>
-
-Chainlink CCIP is available on the following networks:
-
-- Ethereum mainnet.
-- Optimism mainnet.
-- Avalanche mainnet.
-- Polygon mainnet.
-
-See the [supported networks](/ccip/supported-networks) page for more information.
+<ReleaseNotes topic="ccip"></ReleaseNotes>