Merge pull request #5 from devinaconley/hubs

hubs

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

@@ -0,0 +1,95 @@
+"""
+methods to interact with farcaster hub
+"""
+
+# lib
+import os
+import requests
+
+# src
+from .models import FrameMessage, ValidatedMessage, ValidatedData, FrameAction, CastId
+
+
+def get_message(
+        msg: str,
+        hub: str,
+        username: str = None,
+        password: str = None,
+        api_key: str = None
+) -> ValidatedMessage:
+    url = f'{hub}/v1/validateMessage'
+    headers = {'content-type': 'application/octet-stream'}
+    if api_key:
+        headers['api_key'] = api_key
+    auth = None
+    if username:
+        auth = (username, password)
+    res = requests.post(url, headers=headers, auth=auth, data=bytes.fromhex(msg))
+
+    body = res.json()
+    if not body['valid']:
+        raise ValueError('frame action message is invalid')
+    action = ValidatedMessage(**body['message'])
+
+    return action
+
+
+def validate_message(
+        msg: FrameMessage,
+        hub: str,
+        username: str = None,
+        password: str = None,
+        api_key: str = None
+) -> ValidatedMessage:
+    action = get_message(msg.trustedData.messageBytes, hub, username=username, password=password, api_key=api_key)
+
+    if msg.untrustedData.fid != action.data.fid:
+        raise ValueError(f'fid does not match: {msg.untrustedData.fid} {action.data.fid}')
+
+    if msg.untrustedData.buttonIndex != action.data.frameActionBody.buttonIndex:
+        raise ValueError(
+            f'button index does not match: {msg.untrustedData.buttonIndex} {action.data.frameActionBody.buttonIndex}')
+
+    if msg.untrustedData.inputText is not None and msg.untrustedData.inputText != action.data.frameActionBody.inputText:
+        raise ValueError(
+            f'text input does not match: {msg.untrustedData.inputText} {action.data.frameActionBody.inputText}')
+
+    if msg.untrustedData.state is not None and msg.untrustedData.state != action.data.frameActionBody.state:
+        raise ValueError(f'state does not match: {msg.untrustedData.state} {action.data.frameActionBody.state}')
+
+    return action
+
+
+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=str(msg.untrustedData.network),
+                frameActionBody=FrameAction(
+                    url=msg.untrustedData.url,
+                    buttonIndex=msg.untrustedData.buttonIndex,
+                    castId=msg.untrustedData.castId,
+                    inputTest=msg.untrustedData.inputText,
+                    state=msg.untrustedData.state,
+                    transactionId=msg.untrustedData.transactionId
+                )
+            ),
+            hash=msg.untrustedData.messageHash,
+            hashScheme='HASH_SCHEME_BLAKE',
+            signature='',
+            signatureScheme='SIGNATURE_SCHEME_ED25519',
+            signer=''
+        )
+
+    return validate_message(msg, hub, username=username, password=password, api_key=api_key)

framelib/models.py

@@ -14,19 +14,23 @@ class CastId(BaseModel):
     hash: str
 
 
-class UntrustedData(BaseModel):
-    fid: int
+class FrameAction(BaseModel):
     url: str
-    messageHash: str
-    timestamp: int
-    network: int
     buttonIndex: int
     inputText: Optional[str] = None
     state: Optional[str] = None
     transactionId: Optional[str] = None
     castId: CastId
 
 
+class UntrustedData(FrameAction):
+    # note: this untrusted message seems to collapse the ValidatedDate and FrameAction fields
+    fid: int
+    messageHash: str
+    timestamp: int
+    network: int
+
+
 class TrustedData(BaseModel):
     messageBytes: str
 
@@ -51,6 +55,25 @@ class Transaction(BaseModel):
     params: EthTransactionParams
 
 
+# ---- hub ----
+
+class ValidatedData(BaseModel):
+    type: str
+    fid: int
+    timestamp: datetime.datetime
+    network: str
+    frameActionBody: FrameAction
+
+
+class ValidatedMessage(BaseModel):
+    data: ValidatedData
+    hash: str
+    hashScheme: str
+    signature: str
+    signatureScheme: str
+    signer: str
+
+
 # ---- neynar ----
 
 class NeynarViewer(BaseModel):
@@ -67,7 +90,7 @@ class NeynarProfile(BaseModel):
     bio: NeynarBio
 
 
-class Interactor(BaseModel):
+class NeynarInteractor(BaseModel):
     object: str
     fid: int
     username: str
@@ -100,9 +123,9 @@ class NeynarTransaction(BaseModel):
     hash: str
 
 
