feat: cycles cost by gregorydemay · Pull Request #52 · dfinity/sol-rpc-canister

gregorydemay · 2025-03-31T09:50:17Z

Add endpoints to the SOL RPC canister to estimate the cycle cost of a given request. The proposed API is as a follows:

A caller can pass the exact same request parameters to the cycles cost estimation endpoint as to the endpoint that would actually execute the request so that a precise cycles cost estimation can be returned for that particular request.
Since the endpoints on the SOL RPC canister use different types for the parameters, there is a dedicated _CycleCost endpoint for every Solana endpoint supported by the canister.
The idea is that the caller could use those endpoints to establish a baseline and then do the other calls for that endpoint with some additional cycles to account for minor changes in request parameters (unused cycles are reimbursed).

Implementation details:

Introduce the concept of MultiRpcRequest, which is a JSON-RPC request aimed at multiple URLs (corresponding to Solana JSON-RPC providers). This replaces the previous clients used in the canister (CandidRpcClient and SolRpcClient).
This allows to implement once a cycles_cost method for all MultuRpcRequest that we will support.

# Conflicts: # integration_tests/tests/solana_test_validator.rs # integration_tests/tests/tests.rs # libs/client/src/lib.rs

# Conflicts: # integration_tests/src/lib.rs # integration_tests/src/mock.rs # integration_tests/tests/solana_test_validator.rs # integration_tests/tests/tests.rs # libs/client/src/lib.rs # libs/client/src/request/mod.rs

canister/src/providers/tests.rs

lpahlavi

Thanks a lot for the PR @gregorydemay! Looks very good, just some minor comments on my side.

canister/sol_rpc_canister.did

canister/src/main.rs

canister/src/rpc_client/mod.rs

# Conflicts: # Cargo.lock # canister/sol_rpc_canister.did # canister/src/candid_rpc/mod.rs # canister/src/main.rs # canister/src/rpc_client/mod.rs # libs/client/Cargo.toml # libs/client/src/lib.rs # libs/client/src/request/mod.rs

gregorydemay

Thanks @lpahlavi and @ninegua for the feedback! Should be ready for another round.

canister/sol_rpc_canister.did

canister/src/main.rs

canister/src/rpc_client/mod.rs

lpahlavi

Thanks for addressing the feedback and rebasing the PR! LGTM!

canister/sol_rpc_canister.did

canister/src/main.rs

Follow-up on #52 to use the `method` specified by the JSON-RPC request for metrics purposes instead of having a separate enum.

