From 515f0bcd682fe6cc3a182701e6bf0fa3d1b7990c Mon Sep 17 00:00:00 2001 From: Joel Willmore <95916148+jlwllmr@users.noreply.github.com> Date: Fri, 6 Dec 2024 10:00:18 +0000 Subject: [PATCH] Update CCIP Read page (#880) * Modify wording and add CCIP section * Rename file and add rediret * Amend sidebar and paths * Address some errors * Americanize --- docs/get-started/how-to/deploy-subdomain.mdx | 2 +- .../{ccip-read-gateway.mdx => ccip-read.mdx} | 29 ++++++++++++------- docs/release-notes.mdx | 2 +- mlc_config.json | 6 ++++ redirects.json | 7 +++-- sidebars.js | 2 +- 6 files changed, 33 insertions(+), 15 deletions(-) rename docs/get-started/tooling/cross-chain/{ccip-read-gateway.mdx => ccip-read.mdx} (78%) diff --git a/docs/get-started/how-to/deploy-subdomain.mdx b/docs/get-started/how-to/deploy-subdomain.mdx index 6babf7708b..202fd1d2b7 100644 --- a/docs/get-started/how-to/deploy-subdomain.mdx +++ b/docs/get-started/how-to/deploy-subdomain.mdx @@ -114,7 +114,7 @@ file: Copy this address — you'll need it in the next step. The contracts to manage your subdomains on Linea have now been deployed. The next step is to link -these subdomains to your L1 domain on L1 for [CCIP resolution](../tooling/cross-chain/ccip-read-gateway.mdx) to work. +these subdomains to your L1 domain on L1 for [CCIP resolution](../tooling/cross-chain/ccip-read.mdx) to work. ### 2. Set the Linea target resolution diff --git a/docs/get-started/tooling/cross-chain/ccip-read-gateway.mdx b/docs/get-started/tooling/cross-chain/ccip-read.mdx similarity index 78% rename from docs/get-started/tooling/cross-chain/ccip-read-gateway.mdx rename to docs/get-started/tooling/cross-chain/ccip-read.mdx index 8bdfeb9c1b..683863e25b 100644 --- a/docs/get-started/tooling/cross-chain/ccip-read-gateway.mdx +++ b/docs/get-started/tooling/cross-chain/ccip-read.mdx @@ -6,16 +6,15 @@ image: /img/socialCards/ccip-read.jpg import LineaCCIPGraphic from "/img/get_started/tooling/cross_chain/ccip_read_gateway/Linea_ENS_CCIP_read.svg" -[CCIP Read](https://eips.ethereum.org/EIPS/eip-3668), also referred to by its -full name [Cross-chain Interoperability Protocol](https://chain.link/cross-chain), -is a protocol developed by Chainlink to enable applications to access -cross-chain (i.e. on an L2) or offchain data through a gateway server. +[CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) is a protocol developed by ENS that introduces +functionality for cross-chain data retrieval through a gateway server. It extends the [Cross Chain +Interoperability Protocol (CCIP)](https://chain.link/cross-chain) developed by Chainlink, who funded +its development through a [Chainlink Community Grant](https://blog.chain.link/ens-grant-for-ccip-read-development/). -Ethereum Name Service (ENS) implements CCIP Read so that it can resolve domains -on Ethereum even if the relevant data and records are stored on an L2 chain — an -offchain resolver framework. The process is trust-minimal, as the gateway -returns a storage proof that can be verified on L1, and which is immune from any -intervention or tampering. +Ethereum Name Service (ENS) implements CCIP Read so that it can resolve domains on Ethereum even if +the relevant data and records are stored on an L2 chain—an offchain resolver framework. The +process is trust-minimal, as the gateway returns a storage proof that can be verified on L1, and +which is immune from any intervention or tampering. Linea adapted the functionality of the relevant ENS contract, [`evm-gateway`](https://github.com/ensdomains/evmgateway), so that it would function correctly with Linea's sparse Merkle tree design. The @@ -27,7 +26,17 @@ Read more about sparse Merkle trees in our [architecture documentation](../../co ::: -### Linea ENS +## CCIP + +The Chainlink CCIP is middleware designed to enable traditional backends to securely interact with +blockchains, preventing the need for organizations to devote resources to developing case-by-case +solutions to this problem. This enables applications to transfer assets and data between chains, +allowing developers to access different chains for their relative strengths, and also access a +larger audience. + +Read more about CCIP in the [Chainlink documentation](https://docs.chain.link/ccip). + +## Linea ENS Linea ENS allows Linea users to register human-readable domains for considerably lower fees than on Ethereum Mainnet, it also leverages smart contracts with diff --git a/docs/release-notes.mdx b/docs/release-notes.mdx index a6277b17de..a0da6f3fad 100644 --- a/docs/release-notes.mdx +++ b/docs/release-notes.mdx @@ -179,7 +179,7 @@ contracts created by ENS have been adjusted by the Linea team to ensure they wor Sparse Merkle Tree system. The CCIP Read functionality can be applied to any context where a L1 protocol may benefit from -securely querying data on Linea. See our [page on CCIP Read](../docs/get-started/tooling/cross-chain/ccip-read-gateway.mdx) +securely querying data on Linea. See our [page on CCIP Read](../docs/get-started/tooling/cross-chain/ccip-read.mdx) for more information and guidance on how to use the relevant contracts. The Linea repository containing the relevant contracts is [here](https://github.com/Consensys/linea-ens). diff --git a/mlc_config.json b/mlc_config.json index 759f71b137..5c8c204632 100644 --- a/mlc_config.json +++ b/mlc_config.json @@ -20,6 +20,12 @@ }, { "pattern": "https://rpc.sepolia.linea.build" + }, + { + "pattern": "https://bridge.linea.build/" + }, + { + "pattern": "https://goerli.etherscan.io/" } ] } diff --git a/redirects.json b/redirects.json index 942bef194b..ed991d0fcd 100644 --- a/redirects.json +++ b/redirects.json @@ -332,8 +332,11 @@ "from": "/developers/tooling/oracles/dia" }, { - "to": "/get-started/tooling/cross-chain/ccip-read-gateway", - "from": "/developers/tooling/cross-chain/ccip-read-gateway" + "to": "/get-started/tooling/cross-chain/ccip-read", + "from": [ + "/developers/tooling/cross-chain/ccip-read-gateway", + "/get-started/tooling/cross-chain/ccip-read-gateway" + ] }, { "to": "/get-started/tooling/cross-chain", diff --git a/sidebars.js b/sidebars.js index 64159cd0e0..c8a2cd2264 100644 --- a/sidebars.js +++ b/sidebars.js @@ -218,7 +218,7 @@ const sidebars = { }, items: [ "get-started/tooling/cross-chain/axelar", - "get-started/tooling/cross-chain/ccip-read-gateway", + "get-started/tooling/cross-chain/ccip-read", "get-started/tooling/cross-chain/layerzero", "get-started/tooling/cross-chain/shortcuts", ],