-class ValidatedMessage(BaseModel):
+class NeynarValidatedMessage(BaseModel):
     object: str
-    interactor: Interactor
+    interactor: NeynarInteractor
     tapped_button: NeynarButton
     input: Optional[NeynarInput] = None
     state: Optional[NeynarState] = None

framelib/neynar.py

@@ -1,15 +1,17 @@
 """
 methods to call neynar api
 """
-import os
 
+# lib
+import os
 import requests
 
-from .models import FrameMessage, ValidatedMessage, Interactor, NeynarProfile, NeynarBio, NeynarButton, NeynarInput, \
-    NeynarState, NeynarTransaction
+# src
+from .models import FrameMessage, NeynarValidatedMessage, NeynarInteractor, NeynarProfile, NeynarBio, \
+    NeynarButton, NeynarInput, NeynarState, NeynarTransaction
 
 
-def get_frame_action(msg: str, api_key: str) -> ValidatedMessage:
+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'
@@ -30,13 +32,13 @@ def get_frame_action(msg: str, api_key: str) -> ValidatedMessage:
     if not body['valid']:
         raise ValueError('frame action message is invalid')
 
-    action = ValidatedMessage(**body['action'])
+    action = NeynarValidatedMessage(**body['action'])
 
     return action
 
 
-def validate_message(msg: FrameMessage, api_key: str) -> ValidatedMessage:
-    action = get_frame_action(msg.trustedData.messageBytes, api_key)
+def validate_message(msg: FrameMessage, api_key: str) -> NeynarValidatedMessage:
+    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}')
@@ -53,13 +55,13 @@ def validate_message(msg: FrameMessage, api_key: str) -> ValidatedMessage:
     return action
 
 
-def validate_message_or_mock(msg: FrameMessage, api_key: str, mock: bool = False) -> ValidatedMessage:
+def validate_message_or_mock(msg: FrameMessage, api_key: str, mock: bool = False) -> NeynarValidatedMessage:
     if mock:
         # mock
         # TODO option to populate with warpcast profile
-        return ValidatedMessage(
+        return NeynarValidatedMessage(
             object='validated_frame_action',
-            interactor=Interactor(
+            interactor=NeynarInteractor(
                 object='user',
                 fid=msg.untrustedData.fid,
                 username=f'username {msg.untrustedData.fid}',
@@ -81,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) -> ValidatedMessage:
-    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,15 +7,37 @@
 
 # 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
 
 
-class TestValidateMessage(object):
+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
+
+
+class TestValidateMessageHub(object):
+
+    def test_button_1(self):
+        # example signed message from fid 8268 clicking button 1
+        msg = '0a4e080d10cc4018cbe1a230200182013f0a2068747470733a2f2f707974686f6e2d6672616d652e76657263656c2e6170702f10011a1908cc401214000000000000000000000000000000000000000112140101bf04a2e61cb24c9a66c047ac5ed175e1bed8180122403feee9d0c1392c1e5bc7bca49850f83735c53b4f60c88959ffc271123e333a196e963d15619125e6034acda36076c709182daa5625e4affe6df21866c204830828013220ad4520314a78bc4317c604a3324ebc25bd8215c3ac38342fd790b7905c291bd1'
+        action = get_message(msg, 'https://nemes.farcaster.xyz:2281')  # public read only
+        assert action.data.frameActionBody.buttonIndex == 1
+        assert action.data.fid == 8268
+        assert action.data.network == 'FARCASTER_NETWORK_MAINNET'
+        assert action.data.frameActionBody.inputText == ''
+
+    def test_button_1_neynar(self):
+        # example signed message from fid 8268 clicking button 1
+        msg = '0a4e080d10cc4018cbe1a230200182013f0a2068747470733a2f2f707974686f6e2d6672616d652e76657263656c2e6170702f10011a1908cc401214000000000000000000000000000000000000000112140101bf04a2e61cb24c9a66c047ac5ed175e1bed8180122403feee9d0c1392c1e5bc7bca49850f83735c53b4f60c88959ffc271123e333a196e963d15619125e6034acda36076c709182daa5625e4affe6df21866c204830828013220ad4520314a78bc4317c604a3324ebc25bd8215c3ac38342fd790b7905c291bd1'
+        action = get_message(msg, 'https://hub-api.neynar.com', api_key='NEYNAR_API_DOCS')
+        assert action.data.frameActionBody.buttonIndex == 1
+        assert action.data.fid == 8268
+        assert action.data.network == 'FARCASTER_NETWORK_MAINNET'
+        assert action.data.frameActionBody.inputText == ''