Merge pull request #291 from SamuelLHuber/patch-1

docs: connectedAddress tx docs

.changeset/weak-moons-provide.md

@@ -0,0 +1,5 @@
+---
+"docs": patch
+---
+
+fix: add connectedAddress docs

docs/pages/guides/transactions.mdx

@@ -10,12 +10,39 @@ Frames can initiate transactions that apps that integrate Frames can complete, c
 An example snippet can be found below.
 
 ```tsx
-    // ...
-    buttons: [
-      <Button action="tx" target="/txdata" post_url="/frames">
-        Buy a unit
-      </Button>
-    ]
+// ...
+buttons: [
+  <Button action="tx" target="/txdata" post_url="/frames">
+    Buy a unit
+  </Button>,
+];
 ```
 
-Use the [Transactions starter](https://github.com/framesjs/frames.js/tree/main/examples/framesjs-starter/app/examples/new-api-transaction) as a template to build your transaction Frames.
+Use the [Transactions starter](https://github.com/framesjs/frames.js/tree/main/examples/framesjs-starter/app/examples/new-api-transaction) as a template to build your transaction Frames.
+
+## Using the connected wallet address
+
+The client will include the user's connected wallet address that will be executing the transaction in the frame action payload in the when a frame button with `action="tx"` set is pressed.
+
+The address is available in the context under the key `connectedAddress`.
+
+Note:
+
+- The address is only available when the user has connected a wallet to the client the frame button pressed is has a `tx` action.
+- `connectedAddress` differs from the `requesterVerifiedAddresses` returned by the [`farcasterHubContext`](/middleware/farcasterHubContext) middleware.
+
+```tsx [./app/frames/tx-data/route.tsx]
+import { frames } from "../frames";
+
+export const POST = frames(async (ctx) => {
+  if (!ctx.message) {
+    throw new Error("No message");
+  }
+
+  const userAddress = ctx.message.connectedAddress;
+
+  // Do something with the user's connected address that will be executing the tx
+
+  return txData;
+});
+```

docs/pages/reference/js/getFrameMessage.mdx

@@ -5,7 +5,7 @@ Returns a `FrameActionData` object from the message trusted data, as well as `Fr
 ## Usage
 
 ```ts
-import { frameMessage } from 'frames.js';
+import { getFrameMessage } from 'frames.js';
 
 const frameMessage = await getFrameMessage(frameActionPayload);
 console.log(frameMessage);
@@ -16,6 +16,7 @@ console.log(frameMessage);
   inputText: '',
   requesterFid: 1689,
   isValid: true,
+  connectedAddress: '0x8d25687829d6b85d9e0020b8c89e3ca24de20a89',
   casterFollowsRequester: false,
   requesterFollowsCaster: false,
   likedCast: false,
@@ -42,7 +43,8 @@ console.log(frameMessage);
   buttonIndex: 2,
   castId: { fid: 1, hash: '0x0000000000000000000000000000000000000000' },
   inputText: '',
-  requesterFid: 1689
+  requesterFid: 1689,
+  connectedAddress: '0x8d25687829d6b85d9e0020b8c89e3ca24de20a89'
 }
 **/
 ```
@@ -57,6 +59,8 @@ type FrameActionData = {
     hash: `0x${string}`;
   };
   inputText?: string;
+  /** Only available in payloads of buttons with action `tx` **/
+  connectedAddress: string;
 };
 ```