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

Fix typos and improve consistency across documentation files #2408

Closed
wants to merge 5 commits into from
Closed
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
12 changes: 6 additions & 6 deletions packages/hub-nodejs/docs/Events.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Emitted by contracts whenever the ownership of fids or fnames changes.

### IdRegistryEvent

Emit when an onchain event occurs in the IdRegistry which registers or transfers an fid.
Emit when an onchain event occurs in the IdRegistry which registers or transfers a fid.

| Name | Type | Description |
| --------------- | --------------------------- | -------------------------------------------------------- |
Expand All @@ -79,7 +79,7 @@ Emit when an onchain event occurs in the IdRegistry which registers or transfers

### NameRegistryEvent

Emit when an onchain event occurs in the NameRegistry which registers, transfers or renews an fname.
Emit when an onchain event occurs in the NameRegistry which registers, transfers or renews a fname.

| Name | Type | Description |
| --------------- | ------------------------------------------------- | -------------------------------------------------------- |
Expand All @@ -105,8 +105,8 @@ The Farcaster network that will accept the message.
| HUB_EVENT_TYPE_MERGE_MESSAGE | 1 | A message was merged into the Hub |
| HUB_EVENT_TYPE_PRUNE_MESSAGE | 2 | A message was pruned because a limit was exceeded |
| HUB_EVENT_TYPE_REVOKE_MESSAGE | 3 | A message was revoked by a user |
| HUB_EVENT_TYPE_MERGE_ID_REGISTRY_EVENT | 4 | An fid was issued or transferred. |
| HUB_EVENT_TYPE_MERGE_NAME_REGISTRY_EVENT | 5 | An fname was issued, transferred or renewed. |
| HUB_EVENT_TYPE_MERGE_ID_REGISTRY_EVENT | 4 | A fid was issued or transferred. |
| HUB_EVENT_TYPE_MERGE_NAME_REGISTRY_EVENT | 5 | A fname was issued, transferred or renewed. |

### IdRegistryEventType

Expand All @@ -121,5 +121,5 @@ The Farcaster network that will accept the message.
| Name | Number | Description |
| --------------------------------- | ------ | ----------------------------------- |
| NAME_REGISTRY_EVENT_TYPE_NONE | 0 | |
| NAME_REGISTRY_EVENT_TYPE_TRANSFER | 1 | An fname was minted or transferred. |
| NAME_REGISTRY_EVENT_TYPE_RENEW | 1 | An fname was renewed. |
| NAME_REGISTRY_EVENT_TYPE_TRANSFER | 1 | A fname was minted or transferred. |
| NAME_REGISTRY_EVENT_TYPE_RENEW | 1 | A fname was renewed. |
2 changes: 1 addition & 1 deletion packages/hub-nodejs/docs/signers/ViemLocalEip712Signer.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# ViemLocalEip712Signer

An Eip712Signer that is initialized with an [Viem](https://viem.sh/docs/getting-started) LocalACcount and can be used with [Builders](../builders/builders.md) to sign Farcaster Messages.
A Eip712Signer that is initialized with a [Viem](https://viem.sh/docs/getting-started) LocalAсcount and can be used with [Builders](../builders/builders.md) to sign Farcaster Messages.

## Properties

Expand Down
2 changes: 1 addition & 1 deletion packages/hub-nodejs/examples/contract-signatures/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This example app demonstrates how to create and use EIP-712 signatures to sponso

Every onchain action in the Farcaster protocol can be performed by a third party on behalf of the end user by collecting a typed signature and providing it to the Farcaster smart contracts. This makes it possible to pay gas and sponsor onchain transactions for your users without asking them to pay a fee or send a transaction from their wallet.

The structured format of EIP-712 signatures makes them more secure for the end user and easier for wallets to parse, but they can be difficult to construct and work with as an application developer. This demo app shows how to call every signature based function in the Farcaster contracts, including registering an account, transferring an fid, and adding/removing signer keys.
The structured format of EIP-712 signatures makes them more secure for the end user and easier for wallets to parse, but they can be difficult to construct and work with as an application developer. This demo app shows how to call every signature based function in the Farcaster contracts, including registering an account, transferring a fid, and adding/removing signer keys.

This example uses [Hardhat](https://hardhat.org/) to run a local node that simulates OP Mainnet, where the Farcaster contracts are deployed.

Expand Down
4 changes: 2 additions & 2 deletions packages/hub-nodejs/examples/hello-world/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Given a custody address with ~10$ worth of funds on OP Mainnet, this example wil
- Register an FID on the IdRegistry contract
- Purchase 1 unit of storage on the StorageContract
- Create a signer on the KeyRegistry contract
- Register an fname on the fname registry server
- Register a fname on the fname registry server
- Update the user's profile

### Run on StackBlitz
Expand All @@ -20,4 +20,4 @@ You can try out a web version of this at https://farcaster-signup-demo-wkulikows
1. Clone the repo locally
2. Navigate to this folder with `cd packages/hub-nodejs/examples/write-data`
3. Run `yarn install` to install dependencies
4. Run `yarn start`
4. Run `yarn start`