Remove adapter.ts duplication #293

ebarakos · 2021-02-03T15:59:56Z

Removed adapter.ts from example, cryptoapis and amberdata as PoC.

Utilized endpoint Name, by making it a Names array. This might be useful on declaring new endpoint names while also keeping backwards naming compatibility.

…splits tests

github-actions · 2021-02-03T16:00:53Z

I see that you haven't updated any CHANGELOG files. Would it make sense to do so?

…lls, correct typo in baseURL

…factor coinmarketcap typescript refactor

* 1forge to TS * Add Config type for recent change to generic types * Utilize ExecuteWithConfig in 1forge * Adds example README template & remove 'server' script * Alphavantage adapter to TS * Remove alphavantage-sdr folder * Amberdata-gasprice to TS * Anyblock-gasprice to TS * Binance-DEX to TS * Add note to binance-dex's differing use of API_ENDPOINT env var * Brave New Coin to TS * Bring Brave New Coin VWAP into Brave New Coin EA * Coinapi to TS * Coinbase to TS * Coingecko to TS * Move BNC helpers into BNC adapter * Increase alphavantage test timeout * Moves alphavantage APIkey param into endpoint - issue open for improvement * Clean up leftover bravenewcoin-vwap traces * Remove 1forge's conflicting and not useful endpoint param * Requested changes: 1forge balance -> price, alphavantage example output * Re-add server script & spread response data into endpoint responses * Uses verbose env var to determine response data * Gets API_KEY from makeConfig * Add test dummy API_KEY * Re-add server script to example

[develop] Preparing release v0.2.0-rc.1

* batch adapter TS refactor * satisfy linter * Uses config in generics, removes non-TS server script * EA endpoints return their own response & use ExecuteWithConfig type * Capitalize name property * Use Config for baseURL and API_KEYS, re-add server script, use verbose env var for data response Co-authored-by: Justin Kaseman <justinkaseman@live.com>

amberdata/src/index.ts

justinkaseman · 2021-02-05T22:04:43Z

amberdata/src/endpoint/balance.ts

@@ -3,7 +3,7 @@ import { Config } from '@chainlink/types'
 import { Requester } from '@chainlink/external-adapter'
 import { isChainType, isCoinType, BLOCKCHAINS } from '.'

-export const Name = 'balance'
+export const Names = ['balance']


I really like this concept for backwards compatibility.

What it also allows for is if we embrace that "external-adapters" are a simple wrapper that map to a data providers API we could have the naming fit the API.

For example 1forge has an endpoint baseURL/convert that we use to get price data. So there we could set the name = ['price', 'convert']

Only tweak I would make is capitalizing it to denote a static property.

Suggested change

export const Names = ['balance']

export const NAME = ['balance']

I am happy that you like it. I left the naming as I saw in some places, since we use NAME for the whole adapter package(btw, we can re-use a similar logic for routing between different adapter packages, e.g by using "source", as mentioned at the Composable Adapters document). Changing it to NAMES, to indicate array, until we think more regarding these.

justinkaseman · 2021-02-05T22:08:10Z

amberdata/test/balance.test.ts

@@ -1,7 +1,7 @@
-import { makeExecute } from '../src/adapter'
+import adapter from '../src/index'


Could destructure this

Suggested change

import adapter from '../src/index'

import { makeExecute } from '../src/index'

Just a style preference thing.

There are some issues on the export = ES6 default exports of adapters' index.ts files, that's why it can't be used as the other imports. But it should be converted to this syntax once we resolve this.

bootstrap/src/adapter.ts

justinkaseman · 2021-02-05T22:17:22Z

cryptoapis/src/endpoint/bc_info.ts

 import { DEFAULT_ENDPOINT } from '../config'

-export const Name = 'bc_info'
+export const Names = ['difficulty', 'height']


Definitely important for backwards compatibility, but I wonder if in time these names should be housed in ea-legos since they are the specific data point to fetch.

In ea-legos it would map 'bc_info' => ['difficulty', 'height'].

So our Chainlink request would be for the data point block_height from cryptoapis which would then be transformed to call this API wrapper that knows how to make that HTTP request aka

{ "endpoint": "bc_info", "path": "payload.headers" }

I think this builds toward a future where data providers could just upload their whole API via an OpenAPI spec.

Don't think this is a right now thing, just thinking out loud.

typings/@chainlink/index.d.ts

justinkaseman · 2021-02-05T22:30:08Z

Really like the direction, thanks for making a push toward this.

Left some thoughts, also curious to hear what @krebernisak thinks.

…velop

…api key warning

HenryNguyen5 · 2021-08-24T21:05:41Z

What's the status on this PR @ebarakos @justinkaseman?

justinkaseman · 2021-09-08T18:46:55Z

Closing as these changes have become obsolete.

emmick4 and others added 6 commits January 11, 2021 20:36

coinmarketcap ts refactor

a9425aa

types & lint & package name

aceeedc

CHANGELOG

bb4e012

Merge develop

06ce69a

Requested changes: uses generic execute types, base url from config, …

988dc26

…splits tests

add conflux adapter

5c3a7e0

ebarakos force-pushed the refactor/remove-adapter-duplication branch from 59c6045 to 29cffc7 Compare February 3, 2021 16:03

