@chainlink/external-adapter-framework 0.0.22 → 0.0.25

package/cache/index.d.ts

@@ -1,94 +0,0 @@
-import { AdapterEndpoint } from '../adapter';
-import { AdapterConfig, SettingsMap } from '../config';
-import { AdapterMiddlewareBuilder, AdapterResponse, sleep } from '../util';
-export * from './local';
-export * from './redis';
-export * from './factory';
-/**
- * An object describing an entry in the cache.
- * @typeParam T - the type of the entry's value
- */
-export interface CacheEntry<T> {
-    key: string;
-    value: T;
-}
-/**
- * Generic interface for a local or remote Cache.
- * @typeParam T - the type of the cache entries' values
- */
-export interface Cache<T = unknown> {
-    /**
-     * Gets an item from the Cache.
-     *
-     * @param key - the key of the desired entry for which to fetch its value
-     * @returns a Promise of the entry's value, or undefined if not found / expired.
-     */
-    get: (key: string) => Promise<T | undefined>;
-    /**
-     * Sets an item in the Cache.
-     *
-     * @param key - the key of the new entry
-     * @param value - the value of the new entry
-     * @param ttl - the time in milliseconds until the entry expires
-     * @returns an empty Promise that resolves when the entry has been set
-     */
-    set: (key: string, value: T, ttl: number) => Promise<void>;
-    /**
-     * Sets a list of items in the Cache.
-     *
-     * @param entries - a list of cache entries
-     * @param ttl - the time in milliseconds until the entries expire
-     * @returns an empty Promise that resolves when all entries have been set
-     */
-    setMany: (entries: CacheEntry<T>[], ttl: number) => Promise<void>;
-    /**
-     * Deletes the specified item from the Cache
-     *
-     * @param key - the key of the entry to be deleted
-     * @returns an empty Promise that resolves when the entry has been deleted
-     */
-    delete: (key: string) => Promise<void>;
-}
-export declare const calculateCacheKey: <Params, Result, CustomSettings extends SettingsMap>({ adapterEndpoint, adapterConfig, }: {
-    adapterEndpoint: AdapterEndpoint<Params, Result, CustomSettings>;
-    adapterConfig: AdapterConfig<CustomSettings>;
-}, data: unknown) => string;
-export declare const calculateFeedId: <Params, Result, CustomSettings extends SettingsMap>({ adapterEndpoint, adapterConfig, }: {
-    adapterEndpoint: AdapterEndpoint<Params, Result, CustomSettings>;
-    adapterConfig: AdapterConfig<CustomSettings>;
-}, data: unknown) => string;
-/**
- * Calculates a unique key from the provided data.
- *
- * @param data - the request data/body, i.e. the adapter input params
- * @param paramNames - the keys from adapter endpoint input parameters
- * @returns the calculated unique key
- *
- * @example
- * ```
- * calculateKey({ base: 'ETH', quote: 'BTC' }, ['base','quote'])
- * // equals `|base:eth|quote:btc`
- * ```
- */
-export declare const calculateKey: <CustomSettings extends SettingsMap>(data: unknown, paramNames: string[], adapterConfig: AdapterConfig<CustomSettings>) => string;
-/**
- * Polls the provided Cache for an AdapterResponse set in the provided key. If the maximum
- * amount of retries is exceeded, it returns undefined instead.
- *
- * @param cache - a Cache instance
- * @param key - the key generated from an AdapterRequest that corresponds to the desired AdapterResponse
- * @param retry - current retry, only for internal use
- * @returns the AdapterResponse if found, else undefined
- */
-export declare const pollResponseFromCache: (cache: Cache<AdapterResponse>, key: string, options: {
-    maxRetries: number;
-    sleep: number;
-}, retry?: number) => Promise<AdapterResponse | undefined>;
-/**
- * Given a Cache instance in the adapter dependencies, builds a middleware function that will perform
- * a get from said Cache and return that if found; otherwise it'll continue the middleware chain.
- *
- * @param adapter - an initialized adapter
- * @returns the cache middleware function
- */
-export declare const buildCacheMiddleware: AdapterMiddlewareBuilder;

package/cache/local.d.ts

