-
Notifications
You must be signed in to change notification settings - Fork 99
Expand file tree
/
Copy pathvalidateFrameMessage.ts
More file actions
86 lines (76 loc) · 2.2 KB
/
Copy pathvalidateFrameMessage.ts
File metadata and controls
86 lines (76 loc) · 2.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
import type { FrameActionPayload, HubHttpUrlOptions } from "./types";
import { hexStringToUint8Array } from "./utils";
import { DEFAULT_HUB_API_KEY, DEFAULT_HUB_API_URL } from "./default";
import type { FrameActionMessage } from "./farcaster";
import { Message } from "./farcaster";
type ValidateMessageJson = {
valid: boolean;
message: Message;
};
function isValidateMessageJson(value: unknown): value is ValidateMessageJson {
if (typeof value !== "object" || !value) {
return false;
}
const validateMessageJson = value as ValidateMessageJson;
return (
typeof validateMessageJson.valid === "boolean" &&
validateMessageJson.valid &&
typeof validateMessageJson.message === "object"
);
}
/**
* @returns a Promise that resolves with whether the message signature is valid, by querying a Farcaster hub, as well as the message itself
*/
export async function validateFrameMessage(
body: FrameActionPayload,
{
hubHttpUrl = DEFAULT_HUB_API_URL,
hubRequestOptions = {
headers: {
api_key: DEFAULT_HUB_API_KEY,
},
},
}: HubHttpUrlOptions = {}
): Promise<{
isValid: boolean;
message: FrameActionMessage | undefined;
}> {
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition -- just in case
if (!body) {
throw new Error(
"Tried to call validateFrameMessage with no frame action payload. You may be calling it incorrectly on the homeframe"
);
}
const { headers, ...rest } = hubRequestOptions;
const validateMessageResponse = await fetch(
`${hubHttpUrl}/v1/validateMessage`,
{
method: "POST",
headers: {
"Content-Type": "application/octet-stream",
...headers,
},
body: hexStringToUint8Array(body.trustedData.messageBytes),
...rest,
}
);
const validateMessageJson: unknown = await validateMessageResponse.json();
if (!isValidateMessageJson(validateMessageJson)) {
return {
isValid: false,
message: undefined,
};
}
if (validateMessageJson.valid) {
return {
isValid: true,
message: Message.fromJSON(
validateMessageJson.message
) as FrameActionMessage,
};
}
return {
isValid: false,
message: undefined,
};
}