Merge pull request #479 from algorandfoundation/feat/arc56_errors

feat: arc56 error messages

examples/amm/tealscript_artifacts/ConstantProductAMM.approval.teal

@@ -19,6 +19,7 @@ txn OnCompletion
 switch *call_NoOp *NOT_IMPLEMENTED *NOT_IMPLEMENTED *NOT_IMPLEMENTED *NOT_IMPLEMENTED *NOT_IMPLEMENTED *create_NoOp *NOT_IMPLEMENTED *NOT_IMPLEMENTED *NOT_IMPLEMENTED *NOT_IMPLEMENTED *NOT_IMPLEMENTED
 
 *NOT_IMPLEMENTED:
+	// The requested action is not implemented in this contract. Are you using the correct OnComplete? Did you set your app ID?
 	err
 
 // createApplication()void
@@ -186,6 +187,8 @@ tokensToMint:
 	pop
 	swap
 	!
+
+	// wideRatio failed
 	assert
 	frame_bury 0 // aRatio: uint64
 
@@ -201,6 +204,8 @@ tokensToMint:
 	pop
 	swap
 	!
+
+	// wideRatio failed
 	assert
 	frame_bury 1 // bRatio: uint64
 
@@ -231,6 +236,8 @@ tokensToMint:
 	pop
 	swap
 	!
+
+	// wideRatio failed
 	assert
 
 	// set the subroutine return value
@@ -267,6 +274,8 @@ computeRatio:
 	pop
 	swap
 	!
+
+	// wideRatio failed
 	assert
 	retsub
 
@@ -286,6 +295,8 @@ tokensToBurn:
 	pop
 	swap
 	!
+
+	// wideRatio failed
 	assert
 	retsub
 
@@ -328,6 +339,8 @@ tokensToSwap:
 	pop
 	swap
 	!
+
+	// wideRatio failed
 	assert
 
 	// set the subroutine return value
@@ -342,6 +355,8 @@ tokensToSwap:
 	len
 	int 32
 	==
+
+	// argument 0 (governor) for set_governor must be a address
 	assert
 
 	// execute set_governor(address)void
@@ -360,6 +375,8 @@ set_governor:
 	byte 0x67 // "g"
 	app_global_get
 	==
+
+	// transaction verification failed: {"txn":"this.txn","field":"sender","expected":"this.governor.value"}
 	assert
 
 	// examples/amm/amm.algo.ts:79
@@ -390,6 +407,8 @@ set_governor:
 	gtxns TypeEnum
 	int pay
 	==
+
+	// argument 2 (seed) for bootstrap must be a pay transaction
 	assert
 
 	// execute bootstrap(pay,uint64,uint64)uint64
@@ -411,6 +430,8 @@ bootstrap:
 	byte 0x67 // "g"
 	app_global_get
 	==
+
+	// transaction verification failed: {"txn":"this.txn","field":"sender","expected":"this.governor.value"}
 	assert
 
 	// examples/amm/amm.algo.ts:85
@@ -427,13 +448,17 @@ bootstrap:
 	gtxns Receiver
 	global CurrentApplicationAddress
 	==
+
+	// transaction verification failed: {"txn":"seed","field":"receiver","expected":"this.app.address"}
 	assert
 
 	// verify amount
 	frame_dig -1 // seed: PayTxn
 	gtxns Amount
 	int 300_000
 	>=
+
+	// transaction verification failed: {"txn":"seed","field":"amount","condition":"greaterThanEqualTo","expected":">=300_000"}
 	assert
 
 	// examples/amm/amm.algo.ts:88
@@ -501,6 +526,8 @@ bootstrap:
 	gtxns TypeEnum
 	int axfer
 	==
+
+	// argument 3 (bXfer) for mint must be a axfer transaction
 	assert
 
 	// aXfer: axfer
@@ -511,6 +538,8 @@ bootstrap:
 	gtxns TypeEnum
 	int axfer
 	==
+
+	// argument 4 (aXfer) for mint must be a axfer transaction
 	assert
 
 	// execute mint(axfer,axfer,uint64,uint64,uint64)void
@@ -563,27 +592,35 @@ mint:
 	gtxns Sender
 	txn Sender
 	==
+
+	// transaction verification failed: {"txn":"aXfer","field":"sender","expected":"this.txn.sender"}
 	assert
 
 	// verify assetAmount
 	frame_dig -1 // aXfer: AssetTransferTxn
 	gtxns AssetAmount
 	int 0
 	>
+
+	// transaction verification failed: {"txn":"aXfer","field":"assetAmount","condition":"greaterThan","expected":">0"}
 	assert
 
 	// verify assetReceiver
 	frame_dig -1 // aXfer: AssetTransferTxn
 	gtxns AssetReceiver
 	global CurrentApplicationAddress
 	==
+
+	// transaction verification failed: {"txn":"aXfer","field":"assetReceiver","expected":"this.app.address"}
 	assert
 
 	// verify xferAsset
 	frame_dig -1 // aXfer: AssetTransferTxn
 	gtxns XferAsset
 	frame_dig -4 // aAsset: AssetID
 	==