## 🤖 New release * `sol_rpc_types`: 0.1.0 * `sol_rpc_canister`: 0.1.0 * `sol_rpc_client`: 0.1.0 <details><summary>Changelog</summary> ## `sol_rpc_types` <blockquote> ## [0.1.0] - 2025-04-29 ### Added - Add Rustdoc for types related to `getTransaction` ([#71](#71)) - Add support for `getTransaction` RPC method ([#68](#68)) - Add `getBlock` RPC method ([#53](#53)) - Add `sendTransaction` RPC method ([#59](#59)) - Add NOTICE to Apache license ([#60](#60)) - Add `getAccountInfo` RPC method ([#49](#49)) - Add metrics ([#41](#41)) - Add logging crate ([#13](#13)) - Add doc build stage to CI ([#19](#19)) - Add support for override providers ([#12](#12)) ### Changed - Use `canlog_derive` and `canlog` from crates.io ([#84](#84)) - Release pipeline ([#4](#4)) - Default commitment level for `SolRpcClient` ([#77](#77)) - Support method `getBalance` ([#74](#74)) - Rename some enum variants to camel case when serializing ([#72](#72)) - Use SOL RPC canister in `basic_solana` example ([#69](#69)) - Add basic README instructions ([#63](#63)) - Cycles cost ([#52](#52)) - Client builder ([#54](#54)) - Round result from `getSlot` RPC method ([#48](#48)) - Use `canhttp` `multi` feature ([#46](#46)) - Implement getSlot RPC method ([#33](#33)) - Add some tested RPC providers for Solana Mainnet and Devnet ([#15](#15)) - Streamline providers ([#32](#32)) - Add support for API keys ([#10](#10)) - Hard-code SOL RPC providers ([#9](#9)) - Basic Solana wallet example ([#1](#1)) - Initial cargo workspace and build pipeline ([#2](#2)) ### Fixed - Correct Solana cluster for dRPC and Helius providers ([#47](#47))  Changelog All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). </blockquote> ## `sol_rpc_canister` <blockquote> ## [0.1.0] - 2025-04-29 ### Added - Add support for `getTransaction` RPC method ([#68](#68)) - Add `getBlock` RPC method ([#53](#53)) - Add `sendTransaction` RPC method ([#59](#59)) - Add NOTICE to Apache license ([#60](#60)) - Add `getAccountInfo` RPC method ([#49](#49)) - Add metrics ([#41](#41)) - Add logging crate ([#13](#13)) - Add support for override providers ([#12](#12)) ### Changed - Use `canlog_derive` and `canlog` from crates.io ([#84](#84)) - Release pipeline ([#4](#4)) - Clean-up TODOs ([#81](#81)) - Support method `getBalance` ([#74](#74)) - Remove http_types module and use external ic-http-types crate ([#73](#73)) - Rename some enum variants to camel case when serializing ([#72](#72)) - Use constant size JSON-RPC request ID ([#62](#62)) - Use method from JSON-RPC request for metric ([#61](#61)) - Cycles cost ([#52](#52)) - Client builder ([#54](#54)) - Round result from `getSlot` RPC method ([#48](#48)) - Use `canhttp` `multi` feature ([#46](#46)) - Implement a method for making generic RPC request ([#39](#39)) - Implement getSlot RPC method ([#33](#33)) - Add some tested RPC providers for Solana Mainnet and Devnet ([#15](#15)) - Streamline providers ([#32](#32)) - Update rust toolchain to 1.85 ([#21](#21)) - Remove unnecessary Storable implementations ([#14](#14)) - Add support for API keys ([#10](#10)) - Hard-code SOL RPC providers ([#9](#9)) - Reproducible build ([#3](#3)) - Initial cargo workspace and build pipeline ([#2](#2)) ### Fixed - Set `maxSupportedTransactionVersion` to zero for end-to-end tests ([#85](#85)) - API keys ([#58](#58)) - End-to-end tests ([#45](#45)) - Correct Solana cluster for dRPC and Helius providers ([#47](#47)) - E2e test with Solana test validator ([#20](#20)) - Create test canister on ICP mainnet ([#8](#8))  Changelog All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). </blockquote> ## `sol_rpc_client` <blockquote> ## [0.1.0] - 2025-04-29 ### Added - Add support for `getTransaction` RPC method ([#68](#68)) - Add `getBlock` RPC method ([#53](#53)) - Add `sendTransaction` RPC method ([#59](#59)) - Add NOTICE to Apache license ([#60](#60)) - Add `getAccountInfo` RPC method ([#49](#49)) ### Changed - Release pipeline ([#4](#4)) - Default commitment level for `SolRpcClient` ([#77](#77)) - Support method `getBalance` ([#74](#74)) - Use SOL RPC canister in `basic_solana` example ([#69](#69)) - Rust documentation tests for the `SolRpcClient` ([#65](#65)) - Add basic README instructions ([#63](#63)) - Cycles cost ([#52](#52)) - Client builder ([#54](#54)) - Round result from `getSlot` RPC method ([#48](#48)) - Use `canhttp` `multi` feature ([#46](#46)) - Implement a method for making generic RPC request ([#39](#39)) - Implement getSlot RPC method ([#33](#33)) - Streamline providers ([#32](#32)) - Add support for API keys ([#10](#10)) - Hard-code SOL RPC providers ([#9](#9)) - Initial cargo workspace and build pipeline ([#2](#2)) ### Fixed - Forward calls through wallet canister ([#40](#40)) - E2e test with Solana test validator ([#20](#20))  Changelog All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). </blockquote> </details> --- This PR was generated with [release-plz](https://github.com/release-plz/release-plz/). --------- Co-authored-by: gregorydemay <gregory.demay@dfinity.org> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

