Skip to content
This repository was archived by the owner on Aug 30, 2022. It is now read-only.

Improve docs for NFTContract type #97

Merged
jnsdls merged 9 commits into from
Jun 28, 2022
Merged

Improve docs for NFTContract type #97

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
37b56f2
v2.3.13
nachoiacovino Jun 2, 2022
231f6b8
Merge branch 'main' of https://github.com/thirdweb-dev/react
nachoiacovino Jun 7, 2022
a65219c
Merge branch 'main' of https://github.com/thirdweb-dev/react
nachoiacovino Jun 13, 2022
fc1dfa4
Merge branch 'main' of https://github.com/thirdweb-dev/react
nachoiacovino Jun 14, 2022
a167fce
Merge branch 'main' of https://github.com/thirdweb-dev/react
nachoiacovino Jun 14, 2022
bc865f2
Merge branch 'main' of https://github.com/thirdweb-dev/react
nachoiacovino Jun 16, 2022
c24881a
Merge branch 'main' of https://github.com/thirdweb-dev/react
nachoiacovino Jun 23, 2022
379d319
Merge branch 'main' of https://github.com/thirdweb-dev/react
nachoiacovino Jun 27, 2022
9774361
Improve docs for NFTContract
nachoiacovino Jun 28, 2022
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/react.useactivelistings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ export declare function useActiveListings(contract: RequiredParam<Marketplace>,

| Parameter | Type | Description |
| --- | --- | --- |
| contract | [RequiredParam](./react.requiredparam.md)<!-- -->&lt;Marketplace&gt; | an instace of a marketplace contract |
| contract | [RequiredParam](./react.requiredparam.md)<!-- -->&lt;Marketplace&gt; | an instance of a marketplace contract |
| filter | MarketplaceFilter | <i>(Optional)</i> filter to pass to the query for the sake of pagination &amp; filtering |

<b>Returns:</b>
Expand Down
2 changes: 1 addition & 1 deletion docs/react.useauctionwinner.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ export declare function useAuctionWinner(contract: RequiredParam<Marketplace>, l

| Parameter | Type | Description |
| --- | --- | --- |
| contract | [RequiredParam](./react.requiredparam.md)<!-- -->&lt;Marketplace&gt; | an instace of a marketplace contract |
| contract | [RequiredParam](./react.requiredparam.md)<!-- -->&lt;Marketplace&gt; | an instance of a marketplace contract |
| listingId | [RequiredParam](./react.requiredparam.md)<!-- -->&lt;BigNumberish&gt; | the listing id to check |

<b>Returns:</b>
Expand Down
2 changes: 1 addition & 1 deletion docs/react.usebidbuffer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ export declare function useBidBuffer(contract: RequiredParam<Marketplace>): impo

| Parameter | Type | Description |
| --- | --- | --- |
| contract | [RequiredParam](./react.requiredparam.md)<!-- -->&lt;Marketplace&gt; | an instace of a marketplace contract |
| contract | [RequiredParam](./react.requiredparam.md)<!-- -->&lt;Marketplace&gt; | an instance of a marketplace contract |

<b>Returns:</b>

Expand Down
2 changes: 1 addition & 1 deletion docs/react.usebuynow.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ export declare function useBuyNow(contract: RequiredParam<Marketplace>): import(

| Parameter | Type | Description |
| --- | --- | --- |
| contract | [RequiredParam](./react.requiredparam.md)<!-- -->&lt;Marketplace&gt; | an instace of a Marketplace contract |
| contract | [RequiredParam](./react.requiredparam.md)<!-- -->&lt;Marketplace&gt; | an instance of a Marketplace contract |

<b>Returns:</b>

Expand Down
2 changes: 1 addition & 1 deletion docs/react.useclaimednfts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ export declare function useClaimedNFTs(contract: RequiredParam<DropContract>, qu

| Parameter | Type | Description |
| --- | --- | --- |
| contract | [RequiredParam](./react.requiredparam.md)<!-- -->&lt;[DropContract](./react.dropcontract.md)<!-- -->&gt; | an instace of a [DropContract](./react.dropcontract.md) |
| contract | [RequiredParam](./react.requiredparam.md)<!-- -->&lt;[DropContract](./react.dropcontract.md)<!-- -->&gt; | an instance of a [DropContract](./react.dropcontract.md) |
| queryParams | QueryAllParams | <i>(Optional)</i> query params to pass to the query for the sake of pagination |

<b>Returns:</b>
Expand Down
2 changes: 1 addition & 1 deletion docs/react.useclaimednftsupply.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ export declare function useClaimedNFTSupply(contract: RequiredParam<DropContract

| Parameter | Type | Description |
| --- | --- | --- |
| contract | [RequiredParam](./react.requiredparam.md)<!-- -->&lt;[DropContract](./react.dropcontract.md)<!-- -->&gt; | an instace of a [DropContract](./react.dropcontract.md) |
| contract | [RequiredParam](./react.requiredparam.md)<!-- -->&lt;[DropContract](./react.dropcontract.md)<!-- -->&gt; | an instance of a [DropContract](./react.dropcontract.md) |

<b>Returns:</b>

Expand Down
2 changes: 1 addition & 1 deletion docs/react.useclaimnft.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ export declare function useClaimNFT<TContract extends DropContract>(contract: Re

| Parameter | Type | Description |
| --- | --- | --- |
| contract | [RequiredParam](./react.requiredparam.md)<!-- -->&lt;TContract&gt; | an instace of a [DropContract](./react.dropcontract.md) |
| contract | [RequiredParam](./react.requiredparam.md)<!-- -->&lt;TContract&gt; | an instance of a [DropContract](./react.dropcontract.md) |

<b>Returns:</b>

Expand Down
2 changes: 1 addition & 1 deletion docs/react.useclaimtoken.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ export declare function useClaimToken<TContract extends TokenDrop>(contract: Req

| Parameter | Type | Description |
| --- | --- | --- |
| contract | [RequiredParam](./react.requiredparam.md)<!-- -->&lt;TContract&gt; | an instace of a |
| contract | [RequiredParam](./react.requiredparam.md)<!-- -->&lt;TContract&gt; | an instance of a |

<b>Returns:</b>

Expand Down
2 changes: 1 addition & 1 deletion docs/react.usecreateauctionlisting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ export declare function useCreateAuctionListing(contract: RequiredParam<Marketpl

| Parameter | Type | Description |
| --- | --- | --- |
| contract | [RequiredParam](./react.requiredparam.md)<!-- -->&lt;Marketplace&gt; | an instace of a Marketplace contract |
| contract | [RequiredParam](./react.requiredparam.md)<!-- -->&lt;Marketplace&gt; | an instance of a Marketplace contract |

<b>Returns:</b>

Expand Down
2 changes: 1 addition & 1 deletion docs/react.usecreatedirectlisting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ export declare function useCreateDirectListing(contract: RequiredParam<Marketpla

| Parameter | Type | Description |
| --- | --- | --- |
| contract | [RequiredParam](./react.requiredparam.md)<!-- -->&lt;Marketplace&gt; | an instace of a Marketplace contract |
| contract | [RequiredParam](./react.requiredparam.md)<!-- -->&lt;Marketplace&gt; | an instance of a Marketplace contract |

<b>Returns:</b>

Expand Down
2 changes: 1 addition & 1 deletion docs/react.uselisting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ export declare function useListing(contract: RequiredParam<Marketplace>, listing

| Parameter | Type | Description |
| --- | --- | --- |
| contract | [RequiredParam](./react.requiredparam.md)<!-- -->&lt;Marketplace&gt; | an instace of a marketplace contract |
| contract | [RequiredParam](./react.requiredparam.md)<!-- -->&lt;Marketplace&gt; | an instance of a marketplace contract |
| listingId | [RequiredParam](./react.requiredparam.md)<!-- -->&lt;BigNumberish&gt; | the listing id to check |

<b>Returns:</b>
Expand Down
2 changes: 1 addition & 1 deletion docs/react.uselistings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ export declare function useListings(contract: RequiredParam<Marketplace>, filter

| Parameter | Type | Description |
| --- | --- | --- |
| contract | [RequiredParam](./react.requiredparam.md)<!-- -->&lt;Marketplace&gt; | an instace of a marketplace contract |
| contract | [RequiredParam](./react.requiredparam.md)<!-- -->&lt;Marketplace&gt; | an instance of a marketplace contract |
| filter | MarketplaceFilter | <i>(Optional)</i> filter to pass to the query for the sake of pagination &amp; filtering |

<b>Returns:</b>
Expand Down
2 changes: 1 addition & 1 deletion docs/react.usemakebid.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ export declare function useMakeBid(contract: RequiredParam<Marketplace>): import

| Parameter | Type | Description |
| --- | --- | --- |
| contract | [RequiredParam](./react.requiredparam.md)<!-- -->&lt;Marketplace&gt; | an instace of a Marketplace contract |
| contract | [RequiredParam](./react.requiredparam.md)<!-- -->&lt;Marketplace&gt; | an instance of a Marketplace contract |

<b>Returns:</b>

Expand Down
2 changes: 1 addition & 1 deletion docs/react.usemintnft.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ export declare function useMintNFT<TContract extends NFTContract>(contract: Requ

| Parameter | Type | Description |
| --- | --- | --- |
| contract | [RequiredParam](./react.requiredparam.md)<!-- -->&lt;TContract&gt; | an instace of a [NFTContract](./react.nftcontract.md) |
| contract | [RequiredParam](./react.requiredparam.md)<!-- -->&lt;TContract&gt; | an instance of a [NFTContract](./react.nftcontract.md) |

<b>Returns:</b>

Expand Down
2 changes: 1 addition & 1 deletion docs/react.useminttoken.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ export declare function useMintToken(contract: RequiredParam<Erc20>): import("re

| Parameter | Type | Description |
| --- | --- | --- |
| contract | [RequiredParam](./react.requiredparam.md)<!-- -->&lt;Erc20&gt; | an instace of a contract that extends the ERC20 spec (token, token drop, custom contract that follows the ERC20 spec) |
| contract | [RequiredParam](./react.requiredparam.md)<!-- -->&lt;Erc20&gt; | an instance of a contract that extends the ERC20 spec (token, token drop, custom contract that follows the ERC20 spec) |

<b>Returns:</b>

Expand Down
2 changes: 1 addition & 1 deletion docs/react.usenft.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ export declare function useNFT<TContract extends NFTContract>(contract: Required

| Parameter | Type | Description |
| --- | --- | --- |
| contract | [RequiredParam](./react.requiredparam.md)<!-- -->&lt;TContract&gt; | an instace of a [NFTContract](./react.nftcontract.md) |
| contract | [RequiredParam](./react.requiredparam.md)<!-- -->&lt;TContract&gt; | an instance of a [NFTContract](./react.nftcontract.md) |
| tokenId | [RequiredParam](./react.requiredparam.md)<!-- -->&lt;BigNumberish&gt; | the tokenId to look up |

<b>Returns:</b>
Expand Down
2 changes: 1 addition & 1 deletion docs/react.usenfts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ export declare function useNFTs<TContract extends NFTContract>(contract: Require

| Parameter | Type | Description |
| --- | --- | --- |
| contract | [RequiredParam](./react.requiredparam.md)<!-- -->&lt;TContract&gt; | an instace of a [NFTContract](./react.nftcontract.md) |
| contract | [RequiredParam](./react.requiredparam.md)<!-- -->&lt;TContract&gt; | an instance of a [NFTContract](./react.nftcontract.md) |
| queryParams | QueryAllParams | <i>(Optional)</i> query params to pass to the query for the sake of pagination |

<b>Returns:</b>
Expand Down
2 changes: 1 addition & 1 deletion docs/react.useownednfts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ export declare function useOwnedNFTs<TContract extends NFTContract>(contract: Re

| Parameter | Type | Description |
| --- | --- | --- |
| contract | [RequiredParam](./react.requiredparam.md)<!-- -->&lt;TContract&gt; | an instace of a [NFTContract](./react.nftcontract.md) |
| contract | [RequiredParam](./react.requiredparam.md)<!-- -->&lt;TContract&gt; | an instance of a [NFTContract](./react.nftcontract.md) |
| ownerWalletAddress | [RequiredParam](./react.requiredparam.md)<!-- -->&lt;[WalletAddress](./react.walletaddress.md)<!-- -->&gt; | the wallet adress to get owned tokens for |

<b>Returns:</b>
Expand Down
2 changes: 1 addition & 1 deletion docs/react.usetokenbalance.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ export declare function useTokenBalance(contract: RequiredParam<Erc20>, walletAd

| Parameter | Type | Description |
| --- | --- | --- |
| contract | [RequiredParam](./react.requiredparam.md)<!-- -->&lt;Erc20&gt; | an instace of a Token contract. |
| contract | [RequiredParam](./react.requiredparam.md)<!-- -->&lt;Erc20&gt; | an instance of a Token contract. |
| walletAddress | [RequiredParam](./react.requiredparam.md)<!-- -->&lt;[WalletAddress](./react.walletaddress.md)<!-- -->&gt; | |

<b>Returns:</b>
Expand Down
2 changes: 1 addition & 1 deletion docs/react.usetokensupply.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ export declare function useTokenSupply(contract: RequiredParam<Erc20>): import("

| Parameter | Type | Description |
| --- | --- | --- |
| contract | [RequiredParam](./react.requiredparam.md)<!-- -->&lt;Erc20&gt; | an instace of a Token contract. |
| contract | [RequiredParam](./react.requiredparam.md)<!-- -->&lt;Erc20&gt; | an instance of a Token contract. |

<b>Returns:</b>

Expand Down
2 changes: 1 addition & 1 deletion docs/react.usetotalcount.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ export declare function useTotalCount(contract: RequiredParam<NFTContract>): imp

| Parameter | Type | Description |
| --- | --- | --- |
| contract | [RequiredParam](./react.requiredparam.md)<!-- -->&lt;[NFTContract](./react.nftcontract.md)<!-- -->&gt; | an instace of a [NFTContract](./react.nftcontract.md) |
| contract | [RequiredParam](./react.requiredparam.md)<!-- -->&lt;[NFTContract](./react.nftcontract.md)<!-- -->&gt; | an instance of a [NFTContract](./react.nftcontract.md) |

<b>Returns:</b>

Expand Down
2 changes: 1 addition & 1 deletion docs/react.useunclaimednfts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ export declare function useUnclaimedNFTs(contract: RequiredParam<NFTDrop>, query

| Parameter | Type | Description |
| --- | --- | --- |
| contract | [RequiredParam](./react.requiredparam.md)<!-- -->&lt;NFTDrop&gt; | an instace of a contract that extends the Erc721 spec (nft drop, custom contract that follows the Erc721 &amp; drop spec) |
| contract | [RequiredParam](./react.requiredparam.md)<!-- -->&lt;NFTDrop&gt; | an instance of a contract that extends the Erc721 spec (nft drop, custom contract that follows the Erc721 &amp; drop spec) |
| queryParams | QueryAllParams | <i>(Optional)</i> query params to pass to the query for the sake of pagination |

<b>Returns:</b>
Expand Down
2 changes: 1 addition & 1 deletion docs/react.useunclaimednftsupply.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ export declare function useUnclaimedNFTSupply(contract: RequiredParam<NFTDrop>):

| Parameter | Type | Description |
| --- | --- | --- |
| contract | [RequiredParam](./react.requiredparam.md)<!-- -->&lt;NFTDrop&gt; | an instace of a |
| contract | [RequiredParam](./react.requiredparam.md)<!-- -->&lt;NFTDrop&gt; | an instance of a |

<b>Returns:</b>

Expand Down
2 changes: 1 addition & 1 deletion docs/react.usewinningbid.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ export declare function useWinningBid(contract: RequiredParam<Marketplace>, list

| Parameter | Type | Description |
| --- | --- | --- |
| contract | [RequiredParam](./react.requiredparam.md)<!-- -->&lt;Marketplace&gt; | an instace of a marketplace contract |
| contract | [RequiredParam](./react.requiredparam.md)<!-- -->&lt;Marketplace&gt; | an instance of a marketplace contract |
| listingId | [RequiredParam](./react.requiredparam.md)<!-- -->&lt;BigNumberish&gt; | the listing id to check |

<b>Returns:</b>
Expand Down
6 changes: 3 additions & 3 deletions src/hooks/async/claim-conditions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ type ActiveClaimConditionParams<TContract> = TContract extends Erc1155
* const { data: activeClaimCondition, isLoading, error } = useActiveClaimCondition(<YourERC1155ContractInstance>, <tokenId>);
* ```
*
* @param contract - an instace of a contract that extends the ERC721 or ERC1155 spec and implements the `claimConditions` extension.
* @param contract - an instance of a contract that extends the ERC721 or ERC1155 spec and implements the `claimConditions` extension.
* @param tokenId - the id of the token to fetch the claim conditions for (if the contract is an ERC1155 contract)
* @returns a response object with the currently active claim condition
*
Expand Down Expand Up @@ -84,7 +84,7 @@ export function useActiveClaimCondition<
* const { data: claimConditions, isLoading, error } = useClaimConditions(<YourERC1155ContractInstance>, <tokenId>);
* ```
*
* @param contract - an instace of a contract that extends the ERC721 or ERC1155 spec and implements the `claimConditions` extension.
* @param contract - an instance of a contract that extends the ERC721 or ERC1155 spec and implements the `claimConditions` extension.
* @param tokenId - the id of the token to fetch the claim conditions for (if the contract is an ERC1155 contract)
* @returns a response object with the list of claim conditions
*
Expand Down Expand Up @@ -156,7 +156,7 @@ type ClaimIneligibilityInputParams<TContract> = TContract extends Erc1155
* const { data: claimIneligibilityReasons, isLoading, error } = useClaimIneligibilityReasons(<YourERC1155ContractInstance>, {quantity: <quantity>}, <tokenId>);
* ```
*
* @param contract - an instace of a contract that extends the ERC20, ERC721 or ERC1155 spec and implements the `claimConditions` extension.
* @param contract - an instance of a contract that extends the ERC20, ERC721 or ERC1155 spec and implements the `claimConditions` extension.
* @param eligibilityParams - the parameters for the eligibility check, see: {@link ClaimIneligibilityParameters}
* @param tokenId - the id of the token to fetch the claim conditions for (if the contract is an ERC1155 contract)
* @returns a response object with the resons for the claim ineligibility
Expand Down
10 changes: 5 additions & 5 deletions src/hooks/async/drop.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ import invariant from "tiny-invariant";
* const { data: unclaimedNfts, isLoading, error } = useUnclaimedNFTs(<YourERC721DropContractInstance>, { start: 0, count: 100 });
* ```
*
* @param contract - an instace of a contract that extends the Erc721 spec (nft drop, custom contract that follows the Erc721 & drop spec)
* @param contract - an instance of a contract that extends the Erc721 spec (nft drop, custom contract that follows the Erc721 & drop spec)
* @param queryParams - query params to pass to the query for the sake of pagination
* @returns a response object that includes an array of NFTs that are unclaimed
* @beta
Expand Down Expand Up @@ -65,7 +65,7 @@ export function useUnclaimedNFTs(
* const { data: claimedNFTs, isLoading, error } = useClaimedNFTs(<YourERC721DropContractInstance>, { start: 0, count: 100 });
* ```
*
* @param contract - an instace of a {@link DropContract}
* @param contract - an instance of a {@link DropContract}
* @param queryParams - query params to pass to the query for the sake of pagination
* @returns a response object that includes an array of NFTs that are claimed
* @beta
Expand All @@ -78,7 +78,7 @@ export function useClaimedNFTs(
}
/**
*
* @param contract - an instace of a {@link NFTDrop}
* @param contract - an instance of a {@link NFTDrop}
* @returns a response object that includes the number of NFTs that are unclaimed
*/
export function useUnclaimedNFTSupply(contract: RequiredParam<NFTDrop>) {
Expand All @@ -100,7 +100,7 @@ export function useUnclaimedNFTSupply(contract: RequiredParam<NFTDrop>) {

/**
*
* @param contract - an instace of a {@link DropContract}
* @param contract - an instance of a {@link DropContract}
* @returns a response object that includes the number of NFTs that are claimed
*/
export function useClaimedNFTSupply(contract: RequiredParam<DropContract>) {
Expand Down Expand Up @@ -152,7 +152,7 @@ export function useClaimedNFTSupply(contract: RequiredParam<DropContract>) {
* };
* ```
*
* @param contract - an instace of a {@link DropContract}
* @param contract - an instance of a {@link DropContract}
* @returns a mutation object that can be used to claim a NFT to the wallet specificed in the params
* @beta
*/
Expand Down
Loading