Skip to content

Commit b38015c

Browse files
Release 1.286.0 (packages/sources/ncfx)
1 parent bd6225b commit b38015c

File tree

3 files changed

+52
-14
lines changed

3 files changed

+52
-14
lines changed

packages/sources/ncfx/CHANGELOG.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
# @chainlink/ncfx-adapter
22

3+
## 4.6.0
4+
5+
### Minor Changes
6+
7+
- [#4635](https://github.com/smartcontractkit/external-adapters-js/pull/4635) [`d431d86`](https://github.com/smartcontractkit/external-adapters-js/commit/d431d867d6ee5753cf4d470ef71574ad4d75f060) Thanks [@mohamed-mehany](https://github.com/mohamed-mehany)! - Add forex-continuous endpoint for 24/7 forex prices
8+
9+
### Patch Changes
10+
11+
- [#4634](https://github.com/smartcontractkit/external-adapters-js/pull/4634) [`f80dea0`](https://github.com/smartcontractkit/external-adapters-js/commit/f80dea060606c6e3b711b205e2cdaab7463dd127) Thanks [@mohamed-mehany](https://github.com/mohamed-mehany)! - Refactor shared WebSocket utilities to utils
12+
313
## 4.5.4
414

515
### Patch Changes

packages/sources/ncfx/README.md

Lines changed: 41 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,21 @@
11
# NCFX
22

3-
![4.5.4](https://img.shields.io/github/package-json/v/smartcontractkit/external-adapters-js?filename=packages/sources/ncfx/package.json) ![v3](https://img.shields.io/badge/framework%20version-v3-blueviolet)
3+
![4.6.0](https://img.shields.io/github/package-json/v/smartcontractkit/external-adapters-js?filename=packages/sources/ncfx/package.json) ![v3](https://img.shields.io/badge/framework%20version-v3-blueviolet)
44

55
This document was generated automatically. Please see [README Generator](../../scripts#readme-generator) for more info.
66

77
## Environment Variables
88

9-
| Required? | Name | Description | Type | Options | Default |
10-
| :-------: | :---------------------------: | :-------------------------------------------------------: | :----: | :-----: | :--------------------------------------------------------------: |
11-
| | API_USERNAME | Username for the NCFX Crypto API | string | | |
12-
| | API_PASSWORD | Password for the NCFX Crypto API | string | | |
13-
| | FOREX_WS_API_KEY | API key for Forex websocket endpoint | string | | |
14-
| | WS_API_ENDPOINT | The WS API endpoint to use for the crypto endpoint | string | | `wss://cryptofeed.ws.newchangefx.com` |
15-
| | FOREX_WS_API_ENDPOINT | The WS API endpoint to use for the forex endpoint | string | | `wss://fiat.ws.newchangefx.com/sub/fiat/ws/ref` |
16-
| | MARKET_STATUS_WS_API_ENDPOINT | The WS API endpoint to use for the market status endpoint | string | | `wss://fiat.ws.newchangefx.com/general/reference/v1/markethours` |
17-
| | MARKET_STATUS_WS_API_KEY | The WS API key to use for the market status endpoint | string | | |
9+
| Required? | Name | Description | Type | Options | Default |
10+
| :-------: | :------------------------------: | :-----------------------------------------------------------------: | :----: | :-----: | :--------------------------------------------------------------: |
11+
| | API_USERNAME | Username for the NCFX Crypto API | string | | |
12+
| | API_PASSWORD | Password for the NCFX Crypto API | string | | |
13+
| | FOREX_WS_API_KEY | API key for Forex websocket endpoint | string | | |
14+
| | WS_API_ENDPOINT | The WS API endpoint to use for the crypto endpoint | string | | `wss://cryptofeed.ws.newchangefx.com` |
15+
| | FOREX_WS_API_ENDPOINT | The WS API endpoint to use for the forex endpoint | string | | `wss://fiat.ws.newchangefx.com/sub/fiat/ws/ref` |
16+
| | MARKET_STATUS_WS_API_ENDPOINT | The WS API endpoint to use for the market status endpoint | string | | `wss://fiat.ws.newchangefx.com/general/reference/v1/markethours` |
17+
| | MARKET_STATUS_WS_API_KEY | The WS API key to use for the market status endpoint | string | | |
18+
| | FOREX_CONTINUOUS_WS_API_ENDPOINT | The WS API endpoint to use for the forex-continuous (24/7) endpoint | string | | `wss://cryptofeed.ws.newchangefx.com/fiat_v1` |
1819

1920
---
2021

@@ -26,9 +27,9 @@ There are no rate limits for this adapter.
2627

2728
## Input Parameters
2829

29-
| Required? | Name | Description | Type | Options | Default |
30-
| :-------: | :------: | :-----------------: | :----: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :------: |
31-
| | endpoint | The endpoint to use | string | [crypto-lwba](#crypto-lwba-endpoint), [crypto](#crypto-endpoint), [crypto_lwba](#crypto-lwba-endpoint), [cryptolwba](#crypto-lwba-endpoint), [forex-market-status](#market-status-endpoint), [forex](#forex-endpoint), [market-status](#market-status-endpoint), [metals-market-status](#market-status-endpoint), [price](#crypto-endpoint) | `crypto` |
30+
| Required? | Name | Description | Type | Options | Default |
31+
| :-------: | :------: | :-----------------: | :----: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :------: |
32+
| | endpoint | The endpoint to use | string | [crypto-lwba](#crypto-lwba-endpoint), [crypto](#crypto-endpoint), [crypto_lwba](#crypto-lwba-endpoint), [cryptolwba](#crypto-lwba-endpoint), [forex-continuous](#forex-continuous-endpoint), [forex-market-status](#market-status-endpoint), [forex](#forex-endpoint), [market-status](#market-status-endpoint), [metals-market-status](#market-status-endpoint), [price](#crypto-endpoint) | `crypto` |
3233

3334
## Crypto Endpoint
3435

@@ -84,6 +85,33 @@ Request:
8485

8586
---
8687

88+
## Forex-continuous Endpoint
89+
90+
`forex-continuous` is the only supported name for this endpoint.
91+
92+
### Input Params
93+
94+
| Required? | Name | Aliases | Description | Type | Options | Default | Depends On | Not Valid With |
95+
| :-------: | :---: | :------------: | :--------------------------------------------: | :----: | :-----: | :-----: | :--------: | :------------: |
96+
|| base | `coin`, `from` | The symbol of symbols of the currency to query | string | | | | |
97+
|| quote | `market`, `to` | The symbol of the currency to convert to | string | | | | |
98+
99+
### Example
100+
101+
Request:
102+
103+
```json
104+
{
105+
"data": {
106+
"endpoint": "forex-continuous",
107+
"base": "ARS",
108+
"quote": "USD"
109+
}
110+
}
111+
```
112+
113+
---
114+
87115
## Crypto-lwba Endpoint
88116

89117
Supported names for this endpoint are: `crypto-lwba`, `crypto_lwba`, `cryptolwba`.

packages/sources/ncfx/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@chainlink/ncfx-adapter",
3-
"version": "4.5.4",
3+
"version": "4.6.0",
44
"description": "Chainlink NCFX adapter.",
55
"keywords": [
66
"Chainlink",

0 commit comments

Comments
 (0)