[Master] Release/v0.2.0

.github/strategy/adapters.json

@@ -7,6 +7,7 @@
     "image_name": "__ADAPTER__-adapter",
     "adapter": [
       "1forge",
+      "agoric",
       "alphachain",
       "alphavantage",
       "amberdata",
@@ -19,9 +20,9 @@
       "blockchain.com",
       "blockchair",
       "blockcypher",
+      "blockstream",
       "bootstrap",
       "bravenewcoin",
-      "bravenewcoin-vwap",
       "coinapi",
       "coinbase",
       "coincodex",
@@ -51,7 +52,6 @@
       "fixer",
       "fmpcloud",
       "genesis-volatility",
-      "google-finance",
       "json-rpc",
       "kaiko",
       "lcx",
@@ -82,7 +82,13 @@
       "dydx-stark",
       "iex-cloud",
       "cfbenchmarks",
-      "harmony"
+      "conflux",
+      "harmony",
+      "tiingo",
+      "ethwrite",
+      "geodb",
+      "therundown",
+      "tradingeconomics-stream"
     ]
   },
   "2-step": {
@@ -116,25 +122,8 @@
       "apy-finance",
       "crypto-volatility-index",
       "bitcoin-json-rpc",
-      "token-allocation"
-    ]
-  },
-  "synth-index": {
-    "docker": "make docker-synth-index adapter=__ADAPTER__",
-    "cmd": "make zip-synth-index adapter=__ADAPTER__",
-    "asset_path": "./synth-index/__ADAPTER__/dist/synth-index-__ADAPTER__-adapter.zip",
-    "asset_name": "synth-index-__ADAPTER__-adapter.zip",
-    "image_name": "synth-index-__ADAPTER__-adapter",
-    "adapter": [
-      "amberdata",
-      "bravenewcoin",
-      "coinapi",
-      "coingecko",
-      "coinmarketcap",
-      "coinpaprika",
-      "cryptocompare",
-      "kaiko",
-      "nomics"
+      "token-allocation",
+      "synth-index"
     ]
   }
 }

.github/workflows/release-staging.yml

@@ -52,21 +52,25 @@ jobs:
         run: ${{ matrix.adapter.cmd }}
       - name: Build Docker containers
         run: ${{ matrix.adapter.docker }} repo="public.ecr.aws/${{ env.publicecr-name }}/adapters/"
-      - name: Configure AWS Credentials
+      - name: Configure AWS prod Credentials
+        uses: aws-actions/configure-aws-credentials@v1
+        with:
+          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY }}
+          aws-secret-access-key: ${{ secrets.AWS_SECRET_KEY }}
+          aws-region: ${{ secrets.AWS_REGION }}
+      - name: Upload to prod S3
+        run: aws s3 cp ${{ matrix.adapter.asset_path }} s3://adaptor-source-cl/${{ matrix.adapter.asset_name }}
+      - name: Configure staging AWS Credentials
         uses: aws-actions/configure-aws-credentials@v1
         with:
           aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_STAGING }}
           aws-secret-access-key: ${{ secrets.AWS_SECRET_KEY_STAGING }}
           aws-region: ${{ secrets.AWS_REGION }}
-      - name: Upload to S3
+      - name: Upload to staging S3
         run: aws s3 cp ${{ matrix.adapter.asset_path }} s3://adaptor-source-cl-staging/${{ matrix.adapter.asset_name }}
       - name: Authenticate to public ECR
-        run: aws ecr-public get-login-password | docker login --username AWS --password-stdin public.ecr.aws
-        env:
-          AWS_DEFAULT_REGION: us-east-1 # https://docs.aws.amazon.com/AmazonECR/latest/public/public-registries.html#public-registry-auth
+        run: aws ecr-public get-login-password --region us-east-1 | docker login --username AWS --password-stdin public.ecr.aws/${{ env.publicecr-name }}
       - name: Create a public ECR repository if does not exist
-        run: aws ecr-public create-repository --repository-name adapters/${{ matrix.adapter.image_name }} || true
-        env:
-          AWS_DEFAULT_REGION: us-east-1
+        run: aws ecr-public create-repository --region us-east-1 --repository-name adapters/${{ matrix.adapter.image_name }} || true
       - name: Push to public ECR
         run: docker push public.ecr.aws/${{ env.publicecr-name }}/adapters/${{ matrix.adapter.image_name }}

.github/workflows/release.yml

@@ -8,7 +8,7 @@ name: Release
 
 env:
   cache-name: release-ci
