feat: oracle swaps by j4m1ef0rd · Pull Request #6039 · chainflip-io/chainflip-backend

j4m1ef0rd · 2025-08-07T07:07:56Z

Pull Request

Closes: PRO-2331

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

Replaced min_price param with a new SwapLimits struct that has the new oracle price field.
Added logic to the swapping code to check the oracle price and give a price violation if the output of the swap is not enough.
Moved some of the. oracle price feed api stuff.
Added support to the btc vault swap to take a u8 for the new oracle price slippage bps.
- Used u8::MAX as a special value to set None
- Added a new version of the data struct to allow for backwards compatibility
Added 2 tests for the new oracle price protection

TODO: Need some input from @dandanlen

Possible breaking change to request_swap_deposit_address_with_affiliates and request_swap_deposit_address extrinsics.
Breaking change to cf_request_swap_parameter_encoding. This will most likely need a new RPC, can be done in another PR.
Breaking change to schedule_swap and lp_schedule_swap (aka internal swap). should we make another extrinsic instead?
Should we return an error when opening a deposit channel or encoding vault swap params if the oracle price is None for one of the swap assets? Catch it early so they do not think they are protected when they are not.

coderabbitai · 2025-08-07T07:08:03Z

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/oracle-swaps-jamie

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.
- 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.
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 the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

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

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

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

Status, Documentation and Community

Visit our Status Page to check the current availability of CodeRabbit.
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.

syan095 · 2025-08-08T00:16:09Z

state-chain/chains/src/cf_parameters.rs

 /// and refund CCM metadata.
 pub type VaultSwapParametersV0<RefundAddress> =
-	VaultSwapParameters<ChannelRefundParameters<RefundAddress, ()>>;
+	VaultSwapParameters<ChannelRefundParameters<RefundAddress, (), ()>>;


the () design has caused some tricky problems. I would strongly advise using a field with Option<> instead of this () pattern.

I tried. Spent a day trying to change both of them to options and gave up in the end. Might re-visit it in another PR.

yeah better to keep the previous one as is, and just add the new one as Option.
I considered changing this last time in the Solana refund parameter the refactor is too much

yeah I will give that a try

syan095 · 2025-08-08T00:54:54Z

state-chain/chains/src/refund_parameters.rs

 	Ord,
 )]
-pub struct ChannelRefundParameters<A, CcmRefundDetails> {
+pub struct ChannelRefundParameters<A, CcmRefundDetails, OracleSlippage> {


Same point as in the cf_parameter. If possible, avoid this and just use a field. Do we expect different types for the OracleSlippage?

I think the problem is that we have a ton of different types that are derived from ChannelRefundParameters and if we create a separate "v2" type (which we would need to we can still decode the old type) without using generics, you will end up duplicating a lot of code. I'm also not a fan of using generics this way, but I would leave it to @j4m1ef0rd to investigate if there is a better way.

syan095 · 2025-08-08T04:02:34Z

It might be a good idea to add an integration test as well, which can cover the entire workflow from requesting a swap all the way to egress.

state-chain/traits/src/lib.rs

state-chain/traits/src/mocks/price_feed_api.rs

msgmaxim · 2025-08-08T02:29:11Z

state-chain/chains/src/refund_parameters.rs

 	Ord,
 )]