@@ -1,23 +0,0 @@
-import { Cache, CacheEntry } from './index';
-/**
- * Type for a value stored in a LocalCache entry.
- *
- * @typeParam T - the type for the entry's value
- */
-export interface LocalCacheEntry<T> {
-    expirationTimestamp: number;
-    value: T;
-}
-/**
- * Local implementation of a Cache. It uses a simple js Object, storing entries with both
- * a value and an expiration timestamp. Expired entries are deleted on reads (i.e. no background gc/upkeep).
- *
- * @typeParam T - the type for the entries' values
- */
-export declare class LocalCache<T = unknown> implements Cache<T> {
-    store: Record<string, LocalCacheEntry<T>>;
-    get(key: string): Promise<T | undefined>;
-    delete(key: string): Promise<void>;
-    set(key: string, value: T, ttl: number): Promise<void>;
-    setMany(entries: CacheEntry<T>[], ttl: number): Promise<void>;
-}

package/cache/metrics.d.ts

@@ -1,27 +0,0 @@
-import * as client from 'prom-client';
-interface CacheMetricsLabels {
-    participant_id: string;
-    feed_id: string;
-    cache_type: string;
-}
-export declare const cacheGet: (label: CacheMetricsLabels, value: unknown, staleness: number) => void;
-export declare const cacheSet: (label: CacheMetricsLabels, maxAge: number) => void;
-export declare const cacheMetricsLabel: (cacheKey: string, feedId: string, cacheType: string) => {
-    participant_id: string;
-    feed_id: string;
-    cache_type: string;
-};
-export declare enum CacheTypes {
-    Redis = "redis",
-    Local = "local"
-}
-export declare enum CMD_SENT_STATUS {
-    TIMEOUT = "TIMEOUT",
-    FAIL = "FAIL",
-    SUCCESS = "SUCCESS"
-}
-export declare const redisConnectionsOpen: client.Counter<string>;
-export declare const redisRetriesCount: client.Counter<string>;
-export declare const redisCommandsSentCount: client.Counter<"status" | "function_name">;
-export declare const cacheWarmerCount: client.Gauge<"isBatched">;
-export {};

package/cache/redis.d.ts

@@ -1,16 +0,0 @@
-import Redis from 'ioredis';
-import { Cache, CacheEntry } from './index';
-/**
- * Redis implementation of a Cache. It uses a simple js Object, storing entries with both
- * a value and an expiration timestamp. Expired entries are deleted on reads (i.e. no background gc/upkeep).
- *
- * @typeParam T - the type for the entries' values
- */
-export declare class RedisCache<T = unknown> implements Cache<T> {
-    private client;
-    constructor(client: Redis);
-    get(key: string): Promise<T | undefined>;
-    delete(key: string): Promise<void>;
-    set(key: string, value: T, ttl: number): Promise<void>;
-    setMany(entries: CacheEntry<T>[], ttl: number): Promise<void>;
-}

package/config/index.d.ts