+
+	// transaction verification failed: {"txn":"aXfer","field":"xferAsset","expected":"aAsset"}
 	assert
 
 	// valid asset B axfer
@@ -599,27 +636,35 @@ mint:
 	gtxns Sender
 	txn Sender
 	==
+
+	// transaction verification failed: {"txn":"bXfer","field":"sender","expected":"this.txn.sender"}
 	assert
 
 	// verify assetAmount
 	frame_dig -2 // bXfer: AssetTransferTxn
 	gtxns AssetAmount
 	int 0
 	>
+
+	// transaction verification failed: {"txn":"bXfer","field":"assetAmount","condition":"greaterThan","expected":">0"}
 	assert
 
 	// verify assetReceiver
 	frame_dig -2 // bXfer: AssetTransferTxn
 	gtxns AssetReceiver
 	global CurrentApplicationAddress
 	==
+
+	// transaction verification failed: {"txn":"bXfer","field":"assetReceiver","expected":"this.app.address"}
 	assert
 
 	// verify xferAsset
 	frame_dig -2 // bXfer: AssetTransferTxn
 	gtxns XferAsset
 	frame_dig -5 // bAsset: AssetID
 	==
+
+	// transaction verification failed: {"txn":"bXfer","field":"xferAsset","expected":"bAsset"}
 	assert
 
 	// *if0_condition
@@ -732,6 +777,8 @@ mint:
 	gtxns TypeEnum
 	int axfer
 	==
+
+	// argument 3 (poolXfer) for burn must be a axfer transaction
 	assert
 
 	// execute burn(axfer,uint64,uint64,uint64)void
@@ -785,27 +832,35 @@ burn:
 	gtxns Sender
 	txn Sender
 	==
+
+	// transaction verification failed: {"txn":"poolXfer","field":"sender","expected":"this.txn.sender"}
 	assert
 
 	// verify assetAmount
 	frame_dig -1 // poolXfer: AssetTransferTxn
 	gtxns AssetAmount
 	int 0
 	>
+
+	// transaction verification failed: {"txn":"poolXfer","field":"assetAmount","condition":"greaterThan","expected":">0"}
 	assert
 
 	// verify assetReceiver
 	frame_dig -1 // poolXfer: AssetTransferTxn
 	gtxns AssetReceiver
 	global CurrentApplicationAddress
 	==
+
+	// transaction verification failed: {"txn":"poolXfer","field":"assetReceiver","expected":"this.app.address"}
 	assert
 
 	// verify xferAsset
 	frame_dig -1 // poolXfer: AssetTransferTxn
 	gtxns XferAsset
 	frame_dig -2 // poolAsset: AssetID
 	==
+
+	// transaction verification failed: {"txn":"poolXfer","field":"xferAsset","expected":"poolAsset"}
 	assert
 
 	// examples/amm/amm.algo.ts:156
@@ -884,6 +939,8 @@ burn:
 	gtxns TypeEnum
 	int axfer
 	==
+
+	// argument 2 (swapXfer) for swap must be a axfer transaction
 	assert
 
 	// execute swap(axfer,uint64,uint64)void
@@ -928,20 +985,26 @@ swap:
 	gtxns AssetAmount
 	int 0
 	>
+
+	// transaction verification failed: {"txn":"swapXfer","field":"assetAmount","condition":"greaterThan","expected":">0"}
 	assert
 
 	// verify assetReceiver
 	frame_dig -1 // swapXfer: AssetTransferTxn
 	gtxns AssetReceiver
 	global CurrentApplicationAddress
 	==
+
+	// transaction verification failed: {"txn":"swapXfer","field":"assetReceiver","expected":"this.app.address"}
 	assert
 
 	// verify sender
 	frame_dig -1 // swapXfer: AssetTransferTxn
 	gtxns Sender
 	txn Sender
 	==
+
+	// transaction verification failed: {"txn":"swapXfer","field":"sender","expected":"this.txn.sender"}
 	assert
 
 	// verify xferAsset
@@ -954,6 +1017,8 @@ swap:
 	frame_dig -3 // bAsset: AssetID
 	==
 	||
+
+	// transaction verification failed: {"txn":{"txnText":"swapXfer"},"field":"xferAsset","condition":"includedIn","expected":"[aAsset, bAsset]"}
 	assert
 
 	// examples/amm/amm.algo.ts:180
@@ -1025,6 +1090,8 @@ swap:
 	method "createApplication()void"
 	txna ApplicationArgs 0
 	match *abi_route_createApplication
+
+	// this contract does not implement the given ABI method for create NoOp
 	err
 
 *call_NoOp:
@@ -1035,4 +1102,6 @@ swap:
 	method "swap(axfer,uint64,uint64)void"
 	txna ApplicationArgs 0
 	match *abi_route_set_governor *abi_route_bootstrap *abi_route_mint *abi_route_burn *abi_route_swap
+
+	// this contract does not implement the given ABI method for call NoOp
 	err