feat: added state object to FrameValidationData (#216)

coinbase · Mar 5, 2024 · 3f76991 · 3f76991
1 parent 760775a
commit 3f76991
Show file tree

Hide file tree

Showing 9 changed files with 50 additions and 9 deletions.
diff --git a/.changeset/cyan-paws-roll.md b/.changeset/cyan-paws-roll.md
@@ -0,0 +1,6 @@
+---
+'@coinbase/onchainkit': patch
+---
+
+- **feat**: added `state` type support for `FrameData` and `FrameValidationData`. By @zizzamia #216
+- **fix**: update Neynar frame validation type. By @Flickque #212
diff --git a/site/docs/pages/frame/types.mdx b/site/docs/pages/frame/types.mdx
@@ -21,6 +21,25 @@ type FrameButtonMetadata =
     };
 ```
 
+## `FrameData`
+
+```ts
+interface FrameData {
+  buttonIndex: number;
+  castId: {
+    fid: number;
+    hash: string;
+  };
+  inputText: string;
+  fid: number;
+  messageHash: string;
+  network: number;
+  state: string;
+  timestamp: number;
+  url: string;
+}
+```
+
 ## `FrameImageMetadata`
 
 ```ts
@@ -97,6 +116,9 @@ interface FrameValidationData {
   liked: boolean; // Indicates if the viewer clicking the frame liked the cast
   raw: NeynarFrameValidationInternalModel;
   recasted: boolean; // Indicates if the viewer clicking the frame recasted the cast
+  state: {
+    serialized: string; // Serialized state (e.g. JSON) passed to the frame server
+  };
   valid: boolean; // Indicates if the frame is valid
 }
 ```

diff --git a/src/frame/getFrameMessage.integ.ts b/src/frame/getFrameMessage.integ.ts
@@ -4,14 +4,15 @@ describe('getFrameMessage integration tests', () => {
   it('frame message should decode properly', async () => {
     const body = {
       untrustedData: {
+        buttonIndex: 1,
+        castId: { fid: 194519, hash: '0x3d7c0dac1dd0ee588eb58d07105b14786cfca976' },
         fid: 194519,
-        url: 'https://frame-demo.vercel.app/2',
-        messageHash: '0x7099de8afb08984d53f56a02b28d0f96097bfd82',
-        timestamp: 1706559790000,
         inputText: '',
+        messageHash: '0x7099de8afb08984d53f56a02b28d0f96097bfd82',
         network: 1,
-        buttonIndex: 1,
-        castId: { fid: 194519, hash: '0x3d7c0dac1dd0ee588eb58d07105b14786cfca976' },
+        url: 'https://frame-demo.vercel.app/2',
+        state: '',
+        timestamp: 1706559790000,
       },
       trustedData: {
         messageBytes:

diff --git a/src/frame/getFrameMessage.test.ts b/src/frame/getFrameMessage.test.ts
@@ -49,6 +49,7 @@ describe('getFrameValidatedMessage', () => {
           fid: 0,
           network: 0,
           messageHash: '0xthisisnotreal',
+          state: '',
           timestamp: 0,
           url: 'https://localhost:3000',
         },
@@ -75,6 +76,7 @@ describe('getFrameValidatedMessage', () => {
           fid: 0,
           network: 0,
           messageHash: '0xthisisnotreal',
+          state: '',
           timestamp: 0,
           url: 'https://localhost:3000',
         },

diff --git a/src/frame/getMockFrameRequest.ts b/src/frame/getMockFrameRequest.ts
@@ -15,8 +15,8 @@ function getMockFrameRequest(
     ...request,
     mockFrameData: {
       button: request.untrustedData.buttonIndex,
-      input: request.untrustedData.inputText,
       following: !!options?.following,
+      input: request.untrustedData.inputText,
       interactor: {
         fid: options?.interactor?.fid || 0,
         custody_address: options?.interactor?.custody_address || '0xnotarealaddress',
@@ -28,6 +28,9 @@ function getMockFrameRequest(
       },
       liked: !!options?.liked,
       recasted: !!options?.recasted,
+      state: {
+        serialized: request.untrustedData.state || '',
+      },
       valid: true,
       raw: {
         valid: true,

diff --git a/src/frame/types.ts b/src/frame/types.ts
@@ -16,6 +16,7 @@ export interface FrameData {
   fid: number;
   messageHash: string;
   network: number;
+  state: string;
   timestamp: number;
   url: string;
 }
@@ -51,6 +52,9 @@ export interface FrameValidationData {
   liked: boolean; // Indicates if the viewer clicking the frame liked the cast
   raw: NeynarFrameValidationInternalModel;
   recasted: boolean; // Indicates if the viewer clicking the frame recasted the cast
+  state: {
+    serialized: string; // Serialized state (e.g. JSON) passed to the frame server
+  };
   valid: boolean; // Indicates if the frame is valid
 }
 

diff --git a/src/utils/neynar/frame/neynarFrameModels.ts b/src/utils/neynar/frame/neynarFrameModels.ts
@@ -34,6 +34,9 @@ export function convertToNeynarResponseModel(data: any): FrameValidationData | u
     liked: cast?.viewer_context?.liked,
     raw: neynarResponse,
     recasted: cast?.viewer_context?.recasted,
+    state: {
+      serialized: action?.state?.serialized || '',
+    },
     valid: neynarResponse.valid,
   };
 }
diff --git a/src/utils/neynar/frame/types.ts b/src/utils/neynar/frame/types.ts
@@ -89,10 +89,10 @@ export interface NeynarFrameValidationInternalModel {
           action_type: string;
         }[];
         input: {
-          text: string;
+          text?: string;
         };
         state: {
-          serialized: string;
+          serialized?: string;
         };
         post_url: string;
         frames_url: string;

diff --git a/src/version.ts b/src/version.ts
@@ -1 +1 @@
-export const version = '0.9.8';
+export const version = '0.9.9';