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

upgrade react-query to @tanstack/react-query #112

Merged
merged 2 commits into from
Jul 27, 2022
Merged

upgrade react-query to @tanstack/react-query #112

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3305c22
upgrade react-query to @tanstack/react-query
jnsdls Jul 27, 2022
e3897b1
v2.6.0-0
jnsdls Jul 27, 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
4 changes: 2 additions & 2 deletions docs/react.useactiveclaimcondition.md
View file
Open in desktop
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 NFTDrop | EditionDrop | TokenDrop | SignatureDrop>(...[contract, tokenId]: ActiveClaimConditionParams<TContract>): import("react-query").UseQueryResult<{
export declare function useActiveClaimCondition<TContract extends NFTDrop | EditionDrop | TokenDrop | SignatureDrop>(...[contract, tokenId]: ActiveClaimConditionParams<TContract>): import("@tanstack/react-query").UseQueryResult<{
snapshot?: {
address: string;
maxClaimable: string;
Expand Down Expand Up @@ -44,7 +44,7 @@ export declare function useActiveClaimCondition<TContract extends NFTDrop | Edit

<b>Returns:</b>

import("react-query").UseQueryResult&lt;{ snapshot?: { address: string; maxClaimable: string; }\[\] \| undefined; quantityLimitPerTransaction: string; startTime: Date; price: import("ethers").BigNumber; currencyAddress: string; maxQuantity: string; waitInSeconds: import("ethers").BigNumber; merkleRootHash: string \| number\[\]; availableSupply: string; currentMintSupply: string; currencyMetadata: { symbol: string; value: import("ethers").BigNumber; name: string; decimals: number; displayValue: string; }; }, unknown&gt;
import("@tanstack/react-query").UseQueryResult&lt;{ snapshot?: { address: string; maxClaimable: string; }\[\] \| undefined; quantityLimitPerTransaction: string; startTime: Date; price: import("ethers").BigNumber; currencyAddress: string; maxQuantity: string; waitInSeconds: import("ethers").BigNumber; merkleRootHash: string \| number\[\]; availableSupply: string; currentMintSupply: string; currencyMetadata: { symbol: string; value: import("ethers").BigNumber; name: string; decimals: number; displayValue: string; }; }, unknown&gt;

a response object with the currently active claim condition

Expand Down
4 changes: 2 additions & 2 deletions docs/react.useactivelistings.md
View file
Open in desktop
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("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/dist/browser").AuctionListing | import("@thirdweb-dev/sdk/dist/browser").DirectListing)[], unknown>;
```

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

<b>Returns:</b>

import("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/dist/browser").AuctionListing \| import("@thirdweb-dev/sdk/dist/browser").DirectListing)\[\], unknown&gt;

a response object that includes an array of listings

Expand Down
4 changes: 2 additions & 2 deletions docs/react.useallcontractevents.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Use this to query (and subscribe) to all events on a contract.
export declare function useAllContractEvents(contract: RequiredParam<ReturnType<typeof useContract>["contract"]>, options?: {
queryFilter?: EventQueryFilter;
subscribe?: boolean;
}): import("react-query").UseQueryResult<ContractEvent[], unknown>;
}): import("@tanstack/react-query").UseQueryResult<ContractEvent[], unknown>;
```

## Parameters
Expand All @@ -27,7 +27,7 @@ export declare function useAllContractEvents(contract: RequiredParam<ReturnType<

<b>Returns:</b>

import("react-query").UseQueryResult&lt;ContractEvent\[\], unknown&gt;
import("@tanstack/react-query").UseQueryResult&lt;ContractEvent\[\], unknown&gt;

a response object that includes the contract events

4 changes: 2 additions & 2 deletions docs/react.useallrolemembers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Use this to get the roles of a
<b>Signature:</b>

```typescript
export declare function useAllRoleMembers<TContract extends ContractWithRoles>(contract: RequiredParam<TContract>): import("react-query").UseQueryResult<Awaited<Record<RolesForContract<TContract>, string[]>>, unknown>;
export declare function useAllRoleMembers<TContract extends ContractWithRoles>(contract: RequiredParam<TContract>): import("@tanstack/react-query").UseQueryResult<Awaited<Record<RolesForContract<TContract>, string[]>>, unknown>;
```

## Parameters
Expand All @@ -23,7 +23,7 @@ export declare function useAllRoleMembers<TContract extends ContractWithRoles>(c

<b>Returns:</b>

import("react-query").UseQueryResult&lt;Awaited&lt;Record&lt;RolesForContract&lt;TContract&gt;, string\[\]&gt;&gt;, unknown&gt;
import("@tanstack/react-query").UseQueryResult&lt;Awaited&lt;Record&lt;RolesForContract&lt;TContract&gt;, string\[\]&gt;&gt;, unknown&gt;

a list of addresses for all supported roles on the contract.

Expand Down
4 changes: 2 additions & 2 deletions docs/react.useauctionwinner.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ 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 | undefined, unknown>;
export declare function useAuctionWinner(contract: RequiredParam<Marketplace>, listingId: RequiredParam<BigNumberish>): import("@tanstack/react-query").UseQueryResult<string | undefined, unknown>;
```

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

<b>Returns:</b>

import("react-query").UseQueryResult&lt;string \| undefined, unknown&gt;
import("@tanstack/react-query").UseQueryResult&lt;string \| undefined, unknown&gt;

a response object that includes the address of the winner of the auction or undefined if there is no winner yet

Expand Down
4 changes: 2 additions & 2 deletions docs/react.usebalance.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ A hook to get the native or (optional) ERC20 token balance of the connected wall
<b>Signature:</b>

```typescript
export declare function useBalance(tokenAddress?: ContractAddress): import("react-query").UseQueryResult<{
export declare function useBalance(tokenAddress?: ContractAddress): import("@tanstack/react-query").UseQueryResult<{
symbol: string;
value: import("ethers").BigNumber;
name: string;
Expand All @@ -29,7 +29,7 @@ export declare function useBalance(tokenAddress?: ContractAddress): import("reac

<b>Returns:</b>

import("react-query").UseQueryResult&lt;{ symbol: string; value: import("ethers").BigNumber; name: string; decimals: number; displayValue: string; } \| undefined, unknown&gt;
import("@tanstack/react-query").UseQueryResult&lt;{ symbol: string; value: import("ethers").BigNumber; name: string; decimals: number; displayValue: string; } \| undefined, unknown&gt;

the balance of the connected wallet (native or ERC20)

4 changes: 2 additions & 2 deletions docs/react.usebidbuffer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Use this to get the buffer in basis points between offers from your marketplace
<b>Signature:</b>

```typescript
export declare function useBidBuffer(contract: RequiredParam<Marketplace>): import("react-query").UseQueryResult<BigNumber, unknown>;
export declare function useBidBuffer(contract: RequiredParam<Marketplace>): import("@tanstack/react-query").UseQueryResult<BigNumber, unknown>;
```

## Parameters
Expand All @@ -23,7 +23,7 @@ export declare function useBidBuffer(contract: RequiredParam<Marketplace>): impo

<b>Returns:</b>

import("react-query").UseQueryResult&lt;BigNumber, unknown&gt;
import("@tanstack/react-query").UseQueryResult&lt;BigNumber, unknown&gt;

a response object that includes an array of listings

Expand Down
4 changes: 2 additions & 2 deletions docs/react.usebuynow.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Use this to buy out an auction listing from your marketplace contract.
<b>Signature:</b>

```typescript
export declare function useBuyNow(contract: RequiredParam<Marketplace>): import("react-query").UseMutationResult<Omit<{
export declare function useBuyNow(contract: RequiredParam<Marketplace>): import("@tanstack/react-query").UseMutationResult<Omit<{
receipt: import("@ethersproject/abstract-provider").TransactionReceipt;
data: () => Promise<unknown>;
}, "data">, unknown, {
Expand All @@ -34,7 +34,7 @@ export declare function useBuyNow(contract: RequiredParam<Marketplace>): import(

<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, { id: BigNumberish; type: ListingType.Direct; buyAmount: BigNumberish; buyForWallet?: string \| undefined; } \| { id: BigNumberish; type: ListingType.Auction; }, unknown&gt;
import("@tanstack/react-query").UseMutationResult&lt;Omit&lt;{ receipt: import("@ethersproject/abstract-provider").TransactionReceipt; data: () =&gt; Promise&lt;unknown&gt;; }, "data"&gt;, unknown, { id: BigNumberish; type: ListingType.Direct; buyAmount: BigNumberish; buyForWallet?: string \| undefined; } \| { id: BigNumberish; type: ListingType.Auction; }, unknown&gt;

a mutation object that can be used to buy out an auction listing

Expand Down
4 changes: 2 additions & 2 deletions docs/react.useclaimconditions.md
View file
Open in desktop
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 NFTDrop | EditionDrop | TokenDrop | SignatureDrop>(...[contract, tokenId]: ActiveClaimConditionParams<TContract>): import("react-query").UseQueryResult<{
export declare function useClaimConditions<TContract extends NFTDrop | EditionDrop | TokenDrop | SignatureDrop>(...[contract, tokenId]: ActiveClaimConditionParams<TContract>): import("@tanstack/react-query").UseQueryResult<{
snapshot?: {
address: string;
maxClaimable: string;
Expand Down Expand Up @@ -44,7 +44,7 @@ export declare function useClaimConditions<TContract extends NFTDrop | EditionDr

<b>Returns:</b>

import("react-query").UseQueryResult&lt;{ snapshot?: { address: string; maxClaimable: string; }\[\] \| undefined; quantityLimitPerTransaction: string; startTime: Date; price: import("ethers").BigNumber; currencyAddress: string; maxQuantity: string; waitInSeconds: import("ethers").BigNumber; merkleRootHash: string \| number\[\]; availableSupply: string; currentMintSupply: string; currencyMetadata: { symbol: string; value: import("ethers").BigNumber; name: string; decimals: number; displayValue: string; }; }\[\], unknown&gt;
import("@tanstack/react-query").UseQueryResult&lt;{ snapshot?: { address: string; maxClaimable: string; }\[\] \| undefined; quantityLimitPerTransaction: string; startTime: Date; price: import("ethers").BigNumber; currencyAddress: string; maxQuantity: string; waitInSeconds: import("ethers").BigNumber; merkleRootHash: string \| number\[\]; availableSupply: string; currentMintSupply: string; currencyMetadata: { symbol: string; value: import("ethers").BigNumber; name: string; decimals: number; displayValue: string; }; }\[\], unknown&gt;

a response object with the list of claim conditions

Expand Down
4 changes: 2 additions & 2 deletions docs/react.useclaimednfts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ 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<DropContract>, queryParams?: QueryAllParams): import("react-query").UseQueryResult<import("../../types").NFT<DropContract>[], unknown>;
export declare function useClaimedNFTs(contract: RequiredParam<DropContract>, queryParams?: QueryAllParams): import("@tanstack/react-query").UseQueryResult<import("../../types").NFT<DropContract>[], unknown>;
```

## Parameters
Expand All @@ -24,7 +24,7 @@ export declare function useClaimedNFTs(contract: RequiredParam<DropContract>, qu

<b>Returns:</b>

import("react-query").UseQueryResult&lt;import("../../types").[NFT](./react.nft.md)<!-- -->&lt;[DropContract](./react.dropcontract.md)<!-- -->&gt;\[\], unknown&gt;
import("@tanstack/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

Expand Down
4 changes: 2 additions & 2 deletions docs/react.useclaimednftsupply.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<b>Signature:</b>

```typescript
export declare function useClaimedNFTSupply(contract: RequiredParam<DropContract>): import("react-query").UseQueryResult<import("ethers").BigNumber, unknown>;
export declare function useClaimedNFTSupply(contract: RequiredParam<DropContract>): import("@tanstack/react-query").UseQueryResult<import("ethers").BigNumber, unknown>;
```

## Parameters
Expand All @@ -18,7 +18,7 @@ export declare function useClaimedNFTSupply(contract: RequiredParam<DropContract

<b>Returns:</b>

import("react-query").UseQueryResult&lt;import("ethers").BigNumber, unknown&gt;
import("@tanstack/react-query").UseQueryResult&lt;import("ethers").BigNumber, unknown&gt;

a response object that includes the number of NFTs that are claimed

4 changes: 2 additions & 2 deletions docs/react.useclaimineligibilityreasons.md
View file
Open in desktop
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 NFTDrop | EditionDrop | TokenDrop | SignatureDrop>(...[contract, params, tokenId]: ClaimIneligibilityInputParams<TContract>): import("react-query").UseQueryResult<import("@thirdweb-dev/sdk/dist/browser").ClaimEligibility[], unknown>;
export declare function useClaimIneligibilityReasons<TContract extends NFTDrop | EditionDrop | TokenDrop | SignatureDrop>(...[contract, params, tokenId]: ClaimIneligibilityInputParams<TContract>): import("@tanstack/react-query").UseQueryResult<import("@thirdweb-dev/sdk/dist/browser").ClaimEligibility[], unknown>;
```

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

<b>Returns:</b>

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

a response object with the resons for the claim ineligibility

Expand Down
4 changes: 2 additions & 2 deletions docs/react.useclaimnft.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Use this to claim a NFT on your [DropContract](./react.dropcontract.md)
<b>Signature:</b>

```typescript
export declare function useClaimNFT<TContract extends DropContract>(contract: RequiredParam<TContract>): import("react-query").UseMutationResult<ClaimNFTReturnType<TContract>, unknown, ClaimNFTParams<TContract>, unknown>;
export declare function useClaimNFT<TContract extends DropContract>(contract: RequiredParam<TContract>): import("@tanstack/react-query").UseMutationResult<ClaimNFTReturnType<TContract>, unknown, ClaimNFTParams<TContract>, unknown>;
```

## Parameters
Expand All @@ -23,7 +23,7 @@ export declare function useClaimNFT<TContract extends DropContract>(contract: Re

<b>Returns:</b>

import("react-query").UseMutationResult&lt;[ClaimNFTReturnType](./react.claimnftreturntype.md)<!-- -->&lt;TContract&gt;, unknown, [ClaimNFTParams](./react.claimnftparams.md)<!-- -->&lt;TContract&gt;, unknown&gt;
import("@tanstack/react-query").UseMutationResult&lt;[ClaimNFTReturnType](./react.claimnftreturntype.md)<!-- -->&lt;TContract&gt;, unknown, [ClaimNFTParams](./react.claimnftparams.md)<!-- -->&lt;TContract&gt;, unknown&gt;

a mutation object that can be used to claim a NFT to the wallet specificed in the params

Expand Down
4 changes: 2 additions & 2 deletions docs/react.useclaimtoken.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Use this to claim tokens on your
<b>Signature:</b>

```typescript
export declare function useClaimToken<TContract extends TokenDrop>(contract: RequiredParam<TContract>): import("react-query").UseMutationResult<Omit<{
export declare function useClaimToken<TContract extends TokenDrop>(contract: RequiredParam<TContract>): import("@tanstack/react-query").UseMutationResult<Omit<{
receipt: import("@ethersproject/abstract-provider").TransactionReceipt;
data: () => Promise<unknown>;
}, "data">, unknown, ClaimTokenParams, unknown>;
Expand All @@ -26,7 +26,7 @@ export declare function useClaimToken<TContract extends TokenDrop>(contract: Req

<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, [ClaimTokenParams](./react.claimtokenparams.md)<!-- -->, unknown&gt;
import("@tanstack/react-query").UseMutationResult&lt;Omit&lt;{ receipt: import("@ethersproject/abstract-provider").TransactionReceipt; data: () =&gt; Promise&lt;unknown&gt;; }, "data"&gt;, unknown, [ClaimTokenParams](./react.claimtokenparams.md)<!-- -->, unknown&gt;

a mutation object that can be used to tokens to the wallet specificed in the params

Expand Down
Loading