feat: price oracle elections by MxmUrw · Pull Request #5971 · chainflip-io/chainflip-backend

MxmUrw · 2025-07-03T12:22:56Z

Pull Request

Checklist

Please conduct a thorough self-review before opening the PR.

I am confident that the code works.
I have written sufficient tests.
I have written and tested required migrations.
I have updated documentation where appropriate.

Summary

This PR adds another instantiation of the elections pallet to the runtime, with I = (), called GenericElections. It contains a single electoral system, ChainlinkOraclePriceES that implements oracle price elections as described in the linear issue. There's a new safemode that stops the creation of oracle elections situated in the GenericElections instantiation of the elections pallet.

Features that are not part of this PR:

Price spike circuit breaker. We're going to defer this to a later date, when it is clearer how this feature would be used.

coderabbitai · 2025-07-03T12:23:02Z

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing Touches

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch feat/PRO-2289/oracle-elections-system

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai generate unit tests to generate unit tests for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

codecov · 2025-07-03T14:06:24Z

Codecov Report

❌ Patch coverage is 56.64557% with 548 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
engine/src/witness/generic_elections.rs	0%	133 Missing ⚠️
...-chain/runtime/src/migrations/generic_elections.rs	0%	88 Missing ⚠️
...e/src/state_chain_observer/client/electoral_api.rs	0%	59 Missing ⚠️
...e-chain/runtime/src/chainflip/generic_elections.rs	46%	57 Missing and 2 partials ⚠️
...ns/src/electoral_systems/oracle_price/chainlink.rs	75%	44 Missing and 1 partial ⚠️
state-chain/runtime/src/migrations/safe_mode.rs	0%	41 Missing ⚠️
...ctions/src/electoral_systems/oracle_price/price.rs	84%	16 Missing and 5 partials ⚠️
state-chain/custom-rpc/src/lib.rs	0%	20 Missing ⚠️
engine/src/witness/start.rs	0%	16 Missing ⚠️
state-chain/node/src/chain_spec.rs	42%	14 Missing ⚠️
... and 14 more

📢 Thoughts on this report? Let us know!

- wip: feat: add OraclePriceTracker state machine. - wip: adding proper type trait. - feat: sketch of OP statemachine complete. - wip: implementing `generic_elections`. - chore: make it compile. - feat: first prototype implementation of oracle price witnessing ES. - feat: expose generic electoral rpcs. - feat: engine side scaffoling for oracle elections. - wip: try to call sol rpc from voter.

Previously we used the `request` which is not compatible with being called in elections since these have their own retry mechanism. Having infinite retries for rpc calls that always fail would mean that they would never be cleaned up.

… from the ES state.

…eSettings`. Note, does not compile yet because of missing values.

… state.

…ng allowed in const vars.

state-chain/pallets/cf-elections/src/electoral_systems/oracle_price/state_machine.rs

dandanlen · 2025-07-25T15:14:42Z

state-chain/runtime/src/chainflip.rs

+// TODO: is this how we will provide the prices to other pallets?
+#[allow(dead_code)]
+struct GenericElectionsEnvironment;


I think the answer here is that it might make sense to remove the 'elections' context from the naming of this and just provide a struct/trait like PriceFeedApi or something.

For example we could define a struct PriceFeed and impl PriceFeedApi for PriceFeed or something. This is better than using ChainEnvironment, which is a little too generic and vague.

…rom Chainlink on Ethereum.

dandanlen · 2025-07-25T16:05:28Z

I'm happy with this, will let @marcellorigotti review the state machine implementation since he's more familiar with this. After that let's merge.

chore: update insta test for safemode serialization.

marcellorigotti · 2025-07-28T09:48:54Z

state-chain/pallets/cf-elections/src/electoral_systems/oracle_price/primitives.rs

+	pub struct Aggregated<A: AggregationValue> {
+		pub median: A,
+		pub iq_range: RangeInclusive<A>,
+	}


What is iq_range used for exactly? Is it only for testing?

The idea is that it would be nice to have at least some insight into the distribution of votes. We could of course track the extrinsics as you do in the vote log script, but I thought it's easier if we track the value on-chain. So we can easily add it to the prometheus exporter.

I see! I like the idea 👌

… correctly.

…t is higher than success threshold

marcellorigotti

LGTM!

… prices, explicit base and quote asset).

marcellorigotti · 2025-07-30T12:52:45Z

state-chain/pallets/cf-elections/src/electoral_systems/oracle_price/price.rs

 		match self {
 			Btc => 8,
-			Eth => 12,
+			Eth => 18,


nice catch :D

* rpc * refactor: remove `get_latest_price` and replace occurences by `get_latest_asset_state`. * rpc --------- Co-authored-by: Maxim Urschumzew <maxu@chainflip.io>

…ally.

…reward * origin/main: feat: delegated staking auction integration (#6022) ci: improve secret passing 🥷 (#6042) feat: generate backspin chain spec (#6041) refactor: return `Ok(None)` instead of error if sol egress witnessing cannot find a tx (#6036) feat: add operator to validator info (#6040) feat: Support for DCA 1 block interval (#6025) feat: added account balance of operator (#6035) fix: remove race condition in bouncer observe event (#6023) fix: use `any::Asset` instead of `ChainlinkAssetpair` in internal price API (#6034) feat: price oracle elections (#5971) feat: don't error if tx is Confirmed (#6019) chore: process all events in a block in parallel (#6013)

MxmUrw closed this Jul 3, 2025

MxmUrw force-pushed the feat/PRO-2289/oracle-elections-system branch from c093f2f to 5464d82 Compare July 3, 2025 12:25

MxmUrw reopened this Jul 3, 2025

MxmUrw force-pushed the feat/PRO-2289/oracle-elections-system branch from 0d3c902 to cd6870a Compare July 17, 2025 09:09

MxmUrw and others added 18 commits July 17, 2025 11:13

fix: use correct solana addresses.

e9f95fb

feat: compute vote in oracle price voter.

b1d525f

feat: add electoral settings for solana program addresses.

a1ccaa0

fix: bouncer oracle price submission (#5983)

5330f1c

chore: small cosmetic changes.

097d347

feat: add querying Ethereum for prices.

573d2b3

refactor: better data types for price oracle state.

8c58038

refactor: remove query from election state, it is now derivable.

8f82aca

chore: cleaning up.

a7787f4

chore: fix warnings.

6925dc5

refactor: rename.

f7544d6

test: instantiate state machine proptesting for oracle prices.

70b4e40

wip: adding price conversion tools.

864e44f

wip: feat: add method for getting current prices in statechain format…

18d50a1

… from the ES state.

feat: use Fraction prices throughout price elections.

5f88b2e

fix: use correct number of decimals for chainlink price type.

c4b37c9

MxmUrw force-pushed the feat/PRO-2289/oracle-elections-system branch from cd6870a to c4b37c9 Compare July 17, 2025 09:35

MxmUrw and others added 5 commits July 17, 2025 14:43

feat: add chainspec + migration configuration of `ChainlinkOraclePric…