-  publicecr-name: chainlink
+  publicecr-name: z0b1w9r9
 
 jobs:
   release:
@@ -90,21 +90,25 @@ jobs:
           asset_path: ${{ matrix.adapter.asset_path }}
           asset_name: ${{ needs.release.outputs.asset_prefix }}-${{ matrix.adapter.asset_name }}
           asset_content_type: application/zip
-      - name: Configure AWS Credentials
+      - name: Configure AWS Credentials for Prod S3
         uses: aws-actions/configure-aws-credentials@v1
         with:
           aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY }}
           aws-secret-access-key: ${{ secrets.AWS_SECRET_KEY }}
           aws-region: ${{ secrets.AWS_REGION }}
       - name: Upload to S3
         run: aws s3 cp ${{ matrix.adapter.asset_path }} s3://adaptor-source-cl/${{ matrix.adapter.asset_name }}
+      - name: Configure AWS Credentials for SDLC Public ECR
+        uses: aws-actions/configure-aws-credentials@v1
+        with:
+          aws-access-key-id: ${{ secrets.AWS_PUBLICECR_ACCESSKEY }}
+          aws-secret-access-key: ${{ secrets.AWS_PUBLICECR_SECRETKEY }}
+          aws-region: ${{ secrets.AWS_REGION }}
+          role-to-assume: ${{ secrets.AWS_PUBLICECR_ROLE_ARN }}
+          role-duration-seconds: 1200
       - name: Authenticate to public ECR
-        run: aws ecr-public get-login-password | docker login --username AWS --password-stdin public.ecr.aws
-        env:
-          AWS_DEFAULT_REGION: us-east-1 # https://docs.aws.amazon.com/AmazonECR/latest/public/public-registries.html#public-registry-auth
+        run: aws ecr-public get-login-password --region us-east-1  | docker login --username AWS --password-stdin public.ecr.aws/${{ env.publicecr-name }}
       - name: Create a public ECR repository if does not exist
-        run: aws ecr-public create-repository --repository-name adapters/${{ matrix.adapter.image_name }} || true
-        env:
-          AWS_DEFAULT_REGION: us-east-1
+        run: aws ecr-public create-repository --region us-east-1 --repository-name adapters/${{ matrix.adapter.image_name }} || true
       - name: Push to public ECR
         run: docker push public.ecr.aws/${{ env.publicecr-name }}/adapters/${{ matrix.adapter.image_name }}

.gitignore

@@ -2,3 +2,4 @@ node_modules/
 *.zip
 dist
 .DS_Store
+cache

1forge/.eslintrc.js

@@ -1 +1,3 @@
-module.exports = require('../.eslintrc.js')
+module.exports = {
+  ...require('../.eslintrc.ts.js'),
+}

1forge/README.md

@@ -1,23 +1,47 @@
-# Chainlink 1Forge External Adapter
+# Chainlink External Adapter for 1forge
 
-## Input Params
+### Environment Variables
 
-- `base` or `to`: The target currency to query (required)
-- `quote` or `from`: The currency to convert to (required)
-- `endpoint`: The endpoint to call (optional)
+| Required? |  Name   |                        Description                        | Options | Defaults to |
+| :-------: | :-----: | :-------------------------------------------------------: | :-----: | :---------: |
+|    ✅     | API_KEY | An API key that can be obtained from the 1forge dashboard |         |             |
 
