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.

Sign up for GitHub

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

Jump to bottom

🥑 Add mock contract typing #818

Merged
merged 2 commits into from
Jan 26, 2023
Merged

🥑 Add mock contract typing #818

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3edf43e
🥑 Add mock contract typing
pawelpolak2 Jan 25, 2023
807e058
lint
pawelpolak2 Jan 25, 2023
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
5 changes: 5 additions & 0 deletions .changeset/silly-pets-do.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@ethereum-waffle/mock-contract": patch
---

Mock contract typing
22 changes: 13 additions & 9 deletions waffle-mock-contract/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {Contract, ContractFactory, Signer, utils} from 'ethers';
import {BaseContract, Contract, ContractFactory, Signer, utils} from 'ethers';
import type {JsonFragment} from '@ethersproject/abi';

import DoppelgangerContract from './Doppelganger.json';
Expand All @@ -13,9 +13,9 @@ interface StubInterface {
withArgs(...args: any[]): StubInterface;
}

export interface MockContract extends Contract {
export interface MockContract<T extends BaseContract = BaseContract> extends Contract {
mock: {
[key: string]: StubInterface;
[key in ((keyof T['functions'] | 'receive'))]: StubInterface;
};
call (contract: Contract, functionName: string, ...params: any[]): Promise<any>;
staticcall (contract: Contract, functionName: string, ...params: any[]): Promise<any>;
Expand Down Expand Up @@ -155,7 +155,7 @@ async function deploy(signer: Signer, options?: DeployOptions) {
return factory.deploy();
}

function createMock(abi: ABI, mockContractInstance: Contract) {
function createMock<T extends BaseContract>(abi: ABI, mockContractInstance: Contract): MockContract<T>['mock'] {
const {functions} = new utils.Interface(abi);
const encoder = new utils.AbiCoder();

Expand All @@ -166,9 +166,9 @@ function createMock(abi: ABI, mockContractInstance: Contract) {
[func.name]: stubbed,
[func.format()]: stubbed
};
}, {} as MockContract['mock']);
}, {} as MockContract<T>['mock']);

mockedAbi.receive = {
(mockedAbi as any).receive = {
pawelpolak2 marked this conversation as resolved.
Show resolved Hide resolved
returns: () => { throw new Error('Receive function return is not implemented.'); },
withArgs: () => { throw new Error('Receive function return is not implemented.'); },
reverts: () => mockContractInstance.__waffle__receiveReverts('Mock Revert'),
Expand All @@ -178,11 +178,15 @@ function createMock(abi: ABI, mockContractInstance: Contract) {
return mockedAbi;
}

export async function deployMockContract(signer: Signer, abi: ABI, options?: DeployOptions): Promise<MockContract> {
export async function deployMockContract<T extends BaseContract = BaseContract>(
signer: Signer,
abi: ABI,
options?: DeployOptions
): Promise<MockContract<T>> {
const mockContractInstance = await deploy(signer, options);

const mock = createMock(abi, mockContractInstance);
const mockedContract = new Contract(mockContractInstance.address, abi, signer) as MockContract;
const mock = createMock<T>(abi, mockContractInstance);
const mockedContract = new Contract(mockContractInstance.address, abi, signer) as MockContract<T>;
mockedContract.mock = mock;

const encoder = new utils.AbiCoder();
Expand Down