feat: add custom transaction schema to formatTransaction

[nicolasbrugneaux]

Greetings 👋

Description

This PR aims to solidify the Plugin experience by allowing a customTransactionSchema to be used by formatTransaction. This seems to have be thought of before as the formatTransaction already accepted a custom schema in its parameters but it seems it wasn't used anywhere yet. This PR aims solve that.

Type of change

• New feature (non-breaking change which adds functionality)

Checklist:

• I have selected the correct base branch.
• I have performed a self-review of my own code.
• I have commented my code, particularly in hard-to-understand areas.
• I have made corresponding changes to the documentation.
• My changes generate no new warnings.
• Any dependent changes have been merged and published in downstream modules.
• I ran npm run lint with success and extended the tests and types if necessary.
• I ran npm run test:unit with success.
• I ran npm run test:coverage and my test cases cover all the lines and branches of the added code.
• I ran npm run build and tested dist/web3.min.js in a browser.
• I have tested my code on the live network.
• I have checked the Deploy Preview and it looks correct.
• I have updated the CHANGELOG.md file in the root folder.
• I have linked Issue(s) with this PR in "Linked Issues" menu.

[jdevcs]

@nicolasbrugneaux Thanks for your contribution, there are some build issues that need fix.

[nicolasbrugneaux]

@nicolasbrugneaux Thanks for your contribution, there are some build issues that need fix.

I'm having issues running it locally but I think I fixed it all. Any chance we can re-run ci?

[jdevcs]

some of tests needs update, including unit test:

web3-eth:  FAIL  test/unit/format_transaction.test.ts
web3-eth:   ● Test suite failed to run
web3-eth:     test/unit/format_transaction.test.ts:123:52 - error TS2339: Property 'feeCurrency' does not exist on type '{ from?: string | undefined; to?: string | null | undefined; value?: bigint | undefined; accessList?: { readonly address?: string | undefined; readonly storageKeys?: string[] | undefined; }[] | undefined; ... 17 more ...; s?: string | undefined; }'.
web3-eth:     123   expect(formatTransaction(customFieldTransaction).feeCurrency).toBeUndefined();
web3-eth:                                                            ~~~~~~~~~~~
web3-eth:     test/unit/format_transaction.test.ts:130:7 - error TS2322: Type '{ properties: { feeCurrency: string; from: { format: string; }; to: { oneOf: ({ format: string; type?: undefined; } | { type: string; format?: undefined; })[]; }; value: { format: string; }; gas: { format: string; }; ... 17 more ...; s: { ...; }; }; type: string; }' is not assignable to type 'ValidationSchemaInput | { type: string; properties: { from: { format: string; }; to: { oneOf: ({ format: string; type?: undefined; } | { type: string; format?: undefined; })[]; }; ... 19 more ...; s: { ...; }; }; } | undefined'.
web3-eth:       Types of property 'properties' are incompatible.
web3-eth:         Type '{ feeCurrency: string; from: { format: string; }; to: { oneOf: ({ format: string; type?: undefined; } | { type: string; format?: undefined; })[]; }; value: { format: string; }; gas: { format: string; }; gasPrice: { format: string; }; ... 16 more ...; s: { ...; }; }' is not assignable to type '{ from: { format: string; }; to: { oneOf: ({ format: string; type?: undefined; } | { type: string; format?: undefined; })[]; }; value: { format: string; }; gas: { format: string; }; gasPrice: { format: string; }; effectiveGasPrice: { ...; }; ... 15 more ...; s: { ...; }; }'.
web3-eth:           Object literal may only specify known properties, and 'feeCurrency' does not exist in type '{ from: { format: string; }; to: { oneOf: ({ format: string; type?: undefined; } | { type: string; format?: undefined; })[]; }; value: { format: string; }; gas: { format: string; }; gasPrice: { format: string; }; effectiveGasPrice: { ...; }; ... 15 more ...; s: { ...; }; }'.
web3-eth:     130       feeCurrency: 'address',
web3-eth:               ~~~~~~~~~~~~~~~~~~~~~~
web3-eth:     test/unit/format_transaction.test.ts:133:7 - error TS2339: Property 'feeCurrency' does not exist on type '{ from?: string | undefined; to?: string | null | undefined; value?: bigint | undefined; accessList?: { readonly address?: string | undefined; readonly storageKeys?: string[] | undefined; }[] | undefined; ... 17 more ...; s?: string | undefined; }'.
web3-eth:     133    }).feeCurrency,
web3-eth:               ~~~~~~~~

[avkos]

LGTM. But still, some tests fail. Will be great to fix them cause I see some types incompatible.

[Muhammad-Altabba]

Thanks @nicolasbrugneaux,
Could you please revert the code formatting done in this MR so we can easily review it? (We are working on a better formatting for the code which will be in a separate MR).
Also please fix the tests so we can look at your MR deeply.
Thanks,

[jdevcs]

@nicolasbrugneaux great effort, for this feature. I suggested few changes. Thanks for your contributions

[nicolasbrugneaux]

@jdevcs thanks for the thourough review. I should have addressed all feedback. Let me know if you were thinking of doing it differently.

Side note: I also refactored the type of config.customTransactionSchema to be more generic and thus not have to import {CustomTransactionSchema} from 'web3-eth' into web3-core. Let me know if you think there's a better place for that new type.

[luu-alex]

Hey @nicolasbrugneaux , https://github.com/web3/web3.js/actions/runs/10886942923/job/30214851919?pr=7227 the build is currently failing

[nicolasbrugneaux]

Fixed the build, builds locally at least 😅

[luu-alex]

almost there 😅
web3-core: FAIL test/unit/web3_context.test.ts
web3-core: ● Test suite failed to run
web3-core: test/unit/web3_context.test.ts:127:37 - error TS2339: Property 'config' does not exist on type 'Web3RequestManager'.
web3-core: 127 expect(newContext.requestManager.config.defaultHardfork).toEqual(
web3-core:

[nicolasbrugneaux]

I noticed the interface for config.customTransactionSchema was incorrect so I fixed that as well as the failing test above.

[nicolasbrugneaux]

Thank you!!

[nicolasbrugneaux]

hey there @luu-alex since you kindly merged this I wanted to bring your attention to a follow-up issue I encountered:

• [plugin] customTransactionSchema follow-up #7273