--- title: Web3 description: Cloudflare offers gateways to various networks to help Web3 developers do what they do best, develop applications without having to worry about running infrastructure. image: https://developers.cloudflare.com/core-services-preview.png --- > Documentation Index > Fetch the complete documentation index at: https://developers.cloudflare.com/web3/llms.txt > Use this file to discover all available pages before exploring further. [Skip to content](#%5Ftop) # Web3 Develop Web3 applications without having to worry about running infrastructure Add-on feature Web3 (also called the distributed web) refers to a set of technologies for hosting content and applications on decentralized networks — where data is stored across many computers rather than on a single server. These networks use consensus protocols to agree on the state of shared data without relying on a central authority. Note Enterprise customers can preview this product as a [non-contract service](https://developers.cloudflare.com/billing/understand/preview-services/), which provides full access, free of metered usage fees, limits, and certain other restrictions. --- ## Features ### IPFS Gateway Paid add-on Provides a read-only, HTTP-accessible interface to the [Interplanetary File System (IPFS)](https://developers.cloudflare.com/web3/ipfs-gateway/concepts/ipfs/). [ Use IPFS Gateway ](https://developers.cloudflare.com/web3/ipfs-gateway/) ### Ethereum Gateway Paid add-on Gives you read and write access to the [Ethereum network](https://developers.cloudflare.com/web3/ethereum-gateway/concepts/ethereum/) without installing any software on your computer. [ Use Ethereum Gateway ](https://developers.cloudflare.com/web3/ethereum-gateway/) --- ## Benefits Cloudflare's Web3 gateways provide HTTP-accessible interfaces to Web3 networks. Instead of running your own IPFS or Ethereum node, you access these networks through Cloudflare, which provides: * **Ease of access**: Access content from Web3 networks without installing or running any special software. * **Security**: Get the protection benefits of Cloudflare's global anycast network for [enhanced security ↗](https://blog.cloudflare.com/cloudflare-thwarts-17-2m-rps-ddos-attack-the-largest-ever-reported/). * **Reduced maintenance**: Cloudflare — not your developers — maintains and monitors the gateway infrastructure. * **Reliability**: Cloudflare's global anycast network provides a high level of [reliability and availability ↗](https://www.cloudflare.com/network/). * **Performance**: With data centers in [hundreds of cities worldwide ↗](https://www.cloudflare.com/network/), responses are cached and served from locations close to your end users. --- ## More resources [Plans](https://www.cloudflare.com/plans/#overview) Compare available Cloudflare plans [Pricing](https://dash.cloudflare.com/?to=/:account/:zone/web3/) Explore pricing options for Web3 Gateways in the dashboard ```json {"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"item":{"@id":"/directory/","name":"Directory"}},{"@type":"ListItem","position":2,"item":{"@id":"/web3/","name":"Web3"}}]} ``` --- --- title: About description: How Cloudflare Web3 gateways connect HTTP clients to decentralized networks. image: https://developers.cloudflare.com/core-services-preview.png --- > Documentation Index > Fetch the complete documentation index at: https://developers.cloudflare.com/web3/llms.txt > Use this file to discover all available pages before exploring further. [Skip to content](#%5Ftop) # About Cloudflare Web3 gateways let your application interact with decentralized networks (IPFS and Ethereum) using standard HTTP requests. Instead of running your own IPFS or Ethereum node, you point your domain at Cloudflare and the gateway handles network communication on your behalf. When you [create a gateway](https://developers.cloudflare.com/web3/how-to/manage-gateways/#create-a-gateway), Cloudflare automatically creates and adds specific [DNS records](https://developers.cloudflare.com/web3/reference/gateway-dns-records/) to your Cloudflare account. When the hostname associated with your gateway receives requests, its DNS records route these requests to a Cloudflare Workers script that communicates with the underlying network. ![Cloudflare's Web3 gateways provide HTTP-accessible interfaces to the IPFS and Ethereum networks. For more details, continue reading.](https://developers.cloudflare.com/_astro/web3-gateway-flow-diagram.C8S74hHM_261bFb.webp) ## Read operations When your application sends a read request (for example, fetching a file from IPFS or querying an Ethereum account balance), the gateway checks whether the response is already cached at a nearby Cloudflare data center. * If cached, the gateway returns the content immediately over HTTP, without contacting the underlying network. * If not cached, the gateway fetches the content from Cloudflare's own IPFS or Ethereum nodes, caches it for future requests, and returns it over HTTP. ## Write operations Note Only available for gateways to EVM-based chains, such as [Ethereum](https://developers.cloudflare.com/web3/how-to/use-ethereum-gateway). Write operations submit new data to the network. For example, sending a transaction or deploying a smart contract. The gateway forwards your request to one of Cloudflare's Ethereum nodes, which places the transaction in its mempool (a queue of pending transactions waiting to be included in a block). From there, the network's validators select transactions from the mempool, group them into a block, and reach consensus on the block's validity. Once the block is accepted, it becomes part of the permanent blockchain record. The gateway returns a transaction ID so your application can track the result. ```json {"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"item":{"@id":"/directory/","name":"Directory"}},{"@type":"ListItem","position":2,"item":{"@id":"/web3/","name":"Web3"}},{"@type":"ListItem","position":3,"item":{"@id":"/web3/about/","name":"About"}}]} ``` --- --- title: Get started description: Set up a Cloudflare Web3 gateway for Ethereum or IPFS. image: https://developers.cloudflare.com/core-services-preview.png --- > Documentation Index > Fetch the complete documentation index at: https://developers.cloudflare.com/web3/llms.txt > Use this file to discover all available pages before exploring further. [Skip to content](#%5Ftop) # Get started Use this tutorial to set up a Cloudflare Web3 gateway, which gives your application HTTP access to the IPFS or Ethereum network without running your own node. ## Before you begin Before you start, make sure you have [set up an account](https://developers.cloudflare.com/fundamentals/account/) and [added your website](https://developers.cloudflare.com/fundamentals/manage-domains/add-site/) to Cloudflare. ## Step 1 - Subscribe to a gateway Web3 gateways are a paid add-on. To get access, [subscribe to a gateway](https://developers.cloudflare.com/web3/how-to/enable-gateways/). ## Step 2 - Create a gateway After purchasing a gateway subscription, create a gateway. Create via dashboard To create a gateway using the dashboard: 1. In the Cloudflare dashboard, go to the **Web3** page. [ Go to **Web3** ](https://dash.cloudflare.com/?to=/:account/:zone/web3) 2. Click **Create Gateway**. 3. Enter the following information: * **Hostname**: Enter a hostname to use as your gateway, which has to be a subdomain of the current Cloudflare zone. * **Gateway Description**: Enter a description to help distinguish between different gateways. * **Gateway Type**: Select a gateway target of [IPFS DNSLink](https://developers.cloudflare.com/web3/ipfs-gateway/concepts/dnslink/), [IPFS Universal Path](https://developers.cloudflare.com/web3/ipfs-gateway/concepts/universal-gateway/), or [Ethereum](https://developers.cloudflare.com/web3/ethereum-gateway/). * **DNSLink**: Only applicable to IPFS gateways, more details at [DNSLink](https://developers.cloudflare.com/web3/ipfs-gateway/concepts/dnslink/#how-is-it-used-with-cloudflare). 1. Click **Deploy**. Create via API To create a gateway using the API, send a [POST](https://developers.cloudflare.com/api/resources/web3/subresources/hostnames/methods/create/) request that includes the following parameters: * `name`: The hostname that will point to the target gateway via a `CNAME` record. * `target`: The gateway target for the hostname (`ethereum`, `ipfs`, `ipfs_universal_path`). If you need help with API authentication, refer to [Cloudflare API documentation](https://developers.cloudflare.com/fundamentals/api/). Request ``` curl "https://api.cloudflare.com/client/v4/zones/{zone_id}/web3/hostnames" \ --header "X-Auth-Email: " \ --header "X-Auth-Key: " \ --header "Content-Type: application/json" \ --data '{ "name": "gateway.example.com", "description": "This is my IPFS gateway.", "target": "ipfs", "dnslink": "/ipns/onboarding.ipfs.cloudflare.com" }' ``` The response contains the complete definition of the new gateway. Response ``` { "success": true, "errors": [], "messages": [], "result": { "id": "", "name": "gateway.example.com", "description": "This is my IPFS gateway.", "status": "active", "target": "ipfs", "dnslink": "/ipns/onboarding.ipfs.cloudflare.com", "created_on": "", "modified_on": "" } } ``` When you create a gateway, Cloudflare automatically: * Creates and adds [records to your Cloudflare DNS](https://developers.cloudflare.com/web3/reference/gateway-dns-records/) so your gateway can receive and route traffic appropriately. * [Proxies](https://developers.cloudflare.com/dns/proxy-status/) traffic to that hostname. * Issues an SSL/TLS certificate to cover the specified hostname. ## Step 3 - Customize Cloudflare settings Once your gateway becomes [active](https://developers.cloudflare.com/web3/reference/gateway-status/), you can customize the Cloudflare settings associated with your hostname. Since your traffic is automatically proxied through Cloudflare, you customize your website settings to take advantage of various [security, performance, and reliability](https://developers.cloudflare.com/fundamentals/concepts/how-cloudflare-works/#cloudflare-as-a-reverse-proxy) benefits. ## Step 4 - Restrict gateway access (optional) If you are using your gateway for backend services, you may want to use Cloudflare Zero Trust to [restrict gateway access](https://developers.cloudflare.com/web3/how-to/restrict-gateway-access/). ## Step 5 - Set up usage notifications Since this is a service with [usage-based billing](https://developers.cloudflare.com/billing/understand/usage-based-billing/), Cloudflare recommends that you set up usage-based billing notifications to avoid unexpected bills. To set up those notifications: 1. In the Cloudflare dashboard, go to the **Notifications** page. [ Go to **Notifications** ](https://dash.cloudflare.com/?to=/:account/notifications) 2. On **Alert Type** of **Usage Based Billing**, click **Select**. 3. Fill out the following information: * **Name** * **Product** * **Notification limit** (exact metric will vary based on product) * **Notification email** Note Some plans also have access to alerts through [PagerDuty](https://developers.cloudflare.com/notifications/get-started/configure-pagerduty/) and [Webhooks](https://developers.cloudflare.com/notifications/get-started/configure-webhooks/). 4. Select **Save**. ## Step 6 - Use the gateway Once you have created a gateway and updated your Cloudflare settings, you can start using your [IPFS](https://developers.cloudflare.com/web3/how-to/use-ipfs-gateway/) or [Ethereum](https://developers.cloudflare.com/web3/how-to/use-ethereum-gateway/). ```json {"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"item":{"@id":"/directory/","name":"Directory"}},{"@type":"ListItem","position":2,"item":{"@id":"/web3/","name":"Web3"}},{"@type":"ListItem","position":3,"item":{"@id":"/web3/get-started/","name":"Get started"}}]} ``` --- --- title: IPFS Gateway description: Serve IPFS content through Cloudflare without running an IPFS node. image: https://developers.cloudflare.com/core-services-preview.png --- > Documentation Index > Fetch the complete documentation index at: https://developers.cloudflare.com/web3/llms.txt > Use this file to discover all available pages before exploring further. [Skip to content](#%5Ftop) # IPFS Gateway Cloudflare's IPFS gateway provides a read-only, HTTP-accessible interface to the [Interplanetary File System (IPFS)](https://developers.cloudflare.com/web3/ipfs-gateway/concepts/ipfs/). This gateway does not require you to download any special software or give up any storage space on your computer. * [ Concepts ](https://developers.cloudflare.com/web3/ipfs-gateway/concepts/) * [ Reference ](https://developers.cloudflare.com/web3/ipfs-gateway/reference/) * [ Troubleshooting ](https://developers.cloudflare.com/web3/ipfs-gateway/troubleshooting/) ## Availability | Free | Pro | Business | Enterprise | | | -------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Availability | Yes (Usage-based billing) | Yes (Usage-based billing) | Yes (Usage-based billing) | Yes (Usage-based billing) | | Total gateways | 15 | 15 | 15 | Unlimited | | Gateway types | [DNSLink](https://developers.cloudflare.com/web3/ipfs-gateway/concepts/dnslink/) | [DNSLink](https://developers.cloudflare.com/web3/ipfs-gateway/concepts/dnslink/) | [DNSLink](https://developers.cloudflare.com/web3/ipfs-gateway/concepts/dnslink/) | [DNSLink](https://developers.cloudflare.com/web3/ipfs-gateway/concepts/dnslink/),[Universal Gateway](https://developers.cloudflare.com/web3/ipfs-gateway/concepts/universal-gateway/) | | Included bandwidth (without additional cost) | 50 GB data transfer | 50 GB data transfer | 50 GB data transfer | 100 GB data transfer | | File size limit | None | None | None | None | Note For more pricing details, refer to the [Web3 product page ↗](https://www.cloudflare.com/application-services/products/web3/). ```json {"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"item":{"@id":"/directory/","name":"Directory"}},{"@type":"ListItem","position":2,"item":{"@id":"/web3/","name":"Web3"}},{"@type":"ListItem","position":3,"item":{"@id":"/web3/ipfs-gateway/","name":"IPFS Gateway"}}]} ``` --- --- title: DNSLink gateways description: Use DNSLink to map domain names to IPFS content. image: https://developers.cloudflare.com/core-services-preview.png --- > Documentation Index > Fetch the complete documentation index at: https://developers.cloudflare.com/web3/llms.txt > Use this file to discover all available pages before exploring further. [Skip to content](#%5Ftop) ### Tags [ DNS ](https://developers.cloudflare.com/search/?tags=DNS) # DNSLink gateways When you set up a gateway with a DNSLink record, that gateway is restricted to a particular piece of content — either a specific Content Identifier (CID) or an Interplanetary Name Service (IPNS) hostname. This is called a restricted gateway. A restricted gateway differs from a [universal gateway](https://developers.cloudflare.com/web3/ipfs-gateway/concepts/universal-gateway/), which allows users to access any content hosted on the IPFS network. ## What is DNSLink? Every file on [IPFS](https://developers.cloudflare.com/web3/ipfs-gateway/concepts/ipfs/) is identified by a [CID ↗](https://docs.ipfs.io/concepts/glossary/#cid) — a long string like `bafybeiaysi4s6lnjev27ln5icwm6tueaw2vdykrtjkwiphwekaywqhcjze`. These CIDs are not practical for end users to type or remember, the same way IP addresses (`192.0.2.1`) are not practical compared to domain names (`example.com`). DNSLink solves this by mapping a human-readable domain name to an IPFS CID through a DNS TXT record. You put your website files into an IPFS directory and create a DNSLink record pointing your domain to that directory's CID. Users then access your site through a readable URL like `https://cf-ipfs.com/ipns/en.wikipedia-on-ipfs.org/`, and the gateway resolves it to the correct CID. DNSLink also simplifies content updates. When you publish a new version of your site, update the DNSLink record to point to the new CID and the gateway serves the new version automatically — no need to share a new URL. Note For additional details, refer to the official [IPFS documentation ↗](https://docs.ipfs.tech/concepts/dnslink/). ## How is it used with Cloudflare? You have the option to specify the DNSLink when you [create an IPFS gateway](https://developers.cloudflare.com/web3/how-to/manage-gateways/#create-a-gateway), which serves as a custom hostname that directs users to a website already hosted on IPFS. By default, your DNSLink path is `/ipns/onboarding.ipfs.cloudflare.com`. If you choose to put your website in a different content folder hosted at your own IPFS node or with a pinning service, you will need to specify that value. For example, the default DNSLink record for `www.example.com` would look like this: | Record type | Name | Content | | ----------- | ------------------------- | -------------------------------------------- | | TXT | \_dnslink.www.example.com | dnslink=/ipns/onboarding.ipfs.cloudflare.com | For more details about the DNS records created by the IPFS gateway, refer to [Gateway DNS records](https://developers.cloudflare.com/web3/reference/gateway-dns-records/). ```json {"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"item":{"@id":"/directory/","name":"Directory"}},{"@type":"ListItem","position":2,"item":{"@id":"/web3/","name":"Web3"}},{"@type":"ListItem","position":3,"item":{"@id":"/web3/ipfs-gateway/","name":"IPFS Gateway"}},{"@type":"ListItem","position":4,"item":{"@id":"/web3/ipfs-gateway/concepts/","name":"Concepts"}},{"@type":"ListItem","position":5,"item":{"@id":"/web3/ipfs-gateway/concepts/dnslink/","name":"DNSLink gateways"}}]} ``` --- --- title: Interplanetary File System (IPFS) description: How the InterPlanetary File System stores and retrieves content. image: https://developers.cloudflare.com/core-services-preview.png --- > Documentation Index > Fetch the complete documentation index at: https://developers.cloudflare.com/web3/llms.txt > Use this file to discover all available pages before exploring further. [Skip to content](#%5Ftop) # Interplanetary File System (IPFS) The Interplanetary File System (IPFS) is a peer-to-peer file storage network. Instead of storing files on a single server (the way traditional web hosting works), IPFS distributes files across many computers around the world. Any computer can join the IPFS network by installing the IPFS software and start hosting and serving files. If someone uploads a file to the IPFS network, anyone else running IPFS can view and download that file — no central server is involved. ## Content Identifiers Every file added to IPFS is given a unique address derived from a hash of the file's content. This address is called a Content Identifier (CID). A CID contains two pieces of information: the hash of the file and an identifier for the hash algorithm used, combined into a single string. Because the CID is derived from the content itself, two identical files always produce the same CID, and any change to a file produces a different CID. This is what makes IPFS "content-addressed" — you look up files by what they contain, not by where they are stored. IPFS uses [SHA-256 ↗](https://en.wikipedia.org/wiki/SHA-2) by default, and encodes the result with [Base58 ↗](https://en.wikipedia.org/wiki/Base58) — an encoding scheme that omits visually ambiguous characters (such as zero and the capital letter O) to reduce transcription errors. A CID typically looks like: `QmXoypizjW3WknFiJnKLwHCnL72vedxjQkDDP1mXWo6uco` IPFS also supports other encodings ([Base32 ↗](https://en.wikipedia.org/wiki/Base32)) and hash algorithms ([SHA-3 ↗](https://en.wikipedia.org/wiki/SHA-3), [BLAKE2 ↗](https://en.wikipedia.org/wiki/BLAKE%5F%28hash%5Ffunction%29)). ## Uploading to IPFS IPFS tracks which computers have which files using a [Distributed Hash Table (DHT) ↗](https://en.wikipedia.org/wiki/Distributed%5Fhash%5Ftable) — a lookup system that maps CIDs to the network addresses of computers hosting that content. No single computer holds the entire lookup table. Instead, each computer in the network stores a portion of it and knows where to find the rest. "Uploading" content to IPFS does not mean sending your file to a central server. It means announcing to the network that you have the content by adding an entry to the DHT that maps your file's CID to your network address. When someone else wants to download that file, they look up the CID in the DHT, find your address, and download the data directly from you. Because multiple computers can host the same file, downloads are spread across all of them. If any one host goes offline, the others continue to serve the content. This redundancy is what gives IPFS its speed and reliability advantages over single-server hosting. ## Directories You can upload more than just individual files. For example, consider a folder called `example`, which has exactly one file, `example_text.txt`, containing the string `I'm trying out IPFS`. If that folder were uploaded with the command `ipfs add -r ./example`, both the folder and the file it contains would have their own CID. In this case, the folder would have the CID `QmdbaSQbGU6Wo9i5LyWWVLuU8g6WrYpWh2K4Li4QuuE8Fr` while the file would have the CID `QmXnnyufdzAWL5CqZ2RnSNgPbvCc1ALT73s6epPrRnZ1Xy`. You could then access the file in two ways: * Requesting the file directly: `https://cloudflare-ipfs.com/ipfs/QmXnnyufdzAWL5CqZ2RnSNgPbvCc1ALT73s6epPrRnZ1Xy` * Requesting the file by name, from the directory: `https://cloudflare-ipfs.com/ipfs/QmdbaSQbGU6Wo9i5LyWWVLuU8g6WrYpWh2K4Li4QuuE8Fr/example_text.txt` While the CID of a file will only change if the file itself changes, the CID of a directory changes any time **any** of the files in it change, or if any files are added/removed. Directories make it possible to address an entire static website with a single CID and access different pages of the website by requesting different files in the directory. ## Related resources For help with additional concepts, refer to the [IPFS ↗](https://docs.ipfs.tech/concepts/) documentation. ```json {"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"item":{"@id":"/directory/","name":"Directory"}},{"@type":"ListItem","position":2,"item":{"@id":"/web3/","name":"Web3"}},{"@type":"ListItem","position":3,"item":{"@id":"/web3/ipfs-gateway/","name":"IPFS Gateway"}},{"@type":"ListItem","position":4,"item":{"@id":"/web3/ipfs-gateway/concepts/","name":"Concepts"}},{"@type":"ListItem","position":5,"item":{"@id":"/web3/ipfs-gateway/concepts/ipfs/","name":"Interplanetary File System (IPFS)"}}]} ``` --- --- title: Universal Path gateway description: Access any IPFS content through the Universal Path gateway. image: https://developers.cloudflare.com/core-services-preview.png --- > Documentation Index > Fetch the complete documentation index at: https://developers.cloudflare.com/web3/llms.txt > Use this file to discover all available pages before exploring further. [Skip to content](#%5Ftop) # Universal Path gateway A Universal Path gateway is a gateway without a DNSLink record. It allows users to access any content hosted on the IPFS network by specifying a CID or IPNS path in the URL. This differs from a [restricted gateway](https://developers.cloudflare.com/web3/ipfs-gateway/concepts/dnslink/), which limits the gateway to a single piece of content (a specific CID or IPNS hostname). ## How is it used with Cloudflare? You can set up a Universal Path gateway the same way you [create any gateway](https://developers.cloudflare.com/web3/how-to/manage-gateways/). Because a Universal Path gateway is open by default, you may want to use the [gateway blocklist](https://developers.cloudflare.com/web3/how-to/manage-gateways/#update-blocklist) to prevent access to specific content. You can block one or more: * CIDs (`QmPZ9gcCEpqKTo6aq61g2nXGUhM4iCL3ewB6LDXZCtioEB`) * IPFS content paths (`/ipfs/QmYwAPJzv5CZsnA625s3Xf2nemtYgPpHdWEz79ojWnPbdG/readme`) * IPNS content paths (`/ipns/example.com`) Note This feature is limited to specific plans. For more detail, refer to [Limits](https://developers.cloudflare.com/web3/reference/limits/). ```json {"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"item":{"@id":"/directory/","name":"Directory"}},{"@type":"ListItem","position":2,"item":{"@id":"/web3/","name":"Web3"}},{"@type":"ListItem","position":3,"item":{"@id":"/web3/ipfs-gateway/","name":"IPFS Gateway"}},{"@type":"ListItem","position":4,"item":{"@id":"/web3/ipfs-gateway/concepts/","name":"Concepts"}},{"@type":"ListItem","position":5,"item":{"@id":"/web3/ipfs-gateway/concepts/universal-gateway/","name":"Universal Path gateway"}}]} ``` --- --- title: Automated deployments description: Automate IPFS content deployment with CI/CD pipelines. image: https://developers.cloudflare.com/core-services-preview.png --- > Documentation Index > Fetch the complete documentation index at: https://developers.cloudflare.com/web3/llms.txt > Use this file to discover all available pages before exploring further. [Skip to content](#%5Ftop) # Automated deployments Static sites are easy to deploy automatically. The code of the site is usually kept in a Git repository and deployed by pushing the latest commit to a repository that's connected to a Continuous Integration service like [Travis CI ↗](https://travis-ci.org/), or by pushing to a repository directly on the server and activating a post-receive hook. Either way, the production version of the site is built and then copied into the serving path of an Apache or NGINX instance. IPFS usually fits into these systems: instead of copying the production version of a website into the serving path of an HTTP server, you would upload the same files to an IPFS node and update your DNS records with the new hash. There are several tools that help with different parts of this: * [ipfs-deploy ↗](https://github.com/agentofuser/ipfs-deploy) helps upload data to a third-party pinning providers and automatically update Cloudflare-managed DNS records. * [dnslink-cloudflare ↗](https://github.com/ipfs-shipyard/dnslink-cloudflare) is a script to programmatically update DNSLink records. This can be run with the `-Q` flag of `ipfs add` that only outputs the top-level hash. * [Fission's IPFS support ↗](https://guide.fission.codes/developers/custom-domains/using-cloudflare-ipfs-gateway) lets you use the Fission IPFS app publishing system from the CLI or from GitHub Actions, while using Cloudflare-managed DNS and gateway. ```json {"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"item":{"@id":"/directory/","name":"Directory"}},{"@type":"ListItem","position":2,"item":{"@id":"/web3/","name":"Web3"}},{"@type":"ListItem","position":3,"item":{"@id":"/web3/ipfs-gateway/","name":"IPFS Gateway"}},{"@type":"ListItem","position":4,"item":{"@id":"/web3/ipfs-gateway/reference/","name":"Reference"}},{"@type":"ListItem","position":5,"item":{"@id":"/web3/ipfs-gateway/reference/automated-deployment/","name":"Automated deployments"}}]} ``` --- --- title: Peering description: Peer with IPFS content providers for faster content delivery. image: https://developers.cloudflare.com/core-services-preview.png --- > Documentation Index > Fetch the complete documentation index at: https://developers.cloudflare.com/web3/llms.txt > Use this file to discover all available pages before exploring further. [Skip to content](#%5Ftop) # Peering If you are running an IPFS node that serves many requests - like a public HTTP gateway - you may be able to speed up queries by maintaining long-lived connections to nodes that provide a large volume of data. This process is known as **Peering** and you can tell IPFS to prioritize Cloudflare's peers by editing the Peering configuration in your IPFS config file. ``` { "Peering": { "Peers": [ { "ID": "QmcFf2FH3CEgTNHeMRGhN7HNHU1EXAxoEk6EFuSyXCsvRE", "Addrs": [ "/dnsaddr/node-1.ingress.cloudflare-ipfs.com" ] }, { "ID": "QmcFmLd5ySfk2WZuJ1mfSWLDjdmHZq7rSAua4GoeSQfs1z", "Addrs": [ "/dnsaddr/node-2.ingress.cloudflare-ipfs.com" ] }, { "ID": "QmcfFmzSDVbwexQ9Au2pt5YEXHK5xajwgaU6PpkbLWerMa", "Addrs": [ "/dnsaddr/node-3.ingress.cloudflare-ipfs.com" ] }, { "ID": "QmcfJeB3Js1FG7T8YaZATEiaHqNKVdQfybYYkbT1knUswx", "Addrs": [ "/dnsaddr/node-4.ingress.cloudflare-ipfs.com" ] }, { "ID": "QmcfVvzK4tMdFmpJjEKDUoqRgP4W9FnmJoziYX5GXJJ8eZ", "Addrs": [ "/dnsaddr/node-5.ingress.cloudflare-ipfs.com" ] }, { "ID": "QmcfZD3VKrUxyP9BbyUnZDpbqDnT7cQ4WjPP8TRLXaoE7G", "Addrs": [ "/dnsaddr/node-6.ingress.cloudflare-ipfs.com" ] }, { "ID": "QmcfZP2LuW4jxviTeG8fi28qjnZScACb8PEgHAc17ZEri3", "Addrs": [ "/dnsaddr/node-7.ingress.cloudflare-ipfs.com" ] }, { "ID": "QmcfgsJsMtx6qJb74akCw1M24X1zFwgGo11h1cuhwQjtJP", "Addrs": [ "/dnsaddr/node-8.ingress.cloudflare-ipfs.com" ] }, { "ID": "Qmcfr2FC7pFzJbTSDfYaSy1J8Uuy8ccGLeLyqJCKJvTHMi", "Addrs": [ "/dnsaddr/node-9.ingress.cloudflare-ipfs.com" ] }, { "ID": "QmcfR3V5YAtHBzxVACWCzXTt26SyEkxdwhGJ6875A8BuWx", "Addrs": [ "/dnsaddr/node-10.ingress.cloudflare-ipfs.com" ] }, { "ID": "Qmcfuo1TM9uUiJp6dTbm915Rf1aTqm3a3dnmCdDQLHgvL5", "Addrs": [ "/dnsaddr/node-11.ingress.cloudflare-ipfs.com" ] }, { "ID": "QmcfV2sg9zaq7UUHVCGuSvT2M2rnLBAPsiE79vVyK3Cuev", "Addrs": [ "/dnsaddr/node-12.ingress.cloudflare-ipfs.com" ] } ] } } ``` ```json {"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"item":{"@id":"/directory/","name":"Directory"}},{"@type":"ListItem","position":2,"item":{"@id":"/web3/","name":"Web3"}},{"@type":"ListItem","position":3,"item":{"@id":"/web3/ipfs-gateway/","name":"IPFS Gateway"}},{"@type":"ListItem","position":4,"item":{"@id":"/web3/ipfs-gateway/reference/","name":"Reference"}},{"@type":"ListItem","position":5,"item":{"@id":"/web3/ipfs-gateway/reference/peering-with-content-providers/","name":"Peering"}}]} ``` --- --- title: Using IPFS with your website description: Host your website on IPFS and serve it through Cloudflare. image: https://developers.cloudflare.com/core-services-preview.png --- > Documentation Index > Fetch the complete documentation index at: https://developers.cloudflare.com/web3/llms.txt > Use this file to discover all available pages before exploring further. [Skip to content](#%5Ftop) # Using IPFS with your website Though it is not required, it is strongly recommended that websites hosted on IPFS use only relative links, unless linking to a different domain. This is because data can be accessed in many different (but ultimately equivalent) ways: * From your custom domain: `https://ipfs.tech/index.html` * From a gateway: `https://cloudflare-ipfs.com/ipns/ipfs.tech/index.html` * By immutable hash: `https://cloudflare-ipfs.com/ipfs/QmNksJqvwHzNtAtYZVqFZFfdCVciY4ojTU2oFZQSFG9U7B/index.html` Using only relative links within a web application supports all of these at once, and gives the most flexibility to the user. The exact method for switching to relative links, if you do not use them already, depends on the framework you use. ## Angular, React, Vue These popular JavaScript frameworks are covered in a [blog post ↗](https://medium.com/pinata/how-to-easily-host-a-website-on-ipfs-9d842b5d6a01) from [Pinata ↗](https://pinata.cloud/). They are fixed with minor config changes. ## Gatsby Gatsby is a JavaScript framework based on React. There is a [plugin ↗](https://www.gatsbyjs.org/packages/gatsby-plugin-ipfs/) for it that ensures links are relative. ## Jekyll Add a file `_includes/base.html` with the contents: ``` {% assign base = '' %} {% assign depth = page.url | split: '/' | size | minus: 1 %} {% if depth <= 1 %}{% assign base = '.' %} {% elsif depth == 2 %}{% assign base = '..' %} {% elsif depth == 3 %}{% assign base = '../..' %} {% elsif depth == 4 %}{% assign base = '../../..' %}{% endif %} ``` This snippet computes the relative path back to the root of the website from the current page. Update any pages that need to link to the root by adding this at the top: ``` {%- include base.html -%} ``` This snippet also prefixing any links with `{{base}}`. So for example, we would change`href="https://developers.cloudflare.com/css/main.css"` to be `href="https://developers.cloudflare.com/web3/ipfs-gateway/reference/updating-for-ipfs/%7B%7Bbase%7D%7D/css/main.css"` ## Generic For other frameworks, or if a framework was not used, there's a script called [make-relative ↗](https://github.com/tmcw/make-relative) that will parse the HTML of a website and automatically rewrite links and images to be relative. ```json {"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"item":{"@id":"/directory/","name":"Directory"}},{"@type":"ListItem","position":2,"item":{"@id":"/web3/","name":"Web3"}},{"@type":"ListItem","position":3,"item":{"@id":"/web3/ipfs-gateway/","name":"IPFS Gateway"}},{"@type":"ListItem","position":4,"item":{"@id":"/web3/ipfs-gateway/reference/","name":"Reference"}},{"@type":"ListItem","position":5,"item":{"@id":"/web3/ipfs-gateway/reference/updating-for-ipfs/","name":"Using IPFS with your website"}}]} ``` --- --- title: Troubleshooting description: Resolve common IPFS Gateway issues including 523 and 524 errors. image: https://developers.cloudflare.com/core-services-preview.png --- > Documentation Index > Fetch the complete documentation index at: https://developers.cloudflare.com/web3/llms.txt > Use this file to discover all available pages before exploring further. [Skip to content](#%5Ftop) ### Tags [ Debugging ](https://developers.cloudflare.com/search/?tags=Debugging) # Troubleshooting ## Cloudflare-specific ### No link named "ipfs" If you get a `no link named "ipfs" under <>` error message when trying to access content through Cloudflare's IPFS gateway, that means you have created a gateway without a value for the [DNSLink](https://developers.cloudflare.com/web3/ipfs-gateway/concepts/dnslink). Since Cloudflare currently only supports restricted gateways - and not [universal gateways](https://developers.cloudflare.com/web3/ipfs-gateway/concepts/universal-gateway/) \- these requests will continue to fail until you specify a DNSLink value. ### Check Cloudflare's status It is worth checking for recent incidents on Cloudflare's [status dashboard ↗](https://www.cloudflarestatus.com/) that may have affected our gateway, but the best place to get up-to-date information about issues facing IPFS is the [IPFS Discussion Forum ↗](https://discuss.ipfs.io/). ## Generic IPFS IPFS is still a developing protocol and content is often unavailable or slow to load for reasons outside of Cloudflare's control. Usually, this happens for one of the following reasons. ### The content was uploaded to a free/anonymous pinning service. Free and anonymous pinning services can often be used to get content on IPFS in a pinch, but they'll often stop pinning content soon after it's uploaded. Running your own server or using a pinning service are the recommended alternatives, and will keep your content online more reliably. ### No node with the requested content is online. Content will only stay on the IPFS network as long as there's at least one node that's serving it. If all of the nodes that were serving a given piece of content go offline, the content will be inaccessible until one of them comes back online. ### The nodes with the requested content are not publicly addressable. It's common for people who run an IPFS node on their home Wi-Fi to have very long wait times or a high rate of request failure. This is because the rest of the nodes in the IPFS network have difficulty connecting to them through their NAT (Internet router). This can be solved by setting up Port Forwarding on the router, to direct external connections to port 4001 to the host with the IPFS node, or by moving the node to a hosted server/VM. ### The nodes with the requested content are not pinning it. If several minutes have passed since files were uploaded to an IPFS node and they're still not discoverable by other gateways, it's possible the node is having trouble announcing the files to the rest of the network. You can make sure the node with the content has pinned it by running: ``` ipfs pin -r ``` And you can force the actual announcement by running: ``` ipfs dht provide -rv ``` The second command will run indefinitely and has quite complicated output, so you may want to run it in the background and omit the `-v` flag. ### The nodes with the requested content are too old. IPFS issues mandatory updates from time to time that introduce breaking protocol changes. Cloudflare tries to say ahead of these updates and may, as a result, lose connectivity with older nodes. ```json {"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"item":{"@id":"/directory/","name":"Directory"}},{"@type":"ListItem","position":2,"item":{"@id":"/web3/","name":"Web3"}},{"@type":"ListItem","position":3,"item":{"@id":"/web3/ipfs-gateway/","name":"IPFS Gateway"}},{"@type":"ListItem","position":4,"item":{"@id":"/web3/ipfs-gateway/troubleshooting/","name":"Troubleshooting"}}]} ``` --- --- title: Ethereum Gateway description: Access the Ethereum network through Cloudflare without running a node. image: https://developers.cloudflare.com/core-services-preview.png --- > Documentation Index > Fetch the complete documentation index at: https://developers.cloudflare.com/web3/llms.txt > Use this file to discover all available pages before exploring further. [Skip to content](#%5Ftop) # Ethereum Gateway Cloudflare's Ethereum Gateway gives you read and write access to the [Ethereum network](https://developers.cloudflare.com/web3/ethereum-gateway/concepts/ethereum/) without installing any software on your computer. In particular, users can read all information that has been agreed upon by the consensus of existing nodes in the network. In addition, they can write their own transactions and smart contracts to be stored by these nodes in a distributed manner. Anyone else on the network will be able to view these transactions, and even run your smart contracts using their own supply of the Ethereum currency. These interactions take place through the official [Ethereum JSON-RPC API ↗](https://github.com/ethereum/execution-apis) and use [Cloudflare-supported API methods](https://developers.cloudflare.com/web3/ethereum-gateway/reference/supported-api-methods/). ## Availability | Free | Pro | Business | Enterprise | | | --------------------------------------------- | ------------------------- | ------------------------- | ------------------------- | ------------------------- | | Availability | Yes (Usage-based billing) | Yes (Usage-based billing) | Yes (Usage-based billing) | Yes (Usage-based billing) | | Total gateways | 15 | 15 | 15 | Unlimited | | Included bandwidth (without additional cost) | 500,000 HTTP requests | 500,000 HTTP requests | 500,000 HTTP requests | 1,000,000 HTTP requests | Note For more pricing details, refer to the [Web3 product page ↗](https://www.cloudflare.com/application-services/products/web3/). ```json {"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"item":{"@id":"/directory/","name":"Directory"}},{"@type":"ListItem","position":2,"item":{"@id":"/web3/","name":"Web3"}},{"@type":"ListItem","position":3,"item":{"@id":"/web3/ethereum-gateway/","name":"Ethereum Gateway"}}]} ``` --- --- title: Ethereum network description: How the Ethereum blockchain and smart contracts work. image: https://developers.cloudflare.com/core-services-preview.png --- > Documentation Index > Fetch the complete documentation index at: https://developers.cloudflare.com/web3/llms.txt > Use this file to discover all available pages before exploring further. [Skip to content](#%5Ftop) # Ethereum network The Ethereum network is a decentralized platform for running programs called smart contracts. A smart contract is a program stored at a unique address on the network that executes automatically when triggered by a transaction. Because smart contracts run on Ethereum, they can handle any computation that a general-purpose programming language can express. When a smart contract runs, every node in the network independently verifies the result. The network then reaches consensus — all nodes agree on the outcome — and the result becomes part of the permanent record. ## Smart contracts Running a smart contract requires paying a fee in Ethereum's currency, ETH. This fee (called "gas") compensates the network's validators for the computational work of executing your transaction and adding it to the blockchain. If the smart contract transfers ETH between accounts, those balance changes are also recorded in the blockchain. The blockchain therefore represents a complete, verifiable record of the network's current state — including every account balance and every smart contract's stored data. ## Addressing Transactions are grouped into blocks, and blocks are chained together in sequence to form the blockchain — a complete history of every transaction since the network started. Each block has a unique hash identifier (a long hexadecimal string like `0xd4e56740f876aef8c010b86a40d5f56745a118d0906a34e69aec8c0db1cb8fa3q`), and each transaction within a block has its own hash as well. You can use either hash to look up and inspect specific blocks or transactions. When a new block is added, it is broadcast to every node in the network. Because all transactions are public and verifiable, the blockchain provides a transparent and accountable record of the network's state. ## Read and write content To read data from Ethereum — such as checking account balances or querying smart contract state — you need access to an Ethereum node. You can run a node yourself (for example, using [go-ethereum ↗](https://github.com/ethereum/go-ethereum/)) or use a gateway like Cloudflare's. Reads are performed through the [JSON-RPC API ↗](https://github.com/ethereum/wiki/wiki/JSON-RPC), a standard interface for sending queries to the network. To write data — such as sending a transaction or deploying a smart contract — you also use the JSON-RPC API, but you must additionally provide ETH to pay for the transaction fee and sign the transaction with the private key from your [Ethereum wallet ↗](https://www.ethereum.org/use/#%5F3-what-is-a-wallet-and-which-one-should-i-use). Once submitted, the transaction is broadcast to the network and included in the blockchain. ## Connect your website to the gateway To access the Ethereum network from a custom domain name — without running your own node — you can [create an Ethereum Gateway](https://developers.cloudflare.com/web3/how-to/manage-gateways/#create-a-gateway) through Cloudflare. ## Related resources If you’re interested in learning more, you can read the official [RPC documentation ↗](https://github.com/ethereum/wiki/wiki/JSON-RPC), along with the official documentation [provided by Ethereum ↗](https://www.ethereum.org/use/). ```json {"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"item":{"@id":"/directory/","name":"Directory"}},{"@type":"ListItem","position":2,"item":{"@id":"/web3/","name":"Web3"}},{"@type":"ListItem","position":3,"item":{"@id":"/web3/ethereum-gateway/","name":"Ethereum Gateway"}},{"@type":"ListItem","position":4,"item":{"@id":"/web3/ethereum-gateway/concepts/","name":"Concepts"}},{"@type":"ListItem","position":5,"item":{"@id":"/web3/ethereum-gateway/concepts/ethereum/","name":"Ethereum network"}}]} ``` --- --- title: Node types description: Full nodes, archive nodes, and their role in Ethereum queries. image: https://developers.cloudflare.com/core-services-preview.png --- > Documentation Index > Fetch the complete documentation index at: https://developers.cloudflare.com/web3/llms.txt > Use this file to discover all available pages before exploring further. [Skip to content](#%5Ftop) # Node types Ethereum nodes are the computers that store blockchain data and process queries. There are three types, each with different trade-offs between storage requirements and query capabilities. ## Full nodes Full nodes store the current state of the blockchain and validate new blocks as they are produced. Once fully synced with the network, a full node can answer queries about any current blockchain data. Full nodes do not retain every historical state — they can recalculate past states when needed, but this requires additional computation. ## Light nodes Light nodes store only block headers (summaries of each block) rather than the full blockchain state. They can query the Ethereum network but rely on full nodes to provide and verify the underlying data. This makes them much smaller and faster to set up, but less self-sufficient. ## Archive nodes Archive nodes are full nodes that also store every historical state of the blockchain. Because they keep this data readily available in local storage, they can answer queries about past states (such as "what was this account's balance at block 5,000,000?") much faster than a full node, which would need to recalculate that state. ## Nodes at Cloudflare Cloudflare's Ethereum Gateway provides access to full and archive nodes. The archive nodes serve requests for the following [RPC state methods ↗](https://ethereum.org/en/developers/docs/apis/json-rpc/#state%5Fmethods) when the block number parameter is before the most recent 128 blocks or the default block parameter is set to `earliest`: * [eth\_getBalance ↗](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth%5Fgetbalance) * [eth\_getCode ↗](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth%5Fgetcode) * [eth\_getTransactionCount ↗](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth%5Fgettransactioncount) * [eth\_getStorageAt ↗](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth%5Fgetstorageat) * [eth\_call ↗](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth%5Fcall) ```json {"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"item":{"@id":"/directory/","name":"Directory"}},{"@type":"ListItem","position":2,"item":{"@id":"/web3/","name":"Web3"}},{"@type":"ListItem","position":3,"item":{"@id":"/web3/ethereum-gateway/","name":"Ethereum Gateway"}},{"@type":"ListItem","position":4,"item":{"@id":"/web3/ethereum-gateway/concepts/","name":"Concepts"}},{"@type":"ListItem","position":5,"item":{"@id":"/web3/ethereum-gateway/concepts/node-types/","name":"Node types"}}]} ``` --- --- title: Kill Switches description: Disable Ethereum Gateway features in an emergency. image: https://developers.cloudflare.com/core-services-preview.png --- > Documentation Index > Fetch the complete documentation index at: https://developers.cloudflare.com/web3/llms.txt > Use this file to discover all available pages before exploring further. [Skip to content](#%5Ftop) # Kill Switches When writing contracts, be especially careful to write secure code and include a kill switch to ensure that if any bugs do reside in the code, they can be squashed. If you do not include a kill switch and there are vulnerabilities in the smart contract that can be exploited, this can lead to the theft of resources from the smart contract or from other individuals. This was brought into sharp focus during the [infamous DAO incident ↗](https://en.wikipedia.org/wiki/The%5FDAO%5F%28organization%29). The DAO smart contract acted as a complex, decentralized venture capital fund and held Ether worth $250 million at its peak collected from a group of investors. Hackers exploited vulnerabilities in the smart contract, stealing $50 million worth of Ether. Because there is no way to undo transactions in Ether, there was a highly controversial “hard fork," where the majority of the community agreed to accept a block that contained an _irregular state change_ that essentially drained all DAO funds into a special “WithdrawDAO” recovery contract. By convincing enough miners to accept this irregular block as valid, the DAO was able to return investors funds. However, not everyone agreed with the chain, with those who disagreed rejecting the irregular block and forming the Ethereum Classic network, each blockchain grew independently. ## Limitations Kill switches can cause their own problems. Like if a contract that is a library has its kill switch flipped. All contracts relying on this contract can't operate as intended even though the underlying library code is immutable. Recently, an attacker triggered a kill switch in an underlying library function that caused over 500,000 Ether to get [stuck in multi-signature wallets ↗](https://www.parity.io/security-alert-2/). Users of the multi-signature library assumed the immutability of the code meant that the library would always operate as anticipated, and accepted the block. In the wake of this, there are many tools that check smart contracts for bugs or enable bug bounties. > Smart contracts interacting with the blockchain are only deterministic when accounting for the state of the blockchain. ## How is this different? This is a radically different approach for providing transparency and accountability. Because all contracts and transactions are public and verified by **consensus**, trust is distributed amongst the people, rather than centralized in a few big institutions. The trust given to institutions is historic. This history builds trustworthiness. The trust placed in consensus-based algorithms is based on the assumption that most people are honest, or more accurately that no sufficiently large subset of people can be made to collude to produce a malicious outcome. This is the_democratisation of trust_. In the DAO attack, a majority of nodes agreed to accept an irregular state transition. This effectively undid the damage of the attack, and shows how, at least in the world of blockchain, perception is reality. Because most people “believed" -- accepted this irregular block, it became a “real” -- valid block. ```json {"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"item":{"@id":"/directory/","name":"Directory"}},{"@type":"ListItem","position":2,"item":{"@id":"/web3/","name":"Web3"}},{"@type":"ListItem","position":3,"item":{"@id":"/web3/ethereum-gateway/","name":"Ethereum Gateway"}},{"@type":"ListItem","position":4,"item":{"@id":"/web3/ethereum-gateway/reference/","name":"Reference"}},{"@type":"ListItem","position":5,"item":{"@id":"/web3/ethereum-gateway/reference/kill-switches/","name":"Kill Switches"}}]} ``` --- --- title: Rinkeby deprecation description: Deprecation notice for the Rinkeby test network. image: https://developers.cloudflare.com/core-services-preview.png --- > Documentation Index > Fetch the complete documentation index at: https://developers.cloudflare.com/web3/llms.txt > Use this file to discover all available pages before exploring further. [Skip to content](#%5Ftop) ### Tags [ Migration ](https://developers.cloudflare.com/search/?tags=Migration) # Rinkeby deprecation Though Cloudflare's Ethereum Gateway launched with support for the Rinkeby testnet, Rinkeby did not run through [The Merge ↗](https://ethereum.org/en/upgrades/merge/) and - as a result - will no longer be a reliable staging environment for mainnet. Cloudflare will be deprecating support for Rinkeby on January 30, 2023. ## Migration To avoid any issues with your Web3 development or debugging, you should switch over to the [Sepolia testnet](https://developers.cloudflare.com/web3/ethereum-gateway/reference/supported-networks/), which is fully supported with your Ethereum Gateway. To migrate, you should update the endpoints you use when [reading from or writing to](https://developers.cloudflare.com/web3/how-to/use-ethereum-gateway/) the Ethereum network. For example, you might have been using the previous endpoints to interact with your Ethereum Gateway. Previous curl ``` curl https://web3-trial.cloudflare-eth.com/v1/rinkeby \ --header 'Content-Type: application/json' \ --data '{ "jsonrpc": "2.0", "method": "eth_getBlockByNumber", "params": ["0x2244", true], "id": 1 }' ``` Previous JS Fetch API ``` await fetch( new Request('https://web3-trial.cloudflare-eth.com/v1/rinkeby', { method: 'POST', body: JSON.stringify({ jsonrpc: '2.0', method: 'eth_getBlockByNumber', params: ['0x2244', true], id: 1, }), headers: { 'Content-Type': 'application/json', }, }) ).then(resp => { return resp.json(); }); ``` To migrate away from Rinkeby, change the end of your endpoint to use another testnet. New curl ``` curl https://web3-trial.cloudflare-eth.com/v1/sepolia \ --header 'Content-Type: application/json' \ --data '{ "jsonrpc": "2.0", "method": "eth_getBlockByNumber", "params": ["0x2244", true], "id": 1 }' ``` New JS Fetch API ``` await fetch( new Request('https://web3-trial.cloudflare-eth.com/v1/sepolia', { method: 'POST', body: JSON.stringify({ jsonrpc: '2.0', method: 'eth_getBlockByNumber', params: ['0x2244', true], id: 1, }), headers: { 'Content-Type': 'application/json', }, }) ).then(resp => { return resp.json(); }); ``` ```json {"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"item":{"@id":"/directory/","name":"Directory"}},{"@type":"ListItem","position":2,"item":{"@id":"/web3/","name":"Web3"}},{"@type":"ListItem","position":3,"item":{"@id":"/web3/ethereum-gateway/","name":"Ethereum Gateway"}},{"@type":"ListItem","position":4,"item":{"@id":"/web3/ethereum-gateway/reference/","name":"Reference"}},{"@type":"ListItem","position":5,"item":{"@id":"/web3/ethereum-gateway/reference/rinkeby-deprecation/","name":"Rinkeby deprecation"}}]} ``` --- --- title: Supported API methods description: Ethereum JSON-RPC methods supported by the Cloudflare gateway. image: https://developers.cloudflare.com/core-services-preview.png --- > Documentation Index > Fetch the complete documentation index at: https://developers.cloudflare.com/web3/llms.txt > Use this file to discover all available pages before exploring further. [Skip to content](#%5Ftop) ### Tags [ JSON ](https://developers.cloudflare.com/search/?tags=JSON) # Supported API methods The full list of API methods that are supported by an Ethereum Gateway is given below. The gateway returns a `403` if a method is specified that is not supported. For a full list of JSON-RPC API methods, refer to the [JSON-RPC specification ↗](https://github.com/ethereum/execution-apis). | JSON-RPC method | Cloudflare Ethereum Gateway support | | ---------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | | [web3\_clientVersion ↗](https://ethereum.org/en/developers/docs/apis/json-rpc/#web3%5Fclientversion) | ✅ | | [web3\_sha3 ↗](https://ethereum.org/en/developers/docs/apis/json-rpc/#web3%5Fsha3) | ✅ | | [net\_version ↗](https://ethereum.org/en/developers/docs/apis/json-rpc/#net%5Fversion) | ✅ | | [net\_listening ↗](https://ethereum.org/en/developers/docs/apis/json-rpc/#net%5Flistening) | ✅ | | [eth\_syncing ↗](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth%5Fsyncing) | ✅ | | [eth\_mining ↗](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth%5Fmining) | ✅ | | [eth\_gasPrice ↗](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth%5Fgasprice) | ✅ | | [eth\_feeHistory ↗](https://github.com/ethereum/execution-apis)[1](#user-content-fn-2) | ✅ | | [eth\_blockNumber ↗](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth%5Fblocknumber) | ✅ | | [eth\_chainId ↗](https://github.com/ethereum/execution-apis) | ✅ | | [eth\_getBalance ↗](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth%5Fgetbalance) | ✅ | | [eth\_getStorageAt ↗](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth%5Fgetstorageat) | ✅ | | [eth\_getTransactionCount ↗](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth%5Fgettransactioncount) | ✅ | | [eth\_getBlockTransactionCountByHash ↗](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth%5Fgetblocktransactioncountbyhash) | ✅ | | [eth\_getBlockTransactionCountByNumber ↗](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth%5Fgetblocktransactioncountbynumber) | ✅ | | [eth\_getUncleCountByBlockHash ↗](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth%5Fgetunclecountbyblockhash) | ✅ | | [eth\_getUncleCountByBlockNumber ↗](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth%5Fgetunclecountbyblocknumber) | ✅ | | [eth\_getCode ↗](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth%5Fgetcode) | ✅ | | [eth\_sendRawTransaction ↗](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth%5Fsendrawtransaction) | ✅ | | [eth\_call ↗](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth%5Fcall) | ✅ | | [eth\_estimateGas ↗](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth%5Festimategas) | ✅ | | [eth\_getBlockByHash ↗](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth%5Fgetblockbyhash) | ✅ | | [eth\_getBlockByNumber ↗](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth%5Fgetblockbynumber) | ✅ | | [eth\_getTransactionByHash ↗](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth%5Fgettransactionbyhash) | ✅ | | [eth\_getTransactionByBlockHashAndIndex ↗](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth%5Fgettransactionbyblockhashandindex) | ✅ | | [eth\_getTransactionByBlockNumberAndIndex ↗](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth%5Fgettransactionbyblocknumberandindex) | ✅ | | [eth\_getTransactionReceipt ↗](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth%5Fgettransactionreceipt) | ✅ | | [eth\_getUncleByBlockHashAndIndex ↗](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth%5Fgetunclebyblockhashandindex) | ✅ | | [eth\_getUncleByBlockNumberAndIndex ↗](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth%5Fgetunclebyblocknumberandindex) | ✅ | | [eth\_getLogs ↗](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth%5Fgetlogs)[2](#user-content-fn-1) | ✅ | | [eth\_getWork ↗](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth%5Fgetwork) | ✅ | | [eth\_getProof ↗](https://ethereum.github.io/execution-apis/api-documentation/) | ✅ | | [net\_peerCount ↗](https://ethereum.org/en/developers/docs/apis/json-rpc/#net%5Fpeercount) | ❌ | | [eth\_protocolVersion ↗](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth%5Fprotocolversion) | ❌ | | [eth\_coinbase ↗](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth%5Fcoinbase) | ❌ | | [eth\_hashrate ↗](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth%5Fhashrate) | ❌ | | [eth\_accounts ↗](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth%5Faccounts) | ❌ | | [eth\_sign ↗](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth%5Fsign) | ❌ | | [eth\_sendTransaction ↗](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth%5Fsendtransaction) | ❌ | | [eth\_getCompilers ↗](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth%5Fgetcompilers) | ❌ | | [eth\_compileLLL ↗](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth%5Fcompilelll) | ❌ | | [eth\_compileSolidity ↗](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth%5Fcompile%5Fsolidity) | ❌ | | [eth\_compileSerpent ↗](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth%5Fcompileserpent) | ❌ | | [eth\_newFilter ↗](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth%5Fnewfilter) | ❌ | | [eth\_newBlockFilter ↗](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth%5Fnewblockfilter) | ❌ | | [eth\_newPendingTransactionFilter ↗](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth%5Fnewpendingtransactionfilter) | ❌ | | [eth\_uninstallFilter ↗](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth%5Funinstallfilter) | ❌ | | [eth\_getFilterChanges ↗](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth%5Fgetfilterchanges) | ❌ | | [eth\_getFilterLogs ↗](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth%5Fgetfilterlogs) | ❌ | | [eth\_submitWork ↗](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth%5Fsubmitwork) | ❌ | | [eth\_submitHashrate ↗](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth%5Fsubmithashrate) | ❌ | ## Trace methods EVM traces are a way to track the execution of smart contracts on the Ethereum blockchain. It records all the steps taken by the Ethereum Virtual Machine (EVM) as it runs the smart contract. This includes information like the specific operation that was executed, how much gas it cost, and any changes made to the blockchain as a result. The trace module is a tool that allows developers to access and analyze these traces, which can be useful for debugging, testing, and monitoring smart contracts. It can be used to identify and fix errors, optimize performance, and gain insight into how the smart contract is interacting with the blockchain. ### trace\_filter The `trace_filter` method retrieves the traces of multiple transactions in a single request. This method is particularly useful for debugging and monitoring specific addresses on the Ethereum blockchain. #### Request Parameters * `fromBlock`: `Quantity` or `Tag` \- (optional) The block number to start receiving traces from. * `toBlock`: `Quantity` or `Tag` \- (optional) The block number to stop receiving traces at. * `fromAddress`: `Array` \- (optional) An array of addresses to start receiving traces from. * `toAddress`: `Address` \- (optional) An array of addresses to stop retrieving traces at. * `after`: `Quantity` \- (optional) The offset trace number * `count`: `Quantity` \- (optional) The amount of traces to return. #### Returns This method returns an `Array` of traces matching the given filter. #### Example trace\_filter Request ``` curl https://web3-trial.cloudflare-eth.com/v1/mainnet \ -X POST \ -H 'Content-Type: application/json' \ --data '{ "jsonrpc":"2.0", "method":"trace_filter", "params":[ { "count": 200, "fromBlock": "0xccb943", "toBlock": "0xccbc62", "fromAddress": [ "0xEdC763b3e418cD14767b3Be02b667619a6374076" ] } ], "id":1 }' ``` #### Response ``` { "jsonrpc": "2.0", "result": [ { "action": { "from": "0xedc763b3e418cd14767b3be02b667619a6374076", "callType": "call", "gas": "0x8462", "input": "0x095ea7b30000000000000000000000007a250d5630b4cf539739df2c5dacb4c659f2488dffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff", "to": "0x7ff4169a6b5122b664c51c95727d87750ec07c84", "value": "0x0" }, "blockHash": "0x351e7c06ec010c8f7e7358eb580238dd23e1e129be96822aa93ebb6da08558e6", "blockNumber": 13416771, "result": { "gasUsed": "0x6009", "output": "0x0000000000000000000000000000000000000000000000000000000000000001" }, "subtraces": 0, "traceAddress": [], "transactionHash": "0x054bbb9fbb855bf23f755e548c7409f45fc5eff8a824b2ad06380bc038d7b049", "transactionPosition": 54, "type": "call" } ], "id": 1 } ``` ### Limitations The `trace_filter` method has some limitations to ensure that our nodes are not overloaded. * The block range for the `trace_filter` method is limited to 800 blocks. * The trace `count` is limited to 200 ## Footnotes 1. **Limitations**: Max block count of 10\. [↩](#user-content-fnref-2) 2. **Limitations**: Max block range of 800 blocks. [↩](#user-content-fnref-1) ```json {"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"item":{"@id":"/directory/","name":"Directory"}},{"@type":"ListItem","position":2,"item":{"@id":"/web3/","name":"Web3"}},{"@type":"ListItem","position":3,"item":{"@id":"/web3/ethereum-gateway/","name":"Ethereum Gateway"}},{"@type":"ListItem","position":4,"item":{"@id":"/web3/ethereum-gateway/reference/","name":"Reference"}},{"@type":"ListItem","position":5,"item":{"@id":"/web3/ethereum-gateway/reference/supported-api-methods/","name":"Supported API methods"}}]} ``` --- --- title: Supported networks description: Ethereum networks supported by the Cloudflare Ethereum Gateway. image: https://developers.cloudflare.com/core-services-preview.png --- > Documentation Index > Fetch the complete documentation index at: https://developers.cloudflare.com/web3/llms.txt > Use this file to discover all available pages before exploring further. [Skip to content](#%5Ftop) # Supported networks Currently, Cloudflare Ethereum gateways support [interacting with](https://developers.cloudflare.com/web3/how-to/use-ethereum-gateway/) the following networks. | Network | Usage | | --------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | | [Ethereum Mainnet ↗](https://ethereum.org/en/enterprise/) | Append /v1/mainnet to calls to your gateway or the Cloudflare public gateway (cloudflare-eth.com). | | [Sepolia Testnet ↗](https://sepolia.dev/) | Append /v1/sepolia to calls to your gateway. | ```json {"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"item":{"@id":"/directory/","name":"Directory"}},{"@type":"ListItem","position":2,"item":{"@id":"/web3/","name":"Web3"}},{"@type":"ListItem","position":3,"item":{"@id":"/web3/ethereum-gateway/","name":"Ethereum Gateway"}},{"@type":"ListItem","position":4,"item":{"@id":"/web3/ethereum-gateway/reference/","name":"Reference"}},{"@type":"ListItem","position":5,"item":{"@id":"/web3/ethereum-gateway/reference/supported-networks/","name":"Supported networks"}}]} ``` --- ## List Web3 Hostnames **get** `/zones/{zone_id}/web3/hostnames` List Web3 Hostnames ### Path Parameters - `zone_id: string` Specify the identifier of the hostname. ### Returns - `errors: array of ResponseInfo` - `code: number` - `message: string` - `documentation_url: optional string` - `source: optional object { pointer }` - `pointer: optional string` - `messages: array of ResponseInfo` - `code: number` - `message: string` - `documentation_url: optional string` - `source: optional object { pointer }` - `result: array of Hostname` - `id: optional string` Specify the identifier of the hostname. - `created_on: optional string` - `description: optional string` Specify an optional description of the hostname. - `dnslink: optional string` Specify the DNSLink value used if the target is ipfs. - `modified_on: optional string` - `name: optional string` Specify the hostname that points to the target gateway via CNAME. - `status: optional "active" or "pending" or "deleting" or "error"` Specifies the status of the hostname's activation. - `"active"` - `"pending"` - `"deleting"` - `"error"` - `target: optional "ethereum" or "ipfs" or "ipfs_universal_path"` Specify the target gateway of the hostname. - `"ethereum"` - `"ipfs"` - `"ipfs_universal_path"` - `success: true` Specifies whether the API call was successful. - `true` - `result_info: optional object { count, page, per_page, total_count }` - `count: optional number` Specifies the total number of results for the requested service. - `page: optional number` Specifies the current page within paginated list of results. - `per_page: optional number` Specifies the number of results per page of results. - `total_count: optional number` Specifies the total results available without any search parameters. ### Example ```http curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/web3/hostnames \ -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN" ``` #### Response ```json { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "result": [ { "id": "023e105f4ecef8ad9ca31a8372d0c353", "created_on": "2014-01-01T05:20:00.12345Z", "description": "This is my IPFS gateway.", "dnslink": "/ipns/onboarding.ipfs.cloudflare.com", "modified_on": "2014-01-01T05:20:00.12345Z", "name": "gateway.example.com", "status": "active", "target": "ipfs" } ], "success": true, "result_info": { "count": 1, "page": 1, "per_page": 20, "total_count": 2000 } } ``` --- --- title: Customize Cloudflare settings description: Apply Cloudflare security and performance settings to your Web3 gateway. image: https://developers.cloudflare.com/core-services-preview.png --- > Documentation Index > Fetch the complete documentation index at: https://developers.cloudflare.com/web3/llms.txt > Use this file to discover all available pages before exploring further. [Skip to content](#%5Ftop) # Customize Cloudflare settings Once your gateway becomes [active](https://developers.cloudflare.com/web3/reference/gateway-status/), you can customize the Cloudflare settings associated with your hostname. Since your traffic is automatically proxied through Cloudflare, you customize your website settings to take advantage of various [security, performance, and reliability](https://developers.cloudflare.com/fundamentals/concepts/how-cloudflare-works/#cloudflare-as-a-reverse-proxy) benefits. ```json {"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"item":{"@id":"/directory/","name":"Directory"}},{"@type":"ListItem","position":2,"item":{"@id":"/web3/","name":"Web3"}},{"@type":"ListItem","position":3,"item":{"@id":"/web3/how-to/","name":"How to"}},{"@type":"ListItem","position":4,"item":{"@id":"/web3/how-to/customize-cloudflare-settings/","name":"Customize Cloudflare settings"}}]} ``` --- --- title: Subscribe to gateways description: Subscribe to Ethereum or IPFS gateways on your Cloudflare account. image: https://developers.cloudflare.com/core-services-preview.png --- > Documentation Index > Fetch the complete documentation index at: https://developers.cloudflare.com/web3/llms.txt > Use this file to discover all available pages before exploring further. [Skip to content](#%5Ftop) # Subscribe to gateways Before you can [create a new gateway](https://developers.cloudflare.com/web3/how-to/manage-gateways/#create-a-gateway), you need to subscribe to one or more gateways. ## Create new subscription To subscribe to a Web3 gateway (if you have not already subscribed): 1. In the Cloudflare dashboard, go to the **Web3** page. [ Go to **Web3** ](https://dash.cloudflare.com/?to=/:account/:zone/web3) 2. Click **Subscribe to Web3 Gateways**. 3. Choose which gateways you want to subscribe to. 4. Click **Proceed to Payment Details**. 5. Enter your payment information (if not already attached to your account) and complete your purchase. Note Enterprise customers can preview this product as a [non-contract service](https://developers.cloudflare.com/billing/understand/preview-services/), which provides full access, free of metered usage fees, limits, and certain other restrictions. ## Manage existing subscription To update an existing subscription or subscribe to an additional gateway: 1. In the Cloudflare dashboard, go to the **Web3** page. [ Go to **Web3** ](https://dash.cloudflare.com/?to=/:account/:zone/web3) 2. Click **Manage Subscriptions**. 3. To update existing gateway subscriptions, click **Change**. To purchase access to a new gateway, click **Subscribe**. ```json {"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"item":{"@id":"/directory/","name":"Directory"}},{"@type":"ListItem","position":2,"item":{"@id":"/web3/","name":"Web3"}},{"@type":"ListItem","position":3,"item":{"@id":"/web3/how-to/","name":"How to"}},{"@type":"ListItem","position":4,"item":{"@id":"/web3/how-to/enable-gateways/","name":"Subscribe to gateways"}}]} ``` --- --- title: Manage gateways description: Create, edit, and delete Web3 gateways. image: https://developers.cloudflare.com/core-services-preview.png --- > Documentation Index > Fetch the complete documentation index at: https://developers.cloudflare.com/web3/llms.txt > Use this file to discover all available pages before exploring further. [Skip to content](#%5Ftop) # Manage gateways A Cloudflare Web3 gateway provides HTTP-accessible interfaces to various Web3 networks. You can interact with a gateway in several ways. ## Create a gateway * [ Dashboard ](#tab-panel-8918) * [ API ](#tab-panel-8919) To create a gateway using the dashboard: 1. In the Cloudflare dashboard, go to the **Web3** page. [ Go to **Web3** ](https://dash.cloudflare.com/?to=/:account/:zone/web3) 2. Click **Create Gateway**. 3. Enter the following information: * **Hostname**: Enter a hostname to use as your gateway, which has to be a subdomain of the current Cloudflare zone. * **Gateway Description**: Enter a description to help distinguish between different gateways. * **Gateway Type**: Select a gateway target of [IPFS DNSLink](https://developers.cloudflare.com/web3/ipfs-gateway/concepts/dnslink/), [IPFS Universal Path](https://developers.cloudflare.com/web3/ipfs-gateway/concepts/universal-gateway/), or [Ethereum](https://developers.cloudflare.com/web3/ethereum-gateway/). * **DNSLink**: Only applicable to IPFS gateways, more details at [DNSLink](https://developers.cloudflare.com/web3/ipfs-gateway/concepts/dnslink/#how-is-it-used-with-cloudflare). 1. Click **Deploy**. To create a gateway using the API, send a [POST](https://developers.cloudflare.com/api/resources/web3/subresources/hostnames/methods/create/) request that includes the following parameters: * `name`: The hostname that will point to the target gateway via a `CNAME` record. * `target`: The gateway target for the hostname (`ethereum`, `ipfs`, `ipfs_universal_path`). If you need help with API authentication, refer to [Cloudflare API documentation](https://developers.cloudflare.com/fundamentals/api/). Request ``` curl "https://api.cloudflare.com/client/v4/zones/{zone_id}/web3/hostnames" \ --header "X-Auth-Email: " \ --header "X-Auth-Key: " \ --header "Content-Type: application/json" \ --data '{ "name": "gateway.example.com", "description": "This is my IPFS gateway.", "target": "ipfs", "dnslink": "/ipns/onboarding.ipfs.cloudflare.com" }' ``` The response contains the complete definition of the new gateway. Response ``` { "success": true, "errors": [], "messages": [], "result": { "id": "", "name": "gateway.example.com", "description": "This is my IPFS gateway.", "status": "active", "target": "ipfs", "dnslink": "/ipns/onboarding.ipfs.cloudflare.com", "created_on": "", "modified_on": "" } } ``` When you create a gateway, Cloudflare automatically: * Creates and adds [records to your Cloudflare DNS](https://developers.cloudflare.com/web3/reference/gateway-dns-records/) so your gateway can receive and route traffic appropriately. * [Proxies](https://developers.cloudflare.com/dns/proxy-status/) traffic to that hostname. * Issues an SSL/TLS certificate to cover the specified hostname. --- ## Edit a gateway Once you have [created a gateway](#create-a-gateway), you can only edit the **Gateway Description** and — if it is an **IPFS** gateway — also edit the value for the [DNSLink](https://developers.cloudflare.com/web3/ipfs-gateway/concepts/dnslink/) field. If you need to edit other fields, [delete the gateway](#delete-a-gateway) and create a new one. * [ Dashboard ](#tab-panel-8910) * [ API ](#tab-panel-8911) To edit a gateway using the dashboard: 1. In the Cloudflare dashboard, go to the **Web3** page. [ Go to **Web3** ](https://dash.cloudflare.com/?to=/:account/:zone/web3) 2. On a specific gateway, click **Edit**. 3. Update the **Gateway Description** and — if editing an **IPFS** gateway — the value for the [DNSLink](https://developers.cloudflare.com/web3/ipfs-gateway/concepts/dnslink/). 4. Click **Reapply**. To edit specific settings for a gateway, use a [PATCH](https://developers.cloudflare.com/api/resources/web3/subresources/hostnames/methods/edit/) request. --- ## Refresh a gateway When your gateway is stuck in an **Error** [status](https://developers.cloudflare.com/web3/reference/gateway-status/), you should try refreshing the gateway, which attempts to re-create the associated DNS records for the hostname. * [ Dashboard ](#tab-panel-8912) * [ API ](#tab-panel-8913) To refresh a gateway using the dashboard: 1. In the Cloudflare dashboard, go to the **Web3** page. [ Go to **Web3** ](https://dash.cloudflare.com/?to=/:account/:zone/web3) 2. On a gateway, click the dropdown then **Refresh**. To refresh a gateway using the API, send a [PATCH](https://developers.cloudflare.com/api/resources/web3/subresources/hostnames/methods/edit/) request with an empty request body. --- ## Update blocklist When you set up a [IPFS Universal Path gateway](https://developers.cloudflare.com/web3/ipfs-gateway/concepts/universal-gateway/), you may want to add items to the gateway blocklist, which allows you to block access to specific content. You have the ability to block access to one or more: * CIDs (`QmPZ9gcCEpqKTo6aq61g2nXGUhM4iCL3ewB6LDXZCtioEB`) * IPFS content paths (`/ipfs/QmYwAPJzv5CZsnA625s3Xf2nemtYgPpHdWEz79ojWnPbdG/readme`) * IPNS content paths (`/ipns/example.com`) * [ Dashboard ](#tab-panel-8914) * [ API ](#tab-panel-8915) To add an item to the blocklist using the dashboard: 1. In the Cloudflare dashboard, go to the **Web3** page. [ Go to **Web3** ](https://dash.cloudflare.com/?to=/:account/:zone/web3) 2. On a specific gateway, click the dropdown then **Blocklist**. 3. Click **Add entry**. 4. Enter the following information: * **Blocklist entry type**: Choose **CID** or **Content path**. * **Blocklist entry content**: Add a CID or content path to block, meaning either a valid CIDv0 or CIDv1 string (CID) or the entry should start with `/ipfs/` or `/ipns/` (content path). * **Blocklist entry description**: Add a description to help you identify the blocklist entry. 5. Click **Add**. To add a blocklist item using the API, send a [POST](https://developers.cloudflare.com/api/resources/web3/subresources/hostnames/subresources/ipfs%5Funiversal%5Fpaths/subresources/content%5Flists/subresources/entries/methods/create/) request. --- ## Delete a gateway When you delete a gateway, Cloudflare will automatically remove all associated hostname DNS records. This action will impact your traffic and cannot be undone. * [ Dashboard ](#tab-panel-8916) * [ API ](#tab-panel-8917) To delete a gateway using the dashboard: 1. In the Cloudflare dashboard, go to the **Web3** page. [ Go to **Web3** ](https://dash.cloudflare.com/?to=/:account/:zone/web3) 2. On a specific gateway, click the dropdown then **Remove**. 3. Click **Delete hostname**. To delete a gateway using the API, send a [DELETE](https://developers.cloudflare.com/api/resources/web3/subresources/hostnames/methods/delete/) request. ```json {"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"item":{"@id":"/directory/","name":"Directory"}},{"@type":"ListItem","position":2,"item":{"@id":"/web3/","name":"Web3"}},{"@type":"ListItem","position":3,"item":{"@id":"/web3/how-to/","name":"How to"}},{"@type":"ListItem","position":4,"item":{"@id":"/web3/how-to/manage-gateways/","name":"Manage gateways"}}]} ``` --- --- title: Restrict gateway access description: Restrict access to your Web3 gateway with WAF custom rules. image: https://developers.cloudflare.com/core-services-preview.png --- > Documentation Index > Fetch the complete documentation index at: https://developers.cloudflare.com/web3/llms.txt > Use this file to discover all available pages before exploring further. [Skip to content](#%5Ftop) # Restrict gateway access If you are using a [Web3 gateway](https://developers.cloudflare.com/web3/about/) for internal application calls, you may want to restrict gateway access to specific backend services. You can achieve this goal by [creating general Access policies](https://developers.cloudflare.com/cloudflare-one/access-controls/policies/) to block normal traffic and then [creating service tokens](https://developers.cloudflare.com/cloudflare-one/access-controls/service-credentials/service-tokens/) to allow access by your backend service. ```json {"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"item":{"@id":"/directory/","name":"Directory"}},{"@type":"ListItem","position":2,"item":{"@id":"/web3/","name":"Web3"}},{"@type":"ListItem","position":3,"item":{"@id":"/web3/how-to/","name":"How to"}},{"@type":"ListItem","position":4,"item":{"@id":"/web3/how-to/restrict-gateway-access/","name":"Restrict gateway access"}}]} ``` --- --- title: Use Ethereum gateway description: Send JSON-RPC requests through the Cloudflare Ethereum Gateway. image: https://developers.cloudflare.com/core-services-preview.png --- > Documentation Index > Fetch the complete documentation index at: https://developers.cloudflare.com/web3/llms.txt > Use this file to discover all available pages before exploring further. [Skip to content](#%5Ftop) ### Tags [ JSON ](https://developers.cloudflare.com/search/?tags=JSON) # Use Ethereum gateway Once you have an Ethereum gateway — meaning that you [create a new gateway](https://developers.cloudflare.com/web3/how-to/manage-gateways/#create-a-gateway) with a `target` of **Ethereum** — you can interact with [different Ethereum networks](https://developers.cloudflare.com/web3/ethereum-gateway/reference/supported-networks/) by specifying the correct JSON blob for your query. ## Read from the network The Cloudflare Ethereum Gateway allows HTTP requests where the body of the request is set to be the JSON body of the request you would like to make. For example, if you would like to read the block that is at number `0x2244`, then your JSON blob takes the form: ``` { "jsonrpc": "2.0", "method": "eth_getBlockByNumber", "params": ["0x2244", true], "id": 1 } ``` Each blob use a valid [method parameter](https://developers.cloudflare.com/web3/ethereum-gateway/reference/supported-api-methods/). The `params` array here contains the block number that we would like to locate and a boolean expressing whether each individual transaction in the block should be shown in their entirety (`true`) or as stubs (`false`). To send this query to your [custom Ethereum Gateway](https://developers.cloudflare.com/web3/how-to/manage-gateways/), you could use a cURL command: Terminal window ``` curl https://web3-trial.cloudflare-eth.com/v1/mainnet -H 'Content-Type: application/json' --data '{"jsonrpc":"2.0","method":"eth_getBlockByNumber","params":["0x2244", true],"id":1}' ``` You can also write the same query using the JS Fetch API: JavaScript ``` await fetch( new Request("https://web3-trial.cloudflare-eth.com/v1/mainnet", { method: "POST", body: JSON.stringify({ jsonrpc: "2.0", method: "eth_getBlockByNumber", params: ["0x2244", true], id: 1, }), headers: { "Content-Type": "application/json", }, }), ).then((resp) => { return resp.json(); }); ``` The response in both cases will be a JSON blob of the form: ``` { "jsonrpc": "2.0", "id": 1, "result": { "difficulty": "0x746ef15b66", "extraData": "0x476574682f76312e302e302f6c696e75782f676f312e342e32", "gasLimit": "0x1388", "gasUsed": "0x0", "hash": "0xd6bb42034740c5d728e774e43a01f26222e0fcc279c504ca5963dc34fe70f392", "logsBloom": "0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", "miner": "0xf927a40c8b7f6e07c5af7fa2155b4864a4112b13", "mixHash": "0x975da446e302e6da6cedb3fbaa763c3c203ae88d6fab4924e2a3d34a568c4361", "nonce": "0x88a7f12f49151c83", "number": "0x2244", "parentHash": "0x067fd84ecdbc7491bf5ec7d5d4ead361b1f590eec74797a7f90b4a7d7004a48d", "receiptsRoot": "0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421", "sha3Uncles": "0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347", "size": "0x21b", "stateRoot": "0x828dade2067283e370993ec6a1bda0e65c1310e404a6d5bbb030b596eb80017c", "timestamp": "0x55bb040f", "totalDifficulty": "0x5c328da43525d", "transactions": [], "transactionsRoot": "0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421", "uncles": [] } } ``` ## Write to the network Currently, the Ethereum Gateway allows you to write to the network using the `eth_sendRawTransaction` RPC method. This creates a new message call transaction or a contract creation for signed transactions. The transactions are signed using a secret key corresponding to your own [Ethereum wallet ↗](https://www.ethereum.org/use/#%5F3-what-is-a-wallet-and-which-one-should-i-use). Once you have a wallet set up and a method of signing your own transactions, you can write that transaction to the Ethereum network via the [Cloudflare Ethereum Gateway](https://developers.cloudflare.com/web3/ethereum-gateway/reference/supported-api-methods/). Signed transactions use hexadecimal strings of the form: ``` "0xd46e8dd67c5d32be8d46e8dd67c5d32be8058bb8eb970870f072445675058bb8eb970870f072445675" ``` Then you can use your [custom Gateway](https://developers.cloudflare.com/web3/how-to/manage-gateways/) to send the transaction to the network with a cURL command: Terminal window ``` curl https://web3-trial.cloudflare-eth.com/v1/mainnet -H 'Content-Type: application/json' --data '{"jsonrpc":"2.0","method":"eth_sendRawTransaction","params":["0xd46e8dd67c5d32be8d46e8dd67c5d32be8058bb8eb970870f072445675058bb8eb970870f072445675"],"id":1}' ``` You could also use a JS Fetch API request: JavaScript ``` await fetch( new Request("https://web3-trial.cloudflare-eth.com/v1/mainnet", { method: "POST", body: JSON.stringify({ jsonrpc: "2.0", method: "eth_sendRawTransaction", params: [ "0xd46e8dd67c5d32be8d46e8dd67c5d32be8058bb8eb970870f072445675058bb8eb970870f072445675", ], id: 1, }), headers: { "Content-Type": "application/json", }, }), ).then((resp) => { return resp.json(); }); ``` _(The actual command above will not work — you need to provide your own signed transaction.)_ ```json {"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"item":{"@id":"/directory/","name":"Directory"}},{"@type":"ListItem","position":2,"item":{"@id":"/web3/","name":"Web3"}},{"@type":"ListItem","position":3,"item":{"@id":"/web3/how-to/","name":"How to"}},{"@type":"ListItem","position":4,"item":{"@id":"/web3/how-to/use-ethereum-gateway/","name":"Use Ethereum gateway"}}]} ``` --- --- title: Use IPFS gateway description: Serve IPFS content through the Cloudflare IPFS Gateway. image: https://developers.cloudflare.com/core-services-preview.png --- > Documentation Index > Fetch the complete documentation index at: https://developers.cloudflare.com/web3/llms.txt > Use this file to discover all available pages before exploring further. [Skip to content](#%5Ftop) # Use IPFS gateway Once you have an IPFS gateway — meaning that you [create a new gateway](https://developers.cloudflare.com/web3/how-to/manage-gateways/#create-a-gateway) with a `target` of **IPFS** — you can get data from the IPFS network by using a URL. ## Read from the network Every time you access a piece of content through Cloudflare's IPFS Gateway, you need a URL with two parts: the gateway hostname and the request path. ### Gateway hostname Your gateway hostname will be the **Hostname** value you supplied when you [created the gateway](https://developers.cloudflare.com/web3/how-to/manage-gateways/#create-a-gateway). ### Request path The request path will vary based on the type of content you are serving. If a request path is `/ipfs/`, that tells the gateway that you want the content with the Content Identifier (CID) that immediately follows. Because the content is addressed by CID, the gateway's response is immutable and will never change. An example would be `https://cloudflare-ipfs.com/ipfs/QmXoypizjW3WknFiJnKLwHCnL72vedxjQkDDP1mXWo6uco/wiki/`, which is a mirror of Wikipedia and an immutable `/ipfs/` link. If a request path is `/ipns/`, that tells the gateway that you want it to lookup the CID associated with a given domain in DNS and then serve whatever content corresponds to the CID it happens to find. Because DNS can change over time, so will the gateway's response. An example would be `https://cloudflare-ipfs.com/ipns/ipfs.tech/`, which is IPFS's marketing site and can be changed at any time by modifying the [DNSLink record](https://developers.cloudflare.com/web3/ipfs-gateway/concepts/dnslink/) associated with the `ipfs.tech` domain. ## Write to the network Cloudflare's IPFS Gateway is currently limited to read-only access. ```json {"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"item":{"@id":"/directory/","name":"Directory"}},{"@type":"ListItem","position":2,"item":{"@id":"/web3/","name":"Web3"}},{"@type":"ListItem","position":3,"item":{"@id":"/web3/how-to/","name":"How to"}},{"@type":"ListItem","position":4,"item":{"@id":"/web3/how-to/use-ipfs-gateway/","name":"Use IPFS gateway"}}]} ``` --- --- title: Gateway DNS records description: DNS records created for Web3 gateways. image: https://developers.cloudflare.com/core-services-preview.png --- > Documentation Index > Fetch the complete documentation index at: https://developers.cloudflare.com/web3/llms.txt > Use this file to discover all available pages before exploring further. [Skip to content](#%5Ftop) ### Tags [ DNS ](https://developers.cloudflare.com/search/?tags=DNS) # Gateway DNS records Once you [create a gateway](https://developers.cloudflare.com/web3/how-to/manage-gateways/#create-a-gateway), Cloudflare automatically creates and adds records to your Cloudflare DNS so your gateway can receive and route traffic appropriately: * **Ethereum gateways**: Creates a [proxied](https://developers.cloudflare.com/dns/proxy-status/) `CNAME` record pointing your hostname to `ethereum.cloudflare.com`. * **IPFS gateways**: Creates a [proxied](https://developers.cloudflare.com/dns/proxy-status/) `CNAME` record pointing your hostname to `ipfs.cloudflare.com` and a `TXT` record with the value specified for its [DNSLink](https://developers.cloudflare.com/web3/ipfs-gateway/concepts/dnslink/#how-is-it-used-with-cloudflare). These records cannot be edited within Cloudflare DNS. To make edits, you will have to [edit the gateway configuration](https://developers.cloudflare.com/web3/how-to/manage-gateways/#edit-a-gateway) itself. ## Existing DNS records When you [create a gateway](https://developers.cloudflare.com/web3/how-to/manage-gateways/#create-a-gateway) using a hostname with pre-existing DNS records, Cloudflare automatically overwrites your existing records to make them apply to your Web3 gateway. ```json {"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"item":{"@id":"/directory/","name":"Directory"}},{"@type":"ListItem","position":2,"item":{"@id":"/web3/","name":"Web3"}},{"@type":"ListItem","position":3,"item":{"@id":"/web3/reference/","name":"Reference"}},{"@type":"ListItem","position":4,"item":{"@id":"/web3/reference/gateway-dns-records/","name":"Gateway DNS records"}}]} ``` --- --- title: Gateway status description: Web3 gateway status values and their meanings. image: https://developers.cloudflare.com/core-services-preview.png --- > Documentation Index > Fetch the complete documentation index at: https://developers.cloudflare.com/web3/llms.txt > Use this file to discover all available pages before exploring further. [Skip to content](#%5Ftop) # Gateway status Once you [create a gateway](https://developers.cloudflare.com/web3/how-to/manage-gateways/#create-a-gateway), it can have one of several statuses. | Status | Definition | | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Active** | The DNS records for your gateway have been created and are functioning correctly. | | **Pending** | Your Web3 gateway is in the process of becoming **Active**. | | **Deleting** | Your Web3 gateway is being deleted. | | **Error** | The DNS records for your gateway are misconfigured or do not exist. To fix, try [refreshing the gateway](https://developers.cloudflare.com/web3/how-to/manage-gateways/#refresh-a-gateway). | ```json {"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"item":{"@id":"/directory/","name":"Directory"}},{"@type":"ListItem","position":2,"item":{"@id":"/web3/","name":"Web3"}},{"@type":"ListItem","position":3,"item":{"@id":"/web3/reference/","name":"Reference"}},{"@type":"ListItem","position":4,"item":{"@id":"/web3/reference/gateway-status/","name":"Gateway status"}}]} ``` --- --- title: Limits description: Rate limits and size limits for Web3 gateways. image: https://developers.cloudflare.com/core-services-preview.png --- > Documentation Index > Fetch the complete documentation index at: https://developers.cloudflare.com/web3/llms.txt > Use this file to discover all available pages before exploring further. [Skip to content](#%5Ftop) # Limits The following limits apply to users of the Cloudflare Web3 Gateways. Note For more pricing details, refer to the [Web3 product page ↗](https://www.cloudflare.com/application-services/products/web3/). ## IPFS Gateway The following limits apply to Cloudflare's [IPFS Gateway](https://developers.cloudflare.com/web3/ipfs-gateway/). | Free | Pro | Business | Enterprise | | | -------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Availability | Yes (Usage-based billing) | Yes (Usage-based billing) | Yes (Usage-based billing) | Yes (Usage-based billing) | | Total gateways | 15 | 15 | 15 | Unlimited | | Gateway types | [DNSLink](https://developers.cloudflare.com/web3/ipfs-gateway/concepts/dnslink/) | [DNSLink](https://developers.cloudflare.com/web3/ipfs-gateway/concepts/dnslink/) | [DNSLink](https://developers.cloudflare.com/web3/ipfs-gateway/concepts/dnslink/) | [DNSLink](https://developers.cloudflare.com/web3/ipfs-gateway/concepts/dnslink/),[Universal Gateway](https://developers.cloudflare.com/web3/ipfs-gateway/concepts/universal-gateway/) | | Included bandwidth (without additional cost) | 50 GB data transfer | 50 GB data transfer | 50 GB data transfer | 100 GB data transfer | | File size limit | None | None | None | None | ## Ethereum Gateway The following limits apply to Cloudflare's [Ethereum Gateway](https://developers.cloudflare.com/web3/ethereum-gateway/). | Free | Pro | Business | Enterprise | | | --------------------------------------------- | ------------------------- | ------------------------- | ------------------------- | ------------------------- | | Availability | Yes (Usage-based billing) | Yes (Usage-based billing) | Yes (Usage-based billing) | Yes (Usage-based billing) | | Total gateways | 15 | 15 | 15 | Unlimited | | Included bandwidth (without additional cost) | 500,000 HTTP requests | 500,000 HTTP requests | 500,000 HTTP requests | 1,000,000 HTTP requests | ```json {"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"item":{"@id":"/directory/","name":"Directory"}},{"@type":"ListItem","position":2,"item":{"@id":"/web3/","name":"Web3"}},{"@type":"ListItem","position":3,"item":{"@id":"/web3/reference/","name":"Reference"}},{"@type":"ListItem","position":4,"item":{"@id":"/web3/reference/limits/","name":"Limits"}}]} ``` --- --- title: Legacy gateway migration description: Migrate from legacy Web3 gateways to the current setup. image: https://developers.cloudflare.com/core-services-preview.png --- > Documentation Index > Fetch the complete documentation index at: https://developers.cloudflare.com/web3/llms.txt > Use this file to discover all available pages before exploring further. [Skip to content](#%5Ftop) ### Tags [ Migration ](https://developers.cloudflare.com/search/?tags=Migration) # Legacy gateway migration As announced in [our blog post ↗](https://blog.cloudflare.com/ea-web3-gateways/), Cloudflare is deprecating legacy hostnames that point to our public gateway endpoints at `cloudflare-eth.com` and `cloudflare-ipfs.com`. If you created a hostname pointing to these gateways during the [private beta ↗](https://blog.cloudflare.com/announcing-web3-gateways/), you should migrate to use our new Web3 gateways to avoid a disruption in service. --- ## Migration guide The migration is a simple process. First, create a [Cloudflare account](https://developers.cloudflare.com/fundamentals/account/create-account/). Then create a new [Web3 custom gateway](https://developers.cloudflare.com/web3/how-to/manage-gateways/#create-a-gateway) with your existing hostname. Alternatively, you could also create a [Web3 custom gateway](https://developers.cloudflare.com/web3/how-to/manage-gateways/#create-a-gateway) for a new hostname and then modify your application to use your newly created hostname ([IPFS](https://developers.cloudflare.com/web3/how-to/use-ipfs-gateway/) or [Ethereum](https://developers.cloudflare.com/web3/how-to/use-ethereum-gateway/)). ```json {"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"item":{"@id":"/directory/","name":"Directory"}},{"@type":"ListItem","position":2,"item":{"@id":"/web3/","name":"Web3"}},{"@type":"ListItem","position":3,"item":{"@id":"/web3/reference/","name":"Reference"}},{"@type":"ListItem","position":4,"item":{"@id":"/web3/reference/migration-guide/","name":"Legacy gateway migration"}}]} ```