Chainlink Functions is available on mainnet only as a BETA preview to ensure that this new platform is robust and secure for developers. While in BETA, developers must follow best practices and not use the BETA for any mission-critical application or secure any value. Chainlink Functions is likely to evolve and improve. Breaking changes might occur while the service is in BETA. Monitor these docs to stay updated on feature improvements along with interface and contract changes.
Functions Demo
// SPDX-License-Identifier: MIT
pragma solidity 0.8.19;
import {FunctionsClient} from "@chainlink/contracts@1.2.0/src/v0.8/functions/v1_0_0/FunctionsClient.sol";
import {ConfirmedOwner} from "@chainlink/contracts@1.2.0/src/v0.8/shared/access/ConfirmedOwner.sol";
import {FunctionsRequest} from "@chainlink/contracts@1.2.0/src/v0.8/functions/v1_0_0/libraries/FunctionsRequest.sol";
/**
* Request testnet LINK and ETH here: https://faucets.chain.link/
* Find information on LINK Token Contracts and get the latest ETH and LINK faucets here: https://docs.chain.link/resources/link-token-contracts/
*/
/**
* @title GettingStartedFunctionsConsumer
* @notice This is an example contract to show how to make HTTP requests using Chainlink
* @dev This contract uses hardcoded values and should not be used in production.
*/
contract GettingStartedFunctionsConsumer is FunctionsClient, ConfirmedOwner {
using FunctionsRequest for FunctionsRequest.Request;
// State variables to store the last request ID, response, and error
bytes32 public s_lastRequestId;
bytes public s_lastResponse;
bytes public s_lastError;
// Custom error type
error UnexpectedRequestID(bytes32 requestId);
// Event to log responses
event Response(
bytes32 indexed requestId,
string character,
bytes response,
bytes err
);
// Router address - Hardcoded for Sepolia
// Check to get the router address for your supported network https://docs.chain.link/chainlink-functions/supported-networks
address router = 0xb83E47C2bC239B3bf370bc41e1459A34b41238D0;
// JavaScript source code
// Fetch character name from the Star Wars API.
// Documentation: https://swapi.info/people
string source =
"const characterId = args[0];"
"const apiResponse = await Functions.makeHttpRequest({"
"url: `https://swapi.info/api/people/${characterId}/`"
"});"
"if (apiResponse.error) {"
"throw Error('Request failed');"
"}"
"const { data } = apiResponse;"
"return Functions.encodeString(data.name);";
//Callback gas limit
// uint32 gasLimit = 300000;
// donID - Hardcoded for Sepolia
// Check to get the donID for your supported network https://docs.chain.link/chainlink-functions/supported-networks
bytes32 donID =
0x66756e2d657468657265756d2d7365706f6c69612d3100000000000000000000;
// State variable to store the returned character information
string public character;
/**
* @notice Initializes the contract with the Chainlink router address and sets the contract owner
*/
constructor()
FunctionsClient(router)
ConfirmedOwner(msg.sender)
{}
/**
* @notice Sends an HTTP request for character information
* @param subscriptionId The ID for the Chainlink subscription
* @param args The arguments to pass to the HTTP request
* @return requestId The ID of the request
*/
function sendRequest(
uint64 subscriptionId,
string[] calldata args,
uint32 callbackGasLimit
) external onlyOwner returns (bytes32 requestId) {
FunctionsRequest.Request memory req;
req.initializeRequestForInlineJavaScript(source); // Initialize the request with JS code
if (args.length > 0) req.setArgs(args); // Set the arguments for the request
// Send the request and store the request ID
s_lastRequestId = _sendRequest(
req.encodeCBOR(),
subscriptionId,
callbackGasLimit,
donID
);
return s_lastRequestId;
}
/**
* @notice Callback function for fulfilling a request
* @param requestId The ID of the request to fulfill
* @param response The HTTP response data
* @param err Any errors from the Functions request
*/
function fulfillRequest(
bytes32 requestId,
bytes memory response,
bytes memory err
) internal override {
if (s_lastRequestId != requestId) {
revert UnexpectedRequestID(requestId); // Check if request IDs match
}
// Update the contract's state variables with the response and any errors
s_lastResponse = response;
character = string(response);
s_lastError = err;
// Emit an event to log the response
emit Response(requestId, character, s_lastResponse, s_lastError);
}
}
Ref: