diff --git a/content/admin-api/overview.mdx b/content/admin-api/overview.mdx index 83849268d..f454c1f93 100644 --- a/content/admin-api/overview.mdx +++ b/content/admin-api/overview.mdx @@ -4,13 +4,13 @@ subtitle: Programmatically create, configure, and manage Alchemy apps. slug: reference/admin-api/overview --- -The App Management API lets you programmatically create, configure, and manage Alchemy apps without using the dashboard. It is designed for automation, compliance, and enterprise workflows. +The App Management API lets you programmatically create, configure, and manage Alchemy apps without using the Alchemy Dashboard. It is designed for automation, compliance, and enterprise workflows. An App represents a single Alchemy project. You create an app, configure which networks it can access, and optionally restrict usage via allowlists. All changes are applied immediately. *** -## Overview +## What you can do Use this API to: @@ -30,7 +30,7 @@ All requests must include an access key with App Management permissions. To create an access key: -1. Open the Alchemy Dashboard +1. Open the [Alchemy Dashboard](https://dashboard.alchemy.com/) 2. Go to the [Security Tab](https://dashboard.alchemy.com/settings/security) 3. Create a new access key 4. Enable App Management with Read & Write permissions diff --git a/content/admin-api/quickstart.mdx b/content/admin-api/quickstart.mdx index d5674297c..aee7a2c26 100644 --- a/content/admin-api/quickstart.mdx +++ b/content/admin-api/quickstart.mdx @@ -4,7 +4,7 @@ subtitle: Create, configure, and manage an app using the Admin API. slug: reference/admin-api/quickstart --- -## Getting Started +## Get started This guide walks through creating an app, retrieving its details, updating its configuration, and deleting it. diff --git a/content/api-reference/abstract/abstract-api-faq.mdx b/content/api-reference/abstract/abstract-api-faq.mdx index 0c55cdad2..b08d7ffdc 100644 --- a/content/api-reference/abstract/abstract-api-faq.mdx +++ b/content/api-reference/abstract/abstract-api-faq.mdx @@ -19,7 +19,7 @@ Explained in [Abstract API Quickstart](/docs/reference/abstract-api-quickstart). ## Is Abstract EVM compatible? -Abstract is EVM compatible, meaning it looks and feels like Ethereum, but with lower gas fees and higher transaction throughput. Most existing smart contracts built for Ethereum will work out of the box on Abstract (with some differences), meaning developers can easily port applications to Abstract with minimal changes. +Abstract is EVM compatible, meaning it looks and feels like Ethereum, but with lower gas fees and higher transaction throughput. Most existing smart contracts built for Ethereum work out of the box on Abstract (with some differences), meaning you can port applications to Abstract with minimal changes. ## What unique features does Abstract offer? @@ -27,12 +27,12 @@ Abstract offers native account abstraction, which is a key feature of its archit ## How does Abstract's architecture work? -Abstract's architecture includes system contracts and native account abstraction. Developers can learn more about the components that make up Abstract through their documentation. +Abstract's architecture includes system contracts and native account abstraction. You can learn more about the components that make up Abstract through their documentation. ## How does Abstract ensure scalability and security? -Built on top of the ZK Stack, Abstract is a zero-knowledge (ZK) rollup built to be a more scalable alternative to Ethereum; it achieves this scalability by executing transactions off-chain, batching them together, and verifying batches of transactions on Ethereum using (ZK) proofs. +Built on top of the ZK Stack, Abstract is a zero-knowledge (ZK) rollup built to be a more scalable alternative to Ethereum; it achieves this scalability by executing transactions offchain, batching them together, and verifying batches of transactions on Ethereum using (ZK) proofs. ## My question isn't here, where can I get help? -Don't worry, we got you. If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +Don't worry, we got you. If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/abstract/abstract-api-quickstart.mdx b/content/api-reference/abstract/abstract-api-quickstart.mdx index 38304a3a3..6967db46b 100644 --- a/content/api-reference/abstract/abstract-api-quickstart.mdx +++ b/content/api-reference/abstract/abstract-api-quickstart.mdx @@ -14,7 +14,7 @@ Abstract is a Layer 2 (L2) network built on top of Ethereum, designed to securel The Abstract API allows interaction with the Abstract network through a set of JSON-RPC methods. Its design is familiar to developers who have worked with Ethereum's JSON-RPC APIs, making it intuitive and straightforward to use. -## Send Your First Request on Alchemy +## Send your first request on Alchemy Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create an Abstract client connected to Alchemy and fetch the latest block number! @@ -28,7 +28,7 @@ Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create an ``` -## Create Client Connected to Alchemy +## Create a client connected to Alchemy ```js @@ -44,7 +44,7 @@ const client = createPublicClient({ Now that you've created a client connected to Alchemy, you can continue with some basics: -## Get Latest Block Number +## Get the latest block number ```js @@ -53,7 +53,7 @@ console.log("Current block number:", blockNumber); ``` -## Get an Address Balance +## Get an address balance ```js @@ -62,7 +62,7 @@ console.log("Balance (ETH):", Number(balance) / 1e18); ``` -## Read Block Data +## Read block data ```js @@ -73,7 +73,7 @@ console.log(block); ``` -## Fetch a Transaction by Hash +## Fetch a transaction by hash ```js @@ -82,7 +82,7 @@ console.log(tx); ``` -## Fetch Transaction Receipt +## Fetch a transaction receipt ```js diff --git a/content/api-reference/adi/adi-api-faq.mdx b/content/api-reference/adi/adi-api-faq.mdx index f6bf86254..91591d11e 100644 --- a/content/api-reference/adi/adi-api-faq.mdx +++ b/content/api-reference/adi/adi-api-faq.mdx @@ -12,19 +12,19 @@ ADI Network is an EVM-compatible Layer 2 that leverages cryptographic Zero-Knowl Check out our [ADI API Quickstart guide](/docs/reference/adi-api-quickstart) to get started building on ADI. ## What is the ADI API? -The ADI API allows developers to interface with the ADI mainnet. With this API, developers can execute transactions, query on-chain data, and interact with the ADI network, relying on a JSON-RPC standard. +The ADI API allows you to interface with the ADI mainnet. With this API, you can execute transactions, query onchain data, and interact with the ADI network, relying on a JSON-RPC standard. ## Is ADI EVM compatible? Yes, ADI is EVM compatible. ## What API does ADI use? -ADI uses the JSON-RPC API standard. This API is crucial for any blockchain interaction on the ADI network, allowing users to read block/transaction data, query chain information, execute smart contracts, and store data on-chain. +ADI uses the JSON-RPC API standard. This API is crucial for any blockchain interaction on the ADI network, allowing you to read block/transaction data, query chain information, execute smart contracts, and store data onchain. ## What methods are supported on ADI? ADI supports standard Ethereum JSON-RPC methods. Some chain-specific methods may vary. Please check the [ADI API Endpoints](/docs/chains#adi-apis) for a complete list. ## What is an ADI API key? -When accessing the ADI network via a node provider like Alchemy, ADI developers use an API key to send transactions and retrieve data from the network. For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup)! +When accessing the ADI network via a node provider like Alchemy, you use an API key to send transactions and retrieve data from the network. For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup). ## Which libraries support ADI? Common Ethereum libraries like [ethers.js](https://docs.ethers.org/v5/) should be compatible with ADI, given its EVM nature. @@ -33,4 +33,4 @@ Common Ethereum libraries like [ethers.js](https://docs.ethers.org/v5/) should b The native currency of ADI is ADI. ## My question isn’t here, where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/adi/adi-api-quickstart.mdx b/content/api-reference/adi/adi-api-quickstart.mdx index b9d168cb2..20b47e49e 100644 --- a/content/api-reference/adi/adi-api-quickstart.mdx +++ b/content/api-reference/adi/adi-api-quickstart.mdx @@ -14,7 +14,7 @@ ADI Network is an EVM-compatible Layer 2 that leverages cryptographic Zero-Knowl The ADI API allows interaction with the ADI network through a set of JSON-RPC methods. Its design is familiar to developers who have worked with Ethereum's JSON-RPC APIs, making it intuitive and straightforward to use. -## Send Your First Request on Alchemy +## Send your first request on Alchemy Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create an ADI client connected to Alchemy and fetch the latest block number! @@ -28,7 +28,7 @@ Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create an ``` -## Create Client Connected to Alchemy +## Create a client connected to Alchemy ```js @@ -52,7 +52,7 @@ const client = createPublicClient({ Now that you've created a client connected to Alchemy, you can continue with some basics: -## Get Latest Block Number +## Get the latest block number ```js @@ -61,7 +61,7 @@ console.log("Current block number:", blockNumber); ``` -## Get an Address Balance +## Get an address balance ```js @@ -70,7 +70,7 @@ console.log("Balance (ETH):", Number(balance) / 1e18); ``` -## Read Block Data +## Read block data ```js @@ -81,7 +81,7 @@ console.log(block); ``` -## Fetch a Transaction by Hash +## Fetch a transaction by hash ```js @@ -90,7 +90,7 @@ console.log(tx); ``` -## Fetch Transaction Receipt +## Fetch a transaction receipt ```js diff --git a/content/api-reference/alchemy-rollups/customizations-integrations.mdx b/content/api-reference/alchemy-rollups/customizations-integrations.mdx index 5f4b30580..03ad254e3 100644 --- a/content/api-reference/alchemy-rollups/customizations-integrations.mdx +++ b/content/api-reference/alchemy-rollups/customizations-integrations.mdx @@ -45,7 +45,7 @@ Leverage our full suite of developer tools—the same ones powering leading plat ### Token API -* **Comprehensive Token Data:** Easily retrieve token balances and metadata across supported chains. +* **Comprehensive Token Data:** Retrieve token balances and metadata across supported chains. * **No Token List Required:** Automatically provides accurate token information. * **Simplified Integration:** Streamlines the process of displaying token data in your applications. @@ -53,7 +53,7 @@ Leverage our full suite of developer tools—the same ones powering leading plat * **Gas Sponsorship:** Enable transactions to be sponsored, lowering the barrier for user interactions. * **Optimized Throughput:** Ensures transactions are processed quickly by mitigating gas fee spikes. -* **Enhanced User Experience:** Reduces friction, making it easier for users to engage with your dApp. +* **Enhanced User Experience:** Reduces friction, making it easier to engage with your dApp. *** @@ -63,7 +63,7 @@ Expand your rollup’s functionality by integrating with top-tier partners in th **Key Offerings:** -* **Seamless Integrations:** Easily add capabilities such as oracles, data indexers, cross-chain bridges, and more. +* **Seamless Integrations:** Add capabilities such as oracles, data indexers, cross-chain bridges, and more. * **Ecosystem Growth:** Access a vast network of developers and partners to accelerate your project’s adoption. * **Enterprise-Grade Features:** Enjoy white-glove customization, rapid support, and co-marketing opportunities to grow your rollup’s ecosystem. diff --git a/content/api-reference/alchemy-rollups/operating-your-rollup.mdx b/content/api-reference/alchemy-rollups/operating-your-rollup.mdx index 0746a05d4..7288bde96 100644 --- a/content/api-reference/alchemy-rollups/operating-your-rollup.mdx +++ b/content/api-reference/alchemy-rollups/operating-your-rollup.mdx @@ -38,7 +38,7 @@ This guide covers reliability, upgrades, security, and monitoring. # 4. Monitoring & Analytics -* The dashboard provides detailed metrics including TPS, gas usage, and RPC performance. +* The Alchemy Dashboard provides detailed metrics including TPS, gas usage, and RPC performance. * Log data and alerts help identify issues and trigger maintenance actions. * Integration with external analytics tools is supported for deeper insights. diff --git a/content/api-reference/alchemy-rollups/quickstart-deploy-a-rollup.mdx b/content/api-reference/alchemy-rollups/quickstart-deploy-a-rollup.mdx index dc4e007a9..d7efb1e0d 100644 --- a/content/api-reference/alchemy-rollups/quickstart-deploy-a-rollup.mdx +++ b/content/api-reference/alchemy-rollups/quickstart-deploy-a-rollup.mdx @@ -5,7 +5,7 @@ subtitle: Quickstart guide on deploying a self-serve rollup through the Alchemy slug: reference/quickstart-deploy-a-rollup --- -This guide will help you deploy a testnet rollup using the Alchemy Rollups dashboard. Follow these steps to quickly launch your own Layer-2 blockchain. +This guide helps you deploy a testnet rollup using the Alchemy Rollups dashboard. Follow these steps to launch your own Layer-2 blockchain. ## Prerequisites @@ -13,7 +13,7 @@ This guide will help you deploy a testnet rollup using the Alchemy Rollups dashb ## Steps to Deploy a Testnet -1. **Open the Deployment Page:** Navigate to the Rollups section in your [Alchemy dashboard](https://dashboard.alchemy.com/) and click on "Get Started" +1. **Open the Deployment Page:** Navigate to the Rollups section in your [Alchemy Dashboard](https://dashboard.alchemy.com/) and click on "Get Started" ![](https://alchemyapi-res.cloudinary.com/image/upload/v1759284832/docs/deploy-rollup-1_rnqosh.png) diff --git a/content/api-reference/alchemy-rollups/rollups-faq.mdx b/content/api-reference/alchemy-rollups/rollups-faq.mdx index 299508098..072ecae0e 100644 --- a/content/api-reference/alchemy-rollups/rollups-faq.mdx +++ b/content/api-reference/alchemy-rollups/rollups-faq.mdx @@ -21,7 +21,7 @@ A: Our system includes robust redundancy and failover mechanisms to minimize dow **Q: How do I connect my wallet to the rollup?** -A: Add the rollup as a custom network in your wallet by using the RPC URL, Chain ID, currency symbol, and block explorer URL provided in your dashboard. +A: Add the rollup as a custom network in your wallet by using the RPC URL, Chain ID, currency symbol, and block explorer URL provided in your Alchemy Dashboard. **Q: Can I run my own full node?** @@ -33,7 +33,7 @@ A: Throughput can be optimized by adjusting parameters such as block gas limits, **Q: How do I calculate transaction fees?** -A: Transaction fees consist of an L2 execution cost and an L1 inclusion cost. The platform calculates these fees dynamically, and detailed fee breakdowns are available in the dashboard. +A: Transaction fees consist of an L2 execution cost and an L1 inclusion cost. The platform calculates these fees dynamically, and detailed fee breakdowns are available in the Alchemy Dashboard. **Q: Can I change the gas token after deployment?** @@ -41,4 +41,4 @@ A: Changing the gas token post-deployment is complex and typically requires laun **Q: How do I get help if I encounter issues?** -A: For support, use the dedicated channels provided in the dashboard or join our community forums. Detailed troubleshooting guides are also available online. +A: For support, use the dedicated channels provided in the Alchemy Dashboard or join our community forums. Detailed troubleshooting guides are also available online. diff --git a/content/api-reference/alchemy-rollups/rollups-quickstart.mdx b/content/api-reference/alchemy-rollups/rollups-quickstart.mdx index b5c651f94..70ac5179b 100644 --- a/content/api-reference/alchemy-rollups/rollups-quickstart.mdx +++ b/content/api-reference/alchemy-rollups/rollups-quickstart.mdx @@ -11,7 +11,7 @@ hide-toc: true Alchemy Rollups helps you run a dedicated rollup with full control over transaction speed, cost, and functionality. Alchemy Rollups supports both Optimistic Rollups and Zero-Knowledge (ZK) Rollups. -Before diving in, it's important to understand what rollups are and the two primary types available: +Before diving in, here's what rollups are and the two primary types available: # What is a Rollup? @@ -29,7 +29,7 @@ A rollup is a blockchain solution that processes transactions off the main chain **Zero-Knowledge (ZK) Rollups:** * Generate a cryptographic proof for each batch of transactions. -* Allow for near-instant finality since there’s no challenge period. +* Allow near-instant finality since there’s no challenge period. * Offer even greater scalability by reducing the amount of data posted to Layer-1. * Can be more complex to implement due to the proof generation process. @@ -43,7 +43,7 @@ A rollup is a blockchain solution that processes transactions off the main chain ### 🆕 Unlock Novel Use Cases -* **Tailored Functionality:** When you control your chain, you can customize its behavior to suit your specific needs. This flexibility enables innovative integrations—like linking on-chain identities with external verification systems—to power entirely new applications. +* **Tailored Functionality:** When you control your chain, you can customize its behavior to suit your specific needs. This flexibility enables innovative integrations—like linking onchain identities with external verification systems—to power entirely new applications. ### 💸 Make Money diff --git a/content/api-reference/alchemy-rollups/using-your-rollup.mdx b/content/api-reference/alchemy-rollups/using-your-rollup.mdx index ae1683d80..472fed5c4 100644 --- a/content/api-reference/alchemy-rollups/using-your-rollup.mdx +++ b/content/api-reference/alchemy-rollups/using-your-rollup.mdx @@ -15,7 +15,7 @@ This guide covers the following: # 1. RPC Endpoints & API Access -* Your rollup’s RPC URL is available in the Alchemy dashboard. +* Your rollup’s RPC URL is available in the Alchemy Dashboard. * Use this URL in your web3 libraries (e.g., viem, ethers.js, web3.js) to interact with the blockchain. * Standard JSON-RPC methods are supported for reading state and sending transactions. @@ -23,7 +23,7 @@ This guide covers the following: ## Depositing to Rollup -* Use the Bridge UI provided in the dashboard or an external bridge provider. +* Use the Bridge UI provided in the Alchemy Dashboard or an external bridge provider. * Send assets (e.g., ETH, ERC-20 tokens) from your parent chain to your rollup. This involves locking tokens on the parent chain and minting corresponding tokens on rollup. ## Withdrawing to Parent Chain @@ -51,7 +51,7 @@ These steps ensure you can fully use your rollup for development and testing. # 5. Deploying Smart Contracts on Your Rollup -Deploying smart contracts to your rollup is similar to deploying on Ethereum. This guide covers the use of popular tools such as Hardhat and Foundry. +Deploying smart contracts on your rollup is similar to deploying on Ethereum. This guide covers popular tools such as Hardhat and Foundry. ## Using Hardhat diff --git a/content/api-reference/alchemy-transact/transaction-simulation/simulation.mdx b/content/api-reference/alchemy-transact/transaction-simulation/simulation.mdx index d21b7a267..6f3b8fb58 100644 --- a/content/api-reference/alchemy-transact/transaction-simulation/simulation.mdx +++ b/content/api-reference/alchemy-transact/transaction-simulation/simulation.mdx @@ -7,7 +7,7 @@ slug: reference/simulation With our Simulation APIs, you can know the exact impact of a transaction ***before*** it hits the blockchain. -The Transaction Simulation APIs can help prevent unwanted hacks or theft, so you know exactly what a transaction will do by simulating it before you approve it in your wallet. This means identifying exactly what assets will be transferred, what logs will be emitted, what internal calls will be made, etc., before it even happens. +The Transaction Simulation APIs help prevent unwanted hacks or theft, so you know exactly what a transaction will do by simulating it before you approve it in your wallet. This means identifying exactly what assets will be transferred, what logs will be emitted, what internal calls will be made, etc., before it even happens. [**Asset Changes**](/docs/reference/simulation-asset-changes)
Simulates a transaction and returns a full list of asset changes. diff --git a/content/api-reference/anime/anime-api-faq.mdx b/content/api-reference/anime/anime-api-faq.mdx index 345dba2a9..22affdb23 100644 --- a/content/api-reference/anime/anime-api-faq.mdx +++ b/content/api-reference/anime/anime-api-faq.mdx @@ -10,7 +10,7 @@ Anime is a fast and secure blockchain built on Arbitrum, designed to support ani ## What is the Anime API? -The Anime API allows developers to interface with the Anime mainnet and testnet nodes. With this API, developers can execute transactions, query on-chain data, and interact with the Anime network, relying on a JSON-RPC standard. +The Anime API allows you to interface with the Anime mainnet and testnet nodes. With this API, you can execute transactions, query onchain data, and interact with the Anime network, relying on a JSON-RPC standard. ## How can I get started using the Anime API? @@ -18,17 +18,17 @@ Explained in [Anime API Quickstart](/docs/reference/anime-api-quickstart) ## Is Anime EVM compatible? -Absolutely. Anime confidently supports any Ethereum Virtual Machine (EVM) codebase. This allows developers to smoothly deploy and migrate assets and users from Ethereum L1 and other interoperable chains to Anime. +Yes. Anime supports any Ethereum Virtual Machine (EVM) codebase. This allows you to deploy and migrate assets from Ethereum L1 and other interoperable chains to Anime. ## What API does Anime use? -Anime utilizes the JSON-RPC API standard. This API is crucial for any blockchain interaction on the Anime network, allowing users to read block/transaction data, query chain information, execute smart contracts, and store data on-chain. +Anime uses the JSON-RPC API standard. This API is crucial for any blockchain interaction on the Anime network, allowing you to read block/transaction data, query chain information, execute smart contracts, and store data onchain. ## What is a Anime API key? -When accessing the Anime network via a node provider like Alchemy, Anime developers use an API key to send transactions and retrieve data from the network. +When accessing the Anime network via a node provider like Alchemy, you use an API key to send transactions and retrieve data from the network. -For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup)! +For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup). ## Which libraries support Anime? @@ -36,7 +36,7 @@ Common Ethereum libraries like [ethers.js](https://docs.ethers.org/v5/) and [web ## What programming languages work with Anime? -Languages that work with Ethereum, such as Javascript, Solidity, Typescript, and Shell, should also be compatible with Anime. Solidity remains the primary choice for smart contract development, while Javascript is ideal for off-chain interactions. +Languages that work with Ethereum, such as JavaScript, Solidity, TypeScript, and Shell, should also be compatible with Anime. Solidity remains the primary choice for smart contract development, while JavaScript is ideal for offchain interactions. ## What does Anime use for gas? @@ -44,7 +44,7 @@ The native cryptocurrency for Animechain is the ANIME token, which is used for t ## What testnet should I use for Anime? -Developers should use the **Anime Sepolia** testnet for Anime. This testnet provides an environment to deploy smart contracts, execute transactions, and test applications. +Use the **Anime Sepolia** testnet for Anime. This testnet provides an environment to deploy smart contracts, execute transactions, and test applications. ## What methods does Alchemy support for the Anime API? @@ -52,4 +52,4 @@ You can find the list of all the methods Alchemy supports for the Anime API on t ## My question isn't here, where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/anime/anime-api-quickstart.mdx b/content/api-reference/anime/anime-api-quickstart.mdx index 517502c2a..63596f79f 100644 --- a/content/api-reference/anime/anime-api-quickstart.mdx +++ b/content/api-reference/anime/anime-api-quickstart.mdx @@ -14,7 +14,7 @@ Animechain is a fast and secure blockchain built on Arbitrum, designed to suppor The Anime API allows interaction with the Anime network through a set of JSON-RPC methods. Its design is familiar to developers who have worked with Ethereum's JSON-RPC APIs, making it intuitive and straightforward to use. -## Send Your First Request on Alchemy +## Send your first request on Alchemy Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create an Anime client connected to Alchemy and fetch the latest block number! @@ -28,7 +28,7 @@ Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create an ``` -## Create Client Connected to Alchemy +## Create a client connected to Alchemy ```js @@ -52,7 +52,7 @@ const client = createPublicClient({ Now that you've created a client connected to Alchemy, you can continue with some basics: -## Get Latest Block Number +## Get the latest block number ```js @@ -61,7 +61,7 @@ console.log("Current block number:", blockNumber); ``` -## Get an Address Balance +## Get an address balance ```js @@ -70,7 +70,7 @@ console.log("Balance (ANIME):", Number(balance) / 1e18); ``` -## Read Block Data +## Read block data ```js @@ -81,7 +81,7 @@ console.log(block); ``` -## Fetch a Transaction by Hash +## Fetch a transaction by hash ```js @@ -90,7 +90,7 @@ console.log(tx); ``` -## Fetch Transaction Receipt +## Fetch a transaction receipt ```js diff --git a/content/api-reference/apechain/apechain-api-faq.mdx b/content/api-reference/apechain/apechain-api-faq.mdx index fbe008169..b586dcb99 100644 --- a/content/api-reference/apechain/apechain-api-faq.mdx +++ b/content/api-reference/apechain/apechain-api-faq.mdx @@ -11,7 +11,7 @@ ApeChain is a dedicated infrastructure layer designed to power the ApeCoin ecosy ## What is the ApeChain API? -The ApeChain API allows developers to interact with the ApeChain network through a set of JSON-RPC methods. It supports various operations such as smart contract deployment, transaction processing, and data retrieval, enabling developers to integrate ApeChain's functionality into their applications. +The ApeChain API allows you to interact with the ApeChain network through a set of JSON-RPC methods. It supports various operations such as smart contract deployment, transaction processing, and data retrieval, enabling you to integrate ApeChain's functionality into your applications. ## How can I get started using the ApeChain API? @@ -19,7 +19,7 @@ Explained in [ApeChain Quickstart Guide](/docs/reference/apechain-api-quickstart ## Is ApeChain EVM compatible? -Yes, ApeChain is EVM-compatible. As an Arbitrum chain, it allows developers to deploy Ethereum-based smart contracts and applications on the ApeChain network, leveraging existing Ethereum development tools and practices. +Yes, ApeChain is EVM-compatible. As an Arbitrum chain, it allows you to deploy Ethereum-based smart contracts and applications on the ApeChain network, leveraging existing Ethereum development tools and practices. ## What API does ApeChain use? @@ -27,19 +27,19 @@ ApeChain utilizes the JSON-RPC API standard, which is widely used in the Ethereu ## What is an ApeChain API key? -When accessing the ApeChain network via a service provider, developers need an API key to send transactions and retrieve data. An API key ensures secure and authenticated access to the network. +When accessing the ApeChain network via a service provider, you need an API key to send transactions and retrieve data. An API key ensures secure and authenticated access to the network. ## Which libraries support ApeChain? -As an EVM-compatible blockchain, ApeChain supports popular Ethereum libraries such as Web3.js and Ethers.js. This allows developers to leverage existing tools and knowledge when building on ApeChain. +As an EVM-compatible blockchain, ApeChain supports popular Ethereum libraries such as Web3.js and Ethers.js. This allows you to leverage existing tools and knowledge when building on ApeChain. ## What programming languages work with ApeChain? -ApeChain supports Solidity for smart contract development due to its EVM compatibility. For off-chain interactions, developers can use JavaScript, TypeScript, or other common web development languages. +ApeChain supports Solidity for smart contract development due to its EVM compatibility. For offchain interactions, you can use JavaScript, TypeScript, or other common web development languages. ## What does ApeChain use for gas? -ApeChain uses `$APE` as its native gas token. This means that users need `$APE` to pay for transaction fees on the network, which significantly enhances the utility of `$APE` within the ecosystem. +ApeChain uses `$APE` as its native gas token. You need `$APE` to pay for transaction fees on the network, which significantly enhances the utility of `$APE` within the ecosystem. ## How can I participate in the ApeChain ecosystem? @@ -52,8 +52,8 @@ You can participate in the ApeChain ecosystem by: ## Is ApeChain secure? -ApeChain inherits security features from Arbitrum's technology and ultimately derives its security from Ethereum. However, as with any blockchain technology, users and developers should always exercise caution and follow best practices for security. +ApeChain inherits security features from Arbitrum's technology and ultimately derives its security from Ethereum. However, as with any blockchain technology, you should always exercise caution and follow best practices for security. ## My question isn't here, where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/apechain/apechain-api-quickstart.mdx b/content/api-reference/apechain/apechain-api-quickstart.mdx index 64684d195..cfb971205 100644 --- a/content/api-reference/apechain/apechain-api-quickstart.mdx +++ b/content/api-reference/apechain/apechain-api-quickstart.mdx @@ -10,11 +10,11 @@ slug: reference/apechain-api-quickstart get started today. -ApeChain is a dedicated infrastructure layer designed to power the ApeCoin ecosystem. It's an Arbitrum chain that utilizes `$APE` as its native gas token, significantly enhancing `$APE`'s utility and fostering a robust, dynamic economy. ApeChain focuses on ecosystem discovery, unique web3 rails, and top-of-funnel exposure to provide developers and users with the best possible blockchain experience. +ApeChain is a dedicated infrastructure layer designed to power the ApeCoin ecosystem. It's an Arbitrum chain that utilizes `$APE` as its native gas token, significantly enhancing `$APE`'s utility and fostering a robust, dynamic economy. ApeChain focuses on ecosystem discovery, unique web3 rails, and top-of-funnel exposure to provide you with the best possible blockchain experience. The ApeChain API allows interaction with the ApeChain network through a set of JSON-RPC methods. Its design is familiar to developers who have worked with Ethereum's JSON-RPC APIs, making it intuitive and straightforward to use. -## Send Your First Request on Alchemy +## Send your first request on Alchemy Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create an ApeChain client connected to Alchemy and fetch the latest block number! @@ -28,7 +28,7 @@ Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create an ``` -## Create Client Connected to Alchemy +## Create a client connected to Alchemy ```js @@ -44,7 +44,7 @@ const client = createPublicClient({ Now that you've created a client connected to Alchemy, you can continue with some basics: -## Get Latest Block Number +## Get the latest block number ```js @@ -53,7 +53,7 @@ console.log("Current block number:", blockNumber); ``` -## Get an Address Balance +## Get an address balance ```js @@ -62,7 +62,7 @@ console.log("Balance (APE):", Number(balance) / 1e18); ``` -## Read Block Data +## Read block data ```js @@ -73,7 +73,7 @@ console.log(block); ``` -## Fetch a Transaction by Hash +## Fetch a transaction by hash ```js @@ -82,7 +82,7 @@ console.log(tx); ``` -## Fetch Transaction Receipt +## Fetch a transaction receipt ```js diff --git a/content/api-reference/aptos/aptos-api-faq.mdx b/content/api-reference/aptos/aptos-api-faq.mdx index 7c6fc86a6..285a7aade 100644 --- a/content/api-reference/aptos/aptos-api-faq.mdx +++ b/content/api-reference/aptos/aptos-api-faq.mdx @@ -10,7 +10,7 @@ Aptos is a Layer 1 blockchain built for scalability, safety, and upgradeability. ## What is the Aptos API? -The Aptos API allows developers to interact with the Aptos blockchain via a set of RESTful endpoints. It enables actions such as querying accounts and transactions, submitting new transactions, interacting with smart contracts, and accessing on-chain resources. +The Aptos API allows you to interact with the Aptos blockchain via a set of RESTful endpoints. It enables actions such as querying accounts and transactions, submitting new transactions, interacting with smart contracts, and accessing onchain resources. ## How can I get started using the Aptos API? @@ -26,7 +26,7 @@ The Aptos API follows REST principles and communicates via standard HTTP request ## What is an Aptos API key? -If you're using a blockchain infrastructure provider like Alchemy, an API key allows you to send authenticated requests to the Aptos network. This lets you read data from the chain and submit transactions securely. +When using a blockchain infrastructure provider like Alchemy, an API key allows you to send authenticated requests to the Aptos network. This lets you read data from the chain and submit transactions securely. ## Which libraries can I use with the Aptos API? @@ -47,4 +47,4 @@ Aptos uses its native token, APT, to pay transaction fees. The API provides endp ## My question isn't listed here — where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/aptos/aptos-api-quickstart.mdx b/content/api-reference/aptos/aptos-api-quickstart.mdx index 304098df0..42949d929 100644 --- a/content/api-reference/aptos/aptos-api-quickstart.mdx +++ b/content/api-reference/aptos/aptos-api-quickstart.mdx @@ -8,13 +8,13 @@ slug: "reference/aptos-api-quickstart" Aptos is a next-generation Layer 1 blockchain designed for scalability, safety, and upgradeability. It leverages the Move programming language and a novel consensus mechanism to achieve high throughput and low latency. -With its modular architecture, Aptos supports frequent and instant upgrades, making it a dynamic platform for developers and users alike. +With its modular architecture, Aptos supports frequent and instant upgrades, making it a dynamic platform for building and deploying applications. *** ## What is the Aptos Chain API? -The Aptos API provides developers with a set of tools to interact with the Aptos blockchain. +The Aptos API provides a set of tools to interact with the Aptos blockchain. It offers both RESTful and JSON-RPC endpoints, allowing for seamless integration, transaction management, wallet interactions, and more. @@ -30,19 +30,19 @@ Key features include: *** -## Getting Started Instructions +## Getting started -### 1. Choose a Package Manager (npm or yarn) +### 1. Choose a package manager (npm or yarn) -Your first step involves selecting a package manager, which will be crucial for managing your project's dependencies. The choice between `npm` and `yarn` depends on your personal preference or project requirements. +Select a package manager to manage your project's dependencies. The choice between `npm` and `yarn` depends on your preference or project requirements. | npm | yarn | | ------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | | Begin with `npm` by following the [npm documentation](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm). | For `yarn`, refer to [yarn's installation guide](https://classic.yarnpkg.com/lang/en/docs/install). | -### 2. Set Up Your Project +### 2. Set up your project -To kickstart your project, open your terminal and execute the following commands: +Open your terminal and run the following commands: ```text npm @@ -60,7 +60,7 @@ To kickstart your project, open your terminal and execute the following commands This creates a new directory named `aptos-api-quickstart` and initializes a Node.js project within it. -### 3. Make Your First Request +### 3. Make your first request Install Axios, a popular HTTP client, to make API requests: @@ -91,9 +91,9 @@ Create an `index.js` file in your project directory and paste the following code ``` -Remember to replace `yourAPIKey` with your actual Alchemy API key that you can get from your [Alchemy dashboard](https://dashboard.alchemy.com/signup). +Replace `yourAPIKey` with your actual Alchemy API key that you can get from the [Alchemy Dashboard](https://dashboard.alchemy.com/signup). -### 4. Run Your Script +### 4. Run your script To execute your script and make a request to the Aptos App, run: @@ -116,6 +116,6 @@ You should see a list of Aptos accounts (if any exist on your node or fullnode) ] ``` -## Next Steps +## Next steps -Well done! You've just made your first request to the Aptos App API. +You've made your first request to the Aptos App API. diff --git a/content/api-reference/arbitrum-nova/arbitrum-nova-api-quickstart.mdx b/content/api-reference/arbitrum-nova/arbitrum-nova-api-quickstart.mdx index dd01698f3..dc295cb77 100644 --- a/content/api-reference/arbitrum-nova/arbitrum-nova-api-quickstart.mdx +++ b/content/api-reference/arbitrum-nova/arbitrum-nova-api-quickstart.mdx @@ -14,7 +14,7 @@ Arbitrum Nova is a layer 2 scaling solution for Ethereum that leverages optimist The Arbitrum Nova API facilitates interaction with the Arbitrum Nova network through a collection of JSON-RPC methods. Given its compatibility with the Ethereum ecosystem, developers familiar with Ethereum's JSON-RPC APIs will find working with Arbitrum Nova both intuitive and straightforward. -## Send Your First Request on Alchemy +## Send your first request on Alchemy Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create an Arbitrum Nova client connected to Alchemy and fetch the latest block number! @@ -28,7 +28,7 @@ Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create an ``` -## Create Client Connected to Alchemy +## Create a client connected to Alchemy ```js @@ -44,7 +44,7 @@ const client = createPublicClient({ Now that you've created a client connected to Alchemy, you can continue with some basics: -## Get Latest Block Number +## Get the latest block number ```js @@ -53,7 +53,7 @@ console.log("Current block number:", blockNumber); ``` -## Get an Address Balance +## Get an address balance ```js @@ -62,7 +62,7 @@ console.log("Balance (ETH):", Number(balance) / 1e18); ``` -## Read Block Data +## Read block data ```js @@ -73,7 +73,7 @@ console.log(block); ``` -## Fetch a Transaction by Hash +## Fetch a transaction by hash ```js @@ -82,7 +82,7 @@ console.log(tx); ``` -## Fetch Transaction Receipt +## Fetch a transaction receipt ```js diff --git a/content/api-reference/arbitrum-nova/arbitrum-nova-chain-api-faq.mdx b/content/api-reference/arbitrum-nova/arbitrum-nova-chain-api-faq.mdx index eda287865..6c36dce88 100644 --- a/content/api-reference/arbitrum-nova/arbitrum-nova-chain-api-faq.mdx +++ b/content/api-reference/arbitrum-nova/arbitrum-nova-chain-api-faq.mdx @@ -7,11 +7,11 @@ slug: reference/arbitrum-nova-chain-api-faq ## What is Arbitrum Nova? -Arbitrum Nova is a layer 2 scaling solution designed to provide fast, low-cost transactions for Ethereum. It leverages optimistic rollups to achieve high throughput and security, enabling developers to build scalable decentralized applications (dApps) with ease. +Arbitrum Nova is a layer 2 scaling solution designed to provide fast, low-cost transactions for Ethereum. It leverages optimistic rollups to achieve high throughput and security, enabling you to build scalable decentralized applications (dApps). ## What is the Arbitrum Nova API? -The Arbitrum Nova API facilitates interaction with the Arbitrum Nova network through a collection of JSON-RPC methods. It allows developers to interact with the blockchain, enabling functionalities such as transactions, smart contract deployment, and data retrieval. +The Arbitrum Nova API facilitates interaction with the Arbitrum Nova network through a collection of JSON-RPC methods. It allows you to interact with the blockchain, enabling functionalities such as transactions, smart contract deployment, and data retrieval. ## How can I get started using the Arbitrum Nova API? @@ -19,7 +19,7 @@ Explained in [Arbitrum Nova API Quickstart](/docs/reference/arbitrum-nova-api-qu ## Is Arbitrum Nova EVM compatible? -Yes, Arbitrum Nova is fully compatible with the Ethereum Virtual Machine (EVM). This compatibility allows Ethereum developers to port their projects to Arbitrum Nova with minimal changes, benefiting from the network's scalability and low transaction fees. +Yes, Arbitrum Nova is fully compatible with the Ethereum Virtual Machine (EVM). This compatibility allows you to port your projects to Arbitrum Nova with minimal changes, benefiting from the network's scalability and low transaction fees. ## What API does Arbitrum Nova use? @@ -27,9 +27,9 @@ Arbitrum Nova uses the JSON-RPC API standard for blockchain interactions. This i ## What is an Arbitrum Nova API key? -When accessing the Arbitrum Nova network via a node provider like Alchemy, developers use an API key to send transactions and retrieve data from the network. +When accessing the Arbitrum Nova network via a node provider like Alchemy, you use an API key to send transactions and retrieve data from the network. -For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup)! +For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup). ## Which libraries support Arbitrum Nova? @@ -37,7 +37,7 @@ Given Arbitrum Nova's EVM compatibility, popular Ethereum libraries like ethers. ## What programming languages work with Arbitrum Nova? -Similar to Ethereum, Arbitrum Nova supports a range of programming languages for blockchain interaction and smart contract development, including Solidity for smart contracts, as well as JavaScript and TypeScript for dApp development and off-chain interactions. +Similar to Ethereum, Arbitrum Nova supports a range of programming languages for blockchain interaction and smart contract development, including Solidity for smart contracts, as well as JavaScript and TypeScript for dApp development and offchain interactions. ## What does Arbitrum Nova use for gas? @@ -49,4 +49,4 @@ You can find the list of all the methods Alchemy supports for the Arbitrum Nova ## My question isn't here, where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/arbitrum/arbitrum-api-faq/arbitrum-api-faq.mdx b/content/api-reference/arbitrum/arbitrum-api-faq/arbitrum-api-faq.mdx index a45964151..b9bd231a3 100644 --- a/content/api-reference/arbitrum/arbitrum-api-faq/arbitrum-api-faq.mdx +++ b/content/api-reference/arbitrum/arbitrum-api-faq/arbitrum-api-faq.mdx @@ -13,7 +13,7 @@ Arbitrum was founded by Steven Goldfeder and Harry Kalodner in 2021, and since i # What is the Arbitrum API? -The Arbitrum API allows applications to connect to an Arbitrum node that is part of the Arbitrum network. Developers can interact with on-chain data and send different types of transactions to the network by utilizing the endpoints provided by the API. The API follows a JSON-RPC standard. JSON-RPC is a stateless, lightweight, remote procedure call (RPC) protocol encoded in JSON. +The Arbitrum API allows applications to connect to an Arbitrum node that is part of the Arbitrum network. You can interact with onchain data and send different types of transactions to the network by utilizing the endpoints provided by the API. The API follows a JSON-RPC standard. JSON-RPC is a stateless, lightweight, remote procedure call (RPC) protocol encoded in JSON. ## How can I get started using the Arbitrum API? @@ -27,7 +27,7 @@ Arbitrum is a [Layer 2 scaling solution](https://www.alchemy.com/overviews/ether Yes! Arbitrum is fully compatible with all Solidity smart contracts and Ethereum libraries. As Arbitrum acts as a second layer operating on top of the main Ethereum network, it can utilize the [Ethereum Virtual Machine](https://www.alchemy.com/overviews/what-is-the-ethereum-virtual-machine-evm) just like Ethereum. -## How do I add Arbitrum to MetaMask Mainnet? +## How do I add Arbitrum to MetaMask mainnet? Adding Arbitrum to MetaMask takes four steps: @@ -38,9 +38,9 @@ Adding Arbitrum to MetaMask takes four steps: ## What testnet should I use for Arbitrum? -Developers should use the Arbitrum Goerli testnet and [a Goerli faucet to get test ETH](https://goerlifaucet.com/) when testing Arbitrum applications. +Use the Arbitrum Goerli testnet and [a Goerli faucet to get test ETH](https://goerlifaucet.com/) when testing Arbitrum applications. -If you sign in to your Alchemy account, you’ll get 5x more ETH. On Goerli, developers can get 0.05ETH every 24 hours, and use that on the testnet to make sure their applications are working properly before putting them on the Arbitrum mainnet. +If you sign in to your Alchemy account, you’ll get 5x more ETH. On Goerli, you can get 0.05ETH every 24 hours, and use that on the testnet to make sure your applications are working properly before putting them on Arbitrum mainnet. ## How do I build an app on Arbitrum? @@ -52,11 +52,11 @@ For bridging, use the [Arbitrum Bridge](https://bridge.arbitrum.io/). When you c ## What wallets can be used on Arbitrum? -Developers can use many [Web3 wallets](https://www.alchemy.com/web3-wallets-overview) on Arbitrum. As Optimism continues to grow, it supports many of the most popular wallets. Some wallets that people choose to use on Arbitrum include Metamask, Ledger Nano X, and SafePal S1. +You can use many [Web3 wallets](https://www.alchemy.com/web3-wallets-overview) on Arbitrum. As Optimism continues to grow, it supports many of the most popular wallets. Some wallets that people choose to use on Arbitrum include Metamask, Ledger Nano X, and SafePal S1. ## What does Arbitrum use for gas? -Arbitrum uses ETH tokens for gas. Compared to Ethereum, [Arbitrum typically has lower gas fees](https://www.alchemy.com/overviews/arbitrum-statistics) because it uses optimistic rollups to process transactions off-chain and then submit a single bundle of transactions to Ethereum’s mainnet. +Arbitrum uses ETH tokens for gas. Compared to Ethereum, [Arbitrum typically has lower gas fees](https://www.alchemy.com/overviews/arbitrum-statistics) because it uses optimistic rollups to process transactions offchain and then submit a single bundle of transactions to Ethereum’s mainnet. ## What projects are on Arbitrum? @@ -64,17 +64,17 @@ Some of the most popular dApps on Arbitrum include Aave, 1inch Network, and Year ## How do you withdraw ETH from Arbitrum? -Withdrawing ETH from Arbitrum takes three easy steps: just go to The [Arbitrum Bridge](https://bridge.arbitrum.io/), enter the amount you would like to remove from the network, and click “Withdraw”. +Withdrawing ETH from Arbitrum takes three steps: go to the [Arbitrum Bridge](https://bridge.arbitrum.io/), enter the amount you would like to remove from the network, and click “Withdraw”. ## What API does Arbitrum use? -Arbitrum uses the JSON-RPC API standard. The Arbitrum JSON-RPC API serves as the backbone for the Arbitrum network and powers any blockchain interaction. In aggregate, this API suite allows users to read block/transaction data, query chain information, execute smart contracts, and store data on-chain. Developers interact with Arbitrum’s base JSON-RPC APIs to communicate with its decentralized network of nodes. +Arbitrum uses the JSON-RPC API standard. The Arbitrum JSON-RPC API serves as the backbone for the Arbitrum network and powers any blockchain interaction. This API suite allows you to read block/transaction data, query chain information, execute smart contracts, and store data onchain. You interact with Arbitrum’s base JSON-RPC APIs to communicate with its decentralized network of nodes. ## What is an Arbitrum API key? -When accessing the Arbitrum network via a node provider, API services like Alchemy require an API key, which allows developers to monitor personal apps and access usage metrics. +When accessing the Arbitrum network via a node provider, API services like Alchemy require an API key, which allows you to monitor your apps and access usage metrics. -For the best development experience, we recommend that you [sign up for a free API key](https://www.alchemy.com/layer2/arbitrum)! With a dedicated API key, Arbitrum developers can: +For the best development experience, we recommend that you [sign up for a free API key](https://www.alchemy.com/layer2/arbitrum). With a dedicated API key, you can: * access higher request throughput and increase concurrent requests * query enhanced APIs, gain access to free archive data, logs, and API abstractions @@ -82,11 +82,11 @@ For the best development experience, we recommend that you [sign up for a free A ## Which libraries support Arbitrum? -Three libraries support Polygon: Web3.js, and Ethers. Of these three, Alchemy is an improvement over Web3 and Ethers libraries, providing enhanced API calls, upgraded WebSockets, and many other benefits. +Popular libraries supporting Arbitrum include Web3.js and Ethers. The Alchemy SDK is an improvement over Web3 and Ethers libraries, providing enhanced API calls, upgraded WebSocket support, and many other benefits. ## What programming languages work with Arbitrum? -Many programming languages work with Arbitrum, including Solidity, Vyper, and Flint. Basically, Arbitrum works with all EVM programming languages. Any code that can run on Ethereum can also run on Arbitrum. +Many programming languages work with Arbitrum, including Solidity, Vyper, and Flint. Arbitrum works with all EVM programming languages. Any code that can run on Ethereum can also run on Arbitrum. ## What methods does Alchemy support for the Arbitrum API? @@ -94,4 +94,4 @@ You can find the list of all the methods Alchemy supports for the Arbitrum API o ## My question isn't here, where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/arbitrum/arbitrum-api-quickstart.mdx b/content/api-reference/arbitrum/arbitrum-api-quickstart.mdx index 3c0cc9e65..6dc10ac68 100644 --- a/content/api-reference/arbitrum/arbitrum-api-quickstart.mdx +++ b/content/api-reference/arbitrum/arbitrum-api-quickstart.mdx @@ -14,7 +14,7 @@ Arbitrum is a Layer 2 scaling solution for Ethereum that leverages optimistic ro The Arbitrum API facilitates interaction with the Arbitrum network through a collection of JSON-RPC methods. Given its compatibility with the Ethereum ecosystem, developers familiar with Ethereum's JSON-RPC APIs will find working with Arbitrum both intuitive and straightforward. -## Send Your First Request on Alchemy +## Send your first request on Alchemy Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create an Arbitrum client connected to Alchemy and fetch the latest block number! @@ -28,7 +28,7 @@ Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create an ``` -## Create Client Connected to Alchemy +## Create a client connected to Alchemy ```js @@ -44,7 +44,7 @@ const client = createPublicClient({ Now that you've created a client connected to Alchemy, you can continue with some basics: -## Get Latest Block Number +## Get the latest block number ```js @@ -53,7 +53,7 @@ console.log("Current block number:", blockNumber); ``` -## Get an Address Balance +## Get an address balance ```js @@ -62,7 +62,7 @@ console.log("Balance (ETH):", Number(balance) / 1e18); ``` -## Read Block Data +## Read block data ```js @@ -73,7 +73,7 @@ console.log(block); ``` -## Fetch a Transaction by Hash +## Fetch a transaction by hash ```js @@ -82,7 +82,7 @@ console.log(tx); ``` -## Fetch Transaction Receipt +## Fetch a transaction receipt ```js diff --git a/content/api-reference/arc/arc-api-faq.mdx b/content/api-reference/arc/arc-api-faq.mdx index fd21bff36..1638a68d1 100644 --- a/content/api-reference/arc/arc-api-faq.mdx +++ b/content/api-reference/arc/arc-api-faq.mdx @@ -12,22 +12,22 @@ Arc is an open Layer 1 blockchain by Circle, purpose-built for stablecoin financ Check out our [Arc API Quickstart guide](./arc-api-quickstart) to get started building on Arc. ## What is the Arc API? -The Arc API allows developers to interface with the Arc network. With this API, developers can execute transactions, query on-chain data, and interact with the Arc network, relying on a JSON-RPC standard. +The Arc API allows you to interface with the Arc network. With this API, you can execute transactions, query onchain data, and interact with the Arc network, relying on a JSON-RPC standard. ## Is Arc EVM compatible? Yes, Arc is EVM compatible. ## What API does Arc use? -Arc uses the JSON-RPC API standard. This API is crucial for any blockchain interaction on the Arc network, allowing users to read block/transaction data, query chain information, execute smart contracts, and store data on-chain. +Arc uses the JSON-RPC API standard. This API is crucial for any blockchain interaction on the Arc network, allowing you to read block/transaction data, query chain information, execute smart contracts, and store data onchain. ## What methods are supported on Arc? Arc supports standard Ethereum JSON-RPC methods. Some chain-specific methods may vary. Please check the Arc API endpoints documentation for a complete list. ## What is a Arc API key? -When accessing the Arc network via a node provider like Alchemy, Arc developers use an API key to send transactions and retrieve data from the network. For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup)! +When accessing the Arc network via a node provider like Alchemy, you use an API key to send transactions and retrieve data from the network. For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup). ## Which libraries support Arc? Common Ethereum libraries like [ethers.js](https://docs.ethers.org/v5/) should be compatible with Arc, given its EVM nature. ## My question isn’t here, where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/arc/arc-api-quickstart.mdx b/content/api-reference/arc/arc-api-quickstart.mdx index 2f1949c9e..076bd8ad4 100644 --- a/content/api-reference/arc/arc-api-quickstart.mdx +++ b/content/api-reference/arc/arc-api-quickstart.mdx @@ -15,9 +15,9 @@ Arc is an open Layer 1 blockchain by Circle, purpose-built for stablecoin financ The Arc API allows interaction with the Arc network through a set of JSON-RPC methods. Its design is familiar to developers who have worked with Ethereum's JSON-RPC APIs, making it intuitive and straightforward to use. -## Getting Started Instructions +## Getting started -### 1. Choose a Package Manager (npm or yarn) +### 1. Choose a package manager (npm or yarn) Select a package manager to manage your project's dependencies. Choose between `npm` and `yarn` based on your preference or project requirements. @@ -33,7 +33,7 @@ Select a package manager to manage your project's dependencies. Choose between ` ``` -### 2. Set Up Your Project +### 2. Set up your project Open your terminal and execute the following commands to create and initialize your project: @@ -53,7 +53,7 @@ Open your terminal and execute the following commands to create and initialize y This creates a new directory named `arc-api-quickstart` and initializes a Node.js project within it. -### 3. Make Your First Request +### 3. Make your first request Install Axios, a popular HTTP client, to make API requests: @@ -92,9 +92,9 @@ Create an `index.js` file in your project directory and paste the following code ``` -Remember to replace `your-api-key` with your actual Alchemy API key that you can get from your [Alchemy dashboard](https://dashboard.alchemy.com/signup). +Replace `your-api-key` with your actual Alchemy API key that you can get from the [Alchemy Dashboard](https://dashboard.alchemy.com/signup). -### 4. Run Your Script +### 4. Run your script Execute your script to make a request to the Arc network: @@ -112,6 +112,6 @@ You should see the latest block information from Arc's network outputted to your ``` -## Next Steps +## Next steps -Congratulations! You've made your first request to the Arc network. You can now explore the various JSON-RPC methods available on Arc and start building your dApps on this innovative platform. +You've made your first request to the Arc network. You can now explore the various JSON-RPC methods available on Arc and start building your dApps on this platform. diff --git a/content/api-reference/astar/astar-api-faq.mdx b/content/api-reference/astar/astar-api-faq.mdx index a87e77003..140c8f02f 100644 --- a/content/api-reference/astar/astar-api-faq.mdx +++ b/content/api-reference/astar/astar-api-faq.mdx @@ -9,11 +9,11 @@ slug: reference/astar-api-faq Astar is a parachain that connects the Polkadot ecosystem to all major Layer-1 blockchains, including Ethereum, Acala, and eventually Cosmos. -Astar allows developers to build dapps fast, cheap dapps by offering high TPS, low transaction costs, and faster finality. By being compatible with Polkadot, it also enables blockchain networks, like Ethereum and Bitcoin, to operate together seamlessly without having to use a centralized exchange. +Astar allows you to build dApps fast and cheap by offering high TPS, low transaction costs, and faster finality. By being compatible with Polkadot, it also enables blockchain networks, like Ethereum and Bitcoin, to operate together seamlessly without having to use a centralized exchange. ## What is the Astar API? -The Astar API allows applications to connect to an Astar node that is part of the Astar network. Developers can interact with on-chain data and send different types of transactions to the network by utilizing the endpoints provided by the API. The API follows a JSON-RPC standard. JSON-RPC is a stateless, lightweight, remote procedure call (RPC) protocol encoded in JSON. +The Astar API allows applications to connect to an Astar node that is part of the Astar network. You can interact with onchain data and send different types of transactions to the network by utilizing the endpoints provided by the API. The API follows a JSON-RPC standard. JSON-RPC is a stateless, lightweight, remote procedure call (RPC) protocol encoded in JSON. ## How can I get started using the Astart API? @@ -27,7 +27,7 @@ In other words, parachains are project-specific blockchains that run parallel to ## Is Astar EVM compatible? -Yes! Astar allows developers to build dapps using EVM-compatible smart contracts. This means you can make full use of Ethereum developer tooling, libraries, and Solidity to build on Astar. +Yes! Astar allows you to build dApps using EVM-compatible smart contracts. This means you can make full use of Ethereum developer tooling, libraries, and Solidity to build on Astar. ## How do I add Astar to MetaMask? @@ -59,7 +59,7 @@ For bridging, use the [Arthswap Bridge](https://cbridge.celer.network/1/10/DF). ## What wallets can be used with Astar? -Since Astar is EVM-compatible, developers can use many wallets on it. Some of the most popular wallets include Metamask, Ledger Nano X, and SafePal S1. We give details on many of these wallets in our [Web3 wallet overview](https://www.alchemy.com/web3-wallets-overview). +Since Astar is EVM-compatible, you can use many wallets on it. Some of the most popular wallets include Metamask, Ledger Nano X, and SafePal S1. We give details on many of these wallets in our [Web3 wallet overview](https://www.alchemy.com/web3-wallets-overview). ## What does Astar use for gas? @@ -67,7 +67,7 @@ Astar uses the ASTR token for gas. Based on current market prices, developing on ## What projects are on Astar? -[Arthswap](https://app.arthswap.org/#/swap) is one of the most popular dapps on Astar that facilitates swapping, staking, and bridging. +[Arthswap](https://app.arthswap.org/#/swap) is one of the most popular dApps on Astar that facilitates swapping, staking, and bridging. Currently, there is over 500k people in the Astar community and $200 million has already been locked into the network. @@ -77,17 +77,17 @@ To withdraw ETH from Astar, use the [Arthswap Bridge](https://cbridge.celer.netw ## What API does Astar use? -Astar is compatible with the JSON-RPC API standard. The JSON-RPC API has the ability to power any blockchain interaction on Astar. In aggregate, this API suite allows users to read block/transaction data, query chain information, execute smart contracts, store data on-chain, etc. Developers and consumers alike interact with Astar’s base JSON-RPC APIs to communicate with its decentralized network of nodes. +Astar is compatible with the JSON-RPC API standard. The JSON-RPC API powers any blockchain interaction on Astar. This API suite allows you to read block/transaction data, query chain information, execute smart contracts, store data onchain, etc. You interact with Astar’s base JSON-RPC APIs to communicate with its decentralized network of nodes. ## What is an Astar API key? -When accessing the Astar network via a node provider, API services like Alchemy require an API key, which allows developers to monitor personal apps and access usage metrics. +When accessing the Astar network via a node provider, API services like Alchemy require an API key, which allows you to monitor your apps and access usage metrics. While many development environments have a set of default shared API keys, they are often throttled during periods of high usage leading to slower response times and a higher likelihood of request failures. -For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup)! +For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup). -With a dedicated API key, developers are able to: +With a dedicated API key, you can: * access **higher request throughput** and **increased concurrent requests** * query [Data APIs](/docs/reference/data-overview), gaining access to free archive data, logs, and higher-level API abstractions @@ -101,7 +101,7 @@ Alchemy offers Astar-compatible versions of: * [Supernode](/docs/alchemy-supernode) * [the Notify API](/docs/reference/webhooks-overview) -* [Alchemy Websockets](/docs/reference/subscription-api) +* [Alchemy WebSockets](/docs/reference/subscription-api) * [Usage Analytics](/docs/reference/compute-units) * [Composer](/docs/reference/api-overview) * [Explorer](/docs/reference/api-overview) @@ -117,4 +117,4 @@ You can find the list of all the methods Alchemy supports for the Astar API on t ## My question isn't here, where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/astar/astar-api-quickstart.mdx b/content/api-reference/astar/astar-api-quickstart.mdx index 507324924..d9287e6bd 100644 --- a/content/api-reference/astar/astar-api-quickstart.mdx +++ b/content/api-reference/astar/astar-api-quickstart.mdx @@ -14,7 +14,7 @@ Astar Network is a multi-chain smart contract platform that supports both EVM an The Astar API allows interaction with the Astar network through a set of JSON-RPC methods. Its design is familiar to developers who have worked with Ethereum's JSON-RPC APIs, making it intuitive and straightforward to use. -## Send Your First Request on Alchemy +## Send your first request on Alchemy Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create an Astar client connected to Alchemy and fetch the latest block number! @@ -28,7 +28,7 @@ Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create an ``` -## Create Client Connected to Alchemy +## Create a client connected to Alchemy ```js @@ -44,7 +44,7 @@ const client = createPublicClient({ Now that you've created a client connected to Alchemy, you can continue with some basics: -## Get Latest Block Number +## Get the latest block number ```js @@ -53,7 +53,7 @@ console.log("Current block number:", blockNumber); ``` -## Get an Address Balance +## Get an address balance ```js @@ -62,7 +62,7 @@ console.log("Balance (ASTR):", Number(balance) / 1e18); ``` -## Read Block Data +## Read block data ```js @@ -73,7 +73,7 @@ console.log(block); ``` -## Fetch a Transaction by Hash +## Fetch a transaction by hash ```js @@ -82,7 +82,7 @@ console.log(tx); ``` -## Fetch Transaction Receipt +## Fetch a transaction receipt ```js diff --git a/content/api-reference/avalanche-p/avalanche-p-api-faq.mdx b/content/api-reference/avalanche-p/avalanche-p-api-faq.mdx index af746ca62..cdc5458ef 100644 --- a/content/api-reference/avalanche-p/avalanche-p-api-faq.mdx +++ b/content/api-reference/avalanche-p/avalanche-p-api-faq.mdx @@ -49,4 +49,4 @@ You can find the list of supported Avalanche P-Chain methods on the [Avalanche P ## My question isn't here, where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/avalanche-p/avalanche-p-api-quickstart.mdx b/content/api-reference/avalanche-p/avalanche-p-api-quickstart.mdx index d5a078b07..8c62dc3b3 100644 --- a/content/api-reference/avalanche-p/avalanche-p-api-quickstart.mdx +++ b/content/api-reference/avalanche-p/avalanche-p-api-quickstart.mdx @@ -12,11 +12,11 @@ slug: reference/avalanche-p-api-quickstart The Avalanche Platform Chain (P-Chain) is the metadata chain on Avalanche that coordinates validators, manages staking, and handles creation of subnets and blockchains. Unlike the Avalanche C-Chain (EVM), the Avalanche P-Chain uses the `platform.*` JSON-RPC API for validator set management, delegations, and subnet operations. -**The Avalanche P-Chain is now live on both Mainnet and Fuji.** Use the same Alchemy base URLs as Avalanche C-Chain and append `/ext/bc/P` after your API key in the path. +**The Avalanche P-Chain is now live on both mainnet and Fuji.** Use the same Alchemy base URLs as Avalanche C-Chain and append `/ext/bc/P` after your API key in the path. -## Getting Started Instructions +## Getting started -### 1. Choose a Package Manager (npm or yarn) +### 1. Choose a package manager (npm or yarn) Select a package manager to manage your project's dependencies. The choice between `npm` and `yarn` depends on your preference or project requirements. @@ -24,7 +24,7 @@ Select a package manager to manage your project's dependencies. The choice betwe | --- | ---- | | Follow the [npm documentation](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm). | Refer to [yarn's installation guide](https://classic.yarnpkg.com/lang/en/docs/install). | -### 2. Set Up Your Project +### 2. Set up your project Open your terminal and run: @@ -44,7 +44,7 @@ Open your terminal and run: This creates a new directory and initializes a Node.js project. -### 3. Make Your First Request +### 3. Make your first request Create an `index.js` file in your project directory. The following example uses native `fetch` (Node.js 18+), so no extra dependencies are needed. Replace `YOUR_ALCHEMY_API_KEY` with your Alchemy API key. @@ -92,7 +92,7 @@ Run the script: You should see the current P-Chain height in the console (e.g. `P-Chain height: 35000000`). -## Send Your First Request on Alchemy (curl) +## Send your first request on Alchemy (curl) You can also call the API with `curl` from the terminal. Example for **Mainnet** (`platform.getHeight`): @@ -114,7 +114,7 @@ curl -X POST https://avax-fuji.g.alchemy.com/v2/YOUR_ALCHEMY_API_KEY/ext/bc/P \ ``` -## Get Current Validators +## Get current validators ```bash @@ -134,7 +134,7 @@ curl -X POST https://avax-mainnet.g.alchemy.com/v2/YOUR_ALCHEMY_API_KEY/ext/bc/P ``` -## Get Min Stake +## Get min stake ```bash @@ -144,7 +144,7 @@ curl -X POST https://avax-mainnet.g.alchemy.com/v2/YOUR_ALCHEMY_API_KEY/ext/bc/P ``` -## Get Subnets +## Get subnets ```bash diff --git a/content/api-reference/avalanche/avalanche-api-faq.mdx b/content/api-reference/avalanche/avalanche-api-faq.mdx index 48b80e93c..4d8d56d91 100644 --- a/content/api-reference/avalanche/avalanche-api-faq.mdx +++ b/content/api-reference/avalanche/avalanche-api-faq.mdx @@ -27,7 +27,7 @@ Avalanche uses the JSON-RPC API standard for blockchain interactions. This is th ## What is an Avalanche API key? -When accessing the Avalanche network via a node provider like Alchemy, developers use an API key to send transactions and retrieve data from the network. +When accessing the Avalanche network via a node provider like Alchemy, you use an API key to send transactions and retrieve data from the network. For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup)! @@ -37,7 +37,7 @@ Given Avalanche's EVM compatibility, popular Ethereum libraries like ethers.js a ## What programming languages work with Avalanche? -Similar to Ethereum, Avalanche supports a range of programming languages for blockchain interaction and smart contract development, including Solidity for smart contracts, as well as JavaScript and TypeScript for dApp development and off-chain interactions. +Similar to Ethereum, Avalanche supports a range of programming languages for blockchain interaction and smart contract development, including Solidity for smart contracts, as well as JavaScript and TypeScript for dApp development and offchain interactions. ## What does Avalanche use for gas? @@ -49,4 +49,4 @@ You can find the list of all the methods Alchemy supports for the Avalanche API ## My question isn't here, where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/avalanche/avalanche-api-quickstart.mdx b/content/api-reference/avalanche/avalanche-api-quickstart.mdx index 90243eaff..754e4d3ec 100644 --- a/content/api-reference/avalanche/avalanche-api-quickstart.mdx +++ b/content/api-reference/avalanche/avalanche-api-quickstart.mdx @@ -14,7 +14,7 @@ Avalanche is an EVM-compatible blockchain known for its high throughput and low The Avalanche C-Chain API facilitates interaction with the Avalanche network through a collection of JSON-RPC methods. Given its compatibility with the Ethereum ecosystem, developers familiar with Ethereum's JSON-RPC APIs will find working with Avalanche both intuitive and straightforward. -## Send Your First Request on Alchemy +## Send your first request on Alchemy Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create an Avalanche client connected to Alchemy and fetch the latest block number! @@ -28,7 +28,7 @@ Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create an ``` -## Create Client Connected to Alchemy +## Create a client connected to Alchemy ```js @@ -44,7 +44,7 @@ const client = createPublicClient({ Now that you've created a client connected to Alchemy, you can continue with some basics: -## Get Latest Block Number +## Get the latest block number ```js @@ -53,7 +53,7 @@ console.log("Current block number:", blockNumber); ``` -## Get an Address Balance +## Get an address balance ```js @@ -62,7 +62,7 @@ console.log("Balance (AVAX):", Number(balance) / 1e18); ``` -## Read Block Data +## Read block data ```js @@ -73,7 +73,7 @@ console.log(block); ``` -## Fetch a Transaction by Hash +## Fetch a transaction by hash ```js @@ -82,7 +82,7 @@ console.log(tx); ``` -## Fetch Transaction Receipt +## Fetch a transaction receipt ```js diff --git a/content/api-reference/base/base-api-faq.mdx b/content/api-reference/base/base-api-faq.mdx index 290279b92..f90b50e38 100644 --- a/content/api-reference/base/base-api-faq.mdx +++ b/content/api-reference/base/base-api-faq.mdx @@ -11,7 +11,7 @@ slug: reference/base-api-faq ## What is the Base API? -The Base API allows developers to interface with the Base mainnet and testnet nodes. With this API, developers can execute transactions, query on-chain data, and interact with the Base network, relying on a JSON-RPC standard. +The Base API allows developers to interface with the Base mainnet and testnet nodes. With this API, you can execute transactions, query onchain data, and interact with the Base network, relying on a JSON-RPC standard. ## How can I get started using the Base API? @@ -19,15 +19,15 @@ Explained in [Base API Quickstart](/docs/reference/base-api-quickstart) ## Is Base EVM compatible? -Absolutely. Base is built as an Ethereum L2, which means it confidently supports any Ethereum Virtual Machine (EVM) codebase. This allows developers to smoothly deploy and migrate assets and users from Ethereum L1 and other interoperable chains to Base. +Yes. Base is built as an Ethereum L2, which means it supports any Ethereum Virtual Machine (EVM) codebase. This allows you to deploy and migrate assets from Ethereum L1 and other interoperable chains to Base. ## What API does Base use? -Base utilizes the JSON-RPC API standard. This API is crucial for any blockchain interaction on the Base network, allowing users to read block/transaction data, query chain information, execute smart contracts, and store data on-chain. +Base utilizes the JSON-RPC API standard. This API is crucial for any blockchain interaction on the Base network, allowing you to read block/transaction data, query chain information, execute smart contracts, and store data onchain. ## What is a Base API key? -When accessing the Base network via a node provider like Alchemy, Base developers use an API key to send transactions and retrieve data from the network. +When accessing the Base network via a node provider like Alchemy, you use an API key to send transactions and retrieve data from the network. For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup)! @@ -37,7 +37,7 @@ Common Ethereum libraries like [ethers.js](https://docs.ethers.org/v5/) and [web ## What programming languages work with Base? -Languages that work with Ethereum, such as Javascript, Solidity, Typescript, and Shell, should also be compatible with Base. Solidity remains the primary choice for smart contract development, while Javascript is ideal for off-chain interactions. +Languages that work with Ethereum, such as JavaScript, Solidity, TypeScript, and Shell, should also be compatible with Base. Solidity remains the primary choice for smart contract development, while JavaScript is ideal for offchain interactions. ## What does Base use for gas? @@ -45,7 +45,7 @@ The primary currency for transaction fees and other network activities on Base i ## What testnet should I use for Base? -Developers should use the **Base Goerli** testnet for Base. This testnet provides an environment to deploy smart contracts, execute transactions, and test applications. ETH for Base Goerli can be obtained from the [Base Goerli Faucet](https://www.coinbase.com/developer-platform/products/faucet). +Use the **Base Goerli** testnet for Base. This testnet provides an environment to deploy smart contracts, execute transactions, and test applications. ETH for Base Goerli can be obtained from the [Base Goerli Faucet](https://www.coinbase.com/developer-platform/products/faucet). ## What methods does Alchemy support for the Base API? @@ -61,4 +61,4 @@ The Base Bridge facilitates the bridging of ETH between Ethereum and Base. To br ## My question isn't here, where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/base/base-api-quickstart.mdx b/content/api-reference/base/base-api-quickstart.mdx index a485d00a2..68ce8cba5 100644 --- a/content/api-reference/base/base-api-quickstart.mdx +++ b/content/api-reference/base/base-api-quickstart.mdx @@ -14,7 +14,7 @@ Base offers a secure, affordable, and developer-centric Ethereum L2 solution. De The Base API is a collection of JSON-RPC methods that enable developers to interact with the Base network. Notably, it shares the same set of JSON-RPC methods as Optimism. For those already acquainted with [Optimism's API](/docs/reference/optimism-api-endpoints), diving into Base will feel both familiar and effortless. -## Send Your First Request on Alchemy +## Send your first request on Alchemy Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a Base client connected to Alchemy and fetch the latest block number! @@ -28,7 +28,7 @@ Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a B ``` -## Create Client Connected to Alchemy +## Create a client connected to Alchemy ```js @@ -44,7 +44,7 @@ const client = createPublicClient({ Now that you've created a client connected to Alchemy, you can continue with some basics: -## Get Latest Block Number +## Get the latest block number ```js @@ -53,7 +53,7 @@ console.log("Current block number:", blockNumber); ``` -## Get an Address Balance +## Get an address balance ```js @@ -62,7 +62,7 @@ console.log("Balance (ETH):", Number(balance) / 1e18); ``` -## Read Block Data +## Read block data ```js @@ -73,7 +73,7 @@ console.log(block); ``` -## Fetch a Transaction by Hash +## Fetch a transaction by hash ```js @@ -82,7 +82,7 @@ console.log(tx); ``` -## Fetch Transaction Receipt +## Fetch a transaction receipt ```js diff --git a/content/api-reference/base/base-flashblocks-api-quickstart.mdx b/content/api-reference/base/base-flashblocks-api-quickstart.mdx index 0eb57cda0..7cb28b08a 100644 --- a/content/api-reference/base/base-flashblocks-api-quickstart.mdx +++ b/content/api-reference/base/base-flashblocks-api-quickstart.mdx @@ -20,7 +20,7 @@ Flashblocks is currently supported on both Base testnet and mainnet and can be | Base Sepolia | ✅ | | Base Mainnet | ✅ | -## Flashblocks-enabled API Endpoints +## Flashblocks-enabled API endpoints ### [eth\_getBlockByNumber](https://www.alchemy.com/docs/node/op-mainnet/op-mainnet-api-endpoints/eth-get-block-by-number) @@ -215,4 +215,4 @@ curl https://base-sepolia.g.alchemy.com/v2/ -X POST -H "Content-Ty } ``` -Also check out the [Official Base Flashblocks Docs](https://docs.base.org/base-chain/flashblocks/apps)! +For more details, see the [Official Base Flashblocks Docs](https://docs.base.org/base-chain/flashblocks/apps). diff --git a/content/api-reference/berachain/berachain-api-faq.mdx b/content/api-reference/berachain/berachain-api-faq.mdx index ab63dbca3..d81b0e09f 100644 --- a/content/api-reference/berachain/berachain-api-faq.mdx +++ b/content/api-reference/berachain/berachain-api-faq.mdx @@ -11,7 +11,7 @@ Berachain is an innovative blockchain platform designed to offer a secure, scala ## What is the Berachain API? -The Berachain API facilitates interaction with the Berachain network through a collection of JSON-RPC methods. It provides developers with tools to interact with the blockchain, enabling functionalities such as transactions, smart contract deployment, and data retrieval. +The Berachain API facilitates interaction with the Berachain network through a collection of JSON-RPC methods. It provides tools to interact with the blockchain, enabling functionalities such as transactions, smart contract deployment, and data retrieval. ## How can I get started using the Berachain API? @@ -19,7 +19,7 @@ Explained in [Berachain API Quickstart](/docs/reference/berachain-api-quickstart ## Is Berachain EVM compatible? -Yes, Berachain is fully compatible with the Ethereum Virtual Machine (EVM). This compatibility allows Ethereum developers to port their projects to Berachain with minimal changes, benefiting from the chain's high performance and low transaction fees. +Yes, Berachain is fully compatible with the Ethereum Virtual Machine (EVM). This compatibility allows you to port your projects to Berachain with minimal changes, benefiting from the chain's high performance and low transaction fees. ## What API does Berachain use? @@ -27,7 +27,7 @@ Berachain uses the JSON-RPC API standard for blockchain interactions. This is th ## What is a Berachain API key? -When accessing the Berachain network via a node provider like Alchemy, developers use an API key to send transactions and retrieve data from the network. +When accessing the Berachain network via a node provider like Alchemy, you use an API key to send transactions and retrieve data from the network. For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup)! @@ -37,7 +37,7 @@ Given Berachain's EVM compatibility, popular Ethereum libraries like ethers.js a ## What programming languages work with Berachain? -Similar to Ethereum, Berachain supports a range of programming languages for blockchain interaction and smart contract development, including Solidity for smart contracts, as well as JavaScript and TypeScript for dApp development and off-chain interactions. +Similar to Ethereum, Berachain supports a range of programming languages for blockchain interaction and smart contract development, including Solidity for smart contracts, as well as JavaScript and TypeScript for dApp development and offchain interactions. ## What does Berachain use for gas? @@ -49,4 +49,4 @@ You can find the list of all the methods Alchemy supports for the Berachain API ## My question isn't here, where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/berachain/berachain-api-quickstart.mdx b/content/api-reference/berachain/berachain-api-quickstart.mdx index 8bd1dbabe..0d93dd7f9 100644 --- a/content/api-reference/berachain/berachain-api-quickstart.mdx +++ b/content/api-reference/berachain/berachain-api-quickstart.mdx @@ -14,7 +14,7 @@ Berachain is an EVM-compatible blockchain designed to provide high performance, The Berachain API facilitates interaction with the Berachain network through a collection of JSON-RPC methods. Given its compatibility with the Ethereum ecosystem, developers familiar with Ethereum's JSON-RPC APIs will find working with Berachain both intuitive and straightforward. -## Send Your First Request on Alchemy +## Send your first request on Alchemy Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a Berachain client connected to Alchemy and fetch the latest block number! @@ -28,7 +28,7 @@ Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a B ``` -## Create Client Connected to Alchemy +## Create a client connected to Alchemy ```js @@ -44,7 +44,7 @@ const client = createPublicClient({ Now that you've created a client connected to Alchemy, you can continue with some basics: -## Get Latest Block Number +## Get the latest block number ```js @@ -53,7 +53,7 @@ console.log("Current block number:", blockNumber); ``` -## Get an Address Balance +## Get an address balance ```js @@ -62,7 +62,7 @@ console.log("Balance (BERA):", Number(balance) / 1e18); ``` -## Read Block Data +## Read block data ```js @@ -73,7 +73,7 @@ console.log(block); ``` -## Fetch a Transaction by Hash +## Fetch a transaction by hash ```js @@ -82,7 +82,7 @@ console.log(tx); ``` -## Fetch Transaction Receipt +## Fetch a transaction receipt ```js diff --git a/content/api-reference/bitcoin/bitcoin-api-faq.mdx b/content/api-reference/bitcoin/bitcoin-api-faq.mdx index 6a4c9ccf5..2c1b42212 100644 --- a/content/api-reference/bitcoin/bitcoin-api-faq.mdx +++ b/content/api-reference/bitcoin/bitcoin-api-faq.mdx @@ -6,11 +6,11 @@ slug: "reference/bitcoin-api-faq" ## What is Bitcoin? -Bitcoin is the first decentralized, peer-to-peer digital currency. It allows users to send and receive payments without the need for intermediaries like banks. Bitcoin uses a UTXO (Unspent Transaction Output) model and is secured by proof-of-work mining. +Bitcoin is the first decentralized, peer-to-peer digital currency. It allows you to send and receive payments without the need for intermediaries like banks. Bitcoin uses a UTXO (Unspent Transaction Output) model and is secured by proof-of-work mining. ## What is the Bitcoin API? -The Bitcoin API allows developers to interact with the Bitcoin network using JSON-RPC methods. Through the API, developers can retrieve data about blocks, transactions, and the mempool, as well as broadcast new transactions to the network. +The Bitcoin API allows you to interact with the Bitcoin network using JSON-RPC methods. Through the API, you can retrieve data about blocks, transactions, and the mempool, as well as broadcast new transactions to the network. ## How can I get started using the Bitcoin API? @@ -26,7 +26,7 @@ Bitcoin Core implements a standard JSON-RPC interface for querying blockchain da ## What is a Bitcoin API key? -When accessing the Bitcoin Chain network via a node provider like Alchemy, developers use an API key to send transactions and retrieve data from the network. +When accessing the Bitcoin Chain network via a node provider like Alchemy, you use an API key to send transactions and retrieve data from the network. ## Which libraries can I use with the Bitcoin API? @@ -46,4 +46,4 @@ You can find a full list of supported JSON-RPC methods on the [Bitcoin API Endpo ## My question isn't listed here — where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/bitcoin/bitcoin-api-quickstart.mdx b/content/api-reference/bitcoin/bitcoin-api-quickstart.mdx index 0426f5dc4..d782c4e10 100644 --- a/content/api-reference/bitcoin/bitcoin-api-quickstart.mdx +++ b/content/api-reference/bitcoin/bitcoin-api-quickstart.mdx @@ -6,7 +6,7 @@ slug: "reference/bitcoin-api-quickstart" # Introduction -The Bitcoin API gives developers access to interact with the Bitcoin blockchain through a standard set of JSON-RPC methods. With this API, you can retrieve block and transaction data, inspect the mempool, broadcast transactions, and more. +The Bitcoin API gives you access to interact with the Bitcoin blockchain through a standard set of JSON-RPC methods. With this API, you can retrieve block and transaction data, inspect the mempool, broadcast transactions, and more. Unlike EVM chains, Bitcoin uses a UTXO-based model and exposes its functionality via the JSON-RPC protocol. This quickstart will help you make your first request. @@ -27,19 +27,19 @@ If you’ve worked with Ethereum or other JSON-RPC-compatible chains, the struct *** -## Getting Started Instructions +## Getting started -### 1. Choose a Package Manager (npm or yarn) +### 1. Choose a package manager (npm or yarn) -Your first step involves selecting a package manager, which will be crucial for managing your project's dependencies. The choice between `npm` and `yarn` depends on your personal preference or project requirements. +Select a package manager to manage your project's dependencies. The choice between `npm` and `yarn` depends on your preference or project requirements. | npm | yarn | | ------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | | Begin with `npm` by following the [npm documentation](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm). | For `yarn`, refer to [yarn's installation guide](https://classic.yarnpkg.com/lang/en/docs/install). | -### 2. Set Up Your Project +### 2. Set up your project -To kickstart your project, open your terminal and execute the following commands: +Open your terminal and run the following commands: ```text npm @@ -57,7 +57,7 @@ To kickstart your project, open your terminal and execute the following commands This creates a new directory named `bitcoin-api-quickstart` and initializes a Node.js project within it. -### 3. Make Your First Request +### 3. Make your first request Install Axios, a popular HTTP client, to make API requests: @@ -95,9 +95,9 @@ Create an `index.js` file in your project directory and paste the following code ``` -Remember to replace `yourAPIKey` with your actual Alchemy API key that you can get from your [Alchemy dashboard](https://dashboard.alchemy.com/signup). +Replace `yourAPIKey` with your actual Alchemy API key that you can get from the [Alchemy Dashboard](https://dashboard.alchemy.com/signup). -### 4. Run Your Script +### 4. Run your script To execute your script and make a request to the Bitcoin App, run: @@ -113,6 +113,6 @@ You should see the current block number on Bitcoin App (in hexadecimal format) o Current block height: 0x6d68e ``` -## Next Steps +## Next steps -Well done! You've just made your first request to the Bitcoin App API. With this foundation, you can dive deeper into the array of [JSON-RPC methods available on Bitcoin App](/docs/bitcoin/bitcoin-api-overview) and start building your dApps on it! +You've made your first request to the Bitcoin App API. With this foundation, you can dive deeper into the [JSON-RPC methods available on Bitcoin App](/docs/bitcoin/bitcoin-api-overview) and start building your dApps on it! diff --git a/content/api-reference/blast/blast-api-faq.mdx b/content/api-reference/blast/blast-api-faq.mdx index 521948d67..d1cea54c5 100644 --- a/content/api-reference/blast/blast-api-faq.mdx +++ b/content/api-reference/blast/blast-api-faq.mdx @@ -11,7 +11,7 @@ Blast Chain is a high-performance blockchain designed to deliver rapid transacti ## What is the Blast Chain API? -The Blast Chain API facilitates interaction with the Blast Chain network through a collection of JSON-RPC methods. It provides developers with tools to interact with the blockchain, enabling functionalities such as transactions, smart contract deployment, and data retrieval. +The Blast Chain API facilitates interaction with the Blast Chain network through a collection of JSON-RPC methods. It provides tools to interact with the blockchain, enabling functionalities such as transactions, smart contract deployment, and data retrieval. ## How can I get started using the Blast Chain API? @@ -19,7 +19,7 @@ Explained in [Blast Chain API Quickstart](/docs/reference/blast-api-quickstart). ## Is Blast Chain EVM compatible? -Yes, Blast Chain is fully compatible with the Ethereum Virtual Machine (EVM). This compatibility allows Ethereum developers to port their projects to Blast Chain with minimal changes, benefiting from the chain's high throughput and low transaction fees. +Yes, Blast Chain is fully compatible with the Ethereum Virtual Machine (EVM). This compatibility allows you to port your projects to Blast Chain with minimal changes, benefiting from the chain's high throughput and low transaction fees. ## What API does Blast Chain use? @@ -27,7 +27,7 @@ Blast Chain uses the JSON-RPC API standard for blockchain interactions. This is ## What is a Blast Chain API key? -When accessing the Blast Chain network via a node provider like Alchemy, developers use an API key to send transactions and retrieve data from the network. +When accessing the Blast Chain network via a node provider like Alchemy, you use an API key to send transactions and retrieve data from the network. For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup)! @@ -37,7 +37,7 @@ Given Blast Chain's EVM compatibility, popular Ethereum libraries like ethers.js ## What programming languages work with Blast Chain? -Similar to Ethereum, Blast Chain supports a range of programming languages for blockchain interaction and smart contract development, including Solidity for smart contracts, as well as JavaScript and TypeScript for dApp development and off-chain interactions. +Similar to Ethereum, Blast Chain supports a range of programming languages for blockchain interaction and smart contract development, including Solidity for smart contracts, as well as JavaScript and TypeScript for dApp development and offchain interactions. ## What does Blast Chain use for gas? @@ -49,4 +49,4 @@ You can find the list of all the methods Alchemy supports for the Blast Chain AP ## My question isn't here, where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/blast/blast-api-quickstart.mdx b/content/api-reference/blast/blast-api-quickstart.mdx index adea26a86..8707ac25e 100644 --- a/content/api-reference/blast/blast-api-quickstart.mdx +++ b/content/api-reference/blast/blast-api-quickstart.mdx @@ -14,7 +14,7 @@ Blast is an EVM-compatible blockchain designed to provide high performance and s The Blast Chain API facilitates interaction with the Blast network through a collection of JSON-RPC methods. Given its compatibility with the Ethereum ecosystem, developers familiar with Ethereum's JSON-RPC APIs will find working with Blast both intuitive and straightforward. -## Send Your First Request on Alchemy +## Send your first request on Alchemy Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a Blast client connected to Alchemy and fetch the latest block number! @@ -28,7 +28,7 @@ Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a B ``` -## Create Client Connected to Alchemy +## Create a client connected to Alchemy ```js @@ -44,7 +44,7 @@ const client = createPublicClient({ Now that you've created a client connected to Alchemy, you can continue with some basics: -## Get Latest Block Number +## Get the latest block number ```js @@ -53,7 +53,7 @@ console.log("Current block number:", blockNumber); ``` -## Get an Address Balance +## Get an address balance ```js @@ -62,7 +62,7 @@ console.log("Balance (ETH):", Number(balance) / 1e18); ``` -## Read Block Data +## Read block data ```js @@ -73,7 +73,7 @@ console.log(block); ``` -## Fetch a Transaction by Hash +## Fetch a transaction by hash ```js @@ -82,7 +82,7 @@ console.log(tx); ``` -## Fetch Transaction Receipt +## Fetch a transaction receipt ```js diff --git a/content/api-reference/bnb-smart-chain/bnb-smart-chain-api-quickstart.mdx b/content/api-reference/bnb-smart-chain/bnb-smart-chain-api-quickstart.mdx index 904630373..97b32644d 100644 --- a/content/api-reference/bnb-smart-chain/bnb-smart-chain-api-quickstart.mdx +++ b/content/api-reference/bnb-smart-chain/bnb-smart-chain-api-quickstart.mdx @@ -10,11 +10,11 @@ slug: reference/bnb-smart-chain-api-quickstart get started today. -The BNB Smart Chain (BSC) is a high-performance blockchain developed by Binance, designed to offer developers low transaction costs and fast execution times. It is Ethereum Virtual Machine (EVM) compatible which enables developers to deploy Ethereum-based applications seamlessly on it! +BNB Smart Chain (BSC) is a high-performance blockchain developed by Binance, designed to offer low transaction costs and fast execution times. It is Ethereum Virtual Machine (EVM) compatible, which lets you deploy Ethereum-based applications seamlessly. -The BNB Smart Chain API facilitates interaction with the BSC network through a collection of JSON-RPC methods. Given its compatibility with the Ethereum ecosystem, developers familiar with Ethereum's JSON-RPC APIs will find working with BSC both intuitive and straightforward. +The BNB Smart Chain API lets you interact with the BSC network through a collection of JSON-RPC methods. If you're familiar with Ethereum's JSON-RPC APIs, working with BSC is intuitive and straightforward. -## Send Your First Request on Alchemy +## Send your first request on Alchemy Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a BNB Smart Chain client connected to Alchemy and fetch the latest block number! @@ -28,7 +28,7 @@ Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a B ``` -## Create Client Connected to Alchemy +## Create a client connected to Alchemy ```js @@ -44,7 +44,7 @@ const client = createPublicClient({ Now that you've created a client connected to Alchemy, you can continue with some basics: -## Get Latest Block Number +## Get the latest block number ```js @@ -53,7 +53,7 @@ console.log("Current block number:", blockNumber); ``` -## Get an Address Balance +## Get an address balance ```js @@ -62,7 +62,7 @@ console.log("Balance (BNB):", Number(balance) / 1e18); ``` -## Read Block Data +## Read block data ```js @@ -73,7 +73,7 @@ console.log(block); ``` -## Fetch a Transaction by Hash +## Fetch a transaction by hash ```js @@ -82,7 +82,7 @@ console.log(tx); ``` -## Fetch Transaction Receipt +## Fetch a transaction receipt ```js diff --git a/content/api-reference/bnb-smart-chain/bnb-smart-chain-faq.mdx b/content/api-reference/bnb-smart-chain/bnb-smart-chain-faq.mdx index a92581ee2..45b606ff7 100644 --- a/content/api-reference/bnb-smart-chain/bnb-smart-chain-faq.mdx +++ b/content/api-reference/bnb-smart-chain/bnb-smart-chain-faq.mdx @@ -7,11 +7,11 @@ slug: reference/bnb-smart-chain-faq ## What is BNB Smart Chain (BSC)? -The BNB Smart Chain (BSC) is a high-performance blockchain developed by Binance, designed to offer developers low transaction costs and fast execution times. It is Ethereum Virtual Machine (EVM) compatible which enables developers to deploy Ethereum-based applications seamlessly on it! +BNB Smart Chain (BSC) is a high-performance blockchain developed by Binance, designed to offer low transaction costs and fast execution times. It is Ethereum Virtual Machine (EVM) compatible, which lets you deploy Ethereum-based applications seamlessly. ## What is the BNB Smart Chain API? -The BNB Smart Chain API facilitates interaction with the BSC network through a collection of JSON-RPC methods. Given its compatibility with the Ethereum ecosystem, developers familiar with Ethereum's JSON-RPC APIs will find working with BSC both intuitive and straightforward. +The BNB Smart Chain API lets you interact with the BSC network through a collection of JSON-RPC methods. If you're familiar with Ethereum's JSON-RPC APIs, working with BSC is intuitive and straightforward. ## How can I get started using the BSC API? @@ -19,7 +19,7 @@ Explained in [BNB Smart Chain Quickstart](/docs/reference/bnb-smart-chain-api-qu ## Is BSC EVM compatible? -Yes, BNB Smart Chain is fully compatible with the Ethereum Virtual Machine (EVM). This compatibility allows Ethereum developers to port their projects to BSC with minimal changes, taking advantage of the chain's high throughput and low transaction fees. +Yes, BNB Smart Chain is fully compatible with the Ethereum Virtual Machine (EVM). This compatibility lets you port your Ethereum projects to BSC with minimal changes, taking advantage of the chain's high throughput and low transaction fees. ## What API does BSC use? @@ -27,17 +27,17 @@ BNB Smart Chain uses the JSON-RPC API standard for blockchain interactions. This ## What is a BSC API key? -When accessing the BSC network via a node provider like Alchemy, BSC developers use an API key to send transactions and retrieve data from the network. +When accessing the BSC network via a node provider like Alchemy, you use an API key to send transactions and retrieve data from the network. -For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup)! +For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup). ## Which libraries support BSC? -Given BSC's EVM compatibility, popular Ethereum libraries like ethers.js and web3.js are fully compatible with BSC. This allows for seamless development and integration for those familiar with Ethereum's development ecosystem. +Given BSC's EVM compatibility, popular Ethereum libraries like ethers.js and web3.js are fully compatible with BSC. You can develop and integrate seamlessly if you're familiar with Ethereum's development ecosystem. ## What programming languages work with BSC? -Similar to Ethereum, BSC supports a range of programming languages for blockchain interaction and smart contract development, including Solidity for smart contracts, as well as JavaScript and TypeScript for dApp development and off-chain interactions. +Similar to Ethereum, BSC supports a range of programming languages for blockchain interaction and smart contract development, including Solidity for smart contracts, as well as JavaScript and TypeScript for dApp development and offchain interactions. ## What does BSC use for gas? @@ -49,4 +49,4 @@ You can find the list of all the methods Alchemy support for the BSC API on [BSC ## My question isn't here, where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/bob/bob-api-faq.mdx b/content/api-reference/bob/bob-api-faq.mdx index fc87304af..154bd6bcd 100644 --- a/content/api-reference/bob/bob-api-faq.mdx +++ b/content/api-reference/bob/bob-api-faq.mdx @@ -12,22 +12,22 @@ BOB (Build on Bitcoin) is a hybrid OP Stack Layer-2 that runs full-EVM apps whil Check out our [Bob API Quickstart guide](/docs/reference/bob-api-quickstart) to get started building on Bob. ## What is the Bob API? -The Bob API allows developers to interface with the Bob mainnet. With this API, developers can execute transactions, query on-chain data, and interact with the Bob network, relying on a JSON-RPC standard. +The Bob API lets you interface with the Bob mainnet. With this API, you can execute transactions, query onchain data, and interact with the Bob network using the JSON-RPC standard. ## Is Bob EVM compatible? Yes, Bob is EVM compatible. ## What API does Bob use? -Bob uses the JSON-RPC API standard. This API is crucial for any blockchain interaction on the Bob network, allowing users to read block/transaction data, query chain information, execute smart contracts, and store data on-chain. +Bob uses the JSON-RPC API standard. This API is essential for any blockchain interaction on the Bob network, allowing you to read block/transaction data, query chain information, execute smart contracts, and store data onchain. ## What methods are supported on Bob? BOB supports standard Ethereum JSON-RPC methods. Some chain-specific methods may vary. Please check the [BOB API Endpoints](/docs/chains#bob-apis) for a complete list. ## What is a Bob API key? -When accessing the Bob network via a node provider like Alchemy, Bob developers use an API key to send transactions and retrieve data from the network. For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup)! +When accessing the Bob network via a node provider like Alchemy, you use an API key to send transactions and retrieve data from the network. For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup). ## Which libraries support Bob? Common Ethereum libraries like [ethers.js](https://docs.ethers.org/v5/) should be compatible with Bob, given its EVM nature. ## My question isn’t here, where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/bob/bob-api-quickstart.mdx b/content/api-reference/bob/bob-api-quickstart.mdx index 2ccdff056..b60bf35ba 100644 --- a/content/api-reference/bob/bob-api-quickstart.mdx +++ b/content/api-reference/bob/bob-api-quickstart.mdx @@ -14,7 +14,7 @@ BOB (Build on Bitcoin) is a hybrid OP Stack Layer-2 that runs full-EVM apps whil The BOB API allows interaction with the BOB network through a set of JSON-RPC methods. Its design is familiar to developers who have worked with Ethereum's JSON-RPC APIs, making it intuitive and straightforward to use. -## Send Your First Request on Alchemy +## Send your first request on Alchemy Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a BOB client connected to Alchemy and fetch the latest block number! @@ -28,7 +28,7 @@ Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a B ``` -## Create Client Connected to Alchemy +## Create a client connected to Alchemy ```js @@ -44,7 +44,7 @@ const client = createPublicClient({ Now that you've created a client connected to Alchemy, you can continue with some basics: -## Get Latest Block Number +## Get the latest block number ```js @@ -53,7 +53,7 @@ console.log("Current block number:", blockNumber); ``` -## Get an Address Balance +## Get an address balance ```js @@ -62,7 +62,7 @@ console.log("Balance (ETH):", Number(balance) / 1e18); ``` -## Read Block Data +## Read block data ```js @@ -73,7 +73,7 @@ console.log(block); ``` -## Fetch a Transaction by Hash +## Fetch a transaction by hash ```js @@ -82,7 +82,7 @@ console.log(tx); ``` -## Fetch Transaction Receipt +## Fetch a transaction receipt ```js diff --git a/content/api-reference/botanix/botanix-api-faq.mdx b/content/api-reference/botanix/botanix-api-faq.mdx index 2dc9058fb..d860d82f0 100644 --- a/content/api-reference/botanix/botanix-api-faq.mdx +++ b/content/api-reference/botanix/botanix-api-faq.mdx @@ -7,7 +7,7 @@ slug: reference/botanix-api-faq ## What is Botanix? -Botanix is a Bitcoin-native, EVM-compatible Layer 2 that makes it easy to build and run smart contracts using Bitcoin as the native asset. +Botanix is a Bitcoin-native, EVM-compatible Layer 2 that lets you build and run smart contracts using Bitcoin as the native asset. ## How do I get started with Botanix? @@ -15,7 +15,7 @@ Check out our [Botanix API Quickstart guide](/docs/reference/botanix-api-quickst ## What is the Botanix API? -The Botanix API allows developers to interface with the Botanix mainnet and testnet nodes. With this API, developers can execute transactions, query on-chain data, and interact with the Botanix network, relying on a JSON-RPC standard. +The Botanix API lets you interface with the Botanix mainnet and testnet nodes. With this API, you can execute transactions, query onchain data, and interact with the Botanix network using the JSON-RPC standard. ## Is Botanix EVM compatible? @@ -23,13 +23,13 @@ Yes, Botanix is EVM compatible. ## What API does Botanix use? -Botanix utilizes the JSON-RPC API standard. This API is crucial for any blockchain interaction on the Botanix network, allowing users to read block/transaction data, query chain information, execute smart contracts, and store data on-chain. +Botanix uses the JSON-RPC API standard. This API is essential for any blockchain interaction on the Botanix network, allowing you to read block/transaction data, query chain information, execute smart contracts, and store data onchain. ## What is a Botanix API key? -When accessing the Botanix network via a node provider like Alchemy, Botanix developers use an API key to send transactions and retrieve data from the network. +When accessing the Botanix network via a node provider like Alchemy, you use an API key to send transactions and retrieve data from the network. -For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup)! +For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup). ## Which libraries support Botanix? @@ -37,7 +37,7 @@ Common Ethereum libraries like [ethers.js](https://docs.ethers.org/v5/) and [web ## What programming languages work with Botanix? -Languages that work with Ethereum, such as Javascript, Solidity, Typescript, and Shell, should also be compatible with Botanix. Solidity remains the primary choice for smart contract development, while Javascript is ideal for off-chain interactions. +Languages that work with Ethereum, such as JavaScript, Solidity, TypeScript, and Shell, should also be compatible with Botanix. Solidity remains the primary choice for smart contract development, while JavaScript is ideal for offchain interactions. ## What does Botanix use for gas? @@ -49,4 +49,4 @@ You can find the list of all the methods Alchemy supports for the Botanix API on ## My question isn't here, where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/botanix/botanix-api-quickstart.mdx b/content/api-reference/botanix/botanix-api-quickstart.mdx index 9d0e8ec6d..177f9b0a2 100644 --- a/content/api-reference/botanix/botanix-api-quickstart.mdx +++ b/content/api-reference/botanix/botanix-api-quickstart.mdx @@ -10,11 +10,11 @@ slug: reference/botanix-api-quickstart get started today. -Botanix is a Bitcoin-native, EVM-compatible Layer 2 that makes it easy to build and run smart contracts using Bitcoin as the native asset. +Botanix is a Bitcoin-native, EVM-compatible Layer 2 that lets you build and run smart contracts using Bitcoin as the native asset. -The Botanix API allows interaction with the Botanix network through a set of JSON-RPC methods. Its design is familiar to developers who have worked with Ethereum's JSON-RPC APIs, making it intuitive and straightforward to use. +The Botanix API lets you interact with the Botanix network through a set of JSON-RPC methods. If you've worked with Ethereum's JSON-RPC APIs, the design will feel familiar. -## Send Your First Request on Alchemy +## Send your first request on Alchemy Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a Botanix client connected to Alchemy and fetch the latest block number! @@ -28,7 +28,7 @@ Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a B ``` -## Create Client Connected to Alchemy +## Create a client connected to Alchemy ```js @@ -52,7 +52,7 @@ const client = createPublicClient({ Now that you've created a client connected to Alchemy, you can continue with some basics: -## Get Latest Block Number +## Get the latest block number ```js @@ -61,7 +61,7 @@ console.log("Current block number:", blockNumber); ``` -## Get an Address Balance +## Get an address balance ```js @@ -70,7 +70,7 @@ console.log("Balance (BTC):", Number(balance) / 1e18); ``` -## Read Block Data +## Read block data ```js @@ -81,7 +81,7 @@ console.log(block); ``` -## Fetch a Transaction by Hash +## Fetch a transaction by hash ```js @@ -90,7 +90,7 @@ console.log(tx); ``` -## Fetch Transaction Receipt +## Fetch a transaction receipt ```js diff --git a/content/api-reference/celo/celo-chain-api-faq.mdx b/content/api-reference/celo/celo-chain-api-faq.mdx index a01825ce9..b71295f20 100644 --- a/content/api-reference/celo/celo-chain-api-faq.mdx +++ b/content/api-reference/celo/celo-chain-api-faq.mdx @@ -11,7 +11,7 @@ Celo Chain is a mobile-first blockchain platform designed to provide accessible ## What is the Celo Chain API? -The Celo Chain API facilitates interaction with the Celo Chain network through a collection of JSON-RPC methods. It provides developers with tools, including the Celo Sepolia testnet, to interact with the blockchain, enabling functionalities such as transactions, smart contract deployment, and data retrieval. +The Celo Chain API lets you interact with the Celo Chain network through a collection of JSON-RPC methods. It provides tools, including the Celo Sepolia testnet, to interact with the blockchain, enabling transactions, smart contract deployment, and data retrieval. ## How can I get started using the Celo Chain API? @@ -19,7 +19,7 @@ Explained in [Celo Chain API Quickstart](/docs/reference/celo-chain-api-quicksta ## Is Celo Chain EVM compatible? -Yes, Celo Chain is fully compatible with the Ethereum Virtual Machine (EVM). This compatibility allows Ethereum developers to port their projects to Celo Chain with minimal changes, benefiting from the chain's mobile-first approach and low transaction fees. +Yes, Celo Chain is fully compatible with the Ethereum Virtual Machine (EVM). This compatibility lets you port your Ethereum projects to Celo Chain with minimal changes, benefiting from the chain's mobile-first approach and low transaction fees. ## What API does Celo Chain use? @@ -27,20 +27,20 @@ Celo Chain uses the JSON-RPC API standard for blockchain interactions. This is t ## What is a Celo Chain API key? -When accessing the Celo Chain network via a node provider like Alchemy, developers use an API key to send transactions and retrieve data from the network. +When accessing the Celo Chain network via a node provider like Alchemy, you use an API key to send transactions and retrieve data from the network. -For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup)! +For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup). ## What testnet should I use for Celo? -Developers should use the Celo Sepolia testnet for Celo. This testnet provides an environment to deploy and test applications. Tokens can be obtained from the [Celo Sepolia Faucet](https://faucet.celo.org/celo-sepolia). +Use the Celo Sepolia testnet for Celo. This testnet provides an environment to deploy and test applications. You can obtain tokens from the [Celo Sepolia Faucet](https://faucet.celo.org/celo-sepolia). ## Which libraries support Celo Chain? -Given Celo Chain's EVM compatibility, popular Ethereum libraries like ethers.js and web3.js are fully compatible with Celo Chain. This allows for seamless development and integration for those familiar with Ethereum's development ecosystem. +Given Celo Chain's EVM compatibility, popular Ethereum libraries like ethers.js and web3.js are fully compatible with Celo Chain. You can develop and integrate seamlessly if you're familiar with Ethereum's development ecosystem. ## What programming languages work with Celo Chain? -Similar to Ethereum, Celo Chain supports a range of programming languages for blockchain interaction and smart contract development, including Solidity for smart contracts, as well as JavaScript and TypeScript for dApp development and off-chain interactions. +Similar to Ethereum, Celo Chain supports a range of programming languages for blockchain interaction and smart contract development, including Solidity for smart contracts, as well as JavaScript and TypeScript for dApp development and offchain interactions. ## What does Celo Chain use for gas? @@ -52,4 +52,4 @@ You can find the list of all the methods Alchemy supports for the Celo Chain API ## My question isn't here, where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/celo/celo-chain-api-quickstart.mdx b/content/api-reference/celo/celo-chain-api-quickstart.mdx index 6c7f30a5b..8008a7632 100644 --- a/content/api-reference/celo/celo-chain-api-quickstart.mdx +++ b/content/api-reference/celo/celo-chain-api-quickstart.mdx @@ -12,9 +12,9 @@ slug: reference/celo-api-quickstart Celo is an EVM-compatible blockchain designed to provide financial tools and services to anyone with a mobile phone. Known for its focus on usability and inclusive finance, Celo offers a robust environment for deploying Ethereum-based applications with an emphasis on mobile-first experiences. -The Celo API facilitates interaction with the Celo network through a collection of JSON-RPC methods. Given its compatibility with the Ethereum ecosystem, developers familiar with Ethereum's JSON-RPC APIs will find working with Celo both intuitive and straightforward. +The Celo API lets you interact with the Celo network through a collection of JSON-RPC methods. If you're familiar with Ethereum's JSON-RPC APIs, working with Celo is intuitive and straightforward. -## Send Your First Request on Alchemy +## Send your first request on Alchemy Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a Celo client connected to Alchemy and fetch the latest block number! @@ -28,7 +28,7 @@ Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a C ``` -## Create Client Connected to Alchemy +## Create a client connected to Alchemy ```js @@ -44,7 +44,7 @@ const client = createPublicClient({ Now that you've created a client connected to Alchemy, you can continue with some basics: -## Get Latest Block Number +## Get the latest block number ```js @@ -53,7 +53,7 @@ console.log("Current block number:", blockNumber); ``` -## Get an Address Balance +## Get an address balance ```js @@ -62,7 +62,7 @@ console.log("Balance (CELO):", Number(balance) / 1e18); ``` -## Read Block Data +## Read block data ```js @@ -73,7 +73,7 @@ console.log(block); ``` -## Fetch a Transaction by Hash +## Fetch a transaction by hash ```js @@ -82,7 +82,7 @@ console.log(tx); ``` -## Fetch Transaction Receipt +## Fetch a transaction receipt ```js diff --git a/content/api-reference/citrea/citrea-api-faq.mdx b/content/api-reference/citrea/citrea-api-faq.mdx index 0b78dba2f..725fd6001 100644 --- a/content/api-reference/citrea/citrea-api-faq.mdx +++ b/content/api-reference/citrea/citrea-api-faq.mdx @@ -12,22 +12,22 @@ Citrea is a Bitcoin L2 zk-rollup with a Type-2 zkEVM that keeps data availabilit Check out our [Citrea API Quickstart guide](/docs/reference/citrea-api-quickstart) to get started building on Citrea. ## What is the Citrea API? -The Citrea API allows developers to interface with the Citrea testnet (mainnet coming soon). With this API, developers can execute transactions, query on-chain data, and interact with the Citrea network, relying on a JSON-RPC standard. +The Citrea API lets you interface with the Citrea testnet (mainnet coming soon). With this API, you can execute transactions, query onchain data, and interact with the Citrea network using the JSON-RPC standard. ## Is Citrea EVM compatible? Yes, Citrea is EVM compatible. ## What API does Citrea use? -Citrea uses the JSON-RPC API standard. This API is crucial for any blockchain interaction on the Citrea network, allowing users to read block/transaction data, query chain information, execute smart contracts, and store data on-chain. +Citrea uses the JSON-RPC API standard. This API is essential for any blockchain interaction on the Citrea network, allowing you to read block/transaction data, query chain information, execute smart contracts, and store data onchain. ## What methods are supported on Citrea? Citrea supports standard Ethereum JSON-RPC methods. Some chain-specific methods may vary. Please check the [Citrea API Endpoints](/docs/chains#citrea-apis) for a complete list. ## What is a Citrea API key? -When accessing the Citrea network via a node provider like Alchemy, Citrea developers use an API key to send transactions and retrieve data from the network. For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup)! +When accessing the Citrea network via a node provider like Alchemy, you use an API key to send transactions and retrieve data from the network. For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup). ## Which libraries support Citrea? Common Ethereum libraries like [ethers.js](https://docs.ethers.org/v5/) should be compatible with Citrea, given its EVM nature. ## My question isn’t here, where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/citrea/citrea-api-quickstart.mdx b/content/api-reference/citrea/citrea-api-quickstart.mdx index 36f52c39a..b23d9d399 100644 --- a/content/api-reference/citrea/citrea-api-quickstart.mdx +++ b/content/api-reference/citrea/citrea-api-quickstart.mdx @@ -12,9 +12,9 @@ slug: reference/citrea-api-quickstart Citrea is a Bitcoin L2 zk-rollup with a Type-2 zkEVM that keeps data availability and settlement on Bitcoin—via its BitVM-based "Clementine" two-way peg—bringing full EVM compatibility to BTC. -The Citrea API allows interaction with the Citrea network through a set of JSON-RPC methods. Its design is familiar to developers who have worked with Ethereum's JSON-RPC APIs, making it intuitive and straightforward to use. +The Citrea API lets you interact with the Citrea network through a set of JSON-RPC methods. If you've worked with Ethereum's JSON-RPC APIs, the design will feel familiar. -## Send Your First Request on Alchemy +## Send your first request on Alchemy Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a Citrea client connected to Alchemy and fetch the latest block number! @@ -28,7 +28,7 @@ Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a C ``` -## Create Client Connected to Alchemy +## Create a client connected to Alchemy ```js @@ -52,7 +52,7 @@ const client = createPublicClient({ Now that you've created a client connected to Alchemy, you can continue with some basics: -## Get Latest Block Number +## Get the latest block number ```js @@ -61,7 +61,7 @@ console.log("Current block number:", blockNumber); ``` -## Get an Address Balance +## Get an address balance ```js @@ -70,7 +70,7 @@ console.log("Balance (cBTC):", Number(balance) / 1e18); ``` -## Read Block Data +## Read block data ```js @@ -81,7 +81,7 @@ console.log(block); ``` -## Fetch a Transaction by Hash +## Fetch a transaction by hash ```js @@ -90,7 +90,7 @@ console.log(tx); ``` -## Fetch Transaction Receipt +## Fetch a transaction receipt ```js diff --git a/content/api-reference/clankermon/clankermon-api-faq.mdx b/content/api-reference/clankermon/clankermon-api-faq.mdx index eb8ba5ff1..b17ad6abf 100644 --- a/content/api-reference/clankermon/clankermon-api-faq.mdx +++ b/content/api-reference/clankermon/clankermon-api-faq.mdx @@ -12,22 +12,22 @@ Clankermon is a Base-aligned gaming appchain that makes fully onchain gameplay f Check out our [Clankermon API Quickstart guide](/docs/reference/clankermon-api-quickstart) to get started building on Clankermon. ## What is the Clankermon API? -The Clankermon API allows developers to interface with the Clankermon mainnet. With this API, developers can execute transactions, query on-chain data, and interact with the Clankermon network, relying on a JSON-RPC standard. +The Clankermon API lets you interface with the Clankermon mainnet. With this API, you can execute transactions, query onchain data, and interact with the Clankermon network using the JSON-RPC standard. ## Is Clankermon EVM compatible? Yes, Clankermon is EVM compatible. ## What API does Clankermon use? -Clankermon uses the JSON-RPC API standard. This API is crucial for any blockchain interaction on the Clankermon network, allowing users to read block/transaction data, query chain information, execute smart contracts, and store data on-chain. +Clankermon uses the JSON-RPC API standard. This API is essential for any blockchain interaction on the Clankermon network, allowing you to read block/transaction data, query chain information, execute smart contracts, and store data onchain. ## What methods are supported on Clankermon? Clankermon supports standard Ethereum JSON-RPC methods. Some chain-specific methods may vary. Please check the [Clankermon API Endpoints](/docs/chains#clankermon-apis) for a complete list. ## What is a Clankermon API key? -When accessing the Clankermon network via a node provider like Alchemy, Clankermon developers use an API key to send transactions and retrieve data from the network. For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup)! +When accessing the Clankermon network via a node provider like Alchemy, you use an API key to send transactions and retrieve data from the network. For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup). ## Which libraries support Clankermon? Common Ethereum libraries like [ethers.js](https://docs.ethers.org/v5/) should be compatible with Clankermon, given its EVM nature. ## My question isn’t here, where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/clankermon/clankermon-api-quickstart.mdx b/content/api-reference/clankermon/clankermon-api-quickstart.mdx index ffc073249..0f75a309f 100644 --- a/content/api-reference/clankermon/clankermon-api-quickstart.mdx +++ b/content/api-reference/clankermon/clankermon-api-quickstart.mdx @@ -12,9 +12,9 @@ slug: reference/clankermon-api-quickstart Clankermon is a Base-aligned gaming appchain that makes fully onchain gameplay fast and cheap using a Smart Sequencer. -The Clankermon API allows interaction with the Clankermon network through a set of JSON-RPC methods. Its design is familiar to developers who have worked with Ethereum's JSON-RPC APIs, making it intuitive and straightforward to use. +The Clankermon API lets you interact with the Clankermon network through a set of JSON-RPC methods. If you've worked with Ethereum's JSON-RPC APIs, the design will feel familiar. -## Send Your First Request on Alchemy +## Send your first request on Alchemy Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a Clankermon client connected to Alchemy and fetch the latest block number! @@ -28,7 +28,7 @@ Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a C ``` -## Create Client Connected to Alchemy +## Create a client connected to Alchemy ```js @@ -52,7 +52,7 @@ const client = createPublicClient({ Now that you've created a client connected to Alchemy, you can continue with some basics: -## Get Latest Block Number +## Get the latest block number ```js @@ -61,7 +61,7 @@ console.log("Current block number:", blockNumber); ``` -## Get an Address Balance +## Get an address balance ```js @@ -70,7 +70,7 @@ console.log("Balance (ETH):", Number(balance) / 1e18); ``` -## Read Block Data +## Read block data ```js @@ -81,7 +81,7 @@ console.log(block); ``` -## Fetch a Transaction by Hash +## Fetch a transaction by hash ```js @@ -90,7 +90,7 @@ console.log(tx); ``` -## Fetch Transaction Receipt +## Fetch a transaction receipt ```js diff --git a/content/api-reference/crossfi/crossfi-api-faq.mdx b/content/api-reference/crossfi/crossfi-api-faq.mdx index 4c07c8128..d558b1925 100644 --- a/content/api-reference/crossfi/crossfi-api-faq.mdx +++ b/content/api-reference/crossfi/crossfi-api-faq.mdx @@ -11,7 +11,7 @@ CrossFi is a blockchain platform designed to enable cross-chain interoperability ## What is the CrossFi API? -The CrossFi API allows developers to interact with the CrossFi network through a set of JSON-RPC methods. It supports operations such as asset transfers across chains, smart contract deployment, and data retrieval, empowering developers to integrate cross-chain functionality into their applications. +The CrossFi API lets you interact with the CrossFi network through a set of JSON-RPC methods. It supports operations such as asset transfers across chains, smart contract deployment, and data retrieval, letting you integrate cross-chain functionality into your applications. ## How can I get started using the CrossFi API? @@ -19,25 +19,25 @@ For a step-by-step guide, check out the [CrossFi API Quickstart](/docs/reference ## Is CrossFi EVM compatible? -Yes, CrossFi is EVM-compatible, allowing developers to deploy Ethereum-based smart contracts and applications on its network, while also supporting interoperability with other blockchain ecosystems. +Yes, CrossFi is EVM-compatible, allowing you to deploy Ethereum-based smart contracts and applications on its network, while also supporting interoperability with other blockchain ecosystems. ## What API does CrossFi use? -CrossFi utilizes the JSON-RPC API standard, enabling efficient blockchain interactions. It provides a consistent and secure interface for cross-chain transactions and other decentralized operations. +CrossFi uses the JSON-RPC API standard, enabling efficient blockchain interactions. It provides a consistent and secure interface for cross-chain transactions and other decentralized operations. ## What is a CrossFi API key? -When accessing the CrossFi network via a service provider like Alchemy, developers need an API key to send transactions and retrieve data. An API key allows for secure and authenticated access to the network. +When accessing the CrossFi network via a service provider like Alchemy, you need an API key to send transactions and retrieve data. An API key provides secure and authenticated access to the network. -For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup)! +For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup). ## Which libraries support CrossFi? -CrossFi supports popular Ethereum-based libraries like Web3.js and Ethers.js, enabling developers to leverage existing tools for cross-chain and DeFi applications. +CrossFi supports popular Ethereum-based libraries like Web3.js and Ethers.js, so you can leverage existing tools for cross-chain and DeFi applications. ## What programming languages work with CrossFi? -CrossFi supports Solidity for smart contract development due to its EVM compatibility. For off-chain interactions, developers typically use JavaScript, TypeScript, or other widely-used web development languages. +CrossFi supports Solidity for smart contract development due to its EVM compatibility. For offchain interactions, you can use JavaScript, TypeScript, or other widely-used web development languages. ## What does CrossFi use for gas? @@ -49,4 +49,4 @@ You can find the full list of methods supported by Alchemy for the CrossFi API o ## My question isn't here, where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/crossfi/crossfi-api-quickstart.mdx b/content/api-reference/crossfi/crossfi-api-quickstart.mdx index ced37cc7d..38aa264aa 100644 --- a/content/api-reference/crossfi/crossfi-api-quickstart.mdx +++ b/content/api-reference/crossfi/crossfi-api-quickstart.mdx @@ -12,9 +12,9 @@ slug: reference/crossfi-api-quickstart CrossFi is a blockchain platform built to enable seamless cross-chain asset transfers and decentralized finance (DeFi) applications. With a focus on interoperability, security, and scalability, CrossFi provides developers and users with a powerful ecosystem for deploying decentralized applications (dApps) that can operate across multiple blockchain networks. -The CrossFi API facilitates interaction with the CrossFi network through a collection of JSON-RPC methods. Given its developer-friendly design, those familiar with Ethereum's JSON-RPC APIs will find working with CrossFi intuitive and straightforward. +The CrossFi API lets you interact with the CrossFi network through a collection of JSON-RPC methods. If you're familiar with Ethereum's JSON-RPC APIs, working with CrossFi is intuitive and straightforward. -## Send Your First Request on Alchemy +## Send your first request on Alchemy Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a CrossFi client connected to Alchemy and fetch the latest block number! @@ -28,7 +28,7 @@ Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a C ``` -## Create Client Connected to Alchemy +## Create a client connected to Alchemy ```js @@ -52,7 +52,7 @@ const client = createPublicClient({ Now that you've created a client connected to Alchemy, you can continue with some basics: -## Get Latest Block Number +## Get the latest block number ```js @@ -61,7 +61,7 @@ console.log("Current block number:", blockNumber); ``` -## Get an Address Balance +## Get an address balance ```js @@ -70,7 +70,7 @@ console.log("Balance (XFI):", Number(balance) / 1e18); ``` -## Read Block Data +## Read block data ```js @@ -81,7 +81,7 @@ console.log(block); ``` -## Fetch a Transaction by Hash +## Fetch a transaction by hash ```js @@ -90,7 +90,7 @@ console.log(tx); ``` -## Fetch Transaction Receipt +## Fetch a transaction receipt ```js diff --git a/content/api-reference/data/data-overview.mdx b/content/api-reference/data/data-overview.mdx index 94870c15d..7f58c7f10 100644 --- a/content/api-reference/data/data-overview.mdx +++ b/content/api-reference/data/data-overview.mdx @@ -17,7 +17,7 @@ The Data APIs give you fast, reliable access to blockchain data without running - Easily request information about specific tokens like metadata or wallet balances. + Request information about specific tokens like metadata or wallet balances. @@ -33,7 +33,7 @@ The Data APIs give you fast, reliable access to blockchain data without running - Subscribe to on-chain events like transfers, transactions, and balance changes. + Subscribe to onchain events like transfers, transactions, and balance changes. @@ -47,7 +47,7 @@ The Data APIs give you fast, reliable access to blockchain data without running *** -## When Should I Use the Data APIs? +## When should you use the Data APIs? Use the Data APIs if: @@ -59,13 +59,13 @@ Use the Data APIs if: * `estimateUserOpGas` * and more account abstraction features * You want to simulate or estimate transaction outcomes before sending them. -* You need to track wallet or contract activity with push notifications via Webhooks. +* You need to track wallet or contract activity with push notifications via webhooks. *** -## Data APIs Use Cases +## Data APIs use cases -### 1. Developer Tooling & Debugging +### 1. Developer tooling and debugging Perfect for advanced dev environments, simulation dashboards, and infra teams. @@ -73,9 +73,9 @@ Perfect for advanced dev environments, simulation dashboards, and infra teams. * `debug_traceTransaction` * `debug_getRawTrace` -### 2. Help Users *Write* Transactions +### 2. Help your users *write* transactions -Ideal for apps that generate transactions on behalf of users. +Ideal for apps that generate transactions on behalf of your users. **Common use cases:** @@ -84,7 +84,7 @@ Ideal for apps that generate transactions on behalf of users. * Wallets that send tokens or interact with contracts * Portfolio apps that need to simulate or batch transactions -### 3. Help Users *Read* Transactions +### 3. Help your users *read* transactions **Common use cases:** @@ -94,7 +94,7 @@ Ideal for apps that generate transactions on behalf of users. * Historical transfers and analytics dashboards -* Price feeds and on-chain trends +* Price feeds and onchain trends * Pre-indexed data to power all your frontend and backend logic @@ -107,16 +107,16 @@ Ideal for apps that generate transactions on behalf of users. ## Summary -The Data APIs are specifically meant to do the heavy lifting so that you can focus on your product needs. +The Data APIs do the heavy lifting so you can focus on your product. -We are not just the data provider, but also the infra layer behind the biggest names in web3. Alchemy is set apart by: +We're not just a data provider -- we're the infra layer behind the biggest names in web3. Alchemy is set apart by: * **Battle-tested scale**: powering millions of wallets, swaps, and NFT marketplaces — from Fortune 500s to weekend and hackathon builders. * **Multi-chain support**: Ethereum, Base, Polygon, Arbitrum, Optimism, and dozens of other chains supported out of the box. *** -## Quick Reference +## Quick reference ### Token, NFT, and Prices APIs @@ -124,19 +124,19 @@ We are not just the data provider, but also the infra layer behind the biggest n **Ideal for:** Multi-chain token experiences, balance indexing - **How it works:** Simply call an API to return multi-chain and complete token data + **How it works:** Call an API to return multi-chain and complete token data **Ideal for:** NFT drops, token gating, analytics, wallets, marketplaces - - **How it works:** Simply call an API to return multi-chain and complete NFT data + + **How it works:** Call an API to return multi-chain and complete NFT data **Ideal for:** Multi-chain token experiences, trading apps, wallets - - **How it works:** Simply call an API to return multi-chain and complete token prices data + + **How it works:** Call an API to return multi-chain and complete token prices data @@ -146,7 +146,7 @@ We are not just the data provider, but also the infra layer behind the biggest n **Ideal for:** Push notifications, wallets, consumer facing apps - **How it works:** Define your Webhook and start receiving relevant events + **How it works:** Define your webhook and start receiving relevant events diff --git a/content/api-reference/data/nft-api/nft-api-faq.mdx b/content/api-reference/data/nft-api/nft-api-faq.mdx index a1d83880b..0d37eeb8d 100644 --- a/content/api-reference/data/nft-api/nft-api-faq.mdx +++ b/content/api-reference/data/nft-api/nft-api-faq.mdx @@ -7,25 +7,25 @@ slug: reference/nft-api-faq ## What can I make with the NFT API? -Using the Alchemy NFT API lets you fetch and display NFTs for your users, making it easy to build all kinds of NFT projects. +The Alchemy NFT API lets you fetch and display NFTs, making it straightforward to build all kinds of NFT projects. Tell us on [Twitter](https://twitter.com/Alchemy) what you're trying to build! ## What do NFT API requests look like? -We've compiled some super easy to use, copy-and-paste code snippets 😇 +We've compiled some copy-and-paste code snippets. -You can check out the rest of our docs for more in-depth documentation about our endpoints, but for a quick walkthrough with some sample code ready to run, start with this GitHub repository: +Check out the rest of our docs for more in-depth documentation about our endpoints, but for a quick walkthrough with sample code ready to run, start with this GitHub repository: [![GitHub - alchemyplatform/nft-api-javascript-scripts: A collection of Javascript scripts running with Alchemy Web3.js, Fetch, or Axios](https://alchemyapi-res.cloudinary.com/image/upload/v1764179970/docs/api-reference/data/nft-api/nft-api-javascript-scripts.png)](https://github.com/alchemyplatform/nft-api-javascript-scripts) ## What types of NFTs are supported? -All NFTs made with the ERC721 and ERC1155 standards are supported by the NFT API. At the moment, we support a select number of tokens like CryptoPunks and CryptoKitties that pre-date the existence of standardized NFT contracts. +All NFTs made with the ERC-721 and ERC-1155 standards are supported by the NFT API. At the moment, we support a select number of tokens like CryptoPunks and CryptoKitties that pre-date the existence of standardized NFT contracts. Alchemy is actively working on adding support for as many blockchains / NFT standards as we can. If you find that NFTs are missing in wallets you are calling, please provide details about the missing NFT over email: support@alchemy.com -## How does Alchemy determine NFT Standard i.e. if a collection is `ERC721` or `ERC1155` ? +## How does Alchemy determine NFT standard (ERC-721 vs ERC-1155)? First, we collect the following data (each of which is an eth\_call): @@ -41,9 +41,9 @@ After we've collected the data, we have some simple code to determine token stan 2. We first query `supportsInterface` and then query `hasTransfers`. The standards are pretty clear that the contract should return `true` for a `supportsInterface` call, so we look at that first. 3. Finally, we have two token types: `NotAContract` and `NoSupportedNFTStandard`. These token types communicate that we are, in fact, aware of the contract and we are telling you that it is not an NFT contract. -## How does NFT Metadata Work? +## How does NFT metadata work? -The primary object within the Alchemy NFT API is the **NFT asset**, which is an on-chain item that lives on the blockchain. Within each NFT, there can be many different fields that describe its on-presence. +The primary object within the Alchemy NFT API is the **NFT asset**, which is an onchain item that lives on the blockchain. Within each NFT, there can be many different fields that describe its onchain presence. ### General Metadata Structure @@ -57,12 +57,12 @@ The primary object within the Alchemy NFT API is the **NFT asset**, which is an | `attributes` | The traits/attributes/characteristics for each NFT asset. | - Not all metadata fields may be filled out by the NFT creator. NFTs can be published on-chain without these fields and still conform to the `ERC721/ERC1155` standards. + Not all metadata fields may be filled out by the NFT creator. NFTs can be published onchain without these fields and still conform to the ERC-721/ERC-1155 standards. -## What are Gateway vs. Raw URIs? +## What are gateway vs. raw URIs? -Gateways are an important part of NFT infrastructure. Behind the scenes, they allow users to access IPFS content without running an IPFS node. With a gateway provider, a third-party service downloads data off of IPFS nodes and then serves it whenever requested. +Gateways are an important part of NFT infrastructure. Behind the scenes, they let you access IPFS content without running an IPFS node. With a gateway provider, a third-party service downloads data off of IPFS nodes and then serves it whenever requested. NFT creators/developers can also "pin" their content, effectively caching and storing it on gateway nodes/servers. This ensures that the content is always available online. @@ -74,12 +74,12 @@ While NFT gateway and raw URIs tend to be pointed at the same links, gateway URI `getNFTMetadata` is more specific and is used for querying the metadata of a single NFT. Common use cases include NFT rarity tools and NFT searching applications. -## How are NFTs Classified as "Spam"? +## How are NFTs classified as "spam"? Given a contract address, we look at a few things: -1. If this contract is ERC721, does this contract egregiously break the ERC721 standard? i.e., Does it have a lot of duplicate tokens. -2. If this contract is ERC721, does it have any transfer during which it broke the ERC721 standard? i.e. It transferred a token to more than one recipient. +1. If this contract is ERC-721, does this contract egregiously break the ERC-721 standard? i.e., Does it have a lot of duplicate tokens. +2. If this contract is ERC-721, does it have any transfer during which it broke the ERC-721 standard? i.e. It transferred a token to more than one recipient. 3. Does this contract mint tokens mostly to honeypots? Honeypots are popular addresses like `vitalik.eth` 4. Does this contract egregiously lie about its own total supply? i.e. running `totalSupply()` on the contract is vastly different from the empirical number of tokens in circulation. @@ -91,11 +91,11 @@ The response object of Alchemy's `getNFTs` method contains a field called `class The tags are one of the below :- -1. **Erc721TooManyOwners**: A single token in the ERC721 collection has been transferred to multiple owners indicating fraudulent transfers +1. **Erc721TooManyOwners**: A single token in the ERC-721 collection has been transferred to multiple owners indicating fraudulent transfers 2. **Erc721TooManyTokens**: This collection has a lot of duplicate tokens indicating spammy behaviour -3. **Erc721DishonestTotalSupply** : The contract lies about its own token supply. Running `totalSupply()` on the contract is vastly different from the empirical number of tokens in circulation. -4. **MostlyHoneyPotOwners** : Most or all of the owners of the NFT collection are Honeypots i.e. popular addresses like `vitalik.eth`. So these are probably unwarranted airdrops. -5. **OwnedByMostHoneyPots** : A significant chunk of the usual Honeypot addresses own this collection. Again signifying unwarranted airdrops. +3. **Erc721DishonestTotalSupply**: The contract lies about its own token supply. Running `totalSupply()` on the contract is vastly different from the empirical number of tokens in circulation. +4. **MostlyHoneyPotOwners**: Most or all of the owners of the NFT collection are Honeypots i.e. popular addresses like `vitalik.eth`. So these are probably unwarranted airdrops. +5. **OwnedByMostHoneyPots**: A significant chunk of the usual Honeypot addresses own this collection. Again signifying unwarranted airdrops. ## How often is the floor price updated for `getFloorPrice`? @@ -107,9 +107,9 @@ The cache for the getFloorPrice function is only refreshed every 15 mins. So if # NFT Images and Media FAQ -## Why does Alchemy Cache NFT Media? +## Why does Alchemy cache NFT media? -While NFT media is traditionally served from IPFS/third-party servers, developers often face slow loading times and timeout errors when using these endpoints. Alchemy solves this problem by caching NFT images and serving up NFT URLs from our own cache. +While NFT media is traditionally served from IPFS/third-party servers, you may face slow loading times and timeout errors when using these endpoints. Alchemy solves this problem by caching NFT images and serving up NFT URLs from our own cache. ## How do I use Alchemy-hosted NFT media? @@ -139,25 +139,25 @@ When displaying the media associated with an NFT, it is recommended to use the ` Currently, NFT assets are now stored on Alchemy's cloud/CDN (nft-cdn.alchemy.com). We only use Cloudinary for transformations (like resizing, image format conversion, etc.). -Since we automatically generate thumbnails for a cached asset in the payload response, we recommend users use that. +Since we automatically generate thumbnails for a cached asset in the payload response, we recommend using that. However, we still enable resizing, but not by default. For example, if you take a BAYC stored on our CDN [https://nft-cdn.alchemy.com/eth-mainnet/d9d674adddb2da8fcbcdb0230ca1da3d](https://nft-cdn.alchemy.com/eth-mainnet/d9d674adddb2da8fcbcdb0230ca1da3d). -**Base Cloudinary URL:** The thumbnail will be located at a corresponding Cloudinary URL with the same hash: [https://res.cloudinary.com/alchemyapi/image/upload/thumbnail/eth-mainnet/d9d674adddb2da8fcbcdb0230ca1da3d](https://res.cloudinary.com/alchemyapi/image/upload/thumbnail/eth-mainnet/d9d674adddb2da8fcbcdb0230ca1da3d). Developers can then request resized images for thumbnails, smartphones, tablets, and/or laptop viewing, you can manipulate the URL to include height/width like before: +**Base Cloudinary URL:** The thumbnail will be located at a corresponding Cloudinary URL with the same hash: [https://res.cloudinary.com/alchemyapi/image/upload/thumbnail/eth-mainnet/d9d674adddb2da8fcbcdb0230ca1da3d](https://res.cloudinary.com/alchemyapi/image/upload/thumbnail/eth-mainnet/d9d674adddb2da8fcbcdb0230ca1da3d). You can then request resized images for thumbnails, smartphones, tablets, and/or laptop viewing by manipulating the URL to include height/width like before: **Base Cloudinary URL with Width & Height Values:** [https://res.cloudinary.com/alchemyapi/image/upload/w\_400,h\_400/thumbnail/eth-mainnet/d9d674adddb2da8fcbcdb0230ca1da3d](https://res.cloudinary.com/alchemyapi/image/upload/w_400,h_400/thumbnail/eth-mainnet/d9d674adddb2da8fcbcdb0230ca1da3d) Note that this resizes the thumbnail version. - Developers can use any combination of width and height pixel values to create the desired aspect ratio for visual displays. + You can use any combination of width and height pixel values to create the desired aspect ratio for visual displays. Here's an example of a resized BAYC NFT asset cached by Alchemy: [https://res.cloudinary.com/alchemyapi/image/upload/w\_400,h\_400/thumbnail/eth-mainnet/d9d674adddb2da8fcbcdb0230ca1da3d](https://res.cloudinary.com/alchemyapi/image/upload/w_400,h_400/thumbnail/eth-mainnet/d9d674adddb2da8fcbcdb0230ca1da3d) ![378](https://alchemyapi-res.cloudinary.com/image/upload/v1764193029/docs/api-reference/data/nft-api/cdb00a2-Screenshot_2022-11-23_at_10.42.14_AM.png "Screenshot 2022-11-23 at 10.42.14 AM.png") -## How can I get PNG Images instead of SVG when using Alchemy's APIs? +## How can I get PNG images instead of SVG when using Alchemy's APIs? By default Alchemy API returns the same image format as is in the metadata. Sometimes that means SVG images. In case you want to obtain the PNG format for those images instead, you can replace the string `/thumbnail` with `/convert-png` in the thumbnail URL value. @@ -194,7 +194,7 @@ Below are more detailed breakdowns of what many of our errors mean and how to ap ### Why? -In order to fetch the metadata for a given NFT, we call one of two potential methods on the contract with the token ID as the input. For ERC721 contracts, we call the `tokenURI` method. For ERC1155 contracts, we call `uri`. These two methods take in a token ID and return a uri which points to the metadata for that token ID. +To fetch the metadata for a given NFT, we call one of two potential methods on the contract with the token ID as the input. For ERC-721 contracts, we call the `tokenURI` method. For ERC-1155 contracts, we call `uri`. These two methods take in a token ID and return a uri which points to the metadata for that token ID. If we pass a token ID into the method that the contract does not recognize, we will get one of several errors that each mean that the token does not exist. Essentially, the contract does not recognize the token ID that you provided. @@ -206,9 +206,9 @@ The contract throws an exception on etherscan ### Next Steps -More often than not, a contract will return a "token does not exist" error when the token is *not yet minted*. It's important to note that the token ID may, however, exist at a later date once it is minted. If you are confident that the token ID you provided *should* exist, you can retry your query at a later date. Once the token has been minted and recognized by our service, your request may succeed. Note that some contracts do return un-minted tokens, so this error message is not to be used as an indicator for whether a token has been minted yet. +More often than not, a contract will return a "token does not exist" error when the token is *not yet minted*. The token ID may, however, exist at a later date once it is minted. If you are confident that the token ID you provided *should* exist, you can retry your query at a later date. Once the token has been minted and recognized by our service, your request may succeed. Note that some contracts do return un-minted tokens, so this error message is not to be used as an indicator for whether a token has been minted yet. -The second most common reason for a "token does not exist" error is that the token truly does not exist! For older contracts that have been completely minted, this error should be trusted. Repeated attempts at finding metadata will fail simply because it does not exist! +The second most common reason for a "token does not exist" error is that the token truly does not exist! For older contracts that have been completely minted, this error should be trusted. Repeated attempts at finding metadata will fail because it does not exist. ## Malformed token URI @@ -218,7 +218,7 @@ The second most common reason for a "token does not exist" error is that the tok ### Why? -Once we know where an NFT's metadata is stored (by calling `tokenURI` or `uri` on the contract as described above), we visit the resulting website in order to access the metadata. However, if the website that is returned by `tokenURI` or `uri` is malformed, then we cannot visit it and return this error instead. By "malformed" we mean any website that cannot be visited. In the example above (click on it to see) you can see that the `tokenUri.raw` field is an empty string. That is because the `tokenURI` method of that contract returned an empty string instead of a valid website. +Once we know where an NFT's metadata is stored (by calling `tokenURI` or `uri` on the contract as described above), we visit the resulting website to access the metadata. However, if the website that is returned by `tokenURI` or `uri` is malformed, then we cannot visit it and return this error instead. By "malformed" we mean any website that cannot be visited. In the example above (click on it to see) you can see that the `tokenUri.raw` field is an empty string. That is because the `tokenURI` method of that contract returned an empty string instead of a valid website. You can see the empty response in etherscan's contract interface here: [https://etherscan.io/address/0xbfde6246df72d3ca86419628cac46a9d2b60393c#readContract](https://etherscan.io/address/0xbfde6246df72d3ca86419628cac46a9d2b60393c#readContract) @@ -258,7 +258,7 @@ Unfortunately, there isn't much you can do if the contract doesn't properly retu **Why?** -In the section above we talked about how we get the URI where the NFT metadata lives. Once we have the URI, we then attempt to visit it in order to access the metadata. If the URI responds with anything other than a `2xx` response code, like for instance a 502 Bad Gateway, then we return this error. +In the section above we talked about how we get the URI where the NFT metadata lives. Once we have the URI, we then attempt to visit it to access the metadata. If the URI responds with anything other than a `2xx` response code, like for instance a 502 Bad Gateway, then we return this error. ### Next Steps @@ -268,7 +268,7 @@ In this case, it is *possible* that retrying the request can succeed. If the con ### Why? -If a token URI containing metadata responds to our retrieval attempts with a "429 Too Many Requests," the site is informing us that we have requested metadata too often. When this happens, we will not visit the website again in order to release the "rate limit" that they have put on us. During this "waiting period," requesting NFT metadata for that same asset requires hitting that website and, therefore, we will temporarily block the request. +If a token URI containing metadata responds to our retrieval attempts with a "429 Too Many Requests," the site is informing us that we have requested metadata too often. When this happens, we will not visit the website again to release the "rate limit" that they have put on us. During this "waiting period," requesting NFT metadata for that same asset requires hitting that website and, therefore, we will temporarily block the request. ### Next Steps @@ -278,7 +278,7 @@ In this case, you should retry your request after a variable number of seconds. **Why?** -Not all addresses are token contracts! If you send us an address for which there is no contract code then we return this error. In order to determine if the address is a contract, we call `eth_getCode` on the address. +Not all addresses are token contracts! If you send us an address for which there is no contract code then we return this error. To determine if the address is a contract, we call `eth_getCode` on the address. **Next steps** diff --git a/content/api-reference/data/nft-api/nft-api-quickstart.mdx b/content/api-reference/data/nft-api/nft-api-quickstart.mdx index c881d32da..57888e215 100644 --- a/content/api-reference/data/nft-api/nft-api-quickstart.mdx +++ b/content/api-reference/data/nft-api/nft-api-quickstart.mdx @@ -9,7 +9,7 @@ slug: reference/nft-api-quickstart Start using the NFT API in your app today. [Get started for free](https://dashboard.alchemy.com/signup) -# Getting Started Instructions +# Getting started Follow along with the steps below to get started with the NFT API: @@ -60,17 +60,17 @@ Open up a terminal, and from the command line, create a new repository to hold y *** -## 3. Choose a Library +## 3. Choose a library ### a) Fetch -You can easily interact with Alchemy's NFT API using simple fetch requests. No additional dependencies required with Node.js 18+. +You can interact with Alchemy's NFT API using fetch requests. No additional dependencies required with Node.js 18+. -#### Demo Script +#### Demo script [View the demo script on GitHub](https://github.com/alchemyplatform/nft-api-javascript-scripts) -In your `alchemy-nft-api` directory, you can create a new file called `nft-api-script.js` using your favorite file browser, code editor, or just directly in the terminal using the `touch` command like this: +In your `alchemy-nft-api` directory, create a new file called `nft-api-script.js` using your favorite file browser, code editor, or directly in the terminal using the `touch` command: ```shell shell @@ -191,11 +191,11 @@ Run the following command to install `axios` with `npm` and \`yarn ``` -#### Demo Script +#### Demo script [View the demo script on GitHub](https://github.com/alchemyplatform/nft-api-javascript-scripts/blob/main/axios-script.js) -In your `alchemy-nft-api` directory, you can create a new file called `axios-script.js` using your favorite file browser, code editor, or just directly in the terminal using the `touch` command. +In your `alchemy-nft-api` directory, create a new file called `axios-script.js` using your favorite file browser, code editor, or directly in the terminal using the `touch` command. ```shell shell diff --git a/content/api-reference/data/portfolio-apis/portfolio-apis.mdx b/content/api-reference/data/portfolio-apis/portfolio-apis.mdx index 72e5eeb5a..26a846372 100644 --- a/content/api-reference/data/portfolio-apis/portfolio-apis.mdx +++ b/content/api-reference/data/portfolio-apis/portfolio-apis.mdx @@ -9,16 +9,16 @@ Portfolio APIs include *everything* you need to build a view of a user's assets: ## **Why Portfolio APIs?** -* ⛓️ **Multi-Chain**: All Portfolio APIs are multi-chain - get all of the data you need in a single API request, instead of having to parallelize dozens of calls across different networks. -* 💪 **Powerful**: Use powerful APIs that allow you to query for the metadata that you need (e.g. cached images, token metadata, prices) within the same API call. -* 📈**Constantly Improving**: These APIs are continuously improving, based on customer feedback. -* 🪨 **Long Term Partners**: We have 7+ years of experience supporting the largest customers that are onchain and will be around to support you for the long term. -* ⛰️**Scalable**: These APIs power some of the biggest Wallets in the space - rest easy knowing that we can scale with you. +* **Multi-chain**: All Portfolio APIs are multi-chain -- get all the data you need in a single API request, instead of parallelizing dozens of calls across different networks. +* **Powerful**: Query for the metadata you need (e.g. cached images, token metadata, prices) within the same API call. +* **Constantly improving**: These APIs are continuously improving, based on customer feedback. +* **Long-term partners**: We have 7+ years of experience supporting the largest onchain customers and will be around to support you for the long term. +* **Scalable**: These APIs power some of the biggest wallets in the space -- rest assured that we can scale with you. | [**Get Tokens By Wallet**](/docs/data/portfolio-apis/portfolio-api-endpoints/portfolio-api-endpoints/get-tokens-by-address) | [**NFTs By Wallet**](/docs/data/portfolio-apis/portfolio-api-endpoints/portfolio-api-endpoints/get-nfts-by-address) | [Transaction History](/docs/transaction-history) | | ----------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | | ![Image 1](https://alchemyapi-res.cloudinary.com/image/upload/v1764179965/docs/api-reference/data/cc619a4df5351c534c2c0f6c718d26336600c07275d076dd15fe80e1964aaee5-Screenshot_2025-02-24_at_4.22.57_PM.png) | ![Image 2](https://alchemyapi-res.cloudinary.com/image/upload/v1764179966/docs/api-reference/data/b6a2d47e1d0a755c480ec042ebfd011dcb7403c4338ded3c1a8e0edf106bc848-Screenshot_2025-02-24_at_4.22.10_PM.png) | ![Image 3](https://alchemyapi-res.cloudinary.com/image/upload/v1764179967/docs/api-reference/data/4b35a354494bf54afdd84697b1cabf8e199c9863394f50066727892e497111f1-Screenshot_2025-02-24_at_4.23.35_PM.png) | -| **Ideal for:** Multi-chain token experiences, balance indexing

**How it works:** Simply call an API to get balances, metadata, and prices. | **Ideal for:** NFT drops, token gating, analytics, wallets, marketplaces

**How it works:** Simply call an API to return multi-chain and complete NFT data. | **Ideal for:** Wallets

**How it works:** Simply call an API to return get all transactions across different networks for a set of addresses. | +| **Ideal for:** Multi-chain token experiences, balance indexing

**How it works:** Call an API to get balances, metadata, and prices. | **Ideal for:** NFT drops, token gating, analytics, wallets, marketplaces

**How it works:** Call an API to return multi-chain and complete NFT data. | **Ideal for:** Wallets

**How it works:** Call an API to get all transactions across different networks for a set of addresses. | ## Feedback? diff --git a/content/api-reference/data/prices-api/prices-api-faq.mdx b/content/api-reference/data/prices-api/prices-api-faq.mdx index 1572b4ff4..c70075ead 100644 --- a/content/api-reference/data/prices-api/prices-api-faq.mdx +++ b/content/api-reference/data/prices-api/prices-api-faq.mdx @@ -59,4 +59,4 @@ Enterprise: No limits (except for [account throughput](/docs/reference/throughpu ### Something else -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/data/prices-api/prices-api-quickstart.mdx b/content/api-reference/data/prices-api/prices-api-quickstart.mdx index 03ac3591c..6d89366a7 100644 --- a/content/api-reference/data/prices-api/prices-api-quickstart.mdx +++ b/content/api-reference/data/prices-api/prices-api-quickstart.mdx @@ -25,13 +25,13 @@ The Prices API includes the following REST endpoints: *** -# Getting Started +# Getting started -## Via HTTP Requests +## Via HTTP requests -Modern web development uses fetch for HTTP requests. The Prices API can be easily accessed using native fetch or any HTTP client library. +Modern web development uses fetch for HTTP requests. You can access the Prices API using native fetch or any HTTP client library. -### No Additional Installation Required +### No additional installation required The fetch API is available in all modern browsers and Node.js (18+). For older Node.js versions, you can install `node-fetch`: @@ -120,7 +120,7 @@ Create a new JavaScript file (e.g., `prices-fetch-script.js`) and add one of the ``` -### Running the Script +### Running the script Execute the script from your command line: @@ -176,7 +176,7 @@ Execute the script from your command line: ## Via Node Fetch -`node-fetch` is a lightweight option for making HTTP requests with Javascript. +`node-fetch` is a lightweight option for making HTTP requests with JavaScript. ### Installation @@ -270,7 +270,7 @@ Create a new JavaScript file (e.g., `prices-fetch-script.js`) and add the follow ``` -### Running the Script +### Running the script Execute the script from your command line: diff --git a/content/api-reference/data/token-api/token-api-overview.mdx b/content/api-reference/data/token-api/token-api-overview.mdx index dbbc462f9..b08f669d6 100644 --- a/content/api-reference/data/token-api/token-api-overview.mdx +++ b/content/api-reference/data/token-api/token-api-overview.mdx @@ -13,7 +13,7 @@ slug: reference/token-api-overview # Intro -With the Token API, you can retrieve token balances, metadata, and more. Easily request information on specific tokens such as **metadata** or **balances**. +With the Token API, you can retrieve token balances, metadata, and more. Request information on specific tokens such as **metadata** or **balances**. Alchemy currently supports the following [Token API Endpoints](/docs/reference/token-api): diff --git a/content/api-reference/data/token-api/token-api-quickstart.mdx b/content/api-reference/data/token-api/token-api-quickstart.mdx index bc3080205..379828dfd 100644 --- a/content/api-reference/data/token-api/token-api-quickstart.mdx +++ b/content/api-reference/data/token-api/token-api-quickstart.mdx @@ -5,11 +5,11 @@ subtitle: A new developer's guide to using the Token API and getting token infor slug: reference/token-api-quickstart --- -# How to Query the Token API +# How to query the Token API ## Fetch -You can easily interact with Alchemy's Token API using simple fetch requests. No additional dependencies required with Node.js 18+. +You can interact with Alchemy's Token API using fetch requests. No additional dependencies required with Node.js 18+. ### Usage diff --git a/content/api-reference/data/transfers-api/transfers-api-quickstart.mdx b/content/api-reference/data/transfers-api/transfers-api-quickstart.mdx index fd7dd5061..fc4f03e17 100644 --- a/content/api-reference/data/transfers-api/transfers-api-quickstart.mdx +++ b/content/api-reference/data/transfers-api/transfers-api-quickstart.mdx @@ -7,7 +7,7 @@ slug: reference/transfers-api-quickstart *To use the Transfers API you'll need to [create a free Alchemy account](https://alchemy.com/?r=affiliate:4cf7f72f-9238-45c4-a230-6840fcd048ae) first!* -## Transfers API Chain Support +## Transfers API chain support Check the [Chains](https://dashboard.alchemy.com/chains) page for details about product and chain support! @@ -17,35 +17,35 @@ slug: reference/transfers-api-quickstart *NOTE: see the table below for the [types of transfers](#types-of-transfers) supported by each network* -## What are Transfers? +## What are transfers? -Transfers are a representation of value being exchanged between two accounts. Often times users wish to see the historical transactions associated with a specific account or address. This is currently an extremely challenging and inefficient task, requiring users to scan the entire blockchain and index everything to search for transactions associated with the desired address. However, with the Transfers API users can query all types of historical transactions for a given address in a single request. +Transfers are a representation of value being exchanged between two accounts. You may want to see the historical transactions associated with a specific account or address. This is currently an extremely challenging and inefficient task, requiring you to scan the entire blockchain and index everything to search for transactions associated with the desired address. However, with the Transfers API you can query all types of historical transactions for a given address in a single request. -## What's an Example Use Case for Transfers? +## What's an example use case for transfers? -An example use case for the requesting transfer events would be integrating historical transaction data into your dApp. For instructions on how to do this check out this tutorial on [Integrating Historical Transaction Data into your dApp](/docs/integrating-historical-transaction-data-into-your-dapp). +An example use case for requesting transfer events would be integrating historical transaction data into your dApp. For instructions on how to do this, check out the tutorial on [integrating historical transaction data into your dApp](/docs/integrating-historical-transaction-data-into-your-dapp). -## Types of Transfers +## Types of transfers There are five main types of transfers that are captured when using this API. See below for the types of transfers: -### 1. External Eth Transfers +### 1. External ETH transfers These are top level transactions that occur with a from address being an external (user created) address. External addresses have private keys and are accessed by users. -### 2. ERC20 Transfers +### 2. ERC-20 transfers -Event logs for ERC20 transfers. +Event logs for ERC-20 transfers. -### 3. ERC721 Transfers +### 3. ERC-721 transfers -Event logs for ERC721 transfers. +Event logs for ERC-721 transfers. -### 4. ERC1155 Transfers +### 4. ERC-1155 transfers -These are event logs for ERC1155 transfers. +These are event logs for ERC-1155 transfers. -### 5. Internal Eth Transfers +### 5. Internal ETH transfers These are transfers that occur where the `fromAddress` is an internal (smart contract) address. (ex: a smart contract calling another smart contract or smart contract calling another external address). For a full deep dive into internal transfers check out this article on [What are Internal Transactions?](/docs/what-are-internal-transactions). @@ -57,9 +57,9 @@ These are transfers that occur where the `fromAddress` is an internal (smart con We also do not include miner rewards as an internal transfer. -### 6. Special NFT Transfers +### 6. Special NFT transfers -The special NFT endpoint allows users to query for NFTs that don't follow any ERC standards. The 2 included NFTs currently are CryptoPunks and CryptoKitties, which both predate current NFT standards. +The special NFT endpoint lets you query for NFTs that don't follow any ERC standards. The two included NFTs currently are CryptoPunks and CryptoKitties, which both predate current NFT standards. ## Pagination @@ -78,7 +78,7 @@ In the second case, you will also receive a value for `pageKey` in the response, ## How to get timestamps for a transaction? -A transaction object will have a block number associated with it, the block number is the blockchain's measure of time, however, if you want a standard timestamp you can easily get that by specifying `withMetadata=true` in your `alchemy_getAssetTransfers` \*\*request, or make a second call to `eth_getBlockByNumber`, passing in the `blockNum` field from the `alchemy_getAssetTransfers` \*\*response payload. +A transaction object will have a block number associated with it, the block number is the blockchain's measure of time, however, if you want a standard timestamp you can get that by specifying `withMetadata=true` in your `alchemy_getAssetTransfers` \*\*request, or make a second call to `eth_getBlockByNumber`, passing in the `blockNum` field from the `alchemy_getAssetTransfers` \*\*response payload. Surprisingly, a block's timestamp is actually the time that the **previous** **block** was mined not the block that the timestamp is contained within. So for Ethereum Mainnet, blocks tend to actually be mined around 14 seconds after their timestamps. @@ -88,12 +88,12 @@ A transaction object will have a block number associated with it, the block numb By default the Transfers API returns transactions in ascending order so from oldest --> newest transactions. However if you wish to change the order to be from newest --> oldest transactions you can do so by specifying the `order` parameter to `desc`. -## Why does my ERC721 transfer have 0 value? +## Why does my ERC-721 transfer have 0 value? There are typically two transfers that happen with NFTs: 1. The transfer of the token from the previous owner to the new owner -2. The purchase or sale of the NFT token (the transfer of value between the new and previous owner) ERC721 token transfers only capture the first type of transfer (token) not the second type (sale). If you want to see the second type and the transaction was made in ETH you'll need to include `external` transfer types in your request. If the transaction was made in another erc20 token you should include `erc20` transfer types in your request. +2. The purchase or sale of the NFT token (the transfer of value between the new and previous owner) ERC-721 token transfers only capture the first type of transfer (token) not the second type (sale). If you want to see the second type and the transaction was made in ETH you'll need to include `external` transfer types in your request. If the transaction was made in another erc20 token you should include `erc20` transfer types in your request. ## What are the different types of block tags? diff --git a/content/api-reference/data/webhooks/webhooks-overview.mdx b/content/api-reference/data/webhooks/webhooks-overview.mdx index 6864416fc..2bdc5e75e 100644 --- a/content/api-reference/data/webhooks/webhooks-overview.mdx +++ b/content/api-reference/data/webhooks/webhooks-overview.mdx @@ -9,9 +9,9 @@ slug: reference/webhooks-overview Alchemy provides a set of webhooks for tracking address activity and gas prices on several blockchains. -Developers can manually create webhooks from within the dashboard, or programmatically create webhooks to track activity for 10+ addresses using the Notify API. +You can manually create webhooks from within the Alchemy Dashboard, or programmatically create webhooks to track activity for 10+ addresses using the Notify API. -Alchemy Webhooks provide real-time notifications for primarily on-chain data. They're often used to stream on-chain activity for a set of wallets, events and traces on a set of smart contracts, and all block data for a particular chain, but are customizable to your many different use cases! Here are a few quick-links and an introduction video: +Alchemy webhooks provide real-time notifications for primarily onchain data. They're often used to stream onchain activity for a set of wallets, events and traces on a set of smart contracts, and all block data for a particular chain, but are customizable to many different use cases. Here are a few quick links and an introduction video: * [Webhook Types](/docs/reference/webhook-types) * [How to Set up Webhooks](/docs/reference/notify-api-quickstart#how-to-set-up-webhooks) @@ -24,9 +24,9 @@ Alchemy Webhooks provide real-time notifications for primarily on-chain data. Th | Webhook Type | Description | | ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [Custom](/docs/reference/custom-webhook) | Custom Webhooks allows you to track any smart contract or marketplace activity, monitor any contract creation, or any other on-chain interaction. This gives you infinite data access with precise filter controls to get the blockchain data you need. | -| [Address Activity](/docs/reference/address-activity-webhook) | Alchemy's Address Activity webhook tracks all ETH, ERC20, ERC721 and ERC1155 transfers. This provides your app with real-time state changes when an address sends/receives tokens or ETH. Specify the addresses for which you want to track this activity via API as well. A maximum of 100,000 addresses can be added to a single webhook. | -| [NFT Activity](/docs/reference/nft-activity-webhook) | The NFT Activity webhook allows you to track ERC721 and ERC1155 token contracts for NFTs. This provides your app with real-time state changes when an NFT is transferred between addresses. | +| [Custom](/docs/reference/custom-webhook) | Custom webhooks let you track any smart contract or marketplace activity, monitor any contract creation, or any other onchain interaction. This gives you infinite data access with precise filter controls to get the blockchain data you need. | +| [Address Activity](/docs/reference/address-activity-webhook) | Alchemy's Address Activity webhook tracks all ETH, ERC-20, ERC-721 and ERC-1155 transfers. This provides your app with real-time state changes when an address sends/receives tokens or ETH. Specify the addresses you want to track via API as well. A maximum of 100,000 addresses can be added to a single webhook. | +| [NFT Activity](/docs/reference/nft-activity-webhook) | The NFT Activity webhook lets you track ERC-721 and ERC-1155 token contracts for NFTs. This provides your app with real-time state changes when an NFT is transferred between addresses. | Check the [Chains](https://dashboard.alchemy.com/chains) page for details about product and chain support! @@ -34,7 +34,7 @@ Alchemy Webhooks provide real-time notifications for primarily on-chain data. Th ![](https://alchemyapi-res.cloudinary.com/image/upload/v1764179964/docs/api-reference/alchemy-transact/transaction-simulation/523fb8a9a9d899921ee1046d0ff1b389967a9976d1c6112ebbbe071ddd1ef374-image.png) -## V2 Webhook +## V2 webhook ### Field definitions @@ -60,7 +60,7 @@ Alchemy Webhooks provide real-time notifications for primarily on-chain data. Th ``` -## V1 Webhook Event Object +## V1 webhook event object ### Field definitions @@ -74,7 +74,7 @@ Alchemy Webhooks provide real-time notifications for primarily on-chain data. Th For Webhooks full dependencies and more code examples, \[go to the GitHub repo] ([https://github.com/alchemyplatform/webhook-examples](https://github.com/alchemyplatform/webhook-examples)). -### Example Response +### Example response ```shell v1 diff --git a/content/api-reference/debug-api/debug-api-quickstart.mdx b/content/api-reference/debug-api/debug-api-quickstart.mdx index 453d01785..4b84dca2a 100644 --- a/content/api-reference/debug-api/debug-api-quickstart.mdx +++ b/content/api-reference/debug-api/debug-api-quickstart.mdx @@ -80,7 +80,7 @@ Common use cases for the Debug API come in all flavors. Below are popular ones: ### `SUICIDE` * `SUICIDE` is captured when a smart contract is destroyed. That is when the [selfdestruct](https://solidity-by-example.org/hacks/self-destruct/) function of Solidity is used. -* `SUICIDE` transfers the contract's balance to the `address` specified in the `selfdestruct` function clearing on-chain memory. +* `SUICIDE` transfers the contract's balance to the `address` specified in the `selfdestruct` function clearing onchain memory. * The cleared memory is processed as a refund of the total gas cost to complete the transaction. #### Example response diff --git a/content/api-reference/degen/degen-api-faq.mdx b/content/api-reference/degen/degen-api-faq.mdx index 89c835ef3..84ec4bb2f 100644 --- a/content/api-reference/degen/degen-api-faq.mdx +++ b/content/api-reference/degen/degen-api-faq.mdx @@ -12,22 +12,22 @@ Degen Chain is an Arbitrum-based Layer-3 that settles on Base and uses DEGEN as Check out our [Degen API Quickstart guide](/docs/reference/degen-api-quickstart) to get started building on Degen. ## What is the Degen API? -The Degen API allows developers to interface with the Degen mainnet. With this API, developers can execute transactions, query on-chain data, and interact with the Degen network, relying on a JSON-RPC standard. +The Degen API lets you interface with the Degen mainnet. With this API, you can execute transactions, query onchain data, and interact with the Degen network using the JSON-RPC standard. ## Is Degen EVM compatible? Yes, Degen is EVM compatible. ## What API does Degen use? -Degen uses the JSON-RPC API standard. This API is crucial for any blockchain interaction on the Degen network, allowing users to read block/transaction data, query chain information, execute smart contracts, and store data on-chain. +Degen uses the JSON-RPC API standard. This API is essential for any blockchain interaction on the Degen network, allowing you to read block/transaction data, query chain information, execute smart contracts, and store data onchain. ## What methods are supported on Degen? Degen supports standard Ethereum JSON-RPC methods. Some chain-specific methods may vary. Please check the [Degen API Endpoints](/docs/chains#degen-apis) for a complete list. ## What is a Degen API key? -When accessing the Degen network via a node provider like Alchemy, Degen developers use an API key to send transactions and retrieve data from the network. For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup)! +When accessing the Degen network via a node provider like Alchemy, you use an API key to send transactions and retrieve data from the network. For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup). ## Which libraries support Degen? Common Ethereum libraries like [ethers.js](https://docs.ethers.org/v5/) should be compatible with Degen, given its EVM nature. ## My question isn’t here, where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/degen/degen-api-quickstart.mdx b/content/api-reference/degen/degen-api-quickstart.mdx index 0b9fb06d4..53e19245e 100644 --- a/content/api-reference/degen/degen-api-quickstart.mdx +++ b/content/api-reference/degen/degen-api-quickstart.mdx @@ -12,9 +12,9 @@ slug: reference/degen-api-quickstart Degen Chain is an Arbitrum–based Layer-3 that settles on Base and uses DEGEN as gas, delivering ultra-low-cost transactions for Farcaster mini-apps and trading-style apps. -The Degen API allows interaction with the Degen network through a set of JSON-RPC methods. Its design is familiar to developers who have worked with Ethereum's JSON-RPC APIs, making it intuitive and straightforward to use. +The Degen API lets you interact with the Degen network through a set of JSON-RPC methods. If you've worked with Ethereum's JSON-RPC APIs, the design will feel familiar. -## Send Your First Request on Alchemy +## Send your first request on Alchemy Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a Degen client connected to Alchemy and fetch the latest block number! @@ -28,7 +28,7 @@ Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a D ``` -## Create Client Connected to Alchemy +## Create a client connected to Alchemy ```js @@ -44,7 +44,7 @@ const client = createPublicClient({ Now that you've created a client connected to Alchemy, you can continue with some basics: -## Get Latest Block Number +## Get the latest block number ```js @@ -53,7 +53,7 @@ console.log("Current block number:", blockNumber); ``` -## Get an Address Balance +## Get an address balance ```js @@ -62,7 +62,7 @@ console.log("Balance (DEGEN):", Number(balance) / 1e18); ``` -## Read Block Data +## Read block data ```js @@ -73,7 +73,7 @@ console.log(block); ``` -## Fetch a Transaction by Hash +## Fetch a transaction by hash ```js @@ -82,7 +82,7 @@ console.log(tx); ``` -## Fetch Transaction Receipt +## Fetch a transaction receipt ```js diff --git a/content/api-reference/ethereum/ethereum-api-faq/ethereum-api-faq.mdx b/content/api-reference/ethereum/ethereum-api-faq/ethereum-api-faq.mdx index fffd71e47..7a88b2c2f 100644 --- a/content/api-reference/ethereum/ethereum-api-faq/ethereum-api-faq.mdx +++ b/content/api-reference/ethereum/ethereum-api-faq/ethereum-api-faq.mdx @@ -5,25 +5,25 @@ subtitle: Frequently Asked Questions about the Ethereum API slug: reference/ethereum-api-faq --- -## What testnet should developers use for Ethereum development? +## What testnet should you use for Ethereum development? -All developers getting started on Alchemy should use **Sepolia** as their testnet of choice for development! +If you're getting started on Alchemy, use **Sepolia** as your testnet of choice for development. The Ethereum Foundation winded down support for the Rinkeby, Ropsten, and Kovan networks after Ethereum's transition to a proof-of-stake model and the Goerli testnet is also deprecated. To ensure that your testnet applications remain fully functional after the transition, we recommend using Sepolia, which will remain unchanged. Learn more at [Choosing a Web3 Network](/docs/choosing-a-web3-network). ## What API does Ethereum use? -Ethereum uses the JSON-RPC API standard. The Ethereum JSON-RPC API serves as the backbone for the Ethereum network and powers any blockchain interaction. In aggregate, this API suite allows users to read block/transaction data, query chain information, execute smart contracts, store data on-chain, etc. Developers and consumers alike interact with Ethereum’s base JSON-RPC APIs to communicate with its decentralized network of nodes. +Ethereum uses the JSON-RPC API standard. The Ethereum JSON-RPC API serves as the backbone for the Ethereum network and powers any blockchain interaction. This API suite lets you read block/transaction data, query chain information, execute smart contracts, store data onchain, and more. You interact with Ethereum’s base JSON-RPC APIs to communicate with its decentralized network of nodes. -## What is an Ethereum API Key? +## What is an Ethereum API key? -When accessing the Ethereum network via a node provider, API services like Alchemy require an API key, which allows developers to monitor personal apps and access usage metrics. +When accessing the Ethereum network via a node provider, API services like Alchemy require an API key, which lets you monitor your apps and access usage metrics. While many Ethereum development environments have a set of default shared API keys, they are often throttled during periods of high usage leading to slower response times and a higher likelihood of request failures. -For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup)! +For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup). -With a dedicated API key, developers are able to: +With a dedicated API key, you can: * access **higher request throughput** and **increased concurrent requests**. * query [Data APIs](/docs/reference/data-overview), gaining access to free archive data, logs, and higher-level API abstractions. @@ -31,7 +31,7 @@ With a dedicated API key, developers are able to: ## Does Ethereum only use JSON-RPC? -The raw Ethereum client only uses JSON-RPC notation to encode remote procedure calls for interpreting requests and serving up responses. However, most developers use libraries that actually abstract away the JSON-RPC standard. +The raw Ethereum client only uses JSON-RPC notation to encode remote procedure calls for interpreting requests and serving up responses. However, most libraries actually abstract away the JSON-RPC standard. ## How does Alchemy's Ethereum API work? @@ -43,13 +43,13 @@ If you’re not familiar with [how a blockchain works](/docs/blockchain-101), he * Blocks are stored on distributed Ethereum nodes. * Each node in the network serves as a “mini-server” that allows its operator to read/write blocks of data. -Alchemy provides access to our higher-level infrastructure that allows developers to interface with the Ethereum network. With API access, Alchemy developers are able to send read/write requests to the blockchain. +Alchemy provides access to our higher-level infrastructure that lets you interface with the Ethereum network. With API access, you can send read/write requests to the blockchain. -We take care of the hard stuff so that developers can focus on their products! +We take care of the hard stuff so you can focus on your product. ## Can you use Python for Ethereum? -Yes! While Javascript libraries have historically gained traction in the Ethereum development community, Python developers are also able to read and write the same data. One commonly used blockchain interaction library is web3.py which wraps many of the same methods featured in web3.js and Ethers.js. +Yes! While JavaScript libraries have historically gained traction in the Ethereum development community, you can also use Python to read and write the same data. One commonly used blockchain interaction library is web3.py which wraps many of the same methods featured in web3.js and Ethers.js. For Python-based EVM development, [Brownie](https://eth-brownie.readthedocs.io/en/stable/) offers a full suite of Web3 developer tools for compiling, testing, and deploying dApps similar to its peer environments Hardhat and Truffle. @@ -64,11 +64,11 @@ There are three steps to get the timestamp for a transaction: Here is an [example request](https://composer.alchemy.com/?composer_state=%7B%22network%22%3A0%2C%22methodName%22%3A%22eth_getBlockByNumber%22%2C%22paramValues%22%3A%5B%22latest%22%2Cfalse%5D%7D). -It's important to note that block numbers themselves are Ethereum's measure of time, however standard timestamps are available by looking at the block data. +Block numbers themselves are Ethereum's measure of time, however standard timestamps are available by looking at the block data. ## How do I distinguish between a contract address and a wallet address? -A super easy way to distinguish between a contract address and a wallet address is by calling [eth\_getCode](/docs/reference/eth-getcode), which will return contract code if it's a contract and nothing if it's a wallet. Here's an example of both using our composer tool: +A quick way to distinguish between a contract address and a wallet address is by calling [eth\_getCode](/docs/reference/eth-getcode), which returns contract code if it's a contract and nothing if it's a wallet. Here's an example of both using our composer tool: * [**0x Contract Address**](https://composer.alchemy.com/?composer_state=%7B%22network%22%3A0%2C%22methodName%22%3A%22eth_getCode%22%2C%22paramValues%22%3A%5B%220xe41d2489571d322189246dafa5ebde1f4699f498%22%2C%22latest%22%5D%7D) * [**Vitalik's Wallet Address**](https://composer.alchemy.com/?composer_state=%7B%22network%22%3A0%2C%22methodName%22%3A%22eth_getCode%22%2C%22paramValues%22%3A%5B%220xAb5801a7D398351b8bE11C439e05C5B3259aeC9B%22%2C%22latest%22%5D%7D) @@ -91,7 +91,7 @@ However, if this were a QUANTITY, a valid input would be: "0x3" ``` -## What is the Default Block Parameter? +## What is the default block parameter? The default block parameter is used to specify the block height in your request. It is an additional parameter on all of the following methods: @@ -114,4 +114,4 @@ You can find the list of all the methods Alchemy support for the Ethereum API on ## My question isn't here, where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/ethereum/ethereum-api-quickstart.mdx b/content/api-reference/ethereum/ethereum-api-quickstart.mdx index 5e147936b..1aea7fde5 100644 --- a/content/api-reference/ethereum/ethereum-api-quickstart.mdx +++ b/content/api-reference/ethereum/ethereum-api-quickstart.mdx @@ -10,9 +10,9 @@ slug: reference/ethereum-api-quickstart get started today. -The Ethereum API allows applications to connect to an Ethereum node that is part of the Ethereum blockchain. Developers can interact with on-chain data and send different types of transactions to the network by utilizing the endpoints provided by the API. +The Ethereum API lets your application connect to an Ethereum node that is part of the Ethereum blockchain. You can interact with onchain data and send different types of transactions to the network using the endpoints provided by the API. -## Send Your First Request on Alchemy +## Send your first request on Alchemy Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create an Ethereum client connected to Alchemy and fetch the latest block number! @@ -26,7 +26,7 @@ Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create an ``` -## Create Client Connected to Alchemy +## Create a client connected to Alchemy ```js @@ -42,7 +42,7 @@ const client = createPublicClient({ Now that you've created a client connected to Alchemy, you can continue with some basics: -## Get Latest Block Number +## Get the latest block number ```js @@ -51,7 +51,7 @@ console.log("Current block number:", blockNumber); ``` -## Get an Address Balance +## Get an address balance ```js @@ -60,7 +60,7 @@ console.log("Balance (ETH):", Number(balance) / 1e18); ``` -## Read Block Data +## Read block data ```js @@ -71,7 +71,7 @@ console.log(block); ``` -## Fetch a Transaction by Hash +## Fetch a transaction by hash ```js @@ -80,7 +80,7 @@ console.log(tx); ``` -## Fetch Transaction Receipt +## Fetch a transaction receipt ```js @@ -91,7 +91,7 @@ console.log(receipt); ``` -# Ethereum Tutorials +# Ethereum tutorials Check out the following tutorials to learn how to build with Ethereum: diff --git a/content/api-reference/flow/flow-api-faq.mdx b/content/api-reference/flow/flow-api-faq.mdx index f4cc2a7b3..0307d1fa8 100644 --- a/content/api-reference/flow/flow-api-faq.mdx +++ b/content/api-reference/flow/flow-api-faq.mdx @@ -17,9 +17,9 @@ The Flow API enables interaction with the Flow network through JSON-RPC methods. Refer to the [Flow API Quickstart guide](/docs/reference/flow-evm-api-quickstart) for setup instructions. -## Is Flow EVM-Compatible? +## Is Flow EVM-compatible? -Flow supports full EVM equivalence. Solidity contracts work out of the box on Flow and can access Flow's protocol benefits without code changes. That means solidity devs and can easily tap into Flow's user base and unique IPs without any implementation risk. +Flow supports full EVM equivalence. Solidity contracts work out of the box on Flow and can access Flow's protocol benefits without code changes. That means Solidity devs can tap into Flow's user base and unique IPs without any implementation risk. ## What API does Flow use? @@ -27,13 +27,13 @@ Flow uses a JSON-RPC API standard tailored to its multi-role architecture. ## What is a Flow API key? -When accessing Flow via a node provider, developers use an API key to interact with the network. +When accessing Flow via a node provider, you use an API key to interact with the network. -For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup)! +For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup). ## What programming languages work with Flow? -Flow uses Cadence, a resource-oriented programming language, for smart contracts. For off-chain interactions and dApp development, developers typically use JavaScript, TypeScript, or other web development languages. Flow now also works with Solidity. +Flow uses Cadence, a resource-oriented programming language, for smart contracts. For offchain interactions and dApp development, you can use JavaScript, TypeScript, or other web development languages. Flow now also works with Solidity. ## Which libraries support Flow? @@ -49,4 +49,4 @@ Refer to the [Flow API Endpoints](/docs/chains#flow-apis) for a complete list of ## Where can I get additional help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/flow/flow-api-quickstart.mdx b/content/api-reference/flow/flow-api-quickstart.mdx index 83da03c2d..17d8e689d 100644 --- a/content/api-reference/flow/flow-api-quickstart.mdx +++ b/content/api-reference/flow/flow-api-quickstart.mdx @@ -12,9 +12,9 @@ slug: reference/flow-evm-api-quickstart Flow is a blockchain designed for the next generation of apps, games, and digital assets. Known for its high performance, scalability, and developer-friendly features, Flow offers a robust environment for deploying decentralized applications (dApps). -The Flow API facilitates interaction with the Flow network through a collection of JSON-RPC methods. Given its developer-friendly design, those familiar with Ethereum's JSON-RPC APIs will find working with Flow intuitive and straightforward. +The Flow API lets you interact with the Flow network through a collection of JSON-RPC methods. If you're familiar with Ethereum's JSON-RPC APIs, working with Flow is intuitive and straightforward. -## Send Your First Request on Alchemy +## Send your first request on Alchemy Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a Flow EVM client connected to Alchemy and fetch the latest block number! @@ -28,7 +28,7 @@ Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a F ``` -## Create Client Connected to Alchemy +## Create a client connected to Alchemy ```js @@ -44,7 +44,7 @@ const client = createPublicClient({ Now that you've created a client connected to Alchemy, you can continue with some basics: -## Get Latest Block Number +## Get the latest block number ```js @@ -53,7 +53,7 @@ console.log("Current block number:", blockNumber); ``` -## Get an Address Balance +## Get an address balance ```js @@ -62,7 +62,7 @@ console.log("Balance (FLOW):", Number(balance) / 1e18); ``` -## Read Block Data +## Read block data ```js @@ -73,7 +73,7 @@ console.log(block); ``` -## Fetch a Transaction by Hash +## Fetch a transaction by hash ```js @@ -82,7 +82,7 @@ console.log(tx); ``` -## Fetch Transaction Receipt +## Fetch a transaction receipt ```js diff --git a/content/api-reference/frax/frax-api-faq.mdx b/content/api-reference/frax/frax-api-faq.mdx index 9d6f00574..73a05539f 100644 --- a/content/api-reference/frax/frax-api-faq.mdx +++ b/content/api-reference/frax/frax-api-faq.mdx @@ -6,28 +6,28 @@ slug: reference/frax-api-faq --- ## What is Frax? -Fraxtal (Frax Chain) is an EVM-equivalent Layer-2 built on Optimism’s OP Stack that uses FRAX as gas and rewards on-chain activity via Flox/FXTL to scale the Frax ecosystem. +Fraxtal (Frax Chain) is an EVM-equivalent Layer-2 built on Optimism’s OP Stack that uses FRAX as gas and rewards onchain activity via Flox/FXTL to scale the Frax ecosystem. ## How do I get started with Frax? Check out our [Frax API Quickstart guide](/docs/reference/frax-api-quickstart) to get started building on Frax. ## What is the Frax API? -The Frax API allows developers to interface with the Frax mainnet. With this API, developers can execute transactions, query on-chain data, and interact with the Frax network, relying on a JSON-RPC standard. +The Frax API lets you interface with the Frax mainnet. With this API, you can execute transactions, query onchain data, and interact with the Frax network using the JSON-RPC standard. ## Is Frax EVM compatible? Yes, Frax is EVM compatible. ## What API does Frax use? -Frax uses the JSON-RPC API standard. This API is crucial for any blockchain interaction on the Frax network, allowing users to read block/transaction data, query chain information, execute smart contracts, and store data on-chain. +Frax uses the JSON-RPC API standard. This API is essential for any blockchain interaction on the Frax network, allowing you to read block/transaction data, query chain information, execute smart contracts, and store data onchain. ## What methods are supported on Frax? Fraxtal supports standard Ethereum JSON-RPC methods. Some chain-specific methods may vary. Please check the [Fraxtal API Endpoints](/docs/chains#fraxtal-apis) for a complete list. ## What is a Frax API key? -When accessing the Frax network via a node provider like Alchemy, Frax developers use an API key to send transactions and retrieve data from the network. For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup)! +When accessing the Frax network via a node provider like Alchemy, you use an API key to send transactions and retrieve data from the network. For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup). ## Which libraries support Frax? Common Ethereum libraries like [ethers.js](https://docs.ethers.org/v5/) should be compatible with Frax, given its EVM nature. ## My question isn’t here, where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/frax/frax-api-quickstart.mdx b/content/api-reference/frax/frax-api-quickstart.mdx index 88b3a3d6a..5c8660aa7 100644 --- a/content/api-reference/frax/frax-api-quickstart.mdx +++ b/content/api-reference/frax/frax-api-quickstart.mdx @@ -10,11 +10,11 @@ slug: reference/frax-api-quickstart get started today. -Fraxtal (Frax Chain) is an EVM-equivalent Layer-2 built on Optimism's OP Stack that uses FRAX as gas and rewards on-chain activity via Flox/FXTL to scale the Frax ecosystem. +Fraxtal (Frax Chain) is an EVM-equivalent Layer-2 built on Optimism's OP Stack that uses FRAX as gas and rewards onchain activity via Flox/FXTL to scale the Frax ecosystem. -The Fraxtal API allows interaction with the Fraxtal network through a set of JSON-RPC methods. Its design is familiar to developers who have worked with Ethereum's JSON-RPC APIs, making it intuitive and straightforward to use. +The Fraxtal API lets you interact with the Fraxtal network through a set of JSON-RPC methods. If you've worked with Ethereum's JSON-RPC APIs, the design will feel familiar. -## Send Your First Request on Alchemy +## Send your first request on Alchemy Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a Fraxtal client connected to Alchemy and fetch the latest block number! @@ -28,7 +28,7 @@ Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a F ``` -## Create Client Connected to Alchemy +## Create a client connected to Alchemy ```js @@ -44,7 +44,7 @@ const client = createPublicClient({ Now that you've created a client connected to Alchemy, you can continue with some basics: -## Get Latest Block Number +## Get the latest block number ```js @@ -53,7 +53,7 @@ console.log("Current block number:", blockNumber); ``` -## Get an Address Balance +## Get an address balance ```js @@ -62,7 +62,7 @@ console.log("Balance (frxETH):", Number(balance) / 1e18); ``` -## Read Block Data +## Read block data ```js @@ -73,7 +73,7 @@ console.log(block); ``` -## Fetch a Transaction by Hash +## Fetch a transaction by hash ```js @@ -82,7 +82,7 @@ console.log(tx); ``` -## Fetch Transaction Receipt +## Fetch a transaction receipt ```js diff --git a/content/api-reference/geist/geist-deprecation-notice.mdx b/content/api-reference/geist/geist-deprecation-notice.mdx index ebe6f2a4c..8b529b803 100644 --- a/content/api-reference/geist/geist-deprecation-notice.mdx +++ b/content/api-reference/geist/geist-deprecation-notice.mdx @@ -10,7 +10,7 @@ slug: reference/geist-deprecation-notice Effective immediately, all Geist network services are being phased out, including JSON-RPC API endpoints and network infrastructure. -## Migration Options +## Migration options We strongly recommend migrating to **Base**, as the Aavegotchi ecosystem (Geist's primary use case) has officially moved there following a community vote. @@ -22,9 +22,9 @@ We strongly recommend migrating to **Base**, as the Aavegotchi ecosystem (Geist' * **[Polygon](/docs/reference/polygon-pos-api-quickstart)**: For other gaming and NFT applications * **[Ethereum](/docs/reference/ethereum-api-quickstart)**: For scalable Ethereum applications -## Next Steps +## Next steps 1. Choose an alternative network for your application 2. Update your API endpoints and configuration -3. Contact support through the [Alchemy dashboard](https://dashboard.alchemy.com) if you need assistance +3. Contact support through the [Alchemy Dashboard](https://dashboard.alchemy.com) if you need assistance diff --git a/content/api-reference/gensyn/gensyn-api-faq.mdx b/content/api-reference/gensyn/gensyn-api-faq.mdx index f0fb12d01..b25861453 100644 --- a/content/api-reference/gensyn/gensyn-api-faq.mdx +++ b/content/api-reference/gensyn/gensyn-api-faq.mdx @@ -6,28 +6,28 @@ slug: reference/gensyn-api-faq --- ## What is Gensyn? -Gensyn Chain is an EVM-compatible custom Ethereum rollup purpose-built for machine learning—coordinating jobs, verifying training, and paying compute providers on-chain. +Gensyn Chain is an EVM-compatible custom Ethereum rollup purpose-built for machine learning -- coordinating jobs, verifying training, and paying compute providers onchain. ## How do I get started with Gensyn? Check out our [Gensyn API Quickstart guide](/docs/reference/gensyn-api-quickstart) to get started building on Gensyn. ## What is the Gensyn API? -The Gensyn API allows developers to interface with the Gensyn mainnet. With this API, developers can execute transactions, query on-chain data, and interact with the Gensyn network, relying on a JSON-RPC standard. +The Gensyn API lets you interface with the Gensyn mainnet. With this API, you can execute transactions, query onchain data, and interact with the Gensyn network using the JSON-RPC standard. ## Is Gensyn EVM compatible? Yes, Gensyn is EVM compatible. ## What API does Gensyn use? -Gensyn uses the JSON-RPC API standard. This API is crucial for any blockchain interaction on the Gensyn network, allowing users to read block/transaction data, query chain information, execute smart contracts, and store data on-chain. +Gensyn uses the JSON-RPC API standard. This API is essential for any blockchain interaction on the Gensyn network, allowing you to read block/transaction data, query chain information, execute smart contracts, and store data onchain. ## What methods are supported on Gensyn? Gensyn supports standard Ethereum JSON-RPC methods. Some chain-specific methods may vary. Please check the [Gensyn API Endpoints](/docs/chains#gensyn-apis) for a complete list. ## What is a Gensyn API key? -When accessing the Gensyn network via a node provider like Alchemy, Gensyn developers use an API key to send transactions and retrieve data from the network. For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup)! +When accessing the Gensyn network via a node provider like Alchemy, you use an API key to send transactions and retrieve data from the network. For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup). ## Which libraries support Gensyn? Common Ethereum libraries like [ethers.js](https://docs.ethers.org/v5/) should be compatible with Gensyn, given its EVM nature. ## My question isn’t here, where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/gensyn/gensyn-api-quickstart.mdx b/content/api-reference/gensyn/gensyn-api-quickstart.mdx index 580dc1ed1..c335640c9 100644 --- a/content/api-reference/gensyn/gensyn-api-quickstart.mdx +++ b/content/api-reference/gensyn/gensyn-api-quickstart.mdx @@ -10,11 +10,11 @@ slug: reference/gensyn-api-quickstart get started today. -Gensyn Chain is an EVM-compatible custom Ethereum rollup purpose-built for machine learning—coordinating jobs, verifying training, and paying compute providers on-chain. +Gensyn Chain is an EVM-compatible custom Ethereum rollup purpose-built for machine learning -- coordinating jobs, verifying training, and paying compute providers onchain. -The Gensyn API allows interaction with the Gensyn network through a set of JSON-RPC methods. Its design is familiar to developers who have worked with Ethereum's JSON-RPC APIs, making it intuitive and straightforward to use. +The Gensyn API lets you interact with the Gensyn network through a set of JSON-RPC methods. If you've worked with Ethereum's JSON-RPC APIs, the design will feel familiar. -## Send Your First Request on Alchemy +## Send your first request on Alchemy Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a Gensyn client connected to Alchemy and fetch the latest block number! @@ -28,7 +28,7 @@ Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a G ``` -## Create Client Connected to Alchemy +## Create a client connected to Alchemy ```js @@ -52,7 +52,7 @@ const client = createPublicClient({ Now that you've created a client connected to Alchemy, you can continue with some basics: -## Get Latest Block Number +## Get the latest block number ```js @@ -61,7 +61,7 @@ console.log("Current block number:", blockNumber); ``` -## Get an Address Balance +## Get an address balance ```js @@ -70,7 +70,7 @@ console.log("Balance (ETH):", Number(balance) / 1e18); ``` -## Read Block Data +## Read block data ```js @@ -81,7 +81,7 @@ console.log(block); ``` -## Fetch a Transaction by Hash +## Fetch a transaction by hash ```js @@ -90,7 +90,7 @@ console.log(tx); ``` -## Fetch Transaction Receipt +## Fetch a transaction receipt ```js diff --git a/content/api-reference/gnosis/gnosis-chain-api-quickstart.mdx b/content/api-reference/gnosis/gnosis-chain-api-quickstart.mdx index 026cce862..f57440e0a 100644 --- a/content/api-reference/gnosis/gnosis-chain-api-quickstart.mdx +++ b/content/api-reference/gnosis/gnosis-chain-api-quickstart.mdx @@ -12,9 +12,9 @@ slug: reference/gnosis-api-quickstart Gnosis Chain (formerly xDai) is an EVM-compatible blockchain known for its stable and low-cost transactions. Designed to support the needs of decentralized applications (dApps), Gnosis Chain provides a reliable and efficient environment for deploying Ethereum-based applications. -The Gnosis Chain API facilitates interaction with the Gnosis Chain network through a collection of JSON-RPC methods. Given its compatibility with the Ethereum ecosystem, developers familiar with Ethereum's JSON-RPC APIs will find working with Gnosis Chain both intuitive and straightforward. +The Gnosis Chain API lets you interact with the Gnosis Chain network through a collection of JSON-RPC methods. If you're familiar with Ethereum's JSON-RPC APIs, working with Gnosis Chain is intuitive and straightforward. -## Send Your First Request on Alchemy +## Send your first request on Alchemy Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a Gnosis Chain client connected to Alchemy and fetch the latest block number! @@ -28,7 +28,7 @@ Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a G ``` -## Create Client Connected to Alchemy +## Create a client connected to Alchemy ```js @@ -44,7 +44,7 @@ const client = createPublicClient({ Now that you've created a client connected to Alchemy, you can continue with some basics: -## Get Latest Block Number +## Get the latest block number ```js @@ -53,7 +53,7 @@ console.log("Current block number:", blockNumber); ``` -## Get an Address Balance +## Get an address balance ```js @@ -62,7 +62,7 @@ console.log("Balance (xDAI):", Number(balance) / 1e18); ``` -## Read Block Data +## Read block data ```js @@ -73,7 +73,7 @@ console.log(block); ``` -## Fetch a Transaction by Hash +## Fetch a transaction by hash ```js @@ -82,7 +82,7 @@ console.log(tx); ``` -## Fetch Transaction Receipt +## Fetch a transaction receipt ```js diff --git a/content/api-reference/gnosis/gnosis-chain-faq.mdx b/content/api-reference/gnosis/gnosis-chain-faq.mdx index 150cab62f..8568529ac 100644 --- a/content/api-reference/gnosis/gnosis-chain-faq.mdx +++ b/content/api-reference/gnosis/gnosis-chain-faq.mdx @@ -11,7 +11,7 @@ Gnosis Chain (formerly xDai) is a high-performance blockchain designed to offer ## What is the Gnosis Chain API? -The Gnosis Chain API facilitates interaction with the Gnosis Chain network through a collection of JSON-RPC methods. Given its compatibility with the Ethereum ecosystem, developers familiar with Ethereum's JSON-RPC APIs will find working with Gnosis Chain both intuitive and straightforward. +The Gnosis Chain API lets you interact with the Gnosis Chain network through a collection of JSON-RPC methods. Because it's compatible with the Ethereum ecosystem, you'll find working with Gnosis Chain familiar if you've used Ethereum's JSON-RPC APIs. ## How can I get started using the Gnosis Chain API? @@ -27,17 +27,17 @@ Gnosis Chain uses the JSON-RPC API standard for blockchain interactions. This is ## What is a Gnosis Chain API key? -When accessing the Gnosis Chain network via a node provider like Alchemy, developers use an API key to send transactions and retrieve data from the network. +When you access the Gnosis Chain network via a node provider like Alchemy, you use an API key to send transactions and retrieve data from the network. For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup)! ## Which libraries support Gnosis Chain? -Given Gnosis Chain's EVM compatibility, popular Ethereum libraries like ethers.js and web3.js are fully compatible with Gnosis Chain. This allows for seamless development and integration for those familiar with Ethereum's development ecosystem. +Because Gnosis Chain is EVM-compatible, popular Ethereum libraries like ethers.js and web3.js work with Gnosis Chain. If you're familiar with Ethereum's development ecosystem, you can integrate with minimal changes. ## What programming languages work with Gnosis Chain? -Similar to Ethereum, Gnosis Chain supports a range of programming languages for blockchain interaction and smart contract development, including Solidity for smart contracts, as well as JavaScript and TypeScript for dApp development and off-chain interactions. +Like Ethereum, Gnosis Chain supports a range of programming languages for blockchain interaction and smart contract development, including Solidity for smart contracts, as well as JavaScript and TypeScript for dApp development and offchain interactions. ## What does Gnosis Chain use for gas? @@ -49,4 +49,4 @@ You can find the list of all the methods Alchemy supports for the Gnosis Chain A ## My question isn't here, where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/humanity/humanity-api-faq.mdx b/content/api-reference/humanity/humanity-api-faq.mdx index ac98b64f7..4679c91d9 100644 --- a/content/api-reference/humanity/humanity-api-faq.mdx +++ b/content/api-reference/humanity/humanity-api-faq.mdx @@ -12,22 +12,22 @@ Humanity Protocol is a zkEVM Layer-2 for decentralized identity that uses palm-b Check out our [Humanity API Quickstart guide](/docs/reference/humanity-api-quickstart) to get started building on Humanity. ## What is the Humanity API? -The Humanity API allows developers to interface with the Humanity mainnet. With this API, developers can execute transactions, query on-chain data, and interact with the Humanity network, relying on a JSON-RPC standard. +The Humanity API lets you interface with the Humanity mainnet. You can execute transactions, query onchain data, and interact with the Humanity network using the JSON-RPC standard. ## Is Humanity EVM compatible? Yes, Humanity is EVM compatible. ## What API does Humanity use? -Humanity uses the JSON-RPC API standard. This API is crucial for any blockchain interaction on the Humanity network, allowing users to read block/transaction data, query chain information, execute smart contracts, and store data on-chain. +Humanity uses the JSON-RPC API standard. This API handles all blockchain interaction on the Humanity network, letting you read block/transaction data, query chain information, execute smart contracts, and store data onchain. ## What methods are supported on Humanity? Humanity supports standard Ethereum JSON-RPC methods. Some chain-specific methods may vary. Please check the [Humanity API Endpoints](/docs/chains#humanity-apis) for a complete list. ## What is a Humanity API key? -When accessing the Humanity network via a node provider like Alchemy, Humanity developers use an API key to send transactions and retrieve data from the network. For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup)! +When you access the Humanity network via a node provider like Alchemy, you use an API key to send transactions and retrieve data from the network. For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup)! ## Which libraries support Humanity? Common Ethereum libraries like [ethers.js](https://docs.ethers.org/v5/) should be compatible with Humanity, given its EVM nature. ## My question isn’t here, where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/humanity/humanity-api-quickstart.mdx b/content/api-reference/humanity/humanity-api-quickstart.mdx index 360cd18c1..20ce29caf 100644 --- a/content/api-reference/humanity/humanity-api-quickstart.mdx +++ b/content/api-reference/humanity/humanity-api-quickstart.mdx @@ -12,9 +12,9 @@ slug: reference/humanity-api-quickstart Humanity Protocol is a zkEVM Layer-2 for decentralized identity that uses palm-biometric Proof-of-Humanity and zero-knowledge proofs to issue privacy-preserving, Sybil-resistant credentials. -The Humanity API allows interaction with the Humanity network through a set of JSON-RPC methods. Its design is familiar to developers who have worked with Ethereum's JSON-RPC APIs, making it intuitive and straightforward to use. +The Humanity API lets you interact with the Humanity network through a set of JSON-RPC methods. If you've worked with Ethereum's JSON-RPC APIs, the design will feel familiar. -## Send Your First Request on Alchemy +## Send your first request on Alchemy Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a Humanity client connected to Alchemy and fetch the latest block number! @@ -28,7 +28,7 @@ Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a H ``` -## Create Client Connected to Alchemy +## Create a client connected to Alchemy ```js @@ -52,7 +52,7 @@ const client = createPublicClient({ Now that you've created a client connected to Alchemy, you can continue with some basics: -## Get Latest Block Number +## Get the latest block number ```js @@ -61,7 +61,7 @@ console.log("Current block number:", blockNumber); ``` -## Get an Address Balance +## Get an address balance ```js @@ -70,7 +70,7 @@ console.log("Balance (HMT):", Number(balance) / 1e18); ``` -## Read Block Data +## Read block data ```js @@ -81,7 +81,7 @@ console.log(block); ``` -## Fetch a Transaction by Hash +## Fetch a transaction by hash ```js @@ -90,7 +90,7 @@ console.log(tx); ``` -## Fetch Transaction Receipt +## Fetch a transaction receipt ```js diff --git a/content/api-reference/hyperliquid/hyperliquid-api-faq.mdx b/content/api-reference/hyperliquid/hyperliquid-api-faq.mdx index 5f34199fb..0a96b9914 100644 --- a/content/api-reference/hyperliquid/hyperliquid-api-faq.mdx +++ b/content/api-reference/hyperliquid/hyperliquid-api-faq.mdx @@ -15,7 +15,7 @@ Check out our [HyperEVM API Quickstart guide](/docs/reference/hyperliquid-api-qu ## What is the HyperEVM API? -The HyperEVM API allows developers to interface with the HyperEVM mainnet. With this API, developers can execute transactions, query on-chain data, and interact with the HyperEVM network, relying on a JSON-RPC standard. +The HyperEVM API lets you interface with the HyperEVM mainnet. You can execute transactions, query onchain data, and interact with the HyperEVM network using the JSON-RPC standard. ## Is HyperEVM EVM compatible? @@ -23,11 +23,11 @@ Yes, HyperEVM is EVM compatible. ## What API does HyperEVM use? -HyperEVM utilizes the JSON-RPC API standard. This API is crucial for any blockchain interaction on the HyperEVM network, allowing users to read block/transaction data, query chain information, execute smart contracts, and store data on-chain. +HyperEVM uses the JSON-RPC API standard. This API handles all blockchain interaction on the HyperEVM network, letting you read block/transaction data, query chain information, execute smart contracts, and store data onchain. ## What is a HyperEVM API key? -When accessing the HyperEVM network via a node provider like Alchemy, HyperEVM developers use an API key to send transactions and retrieve data from the network. +When you access the HyperEVM network via a node provider like Alchemy, you use an API key to send transactions and retrieve data from the network. For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup)! @@ -37,7 +37,7 @@ Common Ethereum libraries like [ethers.js](https://docs.ethers.org/v5/) and [web ## What programming languages work with HyperEVM? -Languages that work with Ethereum, such as Javascript, Solidity, Typescript, and Shell, should also be compatible with HyperEVM. Solidity remains the primary choice for smart contract development, while Javascript is ideal for off-chain interactions. +Languages that work with Ethereum, such as JavaScript, Solidity, TypeScript, and Shell, should also be compatible with HyperEVM. Solidity remains the primary choice for smart contract development, while JavaScript is ideal for offchain interactions. ## What does HyperEVM use for gas? @@ -49,4 +49,4 @@ You can find the list of all the methods Alchemy supports for the HyperEVM API o ## My question isn't here, where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/hyperliquid/hyperliquid-api-quickstart.mdx b/content/api-reference/hyperliquid/hyperliquid-api-quickstart.mdx index 1aaf5b059..b06158c67 100644 --- a/content/api-reference/hyperliquid/hyperliquid-api-quickstart.mdx +++ b/content/api-reference/hyperliquid/hyperliquid-api-quickstart.mdx @@ -10,13 +10,13 @@ slug: reference/hyperliquid-api-quickstart get started today. -Checkout the [Hyperliquid Alchemy Wallets Guide](https://www.alchemy.com/docs/wallets/recipes/hyperliquid-wallets) for enabling email and social login for user authentication, and the ability to sign and send transactions seamlessly. +Check out the [Hyperliquid Alchemy Wallets Guide](https://www.alchemy.com/docs/wallets/recipes/hyperliquid-wallets) for enabling email and social login for user authentication and the ability to sign and send transactions. HyperEVM is a high-performance, Ethereum-compatible execution layer developed by HyperLiquid that enables smart contracts to run natively alongside its decentralized trading engine, combining low-latency performance with full EVM compatibility. -The HyperEVM API allows interaction with the HyperEVM network through a set of JSON-RPC methods. Its design is familiar to developers who have worked with Ethereum's JSON-RPC APIs, making it intuitive and straightforward to use. +The HyperEVM API lets you interact with the HyperEVM network through a set of JSON-RPC methods. If you've worked with Ethereum's JSON-RPC APIs, the design will feel familiar. -## Send Your First Request on Alchemy +## Send your first request on Alchemy Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a HyperEVM client connected to Alchemy and fetch the latest block number! @@ -30,7 +30,7 @@ Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a H ``` -## Create Client Connected to Alchemy +## Create a client connected to Alchemy ```js @@ -46,7 +46,7 @@ const client = createPublicClient({ Now that you've created a client connected to Alchemy, you can continue with some basics: -## Get Latest Block Number +## Get the latest block number ```js @@ -55,7 +55,7 @@ console.log("Current block number:", blockNumber); ``` -## Get an Address Balance +## Get an address balance ```js @@ -64,7 +64,7 @@ console.log("Balance (HYPE):", Number(balance) / 1e18); ``` -## Read Block Data +## Read block data ```js @@ -75,7 +75,7 @@ console.log(block); ``` -## Fetch a Transaction by Hash +## Fetch a transaction by hash ```js @@ -84,7 +84,7 @@ console.log(tx); ``` -## Fetch Transaction Receipt +## Fetch a transaction receipt ```js diff --git a/content/api-reference/hyperliquid/hyperliquid-info-endpoint.mdx b/content/api-reference/hyperliquid/hyperliquid-info-endpoint.mdx index 05cb0d6ec..726029f8c 100644 --- a/content/api-reference/hyperliquid/hyperliquid-info-endpoint.mdx +++ b/content/api-reference/hyperliquid/hyperliquid-info-endpoint.mdx @@ -9,11 +9,11 @@ description: Reference for the Hyperliquid Info endpoint, including pagination, Responses that take a time range will only return 500 elements or distinct blocks of data. To query larger ranges, use the last returned timestamp as the next `startTime` for pagination. -### Perpetuals vs Spot +### Perpetuals vs spot The endpoints in this section work for both Perpetuals and Spot. For perpetuals `coin` is the name returned in the `meta` response. For Spot, coin should be `PURR/USDC` for PURR, and `@{index}` e.g. `@1` for all other spot tokens where index is the index of the spot pair in the `universe` field of the `spotMeta` response. For example, the spot index for HYPE on mainnet is `@107` because the token index of HYPE is 150 and the spot pair `@107` has tokens `[150, 0]`. Note that some assets may be remapped on user interfaces. For example, `BTC/USDC` on app.hyperliquid.xyz corresponds to `UBTC/USDC` on mainnet HyperCore. The L1 name on the [hyperliquid token details page](https://app.hyperliquid.xyz/explorer/token/0x8f254b963e8468305d409b33aa137c67) can be used to detect remappings. -### User address +### User address query To query the account data associated with a master or sub-account, you must pass in the actual address of that account. A common pitfall is to use an agent wallet's address which leads to an empty result. diff --git a/content/api-reference/ink/ink-api-faq.mdx b/content/api-reference/ink/ink-api-faq.mdx index c67a966fc..84e56e742 100644 --- a/content/api-reference/ink/ink-api-faq.mdx +++ b/content/api-reference/ink/ink-api-faq.mdx @@ -11,7 +11,7 @@ Ink Chain is a high-performance Layer 2 blockchain developed by Kraken, designed ## What is the Ink Chain API? -The Ink Chain API facilitates interaction with the Ink network through a collection of JSON-RPC methods. Given its compatibility with the Ethereum ecosystem, developers familiar with Ethereum's JSON-RPC APIs will find working with Ink both intuitive and straightforward. +The Ink Chain API lets you interact with the Ink network through a collection of JSON-RPC methods. Because it's compatible with the Ethereum ecosystem, you'll find working with Ink familiar if you've used Ethereum's JSON-RPC APIs. ## How can I get started using the Ink API? @@ -27,17 +27,17 @@ Ink Chain uses the JSON-RPC API standard for blockchain interactions. This is th ## What is an Ink API key? -When accessing the Ink network via a node provider like Alchemy, Ink developers use an API key to send transactions and retrieve data from the network. +When you access the Ink network via a node provider like Alchemy, you use an API key to send transactions and retrieve data from the network. For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup)! ## Which libraries support Ink? -Given Ink's compatibility with the Ethereum ecosystem, popular Ethereum libraries like ethers.js and web3.js are fully compatible with Ink. This allows for seamless development and integration for those familiar with Ethereum's development ecosystem. +Because Ink is compatible with the Ethereum ecosystem, popular Ethereum libraries like ethers.js and web3.js work with Ink. If you're familiar with Ethereum's development ecosystem, you can integrate with minimal changes. ## What programming languages work with Ink? -Similar to Ethereum, Ink supports a range of programming languages for blockchain interaction and smart contract development, including Solidity for smart contracts, as well as JavaScript and TypeScript for dApp development and off-chain interactions. +Like Ethereum, Ink supports a range of programming languages for blockchain interaction and smart contract development, including Solidity for smart contracts, as well as JavaScript and TypeScript for dApp development and offchain interactions. ## What does Ink use for gas? @@ -49,4 +49,4 @@ You can find the list of all the methods Alchemy supports for the Ink API on the ## My question isn't here, where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/ink/ink-api-quickstart.mdx b/content/api-reference/ink/ink-api-quickstart.mdx index 61fb5caa3..259fe6b39 100644 --- a/content/api-reference/ink/ink-api-quickstart.mdx +++ b/content/api-reference/ink/ink-api-quickstart.mdx @@ -12,9 +12,9 @@ slug: reference/ink-api-quickstart Ink is a cutting-edge Layer 2 blockchain solution developed by Kraken, designed to bridge centralized and decentralized finance. Built on the OP Stack within the Optimism Superchain ecosystem, Ink offers sub-second block times, optimized gas fees, and high performance. It aims to simplify DeFi access, leveraging Kraken's established infrastructure while inheriting Ethereum's robust security. -The Ink API allows interaction with the Ink network through a set of JSON-RPC methods. Its design is familiar to developers who have worked with Ethereum's JSON-RPC APIs, making it intuitive and straightforward to use. +The Ink API lets you interact with the Ink network through a set of JSON-RPC methods. If you've worked with Ethereum's JSON-RPC APIs, the design will feel familiar. -## Send Your First Request on Alchemy +## Send your first request on Alchemy Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create an Ink client connected to Alchemy and fetch the latest block number! @@ -28,7 +28,7 @@ Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create an ``` -## Create Client Connected to Alchemy +## Create a client connected to Alchemy ```js @@ -44,7 +44,7 @@ const client = createPublicClient({ Now that you've created a client connected to Alchemy, you can continue with some basics: -## Get Latest Block Number +## Get the latest block number ```js @@ -53,7 +53,7 @@ console.log("Current block number:", blockNumber); ``` -## Get an Address Balance +## Get an address balance ```js @@ -62,7 +62,7 @@ console.log("Balance (ETH):", Number(balance) / 1e18); ``` -## Read Block Data +## Read block data ```js @@ -73,7 +73,7 @@ console.log(block); ``` -## Fetch a Transaction by Hash +## Fetch a transaction by hash ```js @@ -82,7 +82,7 @@ console.log(tx); ``` -## Fetch Transaction Receipt +## Fetch a transaction receipt ```js diff --git a/content/api-reference/introduction/api-overview.mdx b/content/api-reference/introduction/api-overview.mdx index 435d851a7..0ff6e7bcd 100644 --- a/content/api-reference/introduction/api-overview.mdx +++ b/content/api-reference/introduction/api-overview.mdx @@ -86,7 +86,7 @@ Use it for NFT metadata, token balances, transaction histories, enriched transfe - Subscribe to on-chain events like transfers, transactions, and balance changes. + Subscribe to onchain events like transfers, transactions, and balance changes. diff --git a/content/api-reference/lens/lens-api-faq.mdx b/content/api-reference/lens/lens-api-faq.mdx index eddc68bb0..393865cf3 100644 --- a/content/api-reference/lens/lens-api-faq.mdx +++ b/content/api-reference/lens/lens-api-faq.mdx @@ -64,4 +64,4 @@ Developers are encouraged to build new experiences on the Lens Network architect ## My question isn't here, where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/lens/lens-api-quickstart.mdx b/content/api-reference/lens/lens-api-quickstart.mdx index f46c090cf..27d94c2a1 100644 --- a/content/api-reference/lens/lens-api-quickstart.mdx +++ b/content/api-reference/lens/lens-api-quickstart.mdx @@ -13,12 +13,12 @@ slug: reference/lens-api-quickstart Lens Network is a decentralized social media infrastructure built on Ethereum using zkSync's technology. It aims to create open and fair social spaces by leveraging hybrid scaling solutions for high-throughput, low-cost transactions. Lens empowers users with control over their social identity and connections, enabling seamless movement across applications and fostering an environment with reduced censorship and enhanced freedom of expression. - Please note that we currently only support Lens Sepolia Testnet + We currently only support Lens Sepolia testnet. -The Lens API allows interaction with the Lens network through a set of JSON-RPC methods. Its design is familiar to developers who have worked with Ethereum's JSON-RPC APIs, making it intuitive and straightforward to use. +The Lens API lets you interact with the Lens network through a set of JSON-RPC methods. If you've worked with Ethereum's JSON-RPC APIs, the design will feel familiar. -## Send Your First Request on Alchemy +## Send your first request on Alchemy Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a Lens client connected to Alchemy and fetch the latest block number! @@ -32,7 +32,7 @@ Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a L ``` -## Create Client Connected to Alchemy +## Create a client connected to Alchemy ```js @@ -56,7 +56,7 @@ const client = createPublicClient({ Now that you've created a client connected to Alchemy, you can continue with some basics: -## Get Latest Block Number +## Get the latest block number ```js @@ -65,7 +65,7 @@ console.log("Current block number:", blockNumber); ``` -## Get an Address Balance +## Get an address balance ```js @@ -74,7 +74,7 @@ console.log("Balance (GRASS):", Number(balance) / 1e18); ``` -## Read Block Data +## Read block data ```js @@ -85,7 +85,7 @@ console.log(block); ``` -## Fetch a Transaction by Hash +## Fetch a transaction by hash ```js @@ -94,7 +94,7 @@ console.log(tx); ``` -## Fetch Transaction Receipt +## Fetch a transaction receipt ```js diff --git a/content/api-reference/linea/linea-chain-api-faq.mdx b/content/api-reference/linea/linea-chain-api-faq.mdx index d161ea9b2..d1f477a5f 100644 --- a/content/api-reference/linea/linea-chain-api-faq.mdx +++ b/content/api-reference/linea/linea-chain-api-faq.mdx @@ -27,17 +27,17 @@ Linea Chain uses the JSON-RPC API standard for blockchain interactions. This is ## What is a Linea Chain API key? -When accessing the Linea Chain network via a node provider like Alchemy, developers use an API key to send transactions and retrieve data from the network. +When you access the Linea Chain network via a node provider like Alchemy, you use an API key to send transactions and retrieve data from the network. For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup)! ## Which libraries support Linea Chain? -Given Linea Chain's EVM compatibility, popular Ethereum libraries like ethers.js and web3.js are fully compatible with Linea Chain. This allows for seamless development and integration for those familiar with Ethereum's development ecosystem. +Because Linea Chain is EVM-compatible, popular Ethereum libraries like ethers.js and web3.js work with Linea Chain. If you're familiar with Ethereum's development ecosystem, you can integrate with minimal changes. ## What programming languages work with Linea Chain? -Similar to Ethereum, Linea Chain supports a range of programming languages for blockchain interaction and smart contract development, including Solidity for smart contracts, as well as JavaScript and TypeScript for dApp development and off-chain interactions. +Like Ethereum, Linea Chain supports a range of programming languages for blockchain interaction and smart contract development, including Solidity for smart contracts, as well as JavaScript and TypeScript for dApp development and offchain interactions. ## What does Linea Chain use for gas? @@ -49,4 +49,4 @@ You can find the list of all the methods Alchemy supports for the Linea Chain AP ## My question isn't here, where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/linea/linea-chain-api-quickstart.mdx b/content/api-reference/linea/linea-chain-api-quickstart.mdx index 887640726..07e91f0f9 100644 --- a/content/api-reference/linea/linea-chain-api-quickstart.mdx +++ b/content/api-reference/linea/linea-chain-api-quickstart.mdx @@ -12,9 +12,9 @@ slug: reference/linea-api-quickstart Linea is an EVM-compatible blockchain designed to provide scalability and efficiency for decentralized applications (dApps). Known for its high throughput and low transaction costs, Linea offers a robust environment for deploying Ethereum-based applications. -The Linea API facilitates interaction with the Linea network through a collection of JSON-RPC methods. Given its compatibility with the Ethereum ecosystem, developers familiar with Ethereum's JSON-RPC APIs will find working with Linea both intuitive and straightforward. +The Linea API lets you interact with the Linea network through a collection of JSON-RPC methods. If you're familiar with Ethereum's JSON-RPC APIs, working with Linea will feel natural. -## Send Your First Request on Alchemy +## Send your first request on Alchemy Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a Linea client connected to Alchemy and fetch the latest block number! @@ -28,7 +28,7 @@ Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a L ``` -## Create Client Connected to Alchemy +## Create a client connected to Alchemy ```js @@ -44,7 +44,7 @@ const client = createPublicClient({ Now that you've created a client connected to Alchemy, you can continue with some basics: -## Get Latest Block Number +## Get the latest block number ```js @@ -53,7 +53,7 @@ console.log("Current block number:", blockNumber); ``` -## Get an Address Balance +## Get an address balance ```js @@ -62,7 +62,7 @@ console.log("Balance (ETH):", Number(balance) / 1e18); ``` -## Read Block Data +## Read block data ```js @@ -73,7 +73,7 @@ console.log(block); ``` -## Fetch a Transaction by Hash +## Fetch a transaction by hash ```js @@ -82,7 +82,7 @@ console.log(tx); ``` -## Fetch Transaction Receipt +## Fetch a transaction receipt ```js diff --git a/content/api-reference/mantle/mantle-chain-api-faq.mdx b/content/api-reference/mantle/mantle-chain-api-faq.mdx index 19e4d6e81..02d7acffc 100644 --- a/content/api-reference/mantle/mantle-chain-api-faq.mdx +++ b/content/api-reference/mantle/mantle-chain-api-faq.mdx @@ -27,17 +27,17 @@ Mantle Chain uses the JSON-RPC API standard for blockchain interactions. This is ## What is a Mantle Chain API key? -When accessing the Mantle Chain network via a node provider like Alchemy, developers use an API key to send transactions and retrieve data from the network. +When you access the Mantle Chain network via a node provider like Alchemy, you use an API key to send transactions and retrieve data from the network. For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup)! ## Which libraries support Mantle Chain? -Given Mantle Chain's EVM compatibility, popular Ethereum libraries like ethers.js and web3.js are fully compatible with Mantle Chain. This allows for seamless development and integration for those familiar with Ethereum's development ecosystem. +Because Mantle Chain is EVM-compatible, popular Ethereum libraries like ethers.js and web3.js work with Mantle Chain. If you're familiar with Ethereum's development ecosystem, you can integrate with minimal changes. ## What programming languages work with Mantle Chain? -Similar to Ethereum, Mantle Chain supports a range of programming languages for blockchain interaction and smart contract development, including Solidity for smart contracts, as well as JavaScript and TypeScript for dApp development and off-chain interactions. +Like Ethereum, Mantle Chain supports a range of programming languages for blockchain interaction and smart contract development, including Solidity for smart contracts, as well as JavaScript and TypeScript for dApp development and offchain interactions. ## What does Mantle Chain use for gas? @@ -49,4 +49,4 @@ You can find the list of all the methods Alchemy supports for the Mantle Chain A ## My question isn't here, where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/mantle/mantle-chain-api-quickstart.mdx b/content/api-reference/mantle/mantle-chain-api-quickstart.mdx index ff6fe579e..c0cac9cef 100644 --- a/content/api-reference/mantle/mantle-chain-api-quickstart.mdx +++ b/content/api-reference/mantle/mantle-chain-api-quickstart.mdx @@ -12,9 +12,9 @@ slug: reference/mantle-api-quickstart Mantle is an EVM-compatible blockchain designed to provide high performance, scalability, and security for decentralized applications (dApps). Known for its fast and low-cost transactions, Mantle offers a robust environment for deploying Ethereum-based applications. -The Mantle API facilitates interaction with the Mantle network through a collection of JSON-RPC methods. Given its compatibility with the Ethereum ecosystem, developers familiar with Ethereum's JSON-RPC APIs will find working with Mantle both intuitive and straightforward. +The Mantle API lets you interact with the Mantle network through a collection of JSON-RPC methods. If you're familiar with Ethereum's JSON-RPC APIs, working with Mantle will feel natural. -## Send Your First Request on Alchemy +## Send your first request on Alchemy Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a Mantle client connected to Alchemy and fetch the latest block number! @@ -28,7 +28,7 @@ Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a M ``` -## Create Client Connected to Alchemy +## Create a client connected to Alchemy ```js @@ -44,7 +44,7 @@ const client = createPublicClient({ Now that you've created a client connected to Alchemy, you can continue with some basics: -## Get Latest Block Number +## Get the latest block number ```js @@ -53,7 +53,7 @@ console.log("Current block number:", blockNumber); ``` -## Get an Address Balance +## Get an address balance ```js @@ -62,7 +62,7 @@ console.log("Balance (MNT):", Number(balance) / 1e18); ``` -## Read Block Data +## Read block data ```js @@ -73,7 +73,7 @@ console.log(block); ``` -## Fetch a Transaction by Hash +## Fetch a transaction by hash ```js @@ -82,7 +82,7 @@ console.log(tx); ``` -## Fetch Transaction Receipt +## Fetch a transaction receipt ```js diff --git a/content/api-reference/megaeth/megaeth-api-faq.mdx b/content/api-reference/megaeth/megaeth-api-faq.mdx index 0a05c3224..1a93c43e9 100644 --- a/content/api-reference/megaeth/megaeth-api-faq.mdx +++ b/content/api-reference/megaeth/megaeth-api-faq.mdx @@ -12,22 +12,22 @@ MegaETH is a high-performance Ethereum Layer 2 blockchain designed to achieve re Check out our [MegaETH API Quickstart guide](/docs/reference/megaeth-api-quickstart) to get started building on MegaETH. ## What is the MegaETH API? -The MegaETH API allows developers to interface with the MegaETH mainnet. With this API, developers can execute transactions, query on-chain data, and interact with the MegaETH network, relying on a JSON-RPC standard. +The MegaETH API lets you interface with the MegaETH mainnet. You can execute transactions, query onchain data, and interact with the MegaETH network using the JSON-RPC standard. ## Is MegaETH EVM compatible? Yes, MegaETH is EVM compatible. ## What API does MegaETH use? -MegaETH uses the JSON-RPC API standard. This API is crucial for any blockchain interaction on the MegaETH network, allowing users to read block/transaction data, query chain information, execute smart contracts, and store data on-chain. +MegaETH uses the JSON-RPC API standard. This API handles all blockchain interaction on the MegaETH network, letting you read block/transaction data, query chain information, execute smart contracts, and store data onchain. ## What methods are supported on MegaETH? MegaETH supports standard Ethereum JSON-RPC methods. Some chain-specific methods may vary. Please check the [MegaETH API Endpoints](/docs/chains#megaeth-apis) for a complete list. ## What is a MegaETH API key? -When accessing the MegaETH network via a node provider like Alchemy, MegaETH developers use an API key to send transactions and retrieve data from the network. For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup)! +When you access the MegaETH network via a node provider like Alchemy, you use an API key to send transactions and retrieve data from the network. For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup)! ## Which libraries support MegaETH? Common Ethereum libraries like [ethers.js](https://docs.ethers.org/v5/) should be compatible with MegaETH, given its EVM nature. ## My question isn’t here, where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/megaeth/megaeth-api-quickstart.mdx b/content/api-reference/megaeth/megaeth-api-quickstart.mdx index ce4274cf7..91182f44d 100644 --- a/content/api-reference/megaeth/megaeth-api-quickstart.mdx +++ b/content/api-reference/megaeth/megaeth-api-quickstart.mdx @@ -12,9 +12,9 @@ slug: reference/megaeth-api-quickstart MegaETH is a high-performance Ethereum Layer 2 blockchain designed to achieve real-time transaction processing with sub-millisecond latency and extremely high throughput. -The MegaETH API allows interaction with the MegaETH network through a set of JSON-RPC methods. Its design is familiar to developers who have worked with Ethereum's JSON-RPC APIs, making it intuitive and straightforward to use. +The MegaETH API lets you interact with the MegaETH network through a set of JSON-RPC methods. If you've worked with Ethereum's JSON-RPC APIs, the design will feel familiar. -## Send Your First Request on Alchemy +## Send your first request on Alchemy Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a MegaETH client connected to Alchemy and fetch the latest block number! @@ -28,7 +28,7 @@ Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a M ``` -## Create Client Connected to Alchemy +## Create a client connected to Alchemy ```js @@ -52,7 +52,7 @@ const client = createPublicClient({ Now that you've created a client connected to Alchemy, you can continue with some basics: -## Get Latest Block Number +## Get the latest block number ```js @@ -61,7 +61,7 @@ console.log("Current block number:", blockNumber); ``` -## Get an Address Balance +## Get an address balance ```js @@ -70,7 +70,7 @@ console.log("Balance (ETH):", Number(balance) / 1e18); ``` -## Read Block Data +## Read block data ```js @@ -81,7 +81,7 @@ console.log(block); ``` -## Fetch a Transaction by Hash +## Fetch a transaction by hash ```js @@ -90,7 +90,7 @@ console.log(tx); ``` -## Fetch Transaction Receipt +## Fetch a transaction receipt ```js diff --git a/content/api-reference/metis/metis-chain-api-faq.mdx b/content/api-reference/metis/metis-chain-api-faq.mdx index 1568e8707..c3ffc7375 100644 --- a/content/api-reference/metis/metis-chain-api-faq.mdx +++ b/content/api-reference/metis/metis-chain-api-faq.mdx @@ -31,17 +31,17 @@ Metis Chain uses the JSON-RPC API standard for blockchain interactions. This is ## What is a Metis Chain API key? -When accessing the Metis Chain network via a node provider like Alchemy, developers use an API key to send transactions and retrieve data from the network. +When you access the Metis Chain network via a node provider like Alchemy, you use an API key to send transactions and retrieve data from the network. For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup)! ## Which libraries support Metis Chain? -Given Metis Chain's EVM compatibility, popular Ethereum libraries like ethers.js and web3.js are fully compatible with Metis Chain. This allows for seamless development and integration for those familiar with Ethereum's development ecosystem. +Because Metis Chain is EVM-compatible, popular Ethereum libraries like ethers.js and web3.js work with Metis Chain. If you're familiar with Ethereum's development ecosystem, you can integrate with minimal changes. ## What programming languages work with Metis Chain? -Similar to Ethereum, Metis Chain supports a range of programming languages for blockchain interaction and smart contract development, including Solidity for smart contracts, as well as JavaScript and TypeScript for dApp development and off-chain interactions. +Like Ethereum, Metis Chain supports a range of programming languages for blockchain interaction and smart contract development, including Solidity for smart contracts, as well as JavaScript and TypeScript for dApp development and offchain interactions. ## What does Metis Chain use for gas? @@ -53,4 +53,4 @@ You can find the list of all the methods Alchemy supports for the Metis Chain AP ## My question isn't here, where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/metis/metis-chain-api-quickstart.mdx b/content/api-reference/metis/metis-chain-api-quickstart.mdx index aef60dd1c..8e226046a 100644 --- a/content/api-reference/metis/metis-chain-api-quickstart.mdx +++ b/content/api-reference/metis/metis-chain-api-quickstart.mdx @@ -12,9 +12,9 @@ slug: reference/metis-api-quickstart Metis is an EVM-compatible blockchain designed to provide high performance, scalability, and security for decentralized applications (dApps). Known for its fast and low-cost transactions, Metis offers a robust environment for deploying Ethereum-based applications with enhanced scalability and performance. -The Metis API facilitates interaction with the Metis network through a collection of JSON-RPC methods. Given its compatibility with the Ethereum ecosystem, developers familiar with Ethereum's JSON-RPC APIs will find working with Metis both intuitive and straightforward. +The Metis API lets you interact with the Metis network through a collection of JSON-RPC methods. If you're familiar with Ethereum's JSON-RPC APIs, working with Metis will feel natural. -## Send Your First Request on Alchemy +## Send your first request on Alchemy Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a Metis client connected to Alchemy and fetch the latest block number! @@ -28,7 +28,7 @@ Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a M ``` -## Create Client Connected to Alchemy +## Create a client connected to Alchemy ```js @@ -44,7 +44,7 @@ const client = createPublicClient({ Now that you've created a client connected to Alchemy, you can continue with some basics: -## Get Latest Block Number +## Get the latest block number ```js @@ -53,7 +53,7 @@ console.log("Current block number:", blockNumber); ``` -## Get an Address Balance +## Get an address balance ```js @@ -62,7 +62,7 @@ console.log("Balance (METIS):", Number(balance) / 1e18); ``` -## Read Block Data +## Read block data ```js @@ -73,7 +73,7 @@ console.log(block); ``` -## Fetch a Transaction by Hash +## Fetch a transaction by hash ```js @@ -82,7 +82,7 @@ console.log(tx); ``` -## Fetch Transaction Receipt +## Fetch a transaction receipt ```js diff --git a/content/api-reference/mode/mode-api-faq.mdx b/content/api-reference/mode/mode-api-faq.mdx index 7acd2fca5..f71799187 100644 --- a/content/api-reference/mode/mode-api-faq.mdx +++ b/content/api-reference/mode/mode-api-faq.mdx @@ -12,22 +12,22 @@ Mode is an OP Stack–based, EVM-equivalent Ethereum Layer-2 that’s growth-foc Check out our [Mode API Quickstart guide](/docs/reference/mode-api-quickstart) to get started building on Mode. ## What is the Mode API? -The Mode API allows developers to interface with the Mode mainnet. With this API, developers can execute transactions, query on-chain data, and interact with the Mode network, relying on a JSON-RPC standard. +The Mode API lets you interface with the Mode mainnet. You can execute transactions, query onchain data, and interact with the Mode network using the JSON-RPC standard. ## Is Mode EVM compatible? Yes, Mode is EVM compatible. ## What API does Mode use? -Mode uses the JSON-RPC API standard. This API is crucial for any blockchain interaction on the Mode network, allowing users to read block/transaction data, query chain information, execute smart contracts, and store data on-chain. +Mode uses the JSON-RPC API standard. This API handles all blockchain interaction on the Mode network, letting you read block/transaction data, query chain information, execute smart contracts, and store data onchain. ## What methods are supported on Mode? Mode supports standard Ethereum JSON-RPC methods. Some chain-specific methods may vary. Please check the [Mode API Endpoints](/docs/chains#mode-apis) for a complete list. ## What is a Mode API key? -When accessing the Mode network via a node provider like Alchemy, Mode developers use an API key to send transactions and retrieve data from the network. For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup)! +When you access the Mode network via a node provider like Alchemy, you use an API key to send transactions and retrieve data from the network. For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup)! ## Which libraries support Mode? Common Ethereum libraries like [ethers.js](https://docs.ethers.org/v5/) should be compatible with Mode, given its EVM nature. ## My question isn’t here, where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/mode/mode-api-quickstart.mdx b/content/api-reference/mode/mode-api-quickstart.mdx index e7caf0f19..267e5b87b 100644 --- a/content/api-reference/mode/mode-api-quickstart.mdx +++ b/content/api-reference/mode/mode-api-quickstart.mdx @@ -12,9 +12,9 @@ slug: reference/mode-api-quickstart Mode is an OP Stack–based, EVM-equivalent Ethereum Layer-2 that's growth-focused—sharing sequencer fees with developers (SFS) and rewarding users to power DeFi/AiFi apps. -The Mode API allows interaction with the Mode network through a set of JSON-RPC methods. Its design is familiar to developers who have worked with Ethereum's JSON-RPC APIs, making it intuitive and straightforward to use. +The Mode API lets you interact with the Mode network through a set of JSON-RPC methods. If you've worked with Ethereum's JSON-RPC APIs, the design will feel familiar. -## Send Your First Request on Alchemy +## Send your first request on Alchemy Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a Mode client connected to Alchemy and fetch the latest block number! @@ -28,7 +28,7 @@ Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a M ``` -## Create Client Connected to Alchemy +## Create a client connected to Alchemy ```js @@ -44,7 +44,7 @@ const client = createPublicClient({ Now that you've created a client connected to Alchemy, you can continue with some basics: -## Get Latest Block Number +## Get the latest block number ```js @@ -53,7 +53,7 @@ console.log("Current block number:", blockNumber); ``` -## Get an Address Balance +## Get an address balance ```js @@ -62,7 +62,7 @@ console.log("Balance (ETH):", Number(balance) / 1e18); ``` -## Read Block Data +## Read block data ```js @@ -73,7 +73,7 @@ console.log(block); ``` -## Fetch a Transaction by Hash +## Fetch a transaction by hash ```js @@ -82,7 +82,7 @@ console.log(tx); ``` -## Fetch Transaction Receipt +## Fetch a transaction receipt ```js diff --git a/content/api-reference/monad/monad-api-faq.mdx b/content/api-reference/monad/monad-api-faq.mdx index de706e09c..cf7d7cf6b 100644 --- a/content/api-reference/monad/monad-api-faq.mdx +++ b/content/api-reference/monad/monad-api-faq.mdx @@ -27,17 +27,17 @@ Monad Chain uses the JSON-RPC API standard for blockchain interactions. This is ## What is a Monad Chain API key? -When accessing the Monad Chain network via a node provider like Alchemy, developers use an API key to send transactions and retrieve data from the network. +When you access the Monad Chain network via a node provider like Alchemy, you use an API key to send transactions and retrieve data from the network. For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup)! ## Which libraries support Monad Chain? -Common Ethereum libraries such as ethers.js, web3.js, and viem are supported, allowing for easy smart contract interaction and wallet management. +Common Ethereum libraries such as ethers.js, web3.js, and viem are supported, enabling smart contract interaction and wallet management. ## What programming languages work with Monad Chain? -It supports Solidity and Vyper for smart contracts, along with JavaScript and TypeScript for off-chain development, ensuring compatibility with projects that compile to EVM bytecode. +It supports Solidity and Vyper for smart contracts, along with JavaScript and TypeScript for offchain development, ensuring compatibility with projects that compile to EVM bytecode. ## What does Monad Chain use for gas? @@ -49,4 +49,4 @@ You can find the list of all the methods Alchemy supports for the Monad Chain AP ## My question isn't here, where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/monad/monad-api-quickstart.mdx b/content/api-reference/monad/monad-api-quickstart.mdx index f0f7bcbc3..3d43fba00 100644 --- a/content/api-reference/monad/monad-api-quickstart.mdx +++ b/content/api-reference/monad/monad-api-quickstart.mdx @@ -13,12 +13,12 @@ slug: reference/monad-api-quickstart Monad is a high-performance Ethereum-compatible L1. Monad materially advances the efficient frontier in the balance between decentralization and scalability. - Please note that we currently only support the Monad testnet + We currently only support the Monad testnet. -The Monad API allows interaction with the Monad network through a set of JSON-RPC methods. Its design is familiar to developers who have worked with Ethereum's JSON-RPC APIs, making it intuitive and straightforward to use. +The Monad API lets you interact with the Monad network through a set of JSON-RPC methods. If you've worked with Ethereum's JSON-RPC APIs, the design will feel familiar. -## Send Your First Request on Alchemy +## Send your first request on Alchemy Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a Monad client connected to Alchemy and fetch the latest block number! @@ -32,7 +32,7 @@ Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a M ``` -## Create Client Connected to Alchemy +## Create a client connected to Alchemy ```js @@ -56,7 +56,7 @@ const client = createPublicClient({ Now that you've created a client connected to Alchemy, you can continue with some basics: -## Get Latest Block Number +## Get the latest block number ```js @@ -65,7 +65,7 @@ console.log("Current block number:", blockNumber); ``` -## Get an Address Balance +## Get an address balance ```js @@ -74,7 +74,7 @@ console.log("Balance (MON):", Number(balance) / 1e18); ``` -## Read Block Data +## Read block data ```js @@ -85,7 +85,7 @@ console.log(block); ``` -## Fetch a Transaction by Hash +## Fetch a transaction by hash ```js @@ -94,7 +94,7 @@ console.log(tx); ``` -## Fetch Transaction Receipt +## Fetch a transaction receipt ```js diff --git a/content/api-reference/moonbeam/moonbeam-api-faq.mdx b/content/api-reference/moonbeam/moonbeam-api-faq.mdx index 784267577..acc8c7004 100644 --- a/content/api-reference/moonbeam/moonbeam-api-faq.mdx +++ b/content/api-reference/moonbeam/moonbeam-api-faq.mdx @@ -6,28 +6,28 @@ slug: reference/moonbeam-api-faq --- ## What is Moonbeam? -Moonbeam is an Ethereum-compatible smart-contract parachain on Polkadot that pairs full EVM tooling with native cross-chain interoperability (XCM/XC-20) for building connected dapps. +Moonbeam is an Ethereum-compatible smart-contract parachain on Polkadot that pairs full EVM tooling with native cross-chain interoperability (XCM/XC-20) for building connected dApps. ## How do I get started with Moonbeam? Check out our [Moonbeam API Quickstart guide](/docs/reference/moonbeam-api-quickstart) to get started building on Moonbeam. ## What is the Moonbeam API? -The Moonbeam API allows developers to interface with the Moonbeam mainnet. With this API, developers can execute transactions, query on-chain data, and interact with the Moonbeam network, relying on a JSON-RPC standard. +The Moonbeam API lets you interface with the Moonbeam mainnet. You can execute transactions, query onchain data, and interact with the Moonbeam network using the JSON-RPC standard. ## Is Moonbeam EVM compatible? Yes, Moonbeam is EVM compatible. ## What API does Moonbeam use? -Moonbeam uses the JSON-RPC API standard. This API is crucial for any blockchain interaction on the Moonbeam network, allowing users to read block/transaction data, query chain information, execute smart contracts, and store data on-chain. +Moonbeam uses the JSON-RPC API standard. This API handles all blockchain interaction on the Moonbeam network, letting you read block/transaction data, query chain information, execute smart contracts, and store data onchain. ## What methods are supported on Moonbeam? Moonbeam supports standard Ethereum JSON-RPC methods. Some chain-specific methods may vary. Please check the [Moonbeam API Endpoints](/docs/chains#moonbeam-apis) for a complete list. ## What is a Moonbeam API key? -When accessing the Moonbeam network via a node provider like Alchemy, Moonbeam developers use an API key to send transactions and retrieve data from the network. For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup)! +When you access the Moonbeam network via a node provider like Alchemy, you use an API key to send transactions and retrieve data from the network. For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup)! ## Which libraries support Moonbeam? Common Ethereum libraries like [ethers.js](https://docs.ethers.org/v5/) should be compatible with Moonbeam, given its EVM nature. ## My question isn’t here, where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/moonbeam/moonbeam-api-quickstart.mdx b/content/api-reference/moonbeam/moonbeam-api-quickstart.mdx index 052383118..7b986f742 100644 --- a/content/api-reference/moonbeam/moonbeam-api-quickstart.mdx +++ b/content/api-reference/moonbeam/moonbeam-api-quickstart.mdx @@ -10,11 +10,11 @@ slug: reference/moonbeam-api-quickstart get started today. -Moonbeam is an Ethereum-compatible smart-contract parachain on Polkadot that pairs full EVM tooling with native cross-chain interoperability (XCM/XC-20) for building connected dapps. +Moonbeam is an Ethereum-compatible smart-contract parachain on Polkadot that pairs full EVM tooling with native cross-chain interoperability (XCM/XC-20) for building connected dApps. -The Moonbeam API allows interaction with the Moonbeam network through a set of JSON-RPC methods. Its design is familiar to developers who have worked with Ethereum's JSON-RPC APIs, making it intuitive and straightforward to use. +The Moonbeam API lets you interact with the Moonbeam network through a set of JSON-RPC methods. If you've worked with Ethereum's JSON-RPC APIs, the design will feel familiar. -## Send Your First Request on Alchemy +## Send your first request on Alchemy Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a Moonbeam client connected to Alchemy and fetch the latest block number! @@ -28,7 +28,7 @@ Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a M ``` -## Create Client Connected to Alchemy +## Create a client connected to Alchemy ```js @@ -44,7 +44,7 @@ const client = createPublicClient({ Now that you've created a client connected to Alchemy, you can continue with some basics: -## Get Latest Block Number +## Get the latest block number ```js @@ -53,7 +53,7 @@ console.log("Current block number:", blockNumber); ``` -## Get an Address Balance +## Get an address balance ```js @@ -62,7 +62,7 @@ console.log("Balance (GLMR):", Number(balance) / 1e18); ``` -## Read Block Data +## Read block data ```js @@ -73,7 +73,7 @@ console.log(block); ``` -## Fetch a Transaction by Hash +## Fetch a transaction by hash ```js @@ -82,7 +82,7 @@ console.log(tx); ``` -## Fetch Transaction Receipt +## Fetch a transaction receipt ```js diff --git a/content/api-reference/mythos/mythos-api-faq.mdx b/content/api-reference/mythos/mythos-api-faq.mdx index ca933c616..49e8f16ac 100644 --- a/content/api-reference/mythos/mythos-api-faq.mdx +++ b/content/api-reference/mythos/mythos-api-faq.mdx @@ -12,22 +12,22 @@ Mythos Chain is an EVM-compatible blockchain built for gaming, powering decentra Check out our [Mythos API Quickstart guide](./mythos-api-quickstart) to get started building on Mythos. ## What is the Mythos API? -The Mythos API allows developers to interface with the Mythos network. With this API, developers can execute transactions, query on-chain data, and interact with the Mythos network, relying on a JSON-RPC standard. +The Mythos API lets you interface with the Mythos network. You can execute transactions, query onchain data, and interact with the Mythos network using the JSON-RPC standard. ## Is Mythos EVM compatible? Yes, Mythos is EVM compatible. ## What API does Mythos use? -Mythos uses the JSON-RPC API standard. This API is crucial for any blockchain interaction on the Mythos network, allowing users to read block/transaction data, query chain information, execute smart contracts, and store data on-chain. +Mythos uses the JSON-RPC API standard. This API handles all blockchain interaction on the Mythos network, letting you read block/transaction data, query chain information, execute smart contracts, and store data onchain. ## What methods are supported on Mythos? Mythos supports standard Ethereum JSON-RPC methods. Some chain-specific methods may vary. Please check the Mythos API endpoints documentation for a complete list. ## What is a Mythos API key? -When accessing the Mythos network via a node provider like Alchemy, Mythos developers use an API key to send transactions and retrieve data from the network. For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup)! +When you access the Mythos network via a node provider like Alchemy, you use an API key to send transactions and retrieve data from the network. For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup)! ## Which libraries support Mythos? Common Ethereum libraries like [ethers.js](https://docs.ethers.org/v5/) should be compatible with Mythos, given its EVM nature. ## My question isn’t here, where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/mythos/mythos-api-quickstart.mdx b/content/api-reference/mythos/mythos-api-quickstart.mdx index 77f345d64..33b965c80 100644 --- a/content/api-reference/mythos/mythos-api-quickstart.mdx +++ b/content/api-reference/mythos/mythos-api-quickstart.mdx @@ -7,17 +7,17 @@ slug: reference/mythos-api-quickstart *To use the Mythos API you'll need to [create a free Alchemy account](https://dashboard.alchemy.com/signup) first!* -## Introduction +## What is Mythos Chain? Mythos Chain is an EVM-compatible blockchain built for gaming, powering decentralized game economies, unified NFT marketplaces, and multi-token ecosystems through the MYTH token. ## What is the Mythos API? -The Mythos API allows interaction with the Mythos network through a set of JSON-RPC methods. Its design is familiar to developers who have worked with Ethereum's JSON-RPC APIs, making it intuitive and straightforward to use. +The Mythos API lets you interact with the Mythos network through a set of JSON-RPC methods. If you've worked with Ethereum's JSON-RPC APIs, the design will feel familiar. -## Getting Started Instructions +## Getting started -### 1. Choose a Package Manager (npm or yarn) +### 1. Choose a package manager (npm or yarn) Select a package manager to manage your project's dependencies. Choose between `npm` and `yarn` based on your preference or project requirements. @@ -33,7 +33,7 @@ Select a package manager to manage your project's dependencies. Choose between ` ``` -### 2. Set Up Your Project +### 2. Set up your project Open your terminal and execute the following commands to create and initialize your project: @@ -53,7 +53,7 @@ Open your terminal and execute the following commands to create and initialize y This creates a new directory named `mythos-api-quickstart` and initializes a Node.js project within it. -### 3. Make Your First Request +### 3. Make your first request Install Axios, a popular HTTP client, to make API requests: @@ -92,9 +92,9 @@ Create an `index.js` file in your project directory and paste the following code ``` -Remember to replace `your-api-key` with your actual Alchemy API key that you can get from your [Alchemy dashboard](https://dashboard.alchemy.com/signup). +Remember to replace `your-api-key` with your actual Alchemy API key that you can get from the [Alchemy Dashboard](https://dashboard.alchemy.com/signup). -### 4. Run Your Script +### 4. Run your script Execute your script to make a request to the Mythos network: @@ -112,6 +112,6 @@ You should see the latest block information from Mythos's network outputted to y ``` -## Next Steps +## Next steps -Congratulations! You've made your first request to the Mythos network. You can now explore the various JSON-RPC methods available on Mythos and start building your dApps on this innovative platform. +You've made your first request to the Mythos network. You can now explore the various JSON-RPC methods available on Mythos and start building your dApps on this platform. diff --git a/content/api-reference/node-api/chain-apis-overview.mdx b/content/api-reference/node-api/chain-apis-overview.mdx index 37f32e678..e4eb47724 100644 --- a/content/api-reference/node-api/chain-apis-overview.mdx +++ b/content/api-reference/node-api/chain-apis-overview.mdx @@ -11,7 +11,7 @@ hide-toc: true Alchemy's Chain APIs provide comprehensive access to blockchain data and functionality across all supported networks. These APIs enable you to interact with blockchains through standardized JSON-RPC methods, allowing you to read blockchain state, write transactions, and build powerful decentralized applications. -## Key Capabilities +## Key capabilities Chain APIs provide essential blockchain functionality including: @@ -21,9 +21,9 @@ Chain APIs provide essential blockchain functionality including: * **Gas Management**: Estimate transaction costs and optimize gas usage * **Network Information**: Access chain-specific data like network version, block numbers, and protocol details -## Supported Blockchains +## Supported blockchains -### Ethereum & EVM Layer 1s +### Ethereum & EVM layer 1s * [**Ethereum**](/docs/ethereum/ethereum-api-overview) - The leading smart contract platform and home to DeFi, NFTs, and Web3 * [**BNB Smart Chain**](/docs/bnb-smart-chain/bnb-smart-chain-api-overview) - High-performance blockchain compatible with Ethereum tooling @@ -32,16 +32,16 @@ Chain APIs provide essential blockchain functionality including: * [**Gnosis**](/docs/gnosis/gnosis-api-overview) - Community-owned Ethereum sidechain focused on payments and prediction markets * [**Rootstock**](/docs/rootstock/rootstock-api-overview) - Bitcoin-secured smart contract platform -### Layer 2 Scaling Solutions +### Layer 2 scaling solutions -#### Optimistic Rollups +#### Optimistic rollups * [**Arbitrum**](/docs/arbitrum/arbitrum-api-overview) - Leading Ethereum L2 with EVM compatibility and lower fees * [**Arbitrum Nova**](/docs/arbitrum-nova/arbitrum-nova-api-overview) - Ultra-low-cost Arbitrum chain for gaming and social * [**OP Mainnet**](/docs/op-mainnet/op-mainnet-api-overview) - Optimistic rollup from Optimism Collective * [**Base**](/docs/base/base-api-overview) - Coinbase's Ethereum L2 built on the OP Stack -#### ZK Rollups +#### ZK rollups * [**Polygon zkEVM**](/docs/reference/polygon-zkevm-api-quickstart) - Zero-knowledge rollup with full EVM equivalence * [**zkSync**](/docs/reference/zksync-api-quickstart) - Privacy-preserving and scalable ZK rollup @@ -49,7 +49,7 @@ Chain APIs provide essential blockchain functionality including: * [**Linea**](/docs/linea/linea-api-overview) - ConsenSys zkEVM rollup * [**Starknet**](/docs/starknet/starknet-api-overview) - Validity rollup using STARK proofs -#### Other L2s & Sidechains +#### Other L2s & sidechains * [**Polygon PoS**](/docs/polygon-pos/polygon-pos-api-overview) - High-throughput Ethereum sidechain * [**Mantle**](/docs/mantle/mantle-api-overview) - Modular L2 with low fees @@ -64,7 +64,7 @@ Chain APIs provide essential blockchain functionality including: * [**Abstract**](/docs/abstract/abstract-api-overview) - Application-specific L2 * [**Soneium**](/docs/soneium/soneium-api-overview) - Next-generation L2 platform -### Alternative Layer 1 Blockchains +### Alternative layer 1 blockchains * [**Solana**](/docs/solana/solana-api-overview) - High-performance blockchain with fast transactions and low fees * [**Aptos**](/docs/reference/aptos-api-quickstart) - Secure, scalable blockchain using the Move language @@ -76,11 +76,11 @@ Chain APIs provide essential blockchain functionality including: * [**Monad**](/docs/monad/monad-api-overview) - High-performance EVM-compatible blockchain * [**Sei**](/docs/sei/sei-api-overview) - Purpose-built L1 for trading applications -### Emerging Networks & Testnets +### Emerging networks & testnets Alchemy also supports many emerging chains and specialized networks including Astar, Hyperliquid, Lens, opBNB, Plasma, Rise, Ronin, Sonic, and many more. Visit our [full chain directory](https://www.alchemy.com/rpc) for a complete list. -## Getting Started +## Getting started 1. **Create an Alchemy account** - Sign up for free at [alchemy.com](https://www.alchemy.com/signup) 2. **Create an app** - Set up a new app for your chosen blockchain diff --git a/content/api-reference/node-api/mev-protection.mdx b/content/api-reference/node-api/mev-protection.mdx index 6770e2350..54e700423 100644 --- a/content/api-reference/node-api/mev-protection.mdx +++ b/content/api-reference/node-api/mev-protection.mdx @@ -39,5 +39,5 @@ No configuration changes are required. Just send transactions to the standard RP ✅ Automatically protects transactions from MEV\ ✅ Faster block inclusion through private routing\ -✅ No changes required in dApp logic\ +✅ No changes required in your dApp logic\ ✅ Included at no additional cost diff --git a/content/api-reference/node-api/node-api-overview.mdx b/content/api-reference/node-api/node-api-overview.mdx index a7b9a919b..6ba3dccb3 100644 --- a/content/api-reference/node-api/node-api-overview.mdx +++ b/content/api-reference/node-api/node-api-overview.mdx @@ -36,7 +36,7 @@ Chain APIs are the per-chain RPC surfaces exposed through the Node API. *** -# Additional Products +# Additional products Use these alongside the Node API for streaming, performance, and deeper inspection. Chain coverage varies: check each page for supported networks. diff --git a/content/api-reference/node-api/node-supported-chains.mdx b/content/api-reference/node-api/node-supported-chains.mdx index bce3667d8..3dae3a68b 100644 --- a/content/api-reference/node-api/node-supported-chains.mdx +++ b/content/api-reference/node-api/node-supported-chains.mdx @@ -5,7 +5,7 @@ subtitle: Use the Node API for low-level access to Alchemy-supported blockchains slug: docs/reference/node-supported-chains --- -## Supported Chains +## Supported chains Alchemy supports both EVM and non-EVM chains, view API references below: @@ -195,7 +195,7 @@ Alchemy supports both EVM and non-EVM chains, view API references below: -## List of HTTP URLs by Supported Network +## List of HTTP URLs by supported network | Platform | Network Name | HTTPS URL | | --- | --- | --- | diff --git a/content/api-reference/op-mainnet/op-mainnet-api-faq/op-mainnet-api-faq.mdx b/content/api-reference/op-mainnet/op-mainnet-api-faq/op-mainnet-api-faq.mdx index 01fca9b52..684b384ea 100644 --- a/content/api-reference/op-mainnet/op-mainnet-api-faq/op-mainnet-api-faq.mdx +++ b/content/api-reference/op-mainnet/op-mainnet-api-faq/op-mainnet-api-faq.mdx @@ -7,13 +7,13 @@ slug: reference/op-mainnet-api-faq ## What is Optimism? -Optimism is a layer 2 [(L2) scaling solution for Ethereum](https://www.alchemy.com/overviews/ethereum-scaling-solutions). As an L2 solution Optimism operates on top of Ethereum’s mainnnet and because of this can utilize Ethereum’s strong security and support Ethereum dApps. All transactions that occur on Optimism are eventually posted and validated on the mainnet of Ethereum using Optimistic Rollups. +Optimism is a layer 2 [(L2) scaling solution for Ethereum](https://www.alchemy.com/overviews/ethereum-scaling-solutions). As an L2 solution, Optimism operates on top of Ethereum’s mainnet and can use Ethereum’s strong security while supporting Ethereum dApps. All transactions that occur on Optimism are eventually posted and validated on the Ethereum mainnet using Optimistic Rollups. Founded by Jinglan Wang, Karl Floersch, and Kevin Ho in 2019, Optimism continues to grow as an L2 solution that offers higher throughput and reduced expenses compared to Ethereum. ## What is the Optimism API? -The Optimism API allows applications to connect to an Optimism node that is part of the Optimism network. Developers can interact with on-chain data and send different types of transactions to the network by utilizing the endpoints provided by the API. The API follows a JSON-RPC standard. JSON-RPC is a stateless, lightweight, remote procedure call (RPC) protocol encoded in JSON. +The Optimism API lets applications connect to an Optimism node that is part of the Optimism network. You can interact with onchain data and send different types of transactions to the network using the endpoints provided by the API. The API follows the JSON-RPC standard, a stateless, lightweight, remote procedure call (RPC) protocol encoded in JSON. ## How can I get started using the Optimism API? @@ -48,7 +48,7 @@ If you sign in to your Alchemy account, you’ll get 5x more ETH. On Goerli, dev ## How do I build an app on Optimism? -To start building a dApp on Optimism, [sign up for Alchemy](https://www.alchemy.com/layer2/optimism) and log in. Then click the “Apps” tab and “Create App”, and you’re ready to build your new app on the Optimism mainnet! +To start building a dApp on Optimism, [sign up for Alchemy](https://www.alchemy.com/layer2/optimism) and log in. Then select the “Apps” tab and “Create App”, and you’re ready to build your new app on the Optimism mainnet! ## How do you bridge Optimism to Ethereum? @@ -70,27 +70,27 @@ Perpetual is a DeFi dApp that allows users to exchange perpetual contracts. Lyra ## How do you withdraw ETH from Optimism? -Withdrawing ETH from Optimism takes three easy steps: go to The [Optimism Gateway](https://gateway.optimism.io/), enter the amount you would like to remove from the network, and click “Withdraw”. Because Optimism uses fraud poofs, it takes 7 days for withdraws to Ethereum to be completed. +Withdrawing ETH from Optimism takes three steps: go to the [Optimism Gateway](https://gateway.optimism.io/), enter the amount you would like to remove from the network, and select “Withdraw”. Because Optimism uses fraud proofs, it takes 7 days for withdrawals to Ethereum to be completed. ## What API does Optimism use? Optimism uses the JSON-RPC API standard. The Optimism JSON-RPC API serves as the backbone for the Optimism network and powers any blockchain interaction. -In aggregate, this API suite allows users to read block/transaction data, query chain information, execute smart contracts, and store data on-chain. Developer interacts with Optimism’s base JSON-RPC APIs to communicate with its decentralized network of nodes. +This API suite lets you read block/transaction data, query chain information, execute smart contracts, and store data onchain. You interact with Optimism’s base JSON-RPC APIs to communicate with its decentralized network of nodes. ## What is an Optimism API key? -When accessing the Optimism network via a node provider, API providers like Alchemy require developers to use an API key to query the blockchain. +When you access the Optimism network via a node provider, API providers like Alchemy require an API key to query the blockchain. -For the best development experience, we recommend that you [sign up for a free API key](https://www.alchemy.com/layer2/optimism)! With a dedicated API key, developers can: +For the best development experience, we recommend that you [sign up for a free API key](https://www.alchemy.com/layer2/optimism)! With a dedicated API key, you can: * access higher request throughput and increased concurrent requests * query enhanced APIs, gaining access to free archive data, logs, and API abstractions -* Leverage individualized usage metrics +* leverage individualized usage metrics ## What programming languages work with Optimism? -Many programming languages work with Optimism including Go, Javascript, Solidity, Typescript, and Shell. Javascript and Solidity are some of the best languages to use, Solidity for smart contracts and Javascript for off-chain requests. +Many programming languages work with Optimism including Go, JavaScript, Solidity, TypeScript, and Shell. JavaScript and Solidity are some of the best languages to use -- Solidity for smart contracts and JavaScript for offchain requests. Before you get started, update your Optimism RPC URL to Alchemy. @@ -110,7 +110,7 @@ The Optimism sequencer has an additional limit on write requests or sending tran ## My question isn't here, where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. *** @@ -136,7 +136,7 @@ The expected time for the upgrade to take place is between 2-4 hours. ## Can developers still submit new transactions or access blockchain data via Alchemy while the upgrade is underway? -Developers will not be able to send new transactions to the network during the upgrade. However, read access to the blockchain data through Alchemy will be available throughout the upgrade. +You won't be able to send new transactions to the network during the upgrade. However, read access to the blockchain data through Alchemy will be available throughout the upgrade. *** diff --git a/content/api-reference/op-mainnet/op-mainnet-api-quickstart.mdx b/content/api-reference/op-mainnet/op-mainnet-api-quickstart.mdx index 910ded271..1736f7c14 100644 --- a/content/api-reference/op-mainnet/op-mainnet-api-quickstart.mdx +++ b/content/api-reference/op-mainnet/op-mainnet-api-quickstart.mdx @@ -12,9 +12,9 @@ slug: reference/op-mainnet-api-quickstart OP Mainnet (Optimism) is a Layer 2 scaling solution for Ethereum that leverages optimistic rollups to provide fast and low-cost transactions. As the foundation of the Optimism Superchain, OP Mainnet offers a secure and scalable environment for deploying Ethereum-based applications. -The OP Mainnet API facilitates interaction with the OP Mainnet network through a collection of JSON-RPC methods. Given its compatibility with the Ethereum ecosystem, developers familiar with Ethereum's JSON-RPC APIs will find working with OP Mainnet both intuitive and straightforward. +The OP Mainnet API lets you interact with the OP Mainnet network through a collection of JSON-RPC methods. If you're familiar with Ethereum's JSON-RPC APIs, working with OP Mainnet will feel natural. -## Send Your First Request on Alchemy +## Send your first request on Alchemy Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create an OP Mainnet client connected to Alchemy and fetch the latest block number! @@ -28,7 +28,7 @@ Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create an ``` -## Create Client Connected to Alchemy +## Create a client connected to Alchemy ```js @@ -44,7 +44,7 @@ const client = createPublicClient({ Now that you've created a client connected to Alchemy, you can continue with some basics: -## Get Latest Block Number +## Get the latest block number ```js @@ -53,7 +53,7 @@ console.log("Current block number:", blockNumber); ``` -## Get an Address Balance +## Get an address balance ```js @@ -62,7 +62,7 @@ console.log("Balance (ETH):", Number(balance) / 1e18); ``` -## Read Block Data +## Read block data ```js @@ -73,7 +73,7 @@ console.log(block); ``` -## Fetch a Transaction by Hash +## Fetch a transaction by hash ```js @@ -82,7 +82,7 @@ console.log(tx); ``` -## Fetch Transaction Receipt +## Fetch a transaction receipt ```js diff --git a/content/api-reference/op-mainnet/op-mainnet-flashblocks-api-quickstart.mdx b/content/api-reference/op-mainnet/op-mainnet-flashblocks-api-quickstart.mdx index f066ddd3a..a9c0d6374 100644 --- a/content/api-reference/op-mainnet/op-mainnet-flashblocks-api-quickstart.mdx +++ b/content/api-reference/op-mainnet/op-mainnet-flashblocks-api-quickstart.mdx @@ -5,13 +5,13 @@ subtitle: Get started building on Optimism using Flashblocks slug: reference/op-mainnet-flashblocks-api-quickstart --- -## Introduction +## What are Flashblocks? Flashblocks on Optimism are a transaction preconfirmation feature that provides near-instant transaction feedback by streaming partial block updates every 200 milliseconds. This significantly reduces the effective block time from Optimism's standard 2 seconds to just 200 milliseconds, a 10x increase. Flashblocks is great for developers who demand instant UX such as decentralized exchanges, onchain gaming, and other high-frequency applications. -## Getting started instructions +## Getting started Flashblocks is currently supported on both Optimism Sepolia testnet and mainnet and can be accessed using your existing **Alchemy Optimism** RPC. @@ -20,7 +20,7 @@ Flashblocks is currently supported on both Optimism Sepolia testnet and mainnet | Optimism Sepolia | ✅ | | Optimism Mainnet | ✅ | -## Flashblocks-enabled API Endpoints +## Flashblocks-enabled API endpoints ### [eth\_getBlockByNumber](https://www.alchemy.com/docs/node/op-mainnet/op-mainnet-api-endpoints/eth-get-block-by-number) diff --git a/content/api-reference/opbnb-paid-tier/opbnb-chain-api-faq.mdx b/content/api-reference/opbnb-paid-tier/opbnb-chain-api-faq.mdx index 23ac9d1da..5b655d77d 100644 --- a/content/api-reference/opbnb-paid-tier/opbnb-chain-api-faq.mdx +++ b/content/api-reference/opbnb-paid-tier/opbnb-chain-api-faq.mdx @@ -31,17 +31,17 @@ opBNB uses the JSON-RPC API standard for blockchain interactions. This is the sa ## What is an opBNB API key? -When accessing the opBNB network via a node provider like Alchemy, developers use an API key to send transactions and retrieve data from the network. +When you access the opBNB network via a node provider like Alchemy, you use an API key to send transactions and retrieve data from the network. For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup)! ## Which libraries support opBNB? -Given opBNB's EVM compatibility, popular Ethereum libraries like ethers.js and web3.js are fully compatible with opBNB. This allows for seamless development and integration for those familiar with Ethereum's development ecosystem. +Because opBNB is EVM-compatible, popular Ethereum libraries like ethers.js and web3.js work with opBNB. If you're familiar with Ethereum's development ecosystem, you can integrate with minimal changes. ## What programming languages work with opBNB? -Similar to Ethereum, opBNB supports a range of programming languages for blockchain interaction and smart contract development, including Solidity for smart contracts, as well as JavaScript and TypeScript for dApp development and off-chain interactions. +Like Ethereum, opBNB supports a range of programming languages for blockchain interaction and smart contract development, including Solidity for smart contracts, as well as JavaScript and TypeScript for dApp development and offchain interactions. ## What does opBNB use for gas? @@ -53,4 +53,4 @@ You can find the list of all the methods Alchemy supports for the opBNB API on t ## My question isn't here, where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/opbnb-paid-tier/opbnb-chain-api-quickstart.mdx b/content/api-reference/opbnb-paid-tier/opbnb-chain-api-quickstart.mdx index eeee042e8..22829a2b4 100644 --- a/content/api-reference/opbnb-paid-tier/opbnb-chain-api-quickstart.mdx +++ b/content/api-reference/opbnb-paid-tier/opbnb-chain-api-quickstart.mdx @@ -12,9 +12,9 @@ slug: reference/opbnb-chain-api-quickstart opBNB is an EVM-compatible blockchain designed to provide high performance, scalability, and security for decentralized applications (dApps). Known for its efficient transaction processing and low costs, opBNB offers a robust environment for deploying Ethereum-based applications. -The opBNB API facilitates interaction with the opBNB network through a collection of JSON-RPC methods. Given its compatibility with the Ethereum ecosystem, developers familiar with Ethereum's JSON-RPC APIs will find working with opBNB both intuitive and straightforward. +The opBNB API lets you interact with the opBNB network through a collection of JSON-RPC methods. If you're familiar with Ethereum's JSON-RPC APIs, working with opBNB will feel natural. -## Send Your First Request on Alchemy +## Send your first request on Alchemy Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create an opBNB client connected to Alchemy and fetch the latest block number! @@ -28,7 +28,7 @@ Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create an ``` -## Create Client Connected to Alchemy +## Create a client connected to Alchemy ```js @@ -44,7 +44,7 @@ const client = createPublicClient({ Now that you've created a client connected to Alchemy, you can continue with some basics: -## Get Latest Block Number +## Get the latest block number ```js @@ -53,7 +53,7 @@ console.log("Current block number:", blockNumber); ``` -## Get an Address Balance +## Get an address balance ```js @@ -62,7 +62,7 @@ console.log("Balance (BNB):", Number(balance) / 1e18); ``` -## Read Block Data +## Read block data ```js @@ -73,7 +73,7 @@ console.log(block); ``` -## Fetch a Transaction by Hash +## Fetch a transaction by hash ```js @@ -82,7 +82,7 @@ console.log(tx); ``` -## Fetch Transaction Receipt +## Fetch a transaction receipt ```js diff --git a/content/api-reference/pharos/pharos-api-faq.mdx b/content/api-reference/pharos/pharos-api-faq.mdx index 45e870968..aba868a23 100644 --- a/content/api-reference/pharos/pharos-api-faq.mdx +++ b/content/api-reference/pharos/pharos-api-faq.mdx @@ -12,22 +12,22 @@ Pharos is a high-performance, EVM-compatible Layer 1 blockchain that combines mo Check out our [Pharos API Quickstart guide](./pharos-api-quickstart) to get started building on Pharos. ## What is the Pharos API? -The Pharos API allows developers to interface with the Pharos network. With this API, developers can execute transactions, query on-chain data, and interact with the Pharos network, relying on a JSON-RPC standard. +The Pharos API lets you interface with the Pharos network. You can execute transactions, query onchain data, and interact with the Pharos network using the JSON-RPC standard. ## Is Pharos EVM compatible? Yes, Pharos is EVM compatible. ## What API does Pharos use? -Pharos uses the JSON-RPC API standard. This API is crucial for any blockchain interaction on the Pharos network, allowing users to read block/transaction data, query chain information, execute smart contracts, and store data on-chain. +Pharos uses the JSON-RPC API standard. This API handles all blockchain interaction on the Pharos network, letting you read block/transaction data, query chain information, execute smart contracts, and store data onchain. ## What methods are supported on Pharos? Pharos supports standard Ethereum JSON-RPC methods. Some chain-specific methods may vary. Please check the Pharos API endpoints documentation for a complete list. ## What is a Pharos API key? -When accessing the Pharos network via a node provider like Alchemy, Pharos developers use an API key to send transactions and retrieve data from the network. For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup)! +When you access the Pharos network via a node provider like Alchemy, you use an API key to send transactions and retrieve data from the network. For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup)! ## Which libraries support Pharos? Common Ethereum libraries like [ethers.js](https://docs.ethers.org/v5/) should be compatible with Pharos, given its EVM nature. ## My question isn’t here, where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/pharos/pharos-api-quickstart.mdx b/content/api-reference/pharos/pharos-api-quickstart.mdx index 146e2433e..e1f440dac 100644 --- a/content/api-reference/pharos/pharos-api-quickstart.mdx +++ b/content/api-reference/pharos/pharos-api-quickstart.mdx @@ -7,19 +7,19 @@ slug: reference/pharos-api-quickstart *To use the Pharos API you'll need to [create a free Alchemy account](https://dashboard.alchemy.com/signup) first!* -## Introduction +## What is Pharos? Pharos is a high-performance, EVM-compatible Layer 1 blockchain that combines modular architecture and deep-parallel execution to deliver sub-second finality and high throughput, designed to unify Web2 and Web3 assets and liquidity. ## What is the Pharos API? -The Pharos API allows interaction with the Pharos network through a set of JSON-RPC methods. Its design is familiar to developers who have worked with Ethereum's JSON-RPC APIs, making it intuitive and straightforward to use. +The Pharos API lets you interact with the Pharos network through a set of JSON-RPC methods. If you've worked with Ethereum's JSON-RPC APIs, the design will feel familiar. -## Getting Started Instructions +## Getting started -### 1. Choose a Package Manager (npm or yarn) +### 1. Choose a package manager (npm or yarn) -Select a package manager to manage your project's dependencies. Choose between `npm` and `yarn` based on your preference or project requirements. +Choose between `npm` and `yarn` based on your preference or project requirements. ```shell npm @@ -33,9 +33,9 @@ Select a package manager to manage your project's dependencies. Choose between ` ``` -### 2. Set Up Your Project +### 2. Set up your project -Open your terminal and execute the following commands to create and initialize your project: +Run the following commands to create and initialize your project: ```shell npm @@ -53,7 +53,7 @@ Open your terminal and execute the following commands to create and initialize y This creates a new directory named `pharos-api-quickstart` and initializes a Node.js project within it. -### 3. Make Your First Request +### 3. Make your first request Install Axios, a popular HTTP client, to make API requests: @@ -92,11 +92,11 @@ Create an `index.js` file in your project directory and paste the following code ``` -Remember to replace `your-api-key` with your actual Alchemy API key that you can get from your [Alchemy dashboard](https://dashboard.alchemy.com/signup). +Replace `your-api-key` with your actual Alchemy API key from the [Alchemy Dashboard](https://dashboard.alchemy.com/signup). -### 4. Run Your Script +### 4. Run your script -Execute your script to make a request to the Pharos network: +Run your script to make a request to the Pharos network: ```shell shell @@ -112,6 +112,6 @@ You should see the latest block information from Pharos's network outputted to y ``` -## Next Steps +## Next steps -Congratulations! You've made your first request to the Pharos network. You can now explore the various JSON-RPC methods available on Pharos and start building your dApps on this innovative platform. +You've made your first request to the Pharos network. You can now explore the various JSON-RPC methods available on Pharos and start building your dApps. diff --git a/content/api-reference/plasma/plasma-api-faq.mdx b/content/api-reference/plasma/plasma-api-faq.mdx index 1f238f119..3a1fcef2d 100644 --- a/content/api-reference/plasma/plasma-api-faq.mdx +++ b/content/api-reference/plasma/plasma-api-faq.mdx @@ -12,22 +12,22 @@ Plasma is an EVM-compatible Layer-1 purpose-built for stablecoins, using PlasmaB Check out our [Plasma API Quickstart guide](/docs/reference/plasma-api-quickstart) to get started building on Plasma. ## What is the Plasma API? -The Plasma API allows developers to interface with the Plasma mainnet. With this API, developers can execute transactions, query on-chain data, and interact with the Plasma network, relying on a JSON-RPC standard. +The Plasma API lets you interact with the Plasma mainnet. You can execute transactions, query onchain data, and interact with the Plasma network using a JSON-RPC standard. ## Is Plasma EVM compatible? Yes, Plasma is EVM compatible. ## What API does Plasma use? -Plasma uses the JSON-RPC API standard. This API is crucial for any blockchain interaction on the Plasma network, allowing users to read block/transaction data, query chain information, execute smart contracts, and store data on-chain. +Plasma uses the JSON-RPC API standard. This API handles all blockchain interactions on the Plasma network, letting you read block/transaction data, query chain information, execute smart contracts, and store data onchain. ## What methods are supported on Plasma? Plasma supports standard Ethereum JSON-RPC methods. Some chain-specific methods may vary. Please check the [Plasma API Endpoints](/docs/chains#plasma-apis) for a complete list. ## What is a Plasma API key? -When accessing the Plasma network via a node provider like Alchemy, Plasma developers use an API key to send transactions and retrieve data from the network. For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup)! +When accessing the Plasma network via a node provider like Alchemy, you use an API key to send transactions and retrieve data from the network. For the best development experience, we recommend you [sign up for a free API key](https://dashboard.alchemy.com/signup). ## Which libraries support Plasma? Common Ethereum libraries like [ethers.js](https://docs.ethers.org/v5/) should be compatible with Plasma, given its EVM nature. ## My question isn’t here, where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/plasma/plasma-api-quickstart.mdx b/content/api-reference/plasma/plasma-api-quickstart.mdx index 0ddb82065..90766985a 100644 --- a/content/api-reference/plasma/plasma-api-quickstart.mdx +++ b/content/api-reference/plasma/plasma-api-quickstart.mdx @@ -12,9 +12,9 @@ slug: reference/plasma-api-quickstart Plasma is an EVM-compatible Layer-1 purpose-built for stablecoins, using PlasmaBFT (Fast HotStuff) and a native Bitcoin bridge to enable near-instant, zero-fee USD₮ transfers and confidential payments. -The Plasma API allows interaction with the Plasma network through a set of JSON-RPC methods. Its design is familiar to developers who have worked with Ethereum's JSON-RPC APIs, making it intuitive and straightforward to use. +The Plasma API lets you interact with the Plasma network through a set of JSON-RPC methods. If you've worked with Ethereum's JSON-RPC APIs, the design will feel familiar. -## Send Your First Request on Alchemy +## Send your first request on Alchemy Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a Plasma client connected to Alchemy and fetch the latest block number! @@ -28,7 +28,7 @@ Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a P ``` -## Create Client Connected to Alchemy +## Create a client connected to Alchemy ```js @@ -52,7 +52,7 @@ const client = createPublicClient({ Now that you've created a client connected to Alchemy, you can continue with some basics: -## Get Latest Block Number +## Get the latest block number ```js @@ -61,7 +61,7 @@ console.log("Current block number:", blockNumber); ``` -## Get an Address Balance +## Get an address balance ```js @@ -70,7 +70,7 @@ console.log("Balance (ETH):", Number(balance) / 1e18); ``` -## Read Block Data +## Read block data ```js @@ -81,7 +81,7 @@ console.log(block); ``` -## Fetch a Transaction by Hash +## Fetch a transaction by hash ```js @@ -90,7 +90,7 @@ console.log(tx); ``` -## Fetch Transaction Receipt +## Fetch a transaction receipt ```js diff --git a/content/api-reference/polygon-pos/polygon-api-faq.mdx b/content/api-reference/polygon-pos/polygon-api-faq.mdx index 94702b714..e18d42896 100644 --- a/content/api-reference/polygon-pos/polygon-api-faq.mdx +++ b/content/api-reference/polygon-pos/polygon-api-faq.mdx @@ -7,11 +7,11 @@ slug: reference/polygon-pos-api-faq # What is Polygon? -[Polygon](https://www.alchemy.com/layer2/polygon) is a sidechain, one type of [Ethereum scaling solution](https://www.alchemy.com/overviews/sidechains-vs-layer2s), that runs parallel to the Ethereum Mainnet. Polygon improves transaction speeds and cost compared to the mainnet, making it an excellent solution for Ethereum developers. Originally known as the Matic network, Jaynti Kanani, Sandeep Nailwal, and Anurag Arjun founded Polygon in late 2017. +[Polygon](https://www.alchemy.com/layer2/polygon) is a sidechain, one type of [Ethereum scaling solution](https://www.alchemy.com/overviews/sidechains-vs-layer2s), that runs parallel to the Ethereum mainnet. Polygon improves transaction speeds and cost compared to the mainnet, making it an excellent solution for Ethereum developers. Originally known as the Matic network, Jaynti Kanani, Sandeep Nailwal, and Anurag Arjun founded Polygon in late 2017. # What is the Polygon API? -The Polygon API allows applications to connect to a Polygon node that is part of the Polygon network. Developers can interact with on-chain data and send different types of transactions to the network by utilizing the endpoints provided by the API. The API follows a JSON-RPC standard. JSON-RPC is a stateless, lightweight, remote procedure call (RPC) protocol encoded in JSON. +The Polygon API lets you connect to a Polygon node that is part of the Polygon network. You can interact with onchain data and send different types of transactions to the network using the endpoints provided by the API. The API follows a JSON-RPC standard -- a stateless, lightweight, remote procedure call (RPC) protocol encoded in JSON. ## How can I get started using the Polygon API? @@ -19,21 +19,21 @@ Explained in the [Polygon API Quickstart Guide](/docs/reference/polygon-pos-api- ## Is Polygon EVM compatible? -Yes! Polygon is fully EVM-compatible with all Solidity smart contracts and Ethereum libraries. The Ethereum Virtual Machine is the distributed state machine that allows developers to make smart contracts on Ethereum. Because Polygon is an sidechain scaling solution, operating in conjunction with the Ethereum blockchain, it is fully compatible with EVM and benefits from its functionality. +Yes! Polygon is fully EVM-compatible with all Solidity smart contracts and Ethereum libraries. The Ethereum Virtual Machine is the distributed state machine that lets you create smart contracts on Ethereum. Because Polygon is a sidechain scaling solution operating in conjunction with the Ethereum blockchain, it is fully compatible with EVM and benefits from its functionality. ## What API does Polygon use? Polygon uses the JSON-RPC API standard as its API. The Polygon JSON-RPC API serves as the backbone for the Polygon network and powers any blockchain interaction. -In aggregate, this API suite allows users to read block/transaction data, query chain information, execute smart contracts, store data on-chain, etc. Developers and consumers alike interact with Polygon’s base JSON-RPC APIs to communicate with its decentralized network of nodes. +This API suite lets you read block/transaction data, query chain information, execute smart contracts, store data onchain, and more. You interact with Polygon’s base JSON-RPC APIs to communicate with its decentralized network of nodes. ## What is a Polygon API key? -When accessing the Polygon network via a node provider like Alchemy, Polygon developers use an API key to send and receive transactions from the network. +When accessing the Polygon network via a node provider like Alchemy, you use an API key to send and receive transactions from the network. -While many Polygon development tools like MetaMask have a set of default Polygon RPC endpoints, they are often throttled during periods of high usage leading to slower response times and a higher likelihood of request failures. +While many Polygon development tools like MetaMask have a set of default Polygon RPC endpoints, they are often throttled during periods of high usage, leading to slower response times and a higher likelihood of request failures. -For the best development experience, we recommend that you [sign up for a free API key](https://www.alchemy.com/layer2/polygon)! With a dedicated API key, developers can: +For the best development experience, we recommend you [sign up for a free API key](https://www.alchemy.com/layer2/polygon). With a dedicated API key, you can: * access higher request throughput and increased concurrent requests * query enhanced APIs, gaining access to free archive data, logs, and API abstractions @@ -41,13 +41,13 @@ For the best development experience, we recommend that you [sign up for a free A ## What programming languages work with Polygon? -Many programming languages work with Polygon including Go, Javascript, Solidity, Typescript, and Shell. Javascript and Solidity are some of the best languages to use, Solidity for smart contracts and Javascript for off-chain requests. +Many programming languages work with Polygon including Go, JavaScript, Solidity, TypeScript, and Shell. JavaScript and Solidity are some of the best languages to use -- Solidity for smart contracts and JavaScript for offchain requests. -## How do I add Polygon to MetaMask Mainnet? +## How do I add Polygon to MetaMask mainnet? To connect Polygon to MetaMask, create a Polygon app in Alchemy. To get a dedicated Polygon RPC endpoint, add a new network to MetaMask, and enter the following details: -* **Network Name:** Polygon Mainnet +* **Network Name:** Polygon mainnet * **New RPC URL:** [https://polygon-mainnet.g.alchemy.com/v2/YOUR-API-KEY](https://polygon-mainnet.g.alchemy.com/v2/YOUR-API-KEY) * **Chain ID:** 137 * **Currency Symbol:** MATIC @@ -55,17 +55,17 @@ To connect Polygon to MetaMask, create a Polygon app in Alchemy. To get a dedica ## What testnet should I use for Polygon? -You should use the Mumbai testnet for testing Polygon applications. Mumbai is the testnet of Polygon, and Polygon developers can use a Mumbai faucet to [get test MATIC tokens](https://mumbaifaucet.com/). +You should use the Mumbai testnet for testing Polygon applications. Mumbai is the testnet of Polygon, and you can use a Mumbai faucet to [get test MATIC tokens](https://mumbaifaucet.com/). -If you sign in with your Alchemy account, you’ll get 5x more test MATIC tokens. On Mumbai, developers can get one token in a twenty-four-hour period, and use that on the testnet to make sure their Polygon applications are working properly before putting them on the mainnet. +If you sign in with your Alchemy account, you’ll get 5x more test MATIC tokens. On Mumbai, you can get one token in a twenty-four-hour period and use it on the testnet to make sure your Polygon applications work properly before deploying to mainnet. ## How do I build an app on Polygon? -Simply [sign up for Alchemy](https://www.alchemy.com/layer2/polygon), click the “Apps” tab, “Create App”, and then you can start building your new app for either the Polygon mainnet or the Mumbai test network! +[Sign up for Alchemy](https://www.alchemy.com/layer2/polygon), click the “Apps” tab, then “Create App”, and start building your new app for either the Polygon mainnet or the Mumbai test network. ## What wallets can be used on Polygon? -Developers can use many wallets on Polygon. Some of the most popular wallets include Metamask, Ledger Nano X, and SafePal S1. We give details on many of these wallets in our [Web3 wallet overview](https://www.alchemy.com/web3-wallets-overview). +You can use many wallets on Polygon. Some of the most popular include Metamask, Ledger Nano X, and SafePal S1. We cover many of these wallets in our [Web3 wallet overview](https://www.alchemy.com/web3-wallets-overview). ## What does Polygon use for gas? @@ -91,4 +91,4 @@ You can find the list of all the methods Alchemy supports for the Polygon API on ## My question isn't here, where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/polygon-pos/polygon-api-quickstart.mdx b/content/api-reference/polygon-pos/polygon-api-quickstart.mdx index 8d96edbff..c55ee5ee8 100644 --- a/content/api-reference/polygon-pos/polygon-api-quickstart.mdx +++ b/content/api-reference/polygon-pos/polygon-api-quickstart.mdx @@ -10,7 +10,7 @@ slug: reference/polygon-pos-api-quickstart get started today. -## Send Your First Request on Alchemy +## Send your first request on Alchemy Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create an Ethereum client connected to Alchemy and fetch the latest block number! @@ -24,7 +24,7 @@ Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create an ``` -## Create Client Connected to Alchemy +## Create a client connected to Alchemy ```js @@ -40,7 +40,7 @@ const client = createPublicClient({ Now that you've created a client connected to Alchemy, you can continue with some basics: -## Get Latest Block Number +## Get the latest block number ```js @@ -49,7 +49,7 @@ console.log("Current block number:", blockNumber); ``` -## Get an Address Balance +## Get an address balance ```js @@ -58,7 +58,7 @@ console.log("Balance (ETH):", Number(balance) / 1e18); ``` -## Read Block Data +## Read block data ```js @@ -69,7 +69,7 @@ console.log(block); ``` -## Fetch a Transaction by Hash +## Fetch a transaction by hash ```js @@ -78,7 +78,7 @@ console.log(tx); ``` -## Fetch Transaction Receipt +## Fetch a transaction receipt ```js @@ -91,7 +91,7 @@ console.log(receipt); # Polygon Tutorials -Want to build your first Dapp on Polygon and use Polygon APIs? +Want to build your first dApp on Polygon and use Polygon APIs? Check out the following tutorials to learn how to build on Polygon: diff --git a/content/api-reference/polygon-zkevm/polygon-zkevm-api-quickstart.mdx b/content/api-reference/polygon-zkevm/polygon-zkevm-api-quickstart.mdx index 2a8a4bb68..24f36843a 100644 --- a/content/api-reference/polygon-zkevm/polygon-zkevm-api-quickstart.mdx +++ b/content/api-reference/polygon-zkevm/polygon-zkevm-api-quickstart.mdx @@ -10,11 +10,11 @@ slug: reference/polygon-zkevm-api-quickstart get started today. -Polygon zkEVM is a decentralized Ethereum Layer 2 network that uses cryptographic zero-knowledge proofs to offer validity and quick finality to off-chain transactions. Emulating the Ethereum Virtual Machine (EVM), zkEVM allows for transparent deployment of existing Ethereum smart contracts while enhancing scalability, security, and transaction throughput. By utilizing zkEVM, developers can build decentralized applications with quick finality and improved performance, all within the Ethereum ecosystem. +Polygon zkEVM is a decentralized Ethereum Layer 2 network that uses cryptographic zero-knowledge proofs to offer validity and quick finality to offchain transactions. Emulating the Ethereum Virtual Machine (EVM), zkEVM allows transparent deployment of existing Ethereum smart contracts while enhancing scalability, security, and transaction throughput. With zkEVM, you can build decentralized applications with quick finality and improved performance, all within the Ethereum ecosystem. -The Polygon zkEVM API is a collection of JSON-RPC methods that enable developers to interact with the Polygon zkEVM network. Using the endpoints provided by the API, developers can access up-to-date network data and submit transactions to it. +The Polygon zkEVM API is a collection of JSON-RPC methods that let you interact with the Polygon zkEVM network. Using the endpoints provided by the API, you can access up-to-date network data and submit transactions. -## Send Your First Request on Alchemy +## Send your first request on Alchemy Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a Polygon zkEVM client connected to Alchemy and fetch the latest block number! @@ -28,7 +28,7 @@ Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a P ``` -## Create Client Connected to Alchemy +## Create a client connected to Alchemy ```js @@ -44,7 +44,7 @@ const client = createPublicClient({ Now that you've created a client connected to Alchemy, you can continue with some basics: -## Get Latest Block Number +## Get the latest block number ```js @@ -53,7 +53,7 @@ console.log("Current block number:", blockNumber); ``` -## Get an Address Balance +## Get an address balance ```js @@ -62,7 +62,7 @@ console.log("Balance (ETH):", Number(balance) / 1e18); ``` -## Read Block Data +## Read block data ```js @@ -73,7 +73,7 @@ console.log(block); ``` -## Fetch a Transaction by Hash +## Fetch a transaction by hash ```js @@ -82,7 +82,7 @@ console.log(tx); ``` -## Fetch Transaction Receipt +## Fetch a transaction receipt ```js diff --git a/content/api-reference/pricing-resources/pricing/compute-unit-costs.mdx b/content/api-reference/pricing-resources/pricing/compute-unit-costs.mdx index 64a279f4c..7297f0e84 100644 --- a/content/api-reference/pricing-resources/pricing/compute-unit-costs.mdx +++ b/content/api-reference/pricing-resources/pricing/compute-unit-costs.mdx @@ -10,7 +10,7 @@ slug: "reference/compute-unit-costs" ## What are Compute Units and Throughput Compute Units? -For more details, please check out the [Compute Units](/docs/reference/compute-units#what-are-compute-units) section and the [Throughput Compute Units](/docs/reference/compute-units#what-are-throughput-compute-units) section. +For more details, check out the [Compute Units](/docs/reference/compute-units#what-are-compute-units) section and the [Throughput Compute Units](/docs/reference/compute-units#what-are-throughput-compute-units) section. # EVM: Standard JSON-RPC Methods @@ -81,7 +81,7 @@ For more details, please check out the [Compute Units](/docs/reference/compute-u | eth\_submitWork | 20 | | | batch | CU of method # times called | | -* To view the batch request breakdown in the dashboard, click on "raw request" +* To view the batch request breakdown in the Alchemy Dashboard, click on "raw request" # Solana: Standard JSON-RPC Methods @@ -142,7 +142,7 @@ For more details, please check out the [Compute Units](/docs/reference/compute-u | getLargestAccounts | 3000 | | | batch\* | CU of method # times called | | -* To view the batch request breakdown in the dashboard, click on "raw request" +* To view the batch request breakdown in the Alchemy Dashboard, click on "raw request" # Solana: DAS APIs (NFT/Token) diff --git a/content/api-reference/pricing-resources/pricing/compute-units.mdx b/content/api-reference/pricing-resources/pricing/compute-units.mdx index 90b74e91e..acaf820fe 100644 --- a/content/api-reference/pricing-resources/pricing/compute-units.mdx +++ b/content/api-reference/pricing-resources/pricing/compute-units.mdx @@ -9,20 +9,20 @@ slug: reference/compute-units # What are Compute Units? -Compute units are a measure of the total computational resources your apps are using on Alchemy. You can think of this as how you would pay Amazon for compute usage on AWS. Some queries are lightweight and fast to run (e.g., eth\_blockNumber) and others can be more intense (e.g., large eth\_getLogs queries). Each method is assigned a quantity of compute units, derived from global average durations of each method. +Compute units measure the total computational resources your apps use on Alchemy. Think of this as how you'd pay Amazon for compute usage on AWS. Some queries are lightweight and fast to run (e.g., eth\_blockNumber) and others can be more intense (e.g., large eth\_getLogs queries). Each method is assigned a quantity of compute units, derived from global average durations of each method. -# Why use Compute Units? +# Why use compute units? -We're obsessed with providing the most developer-friendly experience across our platform, and this doesn't stop at pricing. Pricing on compute units allows us to provide developers with the most fair and transparent pricing possible. No more over-paying for simple requests, you only pay for what you use, period. +We're committed to providing the most developer-friendly experience across our platform, and this doesn't stop at pricing. Pricing on compute units lets us provide the most fair and transparent pricing possible. No more overpaying for simple requests -- you only pay for what you use. -# What are CUPS (Compute Units Per Second)? +# What are CUPS (compute units per second)? -Each application has reserved dedicated [Throughput](/docs/reference/throughput), measured in Compute Units per Second. Applications can greatly exceed their dedicated throughputs based off of elastic demand in our system. +Each application has reserved dedicated [Throughput](/docs/reference/throughput), measured in Compute Units per Second. Applications can greatly exceed their dedicated throughputs based on elastic demand in our system. Since each request is weighted differently, we base this on the total compute units used rather than the number of requests. For example, if you send one eth\_blockNumber (10 CUs), two eth\_getLogs (75 CUs), and two eth\_call(26 CUs) requests in the same second, you will have a total of 212 CUPS. Note that even if your application limit is 200 CUPS, this throughput will likely be allowed still by the system. If you are experiencing throughput errors, or want create a more robust and reliable experience for your users, we recommend [implementing retries](/docs/reference/throughput). -# What are Throughput Compute Units? +# What are throughput compute units? Throughput Compute Units define how often you can run the request within your throughput limits. For example, a 500 CU per second limit would be able to run 50 requests per second that cost 10 throughput CUs. The actual cost of the method is still reflected by the CU amount while the threshold CU allows you to increase the number of requests before you hit your rate limit. If there is no throughput CU listed, it defaults to the actual CU cost. diff --git a/content/api-reference/pricing-resources/pricing/pricing-plans.mdx b/content/api-reference/pricing-resources/pricing/pricing-plans.mdx index 476e159e9..7c729866d 100644 --- a/content/api-reference/pricing-resources/pricing/pricing-plans.mdx +++ b/content/api-reference/pricing-resources/pricing/pricing-plans.mdx @@ -5,9 +5,9 @@ subtitle: A guide to understand Alchemy's pricing plans. slug: reference/pricing-plans --- -# Plans Overview +# Plans overview -## Feature Comparison +## Feature comparison | Feature | Free Tier | PAYG | Enterprise Tier | | -------------------------------- | ----------- | ---------- | --------------- | @@ -16,7 +16,7 @@ slug: reference/pricing-plans | 300M+ CU rate | - | $0.40/M CU | Custom | | Base Throughput (CUs/second) | 500 | 10,000 | Custom | | # of apps | 5 | 30 | Unlimited | -| Webhooks | 5 | 50 | 500 | +| webhooks | 5 | 50 | 500 | | Full Archive Data | ✓ | ✓ | ✓ | | Node API | ✓ | ✓ | ✓ | | Debug API | ✗ | ✓ | ✓ | @@ -26,7 +26,7 @@ slug: reference/pricing-plans | Token API | ✓ | ✓ | ✓ | | Transaction Simulation | ✓ | ✓ | ✓ | | Gas-optimized Transactions | ✗ | ✓ | ✓ | -| Smart Websockets | ✓ | ✓ | ✓ | +| Smart WebSockets | ✓ | ✓ | ✓ | | JavaScript SDK | ✓ | ✓ | ✓ | | Analytics & Reporting | ✓ | ✓ | ✓ | | Email Support | ✓ | ✓ | ✓ | diff --git a/content/api-reference/pricing-resources/resources/batch-requests.mdx b/content/api-reference/pricing-resources/resources/batch-requests.mdx index 334d65f4b..ca60bcca2 100644 --- a/content/api-reference/pricing-resources/resources/batch-requests.mdx +++ b/content/api-reference/pricing-resources/resources/batch-requests.mdx @@ -1,27 +1,27 @@ --- title: Batch Requests -description: Best practices for making batch json-rpc requests on Ethereum, Polygon, Optimism, and Arbitrum. -subtitle: Best practices for making batch json-rpc requests on Ethereum, Polygon, Optimism, and Arbitrum. +description: Best practices for making batch JSON-RPC requests on Ethereum, Polygon, Optimism, and Arbitrum. +subtitle: Best practices for making batch JSON-RPC requests on Ethereum, Polygon, Optimism, and Arbitrum. slug: reference/batch-requests --- ## What is a batch request? -Batch requests are a single HTTP request that contain multiple API calls nested within it. Clients can send several request objects together at the same time, filled within an array, will get a corresponding array of response objects from the server. +Batch requests are a single HTTP request that contains multiple API calls nested within it. You can send several request objects together at the same time in an array, and you'll get a corresponding array of response objects from the server. -The server processes all requests of this batch RPC call concurrently, in any order. The response objects returned from a batch RPC can be in any order, the client should match contexts of request objects to response objects based on `id` member of each object. +The server processes all requests of this batch RPC call concurrently, in any order. The response objects returned from a batch RPC can be in any order -- you should match request objects to response objects based on the `id` member of each object. -Also, In several use-cases which contains different JSON-RPC endpoints, the batching approach can get easily complicated. +In several use cases that contain different JSON-RPC endpoints, the batching approach can get complicated. -Due to these above-mentioned reasons, Alchemy does not recommend using batch requests as they can be less reliable compared to individual API calls. +For these reasons, Alchemy does not recommend using batch requests as they can be less reliable compared to individual API calls. ## What is the batch requests limit over HTTP? The batch request limit over HTTP for all methods and chains is **1000 requests per batch**, above this limit requests are likely to be less reliable. -## What is the batch requests limit over WebSockets? +## What is the batch request limit over WebSockets? -The maximum size of a JSON-RPC `batch` request that can be sent over a WebSocket connection is 20. +The maximum size of a JSON-RPC `batch` request that you can send over a WebSocket connection is 20. ## Unsupported batch request APIs @@ -37,7 +37,7 @@ Batch requests are currently not supported on some of the Alchemy's Enhanced API ## How do you make a batch request? -Batch requests are formatted the same as individual API requests however, the body of the request is an array containing the individual API calls you wish to make, rather than the single API call. Check out the example with [eth\_blockNumber](/docs/reference/eth-blocknumber) below: +Batch requests are formatted the same as individual API requests, but the body of the request is an array containing the individual API calls you want to make rather than a single API call. See the example with [eth\_blockNumber](/docs/reference/eth-blocknumber) below: #### Single eth\_blockNumber request @@ -146,4 +146,4 @@ Batch Requests are usually for JSON-RPC endpoints, but Alchemy provides support ## Handling errors in batch requests -Batch requests always return a `200` HTTP status code, even if some or all requests within the batch fail. Therefore, it is important to parse the [JSON-RPC error codes](/docs/reference/error-reference#standard-json-rpc-errors) in the response to determine if the individual requests within the batch succeeded or failed. +Batch requests always return a `200` HTTP status code, even if some or all requests within the batch fail. Parse the [JSON-RPC error codes](/docs/reference/error-reference#standard-json-rpc-errors) in the response to determine if the individual requests within the batch succeeded or failed. diff --git a/content/api-reference/pricing-resources/resources/error-reference.mdx b/content/api-reference/pricing-resources/resources/error-reference.mdx index 176b21250..cf2b12a53 100644 --- a/content/api-reference/pricing-resources/resources/error-reference.mdx +++ b/content/api-reference/pricing-resources/resources/error-reference.mdx @@ -5,9 +5,9 @@ subtitle: Learn about the standard JSON-RPC error codes and Alchemy's custom err slug: reference/error-reference --- -# Identifying an Error Request +# Identifying an error request -When using Alchemy (and in general, web3 development), to understand if your JSON-RPC request was successful or encountered an error, follow these steps: +When using Alchemy (and web3 development in general), follow these steps to understand if your JSON-RPC request was successful or encountered an error: 1. Check the **HTTP Status Code** of the response: @@ -37,9 +37,9 @@ Here are examples of how HTTP responses may look: ``` -Understanding these responses is important for accurately determining the outcome of your requests. +Understanding these responses helps you accurately determine the outcome of your requests. -# HTTP Status Codes +# HTTP status codes HTTP Status codes are standardized numeric codes that are returned by our servers in response to a client's HTTP requests. In general, there are 3 categories of HTTP codes that you might encounter when using Alchemy: `2xx` , `4xx`, and `5xx`. HTTP error response can have any combination of JSON-RPC error codes (even for `2xx` responses). Below are example HTTP error codes and potential solutions. @@ -60,9 +60,9 @@ HTTP Status codes are standardized numeric codes that are returned by our server | | `500` | `-3200` `-32603` | - `Unable to complete request at this time.` - `Block not processed yet. Please try again.` - `internal server error` | **Server error**: unable to complete the request due to server issues or due to the block not being processed yet | - See the [status page](https://status.alchemy.com/) for latest updates - Ensure the requested block is valid, then retry | | | `503` | `-3200` | `Unable to complete request at this time.` | **Server error**: unable to complete the request due to server issues | - See the [status page](https://status.alchemy.com/) for latest updates | -# JSON-RPC Error Codes +# JSON-RPC error codes -For JSON-RPC specific errors, you may receive any of the above HTTP Error codes in addition to the JSON RPC error codes specified below. +For JSON-RPC specific errors, you may receive any of the above HTTP error codes in addition to the JSON-RPC error codes specified below. Error codes range from `-32768` to `-32000`, any code in this range but not defined explicitly is reserved for future use or application-specific errors. For more info on how these are defined check out the [JSON-RPC Error specification docs](https://www.jsonrpc.org/specification#error_object). @@ -78,7 +78,7 @@ Error codes range from `-32768` to `-32000`, any code in this range but not defi | `3` | `execution reverted` | Generally used for `eth_call`, `eth_estimateGas`, `alchemy_getTokenBalances`. The `data` field in the error response will have more details on the root cause. | | `20` to `63` | `Starknet specific errors` | Errors related to Starknet methods. See [https://docs.starkware.co/starkex/api/spot/error\_codes.htmlfor](https://docs.starkware.co/starkex/api/spot/error_codes.html) more details. | -# Error Messages +# Error messages Below are a few common error messages and how to solve them. @@ -90,9 +90,9 @@ Below are a few common error messages and how to solve them. | `Request timed out. Client should retry.` | Gateway timeouts (usually from nodes). | Retry the request. | | `transaction underpriced` | Transaction was sent with too low gas. | Retry the transaction with higher gas. | -# Common Errors +# Common errors -## How to Solve ENOTFOUND getAddrInfo Errors +## How to solve ENOTFOUND getAddrInfo errors **ENOTFOUND getAddrInfo** error is a common issue encountered by developers when trying to make network requests to a specific URL that might not exist any longer. @@ -110,11 +110,11 @@ JavaScript `const apiUrl = ';` -Save the changes you made to your application and run it again. The ENOTFOUND getAddrInfo error should no longer occur since you are now using the updated URL. To confirm that the error has been resolved, check your application's output or script, and you should see successful network requests to the new URL without any ENOTFOUND errors. +Save the changes and run your application again. The ENOTFOUND getAddrInfo error should no longer occur since you're now using the updated URL. To confirm the fix, check your application's output -- you should see successful network requests to the new URL without any ENOTFOUND errors. ## How to solve `ECONNRESET` errors? -`ECONNRESET` errors occur when a TCP connection cannot be established at that time. If you experience `ECONNRESET` errors, please ensure that your client isn not creating a scenario where new connections are unable to be created. Historically, we have only seen client-side issues causing these errors (if the server were rejecting requests indiscriminately, then it would obviously effect multiple clients simultaneously which has never been the case). If you’re hitting a generic `EPROTO` error message, it’s possible you’re facing similar issues. +`ECONNRESET` errors occur when a TCP connection cannot be established at that time. If you experience `ECONNRESET` errors, ensure that your client isn't creating a scenario where new connections can't be created. Historically, we've only seen client-side issues causing these errors (if the server were rejecting requests indiscriminately, then it would affect multiple clients simultaneously which has never been the case). If you’re hitting a generic `EPROTO` error message, it’s possible you’re facing similar issues. Here are some guidelines to limit client side issues: @@ -129,13 +129,13 @@ Here are some guidelines to limit client side issues: 4. Consider enabling HTTP Pipeline (in which you can send more than one request per TCP connection) -5. Ensure systems outside of your production environment are are also not creating too many requests! +5. Ensure systems outside of your production environment are also not creating too many requests. -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. -# How we define “successful” vs. “failed” requests in the dashboard +# How we define “successful” vs. “failed” requests in the Alchemy Dashboard -The dashboard includes various charts that indicate the number of successful or failed request across your applications. A few examples of these include: +The Alchemy Dashboard includes various charts that indicate the number of successful or failed requests across your applications. A few examples include: [Daily Request Health Pie on the Homepage](https://dashboard.alchemy.com/signup) @@ -147,9 +147,9 @@ The dashboard includes various charts that indicate the number of successful or Several other pages including apps list, app details, logs, and more. -The definitions used for “success” and “failure” throughout the dashboard are the following: +The definitions used for “success” and “failure” throughout the Alchemy Dashboard are: * **Success:** HTTP status code is `2xx` **and** the `response.error` field is empty (null). * **Failure:** Any condition that does not meet the success criteria. -These definitions ensure a straightforward approach to interpreting dashboard metrics and aligns with the actual HTTP responses you receive. +These definitions ensure a clear approach to interpreting Alchemy Dashboard metrics and align with the actual HTTP responses you receive. diff --git a/content/api-reference/pricing-resources/resources/throughput.mdx b/content/api-reference/pricing-resources/resources/throughput.mdx index 3e48aeb28..7663ebe42 100644 --- a/content/api-reference/pricing-resources/resources/throughput.mdx +++ b/content/api-reference/pricing-resources/resources/throughput.mdx @@ -21,9 +21,9 @@ Throughput is defined in terms of CU/s (Compute Units Per Second). Some key aspe *** -## Error Response +## Error response -When you exceed your capacity, you will receive an error response. This response will be different depending on whether you are connecting to Alchemy using HTTP or [WebSockets](/docs/reference/subscription-api). +When you exceed your capacity, you receive an error response. This response differs depending on whether you're connecting to Alchemy using HTTP or [WebSockets](/docs/reference/subscription-api). If you would like to test receiving a 429 response, send a POST request to [https://httpstat.us/429](https://httpstat.us/429). @@ -35,7 +35,7 @@ You will receive an HTTP 429 (Too Many Requests) response status code. ### WebSockets -You will receive a JSON-RPC error response with error code 429. For example, the response might be: +You receive a JSON-RPC error response with error code 429. For example, the response might be: ```json json @@ -55,21 +55,21 @@ You will receive a JSON-RPC error response with error code 429. For example, the There are several options for implementing retries. For a deep dive into each option, check out **[How to Implement Retries](/docs/reference/how-to-implement-retries)**. -All you need to do to easily handle 429 errors is to retry the request. This will ensure a great user experiences with any API even if you aren't hitting rate limits. Once you've implemented retries, [test out the behavior](/docs/reference/throughput#test-rate-limits-retries) to make sure they work as expected. +To handle 429 errors, retry the request. This ensures a great experience with any API even if you aren't hitting rate limits. Once you've implemented retries, [test out the behavior](/docs/reference/throughput#test-rate-limits-retries) to make sure they work as expected. ### Option 1: `Retry-After` If you are using HTTP and not WebSockets you may receive a `Retry-After` header in the HTTP response. This indicates how long you should wait before making a follow-up request. We still recommend using [exponential backoff ](/docs/reference/throughput#option-4-exponential-backoff)since `Retry-After` only accepts an integer number of seconds. -### Option 2: Simple Retries +### Option 2: Simple retries If [exponential backoff](/docs/reference/throughput#option-3-exponential-backoff) poses an challenge to you, a simple retry solution is to wait a random interval between 1000 and 1250 milliseconds after receiving a `429` response, and sending the request again, up to some maximum number of attempts you are willing to wait. -### Option 3: Exponential Backoff +### Option 3: Exponential backoff -Exponential backoff is a standard error-handling strategy for network applications. It is a similar solution to retries, however, instead of waiting random intervals, an exponential backoff algorithm retries requests exponentially, increasing the waiting time between retries up to a maximum backoff time. +Exponential backoff is a standard error-handling strategy for network applications. It's similar to retries, but instead of waiting random intervals, an exponential backoff algorithm retries requests exponentially, increasing the waiting time between retries up to a maximum backoff time. -#### Example Algorithm: +#### Example algorithm: 1. Make a request. 2. If the request fails, wait 1 + `random_number_milliseconds` seconds and retry the request. @@ -88,11 +88,11 @@ The client can continue retrying after it has reached the `maximum_backoff` time *** -## Test Throughput & Retries +## Test throughput and retries To test out your implementation of retries, we created a test app on each network with a low throughput of 50 Compute Units/Second. The same key can be used across all the blockchains we support. Feel free to make requests to this test app on any of the networks using the following API keys: -### Ethereum Mainnet, Polygon Mainnet (and other mainnets) +### Ethereum mainnet, Polygon mainnet (and other mainnets) #### HTTP @@ -114,6 +114,6 @@ To test out your implementation of retries, we created a test app on each networ *** -## Any Other Questions? +## Any other questions? -Reach out to support@alchemy.com with any questions! +Reach out to support@alchemy.com with any questions. diff --git a/content/api-reference/rise/rise-api-faq.mdx b/content/api-reference/rise/rise-api-faq.mdx index 7ac6efd95..c3e6ecc65 100644 --- a/content/api-reference/rise/rise-api-faq.mdx +++ b/content/api-reference/rise/rise-api-faq.mdx @@ -12,22 +12,22 @@ RISE is an Ethereum Layer-2 with a parallel EVM and a “based” hybrid rollup Check out our [Rise API Quickstart guide](/docs/reference/rise-api-quickstart) to get started building on Rise. ## What is the Rise API? -The Rise API allows developers to interface with the Rise mainnet. With this API, developers can execute transactions, query on-chain data, and interact with the Rise network, relying on a JSON-RPC standard. +The Rise API lets you interact with the Rise mainnet. You can execute transactions, query onchain data, and interact with the Rise network using a JSON-RPC standard. ## Is Rise EVM compatible? Yes, Rise is EVM compatible. ## What API does Rise use? -Rise uses the JSON-RPC API standard. This API is crucial for any blockchain interaction on the Rise network, allowing users to read block/transaction data, query chain information, execute smart contracts, and store data on-chain. +Rise uses the JSON-RPC API standard. This API handles all blockchain interactions on the Rise network, letting you read block/transaction data, query chain information, execute smart contracts, and store data onchain. ## What methods are supported on Rise? Rise supports standard Ethereum JSON-RPC methods. Some chain-specific methods may vary. Please check the [Rise API Endpoints](/docs/chains#rise-apis) for a complete list. ## What is a Rise API key? -When accessing the Rise network via a node provider like Alchemy, Rise developers use an API key to send transactions and retrieve data from the network. For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup)! +When accessing the Rise network via a node provider like Alchemy, you use an API key to send transactions and retrieve data from the network. For the best development experience, we recommend you [sign up for a free API key](https://dashboard.alchemy.com/signup). ## Which libraries support Rise? Common Ethereum libraries like [ethers.js](https://docs.ethers.org/v5/) should be compatible with Rise, given its EVM nature. ## My question isn’t here, where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/rise/rise-api-quickstart.mdx b/content/api-reference/rise/rise-api-quickstart.mdx index ebc750598..a16cb5789 100644 --- a/content/api-reference/rise/rise-api-quickstart.mdx +++ b/content/api-reference/rise/rise-api-quickstart.mdx @@ -12,9 +12,9 @@ slug: reference/rise-api-quickstart RISE is an Ethereum Layer-2 with a parallel EVM and a "based" hybrid rollup design that targets sub-5 ms confirmations and 100k+ TPS. -The Rise API allows interaction with the Rise network through a set of JSON-RPC methods. Its design is familiar to developers who have worked with Ethereum's JSON-RPC APIs, making it intuitive and straightforward to use. +The Rise API lets you interact with the Rise network through a set of JSON-RPC methods. If you've worked with Ethereum's JSON-RPC APIs, the design will feel familiar. -## Send Your First Request on Alchemy +## Send your first request on Alchemy Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a Rise client connected to Alchemy and fetch the latest block number! @@ -28,7 +28,7 @@ Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a R ``` -## Create Client Connected to Alchemy +## Create a client connected to Alchemy ```js @@ -52,7 +52,7 @@ const client = createPublicClient({ Now that you've created a client connected to Alchemy, you can continue with some basics: -## Get Latest Block Number +## Get the latest block number ```js @@ -61,7 +61,7 @@ console.log("Current block number:", blockNumber); ``` -## Get an Address Balance +## Get an address balance ```js @@ -70,7 +70,7 @@ console.log("Balance (ETH):", Number(balance) / 1e18); ``` -## Read Block Data +## Read block data ```js @@ -81,7 +81,7 @@ console.log(block); ``` -## Fetch a Transaction by Hash +## Fetch a transaction by hash ```js @@ -90,7 +90,7 @@ console.log(tx); ``` -## Fetch Transaction Receipt +## Fetch a transaction receipt ```js diff --git a/content/api-reference/robinhood-chain/robinhood-chain-api-faq.mdx b/content/api-reference/robinhood-chain/robinhood-chain-api-faq.mdx index c21476b80..834d26f4f 100644 --- a/content/api-reference/robinhood-chain/robinhood-chain-api-faq.mdx +++ b/content/api-reference/robinhood-chain/robinhood-chain-api-faq.mdx @@ -12,22 +12,22 @@ Robinhood Chain is a permissionless Ethereum Layer 2 built on Arbitrum, optimize Check out our [Robinhood Chain API Quickstart guide](./robinhood-chain-api-quickstart) to get started building on Robinhood Chain. ## What is the Robinhood Chain API? -The Robinhood Chain API allows developers to interface with the Robinhood Chain network. With this API, developers can execute transactions, query on-chain data, and interact with the Robinhood Chain network, relying on a JSON-RPC standard. +The Robinhood Chain API lets you interact with the Robinhood Chain network. You can execute transactions, query onchain data, and interact with the Robinhood Chain network using a JSON-RPC standard. ## Is Robinhood Chain EVM compatible? Yes, Robinhood Chain is EVM compatible. ## What API does Robinhood Chain use? -Robinhood Chain uses the JSON-RPC API standard. This API is crucial for any blockchain interaction on the Robinhood Chain network, allowing users to read block/transaction data, query chain information, execute smart contracts, and store data on-chain. +Robinhood Chain uses the JSON-RPC API standard. This API handles all blockchain interactions on the Robinhood Chain network, letting you read block/transaction data, query chain information, execute smart contracts, and store data onchain. ## What methods are supported on Robinhood Chain? Robinhood Chain supports standard Ethereum JSON-RPC methods. Some chain-specific methods may vary. Please check the Robinhood Chain API endpoints documentation for a complete list. ## What is a Robinhood Chain API key? -When accessing the Robinhood Chain network via a node provider like Alchemy, Robinhood Chain developers use an API key to send transactions and retrieve data from the network. For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup)! +When accessing the Robinhood Chain network via a node provider like Alchemy, you use an API key to send transactions and retrieve data from the network. For the best development experience, we recommend you [sign up for a free API key](https://dashboard.alchemy.com/signup). ## Which libraries support Robinhood Chain? Common Ethereum libraries like [ethers.js](https://docs.ethers.org/v5/) should be compatible with Robinhood Chain, given its EVM nature. ## My question isn’t here, where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/robinhood-chain/robinhood-chain-api-quickstart.mdx b/content/api-reference/robinhood-chain/robinhood-chain-api-quickstart.mdx index 689f21d4a..2ef4d86ca 100644 --- a/content/api-reference/robinhood-chain/robinhood-chain-api-quickstart.mdx +++ b/content/api-reference/robinhood-chain/robinhood-chain-api-quickstart.mdx @@ -7,19 +7,19 @@ slug: reference/robinhood-chain-api-quickstart *To use the Robinhood Chain API you'll need to [create a free Alchemy account](https://dashboard.alchemy.com/signup) first!* -## Introduction +## What is Robinhood Chain? Robinhood Chain is a permissionless Ethereum Layer 2 built on Arbitrum, optimized for tokenized real-world assets including equities and ETFs, enabling 24/7 onchain trading and self-custody. ## What is the Robinhood Chain API? -The Robinhood Chain API allows interaction with the Robinhood Chain network through a set of JSON-RPC methods. Its design is familiar to developers who have worked with Ethereum's JSON-RPC APIs, making it intuitive and straightforward to use. +The Robinhood Chain API lets you interact with the Robinhood Chain network through a set of JSON-RPC methods. If you've worked with Ethereum's JSON-RPC APIs, the design will feel familiar. -## Getting Started Instructions +## Getting started -### 1. Choose a Package Manager (npm or yarn) +### 1. Choose a package manager (npm or yarn) -Select a package manager to manage your project's dependencies. Choose between `npm` and `yarn` based on your preference or project requirements. +Choose between `npm` and `yarn` based on your preference or project requirements. ```shell npm @@ -33,9 +33,9 @@ Select a package manager to manage your project's dependencies. Choose between ` ``` -### 2. Set Up Your Project +### 2. Set up your project -Open your terminal and execute the following commands to create and initialize your project: +Run the following commands to create and initialize your project: ```shell npm @@ -53,7 +53,7 @@ Open your terminal and execute the following commands to create and initialize y This creates a new directory named `robinhood-chain-api-quickstart` and initializes a Node.js project within it. -### 3. Make Your First Request +### 3. Make your first request Install Axios, a popular HTTP client, to make API requests: @@ -92,11 +92,11 @@ Create an `index.js` file in your project directory and paste the following code ``` -Remember to replace `your-api-key` with your actual Alchemy API key that you can get from your [Alchemy dashboard](https://dashboard.alchemy.com/signup). +Replace `your-api-key` with your actual Alchemy API key from the [Alchemy Dashboard](https://dashboard.alchemy.com/signup). -### 4. Run Your Script +### 4. Run your script -Execute your script to make a request to the Robinhood Chain network: +Run your script to make a request to the Robinhood Chain network: ```shell shell @@ -112,6 +112,6 @@ You should see the latest block information from Robinhood Chain's network outpu ``` -## Next Steps +## Next steps -Congratulations! You've made your first request to the Robinhood Chain network. You can now explore the various JSON-RPC methods available on Robinhood Chain and start building your dApps on this innovative platform. +You've made your first request to the Robinhood Chain network. You can now explore the various JSON-RPC methods available on Robinhood Chain and start building your dApps. diff --git a/content/api-reference/ronin/ronin-api-faq.mdx b/content/api-reference/ronin/ronin-api-faq.mdx index 0a4b3ef3b..be92d4595 100644 --- a/content/api-reference/ronin/ronin-api-faq.mdx +++ b/content/api-reference/ronin/ronin-api-faq.mdx @@ -12,22 +12,22 @@ Ronin is an EVM blockchain built for gaming, secured by Delegated Proof of Stake Check out our [Ronin API Quickstart guide](/docs/reference/ronin-api-quickstart) to get started building on Ronin. ## What is the Ronin API? -The Ronin API allows developers to interface with the Ronin mainnet. With this API, developers can execute transactions, query on-chain data, and interact with the Ronin network, relying on a JSON-RPC standard. +The Ronin API lets you interact with the Ronin mainnet. You can execute transactions, query onchain data, and interact with the Ronin network using a JSON-RPC standard. ## Is Ronin EVM compatible? Yes, Ronin is EVM compatible. ## What API does Ronin use? -Ronin uses the JSON-RPC API standard. This API is crucial for any blockchain interaction on the Ronin network, allowing users to read block/transaction data, query chain information, execute smart contracts, and store data on-chain. +Ronin uses the JSON-RPC API standard. This API handles all blockchain interactions on the Ronin network, letting you read block/transaction data, query chain information, execute smart contracts, and store data onchain. ## What methods are supported on Ronin? Ronin supports standard Ethereum JSON-RPC methods. Some chain-specific methods may vary. Please check the [Ronin API Endpoints](/docs/chains#ronin-apis) for a complete list. ## What is a Ronin API key? -When accessing the Ronin network via a node provider like Alchemy, Ronin developers use an API key to send transactions and retrieve data from the network. For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup)! +When accessing the Ronin network via a node provider like Alchemy, you use an API key to send transactions and retrieve data from the network. For the best development experience, we recommend you [sign up for a free API key](https://dashboard.alchemy.com/signup). ## Which libraries support Ronin? Common Ethereum libraries like [ethers.js](https://docs.ethers.org/v5/) should be compatible with Ronin, given its EVM nature. ## My question isn’t here, where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/ronin/ronin-api-quickstart.mdx b/content/api-reference/ronin/ronin-api-quickstart.mdx index edc9271cf..fcb9dfd95 100644 --- a/content/api-reference/ronin/ronin-api-quickstart.mdx +++ b/content/api-reference/ronin/ronin-api-quickstart.mdx @@ -12,9 +12,9 @@ slug: reference/ronin-api-quickstart Ronin is an EVM blockchain built for gaming, secured by Delegated Proof of Stake, and now adding Ronin zkEVM rollups so studios can launch low-fee L2s for their games. -The Ronin API allows interaction with the Ronin network through a set of JSON-RPC methods. Its design is familiar to developers who have worked with Ethereum's JSON-RPC APIs, making it intuitive and straightforward to use. +The Ronin API lets you interact with the Ronin network through a set of JSON-RPC methods. If you've worked with Ethereum's JSON-RPC APIs, the design will feel familiar. -## Send Your First Request on Alchemy +## Send your first request on Alchemy Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a Ronin client connected to Alchemy and fetch the latest block number! @@ -28,7 +28,7 @@ Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a R ``` -## Create Client Connected to Alchemy +## Create a client connected to Alchemy ```js @@ -44,7 +44,7 @@ const client = createPublicClient({ Now that you've created a client connected to Alchemy, you can continue with some basics: -## Get Latest Block Number +## Get the latest block number ```js @@ -53,7 +53,7 @@ console.log("Current block number:", blockNumber); ``` -## Get an Address Balance +## Get an address balance ```js @@ -62,7 +62,7 @@ console.log("Balance (RON):", Number(balance) / 1e18); ``` -## Read Block Data +## Read block data ```js @@ -73,7 +73,7 @@ console.log(block); ``` -## Fetch a Transaction by Hash +## Fetch a transaction by hash ```js @@ -82,7 +82,7 @@ console.log(tx); ``` -## Fetch Transaction Receipt +## Fetch a transaction receipt ```js diff --git a/content/api-reference/rootstock/rootstock-api-faq.mdx b/content/api-reference/rootstock/rootstock-api-faq.mdx index 28f226d1d..d32a609d2 100644 --- a/content/api-reference/rootstock/rootstock-api-faq.mdx +++ b/content/api-reference/rootstock/rootstock-api-faq.mdx @@ -27,7 +27,7 @@ Rootstock utilizes the JSON-RPC API standard, which is widely used in the Ethere ## What is an Rootstock API key? -When accessing the Rootstock network via a service provider, developers need an API key to send transactions and retrieve data. An API key ensures secure and authenticated access to the network. +When accessing the Rootstock network via a service provider, you need an API key to send transactions and retrieve data. An API key ensures secure and authenticated access to the network. ## Which libraries support Rootstock? @@ -35,7 +35,7 @@ As an EVM-compatible blockchain, Rootstock supports popular Ethereum libraries s ## What programming languages work with Rootstock? -Rootstock supports Solidity for smart contract development due to its EVM compatibility. For off-chain interactions, developers can use JavaScript, TypeScript, or other common web development languages. +Rootstock supports Solidity for smart contract development due to its EVM compatibility. For offchain interactions, you can use JavaScript, TypeScript, or other common web development languages. ## What does Rootstock use for gas? @@ -51,4 +51,4 @@ The Powpeg is Rootstock's security mechanism based on a layered "defence-in-dept ## My question isn't here, where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/rootstock/rootstock-api-quickstart.mdx b/content/api-reference/rootstock/rootstock-api-quickstart.mdx index a0cf7a3cd..131df51f7 100644 --- a/content/api-reference/rootstock/rootstock-api-quickstart.mdx +++ b/content/api-reference/rootstock/rootstock-api-quickstart.mdx @@ -12,9 +12,9 @@ slug: reference/rootstock-api-quickstart Rootstock is the first and longest-lasting Bitcoin sidechain, combining the security of Bitcoin's proof of work with Ethereum's smart contract capabilities. It's an open-source, EVM-compatible platform secured by over 60% of Bitcoin's hashing power, allowing developers to build trustless, innovative dApps within a thriving ecosystem. -The Rootstock API allows interaction with the Rootstock network through a set of JSON-RPC methods. Its design is familiar to developers who have worked with Ethereum's JSON-RPC APIs, making it intuitive and straightforward to use. +The Rootstock API lets you interact with the Rootstock network through a set of JSON-RPC methods. If you've worked with Ethereum's JSON-RPC APIs, the design will feel familiar. -## Send Your First Request on Alchemy +## Send your first request on Alchemy Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a Rootstock client connected to Alchemy and fetch the latest block number! @@ -28,7 +28,7 @@ Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a R ``` -## Create Client Connected to Alchemy +## Create a client connected to Alchemy ```js @@ -44,7 +44,7 @@ const client = createPublicClient({ Now that you've created a client connected to Alchemy, you can continue with some basics: -## Get Latest Block Number +## Get the latest block number ```js @@ -53,7 +53,7 @@ console.log("Current block number:", blockNumber); ``` -## Get an Address Balance +## Get an address balance ```js @@ -62,7 +62,7 @@ console.log("Balance (RBTC):", Number(balance) / 1e18); ``` -## Read Block Data +## Read block data ```js @@ -73,7 +73,7 @@ console.log(block); ``` -## Fetch a Transaction by Hash +## Fetch a transaction by hash ```js @@ -82,7 +82,7 @@ console.log(tx); ``` -## Fetch Transaction Receipt +## Fetch a transaction receipt ```js diff --git a/content/api-reference/scroll/scroll-chain-api-faq.mdx b/content/api-reference/scroll/scroll-chain-api-faq.mdx index 1f9b4dccd..32f1ab937 100644 --- a/content/api-reference/scroll/scroll-chain-api-faq.mdx +++ b/content/api-reference/scroll/scroll-chain-api-faq.mdx @@ -27,9 +27,9 @@ Scroll Chain uses the JSON-RPC API standard for blockchain interactions. This is ## What is a Scroll Chain API key? -When accessing the Scroll Chain network via a node provider like Alchemy, developers use an API key to send transactions and retrieve data from the network. +When accessing the Scroll Chain network via a node provider like Alchemy, you use an API key to send transactions and retrieve data from the network. -For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup)! +For the best development experience, we recommend you [sign up for a free API key](https://dashboard.alchemy.com/signup). ## Which libraries support Scroll Chain? @@ -37,7 +37,7 @@ Given Scroll Chain's EVM compatibility, popular Ethereum libraries like ethers.j ## What programming languages work with Scroll Chain? -Similar to Ethereum, Scroll Chain supports a range of programming languages for blockchain interaction and smart contract development, including Solidity for smart contracts, as well as JavaScript and TypeScript for dApp development and off-chain interactions. +Similar to Ethereum, Scroll Chain supports a range of programming languages for blockchain interaction and smart contract development, including Solidity for smart contracts and JavaScript and TypeScript for dApp development and offchain interactions. ## What does Scroll Chain use for gas? @@ -49,4 +49,4 @@ You can find the list of all the methods Alchemy supports for the Scroll Chain A ## My question isn't here, where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/scroll/scroll-chain-api-quickstart.mdx b/content/api-reference/scroll/scroll-chain-api-quickstart.mdx index d1eca4a7e..7183384cb 100644 --- a/content/api-reference/scroll/scroll-chain-api-quickstart.mdx +++ b/content/api-reference/scroll/scroll-chain-api-quickstart.mdx @@ -12,9 +12,9 @@ slug: reference/scroll-api-quickstart Scroll is an EVM-compatible blockchain designed to provide scalability and efficiency for decentralized applications (dApps). Known for its high throughput and low transaction costs, Scroll offers a robust environment for deploying Ethereum-based applications. -The Scroll API facilitates interaction with the Scroll network through a collection of JSON-RPC methods. Given its compatibility with the Ethereum ecosystem, developers familiar with Ethereum's JSON-RPC APIs will find working with Scroll both intuitive and straightforward. +The Scroll API lets you interact with the Scroll network through a collection of JSON-RPC methods. If you're familiar with Ethereum's JSON-RPC APIs, working with Scroll will feel natural. -## Send Your First Request on Alchemy +## Send your first request on Alchemy Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a Scroll client connected to Alchemy and fetch the latest block number! @@ -28,7 +28,7 @@ Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a S ``` -## Create Client Connected to Alchemy +## Create a client connected to Alchemy ```js @@ -44,7 +44,7 @@ const client = createPublicClient({ Now that you've created a client connected to Alchemy, you can continue with some basics: -## Get Latest Block Number +## Get the latest block number ```js @@ -53,7 +53,7 @@ console.log("Current block number:", blockNumber); ``` -## Get an Address Balance +## Get an address balance ```js @@ -62,7 +62,7 @@ console.log("Balance (ETH):", Number(balance) / 1e18); ``` -## Read Block Data +## Read block data ```js @@ -73,7 +73,7 @@ console.log(block); ``` -## Fetch a Transaction by Hash +## Fetch a transaction by hash ```js @@ -82,7 +82,7 @@ console.log(tx); ``` -## Fetch Transaction Receipt +## Fetch a transaction receipt ```js diff --git a/content/api-reference/sei/sei-api-faq.mdx b/content/api-reference/sei/sei-api-faq.mdx index fc02822ea..b9bddd461 100644 --- a/content/api-reference/sei/sei-api-faq.mdx +++ b/content/api-reference/sei/sei-api-faq.mdx @@ -27,9 +27,9 @@ Sei uses the JSON-RPC API standard for blockchain interactions. This is the same ## What is a Sei API key? -When accessing the Sei network via a node provider like Alchemy, developers use an API key to send transactions and retrieve data from the network. +When accessing the Sei network via a node provider like Alchemy, you use an API key to send transactions and retrieve data from the network. -For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup)! +For the best development experience, we recommend you [sign up for a free API key](https://dashboard.alchemy.com/signup). ## Which libraries support Sei? @@ -37,7 +37,7 @@ Given Sei's EVM compatibility, popular Ethereum libraries like ethers.js and web ## What programming languages work with Sei? -Similar to Ethereum, Sei supports a range of programming languages for blockchain interaction and smart contract development, including Solidity for smart contracts, as well as JavaScript and TypeScript for dApp development and off-chain interactions. +Similar to Ethereum, Sei supports a range of programming languages for blockchain interaction and smart contract development, including Solidity for smart contracts and JavaScript and TypeScript for dApp development and offchain interactions. ## What does Sei use for gas? @@ -49,4 +49,4 @@ You can find the list of all the methods Alchemy supports for the Sei API on the ## My question isn't here, where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/sei/sei-api-quickstart.mdx b/content/api-reference/sei/sei-api-quickstart.mdx index fc6628da7..95e3052f1 100644 --- a/content/api-reference/sei/sei-api-quickstart.mdx +++ b/content/api-reference/sei/sei-api-quickstart.mdx @@ -12,9 +12,9 @@ slug: reference/sei-api-quickstart Sei is a high-performance blockchain designed for decentralized finance (DeFi) applications. It offers fast transaction speeds, scalability, and a developer-friendly environment, making it an ideal platform for deploying DeFi applications and services. -The Sei API allows developers to interact with the Sei network through a collection of JSON-RPC methods. Given its compatibility with standard blockchain APIs, developers familiar with other blockchain JSON-RPC APIs will find working with Sei intuitive and straightforward. +The Sei API lets you interact with the Sei network through a collection of JSON-RPC methods. If you're familiar with other blockchain JSON-RPC APIs, working with Sei will feel natural. -## Send Your First Request on Alchemy +## Send your first request on Alchemy Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a Sei client connected to Alchemy and fetch the latest block number! @@ -28,7 +28,7 @@ Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a S ``` -## Create Client Connected to Alchemy +## Create a client connected to Alchemy ```js @@ -44,7 +44,7 @@ const client = createPublicClient({ Now that you've created a client connected to Alchemy, you can continue with some basics: -## Get Latest Block Number +## Get the latest block number ```js @@ -53,7 +53,7 @@ console.log("Current block number:", blockNumber); ``` -## Get an Address Balance +## Get an address balance ```js @@ -62,7 +62,7 @@ console.log("Balance (SEI):", Number(balance) / 1e18); ``` -## Read Block Data +## Read block data ```js @@ -73,7 +73,7 @@ console.log(block); ``` -## Fetch a Transaction by Hash +## Fetch a transaction by hash ```js @@ -82,7 +82,7 @@ console.log(tx); ``` -## Fetch Transaction Receipt +## Fetch a transaction receipt ```js diff --git a/content/api-reference/settlus/settlus-api-faq.mdx b/content/api-reference/settlus/settlus-api-faq.mdx index 57f5f4860..78ee3f339 100644 --- a/content/api-reference/settlus/settlus-api-faq.mdx +++ b/content/api-reference/settlus/settlus-api-faq.mdx @@ -12,22 +12,22 @@ Settlus is an OP Stack–based Ethereum Layer-2 for the creator economy, offerin Check out our [Settlus API Quickstart guide](/docs/reference/settlus-api-quickstart) to get started building on Settlus. ## What is the Settlus API? -The Settlus API allows developers to interface with the Settlus mainnet. With this API, developers can execute transactions, query on-chain data, and interact with the Settlus network, relying on a JSON-RPC standard. +The Settlus API lets you interact with the Settlus mainnet. You can execute transactions, query onchain data, and interact with the Settlus network using a JSON-RPC standard. ## Is Settlus EVM compatible? Yes, Settlus is EVM compatible. ## What API does Settlus use? -Settlus uses the JSON-RPC API standard. This API is crucial for any blockchain interaction on the Settlus network, allowing users to read block/transaction data, query chain information, execute smart contracts, and store data on-chain. +Settlus uses the JSON-RPC API standard. This API handles all blockchain interactions on the Settlus network, letting you read block/transaction data, query chain information, execute smart contracts, and store data onchain. ## What methods are supported on Settlus? Settlus supports standard Ethereum JSON-RPC methods. Some chain-specific methods may vary. Please check the [Settlus API Endpoints](/docs/chains#settlus-apis) for a complete list. ## What is a Settlus API key? -When accessing the Settlus network via a node provider like Alchemy, Settlus developers use an API key to send transactions and retrieve data from the network. For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup)! +When accessing the Settlus network via a node provider like Alchemy, you use an API key to send transactions and retrieve data from the network. For the best development experience, we recommend you [sign up for a free API key](https://dashboard.alchemy.com/signup). ## Which libraries support Settlus? Common Ethereum libraries like [ethers.js](https://docs.ethers.org/v5/) should be compatible with Settlus, given its EVM nature. ## My question isn’t here, where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/settlus/settlus-api-quickstart.mdx b/content/api-reference/settlus/settlus-api-quickstart.mdx index c1c1586a9..800b65806 100644 --- a/content/api-reference/settlus/settlus-api-quickstart.mdx +++ b/content/api-reference/settlus/settlus-api-quickstart.mdx @@ -12,9 +12,9 @@ slug: reference/settlus-api-quickstart Settlus is an OP Stack–based Ethereum Layer-2 for the creator economy, offering transparent settlement, programmable payouts, and on-chain royalty tools. -The Settlus API allows interaction with the Settlus network through a set of JSON-RPC methods. Its design is familiar to developers who have worked with Ethereum's JSON-RPC APIs, making it intuitive and straightforward to use. +The Settlus API lets you interact with the Settlus network through a set of JSON-RPC methods. If you've worked with Ethereum's JSON-RPC APIs, the design will feel familiar. -## Send Your First Request on Alchemy +## Send your first request on Alchemy Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a Settlus client connected to Alchemy and fetch the latest block number! @@ -28,7 +28,7 @@ Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a S ``` -## Create Client Connected to Alchemy +## Create a client connected to Alchemy ```js @@ -52,7 +52,7 @@ const client = createPublicClient({ Now that you've created a client connected to Alchemy, you can continue with some basics: -## Get Latest Block Number +## Get the latest block number ```js @@ -61,7 +61,7 @@ console.log("Current block number:", blockNumber); ``` -## Get an Address Balance +## Get an address balance ```js @@ -70,7 +70,7 @@ console.log("Balance (SETL):", Number(balance) / 1e18); ``` -## Read Block Data +## Read block data ```js @@ -81,7 +81,7 @@ console.log(block); ``` -## Fetch a Transaction by Hash +## Fetch a transaction by hash ```js @@ -90,7 +90,7 @@ console.log(tx); ``` -## Fetch Transaction Receipt +## Fetch a transaction receipt ```js diff --git a/content/api-reference/shape/shape-api-faq.mdx b/content/api-reference/shape/shape-api-faq.mdx index e46039708..bde186828 100644 --- a/content/api-reference/shape/shape-api-faq.mdx +++ b/content/api-reference/shape/shape-api-faq.mdx @@ -31,7 +31,7 @@ Shape is built on top of Ethereum and inherits its security. It's designed to be ## What programming languages work with Shape? -Shape supports Solidity for smart contract development due to its EVM equivalence. For off-chain interactions, developers can use JavaScript, TypeScript, or other common web development languages. +Shape supports Solidity for smart contract development due to its EVM equivalence. For offchain interactions, you can use JavaScript, TypeScript, or other common web development languages. ## Is Shape secure? @@ -39,4 +39,4 @@ Shape inherits its security directly from Ethereum, ensuring a high level of sec ## My question isn't here, where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/shape/shape-api-quickstart.mdx b/content/api-reference/shape/shape-api-quickstart.mdx index 086d012b1..792bfa703 100644 --- a/content/api-reference/shape/shape-api-quickstart.mdx +++ b/content/api-reference/shape/shape-api-quickstart.mdx @@ -12,9 +12,9 @@ slug: reference/shape-api-quickstart Shape is a chain for creators built on top of Ethereum. It's an open space where everyone is free to create, from fine art to experimental projects, fostering a unique cultural ecosystem. Shape offers creators the opportunity to claim back 80% of sequencer fees users spend interacting with their contracts, making it an attractive platform for innovative content creation. -The Shape API allows interaction with the Shape network through a set of JSON-RPC methods. Its design is familiar to developers who have worked with Ethereum's JSON-RPC APIs, making it intuitive and straightforward to use. +The Shape API lets you interact with the Shape network through a set of JSON-RPC methods. If you've worked with Ethereum's JSON-RPC APIs, the design will feel familiar. -## Send Your First Request on Alchemy +## Send your first request on Alchemy Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a Shape client connected to Alchemy and fetch the latest block number! @@ -28,7 +28,7 @@ Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a S ``` -## Create Client Connected to Alchemy +## Create a client connected to Alchemy ```js @@ -44,7 +44,7 @@ const client = createPublicClient({ Now that you've created a client connected to Alchemy, you can continue with some basics: -## Get Latest Block Number +## Get the latest block number ```js @@ -53,7 +53,7 @@ console.log("Current block number:", blockNumber); ``` -## Get an Address Balance +## Get an address balance ```js @@ -62,7 +62,7 @@ console.log("Balance (ETH):", Number(balance) / 1e18); ``` -## Read Block Data +## Read block data ```js @@ -73,7 +73,7 @@ console.log(block); ``` -## Fetch a Transaction by Hash +## Fetch a transaction by hash ```js @@ -82,7 +82,7 @@ console.log(tx); ``` -## Fetch Transaction Receipt +## Fetch a transaction receipt ```js diff --git a/content/api-reference/solana/accounts-db-infra.mdx b/content/api-reference/solana/accounts-db-infra.mdx index b40a40967..fb595b51f 100644 --- a/content/api-reference/solana/accounts-db-infra.mdx +++ b/content/api-reference/solana/accounts-db-infra.mdx @@ -7,7 +7,7 @@ slug: docs/solana/accounts-db-infra The most expensive Solana RPC requests involve account scans, such as `getProgramAccounts` and `getLargestTokenAccounts`. These methods are incredibly useful but non-performant methods since they induce a heavy RPC load on Solana validator nodes, often resulting in a 5XX response due to timeout or a response with high latency. -Alchemy has built out core infrastructure that sits atop our Solana validator nodes to support these methods at scale, through what we call the AccountsDB Infrastructure. This infrastructure allows for **faster**, **scalable**, and more **reliable** responses to these methods by paginating the response with a `pageKey`. You could then loop through your that same request with at scan and aggregate the full response from our validator nodes. +Alchemy has built core infrastructure that sits atop our Solana validator nodes to support these methods at scale, through what we call the AccountsDB Infrastructure. This infrastructure provides **faster**, **scalable**, and more **reliable** responses to these methods by paginating the response with a `pageKey`. You can then loop through the same request with a scan and aggregate the full response from our validator nodes. You can see `pageKey` is now an optional parameter in each account-scanning method in our Solana [docs](/docs/reference/getprogramaccounts), and you may also include an `order` optional parameter that would sort the accounts in the response by their `pubkey` field. diff --git a/content/api-reference/solana/solana-api-faq.mdx b/content/api-reference/solana/solana-api-faq.mdx index 1792660d9..4367baa4c 100644 --- a/content/api-reference/solana/solana-api-faq.mdx +++ b/content/api-reference/solana/solana-api-faq.mdx @@ -11,7 +11,7 @@ Solana is a high-performance blockchain platform designed to support the scale, ## What is the Solana API? -The Solana API allows decentralized applications to connect to a Solana node that is part of the Solana blockchain. Developers can interact with on-chain data, send transactions, and deploy contracts by leveraging Alchemy's API endpoints. The API follows a JSON-RPC standard, a lightweight, remote procedure call (RPC) protocol that is commonly used when interacting with blockchain data. +The Solana API lets you connect to a Solana node that is part of the Solana blockchain. You can interact with onchain data, send transactions, and deploy contracts using Alchemy's API endpoints. The API follows a JSON-RPC standard, a lightweight, remote procedure call (RPC) protocol commonly used when interacting with blockchain data. ## How can I get started using the Solana API? diff --git a/content/api-reference/solana/solana-api-quickstart.mdx b/content/api-reference/solana/solana-api-quickstart.mdx index a4399983c..2cce36a04 100644 --- a/content/api-reference/solana/solana-api-quickstart.mdx +++ b/content/api-reference/solana/solana-api-quickstart.mdx @@ -10,7 +10,7 @@ slug: reference/solana-api-quickstart get started today. -## Send Your First Request on Alchemy +## Send your first request on Alchemy Let's use [`@solana/web3.js`](https://www.npmjs.com/package/@solana/web3.js) package to set up a `Connection` with Alchemy and get the latest slot on Solana! @@ -24,7 +24,7 @@ Let's use [`@solana/web3.js`](https://www.npmjs.com/package/@solana/web3.js) pac ``` -## Create Connection to Alchemy +## Create a connection to Alchemy ```js @@ -42,7 +42,7 @@ Let's use [`@solana/web3.js`](https://www.npmjs.com/package/@solana/web3.js) pac Now that you've set up a connection to Alchemy, you can continue with some basics: -## Create a Wallet +## Create a wallet ```js @@ -53,7 +53,7 @@ Now that you've set up a connection to Alchemy, you can continue with some basic ``` -## Check Wallet Balance +## Check wallet balance ```js @@ -62,7 +62,7 @@ Now that you've set up a connection to Alchemy, you can continue with some basic ``` -## Fetch Account Info +## Fetch account info ```js @@ -71,7 +71,7 @@ Now that you've set up a connection to Alchemy, you can continue with some basic ``` -## Find Solana Methods by Category +## Find Solana methods by category @@ -98,7 +98,7 @@ Want to estimate your Solana Compute Units (CUs) before running transactions?\ # Solana Tutorials -You must not stop here! Check out the following tutorials to learn how to build with Solana: +Check out the following tutorials to learn how to build with Solana: * [Hello World Solana Program](/docs/hello-world-solana-program) * [How to Integrate a Solana Program with a Web3 Application](/docs/hello-world-solana-application) diff --git a/content/api-reference/soneium/soneium-api-faq.mdx b/content/api-reference/soneium/soneium-api-faq.mdx index 38d45d905..13d716b2d 100644 --- a/content/api-reference/soneium/soneium-api-faq.mdx +++ b/content/api-reference/soneium/soneium-api-faq.mdx @@ -27,9 +27,9 @@ Soneium utilizes the JSON-RPC API standard, which is widely used in the Ethereum ## What is a Soneium API key? -When accessing the Soneium network via a service provider like Alchemy, developers need an API key to send transactions and retrieve data. An API key ensures secure and authenticated access to the network. +When accessing the Soneium network via a service provider like Alchemy, you need an API key to send transactions and retrieve data. An API key ensures secure and authenticated access to the network. -For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup)! +For the best development experience, we recommend you [sign up for a free API key](https://dashboard.alchemy.com/signup). ## Which libraries support Soneium? @@ -37,7 +37,7 @@ As an EVM-compatible blockchain, Soneium supports popular Ethereum libraries suc ## What programming languages work with Soneium? -Soneium supports Solidity for smart contract development due to its EVM compatibility. For off-chain interactions, developers can use JavaScript, TypeScript, or other common web development languages. +Soneium supports Solidity for smart contract development due to its EVM compatibility. For offchain interactions, you can use JavaScript, TypeScript, or other common web development languages. ## What does Soneium use for gas? @@ -49,4 +49,4 @@ For a comprehensive list of methods supported by Alchemy for the Soneium API, pl ## My question isn't here, where can I get help? -If you have any questions or feedback, please refer to the official Soneium documentation, contact us at support@alchemy.com, or open a ticket in the dashboard. +If you have any questions or feedback, refer to the official Soneium documentation, contact us at support@alchemy.com, or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/soneium/soneium-api-quickstart.mdx b/content/api-reference/soneium/soneium-api-quickstart.mdx index 97a8dd723..58a56cba2 100644 --- a/content/api-reference/soneium/soneium-api-quickstart.mdx +++ b/content/api-reference/soneium/soneium-api-quickstart.mdx @@ -12,9 +12,9 @@ slug: reference/soneium-api-quickstart Soneium is an innovative Ethereum Layer 2 blockchain platform developed by Sony Block Solutions Labs. It aims to integrate Web3 technologies into everyday life, creating an inclusive digital world where everyone can be a creator and innovator. Soneium offers a robust infrastructure for developers to build impactful decentralized applications (dApps) and digital assets, while providing users with a secure and user-friendly environment for interacting with blockchain technology. -The Soneium API allows interaction with the Soneium network through a set of JSON-RPC methods. Its design is familiar to developers who have worked with Ethereum's JSON-RPC APIs, making it intuitive and straightforward to use. +The Soneium API lets you interact with the Soneium network through a set of JSON-RPC methods. If you've worked with Ethereum's JSON-RPC APIs, the design will feel familiar. -## Send Your First Request on Alchemy +## Send your first request on Alchemy Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a Soneium client connected to Alchemy and fetch the latest block number! @@ -28,7 +28,7 @@ Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a S ``` -## Create Client Connected to Alchemy +## Create a client connected to Alchemy ```js @@ -44,7 +44,7 @@ const client = createPublicClient({ Now that you've created a client connected to Alchemy, you can continue with some basics: -## Get Latest Block Number +## Get the latest block number ```js @@ -53,7 +53,7 @@ console.log("Current block number:", blockNumber); ``` -## Get an Address Balance +## Get an address balance ```js @@ -62,7 +62,7 @@ console.log("Balance (ETH):", Number(balance) / 1e18); ``` -## Read Block Data +## Read block data ```js @@ -73,7 +73,7 @@ console.log(block); ``` -## Fetch a Transaction by Hash +## Fetch a transaction by hash ```js @@ -82,7 +82,7 @@ console.log(tx); ``` -## Fetch Transaction Receipt +## Fetch a transaction receipt ```js diff --git a/content/api-reference/sonic/sonic-api-faq.mdx b/content/api-reference/sonic/sonic-api-faq.mdx index f73ece00c..ce327f7b6 100644 --- a/content/api-reference/sonic/sonic-api-faq.mdx +++ b/content/api-reference/sonic/sonic-api-faq.mdx @@ -29,7 +29,7 @@ Sonic Chain uses the JSON-RPC API standard for blockchain interactions. This is When accessing the Sonic Chain network via a node provider like Alchemy, developers use an API key to send transactions and retrieve data from the network. -For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup)! +For the best development experience, we recommend you [sign up for a free API key](https://dashboard.alchemy.com/signup). ## Which libraries support Sonic Chain? @@ -37,7 +37,7 @@ Given Sonic Chain's EVM compatibility, popular Ethereum libraries like ethers.js ## What programming languages work with Sonic Chain? -Similar to Ethereum, Sonic Chain supports a range of programming languages for blockchain interaction and smart contract development, including Solidity for smart contracts, as well as JavaScript and TypeScript for dApp development and off-chain interactions. +Similar to Ethereum, Sonic Chain supports a range of programming languages for blockchain interaction and smart contract development, including Solidity for smart contracts, as well as JavaScript and TypeScript for dApp development and offchain interactions. ## What does Sonic Chain use for gas? @@ -49,4 +49,4 @@ You can find the list of all the methods Alchemy supports for the Sonic Chain AP ## My question isn't here, where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/sonic/sonic-api-quickstart.mdx b/content/api-reference/sonic/sonic-api-quickstart.mdx index d2c6cf271..f8a595a6d 100644 --- a/content/api-reference/sonic/sonic-api-quickstart.mdx +++ b/content/api-reference/sonic/sonic-api-quickstart.mdx @@ -12,9 +12,9 @@ slug: reference/sonic-api-quickstart Sonic is an EVM-compatible, high-performance, scalable, and secure layer-1 blockchain. With over 10,000 TPS, one-second confirmation times, and low-cost transactions, it provides a robust platform for decentralized applications (dApps) and Ethereum-based deployments. -The Sonic API allows interaction with the Sonic network through a set of JSON-RPC methods. Its design is familiar to developers who have worked with Ethereum's JSON-RPC APIs, making it intuitive and straightforward to use. +The Sonic API lets you interact with the Sonic network through a set of JSON-RPC methods. If you've worked with Ethereum's JSON-RPC APIs, the design will feel familiar. -## Send Your First Request on Alchemy +## Send your first request on Alchemy Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a Sonic client connected to Alchemy and fetch the latest block number! @@ -28,7 +28,7 @@ Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a S ``` -## Create Client Connected to Alchemy +## Create a client connected to Alchemy ```js @@ -44,7 +44,7 @@ const client = createPublicClient({ Now that you've created a client connected to Alchemy, you can continue with some basics: -## Get Latest Block Number +## Get the latest block number ```js @@ -53,7 +53,7 @@ console.log("Current block number:", blockNumber); ``` -## Get an Address Balance +## Get an address balance ```js @@ -62,7 +62,7 @@ console.log("Balance (S):", Number(balance) / 1e18); ``` -## Read Block Data +## Read block data ```js @@ -73,7 +73,7 @@ console.log(block); ``` -## Fetch a Transaction by Hash +## Fetch a transaction by hash ```js @@ -82,7 +82,7 @@ console.log(tx); ``` -## Fetch Transaction Receipt +## Fetch a transaction receipt ```js diff --git a/content/api-reference/stable/stable-api-faq.mdx b/content/api-reference/stable/stable-api-faq.mdx index aeb4d4a1c..a6340c87a 100644 --- a/content/api-reference/stable/stable-api-faq.mdx +++ b/content/api-reference/stable/stable-api-faq.mdx @@ -12,22 +12,22 @@ Stable is a high-performance, EVM-compatible Layer 1 blockchain with USDT as the Check out our [Stable API Quickstart guide](./stable-api-quickstart) to get started building on Stable. ## What is the Stable API? -The Stable API allows developers to interface with the Stable network. With this API, developers can execute transactions, query on-chain data, and interact with the Stable network, relying on a JSON-RPC standard. +The Stable API lets you interact with the Stable network. You can execute transactions, query onchain data, and interact with the Stable network using a JSON-RPC standard. ## Is Stable EVM compatible? Yes, Stable is EVM compatible. ## What API does Stable use? -Stable uses the JSON-RPC API standard. This API is crucial for any blockchain interaction on the Stable network, allowing users to read block/transaction data, query chain information, execute smart contracts, and store data on-chain. +Stable uses the JSON-RPC API standard. This API handles all blockchain interactions on the Stable network, letting you read block/transaction data, query chain information, execute smart contracts, and store data onchain. ## What methods are supported on Stable? Stable supports standard Ethereum JSON-RPC methods. Some chain-specific methods may vary. Please check the Stable API endpoints documentation for a complete list. ## What is a Stable API key? -When accessing the Stable network via a node provider like Alchemy, Stable developers use an API key to send transactions and retrieve data from the network. For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup)! +When accessing the Stable network via a node provider like Alchemy, you use an API key to send transactions and retrieve data from the network. For the best development experience, we recommend you [sign up for a free API key](https://dashboard.alchemy.com/signup). ## Which libraries support Stable? Common Ethereum libraries like [ethers.js](https://docs.ethers.org/v5/) should be compatible with Stable, given its EVM nature. ## My question isn’t here, where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/stable/stable-api-quickstart.mdx b/content/api-reference/stable/stable-api-quickstart.mdx index 4571c81fc..a9c5e9783 100644 --- a/content/api-reference/stable/stable-api-quickstart.mdx +++ b/content/api-reference/stable/stable-api-quickstart.mdx @@ -7,19 +7,19 @@ slug: reference/stable-api-quickstart *To use the Stable API you'll need to [create a free Alchemy account](https://dashboard.alchemy.com/signup) first!* -## Introduction +## What is Stable? Stable is a high-performance, EVM-compatible Layer 1 blockchain with USDT as the native gas token, designed for stablecoin payments and settlements with ultra-low fees and instant finality. ## What is the Stable API? -The Stable API allows interaction with the Stable network through a set of JSON-RPC methods. Its design is familiar to developers who have worked with Ethereum's JSON-RPC APIs, making it intuitive and straightforward to use. +The Stable API lets you interact with the Stable network through a set of JSON-RPC methods. If you've worked with Ethereum's JSON-RPC APIs, the design will feel familiar. -## Getting Started Instructions +## Getting started -### 1. Choose a Package Manager (npm or yarn) +### 1. Choose a package manager (npm or yarn) -Select a package manager to manage your project's dependencies. Choose between `npm` and `yarn` based on your preference or project requirements. +Choose between `npm` and `yarn` based on your preference or project requirements. ```shell npm @@ -33,9 +33,9 @@ Select a package manager to manage your project's dependencies. Choose between ` ``` -### 2. Set Up Your Project +### 2. Set up your project -Open your terminal and execute the following commands to create and initialize your project: +Run the following commands to create and initialize your project: ```shell npm @@ -53,7 +53,7 @@ Open your terminal and execute the following commands to create and initialize y This creates a new directory named `stable-api-quickstart` and initializes a Node.js project within it. -### 3. Make Your First Request +### 3. Make your first request Install Axios, a popular HTTP client, to make API requests: @@ -92,11 +92,11 @@ Create an `index.js` file in your project directory and paste the following code ``` -Remember to replace `your-api-key` with your actual Alchemy API key that you can get from your [Alchemy dashboard](https://dashboard.alchemy.com/signup). +Replace `your-api-key` with your actual Alchemy API key from the [Alchemy Dashboard](https://dashboard.alchemy.com/signup). -### 4. Run Your Script +### 4. Run your script -Execute your script to make a request to the Stable network: +Run your script to make a request to the Stable network: ```shell shell @@ -112,6 +112,6 @@ You should see the latest block information from Stable's network outputted to y ``` -## Next Steps +## Next steps -Congratulations! You've made your first request to the Stable network. You can now explore the various JSON-RPC methods available on Stable and start building your dApps on this innovative platform. +You've made your first request to the Stable network. You can now explore the various JSON-RPC methods available on Stable and start building your dApps. diff --git a/content/api-reference/starknet/starknet-api-faq.mdx b/content/api-reference/starknet/starknet-api-faq.mdx index 14df352eb..094ae35fe 100644 --- a/content/api-reference/starknet/starknet-api-faq.mdx +++ b/content/api-reference/starknet/starknet-api-faq.mdx @@ -11,7 +11,7 @@ slug: reference/starknet-api-faq ## What is the Starknet API? -The Starknet API allows applications to connect to a Starknet node that is part of the Starknet network. Developers can interact with on-chain data and send different types of transactions to the network by utilizing the endpoints provided by the API. The API follows a JSON-RPC standard. JSON-RPC is a stateless, lightweight, remote procedure call (RPC) protocol encoded in JSON. +The Starknet API lets you connect to a Starknet node that is part of the Starknet network. You can interact with onchain data and send different types of transactions to the network using the endpoints provided by the API. The API follows a JSON-RPC standard -- a stateless, lightweight, remote procedure call (RPC) protocol encoded in JSON. ## How can I get started using the Starknet API? @@ -43,19 +43,19 @@ You can also directly try these APIs from browser in our [API references for Sta Starknet is not compatible with the Ethereum Virtual Machine (EVM). It uses Cairo, a Turing-complete programming language, which can be used to write smart contracts and compile them to run on Starknet. -StarkNet also has a tool called Warp, developed by the Nethermind team, which is a transpiler that translates Solidity to Cairo. This allows StarkNet to be compatible with Solidity and support smart contract deployment written in Solidity, although it is not directly EVM-compatible​. +Starknet also has a tool called Warp, developed by the Nethermind team, which is a transpiler that translates Solidity to Cairo. This allows Starknet to be compatible with Solidity and support smart contract deployment written in Solidity, although it is not directly EVM-compatible. ## What API does Starknet use? Starknet uses the JSON-RPC API standard as its API. The Starknet JSON-RPC API serves as the backbone for the Starknet network and powers any blockchain interaction. -In aggregate, this API suite allows users to read block/transaction data, query chain information, execute smart contracts, store data on-chain, etc. Developers and consumers alike interact with Starknet’s base JSON-RPC APIs to communicate with its decentralized network of nodes. +This API suite lets you read block/transaction data, query chain information, execute smart contracts, store data onchain, and more. You interact with Starknet’s base JSON-RPC APIs to communicate with its decentralized network of nodes. ## What is a Starknet API key? -When accessing the Starknet network via a node provider like Alchemy, Starknet developers use an API key to send and receive transactions from the network. +When accessing the Starknet network via a node provider like Alchemy, you use an API key to send and receive transactions from the network. -For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup)! +For the best development experience, we recommend you [sign up for a free API key](https://dashboard.alchemy.com/signup). ## Which libraries support Starknet? @@ -67,11 +67,11 @@ Several libraries are available for Starknet development and interaction, includ * [`Caigo`](https://github.com/dontpanicdao/caigo): A Golang SDK for Starknet * [`starknet.php`](https://github.com/Starknet-php/starknet.php): A PHP SDK for Starknet -Additionally, [Protostar](https://github.com/software-mansion/protostar) is a development framework for StarkNet smart contract development. +Additionally, [Protostar](https://github.com/software-mansion/protostar) is a development framework for Starknet smart contract development. ## What programming languages work with Starknet? -Many programming languages work with Starknet including, Javascript, Python, Cairo, and Shell. Javascript and Cairo are some of the best languages to use, Cairo for smart contracts and Javascript for off-chain requests. +Many programming languages work with Starknet including JavaScript, Python, Cairo, and Shell. JavaScript and Cairo are some of the best languages to use -- Cairo for smart contracts and JavaScript for offchain requests. ## What does Starknet use for gas? @@ -79,9 +79,9 @@ Starknet does not have its own separate native token. Instead, it uses ETH, the ## What testnet should I use for Starknet? -The testnet you should use for Starknet is the Starknet Sepolia testnet. By connecting to this testnet, you can launch smart contracts, execute transactions, and test applications on the StarkNet network. +Use the Starknet Sepolia testnet. By connecting to this testnet, you can launch smart contracts, execute transactions, and test applications on the Starknet network. -Additionally, you can obtain test tokens from the Sepolia testnet and use the StarkGate bridge to transfer these tokens to the Starknet testnet. This process allows you to test out the capabilities of the Starknet network in a testnet environment before deploying to the mainnet. +You can also obtain test tokens from the Sepolia testnet and use the StarkGate bridge to transfer these tokens to the Starknet testnet. This lets you test the capabilities of the Starknet network in a testnet environment before deploying to mainnet. ## What methods does Alchemy support for the Starknet API? @@ -89,4 +89,4 @@ You can find the list of all the methods Alchemy support for the Starknet API on ## My question isn't here, where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/starknet/starknet-api-quickstart.mdx b/content/api-reference/starknet/starknet-api-quickstart.mdx index f904f2610..ee876a000 100644 --- a/content/api-reference/starknet/starknet-api-quickstart.mdx +++ b/content/api-reference/starknet/starknet-api-quickstart.mdx @@ -7,31 +7,29 @@ slug: reference/starknet-api-quickstart *To use the Starknet API you'll need to [create a free Alchemy account](https://dashboard.alchemy.com/signup) first!* -# Introduction +## What is the Starknet API? -Starknet is a decentralized Validity-Rollup (often referred to as ZK-Rollup). It operates as a Layer 2 network over Ethereum, enabling any app to achieve massive scale without compromising Ethereum's composability and security. +Starknet is a decentralized Validity-Rollup (also known as ZK-Rollup) that operates as a Layer 2 network over Ethereum, enabling apps to achieve massive scale without compromising Ethereum's composability and security. -# What is Starknet API? +The Starknet API is a collection of JSON-RPC methods that let you interact with the Starknet network. You can access up-to-date network data and submit transactions through the provided endpoints. -The Starknet API is a collection of JSON-RPC methods that allow developers to interact with the Starknet network. By using the endpoints provided by the API, developers can access up-to-date network data and submit transactions to it. +## Getting started -# Getting Started Instructions +### 1. Choose a package manager (npm or yarn) -## 1. Choose a Package Manager (npm or yarn) +Choose a package manager to manage your project's dependencies. The two most popular options for Node.js are `npm` and `yarn`. -Before you begin, you'll need to choose a package manager to manage dependencies in your project. The two most popular package managers for Node.js are `npm` and `yarn`. You can choose the one you're most comfortable with. +#### npm -### npm +Install Node.js and `npm` for your operating system by following the [npm documentation](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm). -To get started with `npm`, follow the documentation to install Node.js and `npm` for your operating system: [https://docs.npmjs.com/downloading-and-installing-node-js-and-npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) +#### yarn -### yarn +Install `yarn` by following the [yarn installation guide](https://classic.yarnpkg.com/lang/en/docs/install/#mac-stable). -To get started with `yarn`, follow these steps: [https://classic.yarnpkg.com/lang/en/docs/install](https://classic.yarnpkg.com/lang/en/docs/install/#mac-stable) +### 2. Set up your project (npm or yarn) -## 2. Set up your project (npm or yarn) - -Let's start by setting up a simple Node.js project. Open your terminal and run the following commands: +Set up a Node.js project. Open your terminal and run the following commands: ```text npm @@ -49,9 +47,9 @@ Let's start by setting up a simple Node.js project. Open your terminal and run t This will create a new directory called `alchemy-starknet-api` and initialize a new Node.js project in it. -## 3. Make Your First Request +### 3. Make your first request -To make requests to the Starknet API, you'll need to use an HTTP client. In this guide, we'll use Axios, a popular HTTP client for Node.js. Install Axios as a dependency in your project with the command below: +You need an HTTP client to make requests to the Starknet API. Install Axios with the command below: ```Text npm @@ -63,7 +61,7 @@ To make requests to the Starknet API, you'll need to use an HTTP client. In this ``` -Next, let's create a script that will make a request to the `starknet_blockNumber` JSON-RPC method on Starknet. Create a new file called `index.js` in your project directory and add the following code: +Create a file called `index.js` in your project directory and add the following code to request the `starknet_blockNumber` JSON-RPC method: ```javascript index.js @@ -89,11 +87,11 @@ Next, let's create a script that will make a request to the `starknet_blockNumbe ``` -Remember to replace `YOUR_API_KEY` with your actual Alchemy API key that you can get from your [Alchemy dashboard](https://dashboard.alchemy.com/signup). +Replace `YOUR_API_KEY` with your actual Alchemy API key from the [Alchemy Dashboard](https://dashboard.alchemy.com/signup). -## 4. Run Script +### 4. Run the script -To run the script and make the request to the Starknet API, execute the following command in your terminal: +Run the following command in your terminal: ```shell shell @@ -101,7 +99,7 @@ To run the script and make the request to the Starknet API, execute the followin ``` -As a result, should see the current block number on Starknet printed to the console! +You should see the current block number on Starknet printed to the console: ```shell shell @@ -109,6 +107,6 @@ As a result, should see the current block number on Starknet printed to the cons ``` -# Next Steps +## Next steps -Congratulations! You've successfully made your first request to the Starknet API using Alchemy. From here, you can explore the various [JSON-RPC methods available on Starknet](/docs/reference/starknet-getclasshashat) and start building your decentralized applications on it! +You've made your first request to the Starknet API using Alchemy. From here, you can explore the [JSON-RPC methods available on Starknet](/docs/reference/starknet-getclasshashat) and start building your decentralized applications. diff --git a/content/api-reference/story/story-api-faq.mdx b/content/api-reference/story/story-api-faq.mdx index 3fc2306ff..9ade458be 100644 --- a/content/api-reference/story/story-api-faq.mdx +++ b/content/api-reference/story/story-api-faq.mdx @@ -6,11 +6,11 @@ slug: reference/story-api-faq --- ## What is Story? -Story is a purpose-built EVM-compatible blockchain that enables fast, transparent, and programmable management, licensing, and monetization of intellectual property on-chain. +Story is a purpose-built EVM-compatible blockchain that enables fast, transparent, and programmable management, licensing, and monetization of intellectual property onchain. ## What is the Story API? -The Story API allows developers to interface with the Story mainnet and testnet nodes. With this API, developers can execute transactions, query on-chain data, and interact with the Story network, relying on a JSON-RPC standard. +The Story API lets you interface with the Story mainnet and testnet nodes. You can execute transactions, query onchain data, and interact with the Story network using the JSON-RPC standard. ## How can I get started using the Story API? @@ -18,17 +18,17 @@ Explained in [Story API Quickstart](/docs/reference/story-api-quickstart) ## Is Story EVM compatible? -Absolutely. Story confidently supports any Ethereum Virtual Machine (EVM) codebase. This allows developers to smoothly deploy and migrate assets and users from Ethereum L1 and other interoperable chains to Story. +Yes. Story supports any Ethereum Virtual Machine (EVM) codebase. You can deploy and migrate assets and users from Ethereum L1 and other interoperable chains to Story. ## What API does Story use? -Story utilizes the JSON-RPC API standard. This API is crucial for any blockchain interaction on the Story network, allowing users to read block/transaction data, query chain information, execute smart contracts, and store data on-chain. +Story uses the JSON-RPC API standard. This API enables blockchain interactions on the Story network, letting you read block/transaction data, query chain information, execute smart contracts, and store data onchain. ## What is a Story API key? -When accessing the Story network via a node provider like Alchemy, Story developers use an API key to send transactions and retrieve data from the network. +When accessing the Story network via a node provider like Alchemy, you use an API key to send transactions and retrieve data from the network. -For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup)! +For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup). ## Which libraries support Story? @@ -36,7 +36,7 @@ Common Ethereum libraries like [ethers.js](https://docs.ethers.org/v5/) and [web ## What programming languages work with Story? -Languages that work with Ethereum, such as Javascript, Solidity, Typescript, and Shell, should also be compatible with Story. Solidity remains the primary choice for smart contract development, while Javascript is ideal for off-chain interactions. +Languages that work with Ethereum, such as JavaScript, Solidity, TypeScript, and Shell, are also compatible with Story. Solidity remains the primary choice for smart contract development, while JavaScript is ideal for offchain interactions. ## What does Story use for gas? @@ -48,4 +48,4 @@ You can find the list of all the methods Alchemy supports for the Story API on t ## My question isn't here, where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/story/story-api-quickstart.mdx b/content/api-reference/story/story-api-quickstart.mdx index 8c87fe863..38baf097b 100644 --- a/content/api-reference/story/story-api-quickstart.mdx +++ b/content/api-reference/story/story-api-quickstart.mdx @@ -10,11 +10,11 @@ slug: reference/story-api-quickstart get started today. -Story is a purpose-built EVM-compatible blockchain that enables fast, transparent, and programmable management, licensing, and monetization of intellectual property on-chain. +Story is a purpose-built EVM-compatible blockchain that enables fast, transparent, and programmable management, licensing, and monetization of intellectual property onchain. -The Story API allows interaction with the Story network through a set of JSON-RPC methods. Its design is familiar to developers who have worked with Ethereum's JSON-RPC APIs, making it intuitive and straightforward to use. +The Story API provides interaction with the Story network through a set of JSON-RPC methods. If you've worked with Ethereum's JSON-RPC APIs, you'll find the interface familiar. -## Send Your First Request on Alchemy +## Send your first request on Alchemy Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a Story client connected to Alchemy and fetch the latest block number! @@ -28,7 +28,7 @@ Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a S ``` -## Create Client Connected to Alchemy +## Create a client connected to Alchemy ```js @@ -44,7 +44,7 @@ const client = createPublicClient({ Now that you've created a client connected to Alchemy, you can continue with some basics: -## Get Latest Block Number +## Get the latest block number ```js @@ -53,7 +53,7 @@ console.log("Current block number:", blockNumber); ``` -## Get an Address Balance +## Get an address balance ```js @@ -62,7 +62,7 @@ console.log("Balance (IP):", Number(balance) / 1e18); ``` -## Read Block Data +## Read block data ```js @@ -73,7 +73,7 @@ console.log(block); ``` -## Fetch a Transaction by Hash +## Fetch a transaction by hash ```js @@ -82,7 +82,7 @@ console.log(tx); ``` -## Fetch Transaction Receipt +## Fetch a transaction receipt ```js diff --git a/content/api-reference/sui/sui-api-faq.mdx b/content/api-reference/sui/sui-api-faq.mdx index e9da7ce92..58331c648 100644 --- a/content/api-reference/sui/sui-api-faq.mdx +++ b/content/api-reference/sui/sui-api-faq.mdx @@ -6,11 +6,11 @@ slug: "reference/sui-api-faq" ## What is Sui? -Sui is a high-performance Layer 1 blockchain developed by Mysten Labs. It is designed to offer low-latency transaction processing, horizontal scalability, and rich on-chain assets using Move, a programming language optimized for secure resource management. Sui’s architecture enables parallel transaction execution, making it well-suited for real-time applications like gaming and social platforms. +Sui is a high-performance Layer 1 blockchain developed by Mysten Labs. It is designed to offer low-latency transaction processing, horizontal scalability, and rich onchain assets using Move, a programming language optimized for secure resource management. Sui’s architecture enables parallel transaction execution, making it well-suited for real-time applications like gaming and social platforms. ## What is the Sui API? -The Sui API allows developers to interact with the Sui blockchain via JSON-RPC and REST endpoints. With the API, you can query chain data, submit transactions, inspect objects and events, and interact with Move-based smart contracts. +The Sui API lets you interact with the Sui blockchain via JSON-RPC and REST endpoints. You can query chain data, submit transactions, inspect objects and events, and interact with Move-based smart contracts. ## How can I get started using the Sui API? @@ -18,7 +18,7 @@ Check out our [Sui API Quickstart](/docs/reference/sui-api-quickstart) guide for ## Does Sui support smart contracts? -Yes. Sui uses the Move programming language to enable secure and performant smart contracts. Contracts can manage on-chain assets and logic and benefit from Sui’s object-centric data model and parallel execution engine. +Yes. Sui uses the Move programming language to enable secure and performant smart contracts. Contracts can manage onchain assets and logic and benefit from Sui’s object-centric data model and parallel execution engine. ## What API standard does Sui use? @@ -26,7 +26,7 @@ Sui provides both JSON-RPC and REST APIs for interacting with the network. JSON- ## What is a Sui API key? -When accessing the Sui Chain network via a node provider like Alchemy, developers use an API key to send transactions and retrieve data from the network. +When accessing the Sui network via a node provider like Alchemy, you use an API key to send transactions and retrieve data from the network. ## Which libraries can I use with the Sui API? @@ -46,4 +46,4 @@ You can find a full list of supported JSON-RPC methods on the [Sui API Endpoints ## My question isn't listed here — where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/sui/sui-api-quickstart.mdx b/content/api-reference/sui/sui-api-quickstart.mdx index 6a3023493..fad728864 100644 --- a/content/api-reference/sui/sui-api-quickstart.mdx +++ b/content/api-reference/sui/sui-api-quickstart.mdx @@ -4,19 +4,17 @@ description: "Get started building on Sui and using the JSON-RPC API" slug: "reference/sui-api-quickstart" --- -# Introduction +The Sui API enables you to interact with the Sui blockchain via a collection of JSON-RPC endpoints. You can query block and transaction data, interact with Move-based smart contracts, manage assets, and more. -The Sui API enables developers to interact with the Sui blockchain via a collection of JSON-RPC endpoints. With this API, you can query block and transaction data, interact with Move-based smart contracts, manage assets, and more. - -Unlike Ethereum-based chains, Sui uses an object-centric data model, optimized for parallel execution and scalability. This quickstart will help you make your first request to the network. +Unlike Ethereum-based chains, Sui uses an object-centric data model, optimized for parallel execution and scalability. This quickstart helps you make your first request to the network. *** -## What is the Sui Chain API? +## What is the Sui API? -The Sui Chain API allows developers to send queries and transactions to the Sui blockchain through a JSON-RPC interface. With Sui’s object-based architecture and horizontal scalability, developers benefit from high throughput and low-latency reads and writes. +The Sui API lets you send queries and transactions to the Sui blockchain through a JSON-RPC interface. With Sui’s object-based architecture and horizontal scalability, you benefit from high throughput and low-latency reads and writes. -Alchemy’s Sui API provides developers with consistent and performant access to: +Alchemy’s Sui API provides consistent and performant access to: * Retrieving account and object data * Querying blocks, transactions, and events @@ -25,19 +23,19 @@ Alchemy’s Sui API provides developers with consistent and performant access to *** -## Getting Started Instructions +## Getting started -### 1. Choose a Package Manager (npm or yarn) +### 1. Choose a package manager (npm or yarn) -Your first step involves selecting a package manager, which will be crucial for managing your project's dependencies. The choice between `npm` and `yarn` depends on your personal preference or project requirements. +Select a package manager to manage your project's dependencies. The choice between `npm` and `yarn` depends on your preference or project requirements. | npm | yarn | | ------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | | Begin with `npm` by following the [npm documentation](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm). | For `yarn`, refer to [yarn's installation guide](https://classic.yarnpkg.com/lang/en/docs/install). | -### 2. Set Up Your Project +### 2. Set up your project -To kickstart your project, open your terminal and execute the following commands: +Open your terminal and run the following commands: ```text npm @@ -55,7 +53,7 @@ To kickstart your project, open your terminal and execute the following commands This creates a new directory named `sui-api-quickstart` and initializes a Node.js project within it. -### 3. Make Your First Request +### 3. Make your first request Install Axios, a popular HTTP client, to make API requests: @@ -93,11 +91,11 @@ Create an `index.js` file in your project directory and paste the following code ``` -Remember to replace `yourAPIKey` with your actual Alchemy API key that you can get from your [Alchemy dashboard](https://dashboard.alchemy.com/signup). +Replace `yourAPIKey` with your actual Alchemy API key from the [Alchemy Dashboard](https://dashboard.alchemy.com/signup). -### 4. Run Your Script +### 4. Run your script -To execute your script and make a request to the Sui App, run: +Run the following command: ```bash bash @@ -105,12 +103,12 @@ To execute your script and make a request to the Sui App, run: ``` -You should see the latest checkpoint sequence number on Sui App outputted to your console: +You should see the latest checkpoint sequence number on Sui printed to your console: ```shell Latest checkpoint sequence number: 1029433 ``` -## Next Steps +## Next steps -Well done! You've just made your first request to the Sui App API. With this foundation, you can dive deeper into the array of [JSON-RPC methods available on Sui App](/docs/chains/sui/sui-api-endpoints/sui-dev-inspect-transaction-block) and start building your dApps on it! +You've made your first request to the Sui API. You can now explore the [JSON-RPC methods available on Sui](/docs/chains/sui/sui-api-endpoints/sui-dev-inspect-transaction-block) and start building your dApps. diff --git a/content/api-reference/superseed/superseed-api-faq.mdx b/content/api-reference/superseed/superseed-api-faq.mdx index 4cbedb144..784aecd13 100644 --- a/content/api-reference/superseed/superseed-api-faq.mdx +++ b/content/api-reference/superseed/superseed-api-faq.mdx @@ -26,7 +26,7 @@ Superseed uses the Ethereum-compatible JSON-RPC API standard. This means most Et ## What is a Superseed API key? -When accessing the Superseed Chain network via a node provider like Alchemy, developers use an API key to send transactions and retrieve data from the network. +When accessing the Superseed network via a node provider like Alchemy, you use an API key to send transactions and retrieve data from the network. ## Which libraries can I use with the Superseed API? @@ -46,4 +46,4 @@ You can find a full list of supported JSON-RPC methods on the [Superseed API End ## My question isn't listed here — where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/superseed/superseed-api-quickstart.mdx b/content/api-reference/superseed/superseed-api-quickstart.mdx index 9735f04c4..e2dc0c1f1 100644 --- a/content/api-reference/superseed/superseed-api-quickstart.mdx +++ b/content/api-reference/superseed/superseed-api-quickstart.mdx @@ -10,11 +10,11 @@ slug: reference/superseed-api-quickstart get started today. -The Superseed API allows developers to interact with the Superseed blockchain using standard JSON-RPC methods. With this API, you can retrieve block and transaction data, send transactions, and build applications powered by Superseed's high-throughput, EVM-compatible environment. +The Superseed API lets you interact with the Superseed blockchain using standard JSON-RPC methods. You can retrieve block and transaction data, send transactions, and build applications powered by Superseed's high-throughput, EVM-compatible environment. -The Superseed Chain API facilitates interaction with the Superseed network through a collection of JSON-RPC methods. Given its compatibility with the Ethereum ecosystem, developers familiar with Ethereum's JSON-RPC APIs will find working with Superseed both intuitive and straightforward. +If you've worked with Ethereum's JSON-RPC APIs, you'll find the Superseed API interface familiar. -## Send Your First Request on Alchemy +## Send your first request on Alchemy Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a Superseed client connected to Alchemy and fetch the latest block number! @@ -28,7 +28,7 @@ Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a S ``` -## Create Client Connected to Alchemy +## Create a client connected to Alchemy ```js @@ -52,7 +52,7 @@ const client = createPublicClient({ Now that you've created a client connected to Alchemy, you can continue with some basics: -## Get Latest Block Number +## Get the latest block number ```js @@ -61,7 +61,7 @@ console.log("Current block number:", blockNumber); ``` -## Get an Address Balance +## Get an address balance ```js @@ -70,7 +70,7 @@ console.log("Balance (ETH):", Number(balance) / 1e18); ``` -## Read Block Data +## Read block data ```js @@ -81,7 +81,7 @@ console.log(block); ``` -## Fetch a Transaction by Hash +## Fetch a transaction by hash ```js @@ -90,7 +90,7 @@ console.log(tx); ``` -## Fetch Transaction Receipt +## Fetch a transaction receipt ```js diff --git a/content/api-reference/tea/tea-api-faq.mdx b/content/api-reference/tea/tea-api-faq.mdx index 562e61e4c..1793bd28c 100644 --- a/content/api-reference/tea/tea-api-faq.mdx +++ b/content/api-reference/tea/tea-api-faq.mdx @@ -6,28 +6,28 @@ slug: reference/tea-api-faq --- ## What is Tea? -Tea Chain is an EVM-compatible Layer-2 built on Optimism’s OP Stack that powers the Tea Protocol’s on-chain registry and rewards for open-source software. +Tea Chain is an EVM-compatible Layer-2 built on Optimism’s OP Stack that powers the Tea Protocol’s onchain registry and rewards for open-source software. ## How do I get started with Tea? Check out our [Tea API Quickstart guide](/docs/reference/tea-api-quickstart) to get started building on Tea. ## What is the Tea API? -The Tea API allows developers to interface with the Tea mainnet. With this API, developers can execute transactions, query on-chain data, and interact with the Tea network, relying on a JSON-RPC standard. +The Tea API lets you interface with the Tea mainnet. You can execute transactions, query onchain data, and interact with the Tea network using the JSON-RPC standard. ## Is Tea EVM compatible? Yes, Tea is EVM compatible. ## What API does Tea use? -Tea uses the JSON-RPC API standard. This API is crucial for any blockchain interaction on the Tea network, allowing users to read block/transaction data, query chain information, execute smart contracts, and store data on-chain. +Tea uses the JSON-RPC API standard. This API enables blockchain interactions on the Tea network, letting you read block/transaction data, query chain information, execute smart contracts, and store data onchain. ## What methods are supported on Tea? Tea supports standard Ethereum JSON-RPC methods. Some chain-specific methods may vary. Please check the [Tea API Endpoints](/docs/chains#tea-apis) for a complete list. ## What is a Tea API key? -When accessing the Tea network via a node provider like Alchemy, Tea developers use an API key to send transactions and retrieve data from the network. For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup)! +When accessing the Tea network via a node provider like Alchemy, you use an API key to send transactions and retrieve data from the network. For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup). ## Which libraries support Tea? Common Ethereum libraries like [ethers.js](https://docs.ethers.org/v5/) should be compatible with Tea, given its EVM nature. ## My question isn’t here, where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/tea/tea-api-quickstart.mdx b/content/api-reference/tea/tea-api-quickstart.mdx index 60635bbc2..d8ca13919 100644 --- a/content/api-reference/tea/tea-api-quickstart.mdx +++ b/content/api-reference/tea/tea-api-quickstart.mdx @@ -10,11 +10,11 @@ slug: reference/tea-api-quickstart get started today. -Tea Chain is an EVM-compatible Layer-2 built on Optimism's OP Stack that powers the Tea Protocol's on-chain registry and rewards for open-source software. +Tea Chain is an EVM-compatible Layer-2 built on Optimism's OP Stack that powers the Tea Protocol's onchain registry and rewards for open-source software. -The Tea API allows interaction with the Tea network through a set of JSON-RPC methods. Its design is familiar to developers who have worked with Ethereum's JSON-RPC APIs, making it intuitive and straightforward to use. +The Tea API provides interaction with the Tea network through a set of JSON-RPC methods. If you've worked with Ethereum's JSON-RPC APIs, you'll find the interface familiar. -## Send Your First Request on Alchemy +## Send your first request on Alchemy Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a Tea client connected to Alchemy and fetch the latest block number! @@ -28,7 +28,7 @@ Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a T ``` -## Create Client Connected to Alchemy +## Create a client connected to Alchemy ```js @@ -52,7 +52,7 @@ const client = createPublicClient({ Now that you've created a client connected to Alchemy, you can continue with some basics: -## Get Latest Block Number +## Get the latest block number ```js @@ -61,7 +61,7 @@ console.log("Current block number:", blockNumber); ``` -## Get an Address Balance +## Get an address balance ```js @@ -70,7 +70,7 @@ console.log("Balance (TEA):", Number(balance) / 1e18); ``` -## Read Block Data +## Read block data ```js @@ -81,7 +81,7 @@ console.log(block); ``` -## Fetch a Transaction by Hash +## Fetch a transaction by hash ```js @@ -90,7 +90,7 @@ console.log(tx); ``` -## Fetch Transaction Receipt +## Fetch a transaction receipt ```js diff --git a/content/api-reference/tempo/tempo-api-faq.mdx b/content/api-reference/tempo/tempo-api-faq.mdx index 49c8deeca..ff1c58aad 100644 --- a/content/api-reference/tempo/tempo-api-faq.mdx +++ b/content/api-reference/tempo/tempo-api-faq.mdx @@ -12,22 +12,22 @@ Tempo is a general-purpose blockchain optimized for payments. Tempo is designed Check out our [Tempo API Quickstart guide](/docs/reference/tempo-api-quickstart) to get started building on Tempo. ## What is the Tempo API? -The Tempo API allows developers to interface with the Tempo mainnet. With this API, developers can execute transactions, query on-chain data, and interact with the Tempo network, relying on a JSON-RPC standard. +The Tempo API lets you interface with the Tempo mainnet. You can execute transactions, query onchain data, and interact with the Tempo network using the JSON-RPC standard. ## Is Tempo EVM compatible? Yes, Tempo is EVM compatible. ## What API does Tempo use? -Tempo uses the JSON-RPC API standard. This API is crucial for any blockchain interaction on the Tempo network, allowing users to read block/transaction data, query chain information, execute smart contracts, and store data on-chain. +Tempo uses the JSON-RPC API standard. This API enables blockchain interactions on the Tempo network, letting you read block/transaction data, query chain information, execute smart contracts, and store data onchain. ## What methods are supported on Tempo? Tempo supports standard Ethereum JSON-RPC methods. Some chain-specific methods may vary. Please check the [Tempo API Endpoints](/docs/chains#tempo-apis) for a complete list. ## What is a Tempo API key? -When accessing the Tempo network via a node provider like Alchemy, Tempo developers use an API key to send transactions and retrieve data from the network. For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup)! +When accessing the Tempo network via a node provider like Alchemy, you use an API key to send transactions and retrieve data from the network. For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup). ## Which libraries support Tempo? Common Ethereum libraries like [ethers.js](https://docs.ethers.org/v5/) should be compatible with Tempo, given its EVM nature. ## My question isn’t here, where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/tempo/tempo-api-quickstart.mdx b/content/api-reference/tempo/tempo-api-quickstart.mdx index 0e5d57919..4a049e13d 100644 --- a/content/api-reference/tempo/tempo-api-quickstart.mdx +++ b/content/api-reference/tempo/tempo-api-quickstart.mdx @@ -12,9 +12,9 @@ slug: reference/tempo-api-quickstart Tempo is a general-purpose blockchain optimized for payments. Tempo is designed to be a low-cost, high-throughput blockchain with user and developer features core to a modern payment system. -The Tempo API allows interaction with the Tempo network through a set of JSON-RPC methods. Its design is familiar to developers who have worked with Ethereum's JSON-RPC APIs, making it intuitive and straightforward to use. +The Tempo API provides interaction with the Tempo network through a set of JSON-RPC methods. If you've worked with Ethereum's JSON-RPC APIs, you'll find the interface familiar. -## Send Your First Request on Alchemy +## Send your first request on Alchemy Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a Tempo client connected to Alchemy and fetch the latest block number! @@ -28,7 +28,7 @@ Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a T ``` -## Create Client Connected to Alchemy +## Create a client connected to Alchemy ```js @@ -52,7 +52,7 @@ const client = createPublicClient({ Now that you've created a client connected to Alchemy, you can continue with some basics: -## Get Latest Block Number +## Get the latest block number ```js @@ -61,7 +61,7 @@ console.log("Current block number:", blockNumber); ``` -## Get an Address Balance +## Get an address balance ```js @@ -70,7 +70,7 @@ console.log("Balance (ETH):", Number(balance) / 1e18); ``` -## Read Block Data +## Read block data ```js @@ -81,7 +81,7 @@ console.log(block); ``` -## Fetch a Transaction by Hash +## Fetch a transaction by hash ```js @@ -90,7 +90,7 @@ console.log(tx); ``` -## Fetch Transaction Receipt +## Fetch a transaction receipt ```js diff --git a/content/api-reference/trace-api/trace-api-quickstart.mdx b/content/api-reference/trace-api/trace-api-quickstart.mdx index 6fe0f3994..87c90de78 100644 --- a/content/api-reference/trace-api/trace-api-quickstart.mdx +++ b/content/api-reference/trace-api/trace-api-quickstart.mdx @@ -11,9 +11,9 @@ To use the Trace API your Alchemy plan must be set to the pay as you go or enter Sign up or upgrade your plan for access. [Get started for free](https://dashboard.alchemy.com/signup) -## Introduction +## Trace API methods -The Trace API methods provide full externality trace functions on transactions executed in the Ethereum chain. Filtering is simple by using just the `address` information. The returned information includes the execution of the following: +The Trace API methods provide full externality trace functions on transactions executed in the Ethereum chain. You can filter by `address` information. The returned information includes the execution of the following: * `CREATE` * `SUICIDE` @@ -26,7 +26,7 @@ The Trace API methods provide full externality trace functions on transactions e ## Trace use cases -Common use cases for the Trace API come in all flavors. Below are popular ones: +Common use cases for the Trace API include: | Use case | Description | Endpoint | | ----------- | ----------------------------------------------------------------------- | --------------------------------------- | @@ -42,11 +42,11 @@ Common use cases for the Trace API come in all flavors. Below are popular ones: | State difference | `stateDiff` | Ethereum state changed values of a transaction. | Ethereum Mainnet & Sepolia | | Virtual Machine Execution Trace | `vmTrace` | Runs a full trace of the VM's state & subcalls in the transaction. | None | -## Trace actions types +## Trace action types ### `CREATE` -* Used to create a smart contract. +* Creates a smart contract. #### Example response @@ -99,7 +99,7 @@ Common use cases for the Trace API come in all flavors. Below are popular ones: ### `SUICIDE` * `SUICIDE` is captured when a smart contract is destroyed. That is when the [selfdestruct](https://solidity-by-example.org/hacks/self-destruct/) function of Solidity is used. -* `SUICIDE` transfers the contract's balance to the `address` specified in the `selfdestruct` function clearing on-chain memory. +* `SUICIDE` transfers the contract's balance to the `address` specified in the `selfdestruct` function clearing onchain memory. * The cleared memory is processed as a refund of the total gas cost to complete the transaction. #### Example response @@ -202,7 +202,7 @@ Traces are structured in a tree format. The `traceAddress` field represents the ![768](https://alchemyapi-res.cloudinary.com/image/upload/v1764192957/docs/api-reference/trace-api/a0d248e-Docs_-_User_flow_1.png "Docs - User flow (1).png") -## Helpful Resources +## Related resources * [What are EVM Traces?](/docs/reference/what-are-evm-traces) * [Trace API vs. Debug API](/docs/reference/trace-api-vs-debug-api) diff --git a/content/api-reference/tron/tron-api-faq.mdx b/content/api-reference/tron/tron-api-faq.mdx index 5fe0ca0a6..c4d99f016 100644 --- a/content/api-reference/tron/tron-api-faq.mdx +++ b/content/api-reference/tron/tron-api-faq.mdx @@ -10,7 +10,7 @@ Tron is a high-performance Layer 1 blockchain designed to support decentralized ## What is the Tron API? -The Tron API allows developers to interact with the Tron blockchain via HTTP JSON endpoints. It provides access to core functionality like querying block and transaction data, interacting with TRC-10 and TRC-20 tokens, invoking smart contracts, and managing accounts. +The Tron API lets you interact with the Tron blockchain via HTTP JSON endpoints. It provides access to core functionality like querying block and transaction data, interacting with TRC-10 and TRC-20 tokens, invoking smart contracts, and managing accounts. ## How can I get started using the Tron API? @@ -26,7 +26,7 @@ Tron offers a custom HTTP JSON RPC-style API, rather than the standard Ethereum- ## What is a Tron API key? -To use Alchemy’s infrastructure for interacting with the Tron network, developers must include their API key in the request URL. This key identifies and authenticates your app, and enables access to Alchemy’s enhanced performance and tooling. +To use Alchemy’s infrastructure for interacting with the Tron network, you must include your API key in the request URL. This key identifies and authenticates your app, and enables access to Alchemy’s enhanced performance and tooling. ## Which libraries can I use with the Tron API? @@ -46,4 +46,4 @@ You can find a full list of supported JSON-RPC methods on the [Tron API Endpoint ## My question isn't listed here — where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/tron/tron-api-quickstart.mdx b/content/api-reference/tron/tron-api-quickstart.mdx index 38f357b43..7a33e7e1a 100644 --- a/content/api-reference/tron/tron-api-quickstart.mdx +++ b/content/api-reference/tron/tron-api-quickstart.mdx @@ -4,17 +4,15 @@ description: "Get started building on Tron and using the HTTP JSON API" slug: "reference/tron-api-quickstart" --- -# Introduction +The Tron API enables you to interact with the Tron blockchain via a collection of HTTP JSON endpoints. You can query block and transaction data, interact with smart contracts, manage assets, participate in governance, and more. -The Tron API enables developers to interact with the Tron blockchain via a collection of HTTP JSON endpoints. With this API, you can query block and transaction data, interact with smart contracts, manage assets, participate in governance, and more. - -Tron leverages a high-throughput, low-latency architecture optimized for dApp performance and decentralized finance. This quickstart guide will walk you through setting up your environment and making your first API call to the Tron network. +Tron leverages a high-throughput, low-latency architecture optimized for dApp performance and decentralized finance. This quickstart walks you through setting up your environment and making your first API call to the Tron network. *** -## What is the Tron Chain API? +## What is the Tron API? -The Tron Chain API allows developers to perform queries and send transactions to the Tron blockchain through a HTTP JSON interface. The API supports comprehensive interactions with Tron's account model, token standards (TRC-10, TRC-20), smart contracts, and node-level information. +The Tron API lets you perform queries and send transactions to the Tron blockchain through an HTTP JSON interface. The API supports comprehensive interactions with Tron's account model, token standards (TRC-10, TRC-20), smart contracts, and node-level information. Alchemy's Tron API offers consistent and performant access to: * Fetching account and token balances @@ -24,19 +22,19 @@ Alchemy's Tron API offers consistent and performant access to: *** -## Getting Started Instructions +## Getting started -### 1. Choose a Package Manager (npm or yarn) +### 1. Choose a package manager (npm or yarn) -Your first step involves selecting a package manager, which will be crucial for managing your project's dependencies. The choice between `npm` and `yarn` depends on your personal preference or project requirements. +Select a package manager to manage your project's dependencies. The choice between `npm` and `yarn` depends on your preference or project requirements. | npm | yarn | | ------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | | Begin with `npm` by following the [npm documentation](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm). | For `yarn`, refer to [yarn's installation guide](https://classic.yarnpkg.com/lang/en/docs/install). | -### 2. Set Up Your Project +### 2. Set up your project -To kickstart your project, open your terminal and execute the following commands: +Open your terminal and run the following commands: ```text npm @@ -54,7 +52,7 @@ To kickstart your project, open your terminal and execute the following commands This creates a new directory named `tron-api-quickstart` and initializes a Node.js project within it. -### 3. Make Your First Request +### 3. Make your first request Install Axios, a popular HTTP client, to make API requests: @@ -86,11 +84,11 @@ Create an `index.js` file in your project directory and paste the following code ``` -Remember to replace `yourAPIKey` with your actual Alchemy API key that you can get from your [Alchemy dashboard](https://dashboard.alchemy.com/signup). +Replace `yourAPIKey` with your actual Alchemy API key from the [Alchemy Dashboard](https://dashboard.alchemy.com/signup). -### 4. Run Your Script +### 4. Run your script -To execute your script and make a request to the Tron API, run: +Run the following command: ```bash bash @@ -104,6 +102,6 @@ You should see the latest block number from the Tron blockchain printed in your Latest block number: 53762589 ``` -## Next Steps +## Next steps -Well done! You've just made your first request to the Tron API. With this foundation, you can dive deeper into the array of [HTTP JSON endpoints available on Tron API](/docs/reference/tron-api-endpoints) and start building your dApps on it! +You've made your first request to the Tron API. You can now explore the [HTTP JSON endpoints available on the Tron API](/docs/reference/tron-api-endpoints) and start building your dApps. diff --git a/content/api-reference/unichain/unichain-api-faq.mdx b/content/api-reference/unichain/unichain-api-faq.mdx index a867bc9c6..d95b22eac 100644 --- a/content/api-reference/unichain/unichain-api-faq.mdx +++ b/content/api-reference/unichain/unichain-api-faq.mdx @@ -17,7 +17,7 @@ Unichain is a DeFi-native Ethereum Layer 2 blockchain, designed to be the home f ## What is the Unichain API? -The Unichain API allows developers to interact with the Unichain network through a set of JSON-RPC methods. It supports various operations such as smart contract deployment, transaction processing, and data retrieval, enabling developers to integrate Unichain's functionality into their applications. +The Unichain API lets you interact with the Unichain network through a set of JSON-RPC methods. It supports smart contract deployment, transaction processing, and data retrieval, enabling you to integrate Unichain's functionality into your applications. ## How can I get started using the Unichain API? @@ -29,15 +29,15 @@ Yes, Unichain is EVM-compatible as it's built as an Ethereum Layer 2 solution. ## What programming languages can I use with Unichain? -You can use Solidity for smart contract development. For off-chain interactions, you can use languages that support Ethereum libraries like JavaScript (with ethers.js or web3.js). +You can use Solidity for smart contract development. For offchain interactions, you can use languages that support Ethereum libraries like JavaScript (with ethers.js or web3.js). ## What API does Unichain use? -Unichain utilizes the JSON-RPC API standard, which is widely used in the Ethereum ecosystem. This provides a familiar and efficient interface for blockchain interactions. +Unichain uses the JSON-RPC API standard, which is widely used in the Ethereum ecosystem. This provides a familiar and efficient interface for blockchain interactions. ## What is a Unichain API key? -When accessing the Unichain network via a service provider like Alchemy, developers need an API key to send transactions and retrieve data. An API key ensures secure and authenticated access to the network. +When accessing the Unichain network via a service provider like Alchemy, you need an API key to send transactions and retrieve data. An API key ensures secure and authenticated access to the network. ## Where can I find more detailed information about Unichain? @@ -53,4 +53,4 @@ Check out the [Unichain API Endpoints](/docs/chains#unichain-apis) ## My question isn't here, where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/unichain/unichain-api-quickstart.mdx b/content/api-reference/unichain/unichain-api-quickstart.mdx index acdb9f131..0c75b4976 100644 --- a/content/api-reference/unichain/unichain-api-quickstart.mdx +++ b/content/api-reference/unichain/unichain-api-quickstart.mdx @@ -12,9 +12,9 @@ slug: reference/unichain-api-quickstart Unichain is a DeFi-native Ethereum Layer 2 blockchain, designed to be the home for liquidity across chains. It offers faster and cheaper transactions while supporting cross-chain liquidity. -The Unichain API allows interaction with the Unichain network through a set of JSON-RPC methods. Its design is familiar to developers who have worked with Ethereum's JSON-RPC APIs, making it intuitive and straightforward to use. +The Unichain API provides interaction with the Unichain network through a set of JSON-RPC methods. If you've worked with Ethereum's JSON-RPC APIs, you'll find the interface familiar. -## Send Your First Request on Alchemy +## Send your first request on Alchemy Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a Unichain client connected to Alchemy and fetch the latest block number! @@ -28,7 +28,7 @@ Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a U ``` -## Create Client Connected to Alchemy +## Create a client connected to Alchemy ```js @@ -44,7 +44,7 @@ const client = createPublicClient({ Now that you've created a client connected to Alchemy, you can continue with some basics: -## Get Latest Block Number +## Get the latest block number ```js @@ -53,7 +53,7 @@ console.log("Current block number:", blockNumber); ``` -## Get an Address Balance +## Get an address balance ```js @@ -62,7 +62,7 @@ console.log("Balance (ETH):", Number(balance) / 1e18); ``` -## Read Block Data +## Read block data ```js @@ -73,7 +73,7 @@ console.log(block); ``` -## Fetch a Transaction by Hash +## Fetch a transaction by hash ```js @@ -82,7 +82,7 @@ console.log(tx); ``` -## Fetch Transaction Receipt +## Fetch a transaction receipt ```js diff --git a/content/api-reference/unichain/unichain-flashblocks-api-quickstart.mdx b/content/api-reference/unichain/unichain-flashblocks-api-quickstart.mdx index e7a44aa82..4c2e9bf65 100644 --- a/content/api-reference/unichain/unichain-flashblocks-api-quickstart.mdx +++ b/content/api-reference/unichain/unichain-flashblocks-api-quickstart.mdx @@ -5,11 +5,11 @@ subtitle: Get started building on Unichain using Flashblocks slug: reference/unichain-flashblocks-api-quickstart --- -## Introduction +## What are Flashblocks? -Flashblocks on Unichain enable ultra-fast transaction confirmations by providing preconfirmations - instant signals that arrive before the next block is finalized. Instead of waiting up to 2 seconds for block confirmation, users receive transaction feedback in just 200 milliseconds, a 10x improvement. +Flashblocks on Unichain enable ultra-fast transaction confirmations by providing preconfirmations -- instant signals that arrive before the next block is finalized. Instead of waiting up to 2 seconds for block confirmation, you receive transaction feedback in 200 milliseconds, a 10x improvement. -Built as an "out-of-protocol" extension, Flashblocks work by streaming partial block updates every 200ms without modifying Unichain's core consensus. This makes them perfect for developers building DeFi applications, marketplaces, payment systems, and other applications where instant confirmations create seamless user experiences. +Built as an "out-of-protocol" extension, Flashblocks work by streaming partial block updates every 200ms without modifying Unichain's core consensus. This makes them ideal for DeFi applications, marketplaces, payment systems, and other applications where instant confirmations create seamless experiences. ## Getting started instructions @@ -20,7 +20,7 @@ Flashblocks is currently supported on both Unichain testnet and mainnet and can | Unichain Sepolia | ✅ | | Unichain Mainnet | ✅ | -## Flashblocks-enabled API Endpoints +## Flashblocks-enabled API endpoints ### [eth\_getBlockByNumber](https://www.alchemy.com/docs/node/op-mainnet/op-mainnet-api-endpoints/eth-get-block-by-number) diff --git a/content/api-reference/websockets/subscription-api-endpoints/logs.mdx b/content/api-reference/websockets/subscription-api-endpoints/logs.mdx index 97371ad53..2c28c71c4 100644 --- a/content/api-reference/websockets/subscription-api-endpoints/logs.mdx +++ b/content/api-reference/websockets/subscription-api-endpoints/logs.mdx @@ -13,7 +13,7 @@ The `logs` subscription type emits logs that match a specified topic filter and If `removed` is not included in the response payload then the logs are still a part of the canonical chain. -# Supported Networks +# Supported networks Check the [Chains](https://dashboard.alchemy.com/chains) page for details about product and chain support! @@ -141,7 +141,7 @@ An object with the following fields: ``` -Below you can find the explanation for individual properties of the response: +Here are the individual properties of the response: * **`jsonrpc`**: The `jsonrpc` property specifies the version of the JSON-RPC protocol that is being used, which in this case is "2.0". * **`method`**: The `method` property specifies the method that was called, which in this case is `eth_subscription`. diff --git a/content/api-reference/websockets/subscription-api.mdx b/content/api-reference/websockets/subscription-api.mdx index e42967d4f..ff4ca5557 100644 --- a/content/api-reference/websockets/subscription-api.mdx +++ b/content/api-reference/websockets/subscription-api.mdx @@ -5,11 +5,11 @@ subtitle: Learn how to subscribe to pending transactions, log events, new blocks slug: reference/subscription-api --- -# Getting Started +# Getting started -The primary way to use the Subscription API or WebSockets is through standard JSON-RPC methods. See the [Using JSON-RPC Requests section](#using-json-rpc-requests-to-access-websockets) below to get started. +The primary way to use the Subscription API is through standard JSON-RPC methods. See the [Using JSON-RPC requests section](#using-json-rpc-requests-to-access-websockets) below to get started. -# Subscription API Endpoints +# Subscription API endpoints For a full list of Subscription API endpoints and supported chains see the [Subscription API Endpoints](/docs/reference/subscription-api-endpoints) doc. Below are the subscription endpoints available and the corresponding docs for each of them. @@ -30,15 +30,15 @@ For a full list of Subscription API endpoints and supported chains see the [Subs # What are WebSockets and how do they differ from HTTP? -WebSockets is a bidirectional communication protocol that maintains a network connection between a server and a client. Unlike HTTP, with WebSockets clients don't need to continuously make requests when they want information. +WebSocket is a bidirectional communication protocol that maintains a network connection between a server and a client. Unlike HTTP, with WebSocket you don't need to continuously make requests when you want information. -Instead, an open WebSocket connection can push network updates to clients by allowing them to subscribe to certain network states, such as new transactions or blocks being added to the blockchain. +Instead, an open WebSocket connection can push network updates to you by allowing subscriptions to certain network states, such as new transactions or blocks being added to the blockchain. -## Using JSON-RPC Requests to Access WebSockets +## Using JSON-RPC requests to access WebSockets The `eth_subscribe` and `eth_unsubscribe` JSON-RPC methods allow you to access WebSockets. -To begin, open a WebSocket using the WebSocket URL for your app. You can find your app's WebSocket URL by opening the app's page in [your dashboard](https://dashboard.alchemy.com/signup) and clicking "View Key". +To begin, open a WebSocket using the WebSocket URL for your app. You can find your app's WebSocket URL by opening the app's page in the [Alchemy Dashboard](https://dashboard.alchemy.com/signup) and clicking "View Key". Note that your app's URL for WebSockets is different from its URL for HTTP requests, but both can be found in the app's "Network" tab. @@ -70,18 +70,18 @@ Next, install a command line tool for making WebSocket requests such as [wscat]( - **Don't Use HTTP Methods Over WebSockets!** + **Don't use HTTP methods over WebSockets** - Though it's currently possible to send all your HTTP requests over Websockets, we discourage our developers from doing so. Instead, you should only send `eth_subscribe` and `eth_unsubscribe` requests to WebSockets. + Though it's currently possible to send all your HTTP requests over WebSocket connections, we discourage doing so. You should only send `eth_subscribe` and `eth_unsubscribe` requests over WebSockets. This is for several reasons: - * You won't receive HTTP status codes in WebSockets responses, which can be useful and actionable. - * Because individual HTTP requests are load-balanced in our infrastructure to the fastest possible server, you'll add additional latency by sending JSON-RPC requests over WebSockets. - * WebSockets client-side handling has many tricky edge cases and silent failure modes, which can make your dApp less stable. + * You won't receive HTTP status codes in WebSocket responses, which can be useful and actionable. + * Because individual HTTP requests are load-balanced in our infrastructure to the fastest possible server, you'll add additional latency by sending JSON-RPC requests over WebSocket connections. + * WebSocket client-side handling has many tricky edge cases and silent failure modes, which can make your dApp less stable. -# WebSocket Limits +# WebSocket limits The following limits apply for WebSocket connections: @@ -92,11 +92,11 @@ The following limits apply for WebSocket connections: *** -# Error Codes +# Error codes | Error Code | Error Message | Solution | | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `32600` | `"Sorry, the maximum batch request size is 1000. Please reduce the size of your request and try again."` | Occurs when user attempts to send high-volume JSON-RPC traffic over Websockets. We recommend this traffic be sent over HTTP instead to optimize server backends. | +| `32600` | `"Sorry, the maximum batch request size is 1000. Please reduce the size of your request and try again."` | Occurs when you attempt to send high-volume JSON-RPC traffic over WebSocket connections. We recommend sending this traffic over HTTP instead to optimize server backends. | | `1008` | `"WebSocket connection limit reached for this app. Please close existing connections and try again."` | Triggered when the number of open WebSocket connections for the app reaches the allowed limit. Close unused connections to restore access. | | `1008` | `"This app has exceeded its limit of open WebSockets. Please close some other connections first."` | Triggered when the team previously exceeded the limit and tries to reconnect again before the backoff interval expires. Close existing connections and wait. | | `1008` | `"You have exceeded the maximum number of concurrent requests on a single WebSocket. At most 200 concurrent requests are allowed per WebSocket."` | Triggered when a client has too many pending JSON-RPC requests on a single WebSocket. Ensure each request completes before sending more. | diff --git a/content/api-reference/world-chain/world-chain-api-faq.mdx b/content/api-reference/world-chain/world-chain-api-faq.mdx index f131e1b82..5019776da 100644 --- a/content/api-reference/world-chain/world-chain-api-faq.mdx +++ b/content/api-reference/world-chain/world-chain-api-faq.mdx @@ -11,7 +11,7 @@ World Chain is a blockchain designed for humans, developed by World. It aims to ## What is the World Chain API? -The World Chain API allows developers to interact with the World Chain network through a set of JSON-RPC methods. It supports various operations such as smart contract deployment, transaction processing, and data retrieval, enabling developers to integrate World Chain's functionality into their applications. +The World Chain API lets you interact with the World Chain network through a set of JSON-RPC methods. It supports smart contract deployment, transaction processing, and data retrieval, enabling you to integrate World Chain's functionality into your applications. ## How can I get started using the World Chain API? @@ -19,19 +19,19 @@ Explained in [World Chain API Quickstart](/docs/reference/world-chain-api-quicks ## Is World Chain EVM compatible? -Yes, World Chain is EVM-compatible. As an Ethereum Layer 2 solution, it allows developers to deploy Ethereum-based smart contracts and applications on the World Chain network, leveraging existing Ethereum development tools and practices. +Yes, World Chain is EVM-compatible. As an Ethereum Layer 2 solution, you can deploy Ethereum-based smart contracts and applications on the World Chain network, leveraging existing Ethereum development tools and practices. ## What API does World Chain use? -World Chain utilizes the JSON-RPC API standard, which is widely used in the Ethereum ecosystem. This provides a familiar and efficient interface for blockchain interactions. +World Chain uses the JSON-RPC API standard, which is widely used in the Ethereum ecosystem. This provides a familiar and efficient interface for blockchain interactions. ## What is a World Chain API key? -When accessing the World Chain network via a service provider, developers need an API key to send transactions and retrieve data. An API key ensures secure and authenticated access to the network. +When accessing the World Chain network via a service provider, you need an API key to send transactions and retrieve data. An API key ensures secure and authenticated access to the network. ## Which libraries support World Chain? -As an EVM-compatible blockchain, World Chain supports popular Ethereum libraries such as Web3.js and Ethers.js. This allows developers to leverage existing tools and knowledge when building on World Chain. +As an EVM-compatible blockchain, World Chain supports popular Ethereum libraries such as Web3.js and Ethers.js. You can leverage existing tools and knowledge when building on World Chain. ## How does World Chain prioritize human users? @@ -39,4 +39,4 @@ World Chain uses World ID's Proof of Personhood system to verify human users. Ve ## My question isn't here, where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/world-chain/world-chain-api-quickstart.mdx b/content/api-reference/world-chain/world-chain-api-quickstart.mdx index e508e6b09..9145e0322 100644 --- a/content/api-reference/world-chain/world-chain-api-quickstart.mdx +++ b/content/api-reference/world-chain/world-chain-api-quickstart.mdx @@ -12,9 +12,9 @@ slug: reference/world-chain-api-quickstart World Chain is a blockchain designed for humans, created by World to accelerate the adoption of Proof of Personhood and decentralized finance. It offers priority blockspace for verified humans, a gas allowance for casual transactions, and deep integration with the World protocol. -The World Chain API allows interaction with the World Chain network through a set of JSON-RPC methods. Its design is familiar to developers who have worked with Ethereum's JSON-RPC APIs, making it intuitive and straightforward to use. +The World Chain API provides interaction with the World Chain network through a set of JSON-RPC methods. If you've worked with Ethereum's JSON-RPC APIs, you'll find the interface familiar. -## Send Your First Request on Alchemy +## Send your first request on Alchemy Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a World Chain client connected to Alchemy and fetch the latest block number! @@ -28,7 +28,7 @@ Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a W ``` -## Create Client Connected to Alchemy +## Create a client connected to Alchemy ```js @@ -44,7 +44,7 @@ const client = createPublicClient({ Now that you've created a client connected to Alchemy, you can continue with some basics: -## Get Latest Block Number +## Get the latest block number ```js @@ -53,7 +53,7 @@ console.log("Current block number:", blockNumber); ``` -## Get an Address Balance +## Get an address balance ```js @@ -62,7 +62,7 @@ console.log("Balance (ETH):", Number(balance) / 1e18); ``` -## Read Block Data +## Read block data ```js @@ -73,7 +73,7 @@ console.log(block); ``` -## Fetch a Transaction by Hash +## Fetch a transaction by hash ```js @@ -82,7 +82,7 @@ console.log(tx); ``` -## Fetch Transaction Receipt +## Fetch a transaction receipt ```js diff --git a/content/api-reference/world-mobile-chain/world-mobile-chain-api-faq.mdx b/content/api-reference/world-mobile-chain/world-mobile-chain-api-faq.mdx index 08012456d..da37f020c 100644 --- a/content/api-reference/world-mobile-chain/world-mobile-chain-api-faq.mdx +++ b/content/api-reference/world-mobile-chain/world-mobile-chain-api-faq.mdx @@ -12,22 +12,22 @@ World Mobile Chain is an EVM-compatible Layer-3 built on Base for decentralized Check out our [WorldMobileChain API Quickstart guide](/docs/reference/worldmobilechain-api-quickstart) to get started building on WorldMobileChain. ## What is the WorldMobileChain API? -The WorldMobileChain API allows developers to interface with the WorldMobileChain mainnet. With this API, developers can execute transactions, query on-chain data, and interact with the WorldMobileChain network, relying on a JSON-RPC standard. +The World Mobile Chain API lets you interface with the World Mobile Chain mainnet. You can execute transactions, query onchain data, and interact with the World Mobile Chain network using the JSON-RPC standard. ## Is WorldMobileChain EVM compatible? Yes, WorldMobileChain is EVM compatible. ## What API does WorldMobileChain use? -WorldMobileChain uses the JSON-RPC API standard. This API is crucial for any blockchain interaction on the WorldMobileChain network, allowing users to read block/transaction data, query chain information, execute smart contracts, and store data on-chain. +World Mobile Chain uses the JSON-RPC API standard. This API enables blockchain interactions on the World Mobile Chain network, letting you read block/transaction data, query chain information, execute smart contracts, and store data onchain. ## What methods are supported on WorldMobileChain? World Mobile Chain supports standard Ethereum JSON-RPC methods. Some chain-specific methods may vary. Please check the [World Mobile Chain API Endpoints](/docs/chains#world-mobile-chain-apis) for a complete list. ## What is a WorldMobileChain API key? -When accessing the WorldMobileChain network via a node provider like Alchemy, WorldMobileChain developers use an API key to send transactions and retrieve data from the network. For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup)! +When accessing the World Mobile Chain network via a node provider like Alchemy, you use an API key to send transactions and retrieve data from the network. For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup). ## Which libraries support WorldMobileChain? Common Ethereum libraries like [ethers.js](https://docs.ethers.org/v5/) should be compatible with WorldMobileChain, given its EVM nature. ## My question isn’t here, where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/world-mobile-chain/world-mobile-chain-api-quickstart.mdx b/content/api-reference/world-mobile-chain/world-mobile-chain-api-quickstart.mdx index 0bc0c2ac6..09812357d 100644 --- a/content/api-reference/world-mobile-chain/world-mobile-chain-api-quickstart.mdx +++ b/content/api-reference/world-mobile-chain/world-mobile-chain-api-quickstart.mdx @@ -12,9 +12,9 @@ slug: reference/world-mobile-chain-api-quickstart World Mobile Chain is an EVM-compatible Layer-3 built on Base for decentralized telecom (DePIN), where EarthNodes secure the network and process telco data to deliver fast, low-cost onchain services. -The World Mobile Chain API allows interaction with the World Mobile Chain network through a set of JSON-RPC methods. Its design is familiar to developers who have worked with Ethereum's JSON-RPC APIs, making it intuitive and straightforward to use. +The World Mobile Chain API provides interaction with the World Mobile Chain network through a set of JSON-RPC methods. If you've worked with Ethereum's JSON-RPC APIs, you'll find the interface familiar. -## Send Your First Request on Alchemy +## Send your first request on Alchemy Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a World Mobile Chain client connected to Alchemy and fetch the latest block number! @@ -28,7 +28,7 @@ Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a W ``` -## Create Client Connected to Alchemy +## Create a client connected to Alchemy ```js @@ -52,7 +52,7 @@ const client = createPublicClient({ Now that you've created a client connected to Alchemy, you can continue with some basics: -## Get Latest Block Number +## Get the latest block number ```js @@ -61,7 +61,7 @@ console.log("Current block number:", blockNumber); ``` -## Get an Address Balance +## Get an address balance ```js @@ -70,7 +70,7 @@ console.log("Balance (WMT):", Number(balance) / 1e18); ``` -## Read Block Data +## Read block data ```js @@ -81,7 +81,7 @@ console.log(block); ``` -## Fetch a Transaction by Hash +## Fetch a transaction by hash ```js @@ -90,7 +90,7 @@ console.log(tx); ``` -## Fetch Transaction Receipt +## Fetch a transaction receipt ```js diff --git a/content/api-reference/xmtp/xmtp-api-faq.mdx b/content/api-reference/xmtp/xmtp-api-faq.mdx index 38d94e5b5..f916315e7 100644 --- a/content/api-reference/xmtp/xmtp-api-faq.mdx +++ b/content/api-reference/xmtp/xmtp-api-faq.mdx @@ -12,22 +12,22 @@ XMTP Chain is a Layer-3 appchain built with Arbitrum that settles to Base, provi Check out our [XMTP API Quickstart guide](/docs/reference/xmtp-api-quickstart) to get started building on XMTP. ## What is the XMTP API? -The XMTP API allows developers to interface with the XMTP mainnet. With this API, developers can execute transactions, query on-chain data, and interact with the XMTP network, relying on a JSON-RPC standard. +The XMTP API lets you interface with the XMTP mainnet. You can execute transactions, query onchain data, and interact with the XMTP network using the JSON-RPC standard. ## Is XMTP EVM compatible? Yes, XMTP is EVM compatible. ## What API does XMTP use? -XMTP uses the JSON-RPC API standard. This API is crucial for any blockchain interaction on the XMTP network, allowing users to read block/transaction data, query chain information, execute smart contracts, and store data on-chain. +XMTP uses the JSON-RPC API standard. This API enables blockchain interactions on the XMTP network, letting you read block/transaction data, query chain information, execute smart contracts, and store data onchain. ## What methods are supported on XMTP? XMTP supports standard Ethereum JSON-RPC methods. Some chain-specific methods may vary. Please check the [XMTP API Endpoints](/docs/chains#xmtp-apis) for a complete list. ## What is a XMTP API key? -When accessing the XMTP network via a node provider like Alchemy, XMTP developers use an API key to send transactions and retrieve data from the network. For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup)! +When accessing the XMTP network via a node provider like Alchemy, you use an API key to send transactions and retrieve data from the network. For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup). ## Which libraries support XMTP? Common Ethereum libraries like [ethers.js](https://docs.ethers.org/v5/) should be compatible with XMTP, given its EVM nature. ## My question isn’t here, where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/xmtp/xmtp-api-quickstart.mdx b/content/api-reference/xmtp/xmtp-api-quickstart.mdx index 0d765eeea..735a5632a 100644 --- a/content/api-reference/xmtp/xmtp-api-quickstart.mdx +++ b/content/api-reference/xmtp/xmtp-api-quickstart.mdx @@ -12,9 +12,9 @@ slug: reference/xmtp-api-quickstart XMTP Chain is a Layer-3 appchain built with Arbitrum that settles to Base, providing a decentralized ledger to consistently order XMTP's messaging metadata. -The XMTP API allows interaction with the XMTP network through a set of JSON-RPC methods. Its design is familiar to developers who have worked with Ethereum's JSON-RPC APIs, making it intuitive and straightforward to use. +The XMTP API provides interaction with the XMTP network through a set of JSON-RPC methods. If you've worked with Ethereum's JSON-RPC APIs, you'll find the interface familiar. -## Send Your First Request on Alchemy +## Send your first request on Alchemy Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create an XMTP client connected to Alchemy and fetch the latest block number! @@ -28,7 +28,7 @@ Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create an ``` -## Create Client Connected to Alchemy +## Create a client connected to Alchemy ```js @@ -52,7 +52,7 @@ const client = createPublicClient({ Now that you've created a client connected to Alchemy, you can continue with some basics: -## Get Latest Block Number +## Get the latest block number ```js @@ -61,7 +61,7 @@ console.log("Current block number:", blockNumber); ``` -## Get an Address Balance +## Get an address balance ```js @@ -70,7 +70,7 @@ console.log("Balance (ETH):", Number(balance) / 1e18); ``` -## Read Block Data +## Read block data ```js @@ -81,7 +81,7 @@ console.log(block); ``` -## Fetch a Transaction by Hash +## Fetch a transaction by hash ```js @@ -90,7 +90,7 @@ console.log(tx); ``` -## Fetch Transaction Receipt +## Fetch a transaction receipt ```js diff --git a/content/api-reference/yellowstone/api-reference-overview.mdx b/content/api-reference/yellowstone/api-reference-overview.mdx index 2c701bc12..bc5c6de27 100644 --- a/content/api-reference/yellowstone/api-reference-overview.mdx +++ b/content/api-reference/yellowstone/api-reference-overview.mdx @@ -4,11 +4,11 @@ description: Yellowstone gRPC subscription types and filtering options slug: reference/yellowstone-grpc-api-overview --- -# API Reference +# API reference Yellowstone gRPC provides real-time streaming of Solana blockchain data through a flexible subscription API. -## Subscription Types +## Subscription types ### [Subscribe Request](/docs/reference/yellowstone-grpc-subscribe-request) The base structure for all subscriptions. Defines filters, commitment levels, and combines multiple subscription types in a single request. diff --git a/content/api-reference/yellowstone/best-practices.mdx b/content/api-reference/yellowstone/best-practices.mdx index beabdbdfb..8433d508a 100644 --- a/content/api-reference/yellowstone/best-practices.mdx +++ b/content/api-reference/yellowstone/best-practices.mdx @@ -4,17 +4,17 @@ description: Essential tips and patterns for production Yellowstone gRPC applica slug: reference/yellowstone-grpc-best-practices --- -# Best Practices +# Best practices This guide covers essential patterns and best practices for building robust, production-ready applications with Yellowstone gRPC. -## Getting Started +## Getting started -### Start Simple +### Start simple Begin with slot subscriptions before moving to more complex filters. Slots are lightweight and help you understand the streaming model. -### Use Filters Wisely +### Use filters wisely Only subscribe to the data you need to reduce bandwidth and processing overhead. @@ -28,13 +28,13 @@ SubscribeRequestFilterTransactions { } ``` -## Connection Management +## Connection management -### Implement Automatic Reconnection +### Implement automatic reconnection Network issues happen - implement automatic reconnection logic to ensure your application stays resilient. Use exponential backoff to avoid hammering the server. -### Handle Ping/Pong Messages +### Handle ping/pong messages Yellowstone gRPC servers send ping messages to check if clients are alive. Always respond with pong, otherwise the server may close your connection. @@ -47,7 +47,7 @@ if matches!(update.update_oneof, Some(UpdateOneof::Ping(_))) { } ``` -### Implement Gap Recovery +### Implement gap recovery Use `from_slot` to recover from disconnections without missing data. This may result in duplicate updates, but ensures no data loss. @@ -59,9 +59,9 @@ subscribe_request.from_slot = if tracked_slot > 0 { }; ``` -## Architecture Patterns +## Architecture patterns -### Separate Ingress and Processing +### Separate ingress and processing Use channels to decouple data ingestion from processing: @@ -89,38 +89,38 @@ tokio::spawn(async move { * Enables parallel processing of updates * Provides natural backpressure mechanism -### Use Bounded Channels with Backpressure +### Use bounded channels with backpressure Choose channel capacity based on your processing speed and tolerance for data loss: * **Smaller capacity** (1K-10K): Lower memory usage, faster recovery from slow processing -- higher chance of dropping updates * **Larger capacity** (50K-100K): Better handling of processing spikes, more memory usage -## Performance Optimization +## Performance optimization -### Monitor Processing Latency +### Monitor processing latency Track the time between receiving updates and processing them. Log warnings if latency exceeds your thresholds. -### Batch Database Writes +### Batch database writes Instead of writing every update individually, batch them for better throughput. Flush when batch size reaches a threshold (e.g., 1000 updates) or after a time interval (e.g., 1 second). -### Use Async Processing for I/O +### Use async processing for I/O Leverage async/await for concurrent processing of updates when doing I/O operations. -### Optimize Memory Usage +### Optimize memory usage For high-throughput scenarios, reuse subscription requests instead of creating new hashmaps on every send. -### Offload Compute Intensive Work +### Offload compute-intensive work If processing task is too compute intensive, consider leveraging the async processing capabilities of the tokio runtime to offload the work to a separate / multiple threads. -## Error Handling +## Error handling -### Distinguish Error Types +### Distinguish error types Handle different error types appropriately: @@ -128,37 +128,37 @@ Handle different error types appropriately: * **Processing errors**: Log and continue or implement dead letter queue * **Channel errors**: Handle full channels (drop or block) and closed channels (exit gracefully) -### Implement Exponential Backoff +### Implement exponential backoff Start with short delays (100ms) and double on each failure up to a maximum (e.g., 60 seconds). Reset backoff on successful connection. -### Log Dropped Updates +### Log dropped updates Monitor when updates are dropped due to slow processing. Track metrics to understand system health. -## Data Management +## Data management -### Handle Duplicate Updates +### Handle duplicate updates When using `from_slot` for gap recovery, you may receive duplicate updates. Use a time-bounded cache or database unique constraints to handle duplicates efficiently. -### Choose Appropriate Commitment Levels +### Choose appropriate commitment levels * **Processed**: Real-time dashboards, exploratory data analysis (fastest, may see rolled back data) * **Confirmed**: Most production applications, indexers (good balance of speed and finality) * **Finalized**: Financial applications requiring absolute certainty (slower, guaranteed finality) -## Testing and Debugging +## Testing and debugging -### Test Reconnection Logic +### Test reconnection logic Simulate connection failures to verify your reconnection logic works as expected. Test with different failure scenarios. -### Add Structured Logging +### Add structured logging Use structured logging (e.g., `tracing` crate) to debug subscription issues. Log key events like reconnections, slot tracking, and subscription updates. -### Monitor Stream Health +### Monitor stream health Track metrics like: @@ -170,14 +170,14 @@ Track metrics like: Alert if the stream appears stalled (e.g., no updates for 30+ seconds). -## Dynamic Subscription Management +## Dynamic subscription management You can update subscriptions at runtime using the bidirectional stream without reconnecting. This is useful for: * Hot-swapping filters based on user actions * Progressive subscription expansion -## Production Checklist +## Production checklist Before deploying to production, ensure you have: @@ -195,7 +195,7 @@ Before deploying to production, ensure you have: * ✅ Health check endpoints * ✅ Metrics and alerting -## Additional Resources +## Additional resources * [Quickstart Guide](/docs/reference/yellowstone-grpc-quickstart) - Get started quickly * [Code Examples](/docs/reference/yellowstone-grpc-examples) - See complete working examples including a full production-grade client diff --git a/content/api-reference/yellowstone/examples.mdx b/content/api-reference/yellowstone/examples.mdx index 10474bcca..8b4685c68 100644 --- a/content/api-reference/yellowstone/examples.mdx +++ b/content/api-reference/yellowstone/examples.mdx @@ -6,7 +6,7 @@ slug: reference/yellowstone-grpc-examples This page provides practical code examples for common Yellowstone gRPC use cases. All examples are in Rust and include placeholders that will be filled with complete working code. -## Prerequisites & Authentication +## Prerequisites and authentication See [Quickstart](/docs/reference/yellowstone-grpc-quickstart) for prerequisites & authentication. @@ -202,7 +202,7 @@ SubscribeRequest { } ``` -## Production-Grade client +## Production-grade client * Durable client * Gap recovery with `from_slot` @@ -494,6 +494,6 @@ async fn dispatcher_loop(mut updates_rx: mpsc::Receiver) { } ``` -## Contributing Examples +## Contributing examples Found a useful pattern? Consider contributing it to these [docs](https://github.com/alchemyplatform/docs/)! diff --git a/content/api-reference/yellowstone/overview.mdx b/content/api-reference/yellowstone/overview.mdx index d00c567ff..453bbb4bc 100644 --- a/content/api-reference/yellowstone/overview.mdx +++ b/content/api-reference/yellowstone/overview.mdx @@ -16,11 +16,11 @@ Yellowstone gRPC offers significant advantages over traditional REST and WebSock * **Persistent connections**: Maintain long-lived streaming connections for continuous data flow * **Type safety**: Leverage Protocol Buffers for strongly-typed data structures -## Alchemy's Yellowstone gRPC Enhancements +## Alchemy's Yellowstone gRPC enhancements Alchemy's implementation of Yellowstone gRPC provides enterprise-grade reliability and features beyond standard implementations: -### High Availability Architecture +### High availability architecture Our **multi-producer and multi-consumer architecture** ensures minimal downtime for your applications: @@ -29,7 +29,7 @@ Our **multi-producer and multi-consumer architecture** ensures minimal downtime * Client connections are automatically load-balanced across multiple consumer endpoints * No single point of failure in the data pipeline -### Historical Data Replay (6000 Slots) +### Historical data replay (6000 slots) Access historical blockchain data with our **6000-slot replayability capacity**: @@ -38,7 +38,7 @@ Access historical blockchain data with our **6000-slot replayability capacity**: * Test and validate your application logic against real historical data * Fill data gaps if your application experienced temporary downtime -### Block Lag Mitigation +### Block lag mitigation Our multi-producer architecture **eliminates single-node block lag issues**: @@ -47,7 +47,7 @@ Our multi-producer architecture **eliminates single-node block lag issues**: * Consensus mechanism ensures data consistency across producers * Provides the freshest possible blockchain data to your applications -## Common Use Cases +## Common use cases Yellowstone gRPC is ideal for: @@ -58,6 +58,6 @@ Yellowstone gRPC is ideal for: * **Trading bots**: React to market conditions with minimal latency * **Indexers**: Build custom blockchain indexing solutions -## Getting Started +## Getting started -Ready to start streaming Solana data? Check out our [Quickstart Guide](/docs/reference/yellowstone-grpc-quickstart) to make your first connection. +Ready to start streaming Solana data? Check out the [Quickstart guide](/docs/reference/yellowstone-grpc-quickstart) to make your first connection. diff --git a/content/api-reference/yellowstone/quickstart.mdx b/content/api-reference/yellowstone/quickstart.mdx index c3afc96a0..d8f833f92 100644 --- a/content/api-reference/yellowstone/quickstart.mdx +++ b/content/api-reference/yellowstone/quickstart.mdx @@ -4,26 +4,26 @@ description: Get started with Yellowstone gRPC streaming in minutes slug: reference/yellowstone-grpc-quickstart --- -# Quickstart Guide +# Quickstart guide -This guide will walk you through making your first Yellowstone gRPC connection and streaming real-time Solana data. +This guide walks you through making your first Yellowstone gRPC connection and streaming real-time Solana data. ## Prerequisites Before you begin, ensure you have: * **Alchemy Team with PAYG or Enterprise Plan**: Yellowstone gRPC is only available to PAYG (Pay-As-You-Go) and Enterprise teams -* **Create an Alchemy App**: You'll need to create an app in your Alchemy dashboard to get your endpoint URL and API key -* **Get your API Key**: Your Alchemy API key will be used as the `X-Token` header for authentication +* **Create an Alchemy app**: You'll need to create an app in the Alchemy Dashboard to get your endpoint URL and API key +* **Get your API key**: Your Alchemy API key will be used as the `X-Token` header for authentication * Basic understanding of gRPC concepts * Understanding of Solana's slot and commitment level concepts ## Authentication -Get your endpoint URL and API key from your Alchemy dashboard. +Get your endpoint URL and API key from the Alchemy Dashboard. ![](https://alchemyapi-res.cloudinary.com/image/upload/v1764192955/docs/api-reference/yellowstone/yellowstone-get_api_key.png "Yellowstone Get API Key") -**Important**: Your Alchemy API Key must be passed as the `X-Token` header in your gRPC requests (not in the URL). +**Important**: Your Alchemy API key must be passed as the `X-Token` header in your gRPC requests (not in the URL). ```rust let endpoint = "https://solana-mainnet.g.alchemy.com"; @@ -36,9 +36,9 @@ let client = GeyserGrpcClient::build_from_shared(endpoint)? .await?; ``` -## Your First Connection +## Your first connection -### Rust Example +### Rust example Below is a basic example of connecting to Yellowstone gRPC with Rust and streaming all transactions. @@ -100,7 +100,7 @@ async fn main() -> Result<()> { } ``` -### Other Languages +### Other languages Yellowstone gRPC supports multiple programming languages. Choose the client that fits your stack: @@ -111,7 +111,7 @@ Yellowstone gRPC supports multiple programming languages. Choose the client that * **TypeScript/JavaScript** - [Official TypeScript Example](https://github.com/rpcpool/yellowstone-grpc/tree/master/examples/typescript) * **Go** - [Official Go Example](https://github.com/rpcpool/yellowstone-grpc/tree/master/examples/golang) -## Next Steps +## Next steps Now that you've established your first connection, explore: diff --git a/content/api-reference/yellowstone/subscribe-accounts.mdx b/content/api-reference/yellowstone/subscribe-accounts.mdx index 5ba85b7c6..e18be1dec 100644 --- a/content/api-reference/yellowstone/subscribe-accounts.mdx +++ b/content/api-reference/yellowstone/subscribe-accounts.mdx @@ -4,9 +4,9 @@ description: Monitor Solana account changes in real-time with account subscripti slug: reference/yellowstone-grpc-subscribe-accounts --- -# Subscribe to Accounts +# Subscribe to accounts -Account subscriptions allow you to monitor changes to Solana accounts in real-time. This is essential for tracking token balances, program state changes, and any other on-chain data stored in accounts. +Account subscriptions allow you to monitor changes to Solana accounts in real-time. This is essential for tracking token balances, program state changes, and any other onchain data stored in accounts. ## Overview @@ -17,7 +17,7 @@ Account subscriptions provide real-time updates whenever an account's data, lamp * Data size * Memory comparisons (byte patterns at specific offsets) -## Filter Structure +## Filter structure ```rust message SubscribeRequestFilterAccounts { @@ -55,9 +55,9 @@ message SubscribeRequestFilterAccountsFilterLamports { } ``` -## Filter Options +## Filter options -### Account Address Filter +### Account address filter Monitor specific accounts by their public key addresses. @@ -71,7 +71,7 @@ Monitor specific accounts by their public key addresses. * Watch a liquidity pool account * Track NFT metadata accounts -### Owner Filter +### Owner filter Subscribe to all accounts owned by a specific program. @@ -85,7 +85,7 @@ Subscribe to all accounts owned by a specific program. * Watch all accounts for a custom program * Monitor DEX program accounts -### Memcmp Filter +### Memcmp filter Filter accounts by matching byte patterns at specific offsets in the account data. @@ -98,7 +98,7 @@ Filter accounts by matching byte patterns at specific offsets in the account dat * Match accounts with specific discriminators * Find accounts containing specific pubkeys -### Data Size Filter +### Data size filter Filter accounts by their data size. @@ -111,14 +111,14 @@ Filter accounts by their data size. * Optimize bandwidth by excluding large accounts * Target specific program account types -### Token Account State Filter +### Token account state filter Filter only for token accounts. **Field**: `token_account_state` (within `filters`)\ **Type**: `bool` -### Lamports Filter +### Lamports filter Filter accounts by their lamport balance. @@ -138,18 +138,18 @@ Filter accounts by their lamport balance. * Monitor accounts above/below threshold * Filter out empty accounts -### Nonempty Transaction Signature +### Nonempty transaction signature Only receive account updates that are associated with a transaction. **Field**: `nonempty_txn_signature`\ **Type**: `optional bool` -## Combining Filters +## Combining filters You can combine multiple filters to narrow your subscription to match specific patterns. -## Response Structure +## Response structure When an account changes, you receive a `SubscribeUpdateAccount` message: diff --git a/content/api-reference/yellowstone/subscribe-blocks.mdx b/content/api-reference/yellowstone/subscribe-blocks.mdx index c97d7e669..9f04f47eb 100644 --- a/content/api-reference/yellowstone/subscribe-blocks.mdx +++ b/content/api-reference/yellowstone/subscribe-blocks.mdx @@ -4,7 +4,7 @@ description: Stream complete Solana block data in real-time slug: reference/yellowstone-grpc-subscribe-blocks --- -# Subscribe to Blocks +# Subscribe to blocks Block subscriptions provide real-time access to complete Solana blocks, including all transactions, account updates, and metadata. This is ideal for indexers, analytics platforms, and applications that need comprehensive blockchain data. @@ -20,7 +20,7 @@ A block contains: Block subscriptions give you the complete picture of what happened in each slot. -## Filter Structure +## Filter structure ```rust message SubscribeRequestFilterBlocks { @@ -31,9 +31,9 @@ message SubscribeRequestFilterBlocks { } ``` -## Filter Options +## Filter options -### Account Include +### Account include Filter blocks to only those containing transactions that involve specific accounts. @@ -51,7 +51,7 @@ Filter blocks to only those containing transactions that involve specific accoun * Track blocks containing activity for watched accounts * Reduce data volume by filtering at the source -### Include Transactions +### Include transactions Control whether full transaction data is included. @@ -71,7 +71,7 @@ Control whether full transaction data is included. * Smaller payload size * Useful when you only need block structure -### Include Accounts +### Include accounts Control whether account update information is included. @@ -90,7 +90,7 @@ Control whether account update information is included. * No account update information * Smaller payload size -### Include Entries +### Include entries Control whether entry data is included. @@ -109,7 +109,7 @@ Control whether entry data is included. * No entry data * Smaller payload size -## Response Structure +## Response structure Block updates arrive as `SubscribeUpdateBlock` messages: @@ -131,7 +131,7 @@ message SubscribeUpdateBlock { } ``` -### Key Fields +### Key fields **`slot`**: The slot number for this block\ **`blockhash`**: Unique hash identifying this block\ @@ -147,7 +147,7 @@ message SubscribeUpdateBlock { **`entries_count`**: Number of entries in this block\ **`entries`**: Entry data (if `include_entries=true`) -## Block vs Block Meta +## Block vs block meta Choose between full blocks and block metadata: diff --git a/content/api-reference/yellowstone/subscribe-request.mdx b/content/api-reference/yellowstone/subscribe-request.mdx index 52b18a372..998abedf3 100644 --- a/content/api-reference/yellowstone/subscribe-request.mdx +++ b/content/api-reference/yellowstone/subscribe-request.mdx @@ -4,11 +4,11 @@ description: Comprehensive guide to the SubscribeRequest structure and configura slug: reference/yellowstone-grpc-subscribe-request --- -# Subscribe Request +# Subscribe request The `SubscribeRequest` message is the foundation of all Yellowstone gRPC subscriptions. It defines what data you want to receive and how you want to filter it. -## Request Structure +## Request structure A `SubscribeRequest` contains multiple subscription types that can be combined in a single request: @@ -28,7 +28,7 @@ message SubscribeRequest { } ``` -## Key Parameters +## Key parameters ### `accounts` @@ -141,7 +141,7 @@ Can be used to send a ping to the server to maintain connection health. **Type**: `optional SubscribeRequestPing` -## Filter Identifiers +## Filter identifiers Each filter map uses string keys that you define. These identifiers are included in `SubscribeUpdate` messages, allowing you to determine which filter matched the data. @@ -151,7 +151,7 @@ Each filter map uses string keys that you define. These identifiers are included * Keep identifiers consistent across your application * Use identifiers to route data to different handlers -## Combining Multiple Subscriptions +## Combining multiple subscriptions You can combine multiple subscription types in a single request: @@ -189,7 +189,7 @@ SubscribeRequest { } ``` -## Response: SubscribeUpdate +## Response: `SubscribeUpdate` The server responds with a stream of `SubscribeUpdate` messages containing: @@ -213,7 +213,7 @@ message SubscribeUpdate { The `filters` field contains the identifiers of the filters that matched this update. -## Next Steps +## Next steps Explore specific subscription types: diff --git a/content/api-reference/yellowstone/subscribe-slots.mdx b/content/api-reference/yellowstone/subscribe-slots.mdx index 52c78a35c..9b456d201 100644 --- a/content/api-reference/yellowstone/subscribe-slots.mdx +++ b/content/api-reference/yellowstone/subscribe-slots.mdx @@ -4,7 +4,7 @@ description: Track Solana slot progression and chain state in real-time slug: reference/yellowstone-grpc-subscribe-slots --- -# Subscribe to Slots +# Subscribe to slots Slot subscriptions provide real-time updates about Solana's slot progression. This is essential for understanding chain state, tracking confirmations, and synchronizing your application with the blockchain. @@ -17,7 +17,7 @@ A slot represents a period of time (400ms) during which a leader can produce a b * When a slot reaches different commitment levels * Parent-child relationships between slots -## Filter Structure +## Filter structure ```rust message SubscribeRequestFilterSlots { @@ -26,9 +26,9 @@ message SubscribeRequestFilterSlots { } ``` -## Filter Options +## Filter options -### Filter by Commitment +### Filter by commitment Control whether to receive updates only for specific commitment levels. @@ -47,7 +47,7 @@ Control whether to receive updates only for specific commitment levels. * Reduces update volume * Useful when you only care about confirmed or finalized slots -### Interslot Updates +### Interslot updates Control whether to receive updates during slot progression (before slot completion). @@ -66,7 +66,7 @@ Control whether to receive updates during slot progression (before slot completi * Receive updates only at major slot state transitions * Lower update volume -## Response Structure +## Response structure Slot updates arrive as `SubscribeUpdateSlot` messages: @@ -96,7 +96,7 @@ enum SlotStatus { **`status`**: Current status of the slot (see SlotStatus enum)\ **`dead_error`**: If present, error message indicating why the slot is dead/skipped -### Slot Status Values +### Slot status values **`SLOT_PROCESSED`** (0): Slot has been processed by the validator\ **`SLOT_CONFIRMED`** (1): Slot has received supermajority confirmation\ diff --git a/content/api-reference/yellowstone/subscribe-transactions.mdx b/content/api-reference/yellowstone/subscribe-transactions.mdx index c4ea54269..f66dc33ba 100644 --- a/content/api-reference/yellowstone/subscribe-transactions.mdx +++ b/content/api-reference/yellowstone/subscribe-transactions.mdx @@ -4,7 +4,7 @@ description: Stream Solana transactions in real-time with powerful filtering opt slug: reference/yellowstone-grpc-subscribe-transactions --- -# Subscribe to Transactions +# Subscribe to transactions Transaction subscriptions allow you to monitor Solana transactions in real-time. This is crucial for DEX integrations, wallet monitoring, program event tracking, and transaction-based analytics. @@ -18,7 +18,7 @@ Transaction subscriptions provide real-time updates for transactions matching yo * Failed vs successful transactions * Complex account inclusion/exclusion rules -## Filter Structure +## Filter structure ```rust message SubscribeRequestFilterTransactions { @@ -31,9 +31,9 @@ message SubscribeRequestFilterTransactions { } ``` -## Filter Options +## Filter options -### Vote Transactions +### Vote transactions Control whether to include vote transactions (validator voting). @@ -51,7 +51,7 @@ Control whether to include vote transactions (validator voting). * Set to `false` for most application use cases (excludes validator voting spam) * Set to `true` only for validator monitoring or consensus analytics -### Failed Transactions +### Failed transactions Control whether to include failed transactions. @@ -70,7 +70,7 @@ Control whether to include failed transactions. * Set to `true` to analyze failure patterns * Leave unset to see all transaction attempts -### Signature Filter +### Signature filter Filter for a specific transaction signature. @@ -88,7 +88,7 @@ Filter for a specific transaction signature. If you want to track the confirmation status of a transaction you are about to send (for example, a payment or program interaction), you can set up a subscription for the expected signature before submitting the transaction. This way, you will receive real-time updates as soon as the transaction is processed by the network. -### Account Include +### Account include Receive transactions involving any of these accounts. @@ -103,7 +103,7 @@ Receive transactions involving any of these accounts. * Track transactions for a set of token accounts * Watch multiple DEX programs -### Account Exclude +### Account exclude Exclude transactions involving these accounts. @@ -118,7 +118,7 @@ Exclude transactions involving these accounts. * Filter out unwanted program interactions * Remove specific token account activity -### Account Required +### Account required Require all of these accounts to be present. @@ -133,7 +133,7 @@ Require all of these accounts to be present. * Find transactions involving multiple specific accounts * Narrow down to very specific transaction patterns -## Combining Account Filters +## Combining account filters Account filters work together: @@ -154,7 +154,7 @@ if account_required is set: must match all ``` -## Response Structure +## Response structure Transaction updates arrive as `SubscribeUpdateTransaction` messages: @@ -173,7 +173,7 @@ message SubscribeUpdateTransactionInfo { } ``` -### Key Fields +### Key fields **`signature`**: Transaction signature (unique identifier)\ **`is_vote`**: Whether this is a vote transaction\ diff --git a/content/api-reference/zetachain/zetachain-api-faq.mdx b/content/api-reference/zetachain/zetachain-api-faq.mdx index 194591bbb..86477bb1e 100644 --- a/content/api-reference/zetachain/zetachain-api-faq.mdx +++ b/content/api-reference/zetachain/zetachain-api-faq.mdx @@ -11,7 +11,7 @@ ZetaChain is a decentralized blockchain network designed to enhance cross-chain ## What is the ZetaChain API? -The ZetaChain API facilitates interaction with the ZetaChain network through a collection of JSON-RPC methods. It allows developers to interact with the blockchain, enabling functionalities such as transactions, smart contract deployment, and data retrieval. +The ZetaChain API enables interaction with the ZetaChain network through a collection of JSON-RPC methods. You can interact with the blockchain for transactions, smart contract deployment, and data retrieval. ## How can I get started using the ZetaChain API? @@ -19,7 +19,7 @@ Explained in [ZetaChain API Quickstart](/docs/reference/zetachain-api-quickstart ## Is ZetaChain EVM compatible? -Yes, ZetaChain is fully compatible with the Ethereum Virtual Machine (EVM). This compatibility allows Ethereum developers to port their projects to ZetaChain with minimal changes, benefiting from the network's cross-chain capabilities and robust infrastructure. +Yes, ZetaChain is fully compatible with the Ethereum Virtual Machine (EVM). This compatibility lets you port your Ethereum projects to ZetaChain with minimal changes, benefiting from the network's cross-chain capabilities and robust infrastructure. ## What API does ZetaChain use? @@ -27,17 +27,17 @@ ZetaChain uses the JSON-RPC API standard for blockchain interactions. This is th ## What is a ZetaChain API key? -When accessing the ZetaChain network via a node provider like Alchemy, developers use an API key to send transactions and retrieve data from the network. +When accessing the ZetaChain network via a node provider like Alchemy, you use an API key to send transactions and retrieve data from the network. -For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup)! +For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup). ## Which libraries support ZetaChain? -Given ZetaChain's EVM compatibility, popular Ethereum libraries like ethers.js and web3.js are fully compatible with ZetaChain. This allows for seamless development and integration for those familiar with Ethereum's development ecosystem. +Given ZetaChain's EVM compatibility, popular Ethereum libraries like ethers.js and web3.js are fully compatible with ZetaChain. You can leverage existing Ethereum development tools and workflows. ## What programming languages work with ZetaChain? -Similar to Ethereum, ZetaChain supports a range of programming languages for blockchain interaction and smart contract development, including Solidity for smart contracts, as well as JavaScript and TypeScript for dApp development and off-chain interactions. +Similar to Ethereum, ZetaChain supports a range of programming languages for blockchain interaction and smart contract development, including Solidity for smart contracts, as well as JavaScript and TypeScript for dApp development and offchain interactions. ## What does ZetaChain use for gas? @@ -49,4 +49,4 @@ You can find the list of all the methods Alchemy supports for the ZetaChain API ## My question isn't here, where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/zetachain/zetachain-api-quickstart.mdx b/content/api-reference/zetachain/zetachain-api-quickstart.mdx index 344b1a596..36b514828 100644 --- a/content/api-reference/zetachain/zetachain-api-quickstart.mdx +++ b/content/api-reference/zetachain/zetachain-api-quickstart.mdx @@ -12,9 +12,9 @@ slug: reference/zetachain-api-quickstart ZetaChain is an EVM-compatible Cosmos SDK-based L1 blockchain designed to enable Omnichain Smart Contracts and provide a unified application experience. Applications on ZetaChain can manage, read, and write state to/from any external chain - even non-smart chains such as Bitcoin network. Users can natively access these applications from any connected chain without requiring users to switch networks. -The ZetaChain API facilitates interaction with the ZetaChain network through a collection of JSON-RPC methods. Given its compatibility with the Ethereum ecosystem, developers familiar with Ethereum's JSON-RPC APIs will find working with ZetaChain both intuitive and straightforward. +The ZetaChain API enables interaction with the ZetaChain network through a collection of JSON-RPC methods. If you're familiar with Ethereum's JSON-RPC APIs, you'll find working with ZetaChain straightforward. -## Send Your First Request on Alchemy +## Send your first request on Alchemy Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a ZetaChain client connected to Alchemy and fetch the latest block number! @@ -28,7 +28,7 @@ Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a Z ``` -## Create Client Connected to Alchemy +## Create a client connected to Alchemy ```js @@ -44,7 +44,7 @@ const client = createPublicClient({ Now that you've created a client connected to Alchemy, you can continue with some basics: -## Get Latest Block Number +## Get the latest block number ```js @@ -53,7 +53,7 @@ console.log("Current block number:", blockNumber); ``` -## Get an Address Balance +## Get an address balance ```js @@ -62,7 +62,7 @@ console.log("Balance (ZETA):", Number(balance) / 1e18); ``` -## Read Block Data +## Read block data ```js @@ -73,7 +73,7 @@ console.log(block); ``` -## Fetch a Transaction by Hash +## Fetch a transaction by hash ```js @@ -82,7 +82,7 @@ console.log(tx); ``` -## Fetch Transaction Receipt +## Fetch a transaction receipt ```js diff --git a/content/api-reference/zksync/zksync-api-faq.mdx b/content/api-reference/zksync/zksync-api-faq.mdx index c4c4b1d98..3dda21392 100644 --- a/content/api-reference/zksync/zksync-api-faq.mdx +++ b/content/api-reference/zksync/zksync-api-faq.mdx @@ -7,7 +7,7 @@ slug: reference/zksync-api-faq ## What is zkSync? -zkSync is a Zero Knowledge (ZK) rollup designed for EVM compatibility within the Ethereum blockchain. It enables developers who have built EVM-based dApps to effortlessly transition to zkSync, enjoying significantly reduced gas fees and increased transactions per second, all while inheriting Ethereum's renowned security and decentralization features. +zkSync is a Zero Knowledge (ZK) rollup designed for EVM compatibility within the Ethereum blockchain. If you've built EVM-based dApps, you can transition to zkSync with significantly reduced gas fees and increased transactions per second, while inheriting Ethereum's security and decentralization features. ## Why choose zkSync Era? @@ -35,7 +35,7 @@ Unlike Optimistic Rollups, which rely on game theory for security and have a fix ## What is the zkSync Era API? -The zkSync Era API allows applications to connect to a zkSync Era node that is part of the zkSync Era network. Developers can interact with on-chain data and send different types of transactions to the network by utilizing the endpoints provided by the API. The API follows a JSON-RPC standard. JSON-RPC is a stateless, lightweight, remote procedure call (RPC) protocol encoded in JSON. +The zkSync Era API lets your applications connect to a zkSync Era node on the network. You can interact with onchain data and send different types of transactions by using the API endpoints. The API follows the JSON-RPC standard, a stateless, lightweight, remote procedure call (RPC) protocol encoded in JSON. ## How can I get started using the zkSync Era API? @@ -43,9 +43,9 @@ Explained in the [zkSync Era API Quickstart Guide](/docs/reference/zksync-api-qu ## What is a zkSync Era API key? -When accessing the zkSync Era network via a node provider like Alchemy, zkSync Era developers use an API key to send and receive transactions from the network. +When accessing the zkSync Era network via a node provider like Alchemy, you use an API key to send and receive transactions from the network. -For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup)! +For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup). ## Which wallets are supported by zkSync Era? @@ -53,11 +53,11 @@ zkSync Era supports all Ethereum-based wallets like Metamask, BitKeep, TrustWall ## What does zkSync Era use for gas? -zkSync Era uses ETH for transaction fees and gas costs within the network. However, since zkSync Era operates as a Layer 2 solution over Ethereum, users must first bridge their ETH from the Ethereum mainnet to the zkSync Era network. This bridging process is necessary to enable the use of ETH on zkSync Era for transactions, including paying gas fees. Once bridged, the ETH in your zkSync Era account can be used seamlessly, just as on the Ethereum mainnet, but with the benefits of lower fees and faster processing times. +zkSync Era uses ETH for transaction fees and gas costs within the network. Since zkSync Era operates as a Layer 2 solution over Ethereum, you must first bridge your ETH from the Ethereum mainnet to the zkSync Era network. Once bridged, your ETH can be used for transactions, including paying gas fees, with the benefits of lower fees and faster processing times. ## What testnet should I use for zkSync Era? -The testnet you should use for zkSync Era is the zkSync Era Sepolia testnet. By connecting to this testnet, you can launch smart contracts, execute transactions, and test applications on the zkSync Era network. +Use the zkSync Era Sepolia testnet. By connecting to this testnet, you can launch smart contracts, execute transactions, and test applications on the zkSync Era network. ## What methods does Alchemy support for the zkSync Era API? @@ -89,4 +89,4 @@ For Windows users, it's recommended to use WSL 2 and ensure that projects are lo ## My question isn't here, where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/zksync/zksync-api-quickstart.mdx b/content/api-reference/zksync/zksync-api-quickstart.mdx index 62035ac57..9bb87a441 100644 --- a/content/api-reference/zksync/zksync-api-quickstart.mdx +++ b/content/api-reference/zksync/zksync-api-quickstart.mdx @@ -12,9 +12,9 @@ slug: reference/zksync-api-quickstart zkSync is a Layer 2 scaling solution for Ethereum, leveraging zkRollup technology. It provides low gas fees, high throughput, and enhanced user privacy while maintaining a secure and decentralized architecture. -The zkSync Era API enables developers to interact seamlessly with the zkSync Era network. Through the API, developers can submit transactions, query state changes, and more, all while benefiting from the scalability and security zkSync Era offers. +The zkSync Era API enables you to interact with the zkSync Era network. You can submit transactions, query state changes, and more, while benefiting from the scalability and security zkSync Era offers. -## Send Your First Request on Alchemy +## Send your first request on Alchemy Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a zkSync Era client connected to Alchemy and fetch the latest block number! @@ -28,7 +28,7 @@ Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a z ``` -## Create Client Connected to Alchemy +## Create a client connected to Alchemy ```js @@ -44,7 +44,7 @@ const client = createPublicClient({ Now that you've created a client connected to Alchemy, you can continue with some basics: -## Get Latest Block Number +## Get the latest block number ```js @@ -53,7 +53,7 @@ console.log("Current block number:", blockNumber); ``` -## Get an Address Balance +## Get an address balance ```js @@ -62,7 +62,7 @@ console.log("Balance (ETH):", Number(balance) / 1e18); ``` -## Read Block Data +## Read block data ```js @@ -73,7 +73,7 @@ console.log(block); ``` -## Fetch a Transaction by Hash +## Fetch a transaction by hash ```js @@ -82,7 +82,7 @@ console.log(tx); ``` -## Fetch Transaction Receipt +## Fetch a transaction receipt ```js diff --git a/content/api-reference/zora/zora-api-faq.mdx b/content/api-reference/zora/zora-api-faq.mdx index 445a055a1..342dcb704 100644 --- a/content/api-reference/zora/zora-api-faq.mdx +++ b/content/api-reference/zora/zora-api-faq.mdx @@ -12,22 +12,22 @@ Zora Network is an OP Stack–powered Ethereum Layer-2 focused on onchain media Check out our [Zora API Quickstart guide](/docs/reference/zora-api-quickstart) to get started building on Zora. ## What is the Zora API? -The Zora API allows developers to interface with the Zora mainnet. With this API, developers can execute transactions, query on-chain data, and interact with the Zora network, relying on a JSON-RPC standard. +The Zora API lets you interface with the Zora mainnet. You can execute transactions, query onchain data, and interact with the Zora network using the JSON-RPC standard. ## Is Zora EVM compatible? Yes, Zora is EVM compatible. ## What API does Zora use? -Zora uses the JSON-RPC API standard. This API is crucial for any blockchain interaction on the Zora network, allowing users to read block/transaction data, query chain information, execute smart contracts, and store data on-chain. +Zora uses the JSON-RPC API standard. This API enables blockchain interactions on the Zora network, letting you read block/transaction data, query chain information, execute smart contracts, and store data onchain. ## What methods are supported on Zora? Zora supports standard Ethereum JSON-RPC methods. Some chain-specific methods may vary. Please check the [Zora API Endpoints](/docs/chains#zora-apis) for a complete list. ## What is a Zora API key? -When accessing the Zora network via a node provider like Alchemy, Zora developers use an API key to send transactions and retrieve data from the network. For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup)! +When accessing the Zora network via a node provider like Alchemy, you use an API key to send transactions and retrieve data from the network. For the best development experience, we recommend that you [sign up for a free API key](https://dashboard.alchemy.com/signup). ## Which libraries support Zora? Common Ethereum libraries like [ethers.js](https://docs.ethers.org/v5/) should be compatible with Zora, given its EVM nature. ## My question isn’t here, where can I get help? -If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. +If you have any questions or feedback, contact us at support@alchemy.com or open a ticket in the Alchemy Dashboard. diff --git a/content/api-reference/zora/zora-api-quickstart.mdx b/content/api-reference/zora/zora-api-quickstart.mdx index 1024f8ff2..7dce21c8b 100644 --- a/content/api-reference/zora/zora-api-quickstart.mdx +++ b/content/api-reference/zora/zora-api-quickstart.mdx @@ -12,9 +12,9 @@ slug: reference/zora-api-quickstart Zora Network is an OP Stack–powered Ethereum Layer-2 focused on onchain media and NFTs, delivering fast, low-cost mints and creator-friendly tools. -The Zora API allows interaction with the Zora network through a set of JSON-RPC methods. Its design is familiar to developers who have worked with Ethereum's JSON-RPC APIs, making it intuitive and straightforward to use. +The Zora API provides interaction with the Zora network through a set of JSON-RPC methods. If you've worked with Ethereum's JSON-RPC APIs, you'll find the interface familiar. -## Send Your First Request on Alchemy +## Send your first request on Alchemy Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a Zora client connected to Alchemy and fetch the latest block number! @@ -28,7 +28,7 @@ Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create a Z ``` -## Create Client Connected to Alchemy +## Create a client connected to Alchemy ```js @@ -44,7 +44,7 @@ const client = createPublicClient({ Now that you've created a client connected to Alchemy, you can continue with some basics: -## Get Latest Block Number +## Get the latest block number ```js @@ -53,7 +53,7 @@ console.log("Current block number:", blockNumber); ``` -## Get an Address Balance +## Get an address balance ```js @@ -62,7 +62,7 @@ console.log("Balance (ETH):", Number(balance) / 1e18); ``` -## Read Block Data +## Read block data ```js @@ -73,7 +73,7 @@ console.log(block); ``` -## Fetch a Transaction by Hash +## Fetch a transaction by hash ```js @@ -82,7 +82,7 @@ console.log(tx); ``` -## Fetch Transaction Receipt +## Fetch a transaction receipt ```js diff --git a/content/tutorials/alchemy-university/blockchain-basics.mdx b/content/tutorials/alchemy-university/blockchain-basics.mdx index 11b6013b0..2717d6241 100644 --- a/content/tutorials/alchemy-university/blockchain-basics.mdx +++ b/content/tutorials/alchemy-university/blockchain-basics.mdx @@ -21,8 +21,6 @@ This guide will teach you about the origins of blockchain technology starting wi After you learn about blockchain basics, you can learn about more advanced modules like cryptography, Ethereum, Solidity, and smart contracts! -## Learn More About Blockchains +## Learn more about blockchains -This content is from Alchemy University's free, 7-week web3 developer bootcamp. To [learn more about blockchains](https://university.alchemy.com/ethereum) and to earn your web3 developer certification, sign up today! - -Let's dive in! +This content is from Alchemy University's free, 7-week web3 developer bootcamp. To [learn more about blockchains](https://university.alchemy.com/ethereum) and earn your web3 developer certification, sign up today! diff --git a/content/tutorials/alchemy-university/ethereum-basics/ethereum-gas.mdx b/content/tutorials/alchemy-university/ethereum-basics/ethereum-gas.mdx index d20c1f99d..0a960eb6f 100644 --- a/content/tutorials/alchemy-university/ethereum-basics/ethereum-gas.mdx +++ b/content/tutorials/alchemy-university/ethereum-basics/ethereum-gas.mdx @@ -11,14 +11,14 @@ In the previous article, we talked about the cost of [operation codes](/docs/wha As many of you may know, the price of gas is something that changes with every block. Historically, gas prices on Ethereum have been unpredictable and at times, astronomically high making transactions inaccessible to most people. -However, In August 2021, after years of research and planning there was an EIP proposed to improve the calculation of gas prices on Ethereum, known as [EIP-1559](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1559.md). Instead of covering the antiquated computation of gas prices from before EIP-1559, we’re just going to focus on how this works for the current state of Ethereum (post EIP-1559). +However, in August 2021, after years of research and planning there was an EIP proposed to improve the calculation of gas prices on Ethereum, known as [EIP-1559](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1559.md). Instead of covering the antiquated computation of gas prices from before EIP-1559, we’re going to focus on how this works for the current state of Ethereum (post EIP-1559). | Denomination | Value in Ether | Common Usage | | --------------- | -------------- | ------------------------- | | Wei | 10^-18 | Technical implementations | | Gwei (giga-wei) | 10^-9 | Human-readable gas fees | -## Gas Prices +## Gas prices The cost of operations on Ethereum is fixed and measured in the amount of “gas”, however, the price of that gas (measured in Gwei) is ever-changing. We are going to understand how these prices are set so that you can be more informed about transaction costs. @@ -28,7 +28,7 @@ The cost of operations on Ethereum is fixed and measured in the amount of “gas With EIP-1559 the mechanism for setting the gas price has shifted from the previous model. We’ll be discussing the current way gas prices are determined since the legacy mechanism has been deprecated. -### Denominations of Ether +### Denominations of ether Just like dollars, Ether has different denominations that are used to express smaller values, particularly when describing gas costs. For example, similar to how 1 dollar is equal to 100 pennies, 1 ether is equal to 10^18 Wei (the smallest denomination of Ether) or 10^9 Gwei. Here is a table with the relevant denominations for ether and their common use cases: @@ -52,19 +52,19 @@ The above screenshot shows two different blocks, one where block space was in hi When blocks are above the target, the gas price (or `base fee`) is automatically increased, increasing the cost and barrier to entry for sending transactions and thereby reducing the number of people who are competing to fill the block. When the block is below the target the `base fee` is lowered to incentivize people to transact by lowering the barrier to entry for paying for a transaction. -This base fee helps users select an efficient gas amount that is likely to get their transaction mined rather than wasting tons of money on unnecessarily high gas prices like we’ve seen in the past. These mechanisms also make it easy to predict future gas prices by looking at how “full” the previous blocks were. +This base fee helps users select an efficient gas amount that is likely to get their transaction mined rather than wasting tons of money on unnecessarily high gas prices like we’ve seen in the past. These mechanisms also make it straightforward to predict future gas prices by looking at how “full” the previous blocks were. We can actually see what this looks like in practice by visiting [etherscan](https://etherscan.io/). Let’s take a look at block [16128921](https://etherscan.io/block/16128921) for example: ![block-16128921](https://alchemyapi-res.cloudinary.com/image/upload/v1764180145/docs/tutorials/alchemy-university/ethereum-basics/block-16128921.png) -we can see here that we are 57% below the desired gas target (only using 6.4 million gas instead of 15 million) and our base fee per gas is 12.044621651 Gwei. What do we think will happen with the next block? Will the base fee increase or decrease? +We can see here that we are 57% below the desired gas target (only using 6.4 million gas instead of 15 million) and our base fee per gas is 12.044621651 Gwei. What do you think will happen with the next block? Will the base fee increase or decrease? Here is a screenshot of block **[16128922](https://etherscan.io/block/16128922)** ![block-16128922](https://alchemyapi-res.cloudinary.com/image/upload/v1764180146/docs/tutorials/alchemy-university/ethereum-basics/block-16128922.png) -We can see that the base fee decreased to 11.18 Gwei and by doing so this incentivized more people to send transactions and the gas used skyrocketed up to almost 30 million, 100% above the gas target! Now what do we think will happen with block [16128923](https://etherscan.io/block/16128923)? See for yourself! +We can see that the base fee decreased to 11.18 Gwei and by doing so this incentivized more people to send transactions and the gas used skyrocketed up to almost 30 million, 100% above the gas target. Now what do you think will happen with block [16128923](https://etherscan.io/block/16128923)? See for yourself. ### What happens to the base fee? @@ -77,7 +77,7 @@ Instead of going straight into the miners pocket, the `base fee` actually gets b Turns out that when you are sending a transaction, you’re not actually setting the `base fee` value, but rather your setting the `max fee` which represents the maximum amount that you're willing to pay to get your transaction included. Luckily, unlike with the previous gas usage model, your transaction will only ever use the `base fee`\*\* amount to execute, the rest of the value (`max fee` - `base fee`) will be returned to you. -As a dApp developer, you can actually create your own algorithm to determine how much gas to include in your transactions using endpoints like **[`eth_feeHistory`](/docs/reference/eth-feehistory)**. +As a dApp developer, you can create your own algorithm to determine how much gas to include in your transactions using endpoints like **[`eth_feeHistory`](/docs/reference/eth-feehistory)**. ### How are miners paid? @@ -85,6 +85,6 @@ Since the `base fee` is entirely burned, the new incentive for miners is now kno Typically when you set the gas for your transaction you’re setting a value called `maxPriorityFee` which is equal to the `max fee` + the miner `tip` . We’ll learn more about sending transactions later on this week! -## Learn More About Ethereum Development +## Learn more about Ethereum development -Alchemy University offers [free web3 development bootcamps that explain Ethereum Gas in-depth](https://university.alchemy.com/ethereum) and help developers master the fundamentals of web3 technology. Sign up for free, and start building today! +Alchemy University offers [free web3 development bootcamps that explain Ethereum gas in-depth](https://university.alchemy.com/ethereum) and help you master the fundamentals of web3 technology. Sign up for free and start building today. diff --git a/content/tutorials/build-with-ai/add-alchemy-rpc-to-any-project.mdx b/content/tutorials/build-with-ai/add-alchemy-rpc-to-any-project.mdx index 330aa923b..f9607e62a 100644 --- a/content/tutorials/build-with-ai/add-alchemy-rpc-to-any-project.mdx +++ b/content/tutorials/build-with-ai/add-alchemy-rpc-to-any-project.mdx @@ -12,7 +12,7 @@ This guide helps you add a server-safe Alchemy JSON RPC endpoint into almost any ## Prerequisites * [Cursor](https://cursor.sh/) is open at your project root -* You have an [Alchemy API Key](https://dashboard.alchemy.com/?a=index) ready to paste into `.env.local` +* You have an [Alchemy API key](https://dashboard.alchemy.com/?a=index) ready to paste into `.env.local` * Optional for smoother automation in Cursor: * Enable Auto run for the terminal * Add a small command allowlist like `npm run dev`, `node`, `mkdir`, `touch` @@ -376,7 +376,7 @@ Tell me: ## How to call the proxy -Send JSON RPC 2.0 to `/api/rpc` in Next.js, or to `http://localhost:8787/rpc` in the fallback Node server. Choose the network with `x-chain`. If you omit it, the proxy uses the generic `ALCHEMY_API_URL`. +Send JSON-RPC 2.0 requests to `/api/rpc` in Next.js, or to `http://localhost:8787/rpc` in the fallback Node server. Choose the network with `x-chain`. If you omit it, the proxy uses the generic `ALCHEMY_API_URL`. **curl example** diff --git a/content/tutorials/build-with-ai/data-apis-with-cursor.mdx b/content/tutorials/build-with-ai/data-apis-with-cursor.mdx index 92e6bc86e..34f9672a9 100644 --- a/content/tutorials/build-with-ai/data-apis-with-cursor.mdx +++ b/content/tutorials/build-with-ai/data-apis-with-cursor.mdx @@ -5,7 +5,7 @@ subtitle: Step-by-step guide to Alchemy Data APIs using Cursor. slug: docs/data-apis-with-cursor --- -## Components of Data API +## Components of the Data API * Portfolio API * Token API @@ -16,18 +16,18 @@ slug: docs/data-apis-with-cursor * Simulation API * Utility API -That's so much functionality! 🤯 It can be difficult to understand what all of these APIs do and how they can work together. So let's start with breaking some of them down: +It can be difficult to understand what all of these APIs do and how they work together. Let's break some of them down: -### Focus of this Guide +### Focus of this guide 1. **Transfers API** 2. **Token API** 3. **Prices API** 4. **Portfolio API** -## Video Walkthrough +## Video walkthrough -Check out this video walkthrough, and follow or follow the quick guide below in order to get started: +Check out this video walkthrough, or follow the quick guide below to get started:
-## How Do I Decide What Data API Is Right For Me? +## How to decide which Data API is right for you Use the flow chart below to assess which API is right for you: ![graph1](https://alchemyapi-res.cloudinary.com/image/upload/v1768593425/docs/tutorials/learn-about-alchemy/Gemini_Generated_Image_ud93rhud93rhud93_mqs33j.png) -## Build an App with Cursor +## Build an app with Cursor -In order to get a better understanding of what each of these APIs can do, let's build an app using Cursor and progressively integrate them! +To get a better understanding of what each of these APIs can do, let's build an app using Cursor and progressively integrate them. For each API (Transfers, Token, Prices, Portfolio), we're going to prompt Cursor to build a component. Then at the end, you'll have a fully-working app to really visualize what each of the APIs can do and how they can work together. -### Project Setup +### Project setup 1. Run `npx create-next-app@latest NAME_OF_YOUR_PROJECT --ts --eslint --app --tailwind --yes` 2. In root folder of your newly-created project, add a `.cursor/rules` folder @@ -102,23 +102,23 @@ alwaysApply: true 6. Go to [`alchemy.com/dashboard`](https://www.alchemy.com/dashboard) and copy-paste your API key 7. Run `npm run dev` -And that's it! You have a complete barebones NextJS project ready to go! 🚀 Your project should be running in `localhost:3000`. +That's it. You have a barebones Next.js project ready to go. Your project should be running on `localhost:3000`. -## #1. Transfers API - What moved in/out? 🧐 +## #1. Transfers API - What moved in/out? * **API Description**: Fetch historical transactions for any address in one request -* **Goal**: Build an “Activity Feed” using Transfers API +* **Goal**: Build an “Activity feed” using Transfers API * **Key Method**: * [alchemy\_getAssetTransfers](https://www.alchemy.com/docs/data/transfers-api/transfers-endpoints/alchemy-get-asset-transfers): allows you to easily fetch historical transactions for any address across Ethereum and supported L2s including Base, Polygon, Arbitrum, and Optimism. * **Prompt**: Build a simple React component that takes a wallet address and uses Alchemy’s Transfers API to show a chronological list of incoming and outgoing token transfers. Add this component as a tab in the main page, as I will add more components and I want them to be separated by tabs. -### Transfers API Conclusion +### Transfers API conclusion After Cursor runs, your UI should look something like this: ![view1](https://alchemyapi-res.cloudinary.com/image/upload/v1768596971/docs/tutorials/learn-about-alchemy/Screenshot_2026-01-16_at_12.56.02_PM_w9tjxk.png) -#### What UI shows about the Transfer API: +#### What the UI shows about the Transfers API: * A simple list * Incoming / outgoing @@ -127,28 +127,28 @@ After Cursor runs, your UI should look something like this: * Timestamp / to / from * Tx hash -#### What this demonstrates about the Transfer API: +#### What this demonstrates about the Transfers API: * Transfers ≠ balances * Raw, event-level data * Event-based API -## #2. Token API - What does wallet own right now? 🧐 +## #2. Token API - What does a wallet own right now? * **API Description**: Easily get information about tokens balances and metadata -* **Goal**: Build a “Token Balances Table” using Tokens API +* **Goal**: Build a “Token balances table” using Tokens API * **Key Method**: * [alchemy\_getTokenBalances](https://www.alchemy.com/docs/data/token-api/token-api-endpoints/alchemy-get-token-balances): returns ERC-20 token balances for a given address. * [alchemy\_getTokenMetadata](https://www.alchemy.com/docs/data/token-api/token-api-endpoints/alchemy-get-token-metadata): returns metadata for a given token contract (name, symbol, decimals, logo). * **Prompt**: In a separate tab, but keeping the first component intact, replace the transfers list with a token balances table using Alchemy’s Token API. Show token metadata and current balances for the same wallet. -### Token API Conclusion +### Token API conclusion After Cursor runs, your UI should look something like this: ![view2](https://alchemyapi-res.cloudinary.com/image/upload/v1768597884/docs/tutorials/learn-about-alchemy/Screenshot_2026-01-16_at_1.11.18_PM_abjs49.png) -#### What UI shows about Token API: +#### What the UI shows about the Token API: * Table with: * Token logo @@ -156,10 +156,10 @@ After Cursor runs, your UI should look something like this: * Balance (human-readable) * No dollar values (yet!) -#### What this demonstrates about the Transfer API: +#### What this demonstrates about the Token API: -* State vs history (ie. this API vs Transfers API) -* This is current state. No history, no prices, just ‘what does x address own?’ +* State vs history (this API vs Transfers API) +* This is current state. No history, no prices, only "what does this address own?" ## #3. Prices API - How much are wallet tokens worth? @@ -169,19 +169,19 @@ After Cursor runs, your UI should look something like this: * [`/prices/v1/{apiKey}/tokens/by-address`](https://www.alchemy.com/docs/data/prices-api/prices-api-endpoints/prices-api-endpoints/get-token-prices-by-address): fetches current prices for multiple tokens using network and address pairs. Returns a list of token prices, each containing the network, address, prices, and an optional error field. * **Prompt**: In a separate tab, but keeping the first and second components intact, enhance the token balances table by fetching USD prices from Alchemy’s Prices API and calculating total portfolio value. Name the tab Portfolio V1. -### Prices API Conclusion +### Prices API conclusion After Cursor runs, your UI should look something like this: ![view3](https://alchemyapi-res.cloudinary.com/image/upload/v1768597900/docs/tutorials/learn-about-alchemy/Screenshot_2026-01-16_at_1.11.34_PM_vdfnvf.png) -#### What UI shows about Prices API: +#### What the UI shows about the Prices API: * Same table * New column: USD value * Portfolio total at the top -#### What this demonstrates about Prices API: +#### What this demonstrates about the Prices API: * Composition vs aggregation * Why Portfolio API exists @@ -189,24 +189,24 @@ After Cursor runs, your UI should look something like this: ## #4 Portfolio API - Just give me everything! * **API Description**: Complete portfolio view of a user’s wallet -* **Goal**: Build a one-call portfolio of a user’s wallet +* **Goal**: Build a one-call portfolio view of a wallet * **Key Method**: * [/data/v1/:apiKey/assets/tokens/by-address](https://www.alchemy.com/docs/data/portfolio-apis/portfolio-api-endpoints/portfolio-api-endpoints/get-tokens-by-address): fetches fungible tokens (native, ERC-20 and SPL) for multiple wallet addresses and networks. Returns a list of tokens with balances, prices, and metadata for each wallet/network combination. * **Prompt**: In a separate tab, but keeping the first, second and third components intact, refactor the latest component to use Alchemy’s Portfolio API instead of manually combining Token and Prices APIs. Name the tab Portfolio V2. -### Portfolio API Conclusion +### Portfolio API conclusion After Cursor runs, your UI should look something like this: ![view4](https://alchemyapi-res.cloudinary.com/image/upload/v1768597911/docs/tutorials/learn-about-alchemy/Screenshot_2026-01-16_at_1.11.46_PM_ezcpdz.png) -#### What UI shows about Portfolio API: +#### What the UI shows about the Portfolio API: * Latest component requires much less code * One request, same UI -#### What this demonstrates about Portfolio API: +#### What this demonstrates about the Portfolio API: * Opinionated APIs * Same UI. Way faster to build. Less code. Less control. @@ -215,7 +215,7 @@ After Cursor runs, your UI should look something like this: ![comparison](https://alchemyapi-res.cloudinary.com/image/upload/v1768598495/docs/tutorials/learn-about-alchemy/Screenshot_2026-01-16_at_1.21.28_PM_dbyqxh.png) -## Conclusion +## Wrap-up ![graph2](https://alchemyapi-res.cloudinary.com/image/upload/v1768593420/docs/tutorials/learn-about-alchemy/Gemini_Generated_Image_9cj1ea9cj1ea9cj1_viua7n.png) diff --git a/content/tutorials/build-with-ai/web3-dashboard-prompt.mdx b/content/tutorials/build-with-ai/web3-dashboard-prompt.mdx index 7405c1f15..2038eb1ff 100644 --- a/content/tutorials/build-with-ai/web3-dashboard-prompt.mdx +++ b/content/tutorials/build-with-ai/web3-dashboard-prompt.mdx @@ -9,9 +9,9 @@ slug: docs/web3-dashboard-prompt You can create the same Web3 Dashboard application shown above using Cursor prompting. -## Video Walkthrough +## Video walkthrough -Check out this video walkthrough, and follow or follow the quick guide below in order to get started: +Check out this video walkthrough, or follow the quick guide below to get started:
-## Create a NextJS Application +## Create a Next.js application Open a terminal and run the following: @@ -53,13 +53,13 @@ Then, cd into your newly created project by running cd my-web3-dashboard ``` -## Use Cursor Chat to Create Application from Scratch +## Use Cursor chat to create the application from scratch -In your terminal, run `code .` in order to open the Cursor application. It should look like this after having run the command from the previous step: +In your terminal, run `code .` to open the Cursor application. It should look like this after running the command from the previous step: ![](https://alchemyapi-res.cloudinary.com/image/upload/v1758518347/Screenshot_2025-09-21_at_10.19.02_PM_flwcdc.png) -The Cursor chat should already be open, but if it isn't, type `CMD+I` in order to open it. +The Cursor chat should already be open, but if it isn't, type `CMD+I` to open it. Now, paste the following "one-shot" prompt in and press `Enter`: @@ -560,13 +560,13 @@ Make sure to select `Keep All` once Cursor is done making changes to your projec Once your project has been fully set up, create a `.env.local` file and copy in the format from the `.env.example` file that Cursor should have already created. -Go to your Alchemy Dashboard and copy-paste it into your `.env.local` file. +Go to your [Alchemy Dashboard](https://dashboard.alchemy.com/) and copy-paste your keys into the `.env.local` file. -## Build Further +## Build further -The prompt above sets you up with a fully functional Web3 Dashboard, including an `/rpc` API endpoint so that you do not have to expose your Alchemy API key in the client-side. +The prompt above sets you up with a fully functional Web3 dashboard, including an `/rpc` API endpoint so you don't have to expose your API key on the client side. -You can continue building further with Cursor by simply interacting with the chat tool, try a few of the following prompts: +You can continue building with Cursor by interacting with the chat tool. Try a few of the following prompts: * "Make this Web3 Dashboard check balances across different chains" * "Add a dark mode toggle" diff --git a/content/tutorials/getting-started/alchemy-via-libraries.mdx b/content/tutorials/getting-started/alchemy-via-libraries.mdx index e46db2de6..120c798f2 100644 --- a/content/tutorials/getting-started/alchemy-via-libraries.mdx +++ b/content/tutorials/getting-started/alchemy-via-libraries.mdx @@ -5,32 +5,32 @@ subtitle: Use AI tools to kickoff your Alchemy journey slug: docs/alchemy-via-libraries --- -> 👋 **Don't have an API Key?** [Start here](/docs/create-an-api-key) before building with AI! +> **Don't have an API key?** [Start here](/docs/create-an-api-key) before building with AI. -## Many Coding Languages, Many Great Web3 Libraries +## Many coding languages, many great web3 libraries Across coding languages you'll find many [great web3 libraries](https://www.alchemy.com/dapps/best/web3-libraries). In most cases the best place to start would be to consult the documentation of the web3 library you're using OR, as we'll recommend below, [build with AI tools](docs/tutorials/build-with-ai/ai-powered-id-es). - If you are starting from your favorite tools' documentation, look for json rpc provider or client HTTP transport. That's where you'll configure your Alchemy URL! + If you are starting from your favorite tool's documentation, look for JSON-RPC provider or client HTTP transport. That's where you'll configure your Alchemy URL. - Essentially you will be pointing your library to your node, and you'll be using Alchemy to host your nodes for you! + You'll be pointing your library to your node, using Alchemy to host your nodes for you. ## Quickstart with AI -There's no easier way than to get started with something like [cursor](https://cursor.com/) or [claude code](https://claude.com/product/claude-code) as shown in this video: +A fast way to get started is with something like [Cursor](https://cursor.com/) or [Claude Code](https://claude.com/product/claude-code) as shown in this video: