Feature/proof of reserves

CHANGELOG.md

@@ -17,13 +17,17 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
   - `finage` to get Financial data from finage.co.uk
   - `coincodex` to get crypto prices from CoinCodex
   - `coinranking` to get crypto prices from Coinranking
+  - `btc.com` to get on-chain balances from BTC.com
+  - `sochain` to get on-chain balances from SoChain
   - `dns-query` to query DNS over HTTPS
   - `dns-record-check` to check whether some record provided exists on DNS
   - `outlier-detection`: composite adapter to check for outlier values between multiple sets of data providers
   - `dydx-stark` to sign the input price data with your private STARK key, and send it to the destination endpoint.
 - Added support for metadata in requests. This gives adapters access to the FM on-chain round state.
 - Moves re-usable test behaviors & testing utils to a new package - `@chainlink/adapter-test-helpers`
 - Added support for using query string parameters as input to adapters.
+- Add a package re-usable adapter factory implementations to - `@chainlink/ea-factories`
+
 - Added support for using multiple API Keys per-adapter
 
 ### Changed
@@ -32,7 +36,11 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 - Market closure is now a composite adapter, and now follows the build instructions for composite adapters. Market
   now also supports using metadata.
 - Coinlore now accepts an optional environment variable to set the default API endpoint
-- migrates @chainlink/ea-bootstrap and @chainlink/external-adapter packages to TS.
+- Migrates @chainlink/ea-bootstrap and @chainlink/external-adapter packages to TS.
+- Updates the following adapters with a second endpoint for getting an account's on-chain balance
+  - `amberdata`
+  - `blockchair`
+  - `cryptoapis`
 - dxFeed now uses OTC feeds for FTSE and N225, rather than licensed data feeds
 
 ### Removed

Makefile

@@ -31,6 +31,7 @@ deps: clean
 	# Call the build script for the adapter if defined (TypeScript adapters have this extra build/compile step)
 	# We use `wsrun` to build workspace dependencies in topological order (TODO: use native `yarn workspaces foreach -pt run setup` with Yarn 2)
 	yarn wsrun -mre -p @chainlink/ea-bootstrap -t setup
+	yarn wsrun -mre -p @chainlink/ea-factories -t setup
 	yarn wsrun -mre -p @chainlink/external-adapter -t setup
 	yarn wsrun -mre -p @chainlink/$(if $(name),$(name),$(adapter))-adapter -t setup
 	yarn --frozen-lockfile --production
@@ -57,7 +58,10 @@ clean-2-step:
 
 build-2-step:
 	cp -r $(adapter) 2-step/
-	mv 2-step/$(adapter)/adapter.js 2-step/$(adapter)/priceAdapter.js
+	if [ -f "2-step/$(adapter)/dist/adapter.js" ]; then \
+		mv 2-step/$(adapter)/dist/adapter.js 2-step/$(adapter)/priceAdapter.js; \
+	else mv 2-step/$(adapter)/adapter.js 2-step/$(adapter)/priceAdapter.js; \
+	fi
 	cp 2-step/adapter.js 2-step/$(adapter)
 	cp -r helpers 2-step/helpers
 	npx @vercel/ncc@0.25.1 build 2-step/$(adapter) -o 2-step/$(adapter)/dist

amberdata/.eslintrc.js

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

amberdata/README.md

@@ -1,5 +1,18 @@
 # Chainlink External Adapter for Amberdata
 
