Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
6 changes: 3 additions & 3 deletions content/admin-api/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion content/admin-api/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
8 changes: 4 additions & 4 deletions content/api-reference/abstract/abstract-api-faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,20 +19,20 @@ 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?

Abstract offers native account abstraction, which is a key feature of its architecture. It also provides the Abstract Global Wallet, a smart contract wallet powering the Abstract ecosystem.

## 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.
14 changes: 7 additions & 7 deletions content/api-reference/abstract/abstract-api-quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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!

Expand All @@ -28,7 +28,7 @@ Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create an
```
</CodeGroup>

## Create Client Connected to Alchemy
## Create a client connected to Alchemy

<CodeGroup>
```js
Expand All @@ -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

<CodeGroup>
```js
Expand All @@ -53,7 +53,7 @@ console.log("Current block number:", blockNumber);
```
</CodeGroup>

## Get an Address Balance
## Get an address balance

<CodeGroup>
```js
Expand All @@ -62,7 +62,7 @@ console.log("Balance (ETH):", Number(balance) / 1e18);
```
</CodeGroup>

## Read Block Data
## Read block data

<CodeGroup>
```js
Expand All @@ -73,7 +73,7 @@ console.log(block);
```
</CodeGroup>

## Fetch a Transaction by Hash
## Fetch a transaction by hash

<CodeGroup>
```js
Expand All @@ -82,7 +82,7 @@ console.log(tx);
```
</CodeGroup>

## Fetch Transaction Receipt
## Fetch a transaction receipt

<CodeGroup>
```js
Expand Down
8 changes: 4 additions & 4 deletions content/api-reference/adi/adi-api-faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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.
14 changes: 7 additions & 7 deletions content/api-reference/adi/adi-api-quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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!

Expand All @@ -28,7 +28,7 @@ Let's use the [`viem`](https://www.npmjs.com/package/viem) package to create an
```
</CodeGroup>

## Create Client Connected to Alchemy
## Create a client connected to Alchemy

<CodeGroup>
```js
Expand All @@ -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

<CodeGroup>
```js
Expand All @@ -61,7 +61,7 @@ console.log("Current block number:", blockNumber);
```
</CodeGroup>

## Get an Address Balance
## Get an address balance

<CodeGroup>
```js
Expand All @@ -70,7 +70,7 @@ console.log("Balance (ETH):", Number(balance) / 1e18);
```
</CodeGroup>

## Read Block Data
## Read block data

<CodeGroup>
```js
Expand All @@ -81,7 +81,7 @@ console.log(block);
```
</CodeGroup>

## Fetch a Transaction by Hash
## Fetch a transaction by hash

<CodeGroup>
```js
Expand All @@ -90,7 +90,7 @@ console.log(tx);
```
</CodeGroup>

## Fetch Transaction Receipt
## Fetch a transaction receipt

<CodeGroup>
```js
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,15 +45,15 @@ 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.

### Gas Manager

* **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.

***

Expand All @@ -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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ 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

* An active paid Alchemy account.

## 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)

Expand Down
6 changes: 3 additions & 3 deletions content/api-reference/alchemy-rollups/rollups-faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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?**

Expand All @@ -33,12 +33,12 @@ 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?**

A: Changing the gas token post-deployment is complex and typically requires launching a new rollup. It is best to decide on the token during the initial configuration.

**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.
Original file line number Diff line number Diff line change
Expand Up @@ -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?

Expand All @@ -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.

Expand All @@ -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

Expand Down
6 changes: 3 additions & 3 deletions content/api-reference/alchemy-rollups/using-your-rollup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,15 @@ 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.

# 2. Bridging Assets

## 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
Expand Down Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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)<br/>
Simulates a transaction and returns a full list of asset changes.
Expand Down
Loading
Loading