Dryrun response

[barnjamin]

API should look something like:

    group = atc.gather_signatures()
    drr = create_dryrun(client, group)
    dr = DryrunResponse(client.dryrun(drr))
    for txn in dr.txns:
        print(txn.app_trace())

and output

#pragma version 6       []
intcblock 1 0 10        []
bytecblock 0xd87699ef   []
txn ApplicationID       [57]
intc_1 // 0             [57, 0]
==                      [0]
bnz label1              []
txn OnCompletion        [0]
pushint 5               [0, 5]
==                      [0]
bnz label2              []
txn OnCompletion        [0]
pushint 4               [0, 4]
...

[tzaffi]

Looks very useful.

I have a couple of suggestions to shorten the code, and some nit-picks that aren't as crucial.

A general question that we should bring up at standup as well: How do we feel about SDK's getting out of sync? I don't believe that this sort of helper functionality exists in any of the other SDK's, and is that ok? I think it should be ok. We may need to signal that this is special to python by having it live in a directory such as extras or goodies ...

[barnjamin]

@tzaffi thanks for the review!

I don't believe that this sort of helper functionality exists in any of the other SDK's, and is that ok?

I expect to add it to the rest of them. I like using python as a testing ground for these to see if it makes sense and find a good pattern.

[tzaffi]

LGTM

[jasonpaulos]

Looks like a nice improvement, though it would be great if there were at least one unit test.

The code seems very testable, since it does not rely on any REST API calls

[ahangsu]

looks pretty neat to me (not sure if we want to ensure fields in DryrunTraceLine or DryrunStackValue), waiting on the test cases

[barnjamin]

Before merging, I want to raise a few more things that may be useful to include.

1. Some indication in the trace for where the issue originated. Often when looking at a trace I try to find the first line the 0 that fails the program is put on the stack. If we can do that automatically and add a <-- This line G, it might help.
2. Parsing out the deltas for each Transaction result. At the moment we don't have anything that does this automatically to b64 decode keys/values.
3. A trivial succeeded type method on the Transaction result that can inspect the app-call-messages or logic-sig-messages for the relevant PASS or REJECT
4. At the moment the disassembly is ambiguous and if an app call is signed by logic, the app call disassembly will be returned DryrunTransactionResult disassembly field ambiguous go-algorand#3563

[barnjamin]

I changed the formatting a bit, to add line number, unquote stack values/convert to hex for bytes, and if 0 is passed for spaces use the longest line length.

Curious to hear thoughts on this format instead

30  | store 0                                                                                             [99]
32  | load 0                                                                                              []
33  | pushint 97                                                                                          [99]
34  | >                                                                                                   [99, 97]
35  | bnz label7                                                                                          [1]
39  | load 0                                                                                              []
40  | callsub label8                                                                                      [99]
109 | store 1                                                                                             [99]
110 | load 1                                                                                              []
111 | callsub label14                                                                                     [99]
75  | store 2                                                                                             [99]
76  | load 2                                                                                              []
77  | intc_1 // 0                                                                                         [99]
78  | ==                                                                                                  [99, 0]
79  | bnz label10                                                                                         [0]
80  | load 2                                                                                              []
81  | intc_2 // 10                                                                                        [99]
82  | /                                                                                                   [99, 10]
83  | intc_1 // 0                                                                                         [9]
84  | >                                                                                                   [9, 0]
85  | bnz label11                                                                                         [1]

[jasonpaulos]

Question for @jasonpaulos . This PR (and #298 as well) adds a new package dependency tabulate. Should this be added to our setup.py here?

py-algorand-sdk/setup.py

Line 19 in 7c0b8a4

install_requires=["pynacl", "pycryptodomex>=3.6.0", "msgpack"],

Yes, @barnjamin did this correctly in 8ded7ec

[tzaffi]

LGTM again