fix: always use view overrides for statcCalls (#866)

Co-authored-by: Paco <liaoishere@gmail.com>
dethcrypto · Aug 20, 2023 · 04ebda9 · 04ebda9
1 parent 64d18f7
commit 04ebda9
Show file tree

Hide file tree

Showing 8 changed files with 48 additions and 12 deletions.
diff --git a/.changeset/moody-lamps-mix.md b/.changeset/moody-lamps-mix.md
@@ -0,0 +1,5 @@
+---
+"@typechain/ethers-v6": patch
+---
+
+fix: always use view overrides for statcCalls
diff --git a/examples/ethers-v6-nodenext/types/ethers-contracts/common.ts b/examples/ethers-v6-nodenext/types/ethers-contracts/common.ts
@@ -122,8 +122,10 @@ export interface TypedContractMethod<
   populateTransaction(
     ...args: ContractMethodArgs<A, S>
   ): Promise<ContractTransaction>;
-  staticCall(...args: ContractMethodArgs<A, S>): Promise<DefaultReturnType<R>>;
+  staticCall(
+    ...args: ContractMethodArgs<A, "view">
+  ): Promise<DefaultReturnType<R>>;
   send(...args: ContractMethodArgs<A, S>): Promise<ContractTransactionResponse>;
   estimateGas(...args: ContractMethodArgs<A, S>): Promise<bigint>;
-  staticCallResult(...args: ContractMethodArgs<A, S>): Promise<R>;
+  staticCallResult(...args: ContractMethodArgs<A, "view">): Promise<R>;
 }
diff --git a/examples/ethers-v6/types/ethers-contracts/common.ts b/examples/ethers-v6/types/ethers-contracts/common.ts
@@ -122,8 +122,10 @@ export interface TypedContractMethod<
   populateTransaction(
     ...args: ContractMethodArgs<A, S>
   ): Promise<ContractTransaction>;
-  staticCall(...args: ContractMethodArgs<A, S>): Promise<DefaultReturnType<R>>;
+  staticCall(
+    ...args: ContractMethodArgs<A, "view">
+  ): Promise<DefaultReturnType<R>>;
   send(...args: ContractMethodArgs<A, S>): Promise<ContractTransactionResponse>;
   estimateGas(...args: ContractMethodArgs<A, S>): Promise<bigint>;
-  staticCallResult(...args: ContractMethodArgs<A, S>): Promise<R>;
+  staticCallResult(...args: ContractMethodArgs<A, "view">): Promise<R>;
 }
diff --git a/packages/hardhat-test/typechain-types/common.ts b/packages/hardhat-test/typechain-types/common.ts
@@ -122,8 +122,10 @@ export interface TypedContractMethod<
   populateTransaction(
     ...args: ContractMethodArgs<A, S>
   ): Promise<ContractTransaction>;
-  staticCall(...args: ContractMethodArgs<A, S>): Promise<DefaultReturnType<R>>;
+  staticCall(
+    ...args: ContractMethodArgs<A, "view">
+  ): Promise<DefaultReturnType<R>>;
   send(...args: ContractMethodArgs<A, S>): Promise<ContractTransactionResponse>;
   estimateGas(...args: ContractMethodArgs<A, S>): Promise<bigint>;
-  staticCallResult(...args: ContractMethodArgs<A, S>): Promise<R>;
+  staticCallResult(...args: ContractMethodArgs<A, "view">): Promise<R>;
 }
diff --git a/packages/hardhat/test/fixture-projects/hardhat-project/typechain-types/common.ts b/packages/hardhat/test/fixture-projects/hardhat-project/typechain-types/common.ts
@@ -122,8 +122,10 @@ export interface TypedContractMethod<
   populateTransaction(
     ...args: ContractMethodArgs<A, S>
   ): Promise<ContractTransaction>;
-  staticCall(...args: ContractMethodArgs<A, S>): Promise<DefaultReturnType<R>>;
+  staticCall(
+    ...args: ContractMethodArgs<A, "view">
+  ): Promise<DefaultReturnType<R>>;
   send(...args: ContractMethodArgs<A, S>): Promise<ContractTransactionResponse>;
   estimateGas(...args: ContractMethodArgs<A, S>): Promise<bigint>;
-  staticCallResult(...args: ContractMethodArgs<A, S>): Promise<R>;
+  staticCallResult(...args: ContractMethodArgs<A, "view">): Promise<R>;
 }
diff --git a/packages/target-ethers-v6-test/test/Payable.test.ts b/packages/target-ethers-v6-test/test/Payable.test.ts
@@ -0,0 +1,21 @@
+import type { AssertTrue, IsExact } from 'test-utils'
+
+import type { Payable } from '../types'
+import type { PostfixOverrides } from '../types/common'
+import { createNewBlockchain } from './common'
+
+describe('Payable', () => {
+  const chain = createNewBlockchain<Payable>('Payable')
+
+  it('generate view override parameter types for staticCall', async () => {
+    type InputType = Parameters<typeof chain.contract.payable_func.staticCall>
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    type _t1 = AssertTrue<IsExact<InputType, PostfixOverrides<[], 'view'>>>
+  })
+
+  it('generate view override parameter types for staticCallResult', async () => {
+    type InputType = Parameters<typeof chain.contract.payable_func.staticCallResult>
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    type _t1 = AssertTrue<IsExact<InputType, PostfixOverrides<[], 'view'>>>
+  })
+})
diff --git a/packages/target-ethers-v6-test/types/common.ts b/packages/target-ethers-v6-test/types/common.ts
@@ -122,8 +122,10 @@ export interface TypedContractMethod<
   populateTransaction(
     ...args: ContractMethodArgs<A, S>
   ): Promise<ContractTransaction>;
-  staticCall(...args: ContractMethodArgs<A, S>): Promise<DefaultReturnType<R>>;
+  staticCall(
+    ...args: ContractMethodArgs<A, "view">
+  ): Promise<DefaultReturnType<R>>;
   send(...args: ContractMethodArgs<A, S>): Promise<ContractTransactionResponse>;
   estimateGas(...args: ContractMethodArgs<A, S>): Promise<bigint>;
-  staticCallResult(...args: ContractMethodArgs<A, S>): Promise<R>;
+  staticCallResult(...args: ContractMethodArgs<A, "view">): Promise<R>;
 }
diff --git a/packages/target-ethers-v6/static/common.ts b/packages/target-ethers-v6/static/common.ts
@@ -82,8 +82,8 @@ export interface TypedContractMethod<
   getFragment(...args: ContractMethodArgs<A, S>): FunctionFragment
 
   populateTransaction(...args: ContractMethodArgs<A, S>): Promise<ContractTransaction>
-  staticCall(...args: ContractMethodArgs<A, S>): Promise<DefaultReturnType<R>>
+  staticCall(...args: ContractMethodArgs<A, 'view'>): Promise<DefaultReturnType<R>>
   send(...args: ContractMethodArgs<A, S>): Promise<ContractTransactionResponse>
   estimateGas(...args: ContractMethodArgs<A, S>): Promise<bigint>
-  staticCallResult(...args: ContractMethodArgs<A, S>): Promise<R>
+  staticCallResult(...args: ContractMethodArgs<A, 'view'>): Promise<R>
 }