How to find which Assert in PyTEAL code failed?

ismax · June 5, 2022, 2:40pm

Hello,
When developing an app using PyTEAL Assert we very often have errors like :

algosdk.error.AlgodHTTPError: TransactionPool.Remember: transaction WVSGUZXHIOZ4XLI6ZBLN2URJHKEKJB6EQHY2Y5GASWEMPLZ335VA: logic eval error: assert failed pc=303. Details: pc=303, opcodes===

Is there an easy way to know which Assert in my PyTEAL code failed ?

Would it be possible to improve debugging by allowing to pass an integer id when we call Assert so that the algod error displays the id and we directly know which assert failed ?

Maugli · June 7, 2022, 8:23am

Or to have a utility witch lists the pc, the compiled bytes and the teal source together? Then pc=303 could be located quite easily…

I mean a list like this:

-PC- -BYTE CODE-
0000 06							        #pragma version 6
0001 20 02 00 01					        intcblock 0 1
0005 26 01 0f 5f
0009 5f 61 70 70
0013 5f 63 72 65
0017 61 74 6f 72
0021 5f 5f						        bytecblock 0x5f5f6170705f63726561746f725f5f		// "__app_creator__"
0023 31 18							txn ApplicationID
0025 22								intc_0 // 0
0026 12								==
0027 40 00 F5    						bnz label1
0030 31 19							txn OnCompletion
0032 22								intc_0 // 0
0033 12								==
0034 40 00 30   						bnz label2
0037 31 19							txn OnCompletion
0039 81 05							pushint 5
0041 12								==
...

It could be easily done using the goal clerk -D option for .teal.tok, and using the bytes of the teal.tok file.

ismax · June 7, 2022, 9:28am

And then how do I find the line responsible in my PyTeal code ?

Maugli · June 7, 2022, 10:30am

Well, a good question. You can approximately map the compiled code to the pyteal. Or, store values (“pseudo line numbers”) in a pyteal scratch var. Or push and pop an Int before the assert.

ismax · June 23, 2022, 7:51pm

For reference, I found :

github.com/algorand/go-algorand

Source mapping: PC->TEAL map

opened 07:10PM - 07 Mar 22 UTC

closed 01:57PM - 04 May 22 UTC

algochoi

new-feature-request Team Scytale

## Problem Developers currently have trouble mapping PC values to TEAL. A com…mon use case is trying to see which assert in a TEAL program failed from a particular PC. We would like to create a standardized format to show this mapping using the [Javascript standard](https://docs.google.com/document/d/1U1RGAehQwRypUTovF1KRlpiOFze0b-_2gc6fAH0KY0k/edit?hl=en_US&pli=1&pli=1). ## Solution Create a subcommand/flag for the `goal clerk compile` command that will generate a JSON of the source map. ``` { "version" : 3, "file": "lines.dis", "sourceRoot": "", "sources": ["foo.teal", "bar.teal"], "names": ["src", "maps", "are", "fun"], "mappings": "AACA;AACA;AACA;;AACA" } ``` The format of the JSON should match the Javascript standard noted above, but for this ticket, we should only really be concerned with the `sources` field and the `mappings` field. The mapping is done in base64 VLQ encoding, and there is an implementation in the tealdbg that [converts integers to VLQ](https://github.com/algorand/go-algorand/blob/d3dc437d58fedd750d09e33f674e931ce2df759c/cmd/tealdbg/util.go#L107). There is a [PR](https://github.com/algorand/go-algorand/pull/3322) by @barnjamin that does a lot of the heavy lifting for this proposed solution, and can be used to convert the output into the standard above. It would also be nice if this was supported in the REST endpoint as well with an optional parameter, e.g. `?map=true`, but this could be a subject of a later ticket. It would also be nice to tackle this issue as well, since there seems to be high community interest: https://github.com/algorand/go-algorand/issues/1654 ### Example `myprog.teal` ``` #pragma version 5 int 3 byte 0x03 btoi == assert int 10 byte 0x10 btoi == assert ``` `myprog.teal.map.json` ``` { "source_name":"myprog.teal", "mapping":";2;;3;;;4;5;6;8;;9;;;10;11;12" } ``` The code used to generate this is in this PR branch: https://github.com/algorand/go-algorand/pull/3726 The source map is generated by passing the `-m` flag to `goal clerk compile`. Example decoder here: https://github.com/algochoi/teal-sourcemap-decoder/tree/examples ``` #pragma version 5 int 3 // PC: 1 byte 0x03 // PC: 3 btoi // PC: 6 == // PC: 7 assert // PC: 8 int 10 // PC: 9 byte 0x10 // PC: 11 btoi // PC: 14 == // PC: 15 assert // PC: 16 ``` ## Dependencies None ## Urgency Medium

ismax · June 23, 2022, 8:53pm

@Maugli or @fabrice
I saw it is possible to get the source map by passing the -m flag to goal clerk compile (here) but is it possible to get it with the Python SDK i.e. by passing a parameter to algod_client.compile(source_code) ?

fabrice · June 23, 2022, 9:13pm

It is supported in the REST endpoint but looks like the SDK do not support it yet:

github.com

algorand/go-algorand/blob/v3.7.2-stable/daemon/algod/api/algod.oas2.json#L1401


      
              "description": "TEAL source code to be compiled",
              "name": "source",
              "in": "body",
              "required": true,
              "schema": {
                "type": "string",
                "format": "binary"
              }
            }, 
            {
              "name": "sourcemap",
              "description": "When set to `true`, returns the source map of the program as a JSON. Defaults to `false`.",
              "in": "query",
              "type": "boolean"
            }
          ],
          "responses": {
            "200": {
              "description": "Successful compilation",
              "$ref": "#/responses/CompileResponse"
            },

ismax · July 11, 2022, 12:08pm

I tried using Postman to test the retrieval of the source map and I have the same response (200 OK) with those 3 URLs :

The response is a json with only 2 keys : hash and result

Algod version of the purestake node is 3.8.1

So I don’t know how to get the source map of my smart contract (useful to debug assert errors).

fabrice · July 11, 2022, 7:30pm

Can you try with this API service API or that one https://algoexplorer.io/api-dev/v2 ?

ismax · July 12, 2022, 3:24pm

Thanks a lot @fabrice !! It works with both algoexplorer and algonode.

Strange that Purestake is not compatible yet despite having up to date node.

Tim · July 12, 2022, 8:51pm

This has been updated for PureStake in BetaNet and TestNet, MainNet will follow tomorrow.

Topic		Replies	Views
How to find error line number in PyTEAL/TEAL? (developer experience) General teal , smart-contracts	1	336	September 21, 2021
AlgodHTTPError from smart contract call AlgoSDK	1	683	March 16, 2022
PyTeal opcodes cost (Asserts vs And) General teal , smart-contracts	2	645	April 8, 2022
Sending signed ApplicationCreateTxn using algod client output an AlgodHTTPError AlgoSDK teal , smart-contracts	4	545	November 9, 2021
Logic eval error: invalid ApplicationArgs index 2 but I don't have 3 args	3	720	November 23, 2021

How to find which Assert in PyTEAL code failed?

Related topics