Eth price syncer using Chainlink oracle #731

luis-herasme · 2025-02-24T04:08:56Z

Checklist

My change requires a documentation update, and I have done it.
I have added tests to cover my changes.
I have filled out the description and linked the related issues.

Description

Adds package to fetch the ETH price at a given timestamp.
We need this to complete #685

Related Issue (Optional)

#617

…h client and price retrieval functions

changeset-bot · 2025-02-24T04:08:59Z

⚠️ No Changeset found

Latest commit: 89c17b0

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

vercel · 2025-02-24T04:09:00Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
blobscan-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Feb 24, 2025 1:26pm
blobscan-staging	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Feb 24, 2025 1:26pm

4 Skipped Deployments

Name	Status	Preview	Updated (UTC)
blobscan-gnosis	⬜️ Ignored (Inspect)	Visit Preview	Feb 24, 2025 1:26pm
blobscan-holesky	⬜️ Ignored (Inspect)	Visit Preview	Feb 24, 2025 1:26pm
blobscan-mainnet	⬜️ Ignored (Inspect)	Visit Preview	Feb 24, 2025 1:26pm
blobscan-sepolia	⬜️ Ignored (Inspect)	Visit Preview	Feb 24, 2025 1:26pm

github-actions · 2025-02-24T04:11:12Z

📦 Next.js Bundle Analysis for @blobscan/web

This analysis was generated by the Next.js Bundle Analysis action. 🤖

This PR introduced no changes to the JavaScript bundle! 🙌

…r exports

…r clarity

…p in getPriceByTimestamp function

…PriceByTimestamp function

…tion

…data

PabloCastellano

Nice to see this implemented! I've left you some suggestions and a request to improve the documentation for this PR.

PabloCastellano · 2025-03-03T17:39:47Z

packages/db/prisma/migrations/20250224043518_/migration.sql

