fix: 🛠️ Add Base Support #43

timbrinded · 2025-10-24T11:18:32Z

Changes

Add Base network support: Added BASE_ASSETS constants and vault deployment configuration for Base mainnet
Refactor network terminology: Renamed 'l1' references to 'vault' to clarify that it represents the network where the vault is deployed (not necessarily Ethereum L1)
Fix wstETH pricing for L2 deployments: wstETH adapter now always queries Ethereum mainnet for pricing, regardless of vault deployment network
- Added eth_mainnet_rpc configuration option for L2 deployments
- Falls back to public RPC if not configured (with warning)
- Added disclaimer about stETH/ETH depeg risk assumptions
Fix private key handling: Resolved issues with private key configuration parsing
Update tests: Fixed and updated test suite to handle Base network and new pricing logic

Technical Details

The wstETH adapter now distinguishes between:

Vault network (where assets are deployed)
Mainnet (where wstETH contract is queried for pricing)

This enables accurate wstETH pricing for vaults deployed on L2s like Base while maintaining the canonical wstETH exchange rate from mainnet.

…/config-file

* refactor: ♻️ big refactor * refactor: ♻️ Tidy * docs: 📝 update readme * refactor: ♻️ pr comments

* feat: add validation for asset prices in total_assets calculation (#35) * feat: add validation for asset prices in total_assets calculation - Implemented checks for invalid prices (<= 0) in the calculate_total_assets function. - Added error handling to raise ValueError with details of invalid prices. - Introduced a new test to ensure that invalid prices trigger the appropriate exception. * refactor: turn invalid prices computation into list comprehension * feat: add price validation for price adapter (#36) * fix: update WstETHAdapter and tests to set ETH base asset price to 1 - Changed the base asset price for ETH in WstETHAdapter from 0 to 1 to ensure accurate pricing. - Updated related tests to verify that the ETH price is now correctly set to 1 instead of 0. - Adjusted documentation to clarify the base asset pricing behavior. * feat: add price validation to BasePriceAdapter * refactor: change validate_prices method to synchronous in price adapters - Updated the validate_prices method in BasePriceAdapter to be synchronous instead of asynchronous. - Adjusted calls to validate_prices in ChainlinkAdapter, CowSwapAdapter, and WstETHAdapter accordingly. * feat: add TypedDict for network addresses in constants.py * feat: add NetworkAddresses instances * refactor: rename NetworkAddresses to NetworkTokens and update address constants * feat: add network configuration and asset retrieval to OracleCLIConfig * refactor: update WstETHAdapter to use dynamic asset addresses from config * refactor: enhance WstETHAdapter to enforce required ETH address and simplify checks * refactor: update CowSwapAdapter to use dynamic asset addresses and improve network configuration * refactor: update ChainlinkAdapter to use dynamic asset addresses from config and enforce required ETH address * refactor: update IdleBalancesAdapter to use dynamic asset addresses from config and enforce required ETH and USDC addresses * refactor: remove optional asset address attributes from Chainlink, CowSwap, and WstETH adapters * refactor: enforce required USDC address in HyperliquidAdapter and update asset address retrieval from config * refactor: update Chainlink test suite to use dynamic asset addresses from config * refactor: update WstETHAdapter tests to utilize dynamic asset addresses from config * refactor: enhance HyperliquidAdapter tests to utilize dynamic USDC addresses from config * refactor: update tests to utilize dynamic asset addresses from config for improved consistency * refactor: update Chainlink and CowSwap tests to utilize dynamic asset addresses from config for improved consistency * refactor: update Chainlink tests to include dynamic ETH address in price fetching for USDT and USDS on testnet * refactor: update import paths from config to settings in CowSwap and Hyperliquid test files

…/config-file

Co-authored-by: Copilot <[email protected]>

* docs * docs

Co-authored-by: Copilot <[email protected]>

Copilot

Pull Request Overview

This PR implements comprehensive configuration management, Base network support, and modular asset adapter infrastructure for the TQ Oracle system.

Key Changes:

Migrated from dataclass-based config to Pydantic Settings with multi-source configuration precedence (CLI > ENV > TOML)
Added Base network support with network-specific asset mappings
Restructured asset adapters to support per-subvault configuration and multi-chain operation
Refactored orchestration into modular pipeline stages (preflight, assets, pricing, report)

Reviewed Changes

Copilot reviewed 49 out of 51 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
`src/tq_oracle/settings.py`	New Pydantic-based settings with TOML/ENV/CLI precedence and network-specific derivations
`src/tq_oracle/state.py`	Application state container replacing global config
`src/tq_oracle/constants.py`	Network-specific asset mappings for mainnet/sepolia/base
`src/tq_oracle/main.py`	Restructured CLI with callback-based initialization and settings injection
`src/tq_oracle/pipeline/`	Modular pipeline stages replacing monolithic orchestrator
`src/tq_oracle/adapters/asset_adapters/`	Chain-aware adapters with registry and per-subvault configuration
`tests/`	Updated tests to use OracleSettings instead of OracleCLIConfig
`tq-oracle-example.toml`	Example configuration file demonstrating new TOML-based config

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-10-24T11:19:52Z

src/tq_oracle/processors/oracle_helper.py

+    # Always sets the base asset to price 0
    if prices.base_asset in prices.prices:


The comment on line 89 is misleading as it refers to setting the base asset price but appears above the sorting logic. Move this comment directly above line 90-91 where the base asset price is actually set, and keep the sorting comment on line 92 where it belongs.

Suggested change

# Always sets the base asset to price 0

if prices.base_asset in prices.prices:

if prices.base_asset in prices.prices:

# Always sets the base asset to price 0

Copilot · 2025-10-24T11:19:53Z

src/tq_oracle/constants.py

+        (SEPOLIA_ASSETS.get("USDC"), 6),
+        (ETH_MAINNET_ASSETS.get("USDT"), 6),
+        (ETH_MAINNET_ASSETS.get("USDS"), 18),


The TOKEN_DECIMALS dictionary construction filters out None addresses but doesn't include Base network assets. This creates an inconsistency where Base network USDC/USDT/USDS addresses won't be found in TOKEN_DECIMALS, potentially causing runtime errors. Add Base network assets to the list comprehension for completeness.

Suggested change

(SEPOLIA_ASSETS.get("USDC"), 6),

(ETH_MAINNET_ASSETS.get("USDT"), 6),

(ETH_MAINNET_ASSETS.get("USDS"), 18),

(SEPOLIA_ASSETS.get("USDC"), 6),

(BASE_ASSETS.get("USDC"), 6),

(ETH_MAINNET_ASSETS.get("USDT"), 6),

(BASE_ASSETS.get("USDT"), 6),

(ETH_MAINNET_ASSETS.get("USDS"), 18),

(BASE_ASSETS.get("USDS"), 18),

Copilot · 2025-10-24T11:19:53Z

src/tq_oracle/adapters/price_adapters/wsteth.py

+                addr
+                for addr in asset_addresses
+                if addr.lower() == self.wsteth_address.lower()
+            )


