You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/tools/oracles/api3.md
+23-22Lines changed: 23 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,9 +6,9 @@
6
6
7
7
[API3](https://api3.org/) is a collaborative project to deliver traditional API services to smart contract platforms in a decentralized and trust-minimized way. It is governed by a decentralized autonomous organization (DAO), namely the [API3 DAO](https://api3.org/dao).
8
8
9
-
:::info The API3 DAO
10
-
Read more about how The API3 DAO works. [Click here](https://docs.api3.org/explore/dao-members/)
11
-
:::
9
+
!!! info "The API3 DAO"
10
+
Read more about how The API3 DAO works. [Click here](https://docs.api3.org/explore/dao-members/)
11
+
12
12
13
13
## Airnode
14
14
@@ -17,7 +17,8 @@ Developers can use [Airnode](https://docs.api3.org/explore/airnode/what-is-airno
17
17
An on-chain smart contract makes a request in the [RRP (Request Response Protocol)](https://docs.api3.org/reference/airnode/latest/concepts/) contract (`AirnodeRrpV0.sol`) that adds the request to the event logs. The Airnode then accesses the event logs, fetches the API data and performs a callback to the requester with the requested data.
**Here is an example of a basic requester contract to request data from an Airnode:**
35
37
@@ -96,9 +98,9 @@ contract Requester is RrpRequesterV0, Ownable {
96
98
97
99
The `_rrpAddress` is the main `airnodeRrpAddress`. The RRP Contracts have already been deployed on-chain. You can check the address for all supported chains [here](https://docs.api3.org/reference/airnode/latest/). You can also try [deploying it using Remix](https://remix.ethereum.org/#url=https://github.com/api3-ecosystem/remix-contracts/blob/master/contracts/RequesterWithWithdrawal.sol&optimize=false&runs=200&evmVersion=null&version=soljson-v0.8.9+commit.e5eed63a.js)
@@ -117,9 +119,9 @@ The callback to the Requester contains two parameters:
117
119
-[**`requestId`**](https://docs.api3.org/reference/airnode/latest/concepts/request.html#requestid): First acquired when making the request and passed here as a reference to identify the request for which the response is intended.
118
120
-**`data`**: In case of a successful response, this is the requested data which has been encoded and contains a timestamp in addition to other response data. Decode it using the `decode()` function from the `abi` object.
119
121
120
-
:::info Note !
121
-
Sponsors should not fund a `sponsorWallet` with more then they can trust the Airnode with, as the Airnode controls the private key to the `sponsorWallet`. The deployer of such Airnode undertakes no custody obligations, and the risk of loss or misuse of any excess funds sent to the `sponsorWallet` remains with the sponsor.
122
-
:::
122
+
!!! info "Note"
123
+
Sponsors should not fund a `sponsorWallet` with more then they can trust the Airnode with, as the Airnode controls the private key to the `sponsorWallet`. The deployer of such Airnode undertakes no custody obligations, and the risk of loss or misuse of any excess funds sent to the `sponsorWallet` remains with the sponsor.
124
+
123
125
124
126
[Try deploying it on Remix!](https://remix.ethereum.org/#url=https://github.com/api3-ecosystem/remix-contracts/blob/master/contracts/RequesterWithWithdrawal.sol&optimize=false&runs=200&evmVersion=null&version=soljson-v0.8.9+commit.e5eed63a.js)
125
127
@@ -136,7 +138,7 @@ Apart from relying on deviation threshold and heartbeat configuration updates, u
136
138
137
139
The [API3 Market](https://market.api3.org/polygon) enables users to connect to a dAPI and access the associated data feed services.
If a dAPI is already activated, make sure to check the expiration date and update parameters. You can update the parameters and extend the subscription by purchasing a new configuration.
168
-
:::
166
+
!!! note "Note"
167
+
If a dAPI is already activated, make sure to check the expiration date and update parameters. You can update the parameters and extend the subscription by purchasing a new configuration.
169
168
170
169
After selecting the dAPI and the configuration, you will be presented with an option to purchase the dAPI and activate it. Make sure to check the time and amount of the subscription. If everything looks good, click on Purchase.
0 commit comments