add additional contract hooks (#56)

* add additional contract hooks

* v2.3.2-0

* Fix typo and some examples

* v2.3.2-1

Co-authored-by: Nacho Iacovino <nacho.iacovino@gmail.com>

Author: jnsdls

docs/react.claimnftparams.md

@@ -0,0 +1,27 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@thirdweb-dev/react](./react.md) &gt; [ClaimNFTParams](./react.claimnftparams.md)
+
+## ClaimNFTParams type
+
+> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+The params for the [useClaimNFT()](./react.useclaimnft.md) hook mutation.
+
+<b>Signature:</b>
+
+```typescript
+export declare type ClaimNFTParams<TContract extends DropContract> = TContract extends Erc1155 ? {
+    to: WalletAddress;
+    tokenId: BigNumberish;
+    quantity: BigNumberish;
+    proofs?: BytesLike[];
+} : {
+    to: WalletAddress;
+    quantity: BigNumberish;
+    proofs?: BytesLike[];
+};
+```
+<b>References:</b> [DropContract](./react.dropcontract.md)<!-- -->, [WalletAddress](./react.walletaddress.md)
+

docs/react.claimnftreturntype.md

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@thirdweb-dev/react](./react.md) &gt; [ClaimNFTReturnType](./react.claimnftreturntype.md)
+
+## ClaimNFTReturnType type
+
+> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+The return type of the [useClaimNFT()](./react.useclaimnft.md) hook.
+
+<b>Signature:</b>
+
+```typescript
+export declare type ClaimNFTReturnType<TContract extends DropContract> = TContract extends Erc721 ? Awaited<ReturnType<TContract["claimTo"]>> : TContract extends Erc1155 ? Awaited<ReturnType<TContract["claimTo"]>> : never;
+```
+<b>References:</b> [DropContract](./react.dropcontract.md)
+

docs/react.dropcontract.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@thirdweb-dev/react](./react.md) &gt; [DropContract](./react.dropcontract.md)
+
+## DropContract type
+
+> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+The possible DROP contract types.
+
+<b>Signature:</b>
+
+```typescript
+export declare type DropContract = NFTDrop | EditionDrop;
+```

docs/react.makebidparams.md

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@thirdweb-dev/react](./react.md) &gt; [MakeBidParams](./react.makebidparams.md)
+
+## MakeBidParams type
+
+<b>Signature:</b>
+
+```typescript
+export declare type MakeBidParams = {
+    listingId: BigNumberish;
+    bid: BigNumberish;
+};
+```

docs/react.md

@@ -16,7 +16,9 @@
 import { useAddress } from "@thirdweb-dev/react"
 ```
  |
-|  [useAllListings(contract, filter)](./react.usealllistings.md) | <b><i>(BETA)</i></b> Use this to get a list all listings from your marketplace contract. |
+|  [useAuctionWinner(contract, listingId)](./react.useauctionwinner.md) | <b><i>(BETA)</i></b> Use this to get the winner of an auction listing from your marketplace contract. |
+|  [useBidBuffer(contract)](./react.usebidbuffer.md) | <b><i>(BETA)</i></b> Use this to get the buffer in basis points between offers from your marketplace contract. |
+|  [useBuyoutListing(contract)](./react.usebuyoutlisting.md) | <b><i>(BETA)</i></b> Use this to buy out an auction listing from your marketplace contract. |
 |  [useChainId()](./react.usechainid.md) | Hook for accessing the chain ID of the network the current wallet is connected to
 ```javascript
 import { useChainId } from "@thirdweb-dev/react"
@@ -26,6 +28,7 @@ import { useChainId } from "@thirdweb-dev/react"
 |  [useClaimedNFTs(contract, queryParams)](./react.useclaimednfts.md) | <b><i>(BETA)</i></b> Use this to get a list of \*claimed\* (minted) NFT tokens of your ERC721 Drop contract. |
 |  [useClaimedNFTSupply(contract)](./react.useclaimednftsupply.md) |  |
 |  [useClaimIneligibilityReasons(\[contract, params, tokenId\])](./react.useclaimineligibilityreasons.md) | <b><i>(BETA)</i></b> Use this to check for reasons that prevent claiming for either ERC20, ERC721 or ERC1155 based contracts. They need to extend the <code>claimCondition</code> extension for this hook to work. |
+|  [useClaimNFT(contract)](./react.useclaimnft.md) | <b><i>(BETA)</i></b> Use this to mint a new NFT on your [DropContract](./react.dropcontract.md) |
 |  [useCoinbaseWallet()](./react.usecoinbasewallet.md) | Hook for connecting to a Coinbase wallet.
 ```javascript
 import { useCoinbaseWallet } from "@thirdweb-dev/react"
@@ -49,11 +52,14 @@ import { useDisconnect } from "@thirdweb-dev/react"
 import { useGnosis } from "@thirdweb-dev/react"
 ```
  |