+## Configuration
+
+The adapter takes the following environment variables:
+
+- `API_KEY`: Optional API key to use
+- `API_TIMEOUT`: Optional timeout param, defaults to `30000`
+
+## Input Params
+
+- `endpoint`: The endpoint to use, one of (price|balance). Default: "price"
+
+### Price endpoint
+
 Gets the [latest spot VWAP price](https://docs.amberdata.io/reference#spot-price-pair-latest) from Amberdata.
 
 ## Input Params
@@ -11,20 +24,119 @@ Gets the [latest spot VWAP price](https://docs.amberdata.io/reference#spot-price
 
 ```json
 {
- "jobRunID": "1",
- "data": {
-  "status": 200,
-  "title": "OK",
-  "description": "Successful request",
-  "payload": {
-   "timestamp": 1603800660000,
-   "pair": "link_usd",
-   "price": "12.02087667",
-   "volume": "508.31"
+  "jobRunID": "1",
+  "data": {
+    "status": 200,
+    "title": "OK",
+    "description": "Successful request",
+    "payload": {
+      "timestamp": 1603800660000,
+      "pair": "link_usd",
+      "price": "12.02087667",
+      "volume": "508.31"
+    },
+    "result": 12.02087667
+  },
+  "result": 12.02087667,
+  "statusCode": 200
+}
+```
+
+### Balance endpoint
+
+- `dataPath`: Optional path where to find the addresses array, defaults to `result`
+- `confirmations`: Optional confirmations param, defaults to `6`
+
+- `addresses`: Addresses to query
+
+  {
+
+  - `address`: Address to query
+  - `coin`: Optional currency to query, defaults to `btc`, one of `(btc|eth|bch|ltc|btsv|zec)`
+  - `chain`: Optional chain to query, defaults to `mainnet`, one of `(mainnet|testnet)` when querying ethereum. Returns Rinkeby data.
+
+  }
+
+```json
+{
+  "id": "1",
+  "data": {
+    "addresses": [
+      {
+        "address": "3EyjZ6CtEZEKyc719NZMyWaJpJG5jsVJL1"
+      },
+      {
+        "address": "38bzm6nhQMFJe71jJw1U7CbgNrVNpkonZF"
+      }
+    ],
+    "dataPath": "addresses"
+  }
+}
+```
+
+### Output
+
+```json
+{
+  "jobRunID": "1",
+  "data": {
+    "responses": [
+      {
+        "status": 200,
+        "title": "OK",
+        "description": "Successful request",
+        "payload": {
+          "address": { "address": "3EyjZ6CtEZEKyc719NZMyWaJpJG5jsVJL1" },
+          "blockchainId": "408fa195a34b533de9ad9889f076045e",
+          "blockNumber": "656338",
+          "timestampNanoseconds": 0,
+          "value": "547",
+          "timestamp": "2020-11-10T19:54:09.000Z"
+        }
+      },
+      {
+        "status": 200,
+        "title": "OK",
+        "description": "Successful request",
+        "payload": {
+          "address": { "address": "38bzm6nhQMFJe71jJw1U7CbgNrVNpkonZF" },
+          "blockchainId": "408fa195a34b533de9ad9889f076045e",
+          "blockNumber": "653986",
+          "timestampNanoseconds": 0,
+          "value": "3282",
+          "timestamp": "2020-10-23T17:28:35.000Z"
+        }
+      }
+    ],
+    "result": [
+      {
+        "address": "3EyjZ6CtEZEKyc719NZMyWaJpJG5jsVJL1",
+        "coin": "btc",
+        "chain": "mainnet",
+        "balance": "547"
+      },
+      {
+        "address": "38bzm6nhQMFJe71jJw1U7CbgNrVNpkonZF",
+        "coin": "btc",
+        "chain": "mainnet",
+        "balance": "3282"
+      }
+    ]
   },
-  "result": 12.02087667
- },
- "result": 12.02087667,
- "statusCode": 200
+  "result": [
+    {
+      "address": "3EyjZ6CtEZEKyc719NZMyWaJpJG5jsVJL1",
+      "coin": "btc",
+      "chain": "mainnet",
+      "balance": "547"
+    },
+    {
+      "address": "38bzm6nhQMFJe71jJw1U7CbgNrVNpkonZF",
+      "coin": "btc",
+      "chain": "mainnet",
+      "balance": "3282"
+    }
+  ],
+  "statusCode": 200
 }
 ```

amberdata/package.json

@@ -2,14 +2,37 @@
   "name": "@chainlink/amberdata-adapter",
   "version": "0.0.1",
   "license": "MIT",
-  "main": "index.js",
+  "main": "dist/index.js",
   "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": "yarn test:unit && yarn test:integration",
+    "test:unit": "mocha --exit --grep @integration --invert -r ts-node/register 'test/**/*.test.ts'",
+    "test:integration": "mocha --timeout 5000 --exit --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"
+  },
+  "dependencies": {},
+  "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"
+  },
+  "repository": {
+    "url": "https://github.com/smartcontractkit/external-adapters-js",
+    "type": "git"
   },
-  "dependencies": {}
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ]
 }

amberdata/src/adapter.ts

@@ -0,0 +1,39 @@
+import { Requester, Validator, AdapterError } from '@chainlink/external-adapter'
+import { ExecuteWithConfig, ExecuteFactory, Config } from '@chainlink/types'
+import { makeConfig, DEFAULT_ENDPOINT } from './config'
+import { price, balance } from './endpoint'
+
+const inputParams = {
+  endpoint: false,
+}
+
+// Export function to integrate with Chainlink node
+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 price.execute(request, config)
+    }
+    case balance.Name: {
+      return balance.makeExecute(config)(request)
+    }
+    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())
+}

amberdata/src/config.ts

@@ -0,0 +1,13 @@
+import { Requester } from '@chainlink/external-adapter'
+import { Config } from '@chainlink/types'
+
+export const DEFAULT_API_ENDPOINT = 'https://web3api.io'
+
+export const DEFAULT_ENDPOINT = 'price'
+
+export const makeConfig = (prefix = ''): Config => {
+  const config = Requester.getDefaultConfig(prefix)
+  config.api.headers['x-api-key'] = config.apiKey
+  config.api.baseURL = config.api.baseURL || DEFAULT_API_ENDPOINT
+  return config
+}

amberdata/src/endpoint/balance.ts

@@ -0,0 +1,34 @@
+import { balance } from '@chainlink/ea-factories'
+import { Config } from '@chainlink/types'
+import { Requester } from '@chainlink/external-adapter'
+import { isChainType, isCoinType, BLOCKCHAINS } from '.'
+
+export const Name = 'balance'
+
+const getBalanceURI = (address: string) => `/api/v2/addresses/${address}/account-balances/latest`
+
+const getBlockchainHeader = (chain?: string, coin?: string) => {
+  const network = Requester.toVendorName(coin, BLOCKCHAINS)
+  return `${network}-mainnet`
+}
+
+const getBalance: balance.GetBalance = async (account, config) => {
+  const reqConfig: any = {
+    ...config.api,
+    url: getBalanceURI(account.address),
+    headers: {
+      ...config.api.headers,
+      'x-amberdata-blockchain-id': getBlockchainHeader(account.chain, account.coin),
+    },
+  }
+
+  const response = await Requester.request(reqConfig)
+  return {
+    payload: response.data,
+    result: [{ ...account, balance: response.data.payload.value }],
+  }
+}
+
+const isSupported: balance.IsSupported = (coin, chain) => isChainType(chain) && isCoinType(coin)
+
+export const makeExecute = (config: Config) => balance.make({ ...config, getBalance, isSupported })