feat: add support for `getSignatureStatuses` RPC method by lpahlavi · Pull Request #96 · dfinity/sol-rpc-canister

lpahlavi · 2025-05-08T10:42:39Z

(XC-291) Add support for getSignatureStatuses RPC method.

Due to the fast-changing value of the confirmations field in the response of getSignatureStatuses, it is set to null in the response transform. This was done to achieve consensus. Rounding is not performed on this value since a value of null is anyways returned after a supermajority of the cluster finalized the transaction, meaning its value is short-lived and the rounded value would not be of much use.

gregorydemay

Thanks for this PR @lpahlavi! A few comments, mostly minor.

libs/types/src/solana/request/mod.rs

canister/src/rpc_client/json/mod.rs

canister/sol_rpc_canister.did

canister/src/rpc_client/mod.rs

integration_tests/tests/solana_test_validator.rs

libs/client/src/lib.rs

libs/types/src/solana/request/mod.rs

canister/sol_rpc_canister.did

gregorydemay

Thanks for the changes! The "main" last point is the deserialization of GetSignatureStatusesParams to ensure that it fails if there are too many signatures.

canister/src/rpc_client/mod.rs

libs/client/src/lib.rs

README.md

lpahlavi · 2025-05-14T09:48:01Z

Thanks for the re-review @gregorydemay! I added a new type in sol_rpc_types to handle vectors with a maximum capacity. I think this makes the most sense IMO since this way once can never instantiate e.g. getSignatureStatuses request parameters with too many signatures, whether through deserialization or direct instantiation. As a bonus I could re-use this for the getRecentPrioritizationFees request parameters. Let me know what you think!

gregorydemay

Thanks @lpahlavi for this PR! A couple of minor comments but otherwise LGTM!

integration_tests/tests/tests.rs

libs/client/src/lib.rs

gregorydemay · 2025-05-14T13:02:06Z

libs/types/src/solana/mod.rs

+
+/// A vector with a maximum capacity.
+#[derive(Debug, Clone, Deserialize, Serialize, CandidType, PartialEq, Default)]
+#[serde(try_from = "Vec<T>")]


shouldn't we have also into Vec<T> for serialization?

Suggested change

#[serde(try_from = "Vec<T>")]

#[serde(try_from = "Vec<T>", into="Vec<T>")]

Hm I added some tests to make sure that encoding/decoding round trips with Candid work and it seems this is not necessary. Furthermore, adding this forces us to add the Clone restriction on the generic type T so I think I will not add it. WDYT?

Hm I added some tests to make sure that encoding/decoding round trips with Candid work and it seems this is not necessary.

I think that's expected because we only use those Candid types to deserialize user inputs, but the Candid encoding of MaxVecLength would result in different bytes than the Candid encoding of the underlying Vec, which is I think unexpected. To test this you do a test similar to this one.

adding this forces us to add the Clone restriction on the generic type T

I'm not following why Clone, the bound should be T: Serialize, no?

libs/types/src/solana/mod.rs

libs/types/src/solana/request/tests.rs

lpahlavi

Thank you for the review @gregorydemay!

libs/types/src/solana/request/tests.rs

lpahlavi · 2025-05-14T14:33:45Z

libs/types/src/solana/mod.rs

+
+/// A vector with a maximum capacity.
+#[derive(Debug, Clone, Deserialize, Serialize, CandidType, PartialEq, Default)]
+#[serde(try_from = "Vec<T>")]


Hm I added some tests to make sure that encoding/decoding round trips with Candid work and it seems this is not necessary. Furthermore, adding this forces us to add the Clone restriction on the generic type T so I think I will not add it. WDYT?

libs/types/src/solana/mod.rs

libs/client/src/lib.rs

integration_tests/tests/tests.rs

canister/src/rpc_client/mod.rs

Follow-up on #92 and #96 to add a detailed table explaining the supported methods and their current limitations.

## 🤖 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>

lpahlavi added 4 commits May 8, 2025 12:41

XC-291: Add support for getSignatureStatuses RPC method

db51eba

XC-291: Add Candid interface and integration tests

4f4cff1

XC-291: Ignore TransactionStatus#Confirmations

0ab752a

XC-291: Fix link in doc

13701fd

lpahlavi marked this pull request as ready for review May 9, 2025 11:07

lpahlavi requested a review from a team as a code owner May 9, 2025 11:07

lpahlavi added 3 commits May 9, 2025 13:34

XC-291: Add end-to-end test

ec7ccdc

XC-291: Fix Candid encoding

86d5285

XC-291: Fix bash typo

c91474e

lpahlavi requested review from gregorydemay and ninegua May 12, 2025 13:29

gregorydemay reviewed May 12, 2025

View reviewed changes

lpahlavi added 3 commits May 13, 2025 11:47

XC-339: Address review feedback

05b17a0

Merge branch 'main' into lpahlavi/XC-291-get-signature-statuses

d292201

XC-339: Clippy

36e70b1

lpahlavi requested a review from gregorydemay May 13, 2025 12:36

gregorydemay reviewed May 13, 2025

View reviewed changes

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

libs/client/src/lib.rs Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

lpahlavi added 5 commits May 13, 2025 17:37

XC-339: Remove is_default_config method

61b3e00

XC-339: Fix todos

209dc16

Merge branch 'main' into lpahlavi/XC-291-get-signature-statuses

299f683

XC-291: Introduce vector with max capacity

9b7226a

XC-291: Clippy

3e17e06

lpahlavi requested a review from gregorydemay May 14, 2025 10:03

gregorydemay approved these changes May 14, 2025

View reviewed changes

lpahlavi added 2 commits May 14, 2025 16:31

XC-291: Address review feedback

824b15b

XC-291: Fix inclusive ranges

c02d177

lpahlavi commented May 14, 2025

View reviewed changes

lpahlavi added 2 commits May 14, 2025 17:53

XC-291: Fix doctest bug with u8 wrap around

fe5aa48

Merge branch 'main' into lpahlavi/XC-291-get-signature-statuses

093878b

XC-291: Fix doctest

26d503c

lpahlavi merged commit d625b8f into main May 14, 2025
12 checks passed

lpahlavi deleted the lpahlavi/XC-291-get-signature-statuses branch May 14, 2025 17:14

gregorydemay mentioned this pull request May 20, 2025

docs: table for supported methods and known limitations #116

Merged

gregorydemay added a commit that referenced this pull request May 21, 2025

docs: table for supported methods and known limitations (#116)

8c20f91

Follow-up on #92 and #96 to add a detailed table explaining the supported methods and their current limitations.

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

	#[serde(try_from = "Vec<T>")]
	#[serde(try_from = "Vec<T>", into="Vec<T>")]

Conversation

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

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!

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!

lpahlavi commented May 14, 2025

Uh oh!

gregorydemay left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

gregorydemay May 14, 2025

Choose a reason for hiding this comment

Uh oh!

lpahlavi May 14, 2025

Choose a reason for hiding this comment

Uh oh!

gregorydemay May 14, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

lpahlavi left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

lpahlavi May 14, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

lpahlavi commented May 8, 2025 •

edited

Loading