Update "Debugging a smart contract" guide #1112

its-everdred · 2021-12-14T19:53:07Z

Problem

The Debugging a smart contract guide is outdated: #1077

Solution

Updated all solc versions to latest.
Updated all console outputs to reflect the updated responses.
Commented out the infinite loop example until the relevant issue is resolved.

its-everdred · 2021-12-14T19:55:15Z

This is branched off of #1106 so until that is merged, this branch will include those changes as well. Set it to blocked for now.

fainashalts

Had a couple of minor suggestions, and I also noticed some remnants from a merge conflict that I noted. Looks good otherwise, just request my re-review when changes are addressed. Thanks! 🎉

src/docs/truffle/reference/truffle-commands.md

src/guides/data.json

src/guides/debugging-an-example-smart-contract/index.md

fainashalts · 2021-12-15T04:18:08Z

src/guides/debugging-an-example-smart-contract/index.md

+     })
+     .then(function (value) {
+       return value.toNumber();
+     });
   ```

   This command looks at the SimpleStorage contract, and then calls the `get()` function as defined inside it. It then returns the output, which is usually rendered as a string, and converts it to a number:

   ```javascript


Suggested change

```javascript

Did you mean to delete only the open tag here? I believe commiting this while leaving the closing ``` would turn the rest of the document into a code block.

src/guides/debugging-an-example-smart-contract/index.md

fainashalts · 2021-12-15T04:18:56Z

src/guides/debugging-an-example-smart-contract/index.md

+     })
+     .then(function (value) {
+       return value.toNumber();
+     });
   ```

   The output should look like this:

   ```javascript


Suggested change

```javascript

Did you mean to delete only the open tag here? I believe commiting this while leaving the closing ``` would turn the rest of the document into a code block.

Whoops! I meant to just delete the javascript tag. :)

src/guides/debugging-an-example-smart-contract/index.md

fainashalts · 2021-12-15T04:21:14Z

src/guides/debugging-an-example-smart-contract/index.md

   ```

   **It is this last event that is triggering the error.** You can see that it is the `assert()` that is to blame.

+<<<<<<< HEAD:src/guides/debugging-an-example-smart-contract.md


I think this is leftover from a merge conflict. I may have missed other parts of this so its probably worth going over it again to see!

Ohhh thank you!

fainashalts · 2021-12-15T04:25:27Z

src/guides/debugging-an-example-smart-contract/index.md


 ### Issue #3: A function isn't operating as desired

+> > > > > > > origin/update-debugging-your-contracts:src/guides/debugging-an-example-smart-contract/index.md


This part too, I assume!

oh wow, where did these merge conflicts come from? Was it from the transition from old to new website?

Ah, perhaps. I'm wondering if I forgot to pull. When I started this, the guides were individual files with no sub-directories, ex: "src/guides/debugging-a-smart-contract.md"

Hrm, would you mind doing a rebase instead? Would be happy to help out

leeftk · 2021-12-15T18:18:05Z

src/guides/debugging-an-example-smart-contract/index.md

   ```

   **The problem is revealed.** The conditional is leading to the wrong event.

