Skip to content
This repository was archived by the owner on Mar 5, 2025. It is now read-only.

Result of contract method .send is hard to type #6883

Merged
avkos merged 11 commits into from
Mar 15, 2024
Merged

Result of contract method .send is hard to type #6883

Changes from 3 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
352e2f2
fix: Add videos to Plugin Section
avkos Mar 12, 2024
03cf4a5
add deploy and send types
avkos Mar 12, 2024
804f150
lint fix
avkos Mar 12, 2024
fbd9f96
add types to web3 packcage
avkos Mar 12, 2024
2e44e94
Merge branch '4.x' into ok/6701-Result-of-contract-method-.send-is-ha…
avkos Mar 12, 2024
93bdcd3
fix unit tests
avkos Mar 12, 2024
dc712c3
test
avkos Mar 14, 2024
147625c
test
avkos Mar 14, 2024
9bd7720
test
avkos Mar 14, 2024
f2cfd02
revert
avkos Mar 14, 2024
0b95837
changelog
avkos Mar 15, 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
31 changes: 22 additions & 9 deletions packages/web3-eth-contract/src/contract.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,8 +82,16 @@ import {
EventLog,
ContractAbiWithSignature,
ContractOptions,
TransactionReceipt,
FormatType,
} from 'web3-types';
import { format, isDataFormat, keccak256, toChecksumAddress , isContractInitOptions } from 'web3-utils';
import {
format,
isDataFormat,
keccak256,
toChecksumAddress,
isContractInitOptions,
} from 'web3-utils';
import {
isNullish,
validator,
Expand Down Expand Up @@ -113,7 +121,7 @@ type ContractBoundMethod<
Abi extends AbiFunctionFragment,
Method extends ContractMethod<Abi> = ContractMethod<Abi>,
> = (
...args: Method['Inputs'] extends undefined|unknown ? any[] : Method['Inputs']
...args: Method['Inputs'] extends undefined | unknown ? any[] : Method['Inputs']
) => Method['Abi']['stateMutability'] extends 'payable' | 'pure'
? PayableMethodObject<Method['Inputs'], Method['Outputs']>
: NonPayableMethodObject<Method['Inputs'], Method['Outputs']>;
Expand Down Expand Up @@ -148,6 +156,16 @@ export type ContractMethodsInterface<Abi extends ContractAbi> = {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
} & { [key: string]: ContractBoundMethod<any> };

export type ContractMethodSend = Web3PromiEvent<
FormatType<TransactionReceipt, typeof DEFAULT_RETURN_FORMAT>,
SendTransactionEvents<typeof DEFAULT_RETURN_FORMAT>
>;
export type ContractDeploySend<Abi extends ContractAbi> = Web3PromiEvent<
// eslint-disable-next-line no-use-before-define
Contract<Abi>,
SendTransactionEvents<typeof DEFAULT_RETURN_FORMAT>
>;

/**
* @hidden
* The event object can be accessed from `myContract.events.myEvent`.
Expand Down Expand Up @@ -768,12 +786,7 @@ export class Contract<Abi extends ContractAbi>
const deployData = _input ?? _data;
return {
arguments: args,
send: (
options?: PayableTxOptions,
): Web3PromiEvent<
Contract<Abi>,
SendTransactionEvents<typeof DEFAULT_RETURN_FORMAT>
> => {
send: (options?: PayableTxOptions): ContractDeploySend<Abi> => {
const modifiedOptions = { ...options };

// eslint-disable-next-line @typescript-eslint/no-unsafe-return
Expand Down Expand Up @@ -1101,7 +1114,7 @@ export class Contract<Abi extends ContractAbi>
block,
),

send: (options?: PayableTxOptions | NonPayableTxOptions) =>
send: (options?: PayableTxOptions | NonPayableTxOptions): ContractMethodSend =>
this._contractMethodSend(methodAbi, abiParams, internalErrorsAbis, options),

estimateGas: async <ReturnFormat extends DataFormat = typeof DEFAULT_RETURN_FORMAT>(
Expand Down