Skip to content
This repository has been archived by the owner on Sep 19, 2024. It is now read-only.

Docs rectify typographical inaccuracies #177

Open
wants to merge 7 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
4 changes: 2 additions & 2 deletions docs/developer-tools/nft-hooks/usenftcontent.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ sidebar_position: 4
This hook makes a request to fetch content (image, video, etc) based on an NFT's metadata.

Most metadata servers allow remote JSON fetches. However, there is a chance this request could fail.
Requests are set with a 10 second timeout to allow showing the user
Requests are set with a 10-second timeout to allow showing the user
an error message instead of an indefinite loader.

:::note
Expand All @@ -28,7 +28,7 @@ You can learn more about MIME types [here](https://developer.mozilla.org/en-US/d
If you do not have access to `mimeType` from the metadata or do not wish to retrieve the metadata, it
can be omitted with a small performance impact.

Content returned from this hook is **NOT CACHED**, meaning that each time the hook is used the content will be fetched.
The content returned from this hook is **NOT CACHED**, meaning that each time the hook is used the content will be fetched.

```ts
/**
Expand Down
6 changes: 3 additions & 3 deletions docs/developer-tools/nft-hooks/usenftmetadata.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ sidebar_position: 3
This hook makes a request to fetch metadata from an NFT's `metadataURI`.

Most metadata servers allow for remote JSON fetches, however, there is a chance this request could fail.
Requests are set with a 10 second timeout to allow showing the user an error message
Requests are set with a 10-second timeout to allow showing the user an error message
instead of an indefinite loader.

:::note
Expand Down Expand Up @@ -83,9 +83,9 @@ import { MediaFetchAgent, Networks } from '@zoralabs/nft-hooks'
// Each instance contains a different request cache.
const fetchAgent = new MediaFetchAgent(Networks.MAINNET)

// Get result from the server
// Get results from the server
const result = await fetchAgent.fetchIPFSMetadata('https://ipfs.io/ipfs/METADATA_HASH')
// result type is {metadata}
```

<br/>
<br/>
2 changes: 1 addition & 1 deletion docs/guides/api-address-balance.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ query JacobsNFTs {
"metadata": {
"image": "https://api.blitmap.com/v1/png/393",
"name": "#393 - Wave Logo",
"description": "Blitmap is a community crafted art collection and universe. All data is completely on chain.\n\n[blitmap.com](https://www.blitmap.com)",
"description": "Blitmap is a community-crafted art collection and universe. All data is completely on chain.\n\n[blitmap.com](https://www.blitmap.com)",
"attributes": [
{
"trait_type": "Type",
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/api-collection-data.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -219,7 +219,7 @@ query FirstMonarchMinted {
One thing to call out is that sometimes collections will airdrop their tokens to people to trick certain interfaces into making it look like that address minted from the collection.
A way to prevent this is to compare the `originatorAddress` with the `toAddress`.

The `originatorAddress` is the address that submitted the transaction and the `toAddress` is the address where the minted NFT was sent to in the transaction.
The `originatorAddress` is the address that submitted the transaction and the `toAddress` is the address where the minted NFT was sent in the transaction.
:::

However, if we set the `tokenId` in `where` to 20 we can view the 21st Monarch minted and see that it was [minted for 0.8 ETH](https://etherscan.io/tx/0x07d236e70c1647f1d8504df7ea74435c01b276e2effe54b1df463a2ea7c76235).
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/builder-deployment.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ For example, a DAO with a symbol of `NOUN` would have NFTs named `NOUN #1`, `NOU
---

## Auction Settings
Next, you will need to configure your auction settings. Keep in mind, a new DAO NFT is minted every time an auction is started.
Next, you will need to configure your auction settings. Keep in mind, that a new DAO NFT is minted every time an auction is started.


- `Duration:` How long an auction runs for
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/builder-protocol-rewards.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ _Diagram for Builder Protocol Rewards_
Builder DAO, the DAO responsible for developing and maintaining the protocol, receives this reward. Learn more about Builder DAO [here](https://nouns.build/dao/ethereum/0xdf9b7d26c8fc806b1ae6273684556761ff02d422/407?tab=about).

2. **Referral Reward** - 2.5%
The referral reward goes to the client that facilitates the auction.
The referral reward goes to the client who facilitates the auction.

Examples:

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/v3-approvals.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The ZORA core contracts include **Token Transfer Helpers** and the **Module Mana
Before interacting with specific modules, there are a few approval steps that are required.
First, any assets that are going to be moved by ZORA must have their respective Transfer Helper approved to the token contract.
For example, if you would like to sell an NFT, the ERC-721 Transfer Helper address must be approved to the NFT contract as an operator.
Second, once the assets have been approved to the Transfer Helpers, the necessary modules must be approved in the Module Manager by the user.
Second, once the assets have been approved by the Transfer Helpers, the necessary modules must be approved in the Module Manager by the user.

##### Approval Steps
1. Approve Tokens to the Transfer Helpers
Expand Down