## 🤖 New release * `sol_rpc_canister`: 0.2.0 <details><summary>Changelog</summary> <blockquote> ## [0.2.0] - 2025-05-27 ### Added - Add client method to sign a transaction ([#113](#113)) - Add Chainstack RPC provider ([#118](#118)) - Add support for `getSignaturesForAddress` ([#106](#106)) - Add support for `getSignatureStatuses` RPC method ([#96](#96)) - Add support for `getTokenAccountBalance` RPC method ([#90](#90)) - Add support for `getTransaction` RPC method ([#68](#68)) - Add `getBlock` RPC method ([#53](#53)) - Add `sendTransaction` RPC method ([#59](#59)) - Add NOTICE to Apache license ([#60](#60)) - Add `getAccountInfo` RPC method ([#49](#49)) - Add metrics ([#41](#41)) - Add logging crate ([#13](#13)) - Add support for override providers ([#12](#12)) ### Changed - Bump version to 0.2 - Candid NonZeroU8 ([#108](#108)) - Add `RoundingError` to `sol_rpc_types` ([#105](#105)) - Use secure primitive types for `Pubkey`, `Signature` and `Hash` ([#98](#98)) - Add support for `getRecentPrioritizationFees` ([#92](#92)) - Simplify API keys provisioning script ([#89](#89)) - Release v0.1.0 ([#88](#88)) - Use `canlog_derive` and `canlog` from crates.io ([#84](#84)) - Release pipeline ([#4](#4)) - Clean-up TODOs ([#81](#81)) - Support method `getBalance` ([#74](#74)) - Remove http_types module and use external ic-http-types crate ([#73](#73)) - Rename some enum variants to camel case when serializing ([#72](#72)) - Use constant size JSON-RPC request ID ([#62](#62)) - Use method from JSON-RPC request for metric ([#61](#61)) - Cycles cost ([#52](#52)) - Client builder ([#54](#54)) - Round result from `getSlot` RPC method ([#48](#48)) - Use `canhttp` `multi` feature ([#46](#46)) - Implement a method for making generic RPC request ([#39](#39)) - Implement getSlot RPC method ([#33](#33)) - Add some tested RPC providers for Solana Mainnet and Devnet ([#15](#15)) - Streamline providers ([#32](#32)) - Update rust toolchain to 1.85 ([#21](#21)) - Remove unnecessary Storable implementations ([#14](#14)) - Add support for API keys ([#10](#10)) - Hard-code SOL RPC providers ([#9](#9)) - Reproducible build ([#3](#3)) - Initial cargo workspace and build pipeline ([#2](#2)) ### Fixed - Missing `TraceHttp` logs ([#129](#129)) - End-to-end tests for `sendTransaction` ([#104](#104)) - Unit test for `getRecentPrioritizationFees` parameters serialization ([#107](#107)) - Integration test for `verifyApiKey` ([#82](#82)) - Set `maxSupportedTransactionVersion` to zero for end-to-end tests ([#85](#85)) - API keys ([#58](#58)) - End-to-end tests ([#45](#45)) - Correct Solana cluster for dRPC and Helius providers ([#47](#47)) - E2e test with Solana test validator ([#20](#20)) - Create test canister on ICP mainnet ([#8](#8)) ### Removed - Remove default/non-default providers ([#122](#122)) </blockquote> </details> --- This PR was generated with [release-plz](https://github.com/release-plz/release-plz/). --------- Co-authored-by: gregorydemay <gregory.demay@dfinity.org> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

