[ethers-v5] Add events support by zemse · Pull Request #321 · dethcrypto/TypeChain

zemse · 2021-01-29T17:05:58Z

This PR adds the missing events support to the ethers v5 target and intends to close #303 and close #249. Thanks @quezak for #303 (comment)

Usage

const filter = contract.filters.Transfer(null, null, null); // TypedEventFilter<>
const result = await contract.queryFilter(filter); // TypedEvent<>

result[0].args.from // type support for named event parameters
result[0].args[0] // type support by index

contract.on(filter, (from, to, value, event) => {
  from; // string
  to; // string
  value; // BigNumber
  event; // TypedEvent<>
})

To test this in your project

git clone -b 303-ethers-v5-add-event-support https://github.com/zemse/TypeChain.git
cd TypeChain
yarn (you need yarn installed if you don't)
yarn build (this generates dist dir which is imp)
Link this custom target to your project by placing the appropriate path to the target: typechain --target ../TypeChain/packages/target-ethers-v5/ (Docs)

Just in case if that sounds too much, I have temporarily published it to npm for testing:

npm install typechain-target-ethers-v5 --save-dev (later you can just replace the package with official one)
typechain --target ethers-v5 (Docs)

changeset-bot · 2021-01-29T17:06:00Z

⚠️ No Changeset found

Latest commit: ca120c7

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

- addListener function was removed since it does not exist in v5 - listeners and off was added

zemse · 2021-01-29T20:57:00Z

Hi @krzkaczor, there is the following error when running the typecheck script (failing in CI) but my typescript compiler (v4.1.3) does not complain about it and seems to work fine. Can you help how this issue can be resolved?

types/commons.ts(15,20): error TS1256: A rest element must be last in a tuple type.
error Command failed with exit code 1.

quezak

Some initial comments before I try this out on my contracts.

Random thought: is it a good idea to skip the whole typed listeners section if a contract has no defined events?

quezak · 2021-02-01T19:10:31Z

+    listeners(eventName?: string): Array<Listener>;
+    off(eventName: string, listener: Listener): this;
+    on(eventName: string, listener: Listener): this;
+    once(eventName: string, listener: Listener): this;
+    removeListener(eventName: string, listener: Listener): this;
+    removeAllListeners(eventName?: string): this;
+
+    listeners<T, G>(eventFilter?: TypedEventFilter<T, G>): Array<TypedListener<T, G>>;
+    off<T, G>(eventFilter: TypedEventFilter<T, G>, listener: TypedListener<T, G>): this;
+    on<T, G>(eventFilter: TypedEventFilter<T, G>, listener: TypedListener<T, G>): this;
+    once<T, G>(eventFilter: TypedEventFilter<T, G>, listener: TypedListener<T, G>): this;
+    removeListener<T, G>(eventFilter: TypedEventFilter<T, G>, listener: TypedListener<T, G>): this;
+    removeAllListeners<T, G>(eventFilter: TypedEventFilter<T, G>): this;


I think the more specific overloads should be first, since TS checks them top-to-bottom IIRC

is it a good idea to skip the whole typed listeners section if a contract has no defined events?

It's a definitely great idea. Since even if these typed listener section lies there useless for contracts without events, I don't think it would affect normal functionality (lmk if it does). Would it be fine if we do that in a separate PR? If not I can do that here.

quezak · 2021-02-01T19:16:41Z

+    import { EventFilter, Event } from 'ethers'
+    import { Result } from '@ethersproject/abi'
+
+    export interface TypedEventFilter<T, G> extends EventFilter {}


why are the T & G args here if they're not used?

Actually the T & G contain type info utilised by queryFilter and other methods for output

krzkaczor · 2021-02-11T18:53:50Z

@zemse as for this TS error, it seems that it works only in TS 4.0+ (https://stackoverflow.com/questions/53356652/typescript-generic-tuples-error-rest-element)

You should get the same error if you use yarn.lock 🤔 Anyway, it doesn't matter, we can bump TS to 4.0 (or even newer?). And bump peer dependency from "typescript": ">=3.8.0", to 4+ in packages/target-ethers-v5/package.json.

Soo, could you:

Normalize all package.json dependencies on typescript to 4.0
Bump peer dependency? in packages/target-ethers-v5/package.json

I will deploy it as major version of ethers-v5 to avoid breaking something.

Thanks!

krzkaczor · 2021-02-14T16:18:41Z

@zemse can we add a test (can be the same thing as you put in this PR description) proofing that this works (and continue to work in future ;) )?

zemse · 2021-02-20T09:54:31Z

I've added some tests pls review

krzkaczor · 2021-02-21T22:11:18Z

@zemse thanks for this! Released in: https://github.com/ethereum-ts/TypeChain/releases/tag/%40typechain%2Fethers-v5%406.0.0

fubar · 2021-02-25T03:52:01Z

@zemse how is this supposed to work? Maybe I'm missing something but the first line in your example contract.filters.Transfer() is invalid because the declaration of that function is generated with arguments:

Transfer(
  from: string | null,
  to: string | null,
  value: null
): TypedEventFilter<
  [string, string, BigNumber],
  { from: string; to: string; value: BigNumber }
>;

Which means those 3 arguments are required.

zemse · 2021-02-25T06:04:36Z

Oh right, you need to do the following, will update the description too.

contract.filters.Transfer(null, null, null)

As a side note: Actually ethers.js on it's core is fine without passing any args, so the args should be made optional in the target too. Will make a PR soon.

fubar · 2021-02-25T06:05:58Z

@zemse sounds good, thanks!

[ethers-v5] Add type support for queryFilter

7b6bf54

zemse marked this pull request as draft January 29, 2021 17:06

zemse added 2 commits January 30, 2021 01:24

[ethers-v5] Add type support for event listeners

44e3938

- addListener function was removed since it does not exist in v5 - listeners and off was added

[ethers-v5] Regenerate types

4622644

zemse added 2 commits January 30, 2021 05:05

[ethers-v5] Fix bug in queryFilter return type

6fa199a

[ethers-v5] Regenerate types

1c5dcc8

quezak reviewed Feb 1, 2021

View reviewed changes

zemse added 3 commits February 9, 2021 16:58

[ethers-v5] Rename generics to suitable names

c6b07aa

[ethers-v5] Move more specific overloads above

73dd6ef

[ethers-v5] Regenerate types

4a91a4f

zemse marked this pull request as ready for review February 9, 2021 11:38

[ethers-v5] Regenerate types

33e567f

zemse added 2 commits February 20, 2021 15:17

[ethers-v5] Fix TypedListener bug and regen types

cff01b0

[ethers-v5] Add tests for events

ca120c7

krzkaczor changed the base branch from master to kk/ethers-v5-add-event-support February 21, 2021 16:07

krzkaczor merged commit 297e320 into dethcrypto:kk/ethers-v5-add-event-support Feb 21, 2021

adrianmcli mentioned this pull request Feb 22, 2021

Upgrade ethers and typechain adrianmcli/dapp-boilerplate#3

Merged

dwardu mentioned this pull request Feb 26, 2021

Fix ethers-v5 code-generation for no-argument events #331

Merged

janklimo mentioned this pull request May 6, 2021

Event types #379

Closed

Uh oh!

Conversation

zemse commented Jan 29, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Usage

To test this in your project

Uh oh!

changeset-bot Bot commented Jan 29, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ No Changeset found

Uh oh!

zemse commented Jan 29, 2021

Uh oh!

quezak left a comment

Choose a reason for hiding this comment

Uh oh!

quezak Feb 1, 2021

Choose a reason for hiding this comment

Uh oh!

zemse Feb 1, 2021

Choose a reason for hiding this comment

Uh oh!

quezak Feb 1, 2021

Choose a reason for hiding this comment

Uh oh!

zemse Feb 1, 2021

Choose a reason for hiding this comment

Uh oh!

Uh oh!

krzkaczor commented Feb 11, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

krzkaczor commented Feb 14, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

zemse commented Feb 20, 2021

Uh oh!

krzkaczor commented Feb 21, 2021

Uh oh!

fubar commented Feb 25, 2021

Uh oh!

zemse commented Feb 25, 2021

Uh oh!

fubar commented Feb 25, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

zemse commented Jan 29, 2021 •

edited

Loading

changeset-bot Bot commented Jan 29, 2021 •

edited

Loading

krzkaczor commented Feb 11, 2021 •

edited

Loading

krzkaczor commented Feb 14, 2021 •

edited

Loading