Skip to content

Support promise inputs in ethers-v5 target #700

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

Merged
merged 7 commits into from
Jun 3, 2022
Merged

Support promise inputs in ethers-v5 target #700

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
a7a34dd
feat: wrap primitive input types in PromiseOrValue
zemse May 24, 2022
251c86e
chore: regenerate types
zemse May 24, 2022
a1a1583
test: add tests for inputs wrapped in promise
zemse May 24, 2022
dca28cd
fix: common import in factories
zemse May 24, 2022
104e27d
refactor: use PromiseOrValue for the from override
zemse May 24, 2022
53aa353
chore: regenerate types
zemse May 24, 2022
f619c59
chore: add changeset
zemse May 25, 2022
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
1 change: 1 addition & 0 deletions packages/hardhat-test/typechain-types/Counter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ import type {
TypedEvent,
TypedListener,
OnEvent,
PromiseOrValue,
} from "./common";

export interface CounterInterface extends utils.Interface {
Expand Down
11 changes: 9 additions & 2 deletions packages/hardhat-test/typechain-types/Demo.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,17 +15,24 @@ import type {
TypedEvent,
TypedListener,
OnEvent,
PromiseOrValue,
} from "./common";

export declare namespace Demo {
export type Struct1Struct = { a: BigNumberish; b: BigNumberish };
export type Struct1Struct = {
a: PromiseOrValue<BigNumberish>;
b: PromiseOrValue<BigNumberish>;
};

export type Struct1StructOutput = [BigNumber, BigNumber] & {
a: BigNumber;
b: BigNumber;
};

export type Struct2Struct = { a: BigNumberish; b: BigNumberish };
export type Struct2Struct = {
a: PromiseOrValue<BigNumberish>;
b: PromiseOrValue<BigNumberish>;
};

export type Struct2StructOutput = [BigNumber, BigNumber] & {
a: BigNumber;
Expand Down
6 changes: 5 additions & 1 deletion packages/hardhat-test/typechain-types/StructsInConstructor.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,13 @@ import type {
TypedEvent,
TypedListener,
OnEvent,
PromiseOrValue,
} from "./common";

export type Vector2Struct = { x: BigNumberish; y: BigNumberish };
export type Vector2Struct = {
x: PromiseOrValue<BigNumberish>;
y: PromiseOrValue<BigNumberish>;
};

export type Vector2StructOutput = [BigNumber, BigNumber] & {
x: BigNumber;
Expand Down
2 changes: 2 additions & 0 deletions packages/hardhat-test/typechain-types/common.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,3 +42,5 @@ export type GetContractTypeFromFactory<F> = F extends MinEthersFactory<
export type GetARGsTypeFromFactory<F> = F extends MinEthersFactory<any, any>
? Parameters<F["deploy"]>
: never;

export type PromiseOrValue<T> = T | Promise<T>;
1 change: 1 addition & 0 deletions packages/hardhat-test/typechain-types/factories/Counter__factory.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
/* eslint-disable */
import { Signer, utils, Contract, ContractFactory, Overrides } from "ethers";
import type { Provider, TransactionRequest } from "@ethersproject/providers";
import type { PromiseOrValue } from "./common";
import type { Counter, CounterInterface } from "../Counter";

const _abi = [
Expand Down
1 change: 1 addition & 0 deletions packages/hardhat-test/typechain-types/factories/Demo__factory.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
/* eslint-disable */
import { Signer, utils, Contract, ContractFactory, Overrides } from "ethers";
import type { Provider, TransactionRequest } from "@ethersproject/providers";
import type { PromiseOrValue } from "./common";
import type { Demo, DemoInterface } from "../Demo";

const _abi = [
Expand Down
1 change: 1 addition & 0 deletions packages/hardhat-test/typechain-types/factories/StructsInConstructor__factory.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
/* eslint-disable */
import { Signer, utils, Contract, ContractFactory, Overrides } from "ethers";
import type { Provider, TransactionRequest } from "@ethersproject/providers";
import type { PromiseOrValue } from "./common";
import type {
StructsInConstructor,
StructsInConstructorInterface,
Expand Down
1 change: 1 addition & 0 deletions ...at/test/fixture-projects/hardhat-project/typechain-types/artifacts/contracts/EdgeCases.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import type {
TypedEvent,
TypedListener,
OnEvent,
PromiseOrValue,
} from "../../common";

export interface EdgeCasesInterface extends utils.Interface {
Expand Down
1 change: 1 addition & 0 deletions ...test/fixture-projects/hardhat-project/typechain-types/artifacts/contracts/TestContract.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import type {
TypedEvent,
TypedListener,
OnEvent,
PromiseOrValue,
} from "../../common";

export interface TestContractInterface extends utils.Interface {
Expand Down
1 change: 1 addition & 0 deletions ...est/fixture-projects/hardhat-project/typechain-types/artifacts/contracts/TestContract1.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import type {
TypedEvent,
TypedListener,
OnEvent,
PromiseOrValue,
} from "../../common";

export interface TestContract1Interface extends utils.Interface {
Expand Down
89 changes: 45 additions & 44 deletions ...test/fixture-projects/hardhat-project/typechain-types/artifacts/contracts/lib/SafeMath.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ import type {
TypedEvent,
TypedListener,
OnEvent,
PromiseOrValue,
} from "../../../common";

export interface SafeMathInterface extends utils.Interface {
Expand All @@ -34,19 +35,19 @@ export interface SafeMathInterface extends utils.Interface {

encodeFunctionData(
functionFragment: "add",
values: [BigNumberish, BigNumberish]
values: [PromiseOrValue<BigNumberish>, PromiseOrValue<BigNumberish>]
): string;
encodeFunctionData(
functionFragment: "div",
values: [BigNumberish, BigNumberish]
values: [PromiseOrValue<BigNumberish>, PromiseOrValue<BigNumberish>]
): string;
encodeFunctionData(
functionFragment: "mul",
values: [BigNumberish, BigNumberish]
values: [PromiseOrValue<BigNumberish>, PromiseOrValue<BigNumberish>]
): string;
encodeFunctionData(
functionFragment: "sub",
values: [BigNumberish, BigNumberish]
values: [PromiseOrValue<BigNumberish>, PromiseOrValue<BigNumberish>]
): string;

decodeFunctionResult(functionFragment: "add", data: BytesLike): Result;
Expand Down Expand Up @@ -85,76 +86,76 @@ export interface SafeMath extends BaseContract {

functions: {
add(
num1: BigNumberish,
num2: BigNumberish,
num1: PromiseOrValue<BigNumberish>,
num2: PromiseOrValue<BigNumberish>,
overrides?: CallOverrides
): Promise<[BigNumber]>;

div(
num1: BigNumberish,
num2: BigNumberish,
num1: PromiseOrValue<BigNumberish>,
num2: PromiseOrValue<BigNumberish>,
overrides?: CallOverrides
): Promise<[BigNumber]>;

mul(
num1: BigNumberish,
num2: BigNumberish,
num1: PromiseOrValue<BigNumberish>,
num2: PromiseOrValue<BigNumberish>,
overrides?: CallOverrides
): Promise<[BigNumber]>;

sub(
num1: BigNumberish,
num2: BigNumberish,
num1: PromiseOrValue<BigNumberish>,
num2: PromiseOrValue<BigNumberish>,
overrides?: CallOverrides
): Promise<[BigNumber]>;
};

add(
num1: BigNumberish,
num2: BigNumberish,
num1: PromiseOrValue<BigNumberish>,
num2: PromiseOrValue<BigNumberish>,
overrides?: CallOverrides
): Promise<BigNumber>;

div(
num1: BigNumberish,
num2: BigNumberish,
num1: PromiseOrValue<BigNumberish>,
num2: PromiseOrValue<BigNumberish>,
overrides?: CallOverrides
): Promise<BigNumber>;

mul(
num1: BigNumberish,
num2: BigNumberish,
num1: PromiseOrValue<BigNumberish>,
num2: PromiseOrValue<BigNumberish>,
overrides?: CallOverrides
): Promise<BigNumber>;

sub(
num1: BigNumberish,
num2: BigNumberish,
num1: PromiseOrValue<BigNumberish>,
num2: PromiseOrValue<BigNumberish>,
overrides?: CallOverrides
): Promise<BigNumber>;

callStatic: {
add(
num1: BigNumberish,
num2: BigNumberish,
num1: PromiseOrValue<BigNumberish>,
num2: PromiseOrValue<BigNumberish>,
overrides?: CallOverrides
): Promise<BigNumber>;

div(
num1: BigNumberish,
num2: BigNumberish,
num1: PromiseOrValue<BigNumberish>,
num2: PromiseOrValue<BigNumberish>,
overrides?: CallOverrides
): Promise<BigNumber>;

mul(
num1: BigNumberish,
num2: BigNumberish,
num1: PromiseOrValue<BigNumberish>,
num2: PromiseOrValue<BigNumberish>,
overrides?: CallOverrides
): Promise<BigNumber>;

sub(
num1: BigNumberish,
num2: BigNumberish,
num1: PromiseOrValue<BigNumberish>,
num2: PromiseOrValue<BigNumberish>,
overrides?: CallOverrides
): Promise<BigNumber>;
};
Expand All @@ -163,52 +164,52 @@ export interface SafeMath extends BaseContract {

estimateGas: {
add(
num1: BigNumberish,
num2: BigNumberish,
num1: PromiseOrValue<BigNumberish>,
num2: PromiseOrValue<BigNumberish>,
overrides?: CallOverrides
): Promise<BigNumber>;

div(
num1: BigNumberish,
num2: BigNumberish,
num1: PromiseOrValue<BigNumberish>,
num2: PromiseOrValue<BigNumberish>,
overrides?: CallOverrides
): Promise<BigNumber>;

mul(
num1: BigNumberish,
num2: BigNumberish,
num1: PromiseOrValue<BigNumberish>,
num2: PromiseOrValue<BigNumberish>,
overrides?: CallOverrides
): Promise<BigNumber>;

sub(
num1: BigNumberish,
num2: BigNumberish,
num1: PromiseOrValue<BigNumberish>,
num2: PromiseOrValue<BigNumberish>,
overrides?: CallOverrides
): Promise<BigNumber>;
};

populateTransaction: {
add(
num1: BigNumberish,
num2: BigNumberish,
num1: PromiseOrValue<BigNumberish>,
num2: PromiseOrValue<BigNumberish>,
overrides?: CallOverrides
): Promise<PopulatedTransaction>;

div(
num1: BigNumberish,
num2: BigNumberish,
num1: PromiseOrValue<BigNumberish>,
num2: PromiseOrValue<BigNumberish>,
overrides?: CallOverrides
): Promise<PopulatedTransaction>;

mul(
num1: BigNumberish,
num2: BigNumberish,
num1: PromiseOrValue<BigNumberish>,
num2: PromiseOrValue<BigNumberish>,
overrides?: CallOverrides
): Promise<PopulatedTransaction>;

sub(
num1: BigNumberish,
num2: BigNumberish,
num1: PromiseOrValue<BigNumberish>,
num2: PromiseOrValue<BigNumberish>,
overrides?: CallOverrides
): Promise<PopulatedTransaction>;
};
Expand Down
2 changes: 2 additions & 0 deletions packages/hardhat/test/fixture-projects/hardhat-project/typechain-types/common.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,3 +42,5 @@ export type GetContractTypeFromFactory<F> = F extends MinEthersFactory<
export type GetARGsTypeFromFactory<F> = F extends MinEthersFactory<any, any>
? Parameters<F["deploy"]>
: never;

export type PromiseOrValue<T> = T | Promise<T>;
Loading