Oracle integration (Chainlink) in Blockchain / Solidity

Introduction

Oracles help smart contracts get information from outside the blockchain. Chainlink is a popular way to connect smart contracts with real-world data safely.

You want your smart contract to know the current price of a cryptocurrency.

You need weather data inside your smart contract for insurance purposes.

You want to trigger actions in your contract based on sports scores.

You want to get random numbers securely for a game on the blockchain.

Syntax

Blockchain / Solidity

import "@chainlink/contracts/src/v0.8/ChainlinkClient.sol";

contract MyContract is ChainlinkClient {
    using Chainlink for Chainlink.Request;

    address private oracle;
    bytes32 private jobId;
    uint256 private fee;

    constructor() {
        setPublicChainlinkToken();
        oracle = 0x...; // Oracle address
        jobId = "..."; // Job ID string
        fee = 0.1 * 10 ** 18; // LINK token fee
    }

    function requestData() public returns (bytes32 requestId) {
        Chainlink.Request memory req = buildChainlinkRequest(jobId, address(this), this.fulfill.selector);
        // Add parameters to request
        return sendChainlinkRequestTo(oracle, req, fee);
    }

    function fulfill(bytes32 _requestId, uint256 _data) public recordChainlinkFulfillment(_requestId) {
        // Use the data
    }
}

You must fund your contract with LINK tokens to pay for oracle services.

The jobId tells the oracle what kind of data to fetch.

Examples

This sets up the Chainlink token, oracle address, job ID, and fee for a price feed request.

Blockchain / Solidity

setPublicChainlinkToken();
oracle = 0x7AFe30cb3E53dba6801aa0ea647A0Ecea7cbe18d;
jobId = "29fa9aa13bf1468788b7cc4a500a45b8";
fee = 0.1 * 10 ** 18;

This function asks the oracle to get Bitcoin price from a web API and return the USD rate.

Blockchain / Solidity

function requestPrice() public returns (bytes32 requestId) {
    Chainlink.Request memory req = buildChainlinkRequest(jobId, address(this), this.fulfill.selector);
    req.add("get", "https://api.coindesk.com/v1/bpi/currentprice/BTC.json");
    req.add("path", "bpi.USD.rate_float");
    return sendChainlinkRequestTo(oracle, req, fee);
}

This function receives the price from the oracle and saves it in the contract.

Blockchain / Solidity

function fulfill(bytes32 _requestId, uint256 _price) public recordChainlinkFulfillment(_requestId) {
    latestPrice = _price;
}

Sample Program

This smart contract uses Chainlink to get the current Bitcoin price in USD from an external API. It stores the price in latestPrice. You call requestPrice() to start the request. When the oracle replies, fulfill() saves the price.

Blockchain / Solidity

pragma solidity ^0.8.7;

import "@chainlink/contracts/src/v0.8/ChainlinkClient.sol";

contract PriceConsumer is ChainlinkClient {
    using Chainlink for Chainlink.Request;

    uint256 public latestPrice;
    address private oracle;
    bytes32 private jobId;
    uint256 private fee;

    constructor() {
        setPublicChainlinkToken();
        oracle = 0x7AFe30cb3E53dba6801aa0ea647A0Ecea7cbe18d;
        jobId = "29fa9aa13bf1468788b7cc4a500a45b8";
        fee = 0.1 * 10 ** 18; // 0.1 LINK
    }

    function requestPrice() public returns (bytes32 requestId) {
        Chainlink.Request memory req = buildChainlinkRequest(jobId, address(this), this.fulfill.selector);
        req.add("get", "https://api.coindesk.com/v1/bpi/currentprice/BTC.json");
        req.add("path", "bpi.USD.rate_float");
        return sendChainlinkRequestTo(oracle, req, fee);
    }

    function fulfill(bytes32 _requestId, uint256 _price) public recordChainlinkFulfillment(_requestId) {
        latestPrice = _price;
    }
}

Important Notes

Make sure your contract has enough LINK tokens to pay the oracle fee.

Oracle addresses and job IDs differ by network (mainnet, testnet).

Chainlink requests are asynchronous; the contract waits for the oracle to call fulfill.

Summary

Chainlink oracles let smart contracts get real-world data safely.

You set oracle address, job ID, and fee to request data.

Data comes back in a callback function you define, like fulfill.

Practice

1. What is the main purpose of using Chainlink oracles in smart contracts?

easy

A. To encrypt data stored on the blockchain

B. To fetch real-world data securely into the blockchain

C. To create new tokens automatically

D. To speed up transaction processing on the blockchain

Solution

1. Step 1: Understand what oracles do

   Oracles connect smart contracts to external data sources outside the blockchain.