e3175b3

…eSettings`. Note, does not compile yet because of missing values.

chore: insert addresses (#6009)

1e0da22

chore: better names + query backup chain already when in MaybeStale…

00e4f3c

… state.

feat: add functor/transformation pattern to deal with vectors not bei…

a1160a9

…ng allowed in const vars.

fix: use correct settings when initializing oracle price elections.

1a86dc6

dandanlen reviewed Jul 25, 2025

View reviewed changes

state-chain/pallets/cf-elections/src/electoral_systems/oracle_price/state_machine.rs Show resolved Hide resolved

dandanlen reviewed Jul 25, 2025

View reviewed changes

MxmUrw added 2 commits July 25, 2025 17:32

fix: use TryInto and don't unwrap when converting values received f…

27a3cea

…rom Chainlink on Ethereum.

chore: use new PriceFeedApi trait instead of ChainEnvironment.

fe6f03d

MxmUrw added 3 commits July 28, 2025 10:36

feat: add safemode migration.

06117fe

chore: try to remove new dependency to fix ci error.

0776980

feat: track SC block height when price was updated.

bc3bdd7

chore: update insta test for safemode serialization.

marcellorigotti reviewed Jul 28, 2025

View reviewed changes

MxmUrw and others added 3 commits July 28, 2025 14:30

feat: add OraclePricesUpdated event.

c9ec653

test: manually verify that computations with the Fraction type work…

29b15cb

… correctly.

fix consensus: return asset only if the number of votes for that asse…

19a15d2

…t is higher than success threshold

marcellorigotti approved these changes Jul 28, 2025

View reviewed changes

MxmUrw added 4 commits July 28, 2025 18:14

fix: fix bug caused by short-circuiting any() usage.

7f81ca5

feat: update OraclePricesUpdated event to new encoding (SC internal…

495ed3a

… prices, explicit base and quote asset).

fix: correct number of Eth decimals.

85d26de

fix: convert to statechain representation before changing price unit.

06bcbc8

MxmUrw force-pushed the feat/PRO-2289/oracle-elections-system branch from 7ceda5b to aa526ff Compare July 30, 2025 09:49

fix: use same conversion function for both API and event.

6104769

MxmUrw force-pushed the feat/PRO-2289/oracle-elections-system branch from aa526ff to 6104769 Compare July 30, 2025 09:59

marcellorigotti reviewed Jul 30, 2025

View reviewed changes

feat: Rpc for oracle prices (#6027)

4203b02

* rpc * refactor: remove `get_latest_price` and replace occurences by `get_latest_asset_state`. * rpc --------- Co-authored-by: Maxim Urschumzew <maxu@chainflip.io>

MxmUrw force-pushed the feat/PRO-2289/oracle-elections-system branch from d7d61b8 to 7ca2f33 Compare July 30, 2025 14:22

test: check conversions from chainlink prices to internal prices manu…

33a1df9

…ally.

MxmUrw force-pushed the feat/PRO-2289/oracle-elections-system branch from 7ca2f33 to 33a1df9 Compare July 30, 2025 14:27

MxmUrw added this pull request to the merge queue Jul 30, 2025

Merged via the queue into main with commit 16d691d Jul 30, 2025
54 checks passed

MxmUrw deleted the feat/PRO-2289/oracle-elections-system branch July 30, 2025 17:13

Conversation

MxmUrw commented Jul 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request

Checklist

Summary

Uh oh!

coderabbitai bot commented Jul 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

codecov bot commented Jul 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

dandanlen Jul 25, 2025

Choose a reason for hiding this comment

Uh oh!

dandanlen commented Jul 25, 2025

Uh oh!

marcellorigotti Jul 28, 2025

Choose a reason for hiding this comment

Uh oh!

MxmUrw Jul 28, 2025

Choose a reason for hiding this comment

Uh oh!

marcellorigotti Jul 28, 2025

Choose a reason for hiding this comment

Uh oh!

marcellorigotti left a comment

Choose a reason for hiding this comment

Uh oh!

marcellorigotti Jul 30, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

MxmUrw commented Jul 3, 2025 •

edited

Loading

coderabbitai bot commented Jul 3, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

codecov bot commented Jul 3, 2025 •

edited

Loading