Add Advanced Sample Project that uses TypeScript #1770

feuGeneA · 2021-08-06T20:46:22Z

Add advanced sample project with TypeScript
Convert require to import in packages/hardhat-core/sample-projects/advanced-ts/scripts/deploy.ts.

Partially addresses review comment #1632 (comment)

fvictorio · 2021-08-13T20:06:37Z

Minor point but: I think we should use .env.example instead of .env.template. I personally have always seen and used .example, but besides the anecdotal evidence, there seems to be more of those files according to GH search: 584K vs 37K. There's also dotenv-safe, which assumes the example file is called that way.

packages/hardhat-core/sample-projects/advanced-ts/README.md

Co-authored-by: Franco Victorio <[email protected]>

Addresses review comment #1770 (comment)

changeset-bot · 2021-08-27T10:37:52Z

🦋 Changeset detected

Latest commit: a00345c

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
hardhat	Patch

Not sure what this means? Click here to learn what changesets are.

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

fvictorio

LGTM. I think @alcuadrado was going to review this one too.

fvictorio · 2021-08-27T10:59:39Z

Oh, one minor comment is that running the suggested eslint command in the README results in this warning:

=============

WARNING: You are currently running a version of TypeScript which is not officially supported by @typescript-eslint/typescript-estree.

You may find that it works just fine, or you may not.

SUPPORTED TYPESCRIPT VERSIONS: >=3.3.1 <4.4.0

YOUR TYPESCRIPT VERSION: 4.4.2

Please only submit bug reports when using the officially supported version.

=============

I don't know if there's a perfect solution for this. If we always use the latest versions of both typescript and @typescript-eslint, this will happen now and then. If we pin them, we'll need to remember to upgrade them (and we probably won't). I say we leave it as it is and, if users care, they can downgrade typescript manually.

cgewecke

Really cool! ❤️

packages/hardhat-core/sample-projects/advanced-ts/hardhat.config.ts

cgewecke · 2021-08-28T16:54:25Z

packages/hardhat-core/sample-projects/advanced-ts/hardhat.config.ts