ebarakos changed the title ~~importing adapter.ts from bootstrap package~~ Remove adapter.ts duplication Feb 3, 2021

ebarakos force-pushed the refactor/remove-adapter-duplication branch from d6060a0 to 4ad374c Compare February 3, 2021 16:34

justinkaseman and others added 14 commits February 3, 2021 12:44

Merge develop

40090fc

Remove adapter.js from merge

981c0dc

Fix: increase test timeout, move marketcap unknown market to error ca…

9ad5695

…lls, correct typo in baseURL

getDefaultConfig takes new parameter for required API key

c6fc972

Brings back dummy API_KEYs for tests

1d834e7

Uses verbose env var to determine response data

59c150f

update changelog: add conflux adapter

4977c31

Merge branch 'develop' into emmick/coinmarketcap-refactor

fb6fad6

Merge pull request #218 from smartcontractkit/emmick/coinmarketcap-re…

09e2bb2

…factor coinmarketcap typescript refactor

Merge branch 'develop' into release/v0.2.0-rc.1

5ec72c2

Merge pull request #298 from smartcontractkit/release/v0.2.0-rc.1

3ee01e9

[develop] Preparing release v0.2.0-rc.1

README improvements, fix typo with PRICE_ADAPTER

4fea27a

justinkaseman reviewed Feb 5, 2021

View reviewed changes

PanaW added 2 commits February 7, 2021 14:25

networkId type fix

efd53dd

feed tx gas info

42ad11e

ebarakos force-pushed the refactor/remove-adapter-duplication branch from 4ad374c to 3974ec4 Compare February 8, 2021 11:28

Read dxFeed config correctly with prefix

1284cb9

HenryNguyen5 and others added 4 commits February 23, 2021 16:05

Publish adapters to prod when merging to develop

cc50afa

Merge pull request #327 from smartcontractkit/feature/publish_prod_de…

6198f32

…velop

Merge branch 'develop' into feature/sdlc-publish

5492d66

Merge pull request #316 from smartcontractkit/feature/sdlc-publish

eae0831

ebarakos force-pushed the refactor/remove-adapter-duplication branch 2 times, most recently from d9c5182 to b88d7eb Compare February 24, 2021 08:47

ebarakos linked an issue Feb 24, 2021 that may be closed by this pull request

Improve how adapters structure and map internal API calls #241

Closed

BkChoy and others added 12 commits February 24, 2021 16:53

basic setup

0971a97

geoDB adapter

c1e9023

updated changelog

97fbebb

Removed other parts of config that include sensitive values. Removed …

1a39885

…api key warning

importing adapter.ts from bootstrap

35afc19

fix test imports

cb620cc

fix names

cc40f56

removed some else clauses

2003847

changed Makefile to use the common adapter

854e876

capitalizing names

faca8b6

removed DEFAULT_ENDPOINT from config + added ethwrite

c056bdf

changed type for endpoint router

7dd2e64

ebarakos force-pushed the refactor/remove-adapter-duplication branch 4 times, most recently from 657f99d to 5f49c2a Compare February 26, 2021 13:08

api not required in Config

84b8d75

ebarakos force-pushed the refactor/remove-adapter-duplication branch from 5f49c2a to 84b8d75 Compare February 26, 2021 13:24

justinkaseman force-pushed the develop branch from 6732ff5 to 5c4c310 Compare August 2, 2021 19:56

justinkaseman closed this Sep 8, 2021

austinborn deleted the refactor/remove-adapter-duplication branch November 4, 2021 17:51

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove adapter.ts duplication #293

Remove adapter.ts duplication #293

ebarakos commented Feb 3, 2021 •

edited

Loading

github-actions bot commented Feb 3, 2021

justinkaseman Feb 5, 2021

ebarakos Feb 9, 2021 •

edited

Loading

justinkaseman Feb 5, 2021

ebarakos Feb 8, 2021

justinkaseman Feb 5, 2021

justinkaseman commented Feb 5, 2021

HenryNguyen5 commented Aug 24, 2021

justinkaseman commented Sep 8, 2021

	export const Names = ['balance']
	export const NAME = ['balance']

		@@ -1,7 +1,7 @@
		import { makeExecute } from '../src/adapter'
		import adapter from '../src/index'

	import adapter from '../src/index'
	import { makeExecute } from '../src/index'

Remove adapter.ts duplication #293

Remove adapter.ts duplication #293

Conversation

ebarakos commented Feb 3, 2021 • edited Loading

github-actions bot commented Feb 3, 2021

justinkaseman Feb 5, 2021

Choose a reason for hiding this comment

ebarakos Feb 9, 2021 • edited Loading

Choose a reason for hiding this comment

justinkaseman Feb 5, 2021

Choose a reason for hiding this comment

ebarakos Feb 8, 2021

Choose a reason for hiding this comment

justinkaseman Feb 5, 2021

Choose a reason for hiding this comment

justinkaseman commented Feb 5, 2021

HenryNguyen5 commented Aug 24, 2021

justinkaseman commented Sep 8, 2021

ebarakos commented Feb 3, 2021 •

edited

Loading

ebarakos Feb 9, 2021 •

edited

Loading