Welcome to the Airnode Testing Suite! This suite is designed to help you test your Airnode on and off-chain. It is assumed that you have done a cloud deployment of your Airnode and have a copy of your deployment files handy. You will also need Metamask, an Ethereum wallet, with some Ropsten testnet ETH for blockchain requests. To get Ropsten test ETH, you may use a faucet, like one from here or here.
-
Frontend - Simple GUI for the Airnode Testing Suite dApp
-
Hardhat - Our requester Smart Contracts
-
API - API Workaround for Cors
Either drag-and-drop or click to upload your config.json file located in the config directory of your deployment package into the Config box on the top left. Do the same for the Receipt box with your receipt.json file located in the output directory.
Choose the endpoint you would like to test from the dropdown menu and check the boxes for any parameters you would like to pass to the endpoint, then fill in their values. Keep in mind, _type and _path are Reserved Parameters required by Airnode. The _type defines the Solidity type, and the _path defines the value to be returned on-chain.
Before testing on-chain, we will use the Airnode HTTP Gateway to quickly and easily make sure our request is a valid Blockchain request (configured in the previous step). Press the HTTP Request button to open the HTTP Testing menu. In the field labeled "Gateway Key", input the HTTP_GATEWAY_API_KEY from your secrets.env file located inside the config directory. Use the "Make Request" button or the generated CURL command to make your request and adjust any params as needed.
When you are satisfied with the response from the HTTP Gateway testing, we can move on to an on-chain request. Close the HTTP Gateway menu and press "Blockchain Request". Connect your Metamask to Ropsten testnet and fund the Sponsor Wallet if the "SponsorWallet Balance" is 0. When you're ready, press "Make Request" and keep an eye on the logs for more information. You should see the desired response from your API.
Congratulations! Your Airnode can successfully receive blockchain requests and return responses to the blockchain! Web3 developers can start here.