Skip to content
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
2 changes: 1 addition & 1 deletion docs/auth-kit/client/app/create-channel.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ const channel = await appClient.createChannel({
| `nonce` | `string` | A custom nonce. Must be at least 8 alphanumeric characters. | No | `ESsxs6MaFio7OvqWb` |
| `notBefore` | `string` | Start time at which the signature becomes valid. ISO 8601 datetime. | No | `2023-12-20T23:21:24.917Z` |
| `expirationTime` | `string` | Expiration time at which the signature is no longer valid. ISO 8601 datetime. | No | `2023-12-20T23:21:24.917Z` |
| `requestId` | `string` | A system specific ID your app can use to refer to the sign in request. | No | `8d0494d9-e0cf-402b-ab0a-394ac7fe07a0` |
| `requestId` | `string` | A system specific ID your app can use to refer to the sign-in request. | No | `8d0494d9-e0cf-402b-ab0a-394ac7fe07a0` |
| `acceptAuthAddress` | `boolean` | Whether your application accepts signatures from an [auth address](https://github.com/farcasterxyz/protocol/discussions/225). | No | `true` |

## Returns
Expand Down
6 changes: 3 additions & 3 deletions docs/auth-kit/hooks/use-sign-in.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# `useSignIn`

Hook for signing in a user. Connects to the relay server, generates a sign in link to present to the user, and polls the relay server for the user's Farcaster wallet signature.
Hook for signing in a user. Connects to the relay server, generates a sign-in link to present to the user, and polls the relay server for the user's Farcaster wallet signature.

If you want to build your own sign in component with a custom UI, use the `useSignIn` hook.
If you want to build your own sign-in component with a custom UI, use the `useSignIn` hook.

```tsx
import { useSignIn, QRCode } from '@farcaster/auth-kit';
Expand Down Expand Up @@ -40,7 +40,7 @@ function App() {
| `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 |
| `onSuccess` | `function` | Callback invoked when sign in is complete and the user is authenticated. | 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
2 changes: 1 addition & 1 deletion docs/developers/frames/advanced.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ like `https://example.xyz/eth-price.png`. When a GET request is made to this end

We recommend setting a non-zero `max-age` so that the image can get cached and
served from CDNs, otherwise users will see a gray image in their feed while the
dynamic image is generated and loads. The exact time depends on your
dynamic image is generated and loaded. The exact time depends on your
application but opt for the longest time that still keeps the image reasonably
fresh.

Expand Down
2 changes: 1 addition & 1 deletion docs/developers/frames/best-practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: Frame Best Practices
Learn best practices for building great Frame experiences.

::: info
These best practices assume a prior knowledge of Frames. If you're looking for
These best practices assume prior knowledge of Frames. If you're looking for
general information about building Frames check out these resources:

- [Getting Started](./getting-started)
Expand Down
2 changes: 1 addition & 1 deletion docs/developers/frames/spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ The `target` property must be a valid `CAIP-10` address, plus an optional token
/>
```

The `tx` action allows a frame to request the user takes an action in their connected wallet. Unlike other action types, `tx` actions have multiple steps.
The `tx` action allows a frame to request that the user takes an action in their connected wallet. Unlike other action types, `tx` actions have multiple steps.

First, the client makes a POST request to the `target` URL to fetch data about the wallet action. The frame server receives a Signature Packet in the POST body, including the address of the connected wallet. The frame server must respond with a 200 OK and a JSON response describing the wallet action:

Expand Down
2 changes: 1 addition & 1 deletion docs/developers/guides/accounts/change-custody.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Change custody address

Accounts are owned by custody address which is an Ethereum address on OP Mainnet.
Accounts are owned by a custody address which is an Ethereum address on OP Mainnet.

A user may want to change this address for security reasons or to transfer ownership of the entire account.

Expand Down
2 changes: 1 addition & 1 deletion docs/developers/guides/accounts/create-account-key.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ if (accountKeyResult.isOk()) {
### 5. Collect an `Add` signature from the user.

Collect an EIP-712 `Add` signature from the user to authorize adding an account key to their FID. In a real world app,
you'll likely collect this signature on your frontend, from the user's wallet. In a frontend context, you can us a `ViemEip712WalletSigner` to connect to a browser wallet rather than a local signer.
you'll likely collect this signature on your frontend, from the user's wallet. In a frontend context, you can use a `ViemEip712WalletSigner` to connect to a browser wallet rather than a local signer.

```ts
if (signedKeyRequestMetadata.isOk()) {
Expand Down
2 changes: 1 addition & 1 deletion docs/developers/guides/accounts/register-ens.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Register ENS Name

A user can set their farcaster username to an ENS name they own.
A user can set their Farcaster username to an ENS name they own.

### Requirements

Expand Down
2 changes: 1 addition & 1 deletion docs/developers/guides/apps/feed.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ if (castsResult.isErr()) {

## 4. Function to pretty print a cast

The raw cast data is not very readable. We'll write a function to convert the timestamp to a human readable format, and
The raw cast data is not very readable. We'll write a function to convert the timestamp to a human-readable format, and
also resolve any mentions (only stored as fids and their location within the cast) to their fnames.

```typescript
Expand Down
2 changes: 1 addition & 1 deletion docs/developers/guides/basics/hello-world.md
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,7 @@ const registerFname = async (fid: number) => {
const fname = await registerFname(fid);
```

Note that this only associated the name to our fid, we still need to set it as our username.
Note that this only associates the name to our fid, we still need to set it as our username.

## 5. Write to the hub

Expand Down
2 changes: 1 addition & 1 deletion docs/developers/guides/writing/casts.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ const castWithEmojiAndMentions = await makeCastAdd(

A cast can be a reply to another cast, URL or NFT. A reply to another cast is treated as a thread, while a reply to a URL or NFT can be treated as a comment or a [channel](#channels).

The optional parentUrl property can be set to a URL or to an fid-hash value of the cast being replied to, as shown in th example below. See [FIP-2](https://github.com/farcasterxyz/protocol/discussions/71) for more details on reply types.
The optional parentUrl property can be set to a URL or to an fid-hash value of the cast being replied to, as shown in the example below. See [FIP-2](https://github.com/farcasterxyz/protocol/discussions/71) for more details on reply types.

```typescript
/**
Expand Down