Getting Started with Ethereum Development Using Alchemy

Ethereum and Alchemy logos

This is a beginners guide to getting started with Ethereum development using Alchemy, the leading blockchain developer platform powering millions of users from 70% of the top blockchain apps, including Maker, 0x, MyEtherWallet, Dharma, and Kyber.

We’ll take you from signing up with Alchemy to writing your first web3 script! No blockchain development experience necessary!

1. Sign Up for a Free Alchemy Account

Creating an account with Alchemy is easy, sign up for free here.

2. Create an Alchemy App

To use Alchemy’s products, you need an API key to authenticate your requests.

You can create API keys from the dashboard. To make a new key, navigate to “Create App” as shown below:

Special thanks to ShapeShift for letting us show their dashboard!

Alchemy dashboard

Fill in the details under “Create App” to get your new key. You can also see apps you previously made and those made by your team here. Pull existing keys by clicking on “View Key” for any app.

Create app with Alchemy screenshot

You can also pull existing API keys by hovering over “Apps” and selecting one. You can “View Key” here, as well as “Edit App” to whitelist specific domains, see several developer tools, and view analytics.

Gif showing a user how to pull API keys

3. Make a Request from the Command Line

Interact with the Ethereum blockchain through Alchemy using JSON-RPC and curl.

For manual requests, we recommend interacting with the JSON-RPC via POST requests. Simply pass in the Content-Type: application/json header and your query as the POST body with the following fields:

  • jsonrpc: The JSON-RPC version—currently, only 2.0 is supported.
  • method: The ETH API method. See API reference.
  • params: A list of parameters to pass to the method.
  • id: The ID of your request. Will be returned by the response so you can keep track of which request a response belongs to.

Here is an example you can run from the command line to retrieve the current gas price:

curl [https://eth-mainnet.alchemyapi.io/v2/demo](https://eth-mainnet.alchemyapi.io/v2/demo) \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","method":"eth_gasPrice","params":[],"id":73}'

NOTE: Replace https://eth-mainnet.alchemyapi.io/v2/demo with your own API key https://eth-mainnet.alchemyapi.io/v2/your-api-key.

Results:

1{ "id": 73,"jsonrpc": "2.0","result": "0x09184e72a000" // 10000000000000 }
2

4. Set up your Web3 Client

If you have an existing client, change your current node provider URL to an Alchemy URL with your API key: “https://eth-mainnet.alchemyapi.io/v2/your-api-key"

NOTE: The scripts below need to be run in a node context or saved in a file, not run from the command line. If you don’t already have Node or npm installed, check out this quick set-up guide for macs.

There are tons of Web3 libraries you can integrate with Alchemy, however, we recommend using Alchemy Web3, a drop-in replacement for web3.js, built and configured to work seamlessly with Alchemy. This provides multiple advantages such as automatic retries and robust WebSocket support.

To install AlchemyWeb3.js, navigate to your project directory and run:

With Yarn:

1yarn add @alch/alchemy-web3
2

With NPM:

1npm install @alch/alchemy-web3
2

To interact with Alchemy’s node infrastructure, run in NodeJS or add this to a JavaScript file:

1const { createAlchemyWeb3 } = require("@alch/alchemy-web3")
2const web3 = createAlchemyWeb3(
3 "https://eth-mainnet.alchemyapi.io/v2/your-api-key"
4)
5

5. Write your first Web3 Script!

Now to get our hands dirty with a little web3 programming we’ll write a simple script that prints out the latest block number from the Ethereum Mainnet.

  1. If you haven’t already, in your terminal create a new project directory and cd into it:
1mkdir web3-examplecd web3-example
2

2. Install the Alchemy web3 (or any web3) dependency into your project if you have not already:

1npm install @alch/alchemy-web3
2

‌3. Create a file named index.js and add the following contents:

You should ultimately replace demo with your Alchemy HTTP API key.

1async function main() {
2 const { createAlchemyWeb3 } = require("@alch/alchemy-web3")
3 const web3 = createAlchemyWeb3("https://eth- mainnet.alchemyapi.io/v2/demo")
4 const blockNumber = await web3.eth.getBlockNumber()
5 console.log("The latest block number is " + blockNumber)
6}
7main()
8

Unfamiliar with the async stuff? Check out this Medium post.

4. Run it in your terminal using node

1node index.js
2

‌5. You should now see the latest block number output in your console!

1The latest block number is 11043912
2

Woo! Congrats! You just wrote your first web3 script using Alchemy 🎉

‌Not sure what to do next? Try deploying your first smart contract and get your hands dirty with some solidity programming in our Hello World Smart Contract Guide, or test your dashboard knowledge with the Dashboard Demo App!

Sign up with Alchemy for free, check out our documentation, and for the latest news, follow us on Twitter.

Ryan Cordell
Last edit: @ryancreatescopy, December 1, 2020
Edit page