Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Correct text #333

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -388,7 +388,6 @@ export default defineConfig({
text: 'verifySignInMessage',
link: '/auth-kit/client/app/verify-sign-in-message',
},
,
],
},
{
Expand Down
4 changes: 2 additions & 2 deletions docs/.vitepress/theme/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@
* The primitive colors used for accent colors. These colors are referenced
* by functional colors such as "Text", "Background", or "Brand".
*
* Each colors have exact same color scale system with 3 levels of solid
* Each color have exact same color scale system with 3 levels of solid
* colors with different brightness, and 1 soft color.
*
* - `XXX-1`: The most solid color used mainly for colored text. It must
* satisfy the contrast ratio against when used on top of `XXX-soft`.
* satisfy the contrast ratio when used on top of `XXX-soft`.
*
* - `XXX-2`: The color used mainly for hover state of the button.
*
Expand Down
6 changes: 3 additions & 3 deletions docs/auth-kit/hooks/use-sign-in-message.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# `useSignInMessage`

Hook for reading the Sign in With Farcaster message and signature used to authenticate the user.
Hook for reading the Sign In With Farcaster message and signature used to authenticate the user.

If you're providing the message and signature to a backend API, you may want to use this hook.

Expand All @@ -12,8 +12,8 @@ function App() {

return (
<div>
<p>You signed: {message}</p>
<p>Your signature: {signature}</p>
<p>You signed in with: {message}</p>
<p>Your signed message: {signature}</p>
</div>
);
}
Expand Down
8 changes: 4 additions & 4 deletions docs/auth-kit/hooks/use-sign-in.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,9 @@ function App() {
| `timeout` | `number` | Return an error after polling for this long. | `300_000` (5 minutes) |
| `interval` | `number` | Poll the relay server for updates at this interval. | `1500` (1.5 seconds) |
| `nonce` | `string` | A random nonce to include in the Sign In With Farcaster message. | None |
| `notBefore` | `string` | Time when the SIWF message becomes valid. ISO 8601 datetime string. | None |
| `expirationTime` | `string` | Time when the SIWF message expires. ISO 8601 datetime string. | None |
| `requestId` | `string` | An optional system-specific ID to include in the SIWF message. | None |
| `notBefore` | `string` | Time when the SIWE message becomes valid. ISO 8601 datetime string. | None |
| `expirationTime` | `string` | Time when the SIWE message expires. ISO 8601 datetime string. | None |
| `requestId` | `string` | An optional system-specific ID to include in the SIWE message. | None |
| `onSuccess` | `function` | Callback invoked when sign in is complete and the user is authenticated. | None |
| `onStatusResponse` | `function` | Callback invoked when the component receives a status update from the relay server. | None |
| `onError` | `function` | Error callback function. | None |
Expand Down Expand Up @@ -80,7 +80,7 @@ function App() {
| Parameter | Description |
| -------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| `signIn` | Call this function following `connect` to begin polling for a signature. |
| `signOut` | Call this function to clear the AuthKit state and sign out the user. |
| `signOut` | Call this function to clear the Auth client state and sign out the user. |
| `connect` | Connect to the auth relay and create a channel. |
| `reconnect` | Reconnect to the relay and try again. Call this in the event of an error. |
| `isConnected` | True if AuthKit is connected to the relay server and has an active channel. |
Expand Down
4 changes: 2 additions & 2 deletions docs/developers/frames/spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -403,7 +403,7 @@ A signature packet is a JSON object sent to the Frame server when a button is cl

1. **Signed Message** — an authenticated protobuf that represents the user action. This message must be unpacked by a farcaster hub to read the data inside.

2. **Unsigned Message** — an unathenticated JSON object that represents the user action. can be read directly.
2. **Unsigned Message** — an unauthenticated JSON object that represents the user action. can be read directly.

::: warning
Unsigned messages can be spoofed and should usually be ignored. It is only safe to use them if you are performing an unauthenticated request.
Expand All @@ -415,7 +415,7 @@ If you are unsure, always read the signed message by sending it into the `valida
{
"untrustedData": {
"fid": 2,
"url": "https://fcpolls.com/polls/1",
"URL": "https://fcpolls.com/polls/1",
"messageHash": "0xd2b1ddc6c88e865a33cb1a565e0058d757042974",
"timestamp": 1706243218,
"network": 1,
Expand Down