@@ -1,258 +0,0 @@
-export declare const BaseSettings: {
-    readonly API_ENDPOINT: {
-        readonly description: "The URL that certain transports use to retrieve data";
-        readonly type: "string";
-    };
-    readonly API_KEY: {
-        readonly description: "Default setting for an EA key";
-        readonly type: "string";
-    };
-    readonly API_TIMEOUT: {
-        readonly description: "The number of milliseconds a request can be pending before returning a timeout error for data provider request";
-        readonly type: "number";
-        readonly default: 30000;
-    };
-    readonly API_VERBOSE: {
-        readonly description: "Toggle whether the response from the EA should contain just the results or also include the full response body from the queried API.";
-        readonly type: "boolean";
-        readonly default: false;
-    };
-    readonly BASE_URL: {
-        readonly description: "Starting path for the EA handler endpoint";
-        readonly type: "string";
-        readonly default: "/";
-    };
-    readonly CACHE_MAX_AGE: {
-        readonly description: "Maximum amount of time (in ms) that a response will stay cached";
-        readonly type: "number";
-        readonly default: 90000;
-    };
-    readonly CACHE_REDIS_HOST: {
-        readonly description: "Hostname for the Redis instance to be used";
-        readonly type: "string";
-        readonly default: "127.0.0.1";
-    };
-    readonly CACHE_REDIS_PASSWORD: {
-        readonly description: "The password required for redis auth";
-        readonly type: "string";
-    };
-    readonly CACHE_REDIS_PATH: {
-        readonly description: "The UNIX socket string of the Redis server";
-        readonly type: "string";
-    };
-    readonly CACHE_REDIS_PORT: {
-        readonly description: "Port for the Redis instance to be used";
-        readonly type: "number";
-        readonly default: 6379;
-    };
-    readonly CACHE_REDIS_TIMEOUT: {
-        readonly description: "Timeout to fail a Redis server request if no response (ms)";
-        readonly type: "number";
-        readonly default: 500;
-    };
-    readonly CACHE_TYPE: {
-        readonly description: "The type of cache to use throughout the EA";
-        readonly type: "enum";
-        readonly default: "local";
-        readonly options: readonly ["local", "redis"];
-    };
-    readonly CORRELATION_ID_ENABLED: {
-        readonly description: "Flag to enable correlation IDs for sent requests in logging";
-        readonly type: "boolean";
-        readonly default: true;
-    };
-    readonly DEBUG: {
-        readonly description: "Toggles debug mode";
-        readonly type: "boolean";
-        readonly default: false;
-    };
-    readonly EA_PORT: {
-        readonly description: "Port through which the EA will listen for REST requests (if mode is set to \"reader\" or \"reader-writer\")";
-        readonly type: "number";
-        readonly default: 8080;
-    };
-    readonly EXPERIMENTAL_METRICS_ENABLED: {
-        readonly description: "Flag to specify whether or not to collect metrics. Used as fallback for METRICS_ENABLED";
-        readonly type: "boolean";
-        readonly default: true;
-    };
-    readonly LOG_LEVEL: {
-        readonly description: "Minimum level required for logs to be output";
-        readonly type: "string";
-        readonly default: "info";
-    };
-    readonly METRICS_ENABLED: {
-        readonly description: "Flag to specify whether or not to startup the metrics server";
-        readonly type: "boolean";
-        readonly default: true;
-    };
-    readonly METRICS_NAME: {
-        readonly description: "Metrics name";
-        readonly type: "string";
-    };
-    readonly METRICS_PORT: {
-        readonly description: "Port metrics will be exposed to";
-        readonly type: "number";
-        readonly default: 9080;
-    };
-    readonly METRICS_USE_BASE_URL: {
-        readonly description: "Flag to specify whether or not to prepend the BASE_URL to the metrics endpoint";
-        readonly type: "boolean";
-    };
-    readonly RATE_LIMIT_API_TIER: {
-        readonly description: "Rate limiting tier to use from the available options for the adapter. If not present, the adapter will run using the first tier on the list.";
-        readonly type: "string";
-    };
-    readonly RATE_LIMIT_CAPACITY: {
-        readonly description: "Used as rate limit capacity per minute and ignores tier settings if defined";
-        readonly type: "number";
-    };
-    readonly RATE_LIMIT_CAPACITY_MINUTE: {
-        readonly description: "Used as rate limit capacity per minute and ignores tier settings if defined. Supercedes RATE_LIMIT_CAPACITY if both vars are set";
-        readonly type: "number";
-    };
-    readonly RATE_LIMIT_CAPACITY_SECOND: {
-        readonly description: "Used as rate limit capacity per second and ignores tier settings if defined";
-        readonly type: "number";
-    };
-    readonly REQUEST_COALESCING_ENABLED: {
-        readonly description: "Enable request coalescing";
-        readonly type: "boolean";
-    };
-    readonly WARMUP_SUBSCRIPTION_TTL: {
-        readonly type: "number";
-        readonly description: "TTL for batch warmer subscriptions";
-        readonly default: 10000;
-    };
-    readonly WS_SUBSCRIPTION_TTL: {
-        readonly description: "";
-        readonly type: "number";
-        readonly default: 120000;
-    };
-    readonly CACHE_POLLING_MAX_RETRIES: {
-        readonly description: "Max amount of times to attempt to find EA response in the cache after the Transport has been set up";
-        readonly type: "number";
-        readonly default: 10;
-    };
-    readonly CACHE_POLLING_SLEEP_MS: {
-        readonly description: "The number of ms to sleep between each retry to fetch the EA response in the cache";
-        readonly type: "number";
-        readonly default: 200;
-    };
-    readonly DEFAULT_CACHE_KEY: {
-        readonly description: "Default key to be used when one cannot be determined from request parameters";
-        readonly type: "string";
-        readonly default: "DEFAULT_CACHE_KEY";
-    };
-    readonly EA_HOST: {
-        readonly description: "Host this EA will listen for REST requests on (if mode is set to \"reader\" or \"reader-writer\")";
-        readonly type: "string";
-        readonly default: "::";
-    };
-    readonly EA_MODE: {
-        readonly description: "Port this EA will listen for REST requests on (if mode is set to \"reader\" or \"reader-writer\")";
-        readonly type: "enum";
-        readonly default: "reader-writer";
-        readonly options: readonly ["reader", "writer", "reader-writer"];
-    };
-    readonly MAX_COMMON_KEY_SIZE: {
-        readonly description: "Maximum amount of characters that the common part of the cache key or feed ID can have";
-        readonly type: "number";
-        readonly default: 300;
-        readonly validate: (value?: number) => "MAX_COMMON_KEY_SIZE must be a number between 150 and 500" | undefined;
-    };
-    readonly REST_TRANSPORT_MAX_RATE_LIMIT_RETRIES: {
-        readonly description: "Maximum amount of times the Rest Transport will attempt to set up a request when blocked by the rate limiter";
-        readonly type: "number";
-        readonly default: 3;
-    };
-    readonly REST_TRANSPORT_MS_BETWEEN_RATE_LIMIT_RETRIES: {
-        readonly description: "Time that the Rest Transport will wait between retries when blocked by the rate limiter";
-        readonly type: "number";
-        readonly default: 400;
-    };
-    readonly SMOKE_TEST_PAYLOAD_FILE_NAME: {
-        readonly description: "Name of the test payload file used for the smoke endpoint";
-        readonly type: "string";
-    };
-};
-export declare const buildAdapterConfig: <CustomSettings extends CustomSettingsType<CustomSettings> = EmptySettings>({ overrides, customSettings, }: {
-    overrides?: Partial<BaseAdapterConfig> | undefined;
-    customSettings?: SettingsMap | undefined;
-}) => AdapterConfig<CustomSettings>;
-declare type SettingValueType = string | number | boolean;
-declare type SettingType<C extends Setting> = C['type'] extends 'string' ? string : C['type'] extends 'number' ? number : C['type'] extends 'boolean' ? boolean : C['type'] extends 'enum' ? C['options'] extends readonly string[] ? C['options'][number] : never : never;
-declare type BaseSettingsType = typeof BaseSettings;
-export declare type Setting = {
-    type: 'string';
-    description: string;
-    options?: never;
-    default?: string;
-    validate?: (value?: string) => ValidationErrorMessage;
-    required?: false;
-} | {
-    type: 'string';
-    description: string;
-    options?: never;
-    default?: string;
-    validate?: (value: string) => ValidationErrorMessage;
-    required: true;
-} | {
-    type: 'number';
-    description: string;
-    options?: never;
-    default?: number;
-    validate?: (value?: number) => ValidationErrorMessage;
-    required?: false;
-} | {
-    type: 'number';
-    description: string;
-    options?: never;
-    default?: number;
-    validate?: (value: number) => ValidationErrorMessage;
-    required: true;
-} | {
-    type: 'boolean';
-    description: string;
-    options?: never;
-    default?: boolean;
-    validate?: (value?: boolean) => ValidationErrorMessage;
-    required?: false;
-} | {
-    type: 'boolean';
-    description: string;
-    options?: never;
-    default?: boolean;
-    validate?: (value: boolean) => ValidationErrorMessage;
-    required: true;
-} | {
-    type: 'enum';
-    description: string;
-    default?: string;
-    options: readonly string[];
-    validate?: (value?: string) => ValidationErrorMessage;
-    required?: false;
-} | {
-    type: 'enum';
-    description: string;
-    default?: string;
-    options: readonly string[];
-    validate?: (value: string) => ValidationErrorMessage;
-    required: true;
-};
-export declare type AdapterConfigFromSettings<T extends SettingsMap> = {
-    -readonly [K in keyof T as T[K] extends {
-        default: SettingValueType;
-    } ? K : T[K]['required'] extends true ? K : never]: SettingType<T[K]>;
-} & {
-    -readonly [K in keyof T as T[K] extends {
-        default: SettingValueType;
-    } ? never : T[K]['required'] extends true ? never : K]?: SettingType<T[K]> | undefined;
-};
-export declare type BaseAdapterConfig = AdapterConfigFromSettings<BaseSettingsType>;
-export declare type AdapterConfig<T extends CustomSettingsType<T> = SettingsMap> = AdapterConfigFromSettings<T> & BaseAdapterConfig;
-export declare type CustomSettingsType<T = SettingsMap> = Record<keyof T, Setting>;
-export declare type EmptySettings = Record<string, never>;
-export declare type SettingsMap = Record<string, Setting>;
-export declare type ValidationErrorMessage = string | undefined;
-export {};