-
 ## Conclusion

 With the ability to debug your contracts directly within Truffle, you have even more power at your hands to make your smart contracts rock-solid and ready to deploy. Make sure to read more about Truffle Develop console and the debugger in the docs. If you have any questions, please join our [community Gitter channel](https://gitter.im/ConsenSys/truffle) where hundreds of fellow Trufflers congregate to answer your questions!


I'm thinking we could remove the part about heading over to our Gitter and recommend people open an issue on Github if they have any questions. Thoughts?

Yeah, I like this point, agreed!

leeftk · 2021-12-15T18:25:55Z

src/docs/truffle/reference/truffle-commands.md

@@ -144,13 +135,11 @@ If you want an interactive console but want to use an existing blockchain, use `

 See the [Using the console](/docs/getting_started/console) section for more details.


Not sure if this link works. May just be that I can't find it but when I try going to it I get a 404.

Oh, good catch, I'm going to replace it with this one: https://trufflesuite.com/docs/truffle/getting-started/using-truffle-develop-and-the-console.html

leeftk · 2021-12-15T18:26:03Z

src/docs/truffle/reference/truffle-commands.md

 Option:

-* `--log`: Start/Connect to a Truffle develop session and log all RPC activity.
-See the [Log RPC Activity](docs/getting_started/console#log-rpc-activity)


Same as above.

going to replace it with this one: https://trufflesuite.com/docs/truffle/getting-started/using-truffle-develop-and-the-console.html#log-rpc-activity

leeftk · 2021-12-15T18:26:12Z

src/docs/truffle/reference/truffle-commands.md

-* `<package_name>`: Name of the package as listed in the Ethereum Package Registry. (required)
-* `@<version>`: When specified, will install a specific version of the package, otherwise will install the latest version.
+- `<package_name>`: Name of the package as listed in the Ethereum Package Registry. (required)
+- `@<version>`: When specified, will install a specific version of the package, otherwise will install the latest version.

 See the [Package Management with EthPM](/docs/getting_started/packages-ethpm) section for more details.


Same as above.

Thanks! Going to replace with: https://trufflesuite.com/docs/truffle/getting-started/package-management-via-ethpm.html

Co-authored-by: Faina Shalts <[email protected]> Update capitalization Co-authored-by: Faina Shalts <[email protected]> Update capitalization Co-authored-by: Faina Shalts <[email protected]> update broken links Remove space Pointed to github instead of gitter

fainashalts suggested changes Dec 15, 2021

View reviewed changes

leeftk reviewed Dec 15, 2021

View reviewed changes

its-everdred requested a review from fainashalts December 15, 2021 22:36

its-everdred added 11 commits December 16, 2021 15:47

Update debugging guide and tutorial names

a84b270

Bump default solidity version

74fc7ee

Bump solc version

d9de7ac

Fix typo

c14b758

Fix migration output

78fe6a7

update the transaction output

1e8cc34

Update event debugging example

33fa647

Remove infinite loop example until issue is resolved

01791dc

Update assertion example

c229c30

Add issue to resolve infinite loop

02435dc

its-everdred force-pushed the fix-debugging-guide branch from 956bc9b to ecec85c Compare December 16, 2021 20:54

its-everdred added 2 commits December 16, 2021 15:57

Remove unnecessary file

43d2184

.

80ac0b3

fainashalts approved these changes Dec 17, 2021

View reviewed changes

its-everdred merged commit 4ac87d7 into main Dec 17, 2021

its-everdred deleted the fix-debugging-guide branch December 17, 2021 20:36

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update "Debugging a smart contract" guide #1112

Update "Debugging a smart contract" guide #1112

its-everdred commented Dec 14, 2021 •

edited

Loading

its-everdred commented Dec 14, 2021

fainashalts left a comment

fainashalts Dec 15, 2021

its-everdred Dec 15, 2021 •

edited

Loading

fainashalts Dec 15, 2021

its-everdred Dec 15, 2021 •

edited

Loading

fainashalts Dec 17, 2021

fainashalts Dec 15, 2021

its-everdred Dec 15, 2021

fainashalts Dec 15, 2021

cds-amal Dec 15, 2021

its-everdred Dec 15, 2021

cds-amal Dec 16, 2021

leeftk Dec 15, 2021

its-everdred Dec 15, 2021

leeftk Dec 15, 2021

its-everdred Dec 15, 2021

leeftk Dec 15, 2021

its-everdred Dec 15, 2021 •

edited

Loading

leeftk Dec 15, 2021

its-everdred Dec 15, 2021


		### Issue #3: A function isn't operating as desired

		> > > > > > > origin/update-debugging-your-contracts:src/guides/debugging-an-example-smart-contract/index.md

		@@ -144,13 +135,11 @@ If you want an interactive console but want to use an existing blockchain, use `

		See the [Using the console](/docs/getting_started/console) section for more details.

Update "Debugging a smart contract" guide #1112

Update "Debugging a smart contract" guide #1112

Conversation

its-everdred commented Dec 14, 2021 • edited Loading

Problem

Solution

its-everdred commented Dec 14, 2021

fainashalts left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

its-everdred Dec 15, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

its-everdred Dec 15, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

its-everdred Dec 15, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

its-everdred commented Dec 14, 2021 •

edited

Loading

its-everdred Dec 15, 2021 •

edited

Loading

its-everdred Dec 15, 2021 •

edited

Loading

its-everdred Dec 15, 2021 •

edited

Loading