Skip to content
This repository was archived by the owner on Aug 30, 2022. It is now read-only.
Merged
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 packages/thirdweb-react/docs/react.useactivelistings.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Use this to get a list active listings from your marketplace contract.
<b>Signature:</b>

```typescript
export declare function useActiveListings(contract: RequiredParam<Marketplace>, filter?: MarketplaceFilter): import("@tanstack/react-query").UseQueryResult<(import("@thirdweb-dev/sdk/dist/browser").AuctionListing | import("@thirdweb-dev/sdk/dist/browser").DirectListing)[], unknown>;
export declare function useActiveListings(contract: RequiredParam<Marketplace>, filter?: MarketplaceFilter): import("@tanstack/react-query").UseQueryResult<(import("@thirdweb-dev/sdk").AuctionListing | import("@thirdweb-dev/sdk").DirectListing)[], unknown>;
```

## Parameters
Expand All @@ -24,7 +24,7 @@ export declare function useActiveListings(contract: RequiredParam<Marketplace>,

<b>Returns:</b>

import("@tanstack/react-query").UseQueryResult&lt;(import("@thirdweb-dev/sdk/dist/browser").AuctionListing \| import("@thirdweb-dev/sdk/dist/browser").DirectListing)\[\], unknown&gt;
import("@tanstack/react-query").UseQueryResult&lt;(import("@thirdweb-dev/sdk").AuctionListing \| import("@thirdweb-dev/sdk").DirectListing)\[\], unknown&gt;

a response object that includes an array of listings

Expand Down
4 changes: 2 additions & 2 deletions packages/thirdweb-react/docs/react.usebatchestoreveal.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<b>Signature:</b>

```typescript
export declare function useBatchesToReveal<TContract extends NFTContract>(contract: RequiredParam<TContract>): import("@tanstack/react-query").UseQueryResult<import("@thirdweb-dev/sdk/dist/browser").BatchToReveal[], unknown>;
export declare function useBatchesToReveal<TContract extends NFTContract>(contract: RequiredParam<TContract>): import("@tanstack/react-query").UseQueryResult<import("@thirdweb-dev/sdk").BatchToReveal[], unknown>;
```

## Parameters
Expand All @@ -18,7 +18,7 @@ export declare function useBatchesToReveal<TContract extends NFTContract>(contra

<b>Returns:</b>

import("@tanstack/react-query").UseQueryResult&lt;import("@thirdweb-dev/sdk/dist/browser").BatchToReveal\[\], unknown&gt;
import("@tanstack/react-query").UseQueryResult&lt;import("@thirdweb-dev/sdk").BatchToReveal\[\], unknown&gt;

a response object that gets the batches to still be revealed

Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Use this to check for reasons that prevent claiming for either ERC20, ERC721 or
<b>Signature:</b>

```typescript
export declare function useClaimIneligibilityReasons<TContract extends NFTContract | Erc20>(...[contract, params, tokenId]: ClaimIneligibilityInputParams<TContract>): import("@tanstack/react-query").UseQueryResult<import("@thirdweb-dev/sdk/dist/browser").ClaimEligibility[], unknown>;
export declare function useClaimIneligibilityReasons<TContract extends NFTContract | Erc20>(...[contract, params, tokenId]: ClaimIneligibilityInputParams<TContract>): import("@tanstack/react-query").UseQueryResult<import("@thirdweb-dev/sdk").ClaimEligibility[], unknown>;
```

## Parameters
Expand All @@ -23,7 +23,7 @@ export declare function useClaimIneligibilityReasons<TContract extends NFTContra

<b>Returns:</b>

import("@tanstack/react-query").UseQueryResult&lt;import("@thirdweb-dev/sdk/dist/browser").ClaimEligibility\[\], unknown&gt;
import("@tanstack/react-query").UseQueryResult&lt;import("@thirdweb-dev/sdk").ClaimEligibility\[\], unknown&gt;

a response object with the resons for the claim ineligibility

Expand Down
4 changes: 2 additions & 2 deletions packages/thirdweb-react/docs/react.usecontractmetadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Use this to get the contract metadata for a (built-in or custom) contract.

```typescript
export declare function useContractMetadata(contractAddress: RequiredParam<ContractAddress>): import("@tanstack/react-query").UseQueryResult<{
[x: string]: import("@thirdweb-dev/sdk/dist/browser").Json;
[x: string]: import("@thirdweb-dev/sdk").Json;
description?: string | undefined;
image?: any;
external_link?: string | undefined;
Expand All @@ -29,7 +29,7 @@ export declare function useContractMetadata(contractAddress: RequiredParam<Contr

<b>Returns:</b>

import("@tanstack/react-query").UseQueryResult&lt;{ \[x: string\]: import("@thirdweb-dev/sdk/dist/browser").Json; description?: string \| undefined; image?: any; external\_link?: string \| undefined; name: string; }, unknown&gt;
import("@tanstack/react-query").UseQueryResult&lt;{ \[x: string\]: import("@thirdweb-dev/sdk").Json; description?: string \| undefined; image?: any; external\_link?: string \| undefined; name: string; }, unknown&gt;

a response object that includes the contract metadata of the deployed contract

Expand Down
4 changes: 2 additions & 2 deletions packages/thirdweb-react/docs/react.usecreateauctionlisting.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Use this to create a new Auction Listing on your marketplace contract.
<b>Signature:</b>

```typescript
export declare function useCreateAuctionListing(contract: RequiredParam<Marketplace>): import("@tanstack/react-query").UseMutationResult<import("@thirdweb-dev/sdk/dist/browser").TransactionResultWithId<never>, unknown, NewAuctionListing, unknown>;
export declare function useCreateAuctionListing(contract: RequiredParam<Marketplace>): import("@tanstack/react-query").UseMutationResult<import("@thirdweb-dev/sdk").TransactionResultWithId<never>, unknown, NewAuctionListing, unknown>;
```

## Parameters
Expand All @@ -23,7 +23,7 @@ export declare function useCreateAuctionListing(contract: RequiredParam<Marketpl

<b>Returns:</b>

import("@tanstack/react-query").UseMutationResult&lt;import("@thirdweb-dev/sdk/dist/browser").TransactionResultWithId&lt;never&gt;, unknown, NewAuctionListing, unknown&gt;
import("@tanstack/react-query").UseMutationResult&lt;import("@thirdweb-dev/sdk").TransactionResultWithId&lt;never&gt;, unknown, NewAuctionListing, unknown&gt;

a mutation object that can be used to create a new auction listing

Expand Down
4 changes: 2 additions & 2 deletions packages/thirdweb-react/docs/react.usecreatedirectlisting.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Use this to create a new Direct Listing on your marketplace contract.
<b>Signature:</b>

```typescript
export declare function useCreateDirectListing(contract: RequiredParam<Marketplace>): import("@tanstack/react-query").UseMutationResult<import("@thirdweb-dev/sdk/dist/browser").TransactionResultWithId<never>, unknown, NewDirectListing, unknown>;
export declare function useCreateDirectListing(contract: RequiredParam<Marketplace>): import("@tanstack/react-query").UseMutationResult<import("@thirdweb-dev/sdk").TransactionResultWithId<never>, unknown, NewDirectListing, unknown>;
```

## Parameters
Expand All @@ -23,7 +23,7 @@ export declare function useCreateDirectListing(contract: RequiredParam<Marketpla

<b>Returns:</b>

import("@tanstack/react-query").UseMutationResult&lt;import("@thirdweb-dev/sdk/dist/browser").TransactionResultWithId&lt;never&gt;, unknown, NewDirectListing, unknown&gt;
import("@tanstack/react-query").UseMutationResult&lt;import("@thirdweb-dev/sdk").TransactionResultWithId&lt;never&gt;, unknown, NewDirectListing, unknown&gt;

a mutation object that can be used to create a new direct listing

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Use this to lazy mint a batch of delayed reveal NFTs on your [DropContract](./re
<b>Signature:</b>

```typescript
export declare function useDelayedRevealLazyMint<TContract extends NFTContract>(contract: RequiredParam<TContract>, onProgress?: (progress: UploadProgressEvent) => void): import("@tanstack/react-query").UseMutationResult<import("@thirdweb-dev/sdk/dist/browser").TransactionResultWithId<never>[], unknown, DelayedRevealLazyMintInput, unknown>;
export declare function useDelayedRevealLazyMint<TContract extends NFTContract>(contract: RequiredParam<TContract>, onProgress?: (progress: UploadProgressEvent) => void): import("@tanstack/react-query").UseMutationResult<import("@thirdweb-dev/sdk").TransactionResultWithId<never>[], unknown, DelayedRevealLazyMintInput, unknown>;
```

## Parameters
Expand All @@ -24,7 +24,7 @@ export declare function useDelayedRevealLazyMint<TContract extends NFTContract>(

<b>Returns:</b>

import("@tanstack/react-query").UseMutationResult&lt;import("@thirdweb-dev/sdk/dist/browser").TransactionResultWithId&lt;never&gt;\[\], unknown, [DelayedRevealLazyMintInput](./react.delayedreveallazymintinput.md)<!-- -->, unknown&gt;
import("@tanstack/react-query").UseMutationResult&lt;import("@thirdweb-dev/sdk").TransactionResultWithId&lt;never&gt;\[\], unknown, [DelayedRevealLazyMintInput](./react.delayedreveallazymintinput.md)<!-- -->, unknown&gt;

a mutation object that can be used to lazy mint a batch of NFTs

6 changes: 3 additions & 3 deletions packages/thirdweb-react/docs/react.uselazymint.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Use this to lazy mint a batch of NFTs on your [DropContract](./react.dropcontrac
<b>Signature:</b>

```typescript
export declare function useLazyMint<TContract extends NFTContract>(contract: RequiredParam<TContract>, onProgress?: (progress: UploadProgressEvent) => void): import("@tanstack/react-query").UseMutationResult<import("@thirdweb-dev/sdk/dist/browser").TransactionResultWithId<{
[x: string]: import("@thirdweb-dev/sdk/dist/browser").Json;
export declare function useLazyMint<TContract extends NFTContract>(contract: RequiredParam<TContract>, onProgress?: (progress: UploadProgressEvent) => void): import("@tanstack/react-query").UseMutationResult<import("@thirdweb-dev/sdk").TransactionResultWithId<{
[x: string]: import("@thirdweb-dev/sdk").Json;
name?: string | number | undefined;
description?: string | null | undefined;
image?: string | null | undefined;
Expand All @@ -35,7 +35,7 @@ export declare function useLazyMint<TContract extends NFTContract>(contract: Req

<b>Returns:</b>

import("@tanstack/react-query").UseMutationResult&lt;import("@thirdweb-dev/sdk/dist/browser").TransactionResultWithId&lt;{ \[x: string\]: import("@thirdweb-dev/sdk/dist/browser").Json; name?: string \| number \| undefined; description?: string \| null \| undefined; image?: string \| null \| undefined; external\_url?: string \| null \| undefined; animation\_url?: string \| null \| undefined; uri: string; id: import("ethers").BigNumber; }&gt;\[\], unknown, { metadatas: NFTMetadataInput\[\]; }, unknown&gt;
import("@tanstack/react-query").UseMutationResult&lt;import("@thirdweb-dev/sdk").TransactionResultWithId&lt;{ \[x: string\]: import("@thirdweb-dev/sdk").Json; name?: string \| number \| undefined; description?: string \| null \| undefined; image?: string \| null \| undefined; external\_url?: string \| null \| undefined; animation\_url?: string \| null \| undefined; uri: string; id: import("ethers").BigNumber; }&gt;\[\], unknown, { metadatas: NFTMetadataInput\[\]; }, unknown&gt;

a mutation object that can be used to lazy mint a batch of NFTs

4 changes: 2 additions & 2 deletions packages/thirdweb-react/docs/react.uselisting.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Use this to get a specific listing from the marketplace.
<b>Signature:</b>

```typescript
export declare function useListing(contract: RequiredParam<Marketplace>, listingId: RequiredParam<BigNumberish>): import("@tanstack/react-query").UseQueryResult<import("@thirdweb-dev/sdk/dist/browser").AuctionListing | import("@thirdweb-dev/sdk/dist/browser").DirectListing, unknown>;
export declare function useListing(contract: RequiredParam<Marketplace>, listingId: RequiredParam<BigNumberish>): import("@tanstack/react-query").UseQueryResult<import("@thirdweb-dev/sdk").AuctionListing | import("@thirdweb-dev/sdk").DirectListing, unknown>;
```

## Parameters
Expand All @@ -24,7 +24,7 @@ export declare function useListing(contract: RequiredParam<Marketplace>, listing

<b>Returns:</b>

import("@tanstack/react-query").UseQueryResult&lt;import("@thirdweb-dev/sdk/dist/browser").AuctionListing \| import("@thirdweb-dev/sdk/dist/browser").DirectListing, unknown&gt;
import("@tanstack/react-query").UseQueryResult&lt;import("@thirdweb-dev/sdk").AuctionListing \| import("@thirdweb-dev/sdk").DirectListing, unknown&gt;

a response object that includes an array of listings

Expand Down
4 changes: 2 additions & 2 deletions packages/thirdweb-react/docs/react.uselistings.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Use this to get a list all listings from your marketplace contract.
<b>Signature:</b>

```typescript
export declare function useListings(contract: RequiredParam<Marketplace>, filter?: MarketplaceFilter): import("@tanstack/react-query").UseQueryResult<(import("@thirdweb-dev/sdk/dist/browser").AuctionListing | import("@thirdweb-dev/sdk/dist/browser").DirectListing)[], unknown>;
export declare function useListings(contract: RequiredParam<Marketplace>, filter?: MarketplaceFilter): import("@tanstack/react-query").UseQueryResult<(import("@thirdweb-dev/sdk").AuctionListing | import("@thirdweb-dev/sdk").DirectListing)[], unknown>;
```

## Parameters
Expand All @@ -24,7 +24,7 @@ export declare function useListings(contract: RequiredParam<Marketplace>, filter

<b>Returns:</b>

import("@tanstack/react-query").UseQueryResult&lt;(import("@thirdweb-dev/sdk/dist/browser").AuctionListing \| import("@thirdweb-dev/sdk/dist/browser").DirectListing)\[\], unknown&gt;
import("@tanstack/react-query").UseQueryResult&lt;(import("@thirdweb-dev/sdk").AuctionListing \| import("@thirdweb-dev/sdk").DirectListing)\[\], unknown&gt;

a response object that includes an array of listings

Expand Down
4 changes: 2 additions & 2 deletions packages/thirdweb-react/docs/react.usemetadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Use this to get the metadata of your

```typescript
export declare function useMetadata(contract: RequiredParam<SmartContract | ValidContractInstance>): import("@tanstack/react-query").UseQueryResult<{
[x: string]: import("@thirdweb-dev/sdk/dist/browser").Json;
[x: string]: import("@thirdweb-dev/sdk").Json;
description?: string | undefined;
image?: any;
external_link?: string | undefined;
Expand All @@ -29,7 +29,7 @@ export declare function useMetadata(contract: RequiredParam<SmartContract | Vali

<b>Returns:</b>

import("@tanstack/react-query").UseQueryResult&lt;{ \[x: string\]: import("@thirdweb-dev/sdk/dist/browser").Json; description?: string \| undefined; image?: any; external\_link?: string \| undefined; name: string; }, unknown&gt;
import("@tanstack/react-query").UseQueryResult&lt;{ \[x: string\]: import("@thirdweb-dev/sdk").Json; description?: string \| undefined; image?: any; external\_link?: string \| undefined; name: string; }, unknown&gt;

a object containing the metadata

Expand Down
6 changes: 3 additions & 3 deletions packages/thirdweb-react/docs/react.usemintnftsupply.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ Use this to mint a new NFT on your [NFTContract](./react.nftcontract.md)
<b>Signature:</b>

```typescript
export declare function useMintNFTSupply(contract: Erc1155): import("@tanstack/react-query").UseMutationResult<import("@thirdweb-dev/sdk/dist/browser").TransactionResultWithId<{
export declare function useMintNFTSupply(contract: Erc1155): import("@tanstack/react-query").UseMutationResult<import("@thirdweb-dev/sdk").TransactionResultWithId<{
metadata: {
[x: string]: import("@thirdweb-dev/sdk/dist/browser").Json;
[x: string]: import("@thirdweb-dev/sdk").Json;
name?: string | number | undefined;
description?: string | null | undefined;
image?: string | null | undefined;
Expand All @@ -35,7 +35,7 @@ export declare function useMintNFTSupply(contract: Erc1155): import("@tanstack/r

<b>Returns:</b>

import("@tanstack/react-query").UseMutationResult&lt;import("@thirdweb-dev/sdk/dist/browser").TransactionResultWithId&lt;{ metadata: { \[x: string\]: import("@thirdweb-dev/sdk/dist/browser").Json; name?: string \| number \| undefined; description?: string \| null \| undefined; image?: string \| null \| undefined; external\_url?: string \| null \| undefined; animation\_url?: string \| null \| undefined; uri: string; id: BigNumber; }; supply: BigNumber; }&gt;, unknown, [MintNFTSupplyParams](./react.mintnftsupplyparams.md)<!-- -->, unknown&gt;
import("@tanstack/react-query").UseMutationResult&lt;import("@thirdweb-dev/sdk").TransactionResultWithId&lt;{ metadata: { \[x: string\]: import("@thirdweb-dev/sdk").Json; name?: string \| number \| undefined; description?: string \| null \| undefined; image?: string \| null \| undefined; external\_url?: string \| null \| undefined; animation\_url?: string \| null \| undefined; uri: string; id: BigNumber; }; supply: BigNumber; }&gt;, unknown, [MintNFTSupplyParams](./react.mintnftsupplyparams.md)<!-- -->, unknown&gt;

a mutation object that can be used to mint a more supply of a token id to the provided wallet

Expand Down
4 changes: 2 additions & 2 deletions packages/thirdweb-react/docs/react.useunclaimednfts.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Use this to get a list of \*unclaimed\* NFT tokens of your ERC721 Drop contract.

```typescript
export declare function useUnclaimedNFTs(contract: RequiredParam<NFTDrop>, queryParams?: QueryAllParams): import("@tanstack/react-query").UseQueryResult<{
[x: string]: import("@thirdweb-dev/sdk/dist/browser").Json;
[x: string]: import("@thirdweb-dev/sdk").Json;
name?: string | number | undefined;
description?: string | null | undefined;
image?: string | null | undefined;
Expand All @@ -33,7 +33,7 @@ export declare function useUnclaimedNFTs(contract: RequiredParam<NFTDrop>, query

<b>Returns:</b>

import("@tanstack/react-query").UseQueryResult&lt;{ \[x: string\]: import("@thirdweb-dev/sdk/dist/browser").Json; name?: string \| number \| undefined; description?: string \| null \| undefined; image?: string \| null \| undefined; external\_url?: string \| null \| undefined; animation\_url?: string \| null \| undefined; uri: string; id: import("ethers").BigNumber; }\[\], unknown&gt;
import("@tanstack/react-query").UseQueryResult&lt;{ \[x: string\]: import("@thirdweb-dev/sdk").Json; name?: string \| number \| undefined; description?: string \| null \| undefined; image?: string \| null \| undefined; external\_url?: string \| null \| undefined; animation\_url?: string \| null \| undefined; uri: string; id: import("ethers").BigNumber; }\[\], unknown&gt;

a response object that includes an array of NFTs that are unclaimed

Expand Down
4 changes: 2 additions & 2 deletions packages/thirdweb-react/docs/react.useupdatemetadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ export declare function useUpdateMetadata(contract: RequiredParam<SmartContract
receipt: import("@ethersproject/abstract-provider").TransactionReceipt;
data: () => Promise<any>;
}, unknown, {
[x: string]: import("@thirdweb-dev/sdk/dist/browser").Json;
[x: string]: import("@thirdweb-dev/sdk").Json;
description?: string | undefined;
image?: any;
external_link?: string | undefined;
Expand All @@ -32,7 +32,7 @@ export declare function useUpdateMetadata(contract: RequiredParam<SmartContract

<b>Returns:</b>

import("@tanstack/react-query").UseMutationResult&lt;{ receipt: import("@ethersproject/abstract-provider").TransactionReceipt; data: () =&gt; Promise&lt;any&gt;; }, unknown, { \[x: string\]: import("@thirdweb-dev/sdk/dist/browser").Json; description?: string \| undefined; image?: any; external\_link?: string \| undefined; name: string; }, unknown&gt;
import("@tanstack/react-query").UseMutationResult&lt;{ receipt: import("@ethersproject/abstract-provider").TransactionReceipt; data: () =&gt; Promise&lt;any&gt;; }, unknown, { \[x: string\]: import("@thirdweb-dev/sdk").Json; description?: string \| undefined; image?: any; external\_link?: string \| undefined; name: string; }, unknown&gt;

a mutation object that can be used to update the metadata

Expand Down
4 changes: 2 additions & 2 deletions packages/thirdweb-react/docs/react.usewinningbid.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Use this to get a the winning bid for an auction listing from your marketplace c
<b>Signature:</b>

```typescript
export declare function useWinningBid(contract: RequiredParam<Marketplace>, listingId: RequiredParam<BigNumberish>): import("@tanstack/react-query").UseQueryResult<import("@thirdweb-dev/sdk/dist/browser").Offer | undefined, unknown>;
export declare function useWinningBid(contract: RequiredParam<Marketplace>, listingId: RequiredParam<BigNumberish>): import("@tanstack/react-query").UseQueryResult<import("@thirdweb-dev/sdk").Offer | undefined, unknown>;
```

## Parameters
Expand All @@ -24,7 +24,7 @@ export declare function useWinningBid(contract: RequiredParam<Marketplace>, list

<b>Returns:</b>

import("@tanstack/react-query").UseQueryResult&lt;import("@thirdweb-dev/sdk/dist/browser").Offer \| undefined, unknown&gt;
import("@tanstack/react-query").UseQueryResult&lt;import("@thirdweb-dev/sdk").Offer \| undefined, unknown&gt;

a response object that includes the that is winning the auction

Expand Down
2 changes: 1 addition & 1 deletion packages/thirdweb-react/docs/react.web3button.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The button has to be wrapped in a `ThirdwebProvider` in order to function.
<b>Signature:</b>

```typescript
Web3Button: React.FC<PropsWithChildren<Web3ButtonProps>>
Web3Button: <TExecutableFn extends ExecutableFn>({ contractAddress, overrides, onSuccess, onError, onSubmit, isDisabled, children, functionName, params, callable, ...themeProps }: PropsWithChildren<Web3ButtonProps<TExecutableFn>>) => JSX.Element
```

## Example
Expand Down
Loading