feat(keyring-api): add optional Balance.metadata#601
Open
ccharly wants to merge 7 commits into
Open
Conversation
ccharly
marked this pull request as ready for review
July 22, 2026 13:04
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, have a team admin enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit c31e9cf. Configure here.
ccharly
commented
Jul 22, 2026
| * Asset amount. | ||
| */ | ||
| amount: StringNumberStruct, | ||
| ...BalanceStruct.schema, |
Contributor
Author
There was a problem hiding this comment.
Just re-inject this schema to avoid drifting. (I almost missed it initially, but Cursor reported it, so I think this refactor makes sense to avoid that in the future)
ccharly
enabled auto-merge
July 22, 2026 14:51
ccharly
disabled auto-merge
July 22, 2026 14:51
Balance.metadata
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
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.

Adding a new
metadatafield forBalanceStruct. This way, asset balances can now provide more "specific" information alongside the current balance.There is not defined shape, we leave it for the consumer and producer to be in-sync regarding the content of it.
Note
Low Risk
Backward-compatible optional API field on balance/asset structs with added tests; no auth, security, or runtime behavior changes in this diff.
Overview
Adds an optional
metadatafield onBalanceStructso producers can attach extra JSON-compatible key/value data next toamountandunit. Validation usesexactOptional(record(string(), JsonStruct)), so the key must be omitted when unused (notundefined) and values must be JSON-safe.FungibleAssetAmountStructnow spreadsBalanceStruct.schemainstead of inliningunit/amount, so fungibleAssetbalances pick upmetadatawithout duplicating fields. Type and runtime tests cover valid metadata onBalanceand fungible assets, plus rejection of invalid shapes.Reviewed by Cursor Bugbot for commit c51e757. Bugbot is set up for automated code reviews on this repo. Configure here.