Skip to content

block-foundation/teal-template

GitHub License devContainer


Block Foundation Logo

PyTeal Template

Block Foundation Smart Contract Series [Teal]


Block Foundation Brand

Contents



Report a Bug Request a Feature Ask a Question Make a Suggestion Start a Discussion

Introduction

This is a very simple example of a stateful smart contract on the Algorand blockchain. Stateful smart contracts have access to both global state (shared by all users of the contract) and local state (unique to each user), but this example only uses local state. The "counter" variable is stored in each user's local state, and is incremented by 1 each time that user calls the contract.

from pyteal import *

def approval_program():
    # This block executes when the smart contract is first initialized.
    # It sets a local variable "counter" to 0 for the sender of the transaction.
    on_initialization = Seq([
        App.localPut(Int(0), Bytes("counter"), Int(0)),
        Return(Int(1))  # This indicates that the initialization was successful.
    ])

    # This block executes on each call to the smart contract after it has been initialized.
    # It increments the "counter" variable by 1 for the sender of the transaction.
    on_call = Seq([
        App.localGetEx(Int(0), App.id(), Bytes("counter")),
        App.localPut(Int(0), Bytes("counter"), Add(Int(1), App.localGet(Int(0), Bytes("counter")))),
        Return(Int(1))  # This indicates that the call was successful.
    ])

    # The Cond function routes execution depending on whether the application is being initialized or called.
    # If the application_id of the transaction is 0, that means the application is being initialized.
    # Otherwise, the application is being called.
    program = Cond(
        [Txn.application_id() == Int(0), on_initialization],
        [Txn.application_id() != Int(0), on_call]
    )

    return program

if __name__ == "__main__":
    # This line compiles the PyTeal code into TEAL (Transaction Execution Approval Language), the bytecode language that Algorand smart contracts are executed in.
    print(compileTeal(approval_program(), mode=Mode.Application))

You can find more information on stateful smart contracts and PyTeal in the Algorand developer documentation.


Colophon

Authors

This is an open-source project by the Block Foundation.

The Block Foundation mission is enabling architects to take back initiative and contribute in solving the mismatch in housing through blockchain technology. Therefore the Block Foundation seeks to unschackle the traditional constraints and construct middle ground between rent and the rigidity of traditional mortgages.

website: www.blockfoundation.io

Development Resources

Contributing

We'd love for you to contribute and to make this project even better than it is today! Please refer to the contribution guidelines for information.

Legal Information

Copyright

Copyright © 2023 Stichting Block Foundation. All Rights Reserved.

License

Except as otherwise noted, the content in this repository is licensed under the Creative Commons Attribution 4.0 International (CC BY 4.0) License, and code samples are licensed under the Apache 2.0 License.

Also see LICENSE and LICENSE-CODE.

Disclaimer

THIS SOFTWARE IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.