fixes wevm#2560 value type on function overload

Yuripetusko · Jul 30, 2024 · 0e3b207 · 0e3b207
1 parent 410ff2b
commit 0e3b207
Show file tree

Hide file tree

Showing 14 changed files with 70 additions and 17 deletions.
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/src/actions/public/estimateContractGas.ts b/src/actions/public/estimateContractGas.ts
@@ -53,6 +53,7 @@ export type EstimateContractGasParameters<
  UnionOmit<EstimateGasParameters<chain>, 'data' | 'to' | 'value'> &
  GetValue<
  abi,
+ 'nonpayable' | 'payable',
  functionName,
  EstimateGasParameters<chain> extends EstimateGasParameters
  ? EstimateGasParameters<chain>['value']

diff --git a/src/actions/public/simulateContract.ts b/src/actions/public/simulateContract.ts
@@ -77,6 +77,7 @@ export type SimulateContractParameters<
  > &
  GetValue<
  abi,
+ 'nonpayable' | 'payable',
  functionName,
  CallParameters<derivedChain> extends CallParameters
  ? CallParameters<derivedChain>['value']

diff --git a/src/actions/wallet/writeContract.test.ts b/src/actions/wallet/writeContract.test.ts
@@ -176,6 +176,18 @@ test('overloaded function', async () => {
  ).toBeDefined()
 })
 
