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

Commit

Permalink
fix: typos (#826)
Browse files Browse the repository at this point in the history
* fix: typo

* fix: typo

* fix: typos

* fix: typos

* fix: typos

* fix: typos

* Update Pack.md

---------

Co-authored-by: ciaranightingale <[email protected]>
  • Loading branch information
omahs and ciaranightingale authored Sep 20, 2023
1 parent bbebc84 commit 62b1dca
Show file tree
Hide file tree
Showing 6 changed files with 9 additions and 9 deletions.
4 changes: 2 additions & 2 deletions docs/contracts/IMarketplace.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ Lets a direct listing creator cancel their listing.
function closeAuction(uint256 _listingId, address _closeFor) external nonpayable
```

Lets any account close an auction on behalf of either the (1) auction&#39;s creator, or (2) winning bidder. For (1): The auction creator is sent the the winning bid amount. For (2): The winning bidder is sent the auctioned NFTs.
Lets any account close an auction on behalf of either the (1) auction&#39;s creator, or (2) winning bidder. For (1): The auction creator is sent the winning bid amount. For (2): The winning bidder is sent the auctioned NFTs.

#### Parameters

Expand Down Expand Up @@ -152,7 +152,7 @@ function offer(uint256 _listingId, uint256 _quantityWanted, address _currency, u

Lets someone make an offer to a direct listing, or bid in an auction.

_Each (address, listing ID) pair maps to a single unique offer. So e.g. if a buyer makes makes two offers to the same direct listing, the last offer is counted as the buyer&#39;s offer to that listing._
_Each (address, listing ID) pair maps to a single unique offer. So e.g. if a buyer makes two offers to the same direct listing, the last offer is counted as the buyer&#39;s offer to that listing._

#### Parameters

Expand Down
4 changes: 2 additions & 2 deletions docs/contracts/design/Marketplace-v3.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The document is written for technical and non-technical readers. To ask further

## Background

The [thirdweb](https://thirdweb.com/) `Marketplace V3` is a marketplace where where people can sell NFTs — [ERC 721](https://eips.ethereum.org/EIPS/eip-721) or [ERC 1155](https://eips.ethereum.org/EIPS/eip-1155) tokens — at a fixed price ( what we'll refer to as a "Direct listing"), or auction them (what we'll refer to as an "Auction listing"). It also allows users to make "Offers" on unlisted NFTs.
The [thirdweb](https://thirdweb.com/) `Marketplace V3` is a marketplace where people can sell NFTs — [ERC 721](https://eips.ethereum.org/EIPS/eip-721) or [ERC 1155](https://eips.ethereum.org/EIPS/eip-1155) tokens — at a fixed price ( what we'll refer to as a "Direct listing"), or auction them (what we'll refer to as an "Auction listing"). It also allows users to make "Offers" on unlisted NFTs.

`Marketplace V3` offers improvements over previous version in terms of design and features, which are discussed in this document. You can refer to previous (v2) `Marketplace` design document [here](https://github.com/thirdweb-dev/contracts/blob/main/contracts/old-marketplace/marketplace.md).

Expand All @@ -20,7 +20,7 @@ We have given `Marketplace` an update that was long overdue. The marketplace pro
2. Auctioning off NFTs.
3. Making offers for NFTs not on sale at all, or at favorable prices.

The core improvement about the `Marketplace V3` smart contract is better developer experience of working with the contract.
The core improvement of the `Marketplace V3` smart contract is better developer experience of working with the contract.

Previous version had some limitations, arising due to (1) the smart contract size limit of `~24.576 kb` on Ethereum mainnet (and other thirdweb supported chains), and (2) the way the smart contract code is organized (single, large smart contract that inherits other contracts). The previous `Marketplace` smart contract has functions that have multiple jobs, behave in many different ways under different circumstances, and a lack of convenient view functions to read data easily.

Expand Down
2 changes: 1 addition & 1 deletion docs/contracts/design/Multiwrap.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The single wrapped token received on bundling up multiple assets, as mentioned a

A token owner should be able to wrap any combination of _n_ ERC20, ERC721 or ERC1155 tokens as a wrapped NFT. When wrapping, the token owner should be able to specify a recipient for the wrapped NFT. At the time of wrapping, the token owner should be able to set the metadata of the wrapped NFT that will be minted.

The wrapped NFT owner should be able to unwrap the the NFT to retrieve the underlying tokens of the wrapped NFT. At the time of unwrapping, the wrapped NFT owner should be able to specify a recipient for the underlying tokens of the wrapped NFT.
The wrapped NFT owner should be able to unwrap the NFT to retrieve the underlying tokens of the wrapped NFT. At the time of unwrapping, the wrapped NFT owner should be able to specify a recipient for the underlying tokens of the wrapped NFT.

The `Multiwrap` contract creator should be able to apply the following role-based restrictions:

Expand Down
4 changes: 2 additions & 2 deletions docs/contracts/design/Pack.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ We’ll now go over the technical details of the `Pack` contract, with reference

## What can be packed in packs?

You can create a set of packs with any combination of any number of ERC20, ERC721 and ERC1155 tokens. For example, you can create a set of packs with 10,000 [USDC](https://www.circle.com/en/usdc) (ERC20), 1 [Bored Ape Yatch Club](https://opensea.io/collection/boredapeyachtclub) NFT (ERC721), and 50 of [adidas originals’ first NFT](https://opensea.io/assets/0x28472a58a490c5e09a238847f66a68a47cc76f0f/0) (ERC1155).
You can create a set of packs with any combination of any number of ERC20, ERC721 and ERC1155 tokens. For example, you can create a set of packs with 10,000 [USDC](https://www.circle.com/en/usdc) (ERC20), 1 [Bored Ape Yacht Club](https://opensea.io/collection/boredapeyachtclub) NFT (ERC721), and 50 of [adidas originals’ first NFT](https://opensea.io/assets/0x28472a58a490c5e09a238847f66a68a47cc76f0f/0) (ERC1155).

With strictly non-fungible tokens i.e. ERC721 NFTs, each NFT has a supply of 1. This means if a pack is opened and an ERC721 NFT is selected by the `Pack` contract to be distributed to the opener, that 1 NFT will be distributed to the opener.

Expand All @@ -79,7 +79,7 @@ uint256 perUnitAmount;
| ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| assetContract | The contract address of the token. |
| tokenType | The type of the token -- ERC20 / ERC721 / ERC1155 |
| tokenId | The tokenId of the the token. (Not applicable for ERC20 tokens. The contract will ignore this value for ERC20 tokens.) |
| tokenId | The tokenId of the token. (Not applicable for ERC20 tokens. The contract will ignore this value for ERC20 tokens.) |
| totalAmount | The total amount of this token packed in the pack. (Not applicable for ERC721 tokens. The contract will always consider this as 1 for ERC721 tokens.) |
| perUnitAmount | The amount of this token to distribute as a unit, on opening a pack. (Not applicable for ERC721 tokens. The contract will always consider this as 1 for ERC721 tokens.) |

Expand Down
2 changes: 1 addition & 1 deletion docs/react/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ No additional configuration is required if you are using the [pages router](http

If you are using the new [app router](https://nextjs.org/docs/app), and If you import a component such as `ThirdwebProvider` in a server component, Next.js will throw an error saying that the component is not marked with `"use client"` directive.

You will need to create an alias for the that component in a separate file with `"use client"` directive on top (before all the imports) and import that instead of using the the component directly from `@thirdweb-dev/react` in server components.
You will need to create an alias for that component in a separate file with `"use client"` directive on top (before all the imports) and import that instead of using the component directly from `@thirdweb-dev/react` in server components.

#### Example

Expand Down
2 changes: 1 addition & 1 deletion docs/typescript/wallet/signTypedData.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Create a typed data structure and message to be signed (for more information, se

This will prompt the user to sign the structured message from their wallet (or sign it automatically if [initialized with a private key](/typescript/sdk.thirdwebsdk.fromprivatekey)).

Once signed, the the payload and its associated signature are returned.
Once signed, the payload and its associated signature are returned.

```javascript
// An example message to ask the user to sign
Expand Down

1 comment on commit 62b1dca

@vercel
Copy link

@vercel vercel bot commented on 62b1dca Sep 20, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.