frame error message

Author: devinaconley

examples/simple/api/index.py

@@ -4,7 +4,7 @@
 import os
 import time
 from flask import Flask, url_for, jsonify
-from framelib import frame, message, validate_message_or_mock, validate_message_or_mock_neynar
+from framelib import frame, message, validate_message_or_mock, validate_message_or_mock_neynar, error
 
 app = Flask(__name__)
 
@@ -36,6 +36,11 @@ def second_page():
     msg = message()
     print(f'received frame message: {msg}')
 
+    if msg.untrustedData.fid == 123:
+        e = error('user 123 is not allowed!')
+        print(e)
+        return e
+
     # validate frame message with neynar
     api_key = os.getenv('NEYNAR_KEY')
     msg_neynar = validate_message_or_mock_neynar(msg, api_key, mock=_vercel_local())

examples/simple/requirements.txt

@@ -1,4 +1,4 @@
 # requirements.txt
-framelib~=0.0.4b3
+framelib~=0.0.4b4
 Flask~=3.0.1
 pydantic

framelib/__init__.py

@@ -2,7 +2,7 @@
 framelib module
 """
 
-from .frame import frame, message
+from .frame import frame, message, error
 from .hub import validate_message, validate_message_or_mock
 from .models import FrameMessage, ValidatedMessage, User
 from .warpcast import get_user

framelib/frame.py

@@ -6,10 +6,10 @@
 import json
 from importlib import resources
 from typing import Literal
-from flask import render_template_string, request, make_response, Response
+from flask import render_template_string, request, make_response, jsonify, Response
 
 # src
-from .models import FrameMessage
+from .models import FrameMessage, FrameError
 
 # enum types
 ButtonActions = Literal['post', 'post_redirect', 'mint', 'link', 'tx']
@@ -63,3 +63,12 @@ def message() -> FrameMessage:
     body = json.loads(request.data)
     msg = FrameMessage(**body)
     return msg
+
+
+def error(text: str, status: int = 400) -> Response:
+    if len(text) > 90:
+        print('warning: error message exceeds 90 characters')
+    e = FrameError(message=text)
+    res = jsonify(e.model_dump())
+    res.status_code = status
+    return res

framelib/models.py

@@ -20,6 +20,7 @@ class FrameAction(BaseModel):
     inputText: Optional[str] = None
     state: Optional[str] = None
     transactionId: Optional[str] = None
+    address: Optional[str] = None
     castId: CastId
 
 
@@ -55,6 +56,12 @@ class Transaction(BaseModel):
     params: EthTransactionParams
 
 
+# ---- frame error ----
+
+class FrameError(BaseModel):
+    message: str
+
+
 # ---- hub ----
 
 class ValidatedData(BaseModel):

setup.py

@@ -5,7 +5,7 @@
 
 setuptools.setup(
     name='framelib',
-    version='0.0.4b3',
+    version='0.0.4b4',
     author='Devin A. Conley',
     author_email='devinaconley@gmail.com',
     description='lightweight library for building farcaster frames using python and flask',