+  },
+  gasReporter: {
+    enabled: process.env.REPORT_GAS !== undefined,
+    currency: "USD",


@feuGeneA

Hi, wrt your issue at hardhat-gas-reporter 72. Was not able to reproduce (using a valid coinmarketcap api. key). I know you tried that but ... maybe there was a copy-paste error or something?

Price data seems to be working ok for latest hardhat in this recent CI run for the plugin.

The config used for that test is:

gasReporter: { coinmarketcap: process.env.CMC_API_KEY }

[EDIT - I think the price problem is a race-condition issue that likely only affects tiny projects (like a sample). More detail about this in hh-gas-reporter 72 comment]

@cgewecke, is there a way to disable this feature and just show the prices in eth? While i find it really cool, it would be nice if we don't ask the users to provide another api key in these sample projects.

Yes good idea,. Someone else has requested that here as well ... (cross-linking: cgewecke/eth-gas-reporter#219)

packages/hardhat-core/sample-projects/advanced-ts/.eslintrc.js

packages/hardhat-core/sample-projects/advanced-ts/hardhat.config.ts

alcuadrado · 2021-09-17T19:45:39Z

packages/hardhat-core/sample-projects/advanced-ts/hardhat.config.ts

+  },
+  gasReporter: {
+    enabled: process.env.REPORT_GAS !== undefined,
+    currency: "USD",


@cgewecke, is there a way to disable this feature and just show the prices in eth? While i find it really cool, it would be nice if we don't ask the users to provide another api key in these sample projects.

Per #1770 (comment)

Addresses review comment #1770 (comment)

Now matches what we were already doing in the advanced JS project. Addresses review comment #1770 (comment)

Store source file as npmignore (without the leading period) so that it doesn't instruct the packaging of hardhat itself to exclude the files listed therein, otherwise they won't be available at project creation time. Addresses review comment #1770 (comment)

Addresses review comment #1770 (comment)

Now matches what we were already doing in the advanced JS project. Addresses review comment #1770 (comment)

alcuadrado

This looks good now, @feuGeneA!

I just added another changeset mentioning there were changes to the advance sample project.

feuGeneA self-assigned this Aug 6, 2021

feuGeneA force-pushed the sample-ts-project branch 2 times, most recently from d15141f to 429071d Compare August 10, 2021 17:02

feuGeneA added 2 commits August 10, 2021 13:10

Some corrections to the (non-TS) Adv. Sample Proj.

1038d20

Add Advanced Sample Project with TypeScript

1c332be

feuGeneA force-pushed the sample-ts-project branch from 429071d to 1c332be Compare August 10, 2021 17:21

feuGeneA marked this pull request as ready for review August 10, 2021 17:36

feuGeneA requested a review from fvictorio August 10, 2021 17:36

feuGeneA added 6 commits August 10, 2021 14:27

add typechain to recommended gitignore

aaa1976

Convert that last require to an import

771bc11

README mention skipping typechecking with ts-node

ac5bb98

Added .env & coverage to recommended_gitignore.txt

3c48f86

Partially addresses review comment #1632 (comment)

Merge branch 'multiple-sample-projects' into sample-ts-project

3d05a25

Work around sc-forks/solidity-coverage#652

aad5237

Base automatically changed from multiple-sample-projects to master August 13, 2021 12:26

Merge branch 'master' into sample-ts-project

6a6945d

fvictorio reviewed Aug 13, 2021

View reviewed changes

packages/hardhat-core/sample-projects/advanced-ts/README.md Outdated Show resolved Hide resolved

fvictorio reviewed Aug 13, 2021

View reviewed changes

packages/hardhat-core/sample-projects/advanced-ts/README.md Outdated Show resolved Hide resolved

feuGeneA and others added 3 commits August 18, 2021 12:31

Correct js/ts mixup in README

af2959a

Co-authored-by: Franco Victorio <[email protected]>

Correct another js/ts mixup in README

7f00860

Co-authored-by: Franco Victorio <[email protected]>

Rename .env.template to .env.example

4101c42

Addresses review comment #1770 (comment)

feuGeneA requested a review from fvictorio August 23, 2021 21:26

Merge branch 'master' into sample-ts-project

721ba0d

Add changeset

e29e14c

fvictorio approved these changes Aug 27, 2021

View reviewed changes

fvictorio requested a review from alcuadrado August 27, 2021 10:56

cgewecke reviewed Aug 28, 2021

View reviewed changes

alcuadrado reviewed Sep 17, 2021

View reviewed changes

packages/hardhat-core/sample-projects/advanced-ts/.eslintrc.js Outdated Show resolved Hide resolved

alcuadrado reviewed Sep 17, 2021

View reviewed changes

feuGeneA added 2 commits September 21, 2021 14:27

Remove workaround for solidity-coverage issue

87cef63

Per #1770 (comment)

eslintrc: rm hre global for hardhat config

1cc3ba3

Addresses review comment #1770 (comment)

feuGeneA added a commit that referenced this pull request Sep 21, 2021

eslintrc: declutter via .npmignore

b56a8a4

Addresses review comment #1770 (comment)

feuGeneA added a commit that referenced this pull request Sep 21, 2021

scripts: process.exitCode=1, not process.exit(1)

aa7976f

Addresses review comment #1770 (comment)

feuGeneA added a commit that referenced this pull request Sep 21, 2021

Improve handling of PRIVATE_KEY env var

48a4c56

Now matches what we were already doing in the advanced JS project. Addresses review comment #1770 (comment)

feuGeneA added 3 commits September 22, 2021 14:18

scripts: process.exitCode=1, not process.exit(1)

d88015c

Addresses review comment #1770 (comment)

Improve handling of PRIVATE_KEY env var

91d1203

Now matches what we were already doing in the advanced JS project. Addresses review comment #1770 (comment)

feuGeneA force-pushed the sample-ts-project branch from 48a4c56 to 91d1203 Compare September 22, 2021 21:31

Merge branch 'master' into sample-ts-project

6b80fd0

feuGeneA requested a review from alcuadrado September 22, 2021 21:57

Create khaki-actors-give.md

a00345c

alcuadrado approved these changes Sep 28, 2021

View reviewed changes

feuGeneA merged commit 1239385 into master Oct 4, 2021

fvictorio deleted the sample-ts-project branch October 4, 2021 21:57

github-actions bot locked as resolved and limited conversation to collaborators Nov 18, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Advanced Sample Project that uses TypeScript #1770

Add Advanced Sample Project that uses TypeScript #1770

feuGeneA commented Aug 6, 2021 •

edited

Loading

fvictorio commented Aug 13, 2021

changeset-bot bot commented Aug 27, 2021 •

edited

Loading

fvictorio left a comment

fvictorio commented Aug 27, 2021

cgewecke left a comment

cgewecke Aug 28, 2021 •

edited

Loading

alcuadrado Sep 17, 2021

cgewecke Sep 17, 2021

alcuadrado Sep 17, 2021

alcuadrado left a comment

Add Advanced Sample Project that uses TypeScript #1770

Add Advanced Sample Project that uses TypeScript #1770

Conversation

feuGeneA commented Aug 6, 2021 • edited Loading

fvictorio commented Aug 13, 2021

changeset-bot bot commented Aug 27, 2021 • edited Loading

🦋 Changeset detected

fvictorio left a comment

Choose a reason for hiding this comment

fvictorio commented Aug 27, 2021

cgewecke left a comment

Choose a reason for hiding this comment

cgewecke Aug 28, 2021 • edited Loading

Choose a reason for hiding this comment

alcuadrado Sep 17, 2021

Choose a reason for hiding this comment

cgewecke Sep 17, 2021

Choose a reason for hiding this comment

alcuadrado Sep 17, 2021

Choose a reason for hiding this comment

alcuadrado left a comment

Choose a reason for hiding this comment

feuGeneA commented Aug 6, 2021 •

edited

Loading

changeset-bot bot commented Aug 27, 2021 •

edited

Loading

cgewecke Aug 28, 2021 •

edited

Loading