+|  [useListing(contract, listingId)](./react.uselisting.md) | <b><i>(BETA)</i></b> Use this to get a specific listing from the marketplace. |
+|  [useListings(contract, filter)](./react.uselistings.md) | <b><i>(BETA)</i></b> Use this to get a list all listings from your marketplace contract. |
 |  [useMagic()](./react.usemagic.md) | Hook for connecting to an email wallet using magic link. This enables users without their own wallets to connect to your application and sign transactions securely using their email.
 ```javascript
 import { useMagic } from "@thirdweb-dev/react"
 ```
  |
+|  [useMakeBid(contract)](./react.usemakebid.md) | <b><i>(BETA)</i></b> Use this to place a bid on an auction listing from your marketplace contract. |
 |  [useMarketplace(contractAddress)](./react.usemarketplace.md) | Hook for getting an instance of a <code>Marketplace</code> contract. This contract is used to support marketplace for purchase and sale of on-chain assets. |
 |  [useMetamask()](./react.usemetamask.md) | Hook for connecting to a Metamask wallet.
 ```javascript
@@ -93,6 +99,7 @@ import { useNetworkMistmatch } from "@thirdweb-dev/react"
 import { useWalletConnect } from "@thirdweb-dev/react"
 ```
  |
+|  [useWinningBid(contract, listingId)](./react.usewinningbid.md) | <b><i>(BETA)</i></b> Use this to get a the winning bid for an auction listing from your marketplace contract. |
 
 ## Interfaces
 
@@ -120,7 +127,11 @@ import { useWalletConnect } from "@thirdweb-dev/react"
 |  Type Alias | Description |
 |  --- | --- |
 |  [ClaimIneligibilityParameters](./react.claimineligibilityparameters.md) | <b><i>(BETA)</i></b> The options to be passed as the second parameter to the <code>useClaimIneligibilityReasons</code> hook. |
+|  [ClaimNFTParams](./react.claimnftparams.md) | <b><i>(BETA)</i></b> The params for the [useClaimNFT()](./react.useclaimnft.md) hook mutation. |
+|  [ClaimNFTReturnType](./react.claimnftreturntype.md) | <b><i>(BETA)</i></b> The return type of the [useClaimNFT()](./react.useclaimnft.md) hook. |
 |  [ContractAddress](./react.contractaddress.md) | <b><i>(BETA)</i></b> A contract address. |
+|  [DropContract](./react.dropcontract.md) | <b><i>(BETA)</i></b> The possible DROP contract types. |
+|  [MakeBidParams](./react.makebidparams.md) |  |
 |  [MintNFTParams](./react.mintnftparams.md) | <b><i>(BETA)</i></b> The params for the [useMintNFT()](./react.usemintnft.md) hook mutation. |
 |  [MintNFTReturnType](./react.mintnftreturntype.md) | <b><i>(BETA)</i></b> The return type of the [useMintNFT()](./react.usemintnft.md) hook. |
 |  [NFT](./react.nft.md) | <b><i>(BETA)</i></b> A single NFT token |

docs/react.useauctionwinner.md

@@ -0,0 +1,41 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@thirdweb-dev/react](./react.md) &gt; [useAuctionWinner](./react.useauctionwinner.md)
+
+## useAuctionWinner() function
+
+> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+Use this to get the winner of an auction listing from your marketplace contract.
+
+<b>Signature:</b>
+
+```typescript
+export declare function useAuctionWinner(contract: RequiredParam<Marketplace>, listingId: RequiredParam<BigNumberish>): import("react-query").UseQueryResult<string, unknown>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  contract | [RequiredParam](./react.requiredparam.md)<!-- -->&lt;Marketplace&gt; | an instace of a marketplace contract |
+|  listingId | [RequiredParam](./react.requiredparam.md)<!-- -->&lt;BigNumberish&gt; | the listing id to check |
+
+<b>Returns:</b>
+
+import("react-query").UseQueryResult&lt;string, unknown&gt;
+
+a response object that includes an array of listings
+
+## Exceptions
+
+an error if the auction is not finished
+
+## Example
+
+
+```javascript
+const { data: auctionWinner, isLoading, error } = useAuctionWinner(<YourMarketplaceContractInstance>, <listingId>);
+```
+

docs/react.usebidbuffer.md

@@ -0,0 +1,36 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@thirdweb-dev/react](./react.md) &gt; [useBidBuffer](./react.usebidbuffer.md)
+
+## useBidBuffer() function
+
+> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+Use this to get the buffer in basis points between offers from your marketplace contract.
+
+<b>Signature:</b>
+
+```typescript
+export declare function useBidBuffer(contract: RequiredParam<Marketplace>): import("react-query").UseQueryResult<BigNumber, unknown>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  contract | [RequiredParam](./react.requiredparam.md)<!-- -->&lt;Marketplace&gt; | an instace of a marketplace contract |
+
+<b>Returns:</b>
+
+import("react-query").UseQueryResult&lt;BigNumber, unknown&gt;
+
+a response object that includes an array of listings
+
+## Example
+
+
+```javascript
+const { data: auctionWinner, isLoading, error } = useAuctionWinner(<YourMarketplaceContractInstance>, <listingId>);
+```
+