## 🤖 New release * `sol_rpc_canister`: 1.0.0 <details><summary>Changelog</summary> <blockquote> ## [1.0.0] - 2025-06-12 ### Added - Add support for `transactionDetails=accounts` ([#139](#139)) - Add support for `rewards` parameter for `getBlock` ([#135](#135)) - Add helper methods for request builders ([#136](#136)) - Add client method to sign a transaction ([#113](#113)) - Add Chainstack RPC provider ([#118](#118)) - Add support for `getSignaturesForAddress` ([#106](#106)) - Add support for `getSignatureStatuses` RPC method ([#96](#96)) - Add support for `getTokenAccountBalance` RPC method ([#90](#90)) - Add support for `getTransaction` RPC method ([#68](#68)) - Add `getBlock` RPC method ([#53](#53)) - Add `sendTransaction` RPC method ([#59](#59)) - Add NOTICE to Apache license ([#60](#60)) - Add `getAccountInfo` RPC method ([#49](#49)) - Add metrics ([#41](#41)) - Add logging crate ([#13](#13)) - Add support for override providers ([#12](#12)) ### Changed - Bump to 1.0.0 - Inline request parameters `is_default_config` methods ([#138](#138)) - Release v0.2.0 ([#131](#131)) - Bump version and use a release notes template ([#130](#130)) - Candid NonZeroU8 ([#108](#108)) - Add `RoundingError` to `sol_rpc_types` ([#105](#105)) - Use secure primitive types for `Pubkey`, `Signature` and `Hash` ([#98](#98)) - Add support for `getRecentPrioritizationFees` ([#92](#92)) - Simplify API keys provisioning script ([#89](#89)) - Release v0.1.0 ([#88](#88)) - Use `canlog_derive` and `canlog` from crates.io ([#84](#84)) - Release pipeline ([#4](#4)) - Clean-up TODOs ([#81](#81)) - Support method `getBalance` ([#74](#74)) - Remove http_types module and use external ic-http-types crate ([#73](#73)) - Rename some enum variants to camel case when serializing ([#72](#72)) - Use constant size JSON-RPC request ID ([#62](#62)) - Use method from JSON-RPC request for metric ([#61](#61)) - Cycles cost ([#52](#52)) - Client builder ([#54](#54)) - Round result from `getSlot` RPC method ([#48](#48)) - Use `canhttp` `multi` feature ([#46](#46)) - Implement a method for making generic RPC request ([#39](#39)) - Implement getSlot RPC method ([#33](#33)) - Add some tested RPC providers for Solana Mainnet and Devnet ([#15](#15)) - Streamline providers ([#32](#32)) - Update rust toolchain to 1.85 ([#21](#21)) - Remove unnecessary Storable implementations ([#14](#14)) - Add support for API keys ([#10](#10)) - Hard-code SOL RPC providers ([#9](#9)) - Reproducible build ([#3](#3)) - Initial cargo workspace and build pipeline ([#2](#2)) ### Fixed - Missing `TraceHttp` logs ([#129](#129)) - End-to-end tests for `sendTransaction` ([#104](#104)) - Unit test for `getRecentPrioritizationFees` parameters serialization ([#107](#107)) - Integration test for `verifyApiKey` ([#82](#82)) - Set `maxSupportedTransactionVersion` to zero for end-to-end tests ([#85](#85)) - API keys ([#58](#58)) - End-to-end tests ([#45](#45)) - Correct Solana cluster for dRPC and Helius providers ([#47](#47)) - E2e test with Solana test validator ([#20](#20)) - Create test canister on ICP mainnet ([#8](#8)) ### Removed - Remove default/non-default providers ([#122](#122)) </blockquote> </details> --- This PR was generated with [release-plz](https://github.com/release-plz/release-plz/). --------- Co-authored-by: gregorydemay <gregory.demay@dfinity.org> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: gregorydemay <112856886+gregorydemay@users.noreply.github.com>

gregorydemay added 19 commits April 1, 2025 10:35

XC-321: move retrieve_logs and verify_api_keys to setup

e12f0f0

XC-321: client builder

1e7fcd8

XC-321: mock API keys

30ca1aa

XC-321: request builder

513783b

XC-321: refactor getSlot

ff61b97

XC-321: refactor request

5a72ec8

XC-321: added docs

15a9fd6

XC-321: prod canister

778d17f

XC-321: examples

e2ab03e

XC-321: fix docs

11b58b8

Merge branch 'main' into gdemay/XC-321-client-request-builder

6cfd8c8

# Conflicts: # integration_tests/tests/solana_test_validator.rs # integration_tests/tests/tests.rs # libs/client/src/lib.rs

XC-321: generic over RPC config

3f1af2f

XC-321: refactor to use SolRpcRequest trait

620c38c

XC-327: map client output

7dd9a2a

XC-327: requestCost skeletton

66f59c6

XC-327: PoC

45b26ce

XC-321: getSlot test

c572adf

XC-321: sol_rpc_canister_cycles_balance method

05b753d

XC-321: integration test with cycles

597d88b

gregorydemay force-pushed the gdemay/XC-321-cycles-cost branch from 27dae5b to 597d88b Compare April 2, 2025 11:36

gregorydemay changed the base branch from main to gdemay/XC-321-client-request-builder April 2, 2025 11:37

gregorydemay added 4 commits April 2, 2025 13:57

XC-321: Clone on RequestBuilder

cf1bffe

XC-321: fix GetSlotRpcConfig

8a06f7b

XC-321: skeletton request_cost as part of RequestBuilder

9269669

XC-321: add request cost

ced0dd4

Base automatically changed from gdemay/XC-321-client-request-builder to main April 4, 2025 08:48