package/config/provider-limits.d.ts

@@ -1,27 +0,0 @@
-export declare const DEFAULT_MINUTE_RATE_LIMIT = 60;
-export declare const BURST_UNDEFINED_QUOTA_MULTIPLE = 2;
-export declare const DEFAULT_WS_CONNECTIONS = 2;
-export declare const DEFAULT_WS_SUBSCRIPTIONS = 10;
-declare type RateLimitTimeFrame = 'rateLimit1s' | 'rateLimit1m' | 'rateLimit1h';
-declare type HTTPTier = {
-    rateLimit1s?: number;
-    rateLimit1m?: number;
-    rateLimit1h?: number;
-    note?: string;
-};
-declare type WSTier = {
-    connections: number;
-    subscriptions: number;
-};
-export interface Limits {
-    http: Record<string, HTTPTier>;
-    ws: Record<string, WSTier>;
-}
-interface ProviderRateLimit {
-    second: number;
-    minute: number;
-}
-export declare const getHTTPLimit: (provider: string, limits: Limits, tier: string, timeframe: RateLimitTimeFrame) => number;
-export declare const getRateLimit: (provider: string, limits: Limits, tier: string) => ProviderRateLimit;
-export declare const getWSLimits: (provider: string, limits: Limits, tier: string) => WSTier;
-export {};

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

