Implement HTTP requests

Overview

This tutorial explains how implement simple HTTP requests to multiple APIs:

tip

These APIs are just examples. You can make HTTP requests to any external API.

1. Create a contract

Create a new file called MultiApiTest.sol:

warden-http-examples/src/MultiApiTest.sol
// SPDX-License-Identifier: UNLICENSED
pragma solidity ^0.8.25;

import "./interfaces/IAsync.sol";
import "./interfaces/Http.sol";
import "./interfaces/IJson.sol";

contract MultiApiTest {
    uint64 public lastTaskId;
    bytes public responseBody;
    uint256 public statusCode;
    string public currentApi;
    
    // Try the CoinGecko API: fetch the current Bitcoin price
    function tryCoinGecko() public returns (Http.Request memory request) {
        currentApi = "CoinGecko";
        request.url = "https://api.coingecko.com/api/v3/simple/price?ids=bitcoin&vs_currencies=usd";
        request.method = "GET";
        request.body = "";
        
        lastTaskId = IASYNC_CONTRACT.addTask("http", abi.encode(request), address(this));
    }
    
    // Try the GitHub API
    function tryGitHub() public returns (Http.Request memory request) {
        currentApi = "GitHub";
        request.url = "https://api.github.com/users/ethereum";
        request.method = "GET";
        request.body = "";
        
        lastTaskId = IASYNC_CONTRACT.addTask("http", abi.encode(request), address(this));
    }
    
    // Try the JSONPlaceholder API
    function tryJSONPlaceholder() public returns (Http.Request memory request) {
        currentApi = "JSONPlaceholder";
        request.url = "https://jsonplaceholder.typicode.com/posts/1";
        request.method = "GET";
        request.body = "";
        
        lastTaskId = IASYNC_CONTRACT.addTask("http", abi.encode(request), address(this));
    }
    
    // Try the OpenWeatherMap API
    function tryOpenWeather() public returns (Http.Request memory request) {
        currentApi = "OpenWeather";
        request.url = "https://api.openweathermap.org/data/2.5/weather?q=London&appid=b6907d289e10d714a6e88b30761fae22";
        request.method = "GET";
        request.body = "";
        
        lastTaskId = IASYNC_CONTRACT.addTask("http", abi.encode(request), address(this));
    }
    
    // Check if the response is ready
    function isReady() public view returns (bool) {
        TaskByIdResponse memory task = IASYNC_CONTRACT.taskById(lastTaskId);
        return task.taskResponse.result.id != 0;
    }
    
    // Try to process the response without reverting
    function tryProcess() public returns (bool) {
        TaskByIdResponse memory task = IASYNC_CONTRACT.taskById(lastTaskId);
        if (task.taskResponse.result.id == 0) {
            return false; // Not ready yet
        }
        
        // Decode the response
        Http.Response memory response = abi.decode(task.taskResponse.result.output, (Http.Response));
        
        // Store the response data
        statusCode = response.status;
        responseBody = response.body;
        
        return true;
    }
    
    // A callback function: the precompile will call it when the response is ready
    function cb() external {
        TaskByIdResponse memory task = IASYNC_CONTRACT.taskById(lastTaskId);
        if (task.taskResponse.result.id == 0) {
            return; // Not ready yet
        }
        
        // Decode the response
        Http.Response memory response = abi.decode(task.taskResponse.result.output, (Http.Response));
        
        // Store the response data
        statusCode = response.status;
        responseBody = response.body;
    }
    
    // Get the response as a string for easier reading
    function getResponseAsString() public view returns (string memory) {
        return string(responseBody);
    }
}

2. Deploy

Deploy the contract:

forge create --rpc-url $RPC_URL --private-key $PRIVATE_KEY \
  src/MultiApiTest.sol:MultiApiTest --broadcast

Note down the value returned as Deployed to and set it as an environment variable:
```
export CONTRACT_ADDRESS=my-contract-address
```

3. Make HTTP requests

3.1. Call the CoinGecko API

Test HTTP requests to the CoinGecko API:

Call the tryCoinGecko() function. It'll fetch the current Bitcoin price.

cast send $CONTRACT_ADDRESS "tryCoinGecko()" \
  --private-key $PRIVATE_KEY \
  --rpc-url $RPC_URL

Wait a few seconds. Now you can check whether the response is ready by calling isReady() (this step is optional):
```
cast call $CONTRACT_ADDRESS "isReady()(bool)" --rpc-url $RPC_URL
```
The expected output is the following:
```
true
```
Call tryProcess(). This function will process the response without reverting in case it's not ready yet.
```
cast send $CONTRACT_ADDRESS "tryProcess()" \
  --private-key $PRIVATE_KEY \
  --rpc-url $RPC_URL
```
Finally, get the status code by calling statusCode():
```
cast call $CONTRACT_ADDRESS "statusCode()(uint256)" --rpc-url $RPC_URL
```
The expected output is the following:
```
200
```

You can also try to get the response as a string:

cast call $CONTRACT_ADDRESS "getResponseAsString()(string)" --rpc-url $RPC_URL

This will print the JSON response:

{"bitcoin":{"usd":50000.0}}

3.2. Call the GitHub API

Test requests to the GitHub API in a similar way:

cast send $CONTRACT_ADDRESS "tryGitHub()" \
  --private-key $PRIVATE_KEY \
  --rpc-url $RPC_URL

cast send $CONTRACT_ADDRESS "tryProcess()"
  --private-key $PRIVATE_KEY \
  --rpc-url $RPC_URL

cast call $CONTRACT_ADDRESS "statusCode()(uint256)" --rpc-url $RPC_URL

The expected output is the following:

3.3. Call the JSONPlaceholder API

Test requests to the JSONPlaceholder API:

cast send $CONTRACT_ADDRESS "tryJSONPlaceholder()" \
--private-key $PRIVATE_KEY \
--rpc-url $RPC_URL

cast send $CONTRACT_ADDRESS "tryProcess()"
--private-key $PRIVATE_KEY \
--rpc-url $RPC_URL

cast call $CONTRACT_ADDRESS "statusCode()(uint256)" --rpc-url $RPC_URL

This might fail with the following error:

Error: server returned a null response when a non-null response was expected

tip

If you're experiencing troubles querying a particular API with x/async, please contact us in Discord.

3.4. Call the OpenWeatherMap API

Test requests to the The OpenWeatherMap API:

cast send $CONTRACT_ADDRESS "tryOpenWeather()" \
--private-key $PRIVATE_KEY \
--rpc-url $RPC_URL

cast send $CONTRACT_ADDRESS "tryProcess()"
--private-key $PRIVATE_KEY \
--rpc-url $RPC_URL

cast call $CONTRACT_ADDRESS "statusCode()(uint256)" --rpc-url $RPC_URL

Next steps

All API requests return JSON data. To learn how to extract data from such responses using the JSON precompile, follow the next guide: Extract data.

Overview​

1. Create a contract​

2. Deploy​

3. Make HTTP requests​

3.1. Call the CoinGecko API​

3.2. Call the GitHub API​

3.3. Call the JSONPlaceholder API​

3.4. Call the OpenWeatherMap API​

Next steps​