Skip to content

fix: evaluated positive or negative balanceDiff to put transactions in from or to #108

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
gabrieledm wants to merge 9 commits into
base: main
Choose a base branch
from
Open

fix: evaluated positive or negative balanceDiff to put transactions in from or to #108

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
70d0971
fix: evaluated positive or negative 'balanceDiff' to put transactions…
gabrieledm Aug 4, 2026
d963b05
Merge branch 'main' into fix/WPN-1223_solana-incorrect-event-logged-f…
gabrieledm Aug 5, 2026
de0c751
chore: shasum
gabrieledm Aug 5, 2026
bae0d29
Merge branch 'main' into fix/WPN-1223_solana-incorrect-event-logged-f…
gabrieledm Aug 5, 2026
6b31475
chore: shasum
gabrieledm Aug 5, 2026
fa5a461
Merge branch 'main' into fix/WPN-1223_solana-incorrect-event-logged-f…
gabrieledm Aug 5, 2026
4d40415
chore: shasum
gabrieledm Aug 5, 2026
74f67aa
chore: shasum
gabrieledm Aug 5, 2026
a5753bb
chore: shasum
gabrieledm Aug 5, 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
4 changes: 4 additions & 0 deletions packages/solana-wallet-snap/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

### Fixed

- Fixed small USDC-to-SOL swaps being incorrectly displayed as sends in Solana activity ([#108](https://github.com/MetaMask/internal-snaps/pull/108))

## [5.0.0]

### Changed
Expand Down
2 changes: 1 addition & 1 deletion packages/solana-wallet-snap/snap.manifest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"url": "https://github.com/MetaMask/internal-snaps.git"
},
"source": {
"shasum": "x1ofZt8S0KIVHIQv3AJyARRJNjs2dvQ8E44IW8mnugU=",
"shasum": "iJX7VX3fcTg0MYKP6idu4edzalhJ6ns/NkWYBZc2KDg=",
"location": {
"npm": {
"filePath": "dist/bundle.js",
Expand Down
286 changes: 277 additions & 9 deletions packages/solana-wallet-snap/src/core/services/transactions/TransactionMapper.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { address as asAddress } from '@solana/kit';
import { address as asAddress, lamports } from '@solana/kit';

import { KnownCaip19Id, Network, Networks } from '../../constants/solana';
import { MOCK_SOLANA_KEYRING_ACCOUNT_0 } from '../../test/mocks/solana-keyring-accounts';
Expand Down Expand Up @@ -28,6 +28,46 @@ jest.mock('../../utils/errors', () => ({
trackError: jest.fn().mockResolvedValue('tracked-error-id'),
}));

type WithTransactionMapperCallback<ReturnValue> = (payload: {
transactionMapper: TransactionMapper;
mockTokenHelper: jest.Mocked<Pick<TokenHelper, 'amountToUiAmountForMint'>>;
mockAssetsService: jest.Mocked<Pick<AssetsService, 'getAssetsMetadata'>>;
}) => Promise<ReturnValue> | ReturnValue;

/**
* Wraps tests by creating a fresh TransactionMapper and fresh mocks.
*
* @param testFunction - The test body receiving the TransactionMapper and relevant mocks.
* @returns The return value of the callback.
*/
async function withTransactionMapper<ReturnValue>(
testFunction: WithTransactionMapperCallback<ReturnValue>,
): Promise<ReturnValue> {
const mockTokenHelper: jest.Mocked<
Pick<TokenHelper, 'amountToUiAmountForMint'>
> = {
amountToUiAmountForMint: jest.fn().mockResolvedValue('1'),
};

const mockAssetsService: jest.Mocked<
Pick<AssetsService, 'getAssetsMetadata'>
> = {
getAssetsMetadata: jest.fn().mockResolvedValue({}),
};

const transactionMapper = new TransactionMapper(
mockTokenHelper as unknown as TokenHelper,
mockAssetsService as unknown as AssetsService,
logger,
);

return await testFunction({
transactionMapper,
mockTokenHelper,
mockAssetsService,
});
}

describe('TransactionMapper', () => {
let transactionMapper: TransactionMapper;
let mockTokenHelper: TokenHelper;
Expand Down Expand Up @@ -214,6 +254,142 @@ describe('TransactionMapper', () => {
});
});

it.each([
{
description: 'less than',
receivedLamports: 1n,
expectedAmount: '0.000000001',
},
{
description: 'equal to',
receivedLamports: 5000n,
expectedAmount: '0.000005',
},
{
description: 'greater than',
receivedLamports: 10000n,
expectedAmount: '0.00001',
},
])(
'maps incoming native SOL for the fee payer when the received amount is $description the transaction fee',
async ({ receivedLamports, expectedAmount }) => {
await withTransactionMapper(
async ({ transactionMapper: freshTransactionMapper }) => {
const feeLamports = 5000n;
const feePayerPreBalance = 1000000n;
const counterpartyPreBalance = receivedLamports;
const [feePayerAddress, counterpartyAddress] =
EXPECTED_NATIVE_SOL_TRANSFER_DATA.transaction.message.accountKeys;

const result = await freshTransactionMapper.mapRpcTransaction(
{
...EXPECTED_NATIVE_SOL_TRANSFER_DATA,
meta: {
...EXPECTED_NATIVE_SOL_TRANSFER_DATA.meta,
// eslint-disable-next-line id-denylist
err: null,
fee: lamports(feeLamports),
preBalances: [
lamports(feePayerPreBalance),
lamports(counterpartyPreBalance),
lamports(1n),
],
postBalances: [
lamports(
feePayerPreBalance - feeLamports + receivedLamports,
),
lamports(0n),
lamports(1n),
],
},
transaction: {
...EXPECTED_NATIVE_SOL_TRANSFER_DATA.transaction,
message: {
...EXPECTED_NATIVE_SOL_TRANSFER_DATA.transaction.message,
instructions: [],
},
},
},
mockAccount,
Network.Mainnet,
);

expect(result).toMatchObject({
type: 'receive',
from: [
{
address: counterpartyAddress,
asset: {
amount: expectedAmount,
fungible: true,
type: Networks[Network.Mainnet].nativeToken.caip19Id,
unit: Networks[Network.Mainnet].nativeToken.symbol,
},
},
],
to: [
{
address: feePayerAddress,
asset: {
amount: expectedAmount,
fungible: true,
type: Networks[Network.Mainnet].nativeToken.caip19Id,
unit: Networks[Network.Mainnet].nativeToken.symbol,
},
},
],
});
},
);
},
);

it('does not treat a transaction-fee-only SOL balance decrease as a native SOL transfer', async () => {
await withTransactionMapper(
async ({ transactionMapper: freshTransactionMapper }) => {
const feeLamports = 5000n;
const feePayerPreBalance = 1000000n;

const result = await freshTransactionMapper.mapRpcTransaction(
{
...EXPECTED_NATIVE_SOL_TRANSFER_DATA,
meta: {
...EXPECTED_NATIVE_SOL_TRANSFER_DATA.meta,
// eslint-disable-next-line id-denylist
err: null,
fee: lamports(feeLamports),
preBalances: [
lamports(feePayerPreBalance),
lamports(0n),
lamports(1n),
],
postBalances: [
lamports(feePayerPreBalance - feeLamports),
lamports(0n),
lamports(1n),
],
},
transaction: {
...EXPECTED_NATIVE_SOL_TRANSFER_DATA.transaction,
message: {
...EXPECTED_NATIVE_SOL_TRANSFER_DATA.transaction.message,
instructions: [],
},
},
},
mockAccount,
Network.Mainnet,
);

expect(result).toMatchObject({
type: 'unknown',
from: [],
to: [],
});
},
);
});

it('maps native SOL transfers - failure', async () => {
const result = await transactionMapper.mapRpcTransaction(
{
Expand Down Expand Up @@ -368,6 +544,98 @@ describe('TransactionMapper', () => {
});
});

it.each([
{
description: 'less than',
receivedLamports: 1n,
expectedAmount: '0.000000001',
},
{
description: 'equal to',
receivedLamports: 5000n,
expectedAmount: '0.000005',
},
{
description: 'greater than',
receivedLamports: 10000n,
expectedAmount: '0.00001',
},
])(
'classifies an SPL token to native SOL transaction as a swap when incoming SOL is $description the transaction fee',
async ({ receivedLamports, expectedAmount }) => {
await withTransactionMapper(
async ({
mockTokenHelper: freshMockTokenHelper,
transactionMapper: freshTransactionMapper,
}) => {
freshMockTokenHelper.amountToUiAmountForMint.mockResolvedValue(
'0.01',
);

const feeLamports = 5000n;
const feePayerPreBalance = 1000000n;
const counterpartyPreBalance = 2039280n;
const [feePayerAddress] =
EXPECTED_SEND_USDC_TRANSFER_DATA.transaction.message.accountKeys;

const result = await freshTransactionMapper.mapRpcTransaction(
{
...EXPECTED_SEND_USDC_TRANSFER_DATA,
meta: {
...EXPECTED_SEND_USDC_TRANSFER_DATA.meta,
// eslint-disable-next-line id-denylist
err: null,
fee: lamports(feeLamports),
preBalances: [
lamports(feePayerPreBalance),
lamports(counterpartyPreBalance),
lamports(2039280n),
lamports(934087680n),
],
postBalances: [
lamports(
feePayerPreBalance - feeLamports + receivedLamports,
),
lamports(counterpartyPreBalance - receivedLamports),
lamports(2039280n),
lamports(934087680n),
],
},
},
mockAccount,
Network.Devnet,
);

expect(result).toMatchObject({
type: 'swap',
from: [
{
address: feePayerAddress,
asset: {
amount: '0.01',
fungible: true,
type: `${Network.Devnet}/token:4zMMC9srt5Ri5X14GAgXhaHii3GnPAEERYPJgZJDncDU`,
unit: '',
},
},
],
to: [
{
address: feePayerAddress,
asset: {
amount: expectedAmount,
fungible: true,
type: Networks[Network.Devnet].nativeToken.caip19Id,
unit: Networks[Network.Devnet].nativeToken.symbol,
},
},
],
});
},
);
},
);

it('maps SPL token transfers - as a sender to self', async () => {
const result = await transactionMapper.mapRpcTransaction(
EXPECTED_SEND_USDC_TRANSFER_TO_SELF_DATA,
Expand Down Expand Up @@ -726,24 +994,24 @@ describe('TransactionMapper', () => {
amount: '0.01',
},
},
],
to: [
{
address: 'DtMUkCoeyzs35B6EpQQxPyyog6TRwXxV1W1Acp8nWBNa',
asset: {
amount: '0.000000008',
fungible: true,
type: 'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/slip44:501',
unit: 'SOL',
type: `${Network.Mainnet}/token:HaMv3cdfDW6357yjpDur6kb6w52BUPJrMJpR76tjpump`,
unit: '',
amount: '2583.728601',
},
},
],
to: [
{
address: 'DtMUkCoeyzs35B6EpQQxPyyog6TRwXxV1W1Acp8nWBNa',
asset: {
amount: '0.000000008',
fungible: true,
type: `${Network.Mainnet}/token:HaMv3cdfDW6357yjpDur6kb6w52BUPJrMJpR76tjpump`,
unit: '',
amount: '2583.728601',
type: 'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp/slip44:501',
unit: 'SOL',
},
},
],
Expand Down
10 changes: 4 additions & 6 deletions packages/solana-wallet-snap/src/core/services/transactions/TransactionMapper.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -363,10 +363,9 @@ export class TransactionMapper {
const amount = balanceDiffSol.absoluteValue().toString();

/**
* If the pre-balance is greater than the post-balance, it means that the account
* has lost SOL, so it's a sender.
* If the balance diff (preBalance-postBalance-fee) is positive, it means that the account is a sender.
*/
if (preBalance.isGreaterThan(postBalance)) {
if (balanceDiffSol.isPositive()) {
from.push({
address,
asset: {
Expand All @@ -379,10 +378,9 @@ export class TransactionMapper {
}

/**
* If the pre-balance is less than the post-balance, it means that the account
* has gained SOL, so it's a receiver.
* If the balance diff (preBalance-postBalance-fee) is negative, it means that the account is a receiver.
*/
if (preBalance.isLessThan(postBalance)) {
if (balanceDiffSol.isNegative()) {
to.push({
address,
asset: {
Expand Down
Loading