2. Step 2: Identify the main use of Chainlink oracles

   Chainlink oracles securely fetch real-world data like prices or weather into smart contracts.

3. Final Answer:

   To fetch real-world data securely into the blockchain -> Option B

4. Quick Check:

   Oracle purpose = fetch external data [OK]

Hint: Oracles bring outside data inside smart contracts [OK]

Common Mistakes:

• Thinking oracles speed up blockchain transactions
• Confusing oracles with token creation
• Assuming oracles encrypt blockchain data

2. Which of the following is the correct way to declare a Chainlink request in Solidity?

easy

A. Chainlink.Request memory req = buildChainlinkRequest(jobId, address(this), this.fulfill.selector);

B. Chainlink.Request req = new Chainlink.Request(jobId, address(this), fulfill);

C. Request memory req = Chainlink.buildRequest(jobId, this, fulfill);

D. ChainlinkRequest req = buildRequest(jobId, this, fulfill.selector);

Solution

1. Step 1: Recall Chainlink request syntax

   The correct syntax uses Chainlink.Request memory and buildChainlinkRequest function.

2. Step 2: Match the correct parameters

   Parameters are jobId, contract address (address(this)), and fulfill function selector (this.fulfill.selector).

3. Final Answer:

   Chainlink.Request memory req = buildChainlinkRequest(jobId, address(this), this.fulfill.selector); -> Option A

4. Quick Check:

   Correct request syntax = Chainlink.Request memory req = buildChainlinkRequest(jobId, address(this), this.fulfill.selector); [OK]

Hint: Use buildChainlinkRequest with memory and fulfill.selector [OK]

Common Mistakes:

• Omitting 'memory' keyword
• Using 'new' keyword incorrectly
• Wrong function selector syntax

3. Given this Solidity snippet, what will be the value of data after fulfillment?

uint256 public data;

function fulfill(bytes32 _requestId, uint256 _value) public recordChainlinkFulfillment(_requestId) {
    data = _value;
}

// Assume fulfill is called with _value = 42

medium

A. 0

B. RequestId bytes32 value

C. Compilation error

D. 42

Solution

1. Step 1: Understand fulfill function behavior

   The fulfill function sets the contract's data variable to the passed _value.

2. Step 2: Apply given input value

   Since fulfill is called with _value = 42, data becomes 42.

3. Final Answer:

   42 -> Option D

4. Quick Check:

   fulfill sets data = _value = 42 [OK]

Hint: fulfill sets data to passed _value parameter [OK]

Common Mistakes:

• Confusing _requestId with _value
• Assuming data stays zero
• Thinking function causes error

4. Identify the error in this Chainlink oracle request code snippet:

Chainlink.Request memory req = buildChainlinkRequest(jobId, address(this), this.fulfill.selector);
req.add("get", "https://api.example.com/data");
req.add("path", "price");
sendChainlinkRequest(req, fee);

medium

A. Missing LINK token approval before sending request

B. Incorrect function name: should be sendChainlinkRequestTo

C. Missing import for Chainlink library

D. Using 'add' instead of 'addString' for parameters

Solution

1. Step 1: Review Chainlink request sending requirements

   Before sending a request, the contract must have LINK tokens approved to pay the oracle fee.

2. Step 2: Check code for LINK approval

   The snippet does not show LINK token approval, which is required to avoid failure.

3. Final Answer:

   Missing LINK token approval before sending request -> Option A

4. Quick Check:

   LINK approval needed before sendChainlinkRequest [OK]

Hint: Always approve LINK tokens before sending requests [OK]

Common Mistakes:

• Assuming sendChainlinkRequestTo is correct function
• Confusing add and addString methods
• Ignoring LINK token approval step

5. You want to fetch the current ETH/USD price using Chainlink in your smart contract. Which steps must you combine to do this correctly?

hard

A. Use Chainlink request but omit fulfill function to save gas

B. Directly call the price feed contract without Chainlink oracles

C. Build a Chainlink request with jobId and URL, send request with fee, implement fulfill to store price

D. Send request without specifying jobId and rely on default oracle

Solution

1. Step 1: Build and send Chainlink request

   Create a request specifying jobId and data source URL, then send it with the required fee.

2. Step 2: Implement fulfill function

   Define fulfill to receive the oracle response and store the ETH/USD price in your contract.

3. Final Answer:

   Build a Chainlink request with jobId and URL, send request with fee, implement fulfill to store price -> Option C

4. Quick Check:

   Request + fee + fulfill = correct Chainlink usage [OK]

Hint: Request data, pay fee, handle response in fulfill [OK]

Common Mistakes:

• Skipping fulfill function implementation
• Not specifying jobId in request
• Assuming default oracle without jobId