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

improve clarity #377

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
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/learn/what-is-farcaster/channels.md
Original file line number Diff line number Diff line change
@@ -10,7 +10,7 @@ Channels are being prototyped in Warpcast and not fully supported by the Farcast

## Hosting Channels

Anyone can create a channel host by paying a fee in Warpcast and choosing a channel name. The name must be under 16 characters and can only contain lowercase alphabets and numbers. A channel's creator is called a host and may invite other co-hosts to operate the channel. Hosts have special privileges like:
Anyone can create a channel host by paying a fee in Warpcast and choosing a channel name. The name must be under 16 characters and can only contain lowercase letters and numbers. A channel's creator is called a host and may invite other co-hosts to operate the channel. Hosts have special privileges like:

1. Defining “channel norms" which everyone must agree to when joining.
2. Pinning or hiding casts in a channel.
2 changes: 1 addition & 1 deletion docs/learn/what-is-farcaster/messages.md
Original file line number Diff line number Diff line change
@@ -4,7 +4,7 @@ Farcaster accounts interact by signing and publishing messages. Alice can create

Messages are stored on a peer-to-peer network of nodes. A node in the Farcaster network is called a Hub, and each Hub stores a copy of the entire network. A user can publish a message to one Hub and it will propagate to the entire network in a few seconds. Farcaster's compact message format and eventually consistent model lets this architecture scale to millions of users.

An account can generate a [key](./accounts.md#adding-account-keys) and give it to an app which can use it to sign messages. Users can use multiple apps with the same account, and each application can have its own key. Separating the signing keys from the ownership keys helps keep the account secure.
An account can generate a [key](./accounts.md#adding-account-keys) and give it to an app that can use it to sign messages. Users can use multiple apps with the same account, and each application can have its own key. Separating the signing keys from the ownership keys helps keep the account secure.

## Types

6 changes: 3 additions & 3 deletions docs/reference/hubble/datatypes/events.md
Original file line number Diff line number Diff line change
@@ -2,9 +2,9 @@

Events represent state changes, like a new message or contract event.

Hubble emit events whenever it observes a state change. Since a hub may see messages in a different order than other hubs, events ordering is specific to each hub. Clients can subscribe to the hub using the [Events API](/reference/hubble/grpcapi/events) to get a live stream of changes to the hub.
Hubble emits events whenever it observes a state change. Since a hub may see messages in a different order than other hubs, events ordering is specific to each hub. Clients can subscribe to the hub using the [Events API](/reference/hubble/grpcapi/events) to get a live stream of changes to the hub.

Hubble keeps event around for 3 days after which they are deleted to save space. To get older data, use the [GRPC](../grpcapi/grpcapi.md) or [HTTP](../httpapi/httpapi.md) APIs.
Hubble keeps events around for 3 days after which they are deleted to save space. To get older data, use the [GRPC](../grpcapi/grpcapi.md) or [HTTP](../httpapi/httpapi.md) APIs.

## HubEvent

@@ -135,7 +135,7 @@ Hubble keeps event around for 3 days after which they are deleted to save space.

| Field | Type | Label | Description |
| --------------- | ------------------------------------------- | ----- | ------------------------------------------------ |
| to | [bytes](#) | | The address the fid was registers/transferred to |
| to | [bytes](#) | | The address the fid was registered/transferred to |
| event_type | [IdRegisterEventType](#IdRegisterEventType) | | The type of the id register event |
| from | [bytes](#) | | The address the transfer originated from |
| recover_address | [bytes](#) | | The recovery address for the fid |