-pub struct ChannelRefundParameters<A, CcmRefundDetails> {
+pub struct ChannelRefundParameters<A, CcmRefundDetails, OracleSlippage> {


I think the problem is that we have a ton of different types that are derived from ChannelRefundParameters and if we create a separate "v2" type (which we would need to we can still decode the old type) without using generics, you will end up duplicating a lot of code. I'm also not a fan of using generics this way, but I would leave it to @j4m1ef0rd to investigate if there is a better way.

state-chain/pallets/cf-swapping/src/lib.rs

state-chain/amm-math/src/lib.rs

state-chain/pallets/cf-swapping/src/tests/fill_or_kill.rs

codecov · 2025-08-12T08:30:47Z

Codecov Report

❌ Patch coverage is 82.30563% with 66 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
state-chain/chains/src/lib.rs	0%	16 Missing ⚠️
state-chain/chains/src/cf_parameters.rs	81%	11 Missing ⚠️
state-chain/chains/src/btc/vault_swap_encoding.rs	86%	7 Missing and 2 partials ⚠️
state-chain/pallets/cf-swapping/src/lib.rs	86%	5 Missing and 3 partials ⚠️
state-chain/runtime/src/chainflip/vault_swaps.rs	0%	6 Missing ⚠️
...-chain/runtime/src/migrations/bitcoin_elections.rs	0%	4 Missing ⚠️
state-chain/chains/src/refund_parameters.rs	57%	3 Missing ⚠️
state-chain/runtime/src/lib.rs	0%	0 Missing and 2 partials ⚠️
api/cf-node-client/src/subxt_state_chain_config.rs	0%	1 Missing ⚠️
api/lib/src/lp.rs	0%	1 Missing ⚠️
... and 5 more

📢 Thoughts on this report? Let us know!

albert-llimos · 2025-08-14T07:07:32Z

state-chain/chains/src/btc/vault_swap_encoding.rs

+		pub affiliates: BoundedVec<AffiliateAndFee, ConstU32<MAX_AFFILIATES>>,
+	}
+
+	impl From<BtcCfParametersV0> for BtcCfParameters {


Nit: In order to keep it consistent with the other chain's cf_parameters I'd suggest renaming BtcCfParameters to BtcCfParametersV1.

albert-llimos · 2025-08-14T07:18:54Z

state-chain/chains/src/cf_parameters.rs

-	VaultSwapParameters<ChannelRefundParameters<RefundAddress, ()>>;
+	VaultSwapParameters<ChannelRefundParametersV0<RefundAddress>>;

 /// New version of `VaultSwapParameters` that includes refund CCM metadata.


Suggested change

/// New version of `VaultSwapParameters` that includes refund CCM metadata.

/// New version of `VaultSwapParameters` includes refund CCM and oracle price slippage.

albert-llimos · 2025-08-14T07:20:22Z

state-chain/chains/src/cf_parameters.rs


+#[cfg(test)]
+pub fn build_and_encode_v0_cf_parameters<RefundAddress: Encode>(
+	refund_parameters: crate::ChannelRefundParametersV0<RefundAddress>, /* crate::ChannelRefundParametersUncheckedV0<RefundAddress>, */


Remove commented code.

albert-llimos · 2025-08-14T07:36:07Z

state-chain/pallets/cf-swapping/src/lib.rs

+						);
+
+						let min_output =
+							output_amount_ceil(swap.swap.input_amount.into(), min_price)


Any particular reason why we use output_amount_ceil instead of output_amount_floor? I don't think it matters here but normally the rounding tends to be done in "favor" of the protocol per say, just to cover any edge cases.
Since it's not AMM logic that's almost certainly not relevant though, so it's just curiosity.

No particular reason. Like you said, this shouldn't matter, but I'm not against changing this to output_amount_floor.

albert-llimos · 2025-08-14T07:44:14Z

bouncer/shared/sol_vault_swap.ts

      gas_budget: fillOrKillParams?.refundCcmMetadata.gasBudget,
      ccm_additional_data: fillOrKillParams?.refundCcmMetadata.ccmAdditionalData,
    },
+    max_oracle_price_slippage: undefined, // TODO: update FillOrKillParamsX128 with max_oracle_price_slippage


Right now the bouncer is using "@chainflip/cli": "1.9.0-assethub.0-ccm-refunds", which is a little patch I made so FillOrKillParamsX128 contains the refund_ccm_metadata. Then the web team will add that to the 1.11 SDK.
We can add max_oracle_price_slippage in that same branch, as it's a little patch anyway, so we can use this in the bouncer. @j4m1ef0rd lmk if you'd want me to help out with that.
Then I think we should have a oracle swap FoK test in tests/fill_or_kill.ts the same way that we have it for regular and CCM refunds.

I made the changes to your branch but I dont have permissions to push it. So I will do this bouncer stuff in another PR so we can merge this now.

feat: oracle swaps

e8e9539

j4m1ef0rd requested a review from syan095 August 7, 2025 07:07

j4m1ef0rd requested review from a team, dandanlen, msgmaxim and nmammeri as code owners August 7, 2025 07:07

syan095 reviewed Aug 8, 2025

View reviewed changes

msgmaxim reviewed Aug 8, 2025

View reviewed changes

fix: bouncer tests and address some PR comments

58b003c

j4m1ef0rd requested a review from martin-chainflip as a code owner August 8, 2025 06:08

fix: bouncer tests

b6b4498

j4m1ef0rd force-pushed the feat/oracle-swaps-jamie branch 2 times, most recently from afccdff to 610c911 Compare August 12, 2025 05:43

j4m1ef0rd added 2 commits August 12, 2025 17:18

fix: update serialized data in test

f870c19

refactor: dont use generics for channel refund params

1f7c917

j4m1ef0rd force-pushed the feat/oracle-swaps-jamie branch from 610c911 to 1f7c917 Compare August 12, 2025 07:24

test: check V0 vault swap compatibility

c7b5992

albert-llimos reviewed Aug 14, 2025

View reviewed changes

refactor: address PR comments

16c571b

msgmaxim approved these changes Aug 15, 2025

View reviewed changes

refactor: use floor instead of ceil

93b5f8b

j4m1ef0rd force-pushed the feat/oracle-swaps-jamie branch from a1c131d to 93b5f8b Compare August 15, 2025 04:35

j4m1ef0rd added this pull request to the merge queue Aug 15, 2025

Merged via the queue into main with commit ea97dce Aug 15, 2025
54 checks passed

j4m1ef0rd deleted the feat/oracle-swaps-jamie branch August 15, 2025 07:38

j4m1ef0rd mentioned this pull request Aug 21, 2025

feat: swap aborted event #6044

Merged

3 tasks

	/// New version of `VaultSwapParameters` that includes refund CCM metadata.
	/// New version of `VaultSwapParameters` includes refund CCM and oracle price slippage.

Conversation

j4m1ef0rd commented Aug 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request

Checklist

Summary

TODO: Need some input from @dandanlen

Uh oh!

coderabbitai bot commented Aug 7, 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/Issue comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Status, Documentation and Community

Uh oh!

Choose a reason for hiding this comment

Uh oh!

j4m1ef0rd Aug 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

syan095 commented Aug 8, 2025

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

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

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

j4m1ef0rd Aug 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

j4m1ef0rd commented Aug 7, 2025 •

edited

Loading

coderabbitai bot commented Aug 7, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

j4m1ef0rd Aug 8, 2025 •

edited

Loading

codecov bot commented Aug 12, 2025 •

edited

Loading

j4m1ef0rd Aug 15, 2025 •

edited

Loading