@chainlink/external-adapter-framework 0.0.21 → 0.0.25

package/examples/bank-frick/util.d.ts

@@ -1,4 +0,0 @@
-import { SigningAlgorithm } from './types';
-import { customSettings } from './config';
-import { AdapterConfig } from '../../config';
-export declare const generateJWT: (config: AdapterConfig<typeof customSettings>, signingAlgorithm?: SigningAlgorithm) => Promise<string>;

package/examples/coingecko/batch-warming.d.ts

@@ -1,7 +0,0 @@
-import { AdapterEndpoint } from '../../adapter';
-interface AdapterRequestParams {
-    base: string;
-    quote: string;
-}
-export declare const batchEndpoint: AdapterEndpoint<AdapterRequestParams, unknown, import("../../config").SettingsMap>;
-export {};

package/examples/coingecko/batch-warming.js

@@ -1,53 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.batchEndpoint = void 0;
-const adapter_1 = require("../../adapter");
-const batch_warming_1 = require("../../transports/batch-warming");
-const DEFAULT_URL = 'https://pro-api.coingecko.com/api/v3';
-const inputParameters = {
-    coinid: {
-        description: 'The CoinGecko id or array of ids of the coin(s) to query (Note: because of current limitations to use a dummy base will need to be supplied)',
-        required: false,
-    },
-    base: {
-        aliases: ['from', 'coin'],
-        description: 'The symbol or array of symbols of the currency to query',
-        required: true,
-    },
-    quote: {
-        aliases: ['to', 'market'],
-        description: 'The symbol of the currency to convert to',
-        required: true,
-    },
-};
-const batchEndpointTransport = new batch_warming_1.BatchWarmingTransport({
-    prepareRequest: (params, context) => {
-        return {
-            baseURL: DEFAULT_URL,
-            url: '/simple/price',
-            method: 'GET',
-            params: {
-                ids: [...new Set(params.map((p) => p.base))].join(','),
-                vs_currencies: [...new Set(params.map((p) => p.quote))].join(','),
-                x_cg_pro_api_key: context.adapterConfig.API_KEY,
-            },
-        };
-    },
-    parseResponse: (res) => {
-        const entries = [];
-        for (const [base, entry] of Object.entries(res.data)) {
-            for (const [quote, price] of Object.entries(entry)) {
-                entries.push({
-                    params: { base, quote },
-                    value: price,
-                });
-            }
-        }
-        return entries;
-    },
-});
-exports.batchEndpoint = new adapter_1.AdapterEndpoint({
-    name: 'batch',
-    transport: batchEndpointTransport,
-    inputParameters,
-});

package/examples/coingecko/index.d.ts

@@ -1,2 +0,0 @@
-import { Adapter } from '../../adapter';
-export declare const adapter: Adapter<import("../../config").SettingsMap>;

package/examples/coingecko/index.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.adapter = void 0;
-const adapter_1 = require("../../adapter");
-const batch_warming_1 = require("./batch-warming");
-const rest_1 = require("./rest");
-exports.adapter = new adapter_1.Adapter({
-    name: 'coingecko',
-    defaultEndpoint: 'batch',
-    endpoints: [rest_1.restEndpoint, batch_warming_1.batchEndpoint],
-});

package/examples/coingecko/rest.d.ts

@@ -1,12 +0,0 @@
-import { AdapterEndpoint } from '../../adapter';
-interface AdapterRequestParams {
-    base: string;
-    quote: string;
-}
-interface ProviderResponseBody {
-    [base: string]: {
-        [quote: string]: number;
-    };
-}
-export declare const restEndpoint: AdapterEndpoint<AdapterRequestParams, ProviderResponseBody, import("../../config").SettingsMap>;
-export {};

package/examples/coingecko/rest.js

@@ -1,51 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.restEndpoint = void 0;
-const adapter_1 = require("../../adapter");
-const transports_1 = require("../../transports");
-const DEFAULT_URL = 'https://api.coingecko.com/api/v3';
-const inputParameters = {
-    coinid: {
-        description: 'The CoinGecko id or array of ids of the coin(s) to query (Note: because of current limitations to use a dummy base will need to be supplied)',
-        required: false,
-    },
-    base: {
-        aliases: ['from', 'coin'],
-        description: 'The symbol or array of symbols of the currency to query',
-        required: true,
-    },
-    quote: {
-        aliases: ['to', 'market'],
-        description: 'The symbol of the currency to convert to',
-        required: true,
-    },
-};
-const restEndpointTransport = new transports_1.RestTransport({
-    prepareRequest: (req) => {
-        return {
-            baseURL: DEFAULT_URL,
-            url: '/simple/price',
-            method: 'GET',
-            params: {
-                ids: req.requestContext.data.base,
-                vs_currencies: req.requestContext.data.quote,
-            },
-        };
-    },
-    parseResponse: (req, res) => {
-        return {
-            data: res.data,
-            statusCode: 200,
-            result: res.data[req.requestContext.data.base]?.[req.requestContext.data.quote],
-        };
-    },
-    options: {
-        coalescing: true,
-    },
-});
-exports.restEndpoint = new adapter_1.AdapterEndpoint({
-    name: 'rest',
-    aliases: ['qwe'],
-    transport: restEndpointTransport,
-    inputParameters,
-});