-## Output
+---
+
+### Input Parameters
+
+| Required? |   Name   |     Description     |         Options          | Defaults to |
+| :-------: | :------: | :-----------------: | :----------------------: | :---------: |
+|           | endpoint | The endpoint to use | [price](#Price-Endpoint) |    price    |
+
+---
+
+## Price Endpoint
+
+[`/convert`](https://1forge.com/api#convert) - Convert from one currency to another
+
+### Input Params
+
+| Required? |      Name      |                  Description                  |                 Options                  | Defaults to |
+| :-------: | :------------: | :-------------------------------------------: | :--------------------------------------: | :---------: |
+|    ✅     | `base`, `from` |      The symbol of the currency to query      | [List](https://1forge.com/currency-list) |             |
+|    ✅     | `quote`, `to`  |   The symbol of the currency to convert to    | [List](https://1forge.com/currency-list) |             |
+|    🟡     |   `quantity`   | An additional amount of the original currency |                                          |             |
+|    🟡     |   `overrides`   | If base provided is found in overrides, that will be used  | [Format](../external-adapter/src/overrides/presetSymbols.json)|             |
+
+
+### Output
 
 ```json
 {
- "jobRunID": "1",
- "data": {
-  "value": 1.22687,
-  "text": "1.0 GBP is worth 1.22687 USD",
-  "timestamp": 1587489920,
-  "result": 1.22687
- },
- "result": 1.22687,
- "statusCode": 200
+  "jobRunID": "1",
+  "data": {
+    "value": 1.22687,
+    "text": "1.0 GBP is worth 1.22687 USD",
+    "timestamp": 1587489920,
+    "result": 1.22687
+  },
+  "result": 1.22687,
+  "statusCode": 200
 }
 ```

1forge/package.json

@@ -1,15 +1,34 @@
 {
   "name": "@chainlink/1forge-adapter",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "license": "MIT",
-  "main": "index.js",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
   "scripts": {
-    "server": "node -e 'require(\"./index.js\").server()'",
+    "prepublishOnly": "yarn build && yarn test:unit",
+    "setup": "yarn build",
+    "build": "tsc -b",
     "lint": "eslint --ignore-path ../.eslintignore . --ext .js,.jsx,.ts,.tsx",
     "lint:fix": "eslint --ignore-path ../.eslintignore . --ext .js,.jsx,.ts,.tsx --fix",
-    "test": "yarn _mocha --timeout 0",
-    "test:unit": "yarn _mocha --grep @integration --invert --timeout 0",
-    "test:integration": "yarn _mocha --grep @integration --timeout 0"
+    "test": "mocha --exit --timeout 15000 -r ts-node/register 'test/**/*.test.ts'",
+    "test:unit": "mocha --exit --grep @integration --invert -r ts-node/register 'test/**/*.test.ts'",
+    "test:integration": "mocha --exit --timeout 15000 --grep @integration -r ts-node/register 'test/**/*.test.ts'",
+    "server": "node -e 'require(\"./index.js\").server()'",
+    "server:dist": "node -e 'require(\"./dist/index.js\").server()'",
+    "start": "yarn server:dist"
+  },
+  "devDependencies": {
+    "@types/chai": "^4.2.11",
+    "@types/express": "^4.17.6",
+    "@types/mocha": "^7.0.2",
+    "@types/node": "^14.0.13",
+    "@typescript-eslint/eslint-plugin": "^3.9.0",
+    "@typescript-eslint/parser": "^3.9.0",
+    "ts-node": "^8.10.2",
+    "typescript": "^3.9.7"
   },
   "dependencies": {}
 }

1forge/src/adapter.ts

@@ -0,0 +1,35 @@
+import { Requester, Validator, AdapterError } from '@chainlink/external-adapter'
+import { Config, ExecuteWithConfig, ExecuteFactory } from '@chainlink/types'
+import { makeConfig, DEFAULT_ENDPOINT } from './config'
+import { price } from './endpoint'
+
+const inputParams = {
+  endpoint: false,
+}
+
+export const execute: ExecuteWithConfig<Config> = async (request, config) => {
+  const validator = new Validator(request, inputParams)
+  if (validator.error) throw validator.error
+
+  Requester.logConfig(config)
+
+  const jobRunID = validator.validated.id
+  const endpoint = validator.validated.data.endpoint || DEFAULT_ENDPOINT
+
+  switch (endpoint) {
+    case price.NAME: {
+      return await price.execute(request, config)
+    }
+    default: {
+      throw new AdapterError({
+        jobRunID,
+        message: `Endpoint ${endpoint} not supported.`,
+        statusCode: 400,
+      })
+    }
+  }
+}
+
+export const makeExecute: ExecuteFactory<Config> = (config) => {
+  return async (request) => execute(request, config || makeConfig())
+}

1forge/src/config.ts

@@ -0,0 +1,19 @@
+import { Requester } from '@chainlink/external-adapter'
+import { Config } from '@chainlink/types'
+
+export const NAME = '1FORGE'
+
+export const DEFAULT_ENDPOINT = 'price'
+export const DEFAULT_API_ENDPOINT = 'https://api.1forge.com/'
+
+export const makeConfig = (prefix?: string): Config => {
+  const config = Requester.getDefaultConfig(prefix, true)
+  config.api = {
+    ...config.api,
+    baseURL: config.api.baseUrl || DEFAULT_API_ENDPOINT,
+    params: {
+      api_key: config.apiKey,
+    },
+  }
+  return config
+}

1forge/src/endpoint/index.ts

@@ -0,0 +1 @@
+export * as price from './price'