Add read_address_balance API
#24692
Open
Add read_address_balance API
#24692
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mystenmark
temporarily deployed
to
sui-typescript-aws-kms-test-env
GitHub Actions
Inactive
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
mystenmark
temporarily deployed
to
sui-typescript-aws-kms-test-env
GitHub Actions
Inactive
tnowacki
reviewed
Dec 18, 2025
Comment on lines
117
to
130
| /// Read the balance of an address as of the beginning of the current consensus commit. | ||
| /// Can read either address-owned or object-owned balances. | ||
| public fun read_address_balance<T>( | ||
| root: &sui::accumulator::AccumulatorRoot, | ||
| address: address, | ||
| ): u64 { | ||
| if (!root.u128_exists<Balance<T>>(address)) { | ||
| return 0 | ||
| }; | ||
| let val: u128 = root.u128_read<Balance<T>>(address); | ||
| let val = std::u128::min(std::u64::max_value!() as u128, val); | ||
| val as u64 | ||
| } | ||
|
|
Contributor
There was a problem hiding this comment.
I will take a deeper look in a bit, but my initial reaction is that this should belong in funds_accumulator.
It can do something like
/// Where `U` is the underlying integer type of `T`
/// This avoids needing 6 different APIs for each type--each of which would need
/// to assert the underlying integer type anyway
public fun read_funds_balance<T, U>(
root: &sui::accumulator::AccumulatorRoot,
_: internal::Permit<T>,
owner: address,
): U;
Contributor
Author
There was a problem hiding this comment.
can you get the max for an integer type parametrically? if not I'm not sure how much this will save.
|
|
||
| /// Read the balance of an address as of the beginning of the current consensus commit. | ||
| /// Can read either address-owned or object-owned balances. | ||
| public fun read_address_balance<T>( |
Contributor
There was a problem hiding this comment.
This should probably be something like
Suggested change
| public fun read_address_balance<T>( | |
| public fun initial_funds_balance<T>( |
initial might not be the right word but we need 4 distinct concepts
- At the start of the transaction
- deposits
- withdrawals
- current/net (initial + withdrawals - deposits)
Contributor
Author
There was a problem hiding this comment.
how about read_settled_address_balance?
mystenmark
force-pushed
the
mlogan-read-obj-balance
branch
from
3729ce7 to
2b290e8
Compare
mystenmark
temporarily deployed
to
sui-typescript-aws-kms-test-env
GitHub Actions
Inactive
mystenmark
force-pushed
the
mlogan-read-obj-balance
branch
from
2b290e8 to
c94cbd3
Compare
mystenmark
temporarily deployed
to
sui-typescript-aws-kms-test-env
GitHub Actions
Inactive
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.