search

Agoric / documentation

User documentation
https://agoric.com/documentation/
Apache License 2.0
15 stars 38 forks source link

Docs Revamp - Debugging - writeup #963

Open sufyaankhan opened 5 months ago

sufyaankhan commented 5 months ago

4 Core Debugging Needs of Developers

1. Debugger for Getting Started

1.1 Agoric SDK installation - debug commands

1.2 Local Chain setup - debug commands

Tools:

2. Debugger for JavaScript Smart Contract Code

As a Smart Contract developer, when I am working in my Project, I need a way to debug my javascript code.

2.1 AVA (for Unit Testing)

AVA is a test runner for Node.js with a concise API, detailed error output and process isolation.

  1. Debugger for my Smart Contract deployment

4. Debugger for my Smart Contract transactions

dckc commented 4 months ago

TRACK_TURNS came to the rescue recently

dckc commented 3 months ago

1.1 Agoric SDK installation - debug commands

I'm not sure what that refers to.

SDK installation is yarn create @agoric/dapp demo. We don't offer any debug commands for that.

We have a "Troubleshooting yarn install" box, but it just says to check platform requirements.

1.2 Local Chain setup - debug commands

We document yarn docker:logs under Starting a Local Agoric Blockchain

Tools:

  • Agoric CLI - Debug capabilities

??? I'm not sure what that refers to.

  • Verbose logging - Verbose logs can possibly help in identifying errors

$DEBUG, $TRACK_TURNS, and $LOCKDOWN_OPTIONS are now linked (briefly) from smart contract basics and eventual send.

2. Debugger for JavaScript Smart Contract Code

As a Smart Contract developer, when I am working in my Project, I need a way to debug my javascript code.

I went over that with @kbennett2000 and we recorded it, but I don't think we have published anything about it.

2.1 AVA (for Unit Testing)

AVA is a test runner for Node.js with a concise API, detailed error output and process isolation.

  • Ideal for unit test your Smart Contract code during early development

Unit testing with ava is discussed in Smart Contract Basics and Contract Walkthru.

  1. Debugger for my Smart Contract deployment

I'm not sure what that would mean. I don't think we have anything like that.

4. Debugger for my Smart Contract transactions

Again, I'm not sure what that would mean. I don't think we have anything like that.

dckc commented 2 months ago

2. Debugger for JavaScript Smart Contract Code

As a Smart Contract developer, when I am working in my Project, I need a way to debug my javascript code.

I went over that with @kbennett2000 and we recorded it, but I don't think we have published anything about it.

we did a public version of the discussion in

I started making a couple video excerpts.