API3 dAPIs
Using API3's dAPIs in your Smart Contracts
dAPIs are continuously updated streams of off-chain data, such as the latest cryptocurrency, stock and commodity prices. They can power various decentralized applications such as DeFi lending, synthetic assets, stablecoins, derivatives, NFTs and more.
The data feeds are continuously updated by first-party oracles using signed data. dApp owners can read the on-chain value of any dAPI in realtime.
Due to being composed of first-party data feeds, dAPIs offer security, transparency, cost-efficiency and scalability in a turn-key package.
Follow these steps to use self-funded dAPIs in your smart contracts on the Fantom Network.
With self-funded dAPIs, you can fund the dAPI with your own funds. The amount of gas you supply will determine how long your dAPI will be available for use. If you run out of gas, you can fund the dAPI again to keep it available for use.
The API3 Market provides a list of all the dAPIs available across multiple chains including testnets. You can filter the list by chains and data providers. You can also search for a specific dAPI by name. Once selected you will land on the details page where you can find more information about the dAPI.
Once you have selected your dAPI, you can activate it by using the API3 Market to send FTM to the
sponsorWallet. Make sure your:- Wallet is connected to the Market and is the same network as the dAPI you are funding.
- Balance of the wallet should be greater than the amount you are sending to the
sponsorWallet.
To fund the dAPI, you need to click on the Fund Gas button. Depending upon if a proxy contract is already deployed, you will see a different UI.
Use the gas estimator to select how much gas is needed by the dAPI. Click on Send FTM to send the entered amount to the sponsor wallet of the respective dAPI.
Once the transaction is broadcasted & confirmed on the blockchain a transaction confirmation screen will appear.
Smart contracts can interact and read values from contracts that are already deployed on the blockchain. By deploying a proxy contract via the API3 Market, a dAPP can interact and read values from a dAPI like ETH/USD.
Note:
- If a proxy is already deployed for a self-funded dAPI, the dApp can read the dAPI without having to deploy a proxy contract. They do this by using the address of the already deployed proxy contract which will be visible on the API3 Market.
If you are deploying a proxy contract during the funding process, clicking on the Get Proxy button will initiate a transaction to your MetaMask that will deploy a proxy contract.
Once the transaction is broadcasted & confirmed on the blockchain, the proxy contract address will be shown on the UI.
Here's an example of a basic contract that reads from a self-funded dAPI.
// SPDX-License-Identifier: MIT
pragma solidity 0.8.17;
import "@openzeppelin/contracts/access/Ownable.sol";
import "@api3/contracts/v0.8/interfaces/IProxy.sol";
contract DataFeedReaderExample is Ownable {
// This contract reads from a single proxy. Your contract can read from multiple proxies.
address public proxy;
// Updating the proxy address is a security-critical action. In this example, only
// the owner is allowed to do so.
function setProxy(address _proxy) public onlyOwner {
proxy = _proxy;
}
function readDataFeed()
external
view
returns (int224 value, uint256 timestamp)
{
(value, timestamp) = IProxy(proxy).read();
// If you have any assumptions about `value` and `timestamp`, make sure
// to validate them right after reading from the proxy.
}
}
setProxy()is used to set the address of the dAPI Proxy Contract.readDataFeed()is a view function that returns the latest price of the set dAPI.
Here are some additional developer resources