Skip to content
This repository has been archived by the owner on Aug 8, 2023. It is now read-only.

Commit

Permalink
Merge in beacon renaming script and polish
Browse files Browse the repository at this point in the history
Add beacon renaming and descriptions addition script.
Some additional polishing.
  • Loading branch information
aquarat authored Feb 4, 2022
2 parents fbbfc51 + 8a137ae commit 29e04eb
Show file tree
Hide file tree
Showing 59 changed files with 469 additions and 215 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

> A package that houses data and utilities required for API3 operations

## `/data`

Static data that other applications (e.g., monitoring and visualization services) may need to know about, including:
Expand All @@ -17,7 +16,7 @@ Static data that other applications (e.g., monitoring and visualization services
## `/data/chains.json`

A JSON file that contains data related to the chains. These chains will not necessarily have official support. Each
chain has the following specified:
chain has the following specified at minimum:

- `AccessControlRegistry`: AccessControlRegistry contract address
- `AirnodeRrp`: AirnodeRrp contract address
Expand Down Expand Up @@ -71,13 +70,17 @@ are human-browseable. The files contents are:
- `templateId`: Template ID (must match `airnode`, `endpointId`, `parameters` encoded and hashed)
- `decodedParameters`: `parameters` decoded to be human-readable
- `chains`: Chains that the template is currently deployed on (must match ones from `chains.json`)
- `templateName`: A human-readable name for the template, suitable for documentation use.
- `description`: A human-readable description for the template, suitable for documentation use (optional).

### `/data/apis/{oisTitle}/beacons`

Hosts files containing beacon data and metadata. The files are named to describe what the beacon is for so that they are
human-browseable.
human-browsable.

- `templateId`: Template ID (must match one from `/data/apis/{oisTitle}/templates`)
- `templateName`: A human-readable name for the template, suitable for documentation use.
- `description`: A human-readable description for the template, suitable for documentation use (optional).
- `parameters`: Airnode ABI-encoded parameters to extend the ones defined by the template
- `beaconId`: Beacon ID (must match `templateId`, `parameters` encoded and hashed)
- `decodedParameters`: `parameters` decoded to be human-readable
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"templateId": "0x9c24111e2c324627cb837b5ec68e17e457596c9398683b280da533e27ab50894",
"templateName": "global vwap for aave_usd",
"templateName": "AAVE/USD",
"parameters": "0x31626262626200000000000000000000000000000000000000000000000000007061697200000000000000000000000000000000000000000000000000000000616176655f7573640000000000000000000000000000000000000000000000005f706174680000000000000000000000000000000000000000000000000000007061796c6f61642e767761702c000000000000000000000000000000000000005f74797065000000000000000000000000000000000000000000000000000000696e743235362c74696d657374616d70000000000000000000000000000000005f74696d65730000000000000000000000000000000000000000000000000000313030303030302c0000000000000000000000000000000000000000000000006c6f6f6b6261636b506572696f640000000000000000000000000000000000003500000000000000000000000000000000000000000000000000000000000000",
"decodedParameters": [
{
Expand Down Expand Up @@ -55,5 +55,6 @@
"apiProviderAirkeeperDeviationPercentage": 0.5,
"apiProviderAirkeeperSponsor": "0x58c210AC77bf7075598D497b18778b7c6687C59f"
}
]
],
"description": "Price of AAVE in USD"
}
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"templateId": "0xb05f57b84056d8bb075b5f1012a3e50a1039175bcfceaaddd6ee7fc774fca35e",
"templateName": "global vwap for atom_usd",
"templateName": "ATOM/USD",
"parameters": "0x3162626262620000000000000000000000000000000000000000000000000000706169720000000000000000000000000000000000000000000000000000000061746f6d5f7573640000000000000000000000000000000000000000000000005f706174680000000000000000000000000000000000000000000000000000007061796c6f61642e767761702c000000000000000000000000000000000000005f74797065000000000000000000000000000000000000000000000000000000696e743235362c74696d657374616d70000000000000000000000000000000005f74696d65730000000000000000000000000000000000000000000000000000313030303030302c0000000000000000000000000000000000000000000000006c6f6f6b6261636b506572696f640000000000000000000000000000000000003500000000000000000000000000000000000000000000000000000000000000",
"decodedParameters": [
{
Expand Down Expand Up @@ -55,5 +55,6 @@
"apiProviderAirkeeperDeviationPercentage": 0.5,
"apiProviderAirkeeperSponsor": "0x58c210AC77bf7075598D497b18778b7c6687C59f"
}
]
],
"description": "Price of ATOM in USD"
}
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"templateId": "0x2a0219013e042c3d68afa6501e9798c84863e7e466f64f4a7d45cb00bf70732e",
"templateName": "global vwap for avax_usd",
"templateName": "AVAX/USD",
"parameters": "0x31626262626200000000000000000000000000000000000000000000000000007061697200000000000000000000000000000000000000000000000000000000617661785f7573640000000000000000000000000000000000000000000000005f706174680000000000000000000000000000000000000000000000000000007061796c6f61642e767761702c000000000000000000000000000000000000005f74797065000000000000000000000000000000000000000000000000000000696e743235362c74696d657374616d70000000000000000000000000000000005f74696d65730000000000000000000000000000000000000000000000000000313030303030302c0000000000000000000000000000000000000000000000006c6f6f6b6261636b506572696f640000000000000000000000000000000000003500000000000000000000000000000000000000000000000000000000000000",
"decodedParameters": [
{
Expand Down Expand Up @@ -55,5 +55,6 @@
"apiProviderAirkeeperDeviationPercentage": 0.5,
"apiProviderAirkeeperSponsor": "0x58c210AC77bf7075598D497b18778b7c6687C59f"
}
]
],
"description": "Price of AVAX in USD"
}
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"templateId": "0x2c552c0210bea2ab148355aaa285bddfe3c1b11f8eeb17c9e6bccc6ec56f9954",
"templateName": "gas prediction for average gas price",
"templateName": "Average Gas on Ethereum Mainnet",
"parameters": "0x31626200000000000000000000000000000000000000000000000000000000005f706174680000000000000000000000000000000000000000000000000000007061796c6f61642e617665726167652e67617350726963652c000000000000005f74797065000000000000000000000000000000000000000000000000000000696e743235362c74696d657374616d7000000000000000000000000000000000",
"decodedParameters": [
{
Expand Down Expand Up @@ -40,5 +40,6 @@
"apiProviderAirkeeperDeviationPercentage": 5,
"apiProviderAirkeeperSponsor": "0x58c210AC77bf7075598D497b18778b7c6687C59f"
}
]
],
"description": "Gas prediction for average gas on Ethereum Mainnet"
}
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"templateId": "0xf60503627e5c2cf3e44c4a39d574a472992823f160d629a6635807de1ec4dce2",
"templateName": "global vwap for bal_usd",
"templateName": "BAL/USD",
"parameters": "0x3162626262620000000000000000000000000000000000000000000000000000706169720000000000000000000000000000000000000000000000000000000062616c5f757364000000000000000000000000000000000000000000000000005f706174680000000000000000000000000000000000000000000000000000007061796c6f61642e767761702c000000000000000000000000000000000000005f74797065000000000000000000000000000000000000000000000000000000696e743235362c74696d657374616d70000000000000000000000000000000005f74696d65730000000000000000000000000000000000000000000000000000313030303030302c0000000000000000000000000000000000000000000000006c6f6f6b6261636b506572696f640000000000000000000000000000000000003500000000000000000000000000000000000000000000000000000000000000",
"decodedParameters": [
{
Expand Down Expand Up @@ -55,5 +55,6 @@
"apiProviderAirkeeperDeviationPercentage": 0.5,
"apiProviderAirkeeperSponsor": "0x58c210AC77bf7075598D497b18778b7c6687C59f"
}
]
],
"description": "Price of BAL in USD"
}
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"templateId": "0x3f9aa8fb88335e7deb5ac57de6158e89b96fed949fca56f9fcfb1f6b65bfa08c",
"templateName": "global vwap for bat_usd",
"templateName": "BAT/USD",
"parameters": "0x316262626262000000000000000000000000000000000000000000000000000070616972000000000000000000000000000000000000000000000000000000006261745f757364000000000000000000000000000000000000000000000000005f706174680000000000000000000000000000000000000000000000000000007061796c6f61642e767761702c000000000000000000000000000000000000005f74797065000000000000000000000000000000000000000000000000000000696e743235362c74696d657374616d70000000000000000000000000000000005f74696d65730000000000000000000000000000000000000000000000000000313030303030302c0000000000000000000000000000000000000000000000006c6f6f6b6261636b506572696f640000000000000000000000000000000000003500000000000000000000000000000000000000000000000000000000000000",
"decodedParameters": [
{
Expand Down Expand Up @@ -55,5 +55,6 @@
"apiProviderAirkeeperDeviationPercentage": 0.5,
"apiProviderAirkeeperSponsor": "0x58c210AC77bf7075598D497b18778b7c6687C59f"
}
]
],
"description": "Price of BAT in USD"
}
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"templateId": "0x5159c2c6e3b9584eb673fa9054bdbf8e74d0b6a9abe3c237556b631203c72be6",
"templateName": "global vwap for btc_usd",
"templateName": "BTC/USD",
"parameters": "0x316262626262000000000000000000000000000000000000000000000000000070616972000000000000000000000000000000000000000000000000000000006274635f757364000000000000000000000000000000000000000000000000005f706174680000000000000000000000000000000000000000000000000000007061796c6f61642e767761702c000000000000000000000000000000000000005f74797065000000000000000000000000000000000000000000000000000000696e743235362c74696d657374616d70000000000000000000000000000000005f74696d65730000000000000000000000000000000000000000000000000000313030303030302c0000000000000000000000000000000000000000000000006c6f6f6b6261636b506572696f640000000000000000000000000000000000003500000000000000000000000000000000000000000000000000000000000000",
"decodedParameters": [
{
Expand Down Expand Up @@ -55,5 +55,6 @@
"apiProviderAirkeeperDeviationPercentage": 0.25,
"apiProviderAirkeeperSponsor": "0x58c210AC77bf7075598D497b18778b7c6687C59f"
}
]
],
"description": "Price of BTC in USD"
}
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"templateId": "0xda1146bcb4ac9a3f7451f5f52d29a2a1f607004b5214e9b859427b4cddd81689",
"templateName": "global vwap for comp_usd",
"templateName": "COMP/USD",
"parameters": "0x31626262626200000000000000000000000000000000000000000000000000007061697200000000000000000000000000000000000000000000000000000000636f6d705f7573640000000000000000000000000000000000000000000000005f706174680000000000000000000000000000000000000000000000000000007061796c6f61642e767761702c000000000000000000000000000000000000005f74797065000000000000000000000000000000000000000000000000000000696e743235362c74696d657374616d70000000000000000000000000000000005f74696d65730000000000000000000000000000000000000000000000000000313030303030302c0000000000000000000000000000000000000000000000006c6f6f6b6261636b506572696f640000000000000000000000000000000000003500000000000000000000000000000000000000000000000000000000000000",
"decodedParameters": [
{
Expand Down Expand Up @@ -55,5 +55,6 @@
"apiProviderAirkeeperDeviationPercentage": 0.5,
"apiProviderAirkeeperSponsor": "0x58c210AC77bf7075598D497b18778b7c6687C59f"
}
]
],
"description": "Price of COMP in USD"
}
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"templateId": "0x86012c43d9aceabd9a010ab3eb9b80e6ac371e4056b3f6500b35ef68b3da1dc2",
"templateName": "global vwap for dai_usd",
"templateName": "DAI/USD",
"parameters": "0x316262626262000000000000000000000000000000000000000000000000000070616972000000000000000000000000000000000000000000000000000000006461695f757364000000000000000000000000000000000000000000000000005f706174680000000000000000000000000000000000000000000000000000007061796c6f61642e767761702c000000000000000000000000000000000000005f74797065000000000000000000000000000000000000000000000000000000696e743235362c74696d657374616d70000000000000000000000000000000005f74696d65730000000000000000000000000000000000000000000000000000313030303030302c0000000000000000000000000000000000000000000000006c6f6f6b6261636b506572696f640000000000000000000000000000000000003500000000000000000000000000000000000000000000000000000000000000",
"decodedParameters": [
{
Expand Down Expand Up @@ -55,5 +55,6 @@
"apiProviderAirkeeperDeviationPercentage": 0.1,
"apiProviderAirkeeperSponsor": "0x58c210AC77bf7075598D497b18778b7c6687C59f"
}
]
],
"description": "Price of DAI in USD"
}
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"templateId": "0xc047a4eba9bcc27a196b987c43ba91853bf7e24b073a071138f423c8fe72d619",
"templateName": "global vwap for eth_btc",
"templateName": "ETH/BTC",
"parameters": "0x316262626262000000000000000000000000000000000000000000000000000070616972000000000000000000000000000000000000000000000000000000006574685f627463000000000000000000000000000000000000000000000000005f706174680000000000000000000000000000000000000000000000000000007061796c6f61642e767761702c000000000000000000000000000000000000005f74797065000000000000000000000000000000000000000000000000000000696e743235362c74696d657374616d70000000000000000000000000000000005f74696d65730000000000000000000000000000000000000000000000000000313030303030302c0000000000000000000000000000000000000000000000006c6f6f6b6261636b506572696f640000000000000000000000000000000000003500000000000000000000000000000000000000000000000000000000000000",
"decodedParameters": [
{
Expand Down Expand Up @@ -55,5 +55,6 @@
"apiProviderAirkeeperDeviationPercentage": 0.25,
"apiProviderAirkeeperSponsor": "0x58c210AC77bf7075598D497b18778b7c6687C59f"
}
]
],
"description": "Price of ETH in BTC"
}
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"templateId": "0xd218d6d5f630faa290676bebe58c88f68a9dccbfece4a3028cf4a5539f397459",
"templateName": "global vwap for eth_usd",
"templateName": "ETH/USD",
"parameters": "0x316262626262000000000000000000000000000000000000000000000000000070616972000000000000000000000000000000000000000000000000000000006574685f757364000000000000000000000000000000000000000000000000005f706174680000000000000000000000000000000000000000000000000000007061796c6f61642e767761702c000000000000000000000000000000000000005f74797065000000000000000000000000000000000000000000000000000000696e743235362c74696d657374616d70000000000000000000000000000000005f74696d65730000000000000000000000000000000000000000000000000000313030303030302c0000000000000000000000000000000000000000000000006c6f6f6b6261636b506572696f640000000000000000000000000000000000003500000000000000000000000000000000000000000000000000000000000000",
"decodedParameters": [
{
Expand Down Expand Up @@ -55,5 +55,6 @@
"apiProviderAirkeeperDeviationPercentage": 0.25,
"apiProviderAirkeeperSponsor": "0x58c210AC77bf7075598D497b18778b7c6687C59f"
}
]
],
"description": "Price of ETH in USD"
}
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"templateId": "0x2ec4a6323e521ec60284b211c2a1348eedb0f2bfbd59c562f0e585226bd0aaf9",
"templateName": "gas prediction for fast gas price",
"templateName": "Fast Gas on Ethereum Mainnet",
"parameters": "0x31626200000000000000000000000000000000000000000000000000000000005f706174680000000000000000000000000000000000000000000000000000007061796c6f61642e666173742e67617350726963652c000000000000000000005f74797065000000000000000000000000000000000000000000000000000000696e743235362c74696d657374616d7000000000000000000000000000000000",
"decodedParameters": [
{
Expand Down Expand Up @@ -40,5 +40,6 @@
"apiProviderAirkeeperDeviationPercentage": 5,
"apiProviderAirkeeperSponsor": "0x58c210AC77bf7075598D497b18778b7c6687C59f"
}
]
],
"description": "Gas prediction for fast gas on Ethereum Mainnet"
}
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"templateId": "0x930141b7fe75bba0c3fbfa5e0b1b006391cad76bea10562e434ca81b70876ba3",
"templateName": "global vwap for knc_usd",
"templateName": "KNC/USD",
"parameters": "0x316262626262000000000000000000000000000000000000000000000000000070616972000000000000000000000000000000000000000000000000000000006b6e635f757364000000000000000000000000000000000000000000000000005f706174680000000000000000000000000000000000000000000000000000007061796c6f61642e767761702c000000000000000000000000000000000000005f74797065000000000000000000000000000000000000000000000000000000696e743235362c74696d657374616d70000000000000000000000000000000005f74696d65730000000000000000000000000000000000000000000000000000313030303030302c0000000000000000000000000000000000000000000000006c6f6f6b6261636b506572696f640000000000000000000000000000000000003500000000000000000000000000000000000000000000000000000000000000",
"decodedParameters": [
{
Expand Down Expand Up @@ -55,5 +55,6 @@
"apiProviderAirkeeperDeviationPercentage": 0.5,
"apiProviderAirkeeperSponsor": "0x58c210AC77bf7075598D497b18778b7c6687C59f"
}
]
],
"description": "Price of KNC in USD"
}
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"templateId": "0x8473a4c5a894bf4724c4d7f7d06ed30019db0058941e5e87b9177514d2fa7308",
"templateName": "global vwap for lrc_usd",
"templateName": "LRC/USD",
"parameters": "0x316262626262000000000000000000000000000000000000000000000000000070616972000000000000000000000000000000000000000000000000000000006c72635f757364000000000000000000000000000000000000000000000000005f706174680000000000000000000000000000000000000000000000000000007061796c6f61642e767761702c000000000000000000000000000000000000005f74797065000000000000000000000000000000000000000000000000000000696e743235362c74696d657374616d70000000000000000000000000000000005f74696d65730000000000000000000000000000000000000000000000000000313030303030302c0000000000000000000000000000000000000000000000006c6f6f6b6261636b506572696f640000000000000000000000000000000000003500000000000000000000000000000000000000000000000000000000000000",
"decodedParameters": [
{
Expand Down Expand Up @@ -55,5 +55,6 @@
"apiProviderAirkeeperDeviationPercentage": 0.5,
"apiProviderAirkeeperSponsor": "0x58c210AC77bf7075598D497b18778b7c6687C59f"
}
]
],
"description": "Price of LRC in USD"
}
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"templateId": "0x5e5fb4b0b75160f1fe08b46e9703fb5cdac50498755cd89b23a4944c18448db0",
"templateName": "global vwap for mana_usd",
"templateName": "MANA/USD",
"parameters": "0x316262626262000000000000000000000000000000000000000000000000000070616972000000000000000000000000000000000000000000000000000000006d616e615f7573640000000000000000000000000000000000000000000000005f706174680000000000000000000000000000000000000000000000000000007061796c6f61642e767761702c000000000000000000000000000000000000005f74797065000000000000000000000000000000000000000000000000000000696e743235362c74696d657374616d70000000000000000000000000000000005f74696d65730000000000000000000000000000000000000000000000000000313030303030302c0000000000000000000000000000000000000000000000006c6f6f6b6261636b506572696f640000000000000000000000000000000000003500000000000000000000000000000000000000000000000000000000000000",
"decodedParameters": [
{
Expand Down Expand Up @@ -55,5 +55,6 @@
"apiProviderAirkeeperDeviationPercentage": 0.5,
"apiProviderAirkeeperSponsor": "0x58c210AC77bf7075598D497b18778b7c6687C59f"
}
]
],
"description": "Price of MANA in USD"
}
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"templateId": "0xb43779b94ff444678da1f32a9076f1dc0d655b6a05377cdf9617a767b41a273a",
"templateName": "global vwap for matic_usd",
"templateName": "MATIC/USD",
"parameters": "0x316262626262000000000000000000000000000000000000000000000000000070616972000000000000000000000000000000000000000000000000000000006d617469635f75736400000000000000000000000000000000000000000000005f706174680000000000000000000000000000000000000000000000000000007061796c6f61642e767761702c000000000000000000000000000000000000005f74797065000000000000000000000000000000000000000000000000000000696e743235362c74696d657374616d70000000000000000000000000000000005f74696d65730000000000000000000000000000000000000000000000000000313030303030302c0000000000000000000000000000000000000000000000006c6f6f6b6261636b506572696f640000000000000000000000000000000000003500000000000000000000000000000000000000000000000000000000000000",
"decodedParameters": [
{
Expand Down Expand Up @@ -55,5 +55,6 @@
"apiProviderAirkeeperDeviationPercentage": 0.5,
"apiProviderAirkeeperSponsor": "0x58c210AC77bf7075598D497b18778b7c6687C59f"
}
]
],
"description": "Price of MATIC in USD"
}
Loading

0 comments on commit 29e04eb

Please sign in to comment.