@@ -1,39 +0,0 @@
-import { AxiosRequestConfig, AxiosResponse } from 'axios';
-import { AdapterInputParameters, BankFrickAccountsRequestSchema, BankFrickAccountsResponseSchema, SigningAlgorithm } from './types';
-import { customSettings } from './config';
-import { Transport } from '../../transports';
-import { AdapterRequest, AdapterResponse } from '../../util';
-import { AdapterConfig } from '../../config';
-import { Cache } from '../../cache';
-import { AdapterDependencies, AdapterEndpoint } from '../../adapter';
-/**
- * RestTransport implementation for Bank Frick, which has unusually complex requirements for an EA
- * The RestTransport is generally built to make a single request and return a single response.
- * This transport instead is used to fetch and process pages of data, and also requires a JWT to run
- *
- * This transport does all the heavy lifting in setup(), which is where the paging happens, and it
- * also has complex retry logic that will attempt to refresh the JWT when certain HTTP errors occur
- */
-export declare class BankFrickAccountsTransport implements Transport<AdapterInputParameters, number, typeof customSettings> {
-    token: string;
-    cache: Cache;
-    initialize(dependencies: AdapterDependencies): Promise<void>;
-    hasBeenSetUp(): Promise<boolean>;
-    /**
-     * Creates an AxiosRequestConfig object for fetching a page of accounts from the Bank Frick API
-     */
-    prepareRequest(firstPosition: number, inputParams: AdapterInputParameters, config: AdapterConfig<typeof customSettings>): AxiosRequestConfig<BankFrickAccountsRequestSchema>;
-    /**
-     * Request with retry logic for Bank Frick's API. In addition to standard retry logic, this function
-     * compares errors against expected errors from the Bank Frick API, and will throw without retries
-     * on a known fatal error, or try to refresh the JWT on a known auth error
-     **/
-    makeRequest(axiosRequest: AxiosRequestConfig<BankFrickAccountsRequestSchema>, config: AdapterConfig<typeof customSettings>, signingAlgorithm?: SigningAlgorithm): Promise<AxiosResponse<BankFrickAccountsResponseSchema>>;
-    validateInputParams(params: AdapterInputParameters): string[];
-    /**
-     * Fetches pages of data from the Bank Frick API, scans for accounts by IBAN, and returns the balance
-     * of all found accounts. Returns a 404 if any IBAN isn't found.
-     */
-    setup(req: AdapterRequest<AdapterInputParameters>, config: AdapterConfig<typeof customSettings>): Promise<AdapterResponse<number>>;
-}
-export declare const accountsRestEndpoint: AdapterEndpoint<AdapterInputParameters, number, import("../../config").SettingsMap>;

package/examples/bank-frick/config/index.d.ts

@@ -1,4 +0,0 @@
-import { SettingsMap } from '../../../config';
-import { SigningAlgorithm } from '../types';
-export declare const signingAlgorithms: SigningAlgorithm[];
-export declare const customSettings: SettingsMap;

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

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

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";