-
Notifications
You must be signed in to change notification settings - Fork 308
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updated readmeBlacklist.json (#3151)
* update readmeBlacklist * changeset --------- Co-authored-by: cl-ea <93770670+cl-ea@users.noreply.github.com>
- Loading branch information
1 parent
9c66de0
commit ac9ebd6
Showing
18 changed files
with
636 additions
and
532 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 |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| --- | ||
| '@chainlink/renvm-address-set-adapter': patch | ||
| '@chainlink/coingecko-adapter': patch | ||
| '@chainlink/enzyme-adapter': patch | ||
| '@chainlink/fcsapi-adapter': patch | ||
| '@chainlink/lcx-adapter': patch | ||
| --- | ||
|
|
||
| Updated Readme file |
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 |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| --- | ||
| '@chainlink/cfbenchmarks-adapter': patch | ||
| '@chainlink/dns-query-adapter': patch | ||
| '@chainlink/gramchain-adapter': patch | ||
| '@chainlink/lotus-adapter': patch | ||
| --- | ||
|
|
||
| Added missing information for readme generation |
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,115 +1,114 @@ | ||
| # Chainlink External Adapter for cfbenchmarks | ||
| # CFBENCHMARKS | ||
|
|
||
| ### Environment variables | ||
|   | ||
|
|
||
| | Required? | Name | Description | Options | Defaults to | | ||
| | :-------: | :-------------: | :------------------------------------------: | :----------: | :---------: | | ||
| | ✅ | `API_USERNAME` | | | | | ||
| | ✅ | `API_PASSWORD` | | | | | ||
| | | `API_SECONDARY` | Use the secondary endpoint from cfbenchmarks | true / false | false | | ||
| This document was generated automatically. Please see [README Generator](../../scripts#readme-generator) for more info. | ||
|
|
||
| ## Environment Variables | ||
|
|
||
| | Required? | Name | Description | Type | Options | Default | | ||
| | :-------: | :-----------------------: | :----------------------------------------------------------------------: | :-----: | :-----: | :--------------------------------------: | | ||
| | ✅ | API_USERNAME | Username for the CFBenchmarks API | string | | | | ||
| | ✅ | API_PASSWORD | Password for the CFBenchmarks API | string | | | | ||
| | | API_ENDPOINT | The default REST API base url | string | | `https://www.cfbenchmarks.com/api` | | ||
| | | WS_API_ENDPOINT | The default WebSocket API base url | string | | `wss://www.cfbenchmarks.com/ws/v4` | | ||
| | | API_SECONDARY | Toggle using the secondary API base URLs | boolean | | `false` | | ||
| | | SECONDARY_API_ENDPOINT | The secondary REST API base url that is toggled using API_SECONDARY | string | | `https://unregprod.cfbenchmarks.com/api` | | ||
| | | SECONDARY_WS_API_ENDPOINT | The secondary WebSocket API base url that is toggled using API_SECONDARY | string | | `wss://unregprod.cfbenchmarks.com/ws/v4` | | ||
|
|
||
| --- | ||
|
|
||
| ### Input Parameters | ||
| ## Data Provider Rate Limits | ||
|
|
||
| | Required? | Name | Description | Options | Defaults to | | ||
| | :-------: | :------: | :-----------------: | :------------------------------------------------: | :---------: | | ||
| | | endpoint | The endpoint to use | [values](#Values-Endpoint), [BIRC](#birc-endpoint) | `values` | | ||
| There are no rate limits for this adapter. | ||
|
|
||
| --- | ||
|
|
||
| ## Values Endpoint | ||
| ## Input Parameters | ||
|
|
||
| ### Input Params | ||
| | Required? | Name | Description | Type | Options | Default | | ||
| | :-------: | :------: | :-----------------: | :----: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :------: | | ||
| | | endpoint | The endpoint to use | string | [birc](#birc-endpoint), [crypto-lwba](#crypto-lwba-endpoint), [crypto](#crypto-endpoint), [crypto_lwba](#crypto-lwba-endpoint), [cryptolwba](#crypto-lwba-endpoint), [price](#crypto-endpoint), [values](#crypto-endpoint) | `crypto` | | ||
|
|
||
| | Required? | Name | Description | Options | Defaults to | | ||
| | :-------: | :-----: | :--------------------------------------------------------------------------------------------: | :-----: | :---------: | | ||
| | | `index` | The ID of the index | | | | ||
| | | `base` | The base asset to convert from (if index is not present), aliased to `from` and `coin` | | | | ||
| | | `quote` | The quote asset to convert to (if index is not present), aliased to `to`, `market`, and `term` | | | | ||
| ## Crypto Endpoint | ||
|
|
||
| ### Sample Input | ||
| Supported names for this endpoint are: `crypto`, `price`, `values`. | ||
|
|
||
| ```json | ||
| { | ||
| "id": "1", | ||
| "data": { | ||
| "index": "BRR" | ||
| } | ||
| } | ||
| ``` | ||
| ### Input Params | ||
|
|
||
| ### Sample Output | ||
| | Required? | Name | Aliases | Description | Type | Options | Default | Depends On | Not Valid With | | ||
| | :-------: | :---: | :------------: | :----------------------------------------------------------------: | :----: | :-----: | :-----: | :--------: | :------------: | | ||
| | | index | | The ID of the index. Takes priority over base/quote when provided. | string | | | | | | ||
| | | base | `coin`, `from` | The symbol of symbols of the currency to query | string | | | | | | ||
| | | quote | `market`, `to` | The symbol of the currency to convert to | string | | | | | | ||
|
|
||
| ```json | ||
| { | ||
| "jobRunID": "1", | ||
| "data": { | ||
| "result": 30363.12 | ||
| }, | ||
| "result": 30363.12, | ||
| "statusCode": 200 | ||
| } | ||
| ``` | ||
| ### Example | ||
|
|
||
| ### Sample Input | ||
| Request: | ||
|
|
||
| ```json | ||
| { | ||
| "id": "1", | ||
| "data": { | ||
| "base": "ETH", | ||
| "endpoint": "crypto", | ||
| "base": "LINK", | ||
| "quote": "USD" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### Sample Output | ||
| --- | ||
|
|
||
| ```json | ||
| { | ||
| "jobRunID": "1", | ||
| "data": { | ||
| "result": 3000.12 | ||
| }, | ||
| "result": 3000.12, | ||
| "statusCode": 200 | ||
| } | ||
| ``` | ||
| ## Birc Endpoint | ||
|
|
||
| ## BIRC Endpoint | ||
| `birc` is the only supported name for this endpoint. | ||
|
|
||
| ### Input Params | ||
|
|
||
| | Required? | Name | Description | Options | Defaults to | | ||
| | :-------: | :-----: | :-------------------------------------------: | :----------------------------------------------------: | :---------: | | ||
| | | `tenor` | The tenor value to pull from the API response | 'SIRB', '1W', '2W', '3W', '1M', '2M', '3M', '4M', '5M' | | | ||
| | Required? | Name | Aliases | Description | Type | Options | Default | Depends On | Not Valid With | | ||
| | :-------: | :---: | :-----: | :-------------------------------------------: | :----: | :----------------------------------------------------: | :-----: | :--------: | :------------: | | ||
| | ✅ | tenor | | The tenor value to pull from the API response | string | `1M`, `1W`, `2M`, `2W`, `3M`, `3W`, `4M`, `5M`, `SIRB` | | | | | ||
|
|
||
| ### Example | ||
|
|
||
| ### Sample Input | ||
| Request: | ||
|
|
||
| ```json | ||
| { | ||
| "id": "1", | ||
| "data": { | ||
| "endpoint": "birc", | ||
| "tenor": "SIRB" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### Sample Output | ||
| --- | ||
|
|
||
| ## Crypto-lwba Endpoint | ||
|
|
||
| Supported names for this endpoint are: `crypto-lwba`, `crypto_lwba`, `cryptolwba`. | ||
|
|
||
| ### Input Params | ||
|
|
||
| | Required? | Name | Aliases | Description | Type | Options | Default | Depends On | Not Valid With | | ||
| | :-------: | :---: | :------------: | :----------------------------------------------------------------: | :----: | :-----: | :-----: | :--------: | :------------: | | ||
| | | index | | The ID of the index. Takes priority over base/quote when provided. | string | | | | | | ||
| | | base | `coin`, `from` | The symbol of symbols of the currency to query | string | | | | | | ||
| | | quote | `market`, `to` | The symbol of the currency to convert to | string | | | | | | ||
|
|
||
| ### Example | ||
|
|
||
| Request: | ||
|
|
||
| ```json | ||
| { | ||
| "jobRunID": "1", | ||
| "result": 0.0947, | ||
| "providerStatusCode": 200, | ||
| "statusCode": 200, | ||
| "data": { | ||
| "result": 0.0947 | ||
| }, | ||
| "metricsMeta": { | ||
| "feedId": "{\"data\":{\"endpoint\":\"birc\"}}" | ||
| "endpoint": "crypto-lwba", | ||
| "base": "LINK", | ||
| "quote": "USD" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| --- | ||
|
|
||
| MIT License |
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
Oops, something went wrong.