The next() call will raise StopIteration if no matching address is found in asset_addresses. Since this code is only reached when has_wsteth is True (which checks if wsteth_address is in asset_addresses_lower), this should theoretically be safe. However, add a default value or explicit check to prevent potential edge cases where case sensitivity mismatches could cause runtime errors.

Suggested change

addr

for addr in asset_addresses

if addr.lower() == self.wsteth_address.lower()

)

(addr for addr in asset_addresses if addr.lower() == self.wsteth_address.lower()),

None

)

if wsteth_addr_actual is None:

raise ValueError(

f"wstETH address {self.wsteth_address} found in asset_addresses_lower but not in asset_addresses. "

"This may be due to a case sensitivity mismatch."

)

Copilot · 2025-10-24T11:19:53Z

src/tq_oracle/settings.py

+                    if key in body:
+                        raise ValueError(
+                            f"Security violation: '{key}' found in TOML config file. "
+                            f"Secrets must only be provided via environment variables or CLI flags."


[nitpick] The security check prevents secrets in TOML files, which is good practice. However, the error message could be more actionable by specifying the exact environment variable name format (e.g., 'Use TQ_ORACLE_PRIVATE_KEY environment variable instead').

Suggested change

f"Secrets must only be provided via environment variables or CLI flags."

f"Use the '{OracleSettings.model_config['env_prefix']}{key.upper()}' environment variable instead."

src/tq_oracle/adapters/asset_adapters/idle_balances.py

…base-support

Copilot

Pull Request Overview

Copilot reviewed 30 out of 30 changed files in this pull request and generated 2 comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

src/tq_oracle/constants.py

src/tq_oracle/main.py

Copilot

Pull Request Overview

Copilot reviewed 32 out of 32 changed files in this pull request and generated 2 comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

src/tq_oracle/settings.py

src/tq_oracle/constants.py

Copilot

Pull Request Overview

Copilot reviewed 32 out of 32 changed files in this pull request and generated 3 comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

src/tq_oracle/adapters/price_adapters/wsteth.py

src/tq_oracle/report/publisher.py

src/tq_oracle/main.py

timbrinded and others added 29 commits October 21, 2025 16:03

feat: ✨ Added config file support

a633db9

tidy

273267e

tidy

26fcc8d

Merge branch 'master' of github.com:Moonsong-Labs/tq-oracle into feat…

2fa2735

…/config-file

Merge branch 'master' of github.com:Moonsong-Labs/tq-oracle into feat…

a759f31

…/config-file

lint

5e26dc1

refactor: ♻️ tidy

80f27fb

ci: 💚 fix ci

4afcd77

fix: 🐛 fix asset order

02ca05d

fix: 🐛 fix oraclehelper issue

0c4620e

fix

01b0c4f

refactor: ♻️ tidy

6c67985

Merge branch 'master' of github.com:Moonsong-Labs/tq-oracle into feat…

fd5649b

…/config-file

fmt

1e29902

fix default overriding

0837dc4

Refactor/big refactor (#39)

be9037b

* refactor: ♻️ big refactor * refactor: ♻️ Tidy * docs: 📝 update readme * refactor: ♻️ pr comments

test fix

02dab8c

refactor: ♻️ pr comments

c230868

Merge branch 'master' of github.com:Moonsong-Labs/tq-oracle into feat…

69bcfc0

…/config-file

pr comments

d4195a7

Update constants.py

a96207b

Co-authored-by: Copilot <[email protected]>

Feat/improved docs checks (#40)

aaebcde

* docs * docs

Update src/tq_oracle/adapters/asset_adapters/idle_balances.py

4fb5e55

Co-authored-by: Copilot <[email protected]>

Update tq-oracle-example.toml

159f70a

Co-authored-by: Copilot <[email protected]>

Update README.md

a797678

Co-authored-by: Copilot <[email protected]>

update cli opts

218f28f

fix: 🐛 working with base now

156d1b7

rename l1->vault

cc27b9e

Copilot AI review requested due to automatic review settings October 24, 2025 11:18

timbrinded changed the title ~~Fix/base support~~ fix: 🛠️ Add Base Support Oct 24, 2025

Copilot AI reviewed Oct 24, 2025

View reviewed changes

timbrinded added 2 commits October 24, 2025 12:27

Merge branch 'master' of github.com:Moonsong-Labs/tq-oracle into fix/…

abd9db5

…base-support

fix private key

542aefe

Copilot AI review requested due to automatic review settings October 24, 2025 12:43

Copilot AI reviewed Oct 24, 2025

View reviewed changes

src/tq_oracle/constants.py Show resolved Hide resolved

src/tq_oracle/main.py Show resolved Hide resolved

timbrinded added 3 commits October 24, 2025 14:06

price fix

126b7c1

fix tests

4b5f500

update tests

ebb10e6

Copilot AI review requested due to automatic review settings October 24, 2025 13:42

Copilot AI reviewed Oct 24, 2025

View reviewed changes

src/tq_oracle/settings.py Show resolved Hide resolved

src/tq_oracle/constants.py Show resolved Hide resolved

timbrinded added 2 commits October 24, 2025 15:02

give steth disclaimer

cc07591

fmt

343de53

Copilot AI review requested due to automatic review settings October 24, 2025 14:35

Copilot AI reviewed Oct 24, 2025

View reviewed changes

src/tq_oracle/adapters/price_adapters/wsteth.py Show resolved Hide resolved

src/tq_oracle/report/publisher.py Show resolved Hide resolved

src/tq_oracle/main.py Show resolved Hide resolved

timbrinded marked this pull request as ready for review October 24, 2025 14:38

timbrinded merged commit 76df7a7 into master Oct 25, 2025
6 checks passed

timbrinded deleted the fix/base-support branch October 25, 2025 07:47

		# Always sets the base asset to price 0
		if prices.base_asset in prices.prices:

-                addr
-                for addr in asset_addresses
-                if addr.lower() == self.wsteth_address.lower()
-            )
+                (addr for addr in asset_addresses if addr.lower() == self.wsteth_address.lower()),
+                None
+            )
+            if wsteth_addr_actual is None:
+                raise ValueError(
+                    f"wstETH address {self.wsteth_address} found in asset_addresses_lower but not in asset_addresses. "
+                    "This may be due to a case sensitivity mismatch."
+                )

	f"Secrets must only be provided via environment variables or CLI flags."
	f"Use the '{OracleSettings.model_config['env_prefix']}{key.upper()}' environment variable instead."

fix: 🛠️ Add Base Support #43

fix: 🛠️ Add Base Support #43

Uh oh!

Conversation

timbrinded commented Oct 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Technical Details

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Oct 24, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 24, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 24, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 24, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

timbrinded commented Oct 24, 2025 •

edited

Loading