Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion eslint-suppressions.json
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@
},
"packages/assets-controller/src/data-sources/SnapDataSource.ts": {
"no-restricted-syntax": {
"count": 2
"count": 3
}
},
"packages/assets-controller/src/data-sources/StakedBalanceDataSource.ts": {
Expand Down
6 changes: 6 additions & 0 deletions packages/assets-controller/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

### Added

- Add Stellar-only snap account-asset enrichment ([9455] (https://github.com/MetaMask/core/pull/9455))
- Add optional `snapDataSourceConfig.isStellarEnabled` getter to `AssetsControllerOptions` so clients can enable or disable Stellar snap `getAccountAssetInfo` enrichment at runtime (defaults to disabled)
- Add Stellar-only snap account-asset enrichment on `SnapDataSource.fetch` when `isStellarEnabled` is true: trustline fields from `getAccountAssetInfo` are attached to matching `stellar:pubnet` native and trustline balance rows under `metadata` on `FungibleAssetBalance`; balance push events (`AccountsController:accountBalancesUpdated`) pass amounts through without enrichment — clients should call `getAssets` after trustline-related snap events (e.g. `AccountsController:accountAssetListUpdated`)

## [10.2.0]

### Added
Expand Down
69 changes: 69 additions & 0 deletions packages/assets-controller/src/AssetsController.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1807,6 +1807,75 @@ describe('AssetsController', () => {
});
});

it('preserves balance metadata enrichment when merge update changes amount', async () => {
const initialState: Partial<AssetsControllerState> = {
assetsBalance: {
[MOCK_ACCOUNT_ID]: {
[MOCK_ASSET_ID]: {
amount: '1',
metadata: { limit: '1000', authorized: true },
},
},
},
};

await withController({ state: initialState }, async ({ controller }) => {
await controller.handleAssetsUpdate(
{
updateMode: 'merge',
assetsBalance: {
[MOCK_ACCOUNT_ID]: {
[MOCK_ASSET_ID]: { amount: '2' },
},
},
},
'TestSource',
);

expect(
controller.state.assetsBalance[MOCK_ACCOUNT_ID]?.[MOCK_ASSET_ID],
).toStrictEqual({
amount: '2',
metadata: { limit: '1000', authorized: true },
});
});
});

it('preserves balance metadata when replaceCoveredChainBalances updates amount only', async () => {
const initialState: Partial<AssetsControllerState> = {
assetsBalance: {
[MOCK_ACCOUNT_ID]: {
[MOCK_ASSET_ID]: {
amount: '1',
metadata: { limit: '1000', authorized: true },
},
},
},
};

await withController({ state: initialState }, async ({ controller }) => {
await controller.handleAssetsUpdate(
{
updateMode: 'merge',
replaceCoveredChainBalances: true,
assetsBalance: {
[MOCK_ACCOUNT_ID]: {
[MOCK_ASSET_ID]: { amount: '2' },
},
},
},
'TestSource',
);

expect(
controller.state.assetsBalance[MOCK_ACCOUNT_ID]?.[MOCK_ASSET_ID],
).toStrictEqual({
amount: '2',
metadata: { limit: '1000', authorized: true },
});
});
});

it('preserves existing balances when merge update adds new chain data', async () => {
const polygonNative = 'eip155:137/slip44:966' as Caip19AssetId;
const initialState: Partial<AssetsControllerState> = {
Expand Down
29 changes: 26 additions & 3 deletions packages/assets-controller/src/AssetsController.ts
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,10 @@ import type { PriceDataSourceConfig } from './data-sources/PriceDataSource';
import { PriceDataSource } from './data-sources/PriceDataSource';
import type { RpcDataSourceConfig } from './data-sources/RpcDataSource';
import { RpcDataSource } from './data-sources/RpcDataSource';
import type { AccountsControllerAccountBalancesUpdatedEvent } from './data-sources/SnapDataSource';
import type {
AccountsControllerAccountBalancesUpdatedEvent,
SnapDataSourceConfig,
} from './data-sources/SnapDataSource';
import { SnapDataSource } from './data-sources/SnapDataSource';
import type { StakedBalanceDataSourceConfig } from './data-sources/StakedBalanceDataSource';
import { StakedBalanceDataSource } from './data-sources/StakedBalanceDataSource';
Expand Down Expand Up @@ -430,6 +433,8 @@ export type AssetsControllerOptions = {
priceDataSourceConfig?: PriceDataSourceConfig;
/** Optional configuration for StakedBalanceDataSource. */
stakedBalanceDataSourceConfig?: StakedBalanceDataSourceConfig;
/** Optional configuration for SnapDataSource. */
snapDataSourceConfig?: SnapDataSourceConfig;
/**
* Function returning whether onboarding is complete. When false,
* RPC and staked balance data sources skip fetch and subscribe
Expand Down Expand Up @@ -565,6 +570,16 @@ function normalizeResponse(response: DataResponse): DataResponse {
return normalized;
}

function mergeBalanceEntry(
previous: AssetBalance | undefined,
incoming: AssetBalance,
): AssetBalance {
return {
...(previous ?? { amount: '0' }),
...incoming,
};
}

/**
* Merge account balances from a data-source response into prior state.
*
Expand All @@ -582,7 +597,11 @@ function mergeAccountBalances(
replaceCoveredChains: boolean,
): Record<string, AssetBalance> {
if (!replaceCoveredChains) {
return { ...previousBalances, ...accountBalances };
const next: Record<string, AssetBalance> = { ...previousBalances };
for (const [assetId, balance] of Object.entries(accountBalances)) {
next[assetId] = mergeBalanceEntry(previousBalances[assetId], balance);
}
return next;
Comment thread
stanleyyconsensys marked this conversation as resolved.
}

const coveredChains = new Set(
Expand All @@ -596,7 +615,9 @@ function mergeAccountBalances(
}
}

Object.assign(next, accountBalances);
for (const [assetId, balance] of Object.entries(accountBalances)) {
next[assetId] = mergeBalanceEntry(previousBalances[assetId], balance);
}

for (const customId of customAssetIds) {
if (!Object.prototype.hasOwnProperty.call(next, customId)) {
Expand Down Expand Up @@ -856,6 +877,7 @@ export class AssetsController extends BaseController<
accountsApiDataSourceConfig,
priceDataSourceConfig,
stakedBalanceDataSourceConfig,
snapDataSourceConfig,
isOnboarded,
tempMigrateAssetsInfoMetadataAssets3346,
}: AssetsControllerOptions) {
Expand Down Expand Up @@ -921,6 +943,7 @@ export class AssetsController extends BaseController<
this.#snapDataSource = new SnapDataSource({
messenger: this.messenger,
onActiveChainsUpdated: this.#onActiveChainsUpdated,
...snapDataSourceConfig,
});
this.#rpcDataSource = new RpcDataSource({
messenger: this.messenger,
Expand Down
Loading
Loading