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.

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: refine execute txn #339

Merged
merged 6 commits into from
Aug 30, 2024
Merged
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
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
],
"details": {
"nonce": "0x1",
"version": "0x2",
"version": "0x1",
"maxFee": "1000000000000000"
},
"hash": "0x042f5e546b2e55eb6b1b735f15fbfbd7621fc01ea7c96dcf87928ac27f054adb"
Expand All @@ -24,7 +24,7 @@
],
"details": {
"nonce": "0x2",
"version": "0x2",
"version": "0x1",
"maxFee": "1000000000000000"
},
"hash": "0x06385d46da9fbed4a5798298b17df069ac5f786e4c9f8f6b81c665540aea245a"
Expand Down
2 changes: 0 additions & 2 deletions packages/starknet-snap/src/estimateFee.ts
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,6 @@ export async function estimateFee(params: ApiParamsWithKeyDeriver) {
);
const { senderAddress } = requestParamsObj;
const network = getNetworkFromChainId(state, requestParamsObj.chainId);
const { transactionVersion } = requestParamsObj;

if (
!contractAddress ||
Expand Down Expand Up @@ -117,7 +116,6 @@ export async function estimateFee(params: ApiParamsWithKeyDeriver) {
senderAddress,
senderPrivateKey,
bulkTransactions,
transactionVersion,
);
logger.log(
`estimateFee:\nestimateFeeBulk estimateBulkFeeResp: ${toJson(
Expand Down
1 change: 0 additions & 1 deletion packages/starknet-snap/src/estimateFees.ts
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ export async function estimateFees(params: ApiParamsWithKeyDeriver) {
senderAddress,
senderPrivateKey,
requestParamsObj.invocations,
requestParamsObj.transactionVersion,
requestParamsObj.invocationDetails,
);

Expand Down
10 changes: 2 additions & 8 deletions packages/starknet-snap/src/executeTxn.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,7 @@ import type {
ApiParamsWithKeyDeriver,
ExecuteTxnRequestParams,
} from './types/snapApi';
import {
ACCOUNT_CLASS_HASH,
CAIRO_VERSION,
TRANSACTION_VERSION,
} from './utils/constants';
import { ACCOUNT_CLASS_HASH, CAIRO_VERSION } from './utils/constants';
import { logger } from './utils/logger';
import {
getNetworkFromChainId,
Expand Down Expand Up @@ -75,7 +71,6 @@ export async function executeTxn(params: ApiParamsWithKeyDeriver) {
senderAddress,
senderPrivateKey,
bulkTransactions,
TRANSACTION_VERSION,
requestParamsObj.invocationsDetails
? requestParamsObj.invocationsDetails
: undefined,
Expand Down Expand Up @@ -147,10 +142,9 @@ export async function executeTxn(params: ApiParamsWithKeyDeriver) {
senderAddress,
senderPrivateKey,
requestParamsObj.txnInvocation,
undefined,
requestParamsObj.abis,
{ maxFee, nonce: nonceSendTransaction },
CAIRO_VERSION,
requestParamsObj.abis,
);
} catch (error) {
logger.error(`Problem found:`, error);
Expand Down
4 changes: 2 additions & 2 deletions packages/starknet-snap/src/rpcs/estimateFee.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ describe('estimateFee', () => {
includeDeploy: false,
chainId,
address: account.address,
version: constants.TRANSACTION_VERSION.V2,
version: constants.TRANSACTION_VERSION.V1,
});

const result = await estimateFee.execute(request);
Expand All @@ -86,7 +86,7 @@ describe('estimateFee', () => {
account.publicKey,
request.invocations,
{
version: constants.TRANSACTION_VERSION.V2,
version: constants.TRANSACTION_VERSION.V1,
},
);
expect(result).toStrictEqual(estimateBulkFeeRespMock);
Expand Down
3 changes: 1 addition & 2 deletions packages/starknet-snap/src/rpcs/estimateFee.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
import type { Json } from '@metamask/snaps-sdk';
import type { UniversalDetails } from 'starknet';
import type { Infer } from 'superstruct';
import { object, string, assign, boolean, optional, enums } from 'superstruct';

Expand Down Expand Up @@ -69,7 +68,7 @@ export class EstimateFeeRpc extends AccountRpcController<
this.account.privateKey,
this.account.publicKey,
invocations,
details as UniversalDetails,
details,
);

return estimateFeeResp;
Expand Down
69 changes: 18 additions & 51 deletions packages/starknet-snap/src/rpcs/executeTxn.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,12 @@ import {
InvalidParamsError,
UserRejectedRequestError,
} from '@metamask/snaps-sdk';
import type { UniversalDetails, Call } from 'starknet';
import type { UniversalDetails, Call, InvokeFunctionResponse } from 'starknet';
import { constants } from 'starknet';

import callsExamples from '../__tests__/fixture/callsExamples.json'; // Assuming you have a similar fixture
import type { FeeTokenUnit } from '../types/snapApi';
import {
STARKNET_SEPOLIA_TESTNET_NETWORK,
TRANSACTION_VERSION,
} from '../utils/constants';
import { STARKNET_SEPOLIA_TESTNET_NETWORK } from '../utils/constants';
import * as starknetUtils from '../utils/starknetUtils';
import { executeTxn as executeTxnUtil } from '../utils/starknetUtils';
import {
Expand Down Expand Up @@ -59,6 +56,7 @@ const prepareMockExecuteTxn = async (
includeDeploy: !accountDeployed,
unit: 'wei' as FeeTokenUnit,
};

const getEstimatedFeesSpy = jest.spyOn(starknetUtils, 'getEstimatedFees');
getEstimatedFeesSpy.mockResolvedValue(getEstimatedFeesRepsMock);

Expand All @@ -67,8 +65,7 @@ const prepareMockExecuteTxn = async (

const createAccountSpy = jest.spyOn(starknetUtils, 'createAccount');
createAccountSpy.mockResolvedValue({
// eslint-disable-next-line @typescript-eslint/naming-convention
transaction_hash:
transactionHash:
'0x07f901c023bac6c874691244c4c2332c6825b916fb68d240c807c6156db84fd3',
address: account.address,
});
Expand All @@ -88,9 +85,8 @@ const prepareMockExecuteTxn = async (

describe('ExecuteTxn', () => {
let callsExample: any;
const transactionVersion = TRANSACTION_VERSION;

it('executes transaction correctly when account is deployed', async () => {
it('executes transaction correctly if the account is deployed', async () => {
callsExample = callsExamples[0];
const {
account,
Expand All @@ -114,18 +110,17 @@ describe('ExecuteTxn', () => {
account.address,
account.privateKey,
request.calls,
transactionVersion,
expect.objectContaining({
maxFee: getEstimatedFeesRepsMock.suggestedMaxFee,
nonce: undefined,
}),
undefined,
{
...callsExample.details,
maxFee: getEstimatedFeesRepsMock.suggestedMaxFee,
},
);
expect(getEstimatedFeesSpy).toHaveBeenCalled();
expect(createAccountSpy).not.toHaveBeenCalled();
});

it('creates an account if the account is not deployed and execute transaction', async () => {
it('creates an account if the account is not deployed and execute the transaction', async () => {
callsExample = callsExamples[1];
const {
account,
Expand All @@ -151,13 +146,12 @@ describe('ExecuteTxn', () => {
account.address,
account.privateKey,
callsExample.calls,
transactionVersion,
undefined,
{
...callsExample.details,
maxFee: getEstimatedFeesRepsMock.suggestedMaxFee,
nonce: 1,
},
undefined,
);
});

Expand All @@ -176,47 +170,20 @@ describe('ExecuteTxn', () => {
);
});

it('throws error if calls are empty', async () => {
callsExample = Object.assign({}, callsExamples[1]);
const { request } = await prepareMockExecuteTxn(
it('throws `Failed to execute transaction` when the transaction hash is not returned from executeTxnUtil', async () => {
callsExample = callsExamples[1];
const { request, executeTxnUtilSpy } = await prepareMockExecuteTxn(
callsExample.hash,
callsExample.calls,
callsExample.details,
true,
);
request.calls = [];

await expect(executeTxn.execute(request)).rejects.toThrow(
'Calls cannot be empty',
executeTxnUtilSpy.mockResolvedValue(
{} as unknown as InvokeFunctionResponse,
);
});

it.each([
{
case: 'executeTxnUtil response is undefined',
executeTxnUtilResp: {},
},
{
case: 'executeTxnUtil response.transaction_hash is undefined',
executeTxnUtilResp: {
// eslint-disable-next-line @typescript-eslint/naming-convention
transaction_hash: undefined,
},
},
])(
'throws `Error` when $case',
async ({ executeTxnUtilResp }: { executeTxnUtilResp: unknown }) => {
callsExample = callsExamples[1];
const { request, executeTxnUtilSpy } = await prepareMockExecuteTxn(
callsExample.hash,
callsExample.calls,
callsExample.details,
true,
);
executeTxnUtilSpy.mockResolvedValue(executeTxnUtilResp as any);
await expect(executeTxn.execute(request)).rejects.toThrow(Error);
},
);
await expect(executeTxn.execute(request)).rejects.toThrow(Error);
});

it('throws `InvalidParamsError` when request parameter is not correct', async () => {
await expect(
Expand Down
Loading
Loading