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
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Use this to get the active claim conditon for ERC20, ERC721 or ERC1155 based con
<b>Signature:</b>

```typescript
export declare function useActiveClaimCondition<TContract extends NFTContract>(...[contract, tokenId]: ClaimConditionsInputParams<TContract>): import("@tanstack/react-query").UseQueryResult<{
export declare function useActiveClaimCondition<TContract extends NFTContract | Erc20>(...[contract, tokenId]: ClaimConditionsInputParams<TContract>): import("@tanstack/react-query").UseQueryResult<{
snapshot?: {
address: string;
maxClaimable: string;
Expand Down
2 changes: 1 addition & 1 deletion packages/thirdweb-react/docs/react.useclaimconditions.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Use this to get all claim conditons for ERC20, ERC721 or ERC1155 based contracts
<b>Signature:</b>

```typescript
export declare function useClaimConditions<TContract extends NFTContract>(...[contract, tokenId]: ClaimConditionsInputParams<TContract>): import("@tanstack/react-query").UseQueryResult<{
export declare function useClaimConditions<TContract extends NFTContract | Erc20>(...[contract, tokenId]: ClaimConditionsInputParams<TContract>): import("@tanstack/react-query").UseQueryResult<{
snapshot?: {
address: string;
maxClaimable: string;
Expand Down
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>(...[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/dist/browser").ClaimEligibility[], unknown>;
```

## Parameters
Expand Down
4 changes: 2 additions & 2 deletions packages/thirdweb-react/docs/react.uselazymint.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Use this to lazy mint a batch of NFTs on your [DropContract](./react.dropcontrac
```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;
name?: string | undefined;
name?: string | number | undefined;
description?: string | null | undefined;
image?: string | null | undefined;
external_url?: 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 \| 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/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;

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.usemintnftsupply.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Use this to mint a new NFT on your [NFTContract](./react.nftcontract.md)
export declare function useMintNFTSupply(contract: Erc1155): import("@tanstack/react-query").UseMutationResult<import("@thirdweb-dev/sdk/dist/browser").TransactionResultWithId<{
metadata: {
[x: string]: import("@thirdweb-dev/sdk/dist/browser").Json;
name?: string | undefined;
name?: string | number | undefined;
description?: string | null | undefined;
image?: string | null | undefined;
external_url?: 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 \| 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/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;

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Use this to reset claim conditions on your [NFTContract](./react.nftcontract.md)
<b>Signature:</b>

```typescript
export declare function useResetClaimConditions<TContract extends NFTContract>(...[contract, tokenId]: ClaimConditionsInputParams<TContract>): import("@tanstack/react-query").UseMutationResult<Omit<{
export declare function useResetClaimConditions<TContract extends NFTContract | Erc20>(...[contract, tokenId]: ClaimConditionsInputParams<TContract>): import("@tanstack/react-query").UseMutationResult<Omit<{
receipt: import("@ethersproject/abstract-provider").TransactionReceipt;
data: () => Promise<unknown>;
}, "data"> | undefined, unknown, void, unknown>;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Use this to set claim conditions on your [NFTContract](./react.nftcontract.md)
<b>Signature:</b>

```typescript
export declare function useSetClaimConditions<TContract extends NFTContract>(...[contract, tokenId]: ClaimConditionsInputParams<TContract>): import("@tanstack/react-query").UseMutationResult<Omit<{
export declare function useSetClaimConditions<TContract extends NFTContract | Erc20>(...[contract, tokenId]: ClaimConditionsInputParams<TContract>): import("@tanstack/react-query").UseMutationResult<Omit<{
receipt: import("@ethersproject/abstract-provider").TransactionReceipt;
data: () => Promise<unknown>;
}, "data"> | undefined, unknown, SetClaimConditionsParams, unknown>;
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 @@ -14,7 +14,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;
name?: string | undefined;
name?: string | number | undefined;
description?: string | null | undefined;
image?: string | null | undefined;
external_url?: 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 \| 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/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;

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

Expand Down
21 changes: 9 additions & 12 deletions packages/thirdweb-react/etc/react.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,12 @@ import { Edition } from '@thirdweb-dev/sdk/dist/browser';
import { EditionDrop } from '@thirdweb-dev/sdk/dist/browser';
import { Erc1155 } from '@thirdweb-dev/sdk/dist/browser';
import type { Erc1155Mintable } from '@thirdweb-dev/sdk/dist/browser';
import type { Erc20 } from '@thirdweb-dev/sdk/dist/browser';
import { Erc20 } from '@thirdweb-dev/sdk/dist/browser';
import type { Erc721 } from '@thirdweb-dev/sdk/dist/browser';
import type { Erc721Mintable } from '@thirdweb-dev/sdk/dist/browser';
import type { EventQueryFilter } from '@thirdweb-dev/sdk/dist/browser';
import { FetchStatus } from '@tanstack/react-query';
import { InjectedConnector } from 'wagmi/connectors/injected';
import { IpfsStorage } from '@thirdweb-dev/sdk/dist/browser';
import { IStorage } from '@thirdweb-dev/sdk/dist/browser';
import { Json } from '@thirdweb-dev/sdk/dist/browser';
import { ListingType } from '@thirdweb-dev/sdk/dist/browser';
Expand Down Expand Up @@ -204,8 +203,6 @@ export type InjectedConnectorType = "injected" | "metamask" | {
options?: InjectedConnector["options"];
};

export { IpfsStorage }

// @public (undocumented)
export interface LoginConfig {
onError?: (error: string) => void;
Expand Down Expand Up @@ -404,7 +401,7 @@ export function useActiveChainId(): SUPPORTED_CHAIN_ID | undefined;
// Warning: (ae-forgotten-export) The symbol "ClaimConditionsInputParams" needs to be exported by the entry point thirdweb-dev-react.cjs.d.ts
//
// @beta
export function useActiveClaimCondition<TContract extends NFTContract>(...[contract, tokenId]: ClaimConditionsInputParams<TContract>): UseQueryResult< {
export function useActiveClaimCondition<TContract extends NFTContract | Erc20>(...[contract, tokenId]: ClaimConditionsInputParams<TContract>): UseQueryResult< {
snapshot?: {
address: string;
maxClaimable: string;
Expand Down Expand Up @@ -521,7 +518,7 @@ type: ListingType.Auction;
export function useChainId(): number | undefined;

// @beta
export function useClaimConditions<TContract extends NFTContract>(...[contract, tokenId]: ClaimConditionsInputParams<TContract>): UseQueryResult< {
export function useClaimConditions<TContract extends NFTContract | Erc20>(...[contract, tokenId]: ClaimConditionsInputParams<TContract>): UseQueryResult< {
snapshot?: {
address: string;
maxClaimable: string;
Expand Down Expand Up @@ -556,7 +553,7 @@ export function useClaimedNFTSupply(contract: RequiredParam<DropContract>): UseQ
// Warning: (ae-forgotten-export) The symbol "ClaimIneligibilityInputParams" needs to be exported by the entry point thirdweb-dev-react.cjs.d.ts
//
// @beta
export function useClaimIneligibilityReasons<TContract extends NFTContract>(...[contract, params, tokenId]: ClaimIneligibilityInputParams<TContract>): UseQueryResult<ClaimEligibility[], unknown>;
export function useClaimIneligibilityReasons<TContract extends NFTContract | Erc20>(...[contract, params, tokenId]: ClaimIneligibilityInputParams<TContract>): UseQueryResult<ClaimEligibility[], unknown>;

// @beta
export function useClaimNFT<TContract extends DropContract>(contract: RequiredParam<TContract>): UseMutationResult<ClaimNFTReturnType<TContract>, unknown, ClaimNFTParams<TContract>, unknown>;
Expand Down Expand Up @@ -1488,7 +1485,7 @@ export function useIsAddressRole<TContract extends ContractWithRoles>(contract:
// @beta
export function useLazyMint<TContract extends NFTContract>(contract: RequiredParam<TContract>, onProgress?: (progress: UploadProgressEvent) => void): UseMutationResult<TransactionResultWithId< {
[x: string]: Json;
name?: string | undefined;
name?: string | number | undefined;
description?: string | null | undefined;
image?: string | null | undefined;
external_url?: string | null | undefined;
Expand Down Expand Up @@ -1550,7 +1547,7 @@ export function useMintNFT<TContract extends NFTContract>(contract: RequiredPara
export function useMintNFTSupply(contract: Erc1155): UseMutationResult<TransactionResultWithId< {
metadata: {
[x: string]: Json;
name?: string | undefined;
name?: string | number | undefined;
description?: string | null | undefined;
image?: string | null | undefined;
external_url?: string | null | undefined;
Expand Down Expand Up @@ -1652,7 +1649,7 @@ export { useProvider }
export function useReadonlySDK(readonlyRpcUrl: string, sdkOptions: SDKOptions, storageInterface?: IStorage): ThirdwebSDK;

// @beta
export function useResetClaimConditions<TContract extends NFTContract>(...[contract, tokenId]: ClaimConditionsInputParams<TContract>): UseMutationResult<Omit<{
export function useResetClaimConditions<TContract extends NFTContract | Erc20>(...[contract, tokenId]: ClaimConditionsInputParams<TContract>): UseMutationResult<Omit<{
receipt: TransactionReceipt;
data: () => Promise<unknown>;
}, "data"> | undefined, unknown, void, unknown>;
Expand Down Expand Up @@ -1699,7 +1696,7 @@ export function useSDK(): ThirdwebSDK | undefined;
export function useSetAllRoleMembers<TContract extends ContractWithRoles>(contract: RequiredParam<TContract>): UseMutationResult<void, unknown, { [role in RolesForContract<TContract>]: string[]; }, unknown>;

// @beta
export function useSetClaimConditions<TContract extends NFTContract>(...[contract, tokenId]: ClaimConditionsInputParams<TContract>): UseMutationResult<Omit<{
export function useSetClaimConditions<TContract extends NFTContract | Erc20>(...[contract, tokenId]: ClaimConditionsInputParams<TContract>): UseMutationResult<Omit<{
receipt: TransactionReceipt;
data: () => Promise<unknown>;
}, "data"> | undefined, unknown, SetClaimConditionsParams, unknown>;
Expand Down Expand Up @@ -1766,7 +1763,7 @@ data: () => Promise<unknown>;
// @beta
export function useUnclaimedNFTs(contract: RequiredParam<NFTDrop>, queryParams?: QueryAllParams): UseQueryResult< {
[x: string]: Json;
name?: string | undefined;
name?: string | number | undefined;
description?: string | null | undefined;
image?: string | null | undefined;
external_url?: string | null | undefined;
Expand Down
2 changes: 1 addition & 1 deletion packages/thirdweb-react/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
"@microsoft/api-extractor": "^7.19.4",
"@microsoft/tsdoc": "^0.14.1",
"@preconstruct/cli": "^2.2.1",
"@thirdweb-dev/sdk": "^2.3.35",
"@thirdweb-dev/sdk": "^2.3.39",
"@trivago/prettier-plugin-sort-imports": "^3.2.0",
"@types/color": "^3.0.3",
"@types/mime": "^3.0.1",
Expand Down
15 changes: 8 additions & 7 deletions packages/thirdweb-react/src/hooks/async/claim-conditions.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import { useMutation, useQueryClient } from "@tanstack/react-query";
import {
ClaimCondition,
ClaimConditionInput,
Erc20,
Erc1155,
} from "@thirdweb-dev/sdk/dist/browser";
import { BigNumberish } from "ethers";
Expand Down Expand Up @@ -77,7 +78,7 @@ export type SetClaimConditionsParams = {
*
* @beta
*/
export function useActiveClaimCondition<TContract extends NFTContract>(
export function useActiveClaimCondition<TContract extends NFTContract | Erc20>(
...[contract, tokenId]: ClaimConditionsInputParams<TContract>
) {
const contractAddress = contract?.getAddress();
Expand Down Expand Up @@ -127,7 +128,7 @@ export function useActiveClaimCondition<TContract extends NFTContract>(
*
* @beta
*/
export function useClaimConditions<TContract extends NFTContract>(
export function useClaimConditions<TContract extends NFTContract | Erc20>(
...[contract, tokenId]: ClaimConditionsInputParams<TContract>
) {
const contractAddress = contract?.getAddress();
Expand Down Expand Up @@ -177,9 +178,9 @@ export function useClaimConditions<TContract extends NFTContract>(
*
* @beta
*/
export function useClaimIneligibilityReasons<TContract extends NFTContract>(
...[contract, params, tokenId]: ClaimIneligibilityInputParams<TContract>
) {
export function useClaimIneligibilityReasons<
TContract extends NFTContract | Erc20,
>(...[contract, params, tokenId]: ClaimIneligibilityInputParams<TContract>) {
const contractAddress = contract?.getAddress();

return useQueryWithNetwork(
Expand Down Expand Up @@ -284,7 +285,7 @@ export function useClaimIneligibilityReasons<TContract extends NFTContract>(
* @returns a mutation object that can be used to set claim conditions
* @beta
*/
export function useSetClaimConditions<TContract extends NFTContract>(
export function useSetClaimConditions<TContract extends NFTContract | Erc20>(
...[contract, tokenId]: ClaimConditionsInputParams<TContract>
) {
const activeChainId = useActiveChainId();
Expand Down Expand Up @@ -370,7 +371,7 @@ export function useSetClaimConditions<TContract extends NFTContract>(
* @returns a mutation object that can be used to reset claim conditions
* @beta
*/
export function useResetClaimConditions<TContract extends NFTContract>(
export function useResetClaimConditions<TContract extends NFTContract | Erc20>(
...[contract, tokenId]: ClaimConditionsInputParams<TContract>
) {
const activeChainId = useActiveChainId();
Expand Down
2 changes: 1 addition & 1 deletion packages/thirdweb-react/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ export * from "./hooks/useNetwork";

// re-exports
export { defaultChains, defaultL2Chains, useAccount, useProvider } from "wagmi";
export { ChainId, IpfsStorage } from "@thirdweb-dev/sdk/dist/browser";
export { ChainId } from "@thirdweb-dev/sdk/dist/browser";

// async hooks
export * from "./hooks/async/contracts";
Expand Down
Loading