# Using Templates

Table of Contents

A request to an Airnode can have many parameters. It is very common for requester contracts (e.g., a data feed) to make repeated requests with the exact same parameters. In such instances, it is wasteful to pass all of these parameters repeatedly. Templates are used to hold a set of parameter values on-chain that can be used repeatedly when calling themakeTemplateRequest()function in AirnodeRrp.sol (opens new window). UnlikemakeFullRequest(), makeTemplateRequest()requires that a requester passtemplateIdwhich identifies a template.

function makeTemplateRequest(
    bytes32 templateId,
    address sponsor,
    address sponsorWallet,
    address fulfillAddress,
    bytes4 fulfillFunctionId,
    bytes calldata parameters
) external override returns (bytes32 requestId) {
1
2
3
4
5
6
7
8

When a template is used to make a request, both the parameters encoded in parameters of the template and parameters provided at request-time (if any) will be used by the Airnode. In case the two include a parameter with the same name, the one provided at request-time will be used.

The structure of a template, as shown below, is simple.

  • address of the desired Airnode
  • endpointId from the Airnode
  • endpoint parameters
struct Template {
  address airnode;
  bytes32 endpointId;
  bytes parameters;
}
1
2
3
4
5

There are just a few steps to create and place a template on-chain for a requester contract to use. Each template is identified by atemplateId, which is the hash of its contents. When you create a template record on-chain, see Part #2: Upload Template, a templateId will be returned.


# Part #1: Build a Template

First create a file that contains a template object. Below is an example. You will need the address of the Airnode and its endpointId to be called. Below are links that discuss request parameters if you need help.

{
  "airnode": "0x15e7097beac1fd23c0d1e3f5a882a6f99ecbcf2e0c1011d1bd43707c6c0ec717",
  "endpointId": "0x2605589dfc93c8f9c35eecdfe1e666c2193df30a8b13e1e0dd72941f59f9064c",
  "parameters": [
    {
      "name": "name1",
      "value": "value1",
      "type": "string"
    },
    {
      "name": "name2",
      "value": "1000",
      "type": "uint256"
    }
  ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

If you create more than one template using the same parameter values for an Airnode/endpointID the sametemplateIdwill be returned for each. Only one template is created when the parameters are the same.


# Part #2: Upload Template

Use the create-template (opens new window) command in the @api3/airnode-admin package to move your template on-chain. The commandcreate-templatereads a file, uses its contents to create a template and returns atemplateId. To create a new template record you will need the following.

  • A providerURL from your blockchain provider.
  • A mnemonic for gas to fund the record creation.
  • The path to a template file.

mnemonic

This wallet pays the transaction gas costs to write the template record. This is not the wallet(s) that will pay gas costs to actually execute any Airnode, for that the Airnode themselves will create sponsor wallets on behalf of your sponsor record.

npx @api3/airnode-admin create-template \
  --providerUrl https://ropsten.infura.io/v3/<KEY> \
  --mnemonic "nature about salad..." \
  --templateFilePath ./template.json
1
2
3
4

# More on Templates

You can create as many templates as needed. Call the getTemplatescommand in the @api3/airnode-admin package to get a list of the templates by theirtemplateIds.

Last Updated: 10/30/2021, 12:37:56 PM