Skip to content

Commit 805468b

Browse files
Feat/DF-20625 apex (#3672)
* DF-20625 apex EA initial commit * add changeset * review fixes
1 parent 29cf6c0 commit 805468b

File tree

19 files changed

+549
-0
lines changed

19 files changed

+549
-0
lines changed
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'@chainlink/apex-adapter': major
3+
---
4+
5+
Apex EA Initial Commit

.pnp.cjs

Lines changed: 21 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/sources/apex/CHANGELOG.md

Whitespace-only changes.

packages/sources/apex/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Chainlink External Adapter for apex
2+
3+
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 apex`.

packages/sources/apex/package.json

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
{
2+
"name": "@chainlink/apex-adapter",
3+
"version": "0.0.0",
4+
"description": "Chainlink apex adapter.",
5+
"keywords": [
6+
"Chainlink",
7+
"LINK",
8+
"blockchain",
9+
"oracle",
10+
"apex"
11+
],
12+
"main": "dist/index.js",
13+
"types": "dist/index.d.ts",
14+
"files": [
15+
"dist"
16+
],
17+
"repository": {
18+
"url": "https://github.com/smartcontractkit/external-adapters-js",
19+
"type": "git"
20+
},
21+
"license": "MIT",
22+
"scripts": {
23+
"clean": "rm -rf dist && rm -f tsconfig.tsbuildinfo",
24+
"prepack": "yarn build",
25+
"build": "tsc -b",
26+
"server": "node -e 'require(\"./index.js\").server()'",
27+
"server:dist": "node -e 'require(\"./dist/index.js\").server()'",
28+
"start": "yarn server:dist"
29+
},
30+
"devDependencies": {
31+
"@types/jest": "27.5.2",
32+
"@types/node": "22.12.0",
33+
"nock": "13.5.6",
34+
"typescript": "5.6.3"
35+
},
36+
"dependencies": {
37+
"@chainlink/external-adapter-framework": "2.0.0",
38+
"axios": "1.7.9",
39+
"tslib": "2.4.1"
40+
}
41+
}
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
import { AdapterConfig } from '@chainlink/external-adapter-framework/config'
2+
3+
export const config = new AdapterConfig({
4+
CLIENT_ID: {
5+
description: 'Data Provider client ID',
6+
type: 'string',
7+
required: true,
8+
sensitive: true,
9+
},
10+
CLIENT_SECRET: {
11+
description: 'Data Provider client secret',
12+
type: 'string',
13+
required: true,
14+
sensitive: true,
15+
},
16+
SCOPE: {
17+
description: 'Scope of credentials',
18+
type: 'string',
19+
required: true,
20+
sensitive: true,
21+
},
22+
GRANT_TYPE: {
23+
description: 'Grant type for credentials',
24+
type: 'string',
25+
required: true,
26+
sensitive: true,
27+
},
28+
NAV_API_ENDPOINT: {
29+
description: 'An API endpoint for Data Provider',
30+
type: 'string',
31+
default: 'https://api.apexgroup.com/v1/reports/NAV',
32+
},
33+
AUTH_API_ENDPOINT: {
34+
description: 'An auth API endpoint for Data Provider',
35+
type: 'string',
36+
required: true,
37+
sensitive: true,
38+
},
39+
BACKGROUND_EXECUTE_MS: {
40+
description:
41+
'The amount of time the background execute should sleep before performing the next request',
42+
type: 'number',
43+
default: 10_000,
44+
},
45+
})
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
export { endpoint as nav } from './nav'
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
import { AdapterEndpoint } from '@chainlink/external-adapter-framework/adapter'
2+
import { InputParameters } from '@chainlink/external-adapter-framework/validation'
3+
import { SingleNumberResultResponse } from '@chainlink/external-adapter-framework/util'
4+
import { config } from '../config'
5+
import { navTransport } from '../transport/nav'
6+
7+
export const inputParameters = new InputParameters(
8+
{
9+
accountName: {
10+
required: true,
11+
type: 'string',
12+
description: 'The account name to query',
13+
},
14+
},
15+
[
16+
{
17+
accountName: 'EXAMPLE',
18+
},
19+
],
20+
)
21+
22+
export type BaseEndpointTypes = {
23+
Parameters: typeof inputParameters.definition
24+
Response: SingleNumberResultResponse
25+
Settings: typeof config.settings
26+
}
27+
28+
export const endpoint = new AdapterEndpoint({
29+
name: 'nav',
30+
transport: navTransport,
31+
inputParameters,
32+
})

packages/sources/apex/src/index.ts

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
import { expose, ServerInstance } from '@chainlink/external-adapter-framework'
2+
import { Adapter } from '@chainlink/external-adapter-framework/adapter'
3+
import { config } from './config'
4+
import { nav } from './endpoint'
5+
6+
export const adapter = new Adapter({
7+
defaultEndpoint: nav.name,
8+
name: 'APEX',
9+
config,
10+
endpoints: [nav],
11+
rateLimiting: {
12+
tiers: {
13+
default: {
14+
rateLimit1m: 6,
15+
note: 'Setting reasonable default limits',
16+
},
17+
},
18+
},
19+
})
20+
21+
export const server = (): Promise<ServerInstance | undefined> => expose(adapter)

0 commit comments

Comments
 (0)