Reviewing and updating Truffle-related references and code #955

wbnns · 2020-03-13T21:13:47Z

Thank you all for your offer of assistance with helping review and update Truffle-related references and code. As discussed via email, opening this issue so we can organize / coordinate together.

There are currently a significant number of references, as can be seen via git grep 'truffle' (here's a link to a gist with the output).

A lot of the code itself that needs to be reviewed/updated is in code/truffle.

Was thinking depending on your availability, it would be nice if you all could review the in-chapter references and help update the code samples.

Please let me know.

The text was updated successfully, but these errors were encountered:

adrianmcli · 2020-03-15T11:44:59Z

@wbnns thanks for the initial push.

I ran a similar command and found 51 files for "truffle" and 13 files for "ganache": https://gist.github.com/adrianmcli/97fd7388989aba80c8ec15de66ec4c45

I think this can be broken down into the following categories:

Chapters, Appendix, Glossary — Mostly text in paragraphs.
Code-based — Actual code.
Miscellaneous — Things in the contrib folder and also example_keys.txt

I think we can probably ignore the contrib stuff since most of that is old and it may not make it "into print" so-to-speak. However the rest definitely requires a review.

What does everyone think?

Files Breakdown

Ganache

Chapters, Appendix, Glossary

03clients.asciidoc
10tokens.asciidoc
appdx-dev-tools.asciidoc
glossary.asciidoc

Code

code/aws/truffle.js
code/truffle/CallExamples/truffle-config.js
code/truffle/METoken/truffle-config.js
code/truffle/METoken_Faucet/truffle-config.js
code/truffle/METoken_METFaucet/truffle-config.js
code/truffle/console/truffle-config.js

Miscellaneous

contrib/angular4-truffle.asciidoc
contrib/ethereum-testnets.asciidoc
misc/example_keys.txt

Truffle

Chapters, Appendix, Glossary

06transactions.asciidoc
07smart-contracts-solidity.asciidoc
10tokens.asciidoc
12dapps.asciidoc
appdx-dev-tools.asciidoc
glossary.asciidoc

Code

code/auction_dapp/DEV_README.md
code/aws/truffle.js
code/truffle/CallExamples/build/contracts/Migrations.json
code/truffle/CallExamples/build/contracts/calledContract.json
code/truffle/CallExamples/build/contracts/calledLibrary.json
code/truffle/CallExamples/build/contracts/caller.json
code/truffle/CallExamples/package-lock.json
code/truffle/CallExamples/package.json
code/truffle/CallExamples/truffle-config.js
code/truffle/Faucet/package-lock.json
code/truffle/Faucet/package.json
code/truffle/FaucetEvents/build/contracts/Faucet.json
code/truffle/FaucetEvents/build/contracts/Migrations.json
code/truffle/FaucetEvents/build/contracts/mortal.json
code/truffle/FaucetEvents/build/contracts/owned.json
code/truffle/FaucetEvents/package-lock.json
code/truffle/FaucetEvents/package.json
code/truffle/FaucetReentryAttack/build/contracts/Attacker.json
code/truffle/FaucetReentryAttack/build/contracts/Faucet.json
code/truffle/FaucetReentryAttack/build/contracts/Migrations.json
code/truffle/FaucetReentryAttack/build/contracts/mortal.json
code/truffle/FaucetReentryAttack/build/contracts/owned.json
code/truffle/FaucetReentryAttack/package-lock.json
code/truffle/FaucetReentryAttack/package.json
code/truffle/METoken/package-lock.json
code/truffle/METoken/package.json
code/truffle/METoken/truffle-config.js
code/truffle/METoken_Faucet/build/contracts/Faucet.json
code/truffle/METoken_Faucet/build/contracts/METoken.json
code/truffle/METoken_Faucet/build/contracts/Migrations.json
code/truffle/METoken_Faucet/package-lock.json
code/truffle/METoken_Faucet/package.json
code/truffle/METoken_Faucet/truffle-config.js
code/truffle/METoken_METFaucet/build/contracts/METFaucet.json
code/truffle/METoken_METFaucet/build/contracts/METoken.json
code/truffle/METoken_METFaucet/build/contracts/Migrations.json
code/truffle/METoken_METFaucet/package-lock.json
code/truffle/METoken_METFaucet/package.json
code/truffle/METoken_METFaucet/truffle-config.js
code/truffle/console/package-lock.json
code/truffle/console/package.json
code/truffle/console/truffle-config.js

Miscellaneous

contrib/angular4-truffle.asciidoc
contrib/aws-network-operation.asciidoc
contrib/ethereum-basics.asciidoc

adrianmcli · 2020-03-15T11:45:11Z

Also @wbnns is there a new deadline that you can give us?

wbnns · 2020-03-16T17:07:38Z

@adrianmcli

This sounds great. Thanks so much!

With regard to a deadline, it would be great to see what you all may be able to help us accomplish in the next 2-4 weeks, alongside your other commitments, if possible.

adrianmcli · 2020-03-16T18:09:26Z

@wbnns Got it. @nicholasjpaterno and I will coordinate to have this done in a few weeks!

wbnns · 2020-03-16T18:34:25Z

@adrianmcli @nicholasjpaterno

Thanks! Please let us know as any questions arise.

adrianmcli · 2020-04-04T04:23:33Z

@wbnns 3 PRs are now ready for review for the Ganache-specific references. Do note that I didn't run through the tutorial itself yet, I just corrected things that I know to be incorrect. I assume someone needs to do all that before publishing (i.e. actually read through the book and do the tutorials).

Ganache

Chapters, Appendix, Glossary: Ganache Text References #960

03clients.asciidoc
10tokens.asciidoc
appdx-dev-tools.asciidoc
glossary.asciidoc

Code: Ganache Code References #959

code/aws/truffle.js
code/truffle/CallExamples/truffle-config.js
code/truffle/METoken/truffle-config.js
code/truffle/METoken_Faucet/truffle-config.js
code/truffle/METoken_METFaucet/truffle-config.js
code/truffle/console/truffle-config.js

Miscellaneous: Ganache Misc References #958

contrib/angular4-truffle.asciidoc
contrib/ethereum-testnets.asciidoc
misc/example_keys.txt

adrianmcli · 2020-04-04T04:57:50Z

@wbnns It's my understanding that files in the contrib folder aren't actually part of the book and that a lot of them are files to be potentially included.

I think it might be a good idea to ignore them for now as a couple of them are quite outdated and require a lot of work to update. I'd rather focus our limited energies on what's already in the book.

Also, #961 is my review of the in-text references of "truffle" and is ready for review. Files reviewed:

06transactions.asciidoc
07smart-contracts-solidity.asciidoc
10tokens.asciidoc
12dapps.asciidoc
appdx-dev-tools.asciidoc
glossary.asciidoc

wbnns · 2020-04-08T13:43:13Z

@adrianmcli Thanks for the assistance! Merged #958, #959, #960 & #961.

Just to confirm, are you all still in the process of reviewing code/truffle/*?

Regarding contrib/:

I think it might be a good idea to ignore them for now as a couple of them are quite outdated and require a lot of work to update. I'd rather focus our limited energies on what's already in the book.

Understood. Let's defer to @aantonop on this.

Also:

I assume someone needs to do all that before publishing (i.e. actually read through the book and do the tutorials).

Yes, this is correct.

adrianmcli · 2020-04-08T20:58:34Z

@wbnns thanks for the merge

Just to confirm, are you all still in the process of reviewing code/truffle/*?

I'm waiting to see when #962 gets merged in. Since 0.6 brings quite a few significant changes to the code, I'd have to do the reivew/testing all over again if I did it now and the PR was subsequently merged.

adrianmcli · 2020-05-08T09:28:43Z

Just pointing out that I am no longer associated with Truffle, but I am happy to keep helping with the book.

wbnns · 2020-05-09T04:11:39Z

@adrianmcli

Ok, that would be great. I hope the move is for the best and that it connects you with a new and awesome opportunity.

What do you currently have bandwidth for in terms of what we were discussing previously?

adrianmcli · 2020-05-09T04:19:12Z

@wbnns I think we should make a decision on @HAOYUatHZ's issue first: #962 (comment)

chanhosuh · 2020-06-09T19:52:32Z

Has anyone gone through the proposed tutorial changes to make sure everything works with all the recent updates? Or do you need a hand on that?

adrianmcli · 2020-06-09T19:56:03Z

@chanhosuh I want to do it after all the code has been upgraded to 0.6. (e.g. when #962 is merged). Not sure why it's not merged yet though?

@HAOYUatHZ @wbnns what's the timeline on having everything converted to 0.6 so we can test things out and finalize this edition of the book?

chanhosuh · 2020-06-09T20:08:48Z

by the way, I noticed the truffle build artifacts are also being committed for several of the projects... is that on purpose? Not sure what benefit that provides, but possibly could be an issue since it contains a mapping of network IDs to contract addresses which wouldn't work for readers. It also leaks a bit of info about the user's local environment, but that can be stripped out harmlessly, I believe, if the build artifacts are needed.

wbnns · 2020-06-09T20:16:05Z

@adrianmcli

what's the timeline on having everything converted to 0.6 so we can test things out and finalize this edition of the book?

Hello. I think late summer / early fall might be the earliest, most realistic estimate.

adrianmcli · 2020-06-09T20:55:44Z

@chanhosuh agreed, those can definitely be gitignored.

HAOYUatHZ · 2020-06-09T22:50:16Z

#962 is kind of ready.

If anyone can review it will be the best!

wbnns · 2021-03-10T13:39:33Z

#962 is merged, sorry for the delay!

mshearer0 · 2022-03-01T20:13:05Z

Please see #1119

This was referenced Apr 4, 2020

Ganache Misc References #958

Merged

Ganache Code References #959

Merged

Ganache Text References #960

Merged

adrianmcli mentioned this issue Apr 4, 2020

Truffle Text References #961

Merged

wbnns added this to the Second Edition milestone Mar 11, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Reviewing and updating Truffle-related references and code #955

Reviewing and updating Truffle-related references and code #955

wbnns commented Mar 13, 2020

adrianmcli commented Mar 15, 2020 •

edited

adrianmcli commented Mar 15, 2020

wbnns commented Mar 16, 2020

adrianmcli commented Mar 16, 2020

wbnns commented Mar 16, 2020

adrianmcli commented Apr 4, 2020 •

edited

adrianmcli commented Apr 4, 2020

wbnns commented Apr 8, 2020 •

edited

adrianmcli commented Apr 8, 2020

adrianmcli commented May 8, 2020

wbnns commented May 9, 2020

adrianmcli commented May 9, 2020

chanhosuh commented Jun 9, 2020

adrianmcli commented Jun 9, 2020

chanhosuh commented Jun 9, 2020

wbnns commented Jun 9, 2020

adrianmcli commented Jun 9, 2020

HAOYUatHZ commented Jun 9, 2020

wbnns commented Mar 10, 2021

mshearer0 commented Mar 1, 2022

Reviewing and updating Truffle-related references and code #955

Reviewing and updating Truffle-related references and code #955

Comments

wbnns commented Mar 13, 2020

adrianmcli commented Mar 15, 2020 • edited

Files Breakdown

Ganache

Truffle

adrianmcli commented Mar 15, 2020

wbnns commented Mar 16, 2020

adrianmcli commented Mar 16, 2020

wbnns commented Mar 16, 2020

adrianmcli commented Apr 4, 2020 • edited

Ganache

adrianmcli commented Apr 4, 2020

wbnns commented Apr 8, 2020 • edited

adrianmcli commented Apr 8, 2020

adrianmcli commented May 8, 2020

wbnns commented May 9, 2020

adrianmcli commented May 9, 2020

chanhosuh commented Jun 9, 2020

adrianmcli commented Jun 9, 2020

chanhosuh commented Jun 9, 2020

wbnns commented Jun 9, 2020

adrianmcli commented Jun 9, 2020

HAOYUatHZ commented Jun 9, 2020

wbnns commented Mar 10, 2021

mshearer0 commented Mar 1, 2022

adrianmcli commented Mar 15, 2020 •

edited

adrianmcli commented Apr 4, 2020 •

edited

wbnns commented Apr 8, 2020 •

edited