feat: initialize initial state in places where state is not present (#…

…449)

* feat: initialize initial state in places where state is not present

* fix: signature and transaction contexts are always posts

* nit: lint

* fix: don't account for context.status

* chore: changesets

.changeset/khaki-fishes-guess.md

@@ -0,0 +1,5 @@
+---
+"frog": patch
+---
+
+Added `initialState` as a fallback to `c.previousState` in handlers that depend on the state but cannot retrieve one.

src/frog-base.tsx

@@ -593,19 +593,16 @@ export class FrogBase<
           // @ts-ignore - private
           this.initialBasePath,
         )
-
-      const { context, getState } = getFrameContext<env, string>({
+      const { context, getState } = await getFrameContext<env, string>({
         context: await requestBodyToContext(c, {
           hub:
             this.hub ||
             (this.hubApiUrl ? { apiUrl: this.hubApiUrl } : undefined),
           secret: this.secret,
           verify,
         }),
-        initialState:
-          typeof this._initialState === 'function'
-            ? await (this._initialState as any)(c)
-            : this._initialState,
+        contextHono: c,
+        initialState: this._initialState,
         origin,
       })
 
@@ -1005,14 +1002,12 @@ export class FrogBase<
       const origin = this.origin ?? url.origin
       const assetsUrl = origin + parsePath(this.assetsPath)
 
-      const { context } = getImageContext<env, string>({
+      const { context } = await getImageContext<env, string>({
         context: await requestBodyToImageContext(c, {
           secret: this.secret,
         }),
-        initialState:
-          typeof this._initialState === 'function'
-            ? await (this._initialState as any)(c)
-            : this._initialState,
+        contextHono: c,
+        initialState: this._initialState,
       })
 
       const response = await handler(context)
@@ -1120,14 +1115,16 @@ export class FrogBase<
     const { verify = this.verify } = options
 
     this.hono.post(parseHonoPath(path), ...middlewares, async (c) => {
-      const { context } = getTransactionContext<env, string, {}, _state>({
+      const { context } = await getTransactionContext<env, string, {}, _state>({
         context: await requestBodyToContext(c, {
           hub:
             this.hub ||
             (this.hubApiUrl ? { apiUrl: this.hubApiUrl } : undefined),
           secret: this.secret,
           verify,
         }),
+        contextHono: c,
+        initialState: this._initialState,
         req: c.req,
       })
       const response = await handler(context)
@@ -1155,14 +1152,16 @@ export class FrogBase<
     const { verify = this.verify } = options
 
     this.hono.post(parseHonoPath(path), ...middlewares, async (c) => {
-      const { context } = getSignatureContext<env, string, {}, _state>({
+      const { context } = await getSignatureContext<env, string, {}, _state>({
         context: await requestBodyToContext(c, {
           hub:
             this.hub ||
             (this.hubApiUrl ? { apiUrl: this.hubApiUrl } : undefined),
           secret: this.secret,
           verify,
         }),
+        contextHono: c,
+        initialState: this._initialState,
         req: c.req,
       })
       const response = await handler(context)

src/utils/getFrameContext.ts

@@ -1,4 +1,4 @@
-import type { Input } from 'hono'
+import type { Context as Context_Hono, Input } from 'hono'
 import type { Context, FrameContext } from '../types/context.js'
 import type { Env } from '../types/env.js'
 import { getIntentState } from './getIntentState.js'
@@ -12,7 +12,11 @@ type GetFrameContextParameters<
   _state = env['State'],
 > = {
   context: Context<env, path, input>
-  initialState?: _state
+  contextHono: Context_Hono<env, path, input>
+  initialState?:
+    | ((c: Context<env>) => _state | Promise<_state>)
+    | _state
+    | undefined
   origin: string
 }
 
@@ -22,12 +26,12 @@ type GetFrameContextReturnType<
   input extends Input = {},
   //
   _state = env['State'],
-> = {
+> = Promise<{
   context: FrameContext<env, path, input>
   getState: () => _state
-}
+}>
 
-export function getFrameContext<
+export async function getFrameContext<
   env extends Env,
   path extends string,
   input extends Input = {},
@@ -36,7 +40,7 @@ export function getFrameContext<
 >(
   parameters: GetFrameContextParameters<env, path, input, _state>,
 ): GetFrameContextReturnType<env, path, input, _state> {
-  const { context, origin } = parameters
+  const { context, contextHono, origin } = parameters
   const { env, frameData, initialPath, previousButtonValues, req, verified } =
     context || {}
 
@@ -55,9 +59,12 @@ export function getFrameContext<
   // initial URL.
   const url = parsePath(reset ? `${origin}${initialPath}` : context.url)
 
-  let previousState = (() => {
-    if (context.status === 'initial') return parameters.initialState
-    return context?.previousState || parameters.initialState
+  let previousState = await (async () => {
+    if (context.previousState) return context.previousState
+
+    if (typeof parameters.initialState === 'function')
+      return await (parameters.initialState as any)(contextHono)
+    return parameters.initialState
   })()
 
   function deriveState(

src/utils/getImageContext.ts

@@ -1,4 +1,4 @@
-import type { Input } from 'hono'
+import type { Context as Context_Hono, Input } from 'hono'
 import type { Context, ImageContext } from '../types/context.js'
 import type { Env } from '../types/env.js'
 
@@ -13,7 +13,11 @@ type GetImageContextParameters<
     Context<env, path, input, _state>,
     'frameData' | 'verified' | 'status' | 'initialPath'
   >
-  initialState?: _state
+  contextHono: Context_Hono<env, path, input>
+  initialState?:
+    | ((c: Context<env>) => _state | Promise<_state>)
+    | _state
+    | undefined
 }
 
 type GetImageContextReturnType<
@@ -22,11 +26,11 @@ type GetImageContextReturnType<
   input extends Input = {},
   //
   _state = env['State'],
-> = {
+> = Promise<{
   context: ImageContext<env, path, input, _state>
-}
+}>
 
-export function getImageContext<
+export async function getImageContext<
   env extends Env,
   path extends string,
   input extends Input = {},
@@ -35,13 +39,19 @@ export function getImageContext<
 >(
   parameters: GetImageContextParameters<env, path, input, _state>,
 ): GetImageContextReturnType<env, path, input, _state> {
-  const { context, initialState } = parameters
+  const { context, contextHono } = parameters
   const { env, previousState, req } = context || {}
 
   return {
     context: {
       env,
-      previousState: previousState ?? (initialState as _state),
+      previousState: await (async () => {
+        if (previousState) return previousState
+
+        if (typeof parameters.initialState === 'function')
+          return await (parameters.initialState as any)(contextHono)
+        return parameters.initialState
+      })(),
       req,
       res: (data) => ({ data, format: 'image', status: 'success' }),
       var: context.var,

src/utils/getSignatureContext.ts

@@ -1,4 +1,4 @@
-import type { HonoRequest, Input } from 'hono'
+import type { Context as Context_Hono, HonoRequest, Input } from 'hono'
 import type { Context, SignatureContext } from '../types/context.js'
 import type { Env } from '../types/env.js'
 import type { SignatureResponse } from '../types/signature.js'
@@ -12,6 +12,11 @@ type GetSignatureContextParameters<
   _state = env['State'],
 > = {
   context: Context<env, path, input, _state>
+  contextHono: Context_Hono<env, path, input>
+  initialState:
+    | ((c: Context_Hono<env>) => _state | Promise<_state>)
+    | _state
+    | undefined
   req: HonoRequest
 }
 
@@ -21,11 +26,11 @@ type GetSignatureContextReturnType<
   input extends Input = {},
   //
   _state = env['State'],
-> = {
+> = Promise<{
   context: SignatureContext<env, path, input, _state>
-}
+}>
 
-export function getSignatureContext<
+export async function getSignatureContext<
   env extends Env,
   path extends string,
   input extends Input,
@@ -34,19 +39,26 @@ export function getSignatureContext<
 >(
   parameters: GetSignatureContextParameters<env, path, input, _state>,
 ): GetSignatureContextReturnType<env, path, input, _state> {
-  const { context } = parameters
+  const { context, contextHono } = parameters
   const {
     env,
     frameData,
     initialPath,
     previousButtonValues,
-    previousState,
     req,
     status,
     verified,
     url,
   } = context || {}
 
+  const previousState = await (async () => {
+    if (context.previousState) return context.previousState
+
+    if (typeof parameters.initialState === 'function')
+      return await (parameters.initialState as any)(contextHono)
+    return parameters.initialState
+  })()
+
   const { buttonValue, inputText } = getIntentState({
     buttonValues: previousButtonValues || [],
     frameData,
@@ -67,7 +79,7 @@ export function getSignatureContext<
       initialPath,
       inputText,
       previousButtonValues,
-      previousState,
+      previousState: previousState as any,
       req,
       res(parameters) {
         const { chainId, method, params } = parameters

src/utils/getTransactionContext.ts

@@ -1,4 +1,4 @@
-import type { HonoRequest, Input } from 'hono'
+import type { Context as Context_Hono, HonoRequest, Input } from 'hono'
 import {
   type Abi,
   AbiFunctionNotFoundError,
@@ -20,6 +20,11 @@ type GetTransactionContextParameters<
   _state = env['State'],
 > = {
   context: Context<env, path, input, _state>
+  contextHono: Context_Hono<env, path, input>
+  initialState:
+    | ((c: Context_Hono<env>) => _state | Promise<_state>)
+    | _state
+    | undefined
   req: HonoRequest
 }
 
@@ -29,11 +34,11 @@ type GetTransactionContextReturnType<
   input extends Input = {},
   //
   _state = env['State'],
-> = {
+> = Promise<{
   context: TransactionContext<env, path, input, _state>
-}
+}>
 
-export function getTransactionContext<
+export async function getTransactionContext<
   env extends Env,
   path extends string,
   input extends Input,
@@ -42,19 +47,26 @@ export function getTransactionContext<
 >(
   parameters: GetTransactionContextParameters<env, path, input, _state>,
 ): GetTransactionContextReturnType<env, path, input, _state> {
-  const { context } = parameters
+  const { context, contextHono } = parameters
   const {
     env,
     frameData,
     initialPath,
     previousButtonValues,
-    previousState,
     req,
     status,
     verified,
     url,
   } = context || {}
 
+  const previousState = await (async () => {
+    if (context.previousState) return context.previousState
+
+    if (typeof parameters.initialState === 'function')
+      return await (parameters.initialState as any)(contextHono)
+    return parameters.initialState
+  })()
+
   const { buttonValue, inputText } = getIntentState({
     buttonValues: previousButtonValues || [],
     frameData,
@@ -112,7 +124,7 @@ export function getTransactionContext<
       initialPath,
       inputText,
       previousButtonValues,
-      previousState,
+      previousState: previousState as any,
       req,
       res(parameters) {
         const { attribution, chainId, method, params } = parameters