-
Notifications
You must be signed in to change notification settings - Fork 300
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
added documentation for smaller adapters used in composites
- Loading branch information
Showing
5 changed files
with
141 additions
and
74 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,20 +1,35 @@ | ||
| # Chainlink External Adapter for Deribit | ||
|
|
||
| ## Input Params | ||
| ### Input Params | ||
|
|
||
| - `base`, `from`, or `coin`: The symbol of the currency to query | ||
| <!-- - `base`, `from`, or `coin`: The symbol of the currency to query | ||
| - `quote`, `to`, or `market`: The symbol of the currency to convert to | ||
| - `endpoint`: Optional endpoint param | ||
| - `endpoint`: Optional endpoint param --> | ||
|
|
||
| ## Output | ||
| | Required? | Name | Description | Options | Defaults to | | ||
| | :-------: | :-----------------------: | :---------------------------------: | :-----: | :---------: | | ||
| | ✅ | `base`, `from`, or `coin` | The symbol of the currency to query | | | | ||
|
|
||
| ### Sample Input | ||
|
|
||
| ```json | ||
| { | ||
| "id": "1", | ||
| "data": { | ||
| "base": "ETH" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ## Sample Output | ||
|
|
||
| ```json | ||
| { | ||
| "jobRunID": "278c97ffadb54a5bbb93cfec5f7b5503", | ||
| "data": { | ||
| "price": 77777.77, | ||
| "result": 77777.77 | ||
| }, | ||
| "statusCode": 200 | ||
| "jobRunID": "1", | ||
| "result": 66.5046281503906, | ||
| "statusCode": 200, | ||
| "data": { | ||
| "result": 66.5046281503906 | ||
| } | ||
| } | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,31 +1,48 @@ | ||
| # Chainlink External Adapter for Genesis Volatility | ||
|
|
||
| ## Input Params | ||
| ### Input Params | ||
|
|
||
| - `base`, `from`, `coin` or `symbol`: The symbol of the currency to query | ||
| - `key`, `result`, or `period`: The key to get the result from | ||
|
|
||
| ## Output | ||
| | Required? | Name | Description | Options | Defaults to | | ||
| | :-------: | :---------------------------------: | :---------------------------------: | :-----: | :---------: | | ||
| | ✅ | `base`, `from`, `coin`, or `symbol` | The symbol of the currency to query | | | | ||
| | ✅ | `key`, `result`, or `period` | The key to get the result from | | | | ||
|
|
||
| ### Sample Input | ||
|
|
||
| ```json | ||
| { | ||
| "id": "1", | ||
| "data": { | ||
| "symbol": "ETH", | ||
| "result": "oneDayIv" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### Sample Output | ||
|
|
||
| ```json | ||
| { | ||
| "jobRunID":"1", | ||
| "data":{ | ||
| "data":{ | ||
| "ChainlinkIv":[ | ||
| { | ||
| "oneDayIv":65.07, | ||
| "twoDayIv":69.29, | ||
| "sevenDayIv":70.53, | ||
| "fourteenDayIv":73.1, | ||
| "twentyOneDayIv":74.93, | ||
| "twentyEightDayIv":76.32 | ||
| } | ||
| ] | ||
| }, | ||
| "result":76.32 | ||
| }, | ||
| "result":76.32, | ||
| "statusCode":200 | ||
| "jobRunID": "1", | ||
| "data": { | ||
| "data": { | ||
| "ChainlinkIv": [ | ||
| { | ||
| "oneDayIv": 65.07, | ||
| "twoDayIv": 69.29, | ||
| "sevenDayIv": 70.53, | ||
| "fourteenDayIv": 73.1, | ||
| "twentyOneDayIv": 74.93, | ||
| "twentyEightDayIv": 76.32 | ||
| } | ||
| ] | ||
| }, | ||
| "result": 76.32 | ||
| }, | ||
| "result": 76.32, | ||
| "statusCode": 200 | ||
| } | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,28 +1,41 @@ | ||
| # Chainlink OilpriceAPI External Adapter | ||
|
|
||
| ## Input Params | ||
| - `type`, `base`, `asset`, `from`: The type of oil to get the price from (required) | ||
| - `endpoint`: The endpoint to use (optional) | ||
| ### Input Params | ||
|
|
||
| | Required? | Name | Description | Options | Defaults to | | ||
| | :-------: | :--------------------------------: | :-----------------------------------: | :------------------: | :-------------: | | ||
| | ✅ | `type`, `base`, `asset`, of `from` | The type of oil to get the price from | `bz`, `brent`, `wti` | | | ||
| | | `endpoint` | The endpoint to use | | `prices/latest` | | ||
|
|
||
| ## Output | ||
| ### Sample Input | ||
|
|
||
| ```json | ||
| { | ||
| "jobRunID":"278c97ffadb54a5bbb93cfec5f7b5503", | ||
| "data":{ | ||
| "status":"success", | ||
| "data":{ | ||
| "price":26.71, | ||
| "formatted":"$26.71", | ||
| "currency":"USD", | ||
| "code":"BRENT_CRUDE_USD", | ||
| "created_at":"2020-03-25T14:10:00.424Z", | ||
| "type":"spot_price" | ||
| }, | ||
| "result":26.71 | ||
| }, | ||
| "result":26.71, | ||
| "statusCode":200 | ||
| "id": 1, | ||
| "data": { | ||
| "base": "BZ" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### Sample Output | ||
|
|
||
| ```json | ||
| { | ||
| "jobRunID": "278c97ffadb54a5bbb93cfec5f7b5503", | ||
| "data": { | ||
| "status": "success", | ||
| "data": { | ||
| "price": 26.71, | ||
| "formatted": "$26.71", | ||
| "currency": "USD", | ||
| "code": "BRENT_CRUDE_USD", | ||
| "created_at": "2020-03-25T14:10:00.424Z", | ||
| "type": "spot_price" | ||
| }, | ||
| "result": 26.71 | ||
| }, | ||
| "result": 26.71, | ||
| "statusCode": 200 | ||
| } | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,32 +1,43 @@ | ||
| # Chainlink External Adapter for XBTO | ||
|
|
||
| ## Input Params | ||
| ### Input Params | ||
|
|
||
| _None_ | ||
| | Required? | Name | Description | Options | Defaults to | | ||
| | :-------: | :------: | :---------: | :------------: | :---------: | | ||
| | | `market` | | `brent`, `wti` | `brent` | | ||
|
|
||
| ## Output | ||
| ### Sample Input | ||
|
|
||
| ```json | ||
| { | ||
| "jobRunID":"1", | ||
| "data":{ | ||
| "index":40.12795, | ||
| "duration":35.71406, | ||
| "1st_sym":"BRNF1", | ||
| "1st_dte":27.13591, | ||
| "1st_mid":40.005, | ||
| "1st_wt":0.7140615, | ||
| "2nd_sym":"BRNG1", | ||
| "2nd_dte":57.13591, | ||
| "2nd_mid":40.435, | ||
| "2nd_wt":0.2859385, | ||
| "3rd_sym":"BRNH1", | ||
| "3rd_dte":87.13591, | ||
| "3rd_mid":40.865, | ||
| "3rd_wt":0, | ||
| "result":40.12795 | ||
| }, | ||
| "result":40.12795, | ||
| "statusCode":200 | ||
| "id": "1", | ||
| "data": {} | ||
| } | ||
| ``` | ||
|
|
||
| ### Sample Output | ||
|
|
||
| ```json | ||
| { | ||
| "jobRunID": "1", | ||
| "data": { | ||
| "index": 40.12795, | ||
| "duration": 35.71406, | ||
| "1st_sym": "BRNF1", | ||
| "1st_dte": 27.13591, | ||
| "1st_mid": 40.005, | ||
| "1st_wt": 0.7140615, | ||
| "2nd_sym": "BRNG1", | ||
| "2nd_dte": 57.13591, | ||
| "2nd_mid": 40.435, | ||
| "2nd_wt": 0.2859385, | ||
| "3rd_sym": "BRNH1", | ||
| "3rd_dte": 87.13591, | ||
| "3rd_mid": 40.865, | ||
| "3rd_wt": 0, | ||
| "result": 40.12795 | ||
| }, | ||
| "result": 40.12795, | ||
| "statusCode": 200 | ||
| } | ||
| ``` |