diff --git a/.changeset/unlucky-carpets-design.md b/.changeset/unlucky-carpets-design.md deleted file mode 100644 index 9120885097..0000000000 --- a/.changeset/unlucky-carpets-design.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@chainlink/securitize-adapter': major ---- - -Securitize Initial release diff --git a/.changeset/warm-hornets-compete.md b/.changeset/warm-hornets-compete.md deleted file mode 100644 index bd1ca21dd4..0000000000 --- a/.changeset/warm-hornets-compete.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@chainlink/ftse-sftp-adapter': major ---- - -Adding Downloading and parsing logic for russell and ftse csv files from ftse sftp server diff --git a/MASTERLIST.md b/MASTERLIST.md index ba6a5210bf..080e632d3e 100644 --- a/MASTERLIST.md +++ b/MASTERLIST.md @@ -1,4 +1,4 @@ -## Release 1.194.0 +## Release 1.195.0 This document was generated automatically. Please see [Master List Generator](./packages/scripts#master-list-generator) for more info. @@ -103,7 +103,7 @@ This document was generated automatically. Please see [Master List Generator](./ | [fluent-finance](packages/sources/fluent-finance/README.md) | `2.0.19` | `source` | v2 | `https://gateway.fluent.finance/v1/gateway/` | | | `balances` | `balances` | | [✅](packages/sources/fluent-finance/test/unit) | [✅](packages/sources/fluent-finance/test/integration) | [✅](packages/sources/fluent-finance/test/e2e) | | [fmpcloud](packages/sources/fmpcloud/README.md) | `1.3.45` | `source` | v2 | `https://fmpcloud.io` | | `API_ENDPOINT`, `API_KEY (✅)` | `price`, `quote`, `stock` | `stock` | | [✅](packages/sources/fmpcloud/test/unit) | [✅](packages/sources/fmpcloud/test/integration) | | | [frxeth-exchange-rate](packages/sources/frxeth-exchange-rate/README.md) | `1.1.26` | `source` | v3 | Unknown | `external-adapter-framework` | `BACKGROUND_EXECUTE_MS`, `CHAIN_ID (✅)`, `FRAX_ETH_PRICE_CONTRACT (✅)`, `RPC_URL (✅)` | `crypto` | `crypto` | | | [✅](packages/sources/frxeth-exchange-rate/test/integration) | | -| [ftse-sftp](packages/sources/ftse-sftp/README.md) | `0.2.0` | `source` | v3 | Unknown | `external-adapter-framework` | Unknown | Unknown | Unknown | Unknown | [✅](packages/sources/ftse-sftp/test/unit) | | | +| [ftse-sftp](packages/sources/ftse-sftp/README.md) | `1.0.0` | `source` | v3 | Unknown | `external-adapter-framework` | `BACKGROUND_EXECUTE_MS`, `SFTP_HOST (✅)`, `SFTP_PASSWORD (✅)`, `SFTP_PORT`, `SFTP_READY_TIMEOUT_MS`, `SFTP_USERNAME (✅)` | `sftp` | `sftp` | | [✅](packages/sources/ftse-sftp/test/unit) | [✅](packages/sources/ftse-sftp/test/integration) | | | [galaxis](packages/sources/galaxis/README.md) | `4.0.22` | `source` | v2 | `https://cdn.nba.com/static/json/staticData/NFTNightlyAchievements` | | `API_ENDPOINT (✅)`, `CHAIN_BATCH_WRITE_ADAPTER_ADDRESS`, `EC_REGISTRY_ADDRESS`, `EC_REGISTRY_MAP_ADDRESS (✅)`, `ETHEREUM_CHAIN_ID`, `ETHEREUM_RPC_URL (✅)` | `nba` | `nba` | | | [✅](packages/sources/galaxis/test/integration) | | | [galaxy](packages/sources/galaxy/README.md) | `2.1.50` | `source` | v3 | `https://data.galaxy.com/v1.0/login` | `external-adapter-framework` | `API_ENDPOINT`, `WS_API_ENDPOINT`, `WS_API_KEY (✅)`, `WS_API_PASSWORD (✅)` | `crypto`, `price` | `price` | ✅ | | [✅](packages/sources/galaxy/test/integration) | | | [gemini](packages/sources/gemini/README.md) | `3.0.31` | `source` | v3 | `https://api.gemini.com` | `external-adapter-framework` | `API_ENDPOINT` | `reserves` | `reserves` | | | [✅](packages/sources/gemini/test/integration) | | @@ -189,6 +189,7 @@ This document was generated automatically. Please see [Master List Generator](./ | [satoshitango](packages/sources/satoshitango/README.md) | `1.3.45` | `source` | v2 | `https://api.satoshitango.com/v3` | | `API_ENDPOINT` | `crypto`, `ticker` | `crypto` | | [✅](packages/sources/satoshitango/test/unit) | [✅](packages/sources/satoshitango/test/integration) | | | [savax-price](packages/composites/savax-price/README.md) | `3.0.109` | `composite` | v2 | Unknown | `token-allocation-adapter` | `AVALANCHE_CHAIN_ID`, `AVALANCHE_RPC_URL (✅)`, `SAVAX_ADDRESS` | `price` | `price` | | [✅](packages/composites/savax-price/test/unit) | [✅](packages/composites/savax-price/test/integration) | [✅](packages/composites/savax-price/test/e2e) | | [secure-mint](packages/composites/secure-mint/README.md) | `1.0.4` | `composite` | v3 | Unknown | `external-adapter-framework` | `BACKGROUND_EXECUTE_MS`, `BITGO_RESERVES_EA_URL`, `SECURE_MINT_INDEXER_URL (✅)` | `mintable` | `mintable` | | [✅](packages/composites/secure-mint/test/unit) | [✅](packages/composites/secure-mint/test/integration) | | +| [securitize](packages/sources/securitize/README.md) | `1.0.0` | `source` | v3 | `https://partners-api.securitize.io/asset-metrics/api/v1/nav` | `external-adapter-framework` | `API_ENDPOINT`, `API_KEY (✅)` | `nav` | `nav` | | [✅](packages/sources/securitize/test/unit) | [✅](packages/sources/securitize/test/integration) | | | [set-token-index](packages/composites/set-token-index/README.md) | `3.0.35` | `composite` | v2 | Unknown | `token-allocation-adapter` | `ETHEREUM_CHAIN_ID`, `ETHEREUM_RPC_URL (✅)` | `allocations`, `token-index`, `tokens` | `token-index` | | | [✅](packages/composites/set-token-index/test/integration) | | | [snowflake](packages/sources/snowflake/README.md) | `1.2.45` | `source` | v2 | Unknown | | `ACCOUNT (✅)`, `CLOUD_PROVIDER`, `CLOUD_REGION`, `DATABASE`, `DB_USERNAME (✅)`, `PRIVATE_KEY (✅)`, `SCHEMA` | `covid-cases` | `covid-cases` | | [✅](packages/sources/snowflake/test/unit) | [✅](packages/sources/snowflake/test/integration) | | | [sochain](packages/sources/sochain/README.md) | `1.3.45` | `source` | v2 | `https://sochain.com` | | `API_ENDPOINT` | `balance` | `balance` | | | [✅](packages/sources/sochain/test/integration) | [✅](packages/sources/sochain/test/e2e) | diff --git a/package.json b/package.json index 7b733c6ac4..4c22b07406 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@chainlink/external-adapters-js", - "version": "1.194.0", + "version": "1.195.0", "license": "MIT", "private": true, "workspaces": [ diff --git a/packages/sources/README.md b/packages/sources/README.md index 0848628ec8..b87107af25 100644 --- a/packages/sources/README.md +++ b/packages/sources/README.md @@ -154,6 +154,7 @@ This document was generated automatically. Please see [Master List Generator](.. - [renvm-address-set](./renvm-address-set/README.md) - [s3-csv-reader](./s3-csv-reader/README.md) - [satoshitango](./satoshitango/README.md) +- [securitize](./securitize/README.md) - [snowflake](./snowflake/README.md) - [sochain](./sochain/README.md) - [solactive](./solactive/README.md) diff --git a/packages/sources/ftse-sftp/CHANGELOG.md b/packages/sources/ftse-sftp/CHANGELOG.md index 04b9f2c5b2..615621579c 100644 --- a/packages/sources/ftse-sftp/CHANGELOG.md +++ b/packages/sources/ftse-sftp/CHANGELOG.md @@ -1,5 +1,11 @@ # @chainlink/ftse-sftp-adapter +## 1.0.0 + +### Major Changes + +- [#4036](https://github.com/smartcontractkit/external-adapters-js/pull/4036) [`725e85e`](https://github.com/smartcontractkit/external-adapters-js/commit/725e85ebbc8d26b3cc25178efcd19e4ad8eac542) Thanks [@dskloetc](https://github.com/dskloetc)! - Adding Downloading and parsing logic for russell and ftse csv files from ftse sftp server + ## 0.2.0 ### Minor Changes diff --git a/packages/sources/ftse-sftp/README.md b/packages/sources/ftse-sftp/README.md new file mode 100644 index 0000000000..29557f0e63 --- /dev/null +++ b/packages/sources/ftse-sftp/README.md @@ -0,0 +1,95 @@ +# FTSE_SFTP + +![1.0.0](https://img.shields.io/github/package-json/v/smartcontractkit/external-adapters-js?filename=packages/sources/ftse-sftp/package.json) ![v3](https://img.shields.io/badge/framework%20version-v3-blueviolet) + +This document was generated automatically. Please see [README Generator](../../scripts#readme-generator) for more info. + +## Environment Variables + +| Required? | Name | Description | Type | Options | Default | +| :-------: | :-------------------: | :---------------------------------------------------------------------------------------: | :----: | :-----: | :-----: | +| ✅ | SFTP_HOST | SFTP server hostname or IP address | string | | | +| | SFTP_PORT | SFTP server port | number | | `22` | +| ✅ | SFTP_USERNAME | SFTP username for authentication | string | | | +| ✅ | SFTP_PASSWORD | SFTP password for authentication | string | | | +| | SFTP_READY_TIMEOUT_MS | How long (in milliseconds) to wait for the SSH handshake to complete | number | | `30000` | +| | BACKGROUND_EXECUTE_MS | The amount of time the background execute should sleep before performing the next request | number | | `10000` | + +--- + +## Data Provider Rate Limits + +There are no rate limits for this adapter. + +--- + +## Input Parameters + +| Required? | Name | Description | Type | Options | Default | +| :-------: | :------: | :-----------------: | :----: | :--------------------: | :-----: | +| | endpoint | The endpoint to use | string | [sftp](#sftp-endpoint) | `sftp` | + +## Sftp Endpoint + +`sftp` is the only supported name for this endpoint. + +### Input Params + +| Required? | Name | Aliases | Description | Type | Options | Default | Depends On | Not Valid With | +| :-------: | :--------: | :-----: | :----------------------------------------------------: | :----: | :------------------------------------------------------------------------: | :-----: | :--------: | :------------: | +| ✅ | instrument | | Abstract identifier of the index to fetch the data for | string | `FTSE100INDEX`, `Russell1000INDEX`, `Russell2000INDEX`, `Russell3000INDEX` | | | | + +### Example + +Request: + +```json +{ + "data": { + "endpoint": "sftp", + "instrument": "FTSE100INDEX" + } +} +``` + +
+Additional Examples + +Request: + +```json +{ + "data": { + "endpoint": "sftp", + "instrument": "Russell1000INDEX" + } +} +``` + +Request: + +```json +{ + "data": { + "endpoint": "sftp", + "instrument": "Russell2000INDEX" + } +} +``` + +Request: + +```json +{ + "data": { + "endpoint": "sftp", + "instrument": "Russell3000INDEX" + } +} +``` + +
+ +--- + +MIT License diff --git a/packages/sources/ftse-sftp/package.json b/packages/sources/ftse-sftp/package.json index d189b2d757..6c8517cfd2 100644 --- a/packages/sources/ftse-sftp/package.json +++ b/packages/sources/ftse-sftp/package.json @@ -1,6 +1,6 @@ { "name": "@chainlink/ftse-sftp-adapter", - "version": "0.2.0", + "version": "1.0.0", "description": "Chainlink ftse-sftp adapter.", "keywords": [ "Chainlink", diff --git a/packages/sources/securitize/CHANGELOG.md b/packages/sources/securitize/CHANGELOG.md index e69de29bb2..3220a0a8e7 100644 --- a/packages/sources/securitize/CHANGELOG.md +++ b/packages/sources/securitize/CHANGELOG.md @@ -0,0 +1,7 @@ +# @chainlink/securitize-adapter + +## 1.0.0 + +### Major Changes + +- [#4013](https://github.com/smartcontractkit/external-adapters-js/pull/4013) [`5c7de6f`](https://github.com/smartcontractkit/external-adapters-js/commit/5c7de6f6b54af9fc19c0a833f1c0c8f800b4dc77) Thanks [@mmcallister-cll](https://github.com/mmcallister-cll)! - Securitize Initial release diff --git a/packages/sources/securitize/README.md b/packages/sources/securitize/README.md index 5f2d77f7c0..c4f346257f 100644 --- a/packages/sources/securitize/README.md +++ b/packages/sources/securitize/README.md @@ -1,3 +1,57 @@ -# Chainlink External Adapter for securitize +# SECURITIZE -This README will be generated automatically when code is merged to `main`. If you would like to generate a preview of the README, please run `yarn generate:readme securitize`. +![1.0.0](https://img.shields.io/github/package-json/v/smartcontractkit/external-adapters-js?filename=packages/sources/securitize/package.json) ![v3](https://img.shields.io/badge/framework%20version-v3-blueviolet) + +This document was generated automatically. Please see [README Generator](../../scripts#readme-generator) for more info. + +## Environment Variables + +| Required? | Name | Description | Type | Options | Default | +| :-------: | :----------: | :---------------------------------: | :----: | :-----: | :-----------------------------------------------------------: | +| ✅ | API_KEY | An API key for Securitize NAV | string | | | +| | API_ENDPOINT | The API endpoint for Securitize NAV | string | | `https://partners-api.securitize.io/asset-metrics/api/v1/nav` | + +--- + +## Data Provider Rate Limits + +| Name | Requests/credits per second | Requests/credits per minute | Requests/credits per hour | Note | +| :-----: | :-------------------------: | :-------------------------: | :-----------------------: | :--------------------------------------: | +| default | | 30 | | 500/minute but setting reasonable limits | + +--- + +## Input Parameters + +| Required? | Name | Description | Type | Options | Default | +| :-------: | :------: | :-----------------: | :----: | :------------------: | :-----: | +| | endpoint | The endpoint to use | string | [nav](#nav-endpoint) | `nav` | + +## Nav Endpoint + +`nav` is the only supported name for this endpoint. + +### Input Params + +| Required? | Name | Aliases | Description | Type | Options | Default | Depends On | Not Valid With | +| :-------: | :----------: | :-----: | :-------------------------------------------------------------------: | :----: | :-----: | :-----: | :--------: | :------------: | +| ✅ | assetId | | The assetId of the fund | string | | | | | +| ✅ | envVarPrefix | | Maps the assetId to the {envVarPrefix.toUpperCase()}\_PUBKEYS env var | string | | | | | + +### Example + +Request: + +```json +{ + "data": { + "endpoint": "nav", + "assetId": "c52c3d79-8317-4692-86f8-4e0dfd508672", + "envVarPrefix": "testAsset" + } +} +``` + +--- + +MIT License diff --git a/packages/sources/securitize/package.json b/packages/sources/securitize/package.json index 05b0891bd0..b0196ef058 100644 --- a/packages/sources/securitize/package.json +++ b/packages/sources/securitize/package.json @@ -1,6 +1,6 @@ { "name": "@chainlink/securitize-adapter", - "version": "0.0.0", + "version": "1.0.0", "description": "Chainlink securitize adapter.", "keywords": [ "Chainlink",