Merge pull request #5 from algorandfoundation/control-flow

added control flow code examples
algorandfoundation · Nov 22, 2024 · f2d9894 · f2d9894
2 parents 65be1bf + 85c9fc2
commit f2d9894
Show file tree

Hide file tree

Showing 19 changed files with 3,043 additions and 0 deletions.
diff --git a/...on-contract-examples/smart_contracts/artifacts/control_flow/ForLoopsExample.approval.teal b/...on-contract-examples/smart_contracts/artifacts/control_flow/ForLoopsExample.approval.teal
@@ -0,0 +1,111 @@
+#pragma version 10
+
+smart_contracts.control_flow.contract.ForLoopsExample.approval_program:
+    callsub __puya_arc4_router__
+    return
+
+
+// smart_contracts.control_flow.contract.ForLoopsExample.__puya_arc4_router__() -> uint64:
+__puya_arc4_router__:
+    proto 0 1
+    txn NumAppArgs
+    bz __puya_arc4_router___bare_routing@5
+    method "for_loop()uint8[4]"
+    txna ApplicationArgs 0
+    match __puya_arc4_router___for_loop_route@2
+    int 0
+    retsub
+
+__puya_arc4_router___for_loop_route@2:
+    txn OnCompletion
+    !
+    assert // OnCompletion is NoOp
+    txn ApplicationID
+    assert // is not creating
+    callsub for_loop
+    byte 0x151f7c75
+    swap
+    concat
+    log
+    int 1
+    retsub
+
+__puya_arc4_router___bare_routing@5:
+    txn OnCompletion
+    bnz __puya_arc4_router___after_if_else@9
+    txn ApplicationID
+    !
+    assert // is creating
+    int 1
+    retsub
+
+__puya_arc4_router___after_if_else@9:
+    int 0
+    retsub
+
+
+// smart_contracts.control_flow.contract.ForLoopsExample.for_loop() -> bytes:
+for_loop:
+    proto 0 1
+    byte ""
+    byte 0x00000000
+    int 3
+    int 0
+
+for_loop_for_body@2:
+    frame_dig 2
+    dup
+    itob
+    extract 7 1
+    frame_dig 3
+    dup
+    int 4
+    <
+    assert // Index access is out of bounds
+    frame_dig 1
+    swap
+    uncover 2
+    replace3
+    frame_bury 1
+    bz for_loop_after_for@5
+    frame_dig 2
+    int 1
+    -
+    frame_bury 2
+    frame_dig 3
+    int 1
+    +
+    frame_bury 3
+    b for_loop_for_body@2
+
+for_loop_after_for@5:
+    int 0
+    frame_bury 3
+
+for_loop_for_header@6:
+    frame_dig 3
+    int 4
+    <
+    dup
+    frame_bury 0
+    bz for_loop_after_for@9
+    frame_dig 3
+    dup
+    itob
+    extract 7 1
+    frame_dig 0
+    assert // Index access is out of bounds
+    frame_dig 1
+    dig 2
+    uncover 2
+    replace3
+    frame_bury 1
+    int 1
+    +
+    frame_bury 3
+    b for_loop_for_header@6
+
+for_loop_after_for@9:
+    frame_dig 1
+    frame_bury 0
+    retsub
diff --git a/...ython-contract-examples/smart_contracts/artifacts/control_flow/ForLoopsExample.arc32.json b/...ython-contract-examples/smart_contracts/artifacts/control_flow/ForLoopsExample.arc32.json
@@ -0,0 +1,50 @@
+{
+    "hints": {
+        "for_loop()uint8[4]": {
+            "call_config": {
+                "no_op": "CALL"
+            }
+        }
+    },
+    "source": {
+        "approval": "I3ByYWdtYSB2ZXJzaW9uIDEwCgpzbWFydF9jb250cmFjdHMuY29udHJvbF9mbG93LmNvbnRyYWN0LkZvckxvb3BzRXhhbXBsZS5hcHByb3ZhbF9wcm9ncmFtOgogICAgY2FsbHN1YiBfX3B1eWFfYXJjNF9yb3V0ZXJfXwogICAgcmV0dXJuCgoKLy8gc21hcnRfY29udHJhY3RzLmNvbnRyb2xfZmxvdy5jb250cmFjdC5Gb3JMb29wc0V4YW1wbGUuX19wdXlhX2FyYzRfcm91dGVyX18oKSAtPiB1aW50NjQ6Cl9fcHV5YV9hcmM0X3JvdXRlcl9fOgogICAgcHJvdG8gMCAxCiAgICB0eG4gTnVtQXBwQXJncwogICAgYnogX19wdXlhX2FyYzRfcm91dGVyX19fYmFyZV9yb3V0aW5nQDUKICAgIG1ldGhvZCAiZm9yX2xvb3AoKXVpbnQ4WzRdIgogICAgdHhuYSBBcHBsaWNhdGlvbkFyZ3MgMAogICAgbWF0Y2ggX19wdXlhX2FyYzRfcm91dGVyX19fZm9yX2xvb3Bfcm91dGVAMgogICAgaW50IDAKICAgIHJldHN1YgoKX19wdXlhX2FyYzRfcm91dGVyX19fZm9yX2xvb3Bfcm91dGVAMjoKICAgIHR4biBPbkNvbXBsZXRpb24KICAgICEKICAgIGFzc2VydCAvLyBPbkNvbXBsZXRpb24gaXMgTm9PcAogICAgdHhuIEFwcGxpY2F0aW9uSUQKICAgIGFzc2VydCAvLyBpcyBub3QgY3JlYXRpbmcKICAgIGNhbGxzdWIgZm9yX2xvb3AKICAgIGJ5dGUgMHgxNTFmN2M3NQogICAgc3dhcAogICAgY29uY2F0CiAgICBsb2cKICAgIGludCAxCiAgICByZXRzdWIKCl9fcHV5YV9hcmM0X3JvdXRlcl9fX2JhcmVfcm91dGluZ0A1OgogICAgdHhuIE9uQ29tcGxldGlvbgogICAgYm56IF9fcHV5YV9hcmM0X3JvdXRlcl9fX2FmdGVyX2lmX2Vsc2VAOQogICAgdHhuIEFwcGxpY2F0aW9uSUQKICAgICEKICAgIGFzc2VydCAvLyBpcyBjcmVhdGluZwogICAgaW50IDEKICAgIHJldHN1YgoKX19wdXlhX2FyYzRfcm91dGVyX19fYWZ0ZXJfaWZfZWxzZUA5OgogICAgaW50IDAKICAgIHJldHN1YgoKCi8vIHNtYXJ0X2NvbnRyYWN0cy5jb250cm9sX2Zsb3cuY29udHJhY3QuRm9yTG9vcHNFeGFtcGxlLmZvcl9sb29wKCkgLT4gYnl0ZXM6CmZvcl9sb29wOgogICAgcHJvdG8gMCAxCiAgICBieXRlICIiCiAgICBieXRlIDB4MDAwMDAwMDAKICAgIGludCAzCiAgICBpbnQgMAoKZm9yX2xvb3BfZm9yX2JvZHlAMjoKICAgIGZyYW1lX2RpZyAyCiAgICBkdXAKICAgIGl0b2IKICAgIGV4dHJhY3QgNyAxCiAgICBmcmFtZV9kaWcgMwogICAgZHVwCiAgICBpbnQgNAogICAgPAogICAgYXNzZXJ0IC8vIEluZGV4IGFjY2VzcyBpcyBvdXQgb2YgYm91bmRzCiAgICBmcmFtZV9kaWcgMQogICAgc3dhcAogICAgdW5jb3ZlciAyCiAgICByZXBsYWNlMwogICAgZnJhbWVfYnVyeSAxCiAgICBieiBmb3JfbG9vcF9hZnRlcl9mb3JANQogICAgZnJhbWVfZGlnIDIKICAgIGludCAxCiAgICAtCiAgICBmcmFtZV9idXJ5IDIKICAgIGZyYW1lX2RpZyAzCiAgICBpbnQgMQogICAgKwogICAgZnJhbWVfYnVyeSAzCiAgICBiIGZvcl9sb29wX2Zvcl9ib2R5QDIKCmZvcl9sb29wX2FmdGVyX2ZvckA1OgogICAgaW50IDAKICAgIGZyYW1lX2J1cnkgMwoKZm9yX2xvb3BfZm9yX2hlYWRlckA2OgogICAgZnJhbWVfZGlnIDMKICAgIGludCA0CiAgICA8CiAgICBkdXAKICAgIGZyYW1lX2J1cnkgMAogICAgYnogZm9yX2xvb3BfYWZ0ZXJfZm9yQDkKICAgIGZyYW1lX2RpZyAzCiAgICBkdXAKICAgIGl0b2IKICAgIGV4dHJhY3QgNyAxCiAgICBmcmFtZV9kaWcgMAogICAgYXNzZXJ0IC8vIEluZGV4IGFjY2VzcyBpcyBvdXQgb2YgYm91bmRzCiAgICBmcmFtZV9kaWcgMQogICAgZGlnIDIKICAgIHVuY292ZXIgMgogICAgcmVwbGFjZTMKICAgIGZyYW1lX2J1cnkgMQogICAgaW50IDEKICAgICsKICAgIGZyYW1lX2J1cnkgMwogICAgYiBmb3JfbG9vcF9mb3JfaGVhZGVyQDYKCmZvcl9sb29wX2FmdGVyX2ZvckA5OgogICAgZnJhbWVfZGlnIDEKICAgIGZyYW1lX2J1cnkgMAogICAgcmV0c3ViCg==",
+        "clear": "I3ByYWdtYSB2ZXJzaW9uIDEwCgpzbWFydF9jb250cmFjdHMuY29udHJvbF9mbG93LmNvbnRyYWN0LkZvckxvb3BzRXhhbXBsZS5jbGVhcl9zdGF0ZV9wcm9ncmFtOgogICAgaW50IDEKICAgIHJldHVybgo="
+    },
+    "state": {
+        "global": {
+            "num_byte_slices": 0,
+            "num_uints": 0
+        },
+        "local": {
+            "num_byte_slices": 0,
+            "num_uints": 0
+        }
+    },
+    "schema": {
+        "global": {
+            "declared": {},
+            "reserved": {}
+        },
+        "local": {
+            "declared": {},
+            "reserved": {}
+        }
+    },
+    "contract": {
+        "name": "ForLoopsExample",
+        "methods": [
+            {
+                "name": "for_loop",
+                "args": [],
+                "readonly": false,
+                "returns": {
+                    "type": "uint8[4]"
+                }
+            }
+        ],
+        "networks": {}
+    },
+    "bare_call_config": {
+        "no_op": "CREATE"
+    }
+}
diff --git a/...ython-contract-examples/smart_contracts/artifacts/control_flow/ForLoopsExample.clear.teal b/...ython-contract-examples/smart_contracts/artifacts/control_flow/ForLoopsExample.clear.teal
@@ -0,0 +1,5 @@
+#pragma version 10
+
+smart_contracts.control_flow.contract.ForLoopsExample.clear_state_program:
+    int 1
+    return
diff --git a/...thon-contract-examples/smart_contracts/artifacts/control_flow/IfElseExample.approval.teal b/...thon-contract-examples/smart_contracts/artifacts/control_flow/IfElseExample.approval.teal
@@ -0,0 +1,115 @@
+#pragma version 10
+
+smart_contracts.control_flow.contract.IfElseExample.approval_program:
+    callsub __puya_arc4_router__
+    return
+
+
+// smart_contracts.control_flow.contract.IfElseExample.__puya_arc4_router__() -> uint64:
+__puya_arc4_router__:
+    proto 0 1
+    txn NumAppArgs
+    bz __puya_arc4_router___bare_routing@6
+    method "is_rich(uint64)string"
+    method "is_even(uint64)string"
+    txna ApplicationArgs 0
+    match __puya_arc4_router___is_rich_route@2 __puya_arc4_router___is_even_route@3
+    int 0
+    retsub
+
+__puya_arc4_router___is_rich_route@2:
+    txn OnCompletion
+    !
+    assert // OnCompletion is NoOp
+    txn ApplicationID
+    assert // is not creating
+    txna ApplicationArgs 1
+    btoi
+    callsub is_rich
+    dup
+    len
+    itob
+    extract 6 2
+    swap
+    concat
+    byte 0x151f7c75
+    swap
+    concat
+    log
+    int 1
+    retsub
+
+__puya_arc4_router___is_even_route@3:
+    txn OnCompletion
+    !
+    assert // OnCompletion is NoOp
+    txn ApplicationID
+    assert // is not creating
+    txna ApplicationArgs 1
+    btoi
+    callsub is_even
+    dup
+    len
+    itob
+    extract 6 2
+    swap
+    concat
+    byte 0x151f7c75
+    swap
+    concat
+    log
+    int 1
+    retsub
+
+__puya_arc4_router___bare_routing@6:
+    txn OnCompletion
+    bnz __puya_arc4_router___after_if_else@10
+    txn ApplicationID
+    !
+    assert // is creating
+    int 1
+    retsub
+
+__puya_arc4_router___after_if_else@10:
+    int 0
+    retsub
+
+
+// smart_contracts.control_flow.contract.IfElseExample.is_rich(account_balance: uint64) -> bytes:
+is_rich:
+    proto 1 1
+    frame_dig -1
+    int 1000
+    >
+    bz is_rich_else_body@2
+    byte "This account is rich!"
+    retsub
+
+is_rich_else_body@2:
+    frame_dig -1
+    int 100
+    >
+    bz is_rich_else_body@4
+    byte "This account is doing well."
+    retsub
+
+is_rich_else_body@4:
+    byte "This account is poor :("
+    retsub
+
+
+// smart_contracts.control_flow.contract.IfElseExample.is_even(number: uint64) -> bytes:
+is_even:
+    proto 1 1
+    frame_dig -1
+    int 2
+    %
+    bnz is_even_ternary_false@2
+    byte "Even"
+    b is_even_ternary_merge@3
+
+is_even_ternary_false@2:
+    byte "Odd"
+
+is_even_ternary_merge@3:
+    retsub
diff --git a/.../python-contract-examples/smart_contracts/artifacts/control_flow/IfElseExample.arc32.json b/.../python-contract-examples/smart_contracts/artifacts/control_flow/IfElseExample.arc32.json
@@ -0,0 +1,73 @@
+{
+    "hints": {
+        "is_rich(uint64)string": {
+            "call_config": {
+                "no_op": "CALL"
+            }
+        },
+        "is_even(uint64)string": {
+            "call_config": {
+                "no_op": "CALL"
+            }
+        }
+    },
+    "source": {
+        "approval": "I3ByYWdtYSB2ZXJzaW9uIDEwCgpzbWFydF9jb250cmFjdHMuY29udHJvbF9mbG93LmNvbnRyYWN0LklmRWxzZUV4YW1wbGUuYXBwcm92YWxfcHJvZ3JhbToKICAgIGNhbGxzdWIgX19wdXlhX2FyYzRfcm91dGVyX18KICAgIHJldHVybgoKCi8vIHNtYXJ0X2NvbnRyYWN0cy5jb250cm9sX2Zsb3cuY29udHJhY3QuSWZFbHNlRXhhbXBsZS5fX3B1eWFfYXJjNF9yb3V0ZXJfXygpIC0+IHVpbnQ2NDoKX19wdXlhX2FyYzRfcm91dGVyX186CiAgICBwcm90byAwIDEKICAgIHR4biBOdW1BcHBBcmdzCiAgICBieiBfX3B1eWFfYXJjNF9yb3V0ZXJfX19iYXJlX3JvdXRpbmdANgogICAgbWV0aG9kICJpc19yaWNoKHVpbnQ2NClzdHJpbmciCiAgICBtZXRob2QgImlzX2V2ZW4odWludDY0KXN0cmluZyIKICAgIHR4bmEgQXBwbGljYXRpb25BcmdzIDAKICAgIG1hdGNoIF9fcHV5YV9hcmM0X3JvdXRlcl9fX2lzX3JpY2hfcm91dGVAMiBfX3B1eWFfYXJjNF9yb3V0ZXJfX19pc19ldmVuX3JvdXRlQDMKICAgIGludCAwCiAgICByZXRzdWIKCl9fcHV5YV9hcmM0X3JvdXRlcl9fX2lzX3JpY2hfcm91dGVAMjoKICAgIHR4biBPbkNvbXBsZXRpb24KICAgICEKICAgIGFzc2VydCAvLyBPbkNvbXBsZXRpb24gaXMgTm9PcAogICAgdHhuIEFwcGxpY2F0aW9uSUQKICAgIGFzc2VydCAvLyBpcyBub3QgY3JlYXRpbmcKICAgIHR4bmEgQXBwbGljYXRpb25BcmdzIDEKICAgIGJ0b2kKICAgIGNhbGxzdWIgaXNfcmljaAogICAgZHVwCiAgICBsZW4KICAgIGl0b2IKICAgIGV4dHJhY3QgNiAyCiAgICBzd2FwCiAgICBjb25jYXQKICAgIGJ5dGUgMHgxNTFmN2M3NQogICAgc3dhcAogICAgY29uY2F0CiAgICBsb2cKICAgIGludCAxCiAgICByZXRzdWIKCl9fcHV5YV9hcmM0X3JvdXRlcl9fX2lzX2V2ZW5fcm91dGVAMzoKICAgIHR4biBPbkNvbXBsZXRpb24KICAgICEKICAgIGFzc2VydCAvLyBPbkNvbXBsZXRpb24gaXMgTm9PcAogICAgdHhuIEFwcGxpY2F0aW9uSUQKICAgIGFzc2VydCAvLyBpcyBub3QgY3JlYXRpbmcKICAgIHR4bmEgQXBwbGljYXRpb25BcmdzIDEKICAgIGJ0b2kKICAgIGNhbGxzdWIgaXNfZXZlbgogICAgZHVwCiAgICBsZW4KICAgIGl0b2IKICAgIGV4dHJhY3QgNiAyCiAgICBzd2FwCiAgICBjb25jYXQKICAgIGJ5dGUgMHgxNTFmN2M3NQogICAgc3dhcAogICAgY29uY2F0CiAgICBsb2cKICAgIGludCAxCiAgICByZXRzdWIKCl9fcHV5YV9hcmM0X3JvdXRlcl9fX2JhcmVfcm91dGluZ0A2OgogICAgdHhuIE9uQ29tcGxldGlvbgogICAgYm56IF9fcHV5YV9hcmM0X3JvdXRlcl9fX2FmdGVyX2lmX2Vsc2VAMTAKICAgIHR4biBBcHBsaWNhdGlvbklECiAgICAhCiAgICBhc3NlcnQgLy8gaXMgY3JlYXRpbmcKICAgIGludCAxCiAgICByZXRzdWIKCl9fcHV5YV9hcmM0X3JvdXRlcl9fX2FmdGVyX2lmX2Vsc2VAMTA6CiAgICBpbnQgMAogICAgcmV0c3ViCgoKLy8gc21hcnRfY29udHJhY3RzLmNvbnRyb2xfZmxvdy5jb250cmFjdC5JZkVsc2VFeGFtcGxlLmlzX3JpY2goYWNjb3VudF9iYWxhbmNlOiB1aW50NjQpIC0+IGJ5dGVzOgppc19yaWNoOgogICAgcHJvdG8gMSAxCiAgICBmcmFtZV9kaWcgLTEKICAgIGludCAxMDAwCiAgICA+CiAgICBieiBpc19yaWNoX2Vsc2VfYm9keUAyCiAgICBieXRlICJUaGlzIGFjY291bnQgaXMgcmljaCEiCiAgICByZXRzdWIKCmlzX3JpY2hfZWxzZV9ib2R5QDI6CiAgICBmcmFtZV9kaWcgLTEKICAgIGludCAxMDAKICAgID4KICAgIGJ6IGlzX3JpY2hfZWxzZV9ib2R5QDQKICAgIGJ5dGUgIlRoaXMgYWNjb3VudCBpcyBkb2luZyB3ZWxsLiIKICAgIHJldHN1YgoKaXNfcmljaF9lbHNlX2JvZHlANDoKICAgIGJ5dGUgIlRoaXMgYWNjb3VudCBpcyBwb29yIDooIgogICAgcmV0c3ViCgoKLy8gc21hcnRfY29udHJhY3RzLmNvbnRyb2xfZmxvdy5jb250cmFjdC5JZkVsc2VFeGFtcGxlLmlzX2V2ZW4obnVtYmVyOiB1aW50NjQpIC0+IGJ5dGVzOgppc19ldmVuOgogICAgcHJvdG8gMSAxCiAgICBmcmFtZV9kaWcgLTEKICAgIGludCAyCiAgICAlCiAgICBibnogaXNfZXZlbl90ZXJuYXJ5X2ZhbHNlQDIKICAgIGJ5dGUgIkV2ZW4iCiAgICBiIGlzX2V2ZW5fdGVybmFyeV9tZXJnZUAzCgppc19ldmVuX3Rlcm5hcnlfZmFsc2VAMjoKICAgIGJ5dGUgIk9kZCIKCmlzX2V2ZW5fdGVybmFyeV9tZXJnZUAzOgogICAgcmV0c3ViCg==",
+        "clear": "I3ByYWdtYSB2ZXJzaW9uIDEwCgpzbWFydF9jb250cmFjdHMuY29udHJvbF9mbG93LmNvbnRyYWN0LklmRWxzZUV4YW1wbGUuY2xlYXJfc3RhdGVfcHJvZ3JhbToKICAgIGludCAxCiAgICByZXR1cm4K"
+    },
+    "state": {
+        "global": {
+            "num_byte_slices": 0,
+            "num_uints": 0
+        },
+        "local": {
+            "num_byte_slices": 0,
+            "num_uints": 0
+        }
+    },
+    "schema": {
+        "global": {
+            "declared": {},
+            "reserved": {}
+        },
+        "local": {
+            "declared": {},
+            "reserved": {}
+        }
+    },
+    "contract": {
+        "name": "IfElseExample",
+        "methods": [
+            {
+                "name": "is_rich",
+                "args": [
+                    {
+                        "type": "uint64",
+                        "name": "account_balance"
+                    }
+                ],
+                "readonly": false,
+                "returns": {
+                    "type": "string"
+                }
+            },
+            {
+                "name": "is_even",
+                "args": [
+                    {
+                        "type": "uint64",
+                        "name": "number"
+                    }
+                ],
+                "readonly": false,
+                "returns": {
+                    "type": "string"
+                }
+            }
+        ],
+        "networks": {}
+    },
+    "bare_call_config": {
+        "no_op": "CREATE"
+    }
+}
diff --git a/.../python-contract-examples/smart_contracts/artifacts/control_flow/IfElseExample.clear.teal b/.../python-contract-examples/smart_contracts/artifacts/control_flow/IfElseExample.clear.teal
@@ -0,0 +1,5 @@
+#pragma version 10
+
+smart_contracts.control_flow.contract.IfElseExample.clear_state_program:
+    int 1
+    return