A Framework for building PyTeal Applications
Project description
Beaker
Beaker is a smart contract development framework for PyTeal.
With Beaker, we build a class that represents our entire application including state and routing.
WARNING
:warning: Mostly Untested - Expect Breaking Changes :warning:
Please file issues or prs and get any contracts audited
Hello, Beaker
from pyteal import *
from beaker import *
# Create a class, subclassing Application from beaker
class HelloBeaker(Application):
# Add an external method with ABI method signature `hello(string)string`
@external
def hello(self, name: abi.String, *, output: abi.String):
# Set output to the result of `Hello, `+name
return output.set(Concat(Bytes("Hello, "), name.get()))
# Create an Application client
app_client = client.ApplicationClient(
# Get sandbox algod client
client=sandbox.get_algod_client(),
# Instantiate app with the program version (default is MAX_TEAL_VERSION)
app=HelloBeaker(version=6),
# Get acct from sandbox and pass the signer
signer=sandbox.get_accounts().pop().signer,
)
# Deploy the app on-chain
app_id, app_addr, txid = app_client.create()
print(
f"""Deployed app in txid {txid}
App ID: {app_id}
Address: {app_addr}
"""
)
# Call the `hello` method
result = app_client.call(HelloBeaker.hello, name="Beaker")
print(result.return_value) # "Hello, Beaker"
Install
Beaker currently requires Python >= 3.10
You can install from pip:
pip install beaker-pyteal
Or from github directly (no promises on stability):
pip install git+https://github.com/algorand-devrel/beaker
Dev Environment
Requires a local sandbox with latest stable tag minimum.
$ git clone git@github.com:algorand/sandbox.git
$ cd sandbox
$ sandbox up source
Front End
See Beaker TS to generate a front end client for a Beaker App.
Testing
You can run tests from the root of the project using pytest
Use
Please feel free to file issues/prs
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for beaker_pyteal-0.5.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7e9b8c61926112ab53d38fa5967b30b8655dd97318b3f7fb8fc73af7e5121f8f |
|
MD5 | a6274ac652c26c8c21f58c8a867849e6 |
|
BLAKE2b-256 | a370e4d32b3ea85760484e23ca5b08b17c4350a7571693e186df620959207819 |