package/examples/coingecko/src/config/index.d.ts

@@ -1,2 +0,0 @@
-export declare const DEFAULT_API_ENDPOINT = "https://api.coingecko.com/api/v3";
-export declare const PRO_API_ENDPOINT = "https://pro-api.coingecko.com/api/v3";

package/examples/coingecko/src/cryptoUtils.d.ts

@@ -1,31 +0,0 @@
-import { AxiosRequestConfig, AxiosResponse } from 'axios';
-import { AdapterConfig } from '../../../config';
-import { InputParameters } from '../../../validation';
-export interface CryptoRequestParams {
-    coinid?: string;
-    base?: string;
-    quote: string;
-}
-export declare const cryptoInputParams: InputParameters;
-export interface ProviderRequestBody {
-    ids: string;
-    vs_currencies: string;
-    include_market_cap?: boolean;
-    include_24hr_vol?: boolean;
-}
-export interface ProviderResponseBody {
-    [base: string]: {
-        [quote: string]: number;
-    };
-}
-interface ResultEntryWithoutOverrides {
-    value: number;
-    params: {
-        quote: string;
-        base?: string;
-        coinid?: string;
-    };
-}
-export declare const buildBatchedRequestBody: (params: CryptoRequestParams[], config: AdapterConfig) => AxiosRequestConfig<ProviderRequestBody>;
-export declare const constructEntry: (res: AxiosResponse<ProviderResponseBody>, requestPayload: CryptoRequestParams, resultPath: string) => ResultEntryWithoutOverrides | undefined;
-export {};

package/examples/coingecko/src/endpoint/coins.d.ts

@@ -1,9 +0,0 @@
-import { AdapterEndpoint } from '../../../../../src/adapter';
-import { InputParameters } from '../../../../../src/validation';
-export declare const inputParameters: InputParameters;
-export interface CoinsResponse {
-    id: string;
-    symbol: string;
-    name: string;
-}
-export declare const endpoint: AdapterEndpoint<import("../../../../util/request").AdapterRequestData, CoinsResponse[], import("../../../../config").SettingsMap>;

package/examples/coingecko/src/endpoint/crypto-marketcap.d.ts

@@ -1,3 +0,0 @@
-import { AdapterEndpoint } from '../../../../adapter';
-import { CryptoRequestParams } from '../cryptoUtils';
-export declare const endpoint: AdapterEndpoint<CryptoRequestParams, unknown, import("../../../../config").SettingsMap>;

package/examples/coingecko/src/endpoint/crypto-volume.d.ts

@@ -1,3 +0,0 @@
-import { AdapterEndpoint } from '../../../../adapter';
-import { CryptoRequestParams } from '../cryptoUtils';
-export declare const endpoint: AdapterEndpoint<CryptoRequestParams, unknown, import("../../../../config").SettingsMap>;

package/examples/coingecko/src/endpoint/crypto.d.ts

@@ -1,3 +0,0 @@
-import { AdapterEndpoint } from '../../../../adapter';
-import { CryptoRequestParams } from '../cryptoUtils';
-export declare const endpoint: AdapterEndpoint<CryptoRequestParams, unknown, import("../../../../config").SettingsMap>;

package/examples/coingecko/src/endpoint/dominance.d.ts

@@ -1,3 +0,0 @@
-import { AdapterEndpoint } from '../../../../adapter';
-import { AdapterRequestParams } from '../globalUtils';
-export declare const endpoint: AdapterEndpoint<AdapterRequestParams, unknown, import("../../../../config").SettingsMap>;

package/examples/coingecko/src/endpoint/global-marketcap.d.ts

@@ -1,3 +0,0 @@
-import { AdapterEndpoint } from '../../../../adapter';
-import { AdapterRequestParams } from '../globalUtils';
-export declare const endpoint: AdapterEndpoint<AdapterRequestParams, unknown, import("../../../../config").SettingsMap>;

package/examples/coingecko/src/endpoint/index.d.ts

