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

lpahlavi · 2025-05-05T12:59:39Z

(XC-325) Add support for the getTokenAccountBalance Solana RPC method.

lpahlavi · 2025-05-05T13:01:47Z

examples/basic_solana/basic_solana.did

    //
    // If no account is provided, the account derived from the caller's principal is used.
-    get_spl_token_balance : (account: opt Address, mint_account: Address) -> (nat);
+    get_spl_token_balance : (account: opt Address, mint_account: Address) -> (text);


I went for the simple option of returning the already formatted balance as I find it adds unnecessary complexity to introduce a new Candid type for UiTokenAmount given that this is just a basic example.

This was mentioned in a previous PR by @ninegua , but we need here also the number of decimals for the example to make sense. Since we can reuse the sol_rpc_types::TokenAmount, I think it's just a matter of copying the Candid declaration here, which should not be too much. WDYT?

I thought that returning the UI amount (i.e. a formatted float, including decimals) would be fine and maybe make the example easier. I don't have a strong opinion on this though, returning the full result is fine by me as well. Done.

integration_tests/tests/solana_test_validator.rs

canister/src/rpc_client/sol_rpc/mod.rs

gregorydemay

Thanks for this PR @lpahlavi ! Some minor comments.

canister/sol_rpc_canister.did

canister/src/rpc_client/mod.rs

canister/src/rpc_client/tests.rs

gregorydemay · 2025-05-06T12:23:13Z

examples/basic_solana/basic_solana.did

    //
    // If no account is provided, the account derived from the caller's principal is used.
-    get_spl_token_balance : (account: opt Address, mint_account: Address) -> (nat);
+    get_spl_token_balance : (account: opt Address, mint_account: Address) -> (text);


This was mentioned in a previous PR by @ninegua , but we need here also the number of decimals for the example to make sense. Since we can reuse the sol_rpc_types::TokenAmount, I think it's just a matter of copying the Candid declaration here, which should not be too much. WDYT?

examples/basic_solana/src/main.rs

gregorydemay · 2025-05-06T12:25:31Z

examples/basic_solana/tests/tests.rs

        .expect("Missing user's associated token account");
    assert_eq!(token_account.token_amount.amount, "999999000");
-    let sender_spl_balance: Nat = basic_solana.update_call(
+    let sender_spl_balance: String = basic_solana.update_call(


It makes more sense to have the balance has an integer IMO, but that should be trivial once we give back the TokenAmount.

I used the TokenAmount type here instead.

libs/client/src/lib.rs

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

XC-325: Add support for getTokenAccountBalance RPC method

37582a9

lpahlavi commented May 5, 2025

View reviewed changes

integration_tests/tests/solana_test_validator.rs Show resolved Hide resolved

XC-325: Add end-to-end test

f98bd2e

lpahlavi marked this pull request as ready for review May 5, 2025 13:36

lpahlavi requested a review from a team as a code owner May 5, 2025 13:36

ninegua reviewed May 6, 2025

View reviewed changes

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

XC-325: Revert unnecessary change

9e92db1

gregorydemay self-requested a review May 6, 2025 12:06

gregorydemay approved these changes May 6, 2025

View reviewed changes

ninegua approved these changes May 6, 2025

View reviewed changes

XC-325: Address review feedback

66dc838

lpahlavi merged commit 743018c into main May 7, 2025
12 checks passed

lpahlavi deleted the lpahlavi/XC-325-get-token-account-balance branch May 7, 2025 09:27

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: add support for `getTokenAccountBalance` RPC method#90

feat: add support for `getTokenAccountBalance` RPC method#90
lpahlavi merged 4 commits intomainfrom
lpahlavi/XC-325-get-token-account-balance

lpahlavi commented May 5, 2025 •

edited

Loading

Uh oh!

lpahlavi May 5, 2025

Uh oh!

gregorydemay May 6, 2025

Uh oh!

lpahlavi May 7, 2025

Uh oh!

Uh oh!

Uh oh!

gregorydemay left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gregorydemay May 6, 2025

Uh oh!

Uh oh!

gregorydemay May 6, 2025

Uh oh!

lpahlavi May 7, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

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

Uh oh!

Uh oh!

lpahlavi May 5, 2025

Choose a reason for hiding this comment

Uh oh!

gregorydemay May 6, 2025

Choose a reason for hiding this comment

Uh oh!

lpahlavi May 7, 2025

Choose a reason for hiding this comment

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!

gregorydemay May 6, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

gregorydemay May 6, 2025

Choose a reason for hiding this comment

Uh oh!

lpahlavi May 7, 2025

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

lpahlavi commented May 5, 2025 •

edited

Loading