Skip to content

feat: add balance metadata for snap datasource [DO NOT MERGE] #9564

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

Open
stanleyyconsensys wants to merge 1 commit into
base: main
Choose a base branch
from
+4 −1
Open

feat: add balance metadata for snap datasource [DO NOT MERGE] #9564

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 4 additions & 1 deletion packages/assets-controller/src/data-sources/SnapDataSource.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ export type AccountBalancesUpdatedEventPayload = {
[assetId: string]: {
amount: string;
unit: string;
metadata?: Record<string, Json>;

@stanleyyconsensys stanleyyconsensys Jul 21, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add metadata into snap balance update event payload type

@Prithpal-Sooriya Prithpal-Sooriya Jul 21, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want type enforced payloads?

E.g. a typed descriminated union?

@Prithpal-Sooriya Prithpal-Sooriya Jul 21, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or maybe we can enforce a schema for runtime validation & parsing?

@stanleyyconsensys stanleyyconsensys Jul 21, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i think in future
some snap may still using SNAP path to sync data, those data will not able to predict

adding validation may also adding a complexity on how snap ship data to controller

and it require bump up to controller when the data sharp change..., so i will suggest leave it as this (should align with keyring API)

};
};
};
Expand Down Expand Up @@ -292,6 +293,7 @@ export class SnapDataSource extends AbstractDataSource<
accountAssets ??= {};
accountAssets[assetId as Caip19AssetId] = {
amount: balance.amount,
...(balance.metadata ? { metadata: balance.metadata } : {}),

@stanleyyconsensys stanleyyconsensys Jul 21, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

when persist balance data via event, we persist metadata together if any

type AssetBalance already ready to store metadata

};
}
}
Expand Down Expand Up @@ -483,7 +485,7 @@ export class SnapDataSource extends AbstractDataSource<
}

// Step 2: Get balances for those specific assets
const balances: Record<CaipAssetType, Balance> =
const balances: Record<CaipAssetType, Balance & { metadata?: Json }> =

@stanleyyconsensys stanleyyconsensys Jul 21, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

mock keyring type

await client.getAccountBalances(
accountId,
accountAssets as CaipAssetType[],
Expand All @@ -497,6 +499,7 @@ export class SnapDataSource extends AbstractDataSource<
if (accountBalances) {
(accountBalances as Record<string, unknown>)[assetId] = {
amount: balance.amount,
...(balance.metadata ? { metadata: balance.metadata } : {}),

@stanleyyconsensys stanleyyconsensys Jul 21, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

when persist balance data via keyring API get balance, we persist metadata together if any

};
}
}
Expand Down
Loading