Skip to content
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

chore: update test for UserInputEventController #436

Merged
merged 2 commits into from
Nov 25, 2024
Merged

chore: update test for UserInputEventController #436

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2964ea5
chore: update input event controller test
stanleyyconsensys Nov 25, 2024
4c93347
fix: lint
stanleyyconsensys Nov 25, 2024
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
13 changes: 5 additions & 8 deletions packages/starknet-snap/src/__tests__/helper.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,17 +22,14 @@ import { v4 as uuidv4 } from 'uuid';
import { FeeToken } from '../types/snapApi';
import type {
AccContract,
Erc20Token,
Transaction,
TransactionRequest,
} from '../types/snapState';
import {
ACCOUNT_CLASS_HASH,
ACCOUNT_CLASS_HASH_LEGACY,
ETHER_MAINNET,
PRELOADED_TOKENS,
PROXY_CONTRACT_HASH,
STRK_MAINNET,
} from '../utils/constants';
import { grindKey } from '../utils/keyPair';

Expand Down Expand Up @@ -299,17 +296,16 @@ export function generateTransactions({
export function generateTransactionRequests({
chainId,
address,
selectedFeeToken,
selectedFeeTokens = Object.values(FeeToken),
contractAddresses = PRELOADED_TOKENS.map((token) => token.address),
cnt = 1,
}: {
chainId: constants.StarknetChainId | string;
address: string;
selectedFeeToken?: Erc20Token;
selectedFeeTokens?: FeeToken[];
contractAddresses?: string[];
cnt?: number;
}): TransactionRequest[] {
const feeTokens = [STRK_MAINNET, ETHER_MAINNET];
const request = {
chainId: chainId,
id: '',
Expand All @@ -333,8 +329,9 @@ export function generateTransactionRequests({
addressIndex: 0,
maxFee: '100',
selectedFeeToken:
selectedFeeToken?.symbol ??
feeTokens[Math.floor(generateRandomValue() * feeTokens.length)].symbol,
selectedFeeTokens[
Math.floor(generateRandomValue() * selectedFeeTokens.length)
],
calls: [
{
contractAddress:
Expand Down
104 changes: 74 additions & 30 deletions packages/starknet-snap/src/ui/controllers/user-input-event-controller.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -315,23 +315,47 @@ describe('UserInputEventController', () => {
});

describe('handleFeeTokenChange', () => {
type PrepareHandleFeeTokenChangeArg = {
feeToken: {
// The fee token that we change from
changeFrom: FeeToken;
// The fee token that we change to
changeTo: FeeToken;
};
};

const prepareHandleFeeTokenChange = async (
feeToken: FeeToken = FeeToken.STRK,
selectedFeeToken?: Erc20Token,
arg: PrepareHandleFeeTokenChangeArg = {
feeToken: {
changeFrom: FeeToken.STRK,
changeTo: FeeToken.ETH,
},
},
) => {
const network = STARKNET_TESTNET_NETWORK;
const { chainId } = network;
const { feeToken } = arg;

const [account] = await generateAccounts(chainId, 1);
const [transactionRequest] = generateTransactionRequests({
chainId,
address: account.address,
selectedFeeToken,
selectedFeeTokens: [feeToken.changeFrom],
});

// Create a copy of the original transaction request, for testing if the transaction request is updated / rolled back
const originalTransactionRequest = {
...transactionRequest,
// Since only `maxFee`, `selectedFeeToken`, `includeDeploy` and `resourceBounds` has been updated, hence we only need to copy these fields
maxFee: transactionRequest.maxFee,
selectedFeeToken: transactionRequest.selectedFeeToken,
includeDeploy: transactionRequest.includeDeploy,
resourceBounds: [...transactionRequest.resourceBounds],
};

const event = generateInputEvent({
transactionRequest,
eventValue: feeToken,
eventValue: feeToken.changeTo,
});

mockNetworkStateManager(network);
Expand All @@ -341,24 +365,23 @@ describe('UserInputEventController', () => {
return {
...mockHasSufficientFundsForFee(),
...mockUpdateExecuteTxnFlow(),
...mockEstimateFee(feeToken),
...mockEstimateFee(feeToken.changeTo),
...mockTransactionRequestStateManager(),
event,
originalTransactionRequest,
transactionRequest,
account,
network,
feeToken,
feeToken: feeToken.changeTo,
};
};

it.each([STRK_SEPOLIA_TESTNET, ETHER_SEPOLIA_TESTNET])(
'updates the transaction request with the updated estimated fee: feeToken - %symbol',
'updates the transaction request with the updated estimated fee: feeToken - $symbol',
async (token: Erc20Token) => {
const feeToken = FeeToken[token.symbol];
const selectedFeeToken =
token.symbol === FeeToken.ETH
? STRK_SEPOLIA_TESTNET
: ETHER_SEPOLIA_TESTNET;
const feeTokenChangeTo = FeeToken[token.symbol];
const feeTokenChangeFrom =
token.symbol === FeeToken.ETH ? FeeToken.STRK : FeeToken.ETH;
const {
event,
account,
Expand All @@ -369,7 +392,13 @@ describe('UserInputEventController', () => {
mockGetEstimatedFeesResponse,
upsertTransactionRequestSpy,
transactionRequest,
} = await prepareHandleFeeTokenChange(feeToken, selectedFeeToken);
} = await prepareHandleFeeTokenChange({
feeToken: {
changeFrom: feeTokenChangeFrom,
changeTo: feeTokenChangeTo,
},
});

const feeTokenAddress = token.address;
const { signer, calls } = transactionRequest;
const { publicKey, privateKey, address } = account;
Expand All @@ -394,7 +423,7 @@ describe('UserInputEventController', () => {
},
],
{
version: controller.feeTokenToTransactionVersion(feeToken),
version: controller.feeTokenToTransactionVersion(feeTokenChangeTo),
},
);
expect(hasSufficientFundsForFeeSpy).toHaveBeenCalledWith({
Expand All @@ -410,9 +439,10 @@ describe('UserInputEventController', () => {
controller.eventId,
transactionRequest,
);
// Make sure the `selectedFeeToken` transaction request has been updated
expect(upsertTransactionRequestSpy).toHaveBeenCalledWith({
...transactionRequest,
selectedFeeToken: feeToken,
selectedFeeToken: feeTokenChangeTo,
});
},
);
Expand All @@ -421,53 +451,67 @@ describe('UserInputEventController', () => {
const {
event,
hasSufficientFundsForFeeSpy,
transactionRequest,
originalTransactionRequest,
updateExecuteTxnFlowSpy,
upsertTransactionRequestSpy,
feeToken,
} = await prepareHandleFeeTokenChange();
} = await prepareHandleFeeTokenChange({
feeToken: {
changeFrom: FeeToken.STRK,
changeTo: FeeToken.ETH,
},
});
hasSufficientFundsForFeeSpy.mockResolvedValue(false);

const controller = createMockController(event);
await controller.handleFeeTokenChange();

expect(upsertTransactionRequestSpy).not.toHaveBeenCalled();
expect(feeToken).not.toStrictEqual(
originalTransactionRequest.selectedFeeToken,
);
// If the account balance is insufficient to cover the fee, the transaction request should be rolled back or not updated.
expect(updateExecuteTxnFlowSpy).toHaveBeenCalledWith(
controller.eventId,
transactionRequest,
originalTransactionRequest,
{
errors: {
fees: `Not enough ${feeToken} to pay for fee, switching back to ${transactionRequest.selectedFeeToken}`,
fees: `Not enough ${feeToken} to pay for fee, switching back to ${originalTransactionRequest.selectedFeeToken}`,
},
},
);
});

it('rollback the transaction request and show a general error message if other error was thrown.', async () => {
it('rollbacks the transaction request with a general error message if another Error was thrown.', async () => {
const {
event,
transactionRequest,
originalTransactionRequest,
updateExecuteTxnFlowSpy,
upsertTransactionRequestSpy,
} = await prepareHandleFeeTokenChange();
feeToken,
} = await prepareHandleFeeTokenChange({
feeToken: {
changeFrom: FeeToken.STRK,
changeTo: FeeToken.ETH,
},
});

// Simulate an error thrown to test the error handling
upsertTransactionRequestSpy.mockRejectedValue(new Error('Failed!'));
const rollbackSnapshot = {
maxFee: transactionRequest.maxFee,
selectedFeeToken: transactionRequest.selectedFeeToken,
includeDeploy: transactionRequest.includeDeploy,
resourceBounds: [...transactionRequest.resourceBounds],
};

const controller = createMockController(event);
await controller.handleFeeTokenChange();

expect(feeToken).not.toStrictEqual(
originalTransactionRequest.selectedFeeToken,
);
// if any Error was thrown, the transaction request should be rolled back or not updated.
expect(updateExecuteTxnFlowSpy).toHaveBeenCalledWith(
controller.eventId,
{ ...transactionRequest, ...rollbackSnapshot },
originalTransactionRequest,
{
errors: {
fees: `Failed to calculate the fees, switching back to ${transactionRequest.selectedFeeToken}`,
fees: `Failed to calculate the fees, switching back to ${originalTransactionRequest.selectedFeeToken}`,
},
},
);
Expand Down
20 changes: 8 additions & 12 deletions packages/starknet-snap/src/ui/controllers/user-input-event-controller.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,8 +132,9 @@ export class UserInputEventController {

protected createRollbackSnapshot(
request: TransactionRequest,
): Partial<TransactionRequest> {
): TransactionRequest {
return {
...request,
maxFee: request.maxFee,
selectedFeeToken: request.selectedFeeToken,
includeDeploy: request.includeDeploy,
Expand All @@ -143,7 +144,7 @@ export class UserInputEventController {

protected async handleFeeTokenChange() {
const request = this.context?.request as TransactionRequest;
const rollbackSnapshot = this.createRollbackSnapshot(request);
const originalRequest = this.createRollbackSnapshot(request);
const { addressIndex, calls, signer, chainId } = request;
const feeToken = (this.event as InputChangeEvent)
.value as unknown as FeeToken;
Expand Down Expand Up @@ -204,17 +205,12 @@ export class UserInputEventController {
} catch (error) {
const errorMessage =
error instanceof InsufficientFundsError
? `Not enough ${feeToken} to pay for fee, switching back to ${request.selectedFeeToken}`
: `Failed to calculate the fees, switching back to ${request.selectedFeeToken}`;

? `Not enough ${feeToken} to pay for fee, switching back to ${originalRequest.selectedFeeToken}`
: `Failed to calculate the fees, switching back to ${originalRequest.selectedFeeToken}`;
// On failure, display ExecuteTxnUI with an error message
await updateExecuteTxnFlow(
this.eventId,
{ ...request, ...rollbackSnapshot },
{
errors: { fees: errorMessage },
},
);
await updateExecuteTxnFlow(this.eventId, originalRequest, {
errors: { fees: errorMessage },
});
}
}
}
Loading