+test('payable overloaded function', async () => {
+ expect(
+ await writeContract(client, {
+ ...wagmiContractConfig,
+ account: accounts[0].address,
+ functionName: 'mint',
+ args: [69420n, 1n],
+ value: 1n,
+ }),
+ ).toBeDefined()
+})
+
 test('w/ simulateContract', async () => {
  const { request } = await simulateContract(client, {
  ...wagmiContractConfig,

diff --git a/src/actions/wallet/writeContract.ts b/src/actions/wallet/writeContract.ts
@@ -61,8 +61,10 @@ export type WriteContractParameters<
  GetAccountParameter<account> &
  GetValue<
  abi,
+ 'nonpayable' | 'payable',
  functionName,
- FormattedTransactionRequest<derivedChain>['value']
+ FormattedTransactionRequest<derivedChain>['value'],
+ args
  > & {
  /** Data to append to the end of the calldata. Useful for adding a ["domain" tag](https://opensea.notion.site/opensea/Seaport-Order-Attributions-ec2d69bf455041a5baa490941aad307f). */
  dataSuffix?: Hex | undefined

diff --git a/src/experimental/eip5792/actions/writeContracts.ts b/src/experimental/eip5792/actions/writeContracts.ts
@@ -151,4 +151,4 @@ export type WriteContractFunctionParameters<
  | (functionName extends allFunctionNames ? functionName : never) // infer value
  args?: (abi extends Abi ? UnionWiden<args> : never) | allArgs | undefined
 } & (readonly [] extends allArgs ? {} : { args: Widen<args> }) &
- GetValue<abi, functionName>
+ GetValue<abi, mutability, functionName>
diff --git a/src/op-stack/actions/estimateContractL1Fee.ts b/src/op-stack/actions/estimateContractL1Fee.ts
@@ -57,6 +57,7 @@ export type EstimateContractL1FeeParameters<
  > &
  GetValue<
  abi,
+ 'nonpayable' | 'payable',
  functionName,
  EstimateL1FeeParameters<
  chain,

diff --git a/src/op-stack/actions/estimateContractL1Gas.ts b/src/op-stack/actions/estimateContractL1Gas.ts
@@ -57,6 +57,7 @@ export type EstimateContractL1GasParameters<
  > &
  GetValue<
  abi,
+ 'nonpayable' | 'payable',
  functionName,
  EstimateL1GasParameters<
  chain,

diff --git a/src/op-stack/actions/estimateContractTotalFee.ts b/src/op-stack/actions/estimateContractTotalFee.ts
@@ -57,6 +57,7 @@ export type EstimateContractTotalFeeParameters<
  > &
  GetValue<
  abi,
+ 'nonpayable' | 'payable',
  functionName,
  EstimateTotalFeeParameters<
  chain,

diff --git a/src/op-stack/actions/estimateContractTotalGas.ts b/src/op-stack/actions/estimateContractTotalGas.ts
@@ -57,6 +57,7 @@ export type EstimateContractTotalGasParameters<
  > &
  GetValue<
  abi,
+ 'nonpayable' | 'payable',
  functionName,
  EstimateTotalGasParameters<
  chain,

diff --git a/src/types/contract.test-d.ts b/src/types/contract.test-d.ts
@@ -221,19 +221,23 @@ test('GetEventArgs', () => {
 
 test('GetValue', () => {
  // payable
- type Result = GetValue<typeof seaportAbi, 'fulfillAdvancedOrder'>
+ type Result = GetValue<typeof seaportAbi, 'payable', 'fulfillAdvancedOrder'>
  expectTypeOf<Result>().toEqualTypeOf<{ value?: bigint }>()
 
  // other
- expectTypeOf<GetValue<typeof seaportAbi, 'getOrderStatus'>>().toEqualTypeOf<{
+ expectTypeOf<
+ GetValue<typeof seaportAbi, 'view', 'getOrderStatus'>
+ >().toEqualTypeOf<{
  value?: never
  }>()
- expectTypeOf<GetValue<typeof seaportAbi, 'cancel'>>().toEqualTypeOf<{
+ expectTypeOf<
+ GetValue<typeof seaportAbi, 'nonpayable', 'cancel'>
+ >().toEqualTypeOf<{
  value?: never
  }>()
 
  // unknown abi
- expectTypeOf<GetValue<Abi, 'foo'>>().toEqualTypeOf<{
+ expectTypeOf<GetValue<Abi, 'nonpayable' | 'payable', 'foo'>>().toEqualTypeOf<{
  value?: bigint | undefined
  }>()
  const abi = [
@@ -244,7 +248,9 @@ test('GetValue', () => {
  outputs: [{ type: 'uint256' }],
  },
  ]
- expectTypeOf<GetValue<typeof abi, 'foo'>>().toEqualTypeOf<{
+ expectTypeOf<
+ GetValue<typeof abi, 'nonpayable' | 'payable', 'foo'>
+ >().toEqualTypeOf<{
  value?: bigint | undefined
  }>()
 })

diff --git a/src/types/contract.ts b/src/types/contract.ts
@@ -303,10 +303,19 @@ export type EventDefinition = `${string}(${string})`
 
 export type GetValue<
  abi extends Abi | readonly unknown[],
- functionName extends string,
+ mutability extends AbiStateMutability = AbiStateMutability,
+ functionName extends ContractFunctionName<
+ abi,
+ mutability
+ > = ContractFunctionName<abi, mutability>,
  valueType = TransactionRequest['value'],
+ args extends ContractFunctionArgs<
+ abi,
+ mutability,
+ functionName
+ > = ContractFunctionArgs<abi, mutability, functionName>,
  abiFunction extends AbiFunction = abi extends Abi
- ? ExtractAbiFunction<abi, functionName>
+ ? ExtractAbiFunctionForArgs<abi, mutability, functionName, args>
  : AbiFunction,
  _Narrowable extends boolean = IsNarrowable<abi, Abi>,
 > = _Narrowable extends true

diff --git a/src/utils/abi/decodeFunctionData.test-d.ts b/src/utils/abi/decodeFunctionData.test-d.ts
@@ -31,7 +31,7 @@ test('default', () => {
  functionName: 'isApprovedForAll'
  }
  | {
- args: readonly [] | readonly [bigint]
+ args: readonly [] | readonly [bigint] | readonly [bigint, bigint]
  functionName: 'mint'
  }
  | {

diff --git a/test/src/abis.ts b/test/src/abis.ts
@@ -1363,6 +1363,16 @@ export const wagmiContractConfig = {
  stateMutability: 'nonpayable',
  type: 'function',
  },
+ {
+ inputs: [
+ { name: 'tokenId', type: 'uint256' },
+ { name: 'quantity', type: 'uint256' },
+ ],
+ name: 'mint',
+ outputs: [],
+ stateMutability: 'payable',
+ type: 'function',
+ },
  {
  inputs: [],
  name: 'name',