@@ -1,6 +0,0 @@
-export { endpoint as coins } from './coins';
-export { endpoint as crypto } from './crypto';
-export { endpoint as cryptoMarketcap } from './crypto-marketcap';
-export { endpoint as globalMarketcap } from './global-marketcap';
-export { endpoint as dominance } from './dominance';
-export { endpoint as cryptoVolume } from './crypto-volume';

package/examples/coingecko/src/globalUtils.d.ts

@@ -1,27 +0,0 @@
-import { AxiosRequestConfig, AxiosResponse } from 'axios';
-import { InputParameters } from '../../../validation';
-export declare const inputParameters: InputParameters;
-export interface AdapterRequestParams {
-    market: string;
-}
-export interface ProviderResponseBody {
-    data: {
-        active_cryptocurrencies: number;
-        upcoming_icos: number;
-        ongoing_icos: number;
-        ended_icos: number;
-        markets: number;
-        total_market_cap: Record<string, number>;
-        total_volume: Record<string, number>;
-        market_cap_percentage: Record<string, number>;
-        market_cap_change_percentage_24h_usd: number;
-        updated_at: number;
-    };
-}
-interface ResultEntry {
-    value: number;
-    params: AdapterRequestParams;
-}
-export declare const buildGlobalRequestBody: (apiKey?: string) => AxiosRequestConfig<never>;
-export declare const constructEntry: (res: AxiosResponse<ProviderResponseBody>, requestPayload: AdapterRequestParams, resultPath: 'total_market_cap' | 'market_cap_percentage') => ResultEntry | undefined;
-export {};

package/examples/coingecko/src/index.d.ts

@@ -1,4 +0,0 @@
-/// <reference types="node" />
-import { Adapter } from '../../../../src/adapter';
-export declare const adapter: Adapter<import("../../../config").SettingsMap>;
-export declare const server: () => Promise<import("fastify").FastifyInstance<import("fastify").RawServerDefault, import("http").IncomingMessage, import("http").ServerResponse<import("http").IncomingMessage>, import("fastify").FastifyBaseLogger, import("fastify").FastifyTypeProviderDefault> | undefined>;

package/examples/coingecko/test/e2e/adapter.test.js

