feat: added initial version of getFrameAccountAddress, which helps …

…getting the Account Address from the Farcaster ID using the Frame. (#20)

.changeset/wild-poems-tell.md

@@ -0,0 +1,5 @@
+---
+'@coinbase/onchainkit': patch
+---
+
+- **feat**: added initial version of `getFrameAccountAddress`, which helps getting the Account Address from the Farcaster ID using the Frame.

README.md

@@ -2,10 +2,9 @@
 
 > OnchainKit is a collection of CSS, React components and Core utilities specifically crafted to enhance your creativity when building onchain applications.
 
-
 ## Getting Started
-Add OnchainKit to your project, install the required packages.
 
+Add OnchainKit to your project, install the required packages.
 
 ```bash
 # Use Yarn
@@ -53,6 +52,7 @@ export default function Page() {
 ```
 
 `getFrameMetadata` params
-- `buttons`: A list of strings which are the label for the buttons in the frame (max 4 buttons). 
+
+- `buttons`: A list of strings which are the label for the buttons in the frame (max 4 buttons).
 - `image`: An image which must be smaller than 10MB and should have an aspect ratio of 1.91:1
-- `post_url`: A valid POST URL to send the Signature Packet to. 
+- `post_url`: A valid POST URL to send the Signature Packet to.

package.json

@@ -4,6 +4,7 @@
   "repository": "https://github.com/coinbase/onchainkit.git",
   "license": "MIT",
   "dependencies": {
+    "@farcaster/hub-nodejs": "0.10.21",
     "react": "^18",
     "viem": "2.5.0"
   },

src/core/getFrameAccountAddress.ts

@@ -0,0 +1,53 @@
+import { HubRpcClient, Message, getSSLHubRpcClient } from '@farcaster/hub-nodejs';
+
+// URL of the Hub
+const HUB_URL = 'nemes.farcaster.xyz:2283';
+// Create a Hub RPC client
+const client: HubRpcClient = getSSLHubRpcClient(HUB_URL);
+
+type FidResponse = {
+  verifications: string[];
+};
+
+/**
+ * Get the Account Address from the Farcaster ID using the Frame.
+ * @param body
+ * @param param1
+ * @returns 
+ */
+async function getFrameAccountAddress(
+  body: { trustedData?: { messageBytes?: string } },
+  { NEYNAR_API_KEY = 'NEYNAR_API_DOCS' },
+) {
+  let farcasterID = 0;
+  let validatedMessage: Message | undefined = undefined;
+  // Get the message from the request body
+  const frameMessage: Message = Message.decode(
+    Buffer.from(body?.trustedData?.messageBytes ?? '', 'hex'),
+  );
+  // Validate the message
+  const result = await client.validateMessage(frameMessage);
+  if (result.isOk() && result.value.valid && result.value.message) {
+    validatedMessage = result.value.message;
+  }
+  // Get the Farcaster ID from the message
+  farcasterID = validatedMessage?.data?.fid ?? 0;
+  // Get the user verifications from the Farcaster Indexer
+  const options = {
+    method: 'GET',
+    url: `https://api.neynar.com/v2/farcaster/user/bulk?fids=${farcasterID}`,
+    headers: { accept: 'application/json', api_key: NEYNAR_API_KEY },
+  };
+  const resp = await fetch(options.url, { headers: options.headers });
+  const responseBody = await resp.json();
+  // Get the user verifications from the response
+  if (responseBody.users) {
+    const userVerifications = responseBody.users[0] as FidResponse;
+    if (userVerifications.verifications) {
+      return userVerifications.verifications[0];
+    }
+  }
+  return '0x00';
+}
+
+export { getFrameAccountAddress };

src/index.ts

@@ -1,5 +1,6 @@
 // ☕️
-const version = '0.1.2';
+const version = '0.1.4';
 
-// TODO remove this line from here
+export { version };
+export { getFrameAccountAddress } from './core/getFrameAccountAddress';
 export { getFrameMetadata } from './core/getFrameMetadata';