Skip to content

docs(assets-controller): correct raw-vs-converted balance comments #10469

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Kriys94 merged 4 commits into from
Sep 25, 2026
Merged

docs(assets-controller): correct raw-vs-converted balance comments #10469

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8ae5dfe
docs(assets-controller): correct raw-vs-converted balance comments
Prithpal-Sooriya Sep 25, 2026
fc1d110
chore(assets-controller): add changelog entry for #10469
Prithpal-Sooriya Sep 25, 2026
a64ecdb
chore(assets-controller): merge main into docs branch
Prithpal-Sooriya Sep 25, 2026
abdcbbc
chore(assets-controller): remove changelog entry for #10469
Prithpal-Sooriya Sep 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions packages/assets-controller/src/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -299,8 +299,8 @@ destroy()
// Per-account balances
assetsBalance: {
"account-uuid-1": {
"eip155:1/slip44:60": { amount: "1000000000000000000" },
"eip155:1/erc20:0xA0b8...": { amount: "1000000" },
"eip155:1/slip44:60": { amount: "1" },
"eip155:1/erc20:0xA0b8...": { amount: "1" },
},
"account-uuid-2": { ... },
},
Expand Down Expand Up @@ -411,7 +411,7 @@ const balances = await messenger.call(
Record<AccountId, Record<Caip19AssetId, AssetBalance>>;

interface AssetBalance {
amount: string; // Raw amount as string (e.g., "1000000000000000000" for 1 ETH)
amount: string; // Converted amount (e.g., "1" for 1 ETH)
}
```

Expand All @@ -427,7 +427,7 @@ const balances = await messenger.call(
},
);

// Get raw ETH balance
// Get ETH balance
const ethBalance = balances[accountId]['eip155:1/slip44:60'].amount;
```

Expand Down Expand Up @@ -536,7 +536,7 @@ await messenger.call(
{
assetsBalance: {
'account-uuid-1': {
'eip155:1/slip44:60': { amount: '1000000000000000000' },
'eip155:1/slip44:60': { amount: '1' },
},
},
},
Expand Down Expand Up @@ -589,8 +589,8 @@ messenger.subscribe('AssetsController:balanceChanged', (event) => {
{
accountId: AccountId; // Account UUID
assetId: Caip19AssetId; // "eip155:1/slip44:60"
previousAmount: string; // "1000000000000000000"
newAmount: string; // "2000000000000000000"
previousAmount: string; // "1"
newAmount: string; // "2"
}
```

Expand Down
2 changes: 1 addition & 1 deletion packages/assets-controller/src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -274,7 +274,7 @@ export type AssetPrice = FungibleAssetPrice | NFTAssetPrice;
* Balance data for fungible tokens (native, ERC20, SPL).
*/
export type FungibleAssetBalance = {
/** Raw balance amount as string (e.g., "1000000000" for 1000 USDC) */
/** Converted balance amount (e.g., "1000" for 1000 USDC) */
amount: string;
/**
* Network-specific balance fields, when the source provides them. Stellar
Expand Down
Loading