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.

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

General New User Umbrealla Issue #1

Open
Olshansk opened this issue Oct 22, 2021 · 2 comments
Open

General New User Umbrealla Issue #1

Olshansk opened this issue Oct 22, 2021 · 2 comments

Comments

@Olshansk
Copy link

I'm hoping to keep this "issue" to discuss a few general questions/suggestions as I'm getting acquainted with the library. I'm happy to contribute as well, but wanted to get some feedback first before putting together a formal PRt.

Regarding the Signers interface:

  1. Why not put the types directory under test/types given that it's used for testing?
  2. What's the motivation between only having one owner and one other rather than a few (or a list?) of users?

Regarding tests:
3. I was thinking of adding a few examples of different tests for future readers, but not sure if that's outside the scope of this github repo in terms of what you had in mind.

@yosriady
Copy link
Owner

Why not put the types directory under test/types given that it's used for testing?

I agree, that would be cleaner.

What's the motivation between only having one owner and one other rather than a few (or a list?) of users?

There's no particular reason. Instead of defining just 2 accounts in https://github.com/yosriady/contracts-starter/blob/master/test/utils/context.ts#L8-L19, it could just return the whole set and have each test suite select the accounts it needs. That's be a good improvement.

I was thinking of adding a few examples of different tests for future readers, but not sure if that's outside the scope of this github repo in terms of what you had in mind.

That would be fantastic! I think the following can be added:

  • Testing events
  • Testing reverts

@Olshansk
Copy link
Author

Thanks for the quick and detailed reply!

I used this repo as the foundation for a project I'm working on and it's definitely super useful.

Once I make some more progress, I'll send over a PR with some of the common tasks (e.g. testing reverts, importing Libs, general-purpose hardhat tasks) I've found useful for review.

I'll keep it very light and basic skeletons to prevent the repo from having too much source code out of the box.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants