History & Events

import { GearboxSDK } from "@gearbox-protocol/sdk/official";

const sdk = await GearboxSDK.init({
  chains: [1, 42161],
  startFromCache: true,
});

// APY history for a pool over the last 90 days
const apyHistory = await sdk.history.getMetric({
  entity: poolAddress,
  chainId: 1,
  metric: "apy",
  period: "90d",
});

for (const point of apyHistory.data) {
  console.log(`${point.date}: ${point.value}%`);
}

const [apy, utilization, tvl] = await Promise.all([
  sdk.history.getMetric({ entity: poolAddress, chainId: 1, metric: "apy", period: "90d" }),
  sdk.history.getMetric({ entity: poolAddress, chainId: 1, metric: "utilization", period: "90d" }),
  sdk.history.getMetric({ entity: poolAddress, chainId: 1, metric: "tvl", period: "90d" }),
]);

const sharePrice = await sdk.history.getMetric({
  entity: poolAddress,
  chainId: 1,
  metric: "share_price",
  period: "90d",
  resolution: "1d",
});

// Detect any drops
for (let i = 1; i < sharePrice.data.length; i++) {
  const prev = sharePrice.data[i - 1].value;
  const curr = sharePrice.data[i].value;
  if (curr < prev) {
    console.warn(`Share price dropped on ${sharePrice.data[i].date}: ${prev} → ${curr}`);
  }
}

const feed = await sdk.events.getFeed({
  entity: poolAddress,
  chainId: 1,
  since: "2025-01-01T00:00:00Z",
});

for (const event of feed.events) {
  console.log(`[${event.timestamp}] ${event.type}: ${event.description}`);
}

const projection = await sdk.events.getProjection({
  entity: poolAddress,
  chainId: 1,
});

// Current state
console.log("Current parameters:", projection.current);

// Projected state after pending changes
if (projection.projected) {
  console.log("Projected parameters:", projection.projected);

  // See individual parameter diffs
  for (const diff of projection.changes) {
    console.log(`${diff.parameter}: ${diff.from} → ${diff.to} (ETA: ${diff.eta})`);
  }
}

const projection = await sdk.events.getProjection({
  entity: poolAddress,
  chainId: 1,
});

// Find quota rate changes
const quotaChanges = projection.changes.filter(d => d.parameter === "quotaRate");

for (const change of quotaChanges) {
  console.log(
    `${change.token} quota rate: ${change.from}% → ${change.to}% (ETA: ${change.eta})`
  );
  // Output: "USDC quota rate: 3% → 4% (ETA: 2025-04-20T12:00:00Z)"
}

const result = await sdk.history.getMetric({
  entity: poolAddress,
  chainId: 1,
  metric: "apy",
});

if (!result.meta.backendAvailable) {
  console.warn("Backend unavailable — historical data may be incomplete");
}