@oomol-lab/open-connector 1.9.1 → 1.9.3

package/src/providers/defillama/shared-schemas.d.ts

@@ -0,0 +1,71 @@
+import type { JsonSchema } from "../../core/types.ts";
+export declare const dividendYieldSchema: JsonSchema;
+export declare const priceChangePercentage1ySchema: JsonSchema;
+export declare const priceChangePercentage7dSchema: JsonSchema;
+export declare const priceChangePercentage1mSchema: JsonSchema;
+export declare const coinsSchema: JsonSchema;
+export declare const sectorSlugSchema: JsonSchema;
+export declare const priceToRevenueSchema: JsonSchema;
+export declare const enterpriseValueToEbitdaSchema: JsonSchema;
+export declare const pricePerShareSchema: JsonSchema;
+export declare const confidenceSchema: JsonSchema;
+export declare const rangeSchema: JsonSchema;
+export declare const updatedAtSchema: JsonSchema;
+export declare const decimalsSchema: JsonSchema;
+export declare const protocolEntrySchema: JsonSchema;
+export declare const totalSchema: JsonSchema;
+export declare const priceChangePercentage3mSchema: JsonSchema;
+export declare const priceChangePercentage6mSchema: JsonSchema;
+export declare const rewardSchema: JsonSchema;
+export declare const dollarVolumeShare24hSchema: JsonSchema;
+export declare const priceToBookSchema: JsonSchema;
+export declare const priceChangePercentage1dSchema: JsonSchema;
+export declare const linkedProtocolsSchema: JsonSchema;
+export declare const chainSchema: JsonSchema;
+export declare const amountSchema: JsonSchema;
+export declare const employeeCountSchema: JsonSchema;
+export declare const usdSchema: JsonSchema;
+export declare const categoriesValueSchema: JsonSchema;
+export declare const githubSchema: JsonSchema;
+export declare const categorySchema: JsonSchema;
+export declare const dataTypeSchema: JsonSchema;
+export declare const companySchema: JsonSchema;
+export declare const operatingProfitMarginTTMSchema: JsonSchema;
+export declare const chainsSchema: JsonSchema;
+export declare const allChainsSchema: JsonSchema;
+export declare const chartBreakdownValuesSchema: JsonSchema;
+export declare const leadInvestorsSchema: JsonSchema;
+export declare const totalDataChartSchema: JsonSchema;
+export declare const otherInvestorsSchema: JsonSchema;
+export declare const sectorSchema: JsonSchema;
+export declare const marketCapChange1dSchema: JsonSchema;
+export declare const valuesEntrySchema: JsonSchema;
+export declare const totalDataChartBreakdownSchema: JsonSchema;
+export declare const holdersYieldSchema: JsonSchema;
+export declare const breakdownSchema: JsonSchema;
+export declare const chainTvlsSchema: JsonSchema;
+export declare const periodEndingSchema: JsonSchema;
+export declare const countrySchema: JsonSchema;
+export declare const currentChainTvlsSchema: JsonSchema;
+export declare const childProtocolsSchema: JsonSchema;
+export declare const unstructuredChartResponseSchema: JsonSchema;
+export declare const earningsYieldSchema: JsonSchema;
+export declare const trailingPESchema: JsonSchema;
+export declare const totalCirculatingSchema: JsonSchema;
+export declare const dollarVolume24hSchema: JsonSchema;
+export declare const metricSchema: JsonSchema;
+export declare const valuesSchema: JsonSchema;
+export declare const annualValueSchema: JsonSchema;
+export declare const keySchema: JsonSchema;
+export declare const childrenValueSchema: JsonSchema;
+export declare const timeSeriesResponseSchema: JsonSchema;
+export declare const underlyingTokensEntrySchema: JsonSchema;
+export declare const sourcePoolSchema: JsonSchema;
+export declare const coverageSchema: JsonSchema;
+export declare const breakdownChartResponseSchema: JsonSchema;
+export declare const currentSchema: JsonSchema;
+export declare const avg7dSchema: JsonSchema;
+export declare const avg30dSchema: JsonSchema;
+export declare const childrenSchema: JsonSchema;
+export declare const apySchema: JsonSchema;
+export declare const byChainValueSchema: JsonSchema;

package/src/providers/defillama/shared-schemas.js