gregorydemay added 4 commits April 4, 2025 11:48

Merge branch 'main' into gdemay/XC-321-cycles-cost

f862c27

# Conflicts: # integration_tests/src/lib.rs # integration_tests/src/mock.rs # integration_tests/tests/solana_test_validator.rs # integration_tests/tests/tests.rs # libs/client/src/lib.rs # libs/client/src/request/mod.rs

XC-321: delete empty file

644c95b

XC-321: ensure that cycles cost is tight

c69dad9

XC-321: remove useless logs

175c380

gregorydemay commented Apr 7, 2025

View reviewed changes

canister/src/providers/tests.rs Show resolved Hide resolved

gregorydemay requested review from lpahlavi and ninegua April 7, 2025 09:56

lpahlavi reviewed Apr 7, 2025

View reviewed changes

canister/sol_rpc_canister.did Show resolved Hide resolved

canister/src/main.rs Show resolved Hide resolved

canister/src/main.rs Show resolved Hide resolved

canister/src/rpc_client/mod.rs Outdated Show resolved Hide resolved

ninegua approved these changes Apr 8, 2025

View reviewed changes

canister/src/rpc_client/mod.rs Show resolved Hide resolved

gregorydemay added 10 commits April 8, 2025 14:25

Merge branch 'main' into gdemay/XC-321-cycles-cost

ec51585

# Conflicts: # Cargo.lock # canister/sol_rpc_canister.did # canister/src/candid_rpc/mod.rs # canister/src/main.rs # canister/src/rpc_client/mod.rs # libs/client/Cargo.toml # libs/client/src/lib.rs # libs/client/src/request/mod.rs

XC-321: MultiRpcRequest for GetAccountInfo

60bcdb9

XC-321: fix candid interface

2c77436

XC-321: fix tests

285d47f

XC-321: fix getAccountInfo JSON response type

9c75632

XC-321: fix should_get_exact_cycles_cost

6ad0b91

XC-321: rename to jsonRequest

5964964

XC-321: added test should_be_zero_when_in_demo_mode

1a71829

XC-321: fix cycles in examples

1e57fce

XC-321: refactor based on reviewers' feedback

540f2f8

gregorydemay commented Apr 8, 2025

View reviewed changes

canister/sol_rpc_canister.did Show resolved Hide resolved

canister/src/main.rs Show resolved Hide resolved

canister/src/main.rs Show resolved Hide resolved

canister/src/rpc_client/mod.rs Show resolved Hide resolved

canister/src/rpc_client/mod.rs Outdated Show resolved Hide resolved

gregorydemay mentioned this pull request Apr 9, 2025

feat: add sendTransaction RPC method #59

Merged

lpahlavi approved these changes Apr 9, 2025

View reviewed changes

canister/sol_rpc_canister.did Show resolved Hide resolved

canister/src/main.rs Show resolved Hide resolved

gregorydemay merged commit 0a24245 into main Apr 9, 2025
11 checks passed

gregorydemay deleted the gdemay/XC-321-cycles-cost branch April 9, 2025 08:29

gregorydemay mentioned this pull request Apr 9, 2025

refactor: use method from JSON-RPC request for metric #61

Merged

gregorydemay added a commit that referenced this pull request Apr 10, 2025

refactor: use method from JSON-RPC request for metric (#61)

3a78c90

Follow-up on #52 to use the `method` specified by the JSON-RPC request for metrics purposes instead of having a separate enum.

This was referenced Apr 28, 2025

chore: release v0.1.0 #83

Closed

chore: release v0.1.0 #88

Merged

github-actions bot mentioned this pull request May 27, 2025

chore: release v0.2.0 #131

Merged

github-actions bot mentioned this pull request Jun 12, 2025

chore: release v1.0.0 #146

Merged

github-actions bot mentioned this pull request Jul 31, 2025

chore: release #189

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: cycles cost#52

feat: cycles cost#52
gregorydemay merged 48 commits intomainfrom
gdemay/XC-321-cycles-cost

gregorydemay commented Mar 31, 2025 •

edited

Loading

Uh oh!

Uh oh!

lpahlavi left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gregorydemay left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lpahlavi left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

gregorydemay commented Mar 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

lpahlavi left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gregorydemay left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lpahlavi left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

gregorydemay commented Mar 31, 2025 •

edited

Loading