use hubs in example, expose methods, beta release

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_vercel
+from framelib import frame, message, validate_message_or_mock, validate_message_or_mock_neynar
 
 app = Flask(__name__)
 
@@ -38,14 +38,18 @@ def second_page():
 
     # validate frame message with neynar
     api_key = os.getenv('NEYNAR_KEY')
-    msg_val = validate_message_or_mock_vercel(msg, api_key)
-    print(f'validated frame message, fid: {msg_val.interactor.fid}, button: {msg_val.tapped_button}')
+    msg_neynar = validate_message_or_mock_neynar(msg, api_key, mock=_vercel_local())
+    print(f'validated frame message, fid: {msg_neynar.interactor.fid}, button: {msg_neynar.tapped_button}')
+
+    # validate frame message with hub
+    msg_hub = validate_message_or_mock(msg, 'https://nemes.farcaster.xyz:2281', mock=_vercel_local())
+    print(f'validated frame message hub, fid: {msg_hub.data.fid}, button: {msg_hub.data.frameActionBody.buttonIndex}')
 
     return frame(
         image=_github_preview_image(),
         button1='back \U0001F519',
         post_url=url_for('home', _external=True),
-        input_text=f'hello {msg_val.interactor.username}!',
+        input_text=f'hello {msg_neynar.interactor.username}!',
         button2='github',
         button2_action='link',
         button2_target='https://github.com/devinaconley/python-frames'
@@ -55,3 +59,8 @@ def second_page():
 def _github_preview_image() -> str:
     hour = int((time.time() // 3600) * 3600)  # github throttles if you invalidate image cache too much
     return f'https://opengraph.githubassets.com/{hour}/devinaconley/python-frames'
+
+
+def _vercel_local() -> bool:
+    vercel_env = os.getenv('VERCEL_ENV')
+    return vercel_env is None or vercel_env == 'development'

examples/simple/requirements.txt

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

examples/transaction/api/index.py

@@ -4,7 +4,7 @@
 
 import json
 from flask import Flask, url_for, jsonify, request
-from framelib import frame, message, validate_message_or_mock_vercel, transaction
+from framelib import frame, message, transaction
 from eth_utils import to_wei
 
 from .constant import ABI_WETH, CHAIN_ID, ADDRESS_WETH, IM_WETH
@@ -36,7 +36,8 @@ def home():
         button2_action='tx',
         button2_target=url_for('tx_withdraw', _external=True, value=to_wei(0.01, 'ether')),
         input_text='WETH amount',
-        post_url=url_for('home', _external=True)
+        post_url=url_for('home', _external=True),
+        max_age=3600
     )
 
 

examples/transaction/requirements.txt

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

framelib/__init__.py

@@ -3,7 +3,11 @@
 """
 
 from .frame import frame, message
+from .hub import validate_message, validate_message_or_mock
 from .models import FrameMessage, ValidatedMessage, User
 from .warpcast import get_user
-from .neynar import validate_message, validate_message_or_mock, validate_message_or_mock_vercel
+from .neynar import (
+    validate_message as validate_message_neynar,
+    validate_message_or_mock as validate_message_or_mock_neynar
+)
 from .transaction import transaction

framelib/hub.py

@@ -60,15 +60,22 @@ def validate_message(
     return action
 
 
-def validate_message_or_mock(msg: FrameMessage, api_key: str, mock: bool = False) -> ValidatedMessage:
+def validate_message_or_mock(
+        msg: FrameMessage,
+        hub: str,
+        username: str = None,
+        password: str = None,
+        api_key: str = None,
+        mock: bool = False
+) -> ValidatedMessage:
     if mock:
         # mock
         return ValidatedMessage(
             data=ValidatedData(
                 type='MESSAGE_TYPE_FRAME_ACTION',
                 fid=msg.untrustedData.fid,
                 timestamp=msg.untrustedData.timestamp,
-                network=msg.untrustedData.network,
+                network=str(msg.untrustedData.network),
                 frameActionBody=FrameAction(
                     url=msg.untrustedData.url,
                     buttonIndex=msg.untrustedData.buttonIndex,
@@ -78,16 +85,11 @@ def validate_message_or_mock(msg: FrameMessage, api_key: str, mock: bool = False
                     transactionId=msg.untrustedData.transactionId
                 )
             ),
-            hash=msg.untrustedData.hash,
+            hash=msg.untrustedData.messageHash,
             hashScheme='HASH_SCHEME_BLAKE',
             signature='',
-            signature_scheme='SIGNATURE_SCHEME_ED25519',
+            signatureScheme='SIGNATURE_SCHEME_ED25519',
             signer=''
         )
 
-    return validate_message(msg, api_key)
-
-
-def validate_message_or_mock_vercel(msg: FrameMessage, api_key: str) -> ValidatedMessage:
-    vercel_env = os.getenv('VERCEL_ENV')
-    return validate_message_or_mock(msg, api_key, vercel_env is None or vercel_env == 'development')
+    return validate_message(msg, hub, username=username, password=password, api_key=api_key)

framelib/neynar.py

@@ -11,7 +11,7 @@
     NeynarButton, NeynarInput, NeynarState, NeynarTransaction
 
 
-def get_frame_action(msg: str, api_key: str) -> NeynarValidatedMessage:
+def get_frame_message(msg: str, api_key: str) -> NeynarValidatedMessage:
     if not api_key:
         raise ValueError('neynar api key not set')
     url = 'https://api.neynar.com/v2/farcaster/frame/validate'
@@ -38,7 +38,7 @@ def get_frame_action(msg: str, api_key: str) -> NeynarValidatedMessage:
 
 
 def validate_message(msg: FrameMessage, api_key: str) -> NeynarValidatedMessage:
-    action = get_frame_action(msg.trustedData.messageBytes, api_key)
+    action = get_frame_message(msg.trustedData.messageBytes, api_key)
 
     if msg.untrustedData.fid != action.interactor.fid:
         raise ValueError(f'fid does not match: {msg.untrustedData.fid} {action.interactor.fid}')
@@ -83,8 +83,3 @@ def validate_message_or_mock(msg: FrameMessage, api_key: str, mock: bool = False
         )
 
     return validate_message(msg, api_key)
-
-
-def validate_message_or_mock_vercel(msg: FrameMessage, api_key: str) -> NeynarValidatedMessage:
-    vercel_env = os.getenv('VERCEL_ENV')
-    return validate_message_or_mock(msg, api_key, vercel_env is None or vercel_env == 'development')

setup.py

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

test/test_validation.py

@@ -7,7 +7,7 @@
 
 # src
 from framelib import validate_message
-from framelib.neynar import get_frame_action
+from framelib.neynar import get_frame_message
 from framelib.hub import get_message
 
 
@@ -16,7 +16,7 @@ class TestValidateMessageNeynar(object):
     def test_button_1(self):
         # example signed message from fid 8268 clicking button 1
         msg = '0a4e080d10cc4018cbe1a230200182013f0a2068747470733a2f2f707974686f6e2d6672616d652e76657263656c2e6170702f10011a1908cc401214000000000000000000000000000000000000000112140101bf04a2e61cb24c9a66c047ac5ed175e1bed8180122403feee9d0c1392c1e5bc7bca49850f83735c53b4f60c88959ffc271123e333a196e963d15619125e6034acda36076c709182daa5625e4affe6df21866c204830828013220ad4520314a78bc4317c604a3324ebc25bd8215c3ac38342fd790b7905c291bd1'
-        action = get_frame_action(msg, 'NEYNAR_API_DOCS')
+        action = get_frame_message(msg, 'NEYNAR_API_DOCS')
         assert action.tapped_button.index == 1
         assert action.interactor.fid == 8268
         assert action.input is None