docs/react.usebuyoutlisting.md

@@ -0,0 +1,58 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@thirdweb-dev/react](./react.md) &gt; [useBuyoutListing](./react.usebuyoutlisting.md)
+
+## useBuyoutListing() function
+
+> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+Use this to buy out an auction listing from your marketplace contract.
+
+<b>Signature:</b>
+
+```typescript
+export declare function useBuyoutListing(contract: RequiredParam<Marketplace>): import("react-query").UseMutationResult<Omit<{
+    receipt: import("@ethersproject/abstract-provider").TransactionReceipt;
+    data: () => Promise<unknown>;
+}, "data">, unknown, BigNumberish, unknown>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  contract | [RequiredParam](./react.requiredparam.md)<!-- -->&lt;Marketplace&gt; | an instace of a Marketplace contract |
+
+<b>Returns:</b>
+
+import("react-query").UseMutationResult&lt;Omit&lt;{ receipt: import("@ethersproject/abstract-provider").TransactionReceipt; data: () =&gt; Promise&lt;unknown&gt;; }, "data"&gt;, unknown, BigNumberish, unknown&gt;
+
+a mutation object that can be used to buy out an auction listing
+
+## Example
+
+
+```jsx
+const Component = () => {
+  const {
+    mutate: buyoutListing,
+    isLoading,
+    error,
+  } = useBuyoutListing(">>YourMarketplaceContractInstance<<");
+
+  if (error) {
+    console.error("failed to buyout listing", error);
+  }
+
+  return (
+    <button
+      disabled={isLoading}
+      onClick={() => buyoutListing(listingId)}
+    >
+      Buy listing!
+    </button>
+  );
+};
+```
+

docs/react.useclaimednfts.md

@@ -12,19 +12,19 @@ Use this to get a list of \*claimed\* (minted) NFT tokens of your ERC721 Drop co
 <b>Signature:</b>
 
 ```typescript
-export declare function useClaimedNFTs(contract: RequiredParam<NFTDrop>, queryParams?: QueryAllParams): import("react-query").UseQueryResult<NFT<NFTDrop>[], unknown>;
+export declare function useClaimedNFTs(contract: RequiredParam<DropContract>, queryParams?: QueryAllParams): import("react-query").UseQueryResult<import("../../types").NFT<DropContract>[], unknown>;
 ```
 
 ## Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  contract | [RequiredParam](./react.requiredparam.md)<!-- -->&lt;NFTDrop&gt; | an instace of a  |
+|  contract | [RequiredParam](./react.requiredparam.md)<!-- -->&lt;[DropContract](./react.dropcontract.md)<!-- -->&gt; | an instace 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>
 
-import("react-query").UseQueryResult&lt;[NFT](./react.nft.md)<!-- -->&lt;NFTDrop&gt;\[\], unknown&gt;
+import("react-query").UseQueryResult&lt;import("../../types").[NFT](./react.nft.md)<!-- -->&lt;[DropContract](./react.dropcontract.md)<!-- -->&gt;\[\], unknown&gt;
 
 a response object that includes an array of NFTs that are claimed
 

docs/react.useclaimednftsupply.md

@@ -7,18 +7,18 @@
 <b>Signature:</b>
 
 ```typescript
-export declare function useClaimedNFTSupply(contract: RequiredParam<NFTDrop>): import("react-query").UseQueryResult<BigNumber, unknown>;
+export declare function useClaimedNFTSupply(contract: RequiredParam<DropContract>): import("react-query").UseQueryResult<import("ethers").BigNumber, unknown>;
 ```
 
 ## Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  contract | [RequiredParam](./react.requiredparam.md)<!-- -->&lt;NFTDrop&gt; | an instace of a  |
+|  contract | [RequiredParam](./react.requiredparam.md)<!-- -->&lt;[DropContract](./react.dropcontract.md)<!-- -->&gt; | an instace of a [DropContract](./react.dropcontract.md) |
 
 <b>Returns:</b>
 
-import("react-query").UseQueryResult&lt;BigNumber, unknown&gt;
+import("react-query").UseQueryResult&lt;import("ethers").BigNumber, unknown&gt;
 
 a response object that includes the number of NFTs that are claimed