@@ -0,0 +1,157 @@
+import { s } from "../../core/json-schema.js";
+export const dividendYieldSchema = s.nullable(s.number("100 × total TTM dividends / total market cap, in percent."));
+export const priceChangePercentage1ySchema = s.nullable(s.number("Cap-weighted price change over the last year, in percent."));
+export const priceChangePercentage7dSchema = s.nullable(s.number("Cap-weighted price change over the last 7 days, in percent."));
+export const priceChangePercentage1mSchema = s.nullable(s.number("Cap-weighted price change over the last 30 days, in percent."));
+export const coinsSchema = s.string("set of comma-separated tokens defined as {chain}:{address}", {
+    minLength: 1,
+});
+export const sectorSlugSchema = s.string("URL-safe sector id. Pass it as `sector` to the other equities endpoints.");
+export const priceToRevenueSchema = s.nullable(s.number("Aggregate price to sales: total market cap / total TTM revenue."));
+export const enterpriseValueToEbitdaSchema = s.nullable(s.number("Aggregate EV/EBITDA: total enterprise value / total TTM EBITDA."));
+export const pricePerShareSchema = s.nullable(s.number("Pool token price per share for vault-style pools; null otherwise"));
+export const confidenceSchema = s.number("Confidence score between 0 and 1 indicating the reliability of the price.");
+export const rangeSchema = s.withEnum(s.string("History window; defaults to max (the full series)"), [
+    "30d",
+    "90d",
+    "max",
+]);
+export const updatedAtSchema = s.nullable(s.string("Most recent quote time across the constituents.", { format: "date-time" }));
+export const decimalsSchema = s.number("Token decimals. Omitted for coingecko-native assets (e.g. coingecko:ethereum).");
+export const protocolEntrySchema = s.object("Result entry returned by DeFiLlama.", {}, { required: [], additionalProperties: true });
+export const totalSchema = s.nullable(s.number("base minus reward, in percent; negative means the borrower is net paid"));
+export const priceChangePercentage3mSchema = s.nullable(s.number("Cap-weighted price change over the last 3 calendar months, in percent."));
+export const priceChangePercentage6mSchema = s.nullable(s.number("Cap-weighted price change over the last 6 calendar months, in percent."));
+export const rewardSchema = s.nullable(s.number("APY in percent from incentive token emissions; null when there are none"));
+export const dollarVolumeShare24hSchema = s.nullable(s.number("Share of all tracked US value traded in the latest session, in percent."));
+export const priceToBookSchema = s.nullable(s.number("Aggregate price to book: total market cap / total shareholders' equity."));
+export const priceChangePercentage1dSchema = s.nullable(s.number("Cap-weighted price change over the latest session, in percent (`0.86` is +0.86%)."));
+export const linkedProtocolsSchema = s.array("Linked protocols", s.string("Result entry returned by DeFiLlama."));
+export const chainSchema = s.string("chain slug, you can get these from /chains or the chains property on /protocols", { minLength: 1 });
+export const amountSchema = s.nullable(s.string("Raw base units of `denomination`, as a decimal string; parse with BigInt, not Number."));
+export const employeeCountSchema = s.nullable(s.number("Total employees across the constituents that report a headcount. `null` when none do."));
+export const usdSchema = s.nullable(s.number("Capacity in USD. Null when `denomination` is, since the conversion needs its decimals."));
+export const categoriesValueSchema = s.array("Value for this key.", s.string("Result entry returned by DeFiLlama."));
+export const githubSchema = s.array("GitHub repositories", s.string("Result entry returned by DeFiLlama."));
+export const categorySchema = s.string("category slug (slugified category name, e.g. 'dexs', 'prediction-market', 'options')", { minLength: 1 });
+export const dataTypeSchema = s.withEnum(s.string("Desired data type, dailyNotionalVolume by default."), [
+    "dailyPremiumVolume",
+    "dailyNotionalVolume",
+]);
+export const companySchema = s.string("Company id from `GET /pre-ipo/v1/companies-list` (case-insensitive). The display `name` is not accepted.");
+export const operatingProfitMarginTTMSchema = s.nullable(s.number("Total TTM operating income / total TTM revenue, in percent. Weighted by revenue, not market cap."));
+export const chainsSchema = s.array("chains returned by DeFiLlama.", s.string("Result entry returned by DeFiLlama."));
+const labelsSchema = s.array("labels returned by DeFiLlama.", s.string("Result entry returned by DeFiLlama."));
+export const allChainsSchema = s.array("allChains returned by DeFiLlama.", s.string("Result entry returned by DeFiLlama."));
+export const chartBreakdownValuesSchema = s.object("Value for this key.", {}, { required: [], additionalProperties: s.number("Value for this key.") });
+const assetIssuersSchema = s.array("assetIssuers returned by DeFiLlama.", s.string("Result entry returned by DeFiLlama."));
+export const leadInvestorsSchema = s.array("leadInvestors returned by DeFiLlama.", s.string("Result entry returned by DeFiLlama."));
+export const totalDataChartSchema = s.array("totalDataChart returned by DeFiLlama.", s.array("Result entry returned by DeFiLlama.", {}));
+export const otherInvestorsSchema = s.array("otherInvestors returned by DeFiLlama.", s.string("Result entry returned by DeFiLlama."));
+export const sectorSchema = s.string("Sector name as the data vendor labels it (not GICS). Companies the vendor left unclassified roll up into `Unknown`.");
+export const marketCapChange1dSchema = s.nullable(s.number("Change in total market cap over the latest session, in USD. Reconciles exactly with `priceChangePercentage1d`."));
+export const valuesEntrySchema = s.array("Result entry returned by DeFiLlama.", s.nullable(s.number("Result entry returned by DeFiLlama.")));
+export const totalDataChartBreakdownSchema = s.array("totalDataChartBreakdown returned by DeFiLlama.", s.array("Result entry returned by DeFiLlama.", {}));
+export const holdersYieldSchema = s.nullable(s.number("100 × total TTM holders' revenue (dividends plus buybacks, net of share issuance) / total market cap, in percent."));
+export const breakdownSchema = s.object("breakdown returned by DeFiLlama.", {}, { required: [], additionalProperties: s.string("Value for this key.") });
+export const chainTvlsSchema = s.object("chainTvls returned by DeFiLlama.", {}, { required: [], additionalProperties: s.number("Value for this key.") });
+export const periodEndingSchema = s.array("periodEnding returned by DeFiLlama.", s.string("Result entry returned by DeFiLlama.", { format: "date" }));
+export const countrySchema = s.string("Two-letter country code (ISO 3166-1 alpha-2) for the company, as returned by `GET /equities/v1/companies-list` (case-insensitive).");
+export const currentChainTvlsSchema = s.object("currentChainTvls returned by DeFiLlama.", {}, { required: [], additionalProperties: s.number("Value for this key.") });
+export const childProtocolsSchema = s.array("Child protocols", protocolEntrySchema);
+const dataEntrySchema = s.array("Result entry returned by DeFiLlama.", s.number("Result entry returned by DeFiLlama."), { minItems: 2, maxItems: 2 });
+export const unstructuredChartResponseSchema = s.object("DeFiLlama result.", { data: s.array("DeFiLlama response.", {}) }, { required: ["data"], additionalProperties: true });
+export const earningsYieldSchema = s.nullable(s.number("100 × total TTM earnings / total market cap, in percent. Signed, so it stays defined when `trailingPE` is `null` for a loss-making group."));
+export const trailingPESchema = s.nullable(s.number("Aggregate price to earnings: total market cap / total TTM earnings. `null` when total earnings are zero or negative; use `earningsYield` then."));
+export const totalCirculatingSchema = s.object("totalCirculating returned by DeFiLlama.", { peggedUSD: s.number("peggedUSD returned by DeFiLlama.") }, { required: [], additionalProperties: true });
+export const dollarVolume24hSchema = s.nullable(s.number("Value traded in the latest session (shares traded × price, summed), in USD. Reads low while a session is still open; `volumeAsOf` says when it was taken."));
+export const metricSchema = s.withEnum(s.string("The dimension metric type", { minLength: 1 }), [
+    "fees",
+    "liquidations",
+    "dexs",
+    "derivatives",
+    "options",
+    "aggregators",
+    "bridge-aggregators",
+    "open-interest",
+    "normalized-volume",
+    "active-users",
+]);
+export const valuesSchema = s.array("values returned by DeFiLlama.", valuesEntrySchema);
+const dataSchema = s.array("DeFiLlama response.", dataEntrySchema);
+export const annualValueSchema = s.object("Value for this key.", { labels: labelsSchema }, { required: [], additionalProperties: true });
+export const keySchema = s.withEnum(s.string('Metric to return. Omit for default TVL. Use "all" for the sum of tvl+borrowed+staking+pool2+vesting, or a specific metric like "staking", "borrowed", "vesting", "pool2".'), ["all", "staking", "borrowed", "vesting", "pool2"]);
+export const childrenValueSchema = s.object("Value for this key.", { values: valuesSchema }, { required: [], additionalProperties: true });
+export const timeSeriesResponseSchema = s.object("DeFiLlama result.", { data: dataSchema }, { required: ["data"], additionalProperties: true });
+export const underlyingTokensEntrySchema = s.object("Result entry returned by DeFiLlama.", {
+    address: s.string("address returned by DeFiLlama."),
+    symbol: s.nullable(s.string("symbol returned by DeFiLlama.")),
+    decimals: s.nullable(s.integer("decimals returned by DeFiLlama.")),
+}, { required: [], additionalProperties: true });
+export const sourcePoolSchema = s.object("source_pool returned by DeFiLlama.", {
+    id: s.string("Earn pool the intrinsic yield is sourced from"),
+    pool_token: s.string("Address of the yield-bearing token"),
+    symbol: s.nullable(s.string("symbol returned by DeFiLlama.")),
+}, { required: [], additionalProperties: true });
+export const coverageSchema = s.object("Share of the constituents' market cap that supplied each metric's inputs, from 0 to 1, keyed by metric name. A ratio is served as `null` when its coverage is below 0.6, rather than as a figure computed over the wrong subset.", {}, {
+    required: [],
+    additionalProperties: s.number("Value for this key.", { minimum: 0, maximum: 1 }),
+});
+export const breakdownChartResponseSchema = s.object("DeFiLlama result.", {
+    data: s.array("DeFiLlama response.", s.object("Result entry returned by DeFiLlama.", { timestamp: s.number("Unix timestamp") }, { required: [], additionalProperties: s.number("Value for this key.") })),
+}, { required: ["data"], additionalProperties: true });
+export const currentSchema = s.object("Latest observed values", {
+    base: s.nullable(s.number("Organic APY in percent, excluding incentive rewards")),
+    reward: rewardSchema,
+    total: s.nullable(s.number("base plus reward, in percent")),
+}, { required: [], additionalProperties: true });
+export const avg7dSchema = s.object("Trailing 7-day average", {
+    base: s.nullable(s.number("Organic APY in percent, excluding incentive rewards")),
+    reward: rewardSchema,
+    total: s.nullable(s.number("base plus reward, in percent")),
+}, { required: [], additionalProperties: true });
+export const avg30dSchema = s.object("Trailing 30-day average", {
+    base: s.nullable(s.number("Organic APY in percent, excluding incentive rewards")),
+    reward: rewardSchema,
+    total: s.nullable(s.number("base plus reward, in percent")),
+}, { required: [], additionalProperties: true });
+export const childrenSchema = s.object("children returned by DeFiLlama.", {}, { required: [], additionalProperties: childrenValueSchema });
+const governanceOnlySchema = s.object("governanceOnly returned by DeFiLlama.", {
+    onChainMcap: s.number("onChainMcap returned by DeFiLlama."),
+    activeMcap: s.number("activeMcap returned by DeFiLlama."),
+    defiActiveTvl: s.number("defiActiveTvl returned by DeFiLlama."),
+    assetCount: s.integer("assetCount returned by DeFiLlama."),
+    assetIssuers: assetIssuersSchema,
+}, { required: [], additionalProperties: true });
+const stablecoinsOnlySchema = s.object("stablecoinsOnly returned by DeFiLlama.", {
+    onChainMcap: s.number("onChainMcap returned by DeFiLlama."),
+    activeMcap: s.number("activeMcap returned by DeFiLlama."),
+    defiActiveTvl: s.number("defiActiveTvl returned by DeFiLlama."),
+    assetCount: s.integer("assetCount returned by DeFiLlama."),
+    assetIssuers: assetIssuersSchema,
+}, { required: [], additionalProperties: true });
+const stablecoinsAndGovernanceSchema = s.object("stablecoinsAndGovernance returned by DeFiLlama.", {
+    onChainMcap: s.number("onChainMcap returned by DeFiLlama."),
+    activeMcap: s.number("activeMcap returned by DeFiLlama."),
+    defiActiveTvl: s.number("defiActiveTvl returned by DeFiLlama."),
+    assetCount: s.integer("assetCount returned by DeFiLlama."),
+    assetIssuers: assetIssuersSchema,
+}, { required: [], additionalProperties: true });
+export const apySchema = s.object("Intrinsic APY in percent", {
+    current: s.object("Latest observed value", { base: s.nullable(s.number("base returned by DeFiLlama.")) }, { required: [], additionalProperties: true }),
+    avg_7d: s.object("Trailing 7-day average", { base: s.nullable(s.number("base returned by DeFiLlama.")) }, { required: [], additionalProperties: true }),
+    avg_30d: s.object("Trailing 30-day average", { base: s.nullable(s.number("base returned by DeFiLlama.")) }, { required: [], additionalProperties: true }),
+}, { required: [], additionalProperties: true });
+const baseSchema = s.object("Default RWA bucket. The chain table uses this bucket unless stablecoins or governance assets are explicitly included.", {
+    onChainMcap: s.number("onChainMcap returned by DeFiLlama."),
+    activeMcap: s.number("activeMcap returned by DeFiLlama."),
+    defiActiveTvl: s.number("defiActiveTvl returned by DeFiLlama."),
+    assetCount: s.integer("assetCount returned by DeFiLlama."),
+    assetIssuers: assetIssuersSchema,
+}, { required: [], additionalProperties: true });
+export const byChainValueSchema = s.object("Value for this key.", {
+    base: baseSchema,
+    stablecoinsOnly: stablecoinsOnlySchema,
+    governanceOnly: governanceOnlySchema,
+    stablecoinsAndGovernance: stablecoinsAndGovernanceSchema,
+}, { required: [], additionalProperties: true });

package/src/providers/defillama/tvl-definitions.d.ts

@@ -0,0 +1,2 @@
+import type { DefillamaDefinition } from "./actions.ts";
+export declare const tvlDefinitions: DefillamaDefinition[];