@@ -0,0 +1,8 @@
+-- CreateTable
+CREATE TABLE "eth_price" (


I assume we are going to save the price in USD, right? Then let's better rename it:

Suggested change

CREATE TABLE "eth_price" (

CREATE TABLE "ethusd_price" (

PabloCastellano · 2025-03-03T17:40:34Z

packages/db/prisma/schema.prisma

@@ -301,6 +301,14 @@ model OverallStats {
  @@map("overall_stats")
 }

+model ETHPrice {


Suggested change

model ETHPrice {

model EthUsdPrice {

PabloCastellano · 2025-03-03T17:49:06Z

packages/syncers/src/syncers/ETHPriceSyncer.ts

+          },
+        });
+
+        this.logger.info(`Fetched price data: ${JSON.stringify(priceData)}`);


Suggested change

this.logger.info(`Fetched price data: ${JSON.stringify(priceData)}`);

this.logger.info(`Fetched price data: ${JSON.stringify(priceData)} USD`);

PabloCastellano · 2025-03-03T17:50:14Z

apps/docs/src/app/docs/environment/page.md

@@ -60,6 +60,7 @@ nextjs:
 | `WEAVEVM_API_KEY`                    | API key required to authenticate requests to the WeaveVM blob storage reference updater endpoint   | No                              | (empty)                        |
 | `STATS_SYNCER_DAILY_CRON_PATTERN`    | Cron pattern for the daily stats job                                                               | No                              | `30 0 * * * *`                 |
 | `STATS_SYNCER_OVERALL_CRON_PATTERN`  | Cron pattern for the overall stats job                                                             | No                              | `*/15 * * * *`                 |
+| `ETH_PRICE_SYNCER_CRON_PATTERN`      | Cron pattern for the ETH price job                                                                 | No                              | `0 * * * *`                    |


Suggested change

| `ETH_PRICE_SYNCER_CRON_PATTERN` | Cron pattern for the ETH price job | No | `0 * * * *` |

| `ETH_PRICE_SYNCER_CRON_PATTERN` | Cron pattern for the job that periodically stores ETH price in database | No | `0 * * * *` |

PabloCastellano · 2025-03-03T17:52:02Z

packages/env/index.ts

@@ -83,6 +83,9 @@ export const env = createEnv({
        .url()
        .default("http://localhost:4318"),

+      // ETH Price


Suggested change

// ETH Price

// ETH Price (default: every minute)

PabloCastellano · 2025-03-03T17:54:47Z

packages/eth-price/src/client.ts

+    ...mainnet,
+    rpcUrls: {
+      default: {
+        http: [process.env.RPC_URL!],


Is this a new variable? If so, remember adding it to the documentation

PabloCastellano · 2025-03-03T17:58:15Z

packages/eth-price/src/get-price-by-timestamp.ts

+  });
+
+  if (response === null) {
+    throw new Error(`No data found for target timestamp: ${targetTimestamp}`);


Suggested change

throw new Error(`No data found for target timestamp: ${targetTimestamp}`);

throw new Error(`Could not retrieve ETH price from Chainlink oracle using timestamp: ${targetTimestamp}`);

PabloCastellano · 2025-03-03T18:02:18Z

packages/eth-price/src/get-price-by-timestamp.ts

+ * @param tolerance The maximum difference between the target timestamp and the timestamp of the data.
+ * @returns The price of the asset at the given timestamp.
+ **/
+export async function getPriceByTimestamp({


Could you improve this documentation? What I really miss from this PR is a comment that explains the process that you've implemented for querying an oracle using a timestamp. Also explaining the relation with other functions (such as getPhaseAggregators or getClosestRoundData) and adding a link to some external documentation to learn more about the protocol would be helpful.

luis-herasme added 2 commits January 31, 2025 02:47

feat(eth-price): add initial implementation for eth-price package wit…

2c7f37d

…h client and price retrieval functions

fix(test): use contractAddress variable in getPriceByTimestamp test

e6de468

luis-herasme added 7 commits February 24, 2025 00:24

feat(eth-price): update package name and structure, add index file fo…

39f3c3f

…r exports

refactor(eth-price): rename timestamp parameter to targetTimestamp fo…

b48b61c

…r clarity

refactor(eth-price): clarify parameter description for targetTimestam…

0318c55

…p in getPriceByTimestamp function

refactor(eth-price): rename Data type to PriceData for clarity in get…

96c319f

…PriceByTimestamp function

feat(db): add ETHPrice model and migration for eth_price table

fbc0a6c

feat(env): add ETH_PRICE_SYNCER_CRON_PATTERN to environment configura…

2d06772

…tion

feat(syncers): add ETHPriceSyncer for fetching and storing ETH price …

0d9603c

…data

vercel bot deployed to Preview – blobscan-docs February 24, 2025 04:57 View deployment

luis-herasme requested review from PJColombo, PabloCastellano and xFJA and removed request for PJColombo February 24, 2025 04:59

vercel bot deployed to Preview – blobscan-staging February 24, 2025 05:00 View deployment

Merge branch 'main' into eth-price

89c17b0

vercel bot deployed to Preview – blobscan-staging February 24, 2025 13:25 View deployment

vercel bot deployed to Preview – blobscan-docs February 24, 2025 13:26 View deployment

PabloCastellano requested changes Mar 3, 2025

View reviewed changes

PabloCastellano changed the title ~~Eth price~~ Eth price syncer Mar 3, 2025

PabloCastellano changed the title ~~Eth price syncer~~ Eth price syncer using Chainlink oracle Mar 3, 2025

PabloCastellano mentioned this pull request Mar 3, 2025

feat: add USD blob gas price display on home screen #685

Open

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Eth price syncer using Chainlink oracle #731

Eth price syncer using Chainlink oracle #731

luis-herasme commented Feb 24, 2025 •

edited

Loading

changeset-bot bot commented Feb 24, 2025 •

edited

Loading

vercel bot commented Feb 24, 2025 •

edited

Loading

github-actions bot commented Feb 24, 2025 •

edited

Loading

PabloCastellano left a comment

PabloCastellano Mar 3, 2025

PabloCastellano Mar 3, 2025

PabloCastellano Mar 3, 2025

PabloCastellano Mar 3, 2025

PabloCastellano Mar 3, 2025

PabloCastellano Mar 3, 2025

PabloCastellano Mar 3, 2025

PabloCastellano Mar 3, 2025

	this.logger.info(`Fetched price data: ${JSON.stringify(priceData)}`);
	this.logger.info(`Fetched price data: ${JSON.stringify(priceData)} USD`);

	\| `ETH_PRICE_SYNCER_CRON_PATTERN` \| Cron pattern for the ETH price job \| No \| `0 * * * *` \|
	\| `ETH_PRICE_SYNCER_CRON_PATTERN` \| Cron pattern for the job that periodically stores ETH price in database \| No \| `0 * * * *` \|

	throw new Error(`No data found for target timestamp: ${targetTimestamp}`);
	throw new Error(`Could not retrieve ETH price from Chainlink oracle using timestamp: ${targetTimestamp}`);

Eth price syncer using Chainlink oracle #731

Are you sure you want to change the base?

Eth price syncer using Chainlink oracle #731

Conversation

luis-herasme commented Feb 24, 2025 • edited Loading

Checklist

Description

Related Issue (Optional)

changeset-bot bot commented Feb 24, 2025 • edited Loading

⚠️ No Changeset found

vercel bot commented Feb 24, 2025 • edited Loading

github-actions bot commented Feb 24, 2025 • edited Loading

📦 Next.js Bundle Analysis for @blobscan/web

PabloCastellano left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

luis-herasme commented Feb 24, 2025 •

edited

Loading

changeset-bot bot commented Feb 24, 2025 •

edited

Loading

vercel bot commented Feb 24, 2025 •

edited

Loading

github-actions bot commented Feb 24, 2025 •

edited

Loading