@@ -1,262 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-/* eslint-disable max-nested-callbacks */
-const index_1 = require("../../src/index");
-const __1 = require("../../../..");
-const supertest_1 = __importDefault(require("supertest"));
-let adapterServer;
-function sleep(ms) {
-    // eslint-disable-next-line
-    return new Promise((resolve) => setTimeout(resolve, ms));
-}
-describe('execute', () => {
-    const id = '1';
-    let req;
-    jest.setTimeout(10000);
-    const successfulRequests = {
-        crypto: {
-            id,
-            data: {
-                base: 'ETH',
-                quote: 'USD',
-            },
-        },
-        cryptoWithCoinid: {
-            id,
-            data: {
-                coinid: 'bitcoin',
-                quote: 'USD',
-            },
-        },
-        cryptoWithOverride: {
-            id,
-            data: {
-                base: 'BTC',
-                quote: 'EUR',
-                overrides: {
-                    coingecko: {
-                        BTC: 'solana',
-                    },
-                },
-            },
-        },
-        coins: {
-            id,
-            endpoint: 'coins',
-        },
-        marketcap: {
-            id,
-            endpoint: 'marketcap',
-            data: {
-                base: 'ETH',
-                quote: 'USD',
-            },
-        },
-        volume: {
-            id,
-            endpoint: 'volume',
-            data: {
-                base: 'ETH',
-                quote: 'USD',
-            },
-        },
-        globalmarketcap: {
-            id,
-            endpoint: 'globalmarketcap',
-            data: {
-                market: 'ETH',
-            },
-        },
-        dominance: {
-            id,
-            endpoint: 'dominance',
-            data: {
-                market: 'ETH',
-            },
-        },
-    };
-    const errorRequests = {
-        cryptoWithBadSymbol: {
-            id,
-            data: {
-                base: 'ZWXK',
-                quote: 'USD',
-            },
-        },
-        cryptoWithBadOverride: {
-            id,
-            data: {
-                base: 'LINK',
-                quote: 'USD',
-                overrides: {
-                    coingecko: {
-                        LINK: 'badtokenid',
-                    },
-                },
-            },
-        },
-        dominanceWithBadSymbol: {
-            id,
-            endpoint: 'dominance',
-            data: {
-                market: 'ZWXK',
-            },
-        },
-    };
-    beforeAll(async () => {
-        try {
-            adapterServer = await (0, __1.expose)(index_1.adapter);
-            req = (0, supertest_1.default)('localhost:8080');
-        }
-        catch {
-            throw new Error('Could not start server when running CoinGecko e2e tests');
-        }
-        if (!adapterServer) {
-            throw new Error('Could not start server when running CoinGecko e2e tests');
-        }
-        // Send inital requests to warm the cache
-        const pendingRequests = [];
-        for (const reqData of Object.values(successfulRequests)) {
-            pendingRequests.push(req.post('/').send(reqData));
-        }
-        for (const reqData of Object.values(errorRequests)) {
-            pendingRequests.push(req.post('/').send(reqData));
-        }
-        // Wait for all the pending requests to be complete
-        Promise.all(pendingRequests);
-        // Sleep while the cache is filled
-        await sleep(5000);
-    });
-    afterAll((done) => {
-        if (adapterServer) {
-            adapterServer.close(done());
-        }
-    });
-    describe('crypto api', () => {
-        it('should return success', async () => {
-            // Send inital request to warm cache
-            const response = await req
-                .post('/')
-                .send(successfulRequests.crypto)
-                .set('Accept', '*/*')
-                .set('Content-Type', 'application/json')
-                .expect(200);
-            expect(response.body.result).toBeGreaterThan(0);
-        });
-        it('should return success with coinid', async () => {
-            const response = await req
-                .post('/')
-                .send(successfulRequests.cryptoWithCoinid)
-                .set('Accept', '*/*')
-                .set('Content-Type', 'application/json')
-                .expect('Content-Type', /json/)
-                .expect(200);
-            expect(response.body.result).toBeGreaterThan(0);
-        });
-        it('should return error message for bad symbol', async () => {
-            await req
-                .post('/')
-                .send(errorRequests.cryptoWithBadSymbol)
-                .set('Accept', '*/*')
-                .set('Content-Type', 'application/json')
-                .expect(504);
-        });
-        it('should return success with override', async () => {
-            const response = await req
-                .post('/')
-                .send(successfulRequests.cryptoWithOverride)
-                .set('Accept', '*/*')
-                .set('Content-Type', 'application/json')
-                .expect('Content-Type', /json/)
-                .expect(200);
-            expect(response.body.result).toBeGreaterThan(0);
-        });
-        it('should return 504 for bad override', async () => {
-            const response = await req
-                .post('/')
-                .send(errorRequests.cryptoWithBadOverride)
-                .set('Accept', '*/*')
-                .set('Content-Type', 'application/json')
-                .expect(504);
-            expect(typeof response.body.result === 'string');
-        });
-        it('should return 504 for bad symbol', async () => {
-            await req
-                .post('/')
-                .send(errorRequests.cryptoWithBadSymbol)
-                .set('Accept', '*/*')
-                .set('Content-Type', 'application/json')
-                .expect(504);
-        });
-    });
-    describe('coins api', () => {
-        it('should return success', async () => {
-            await req
-                .post('/')
-                .send(successfulRequests.coins)
-                .set('Accept', '*/*')
-                .set('Content-Type', 'application/json')
-                .expect('Content-Type', /json/)
-                .expect(200);
-        });
-    });
-    describe('volume api', () => {
-        it('should return success', async () => {
-            const response = await req
-                .post('/')
-                .send(successfulRequests.volume)
-                .set('Accept', '*/*')
-                .set('Content-Type', 'application/json')
-                .expect('Content-Type', /json/)
-                .expect(200);
-            expect(response.body.result).toBeGreaterThan(0);
-        });
-    });
-    describe('marketcap api', () => {
-        it('should return success', async () => {
-            const response = await req
-                .post('/')
-                .send(successfulRequests.marketcap)
-                .set('Accept', '*/*')
-                .set('Content-Type', 'application/json')
-                .expect('Content-Type', /json/)
-                .expect(200);
-            expect(response.body.result).toBeGreaterThan(0);
-        });
-    });
-    describe('globalmarketcap api', () => {
-        it('should return success', async () => {
-            const response = await req
-                .post('/')
-                .send(successfulRequests.globalmarketcap)
-                .set('Accept', '*/*')
-                .set('Content-Type', 'application/json')
-                .expect('Content-Type', /json/)
-                .expect(200);
-            expect(response.body.result).toBeGreaterThan(0);
-        });
-    });
-    describe('dominance api', () => {
-        it('should return success', async () => {
-            const response = await req
-                .post('/')
-                .send(successfulRequests.dominance)
-                .set('Accept', '*/*')
-                .set('Content-Type', 'application/json')
-                .expect('Content-Type', /json/)
-                .expect(200);
-            expect(response.body.result).toBeGreaterThan(0);
-        });
-        it('should return 504 for bad symbol', async () => {
-            await req
-                .post('/')
-                .send(errorRequests.dominanceWithBadSymbol)
-                .set('Accept', '*/*')
-                .set('Content-Type', 'application/json')
-                .expect(504);
-        });
-    });
-});