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
2 changes: 1 addition & 1 deletion docs/react.claimineligibilityparameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The options to be passed as the second parameter to the `useClaimIneligibilityRe

```typescript
export declare type ClaimIneligibilityParameters = {
walletAddress?: WalletAddress;
walletAddress: WalletAddress;
quantity: string | number;
};
```
Expand Down
6 changes: 3 additions & 3 deletions docs/react.useclaimineligibilityreasons.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,20 +31,20 @@ a response object with the resons for the claim ineligibility


```javascript
const { data: activeClaimCondition, isLoading, error } = useClaimIneligibilityReasons(<YourERC20ContractInstance>);
const { data: activeClaimCondition, isLoading, error } = useClaimIneligibilityReasons(<YourERC20ContractInstance>, { walletAddress: <walletAddress> });
```

## Example 2


```javascript
const { data: claimIneligibilityReasons, isLoading, error } = useClaimIneligibilityReasons(<YourERC721ContractInstance>, {quantity: <quantity>});
const { data: claimIneligibilityReasons, isLoading, error } = useClaimIneligibilityReasons(<YourERC721ContractInstance>, { quantity: <quantity>, walletAddress: <walletAddress> });
```

## Example 3


```javascript
const { data: claimIneligibilityReasons, isLoading, error } = useClaimIneligibilityReasons(<YourERC1155ContractInstance>, {quantity: <quantity>}, <tokenId>);
const { data: claimIneligibilityReasons, isLoading, error } = useClaimIneligibilityReasons(<YourERC1155ContractInstance>, { quantity: <quantity>, walletAddress: <walletAddress> }, <tokenId>);
```

4 changes: 2 additions & 2 deletions docs/snippets.json
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,7 @@
},
{
"name": "useClaimIneligibilityReasons",
"example": "const { data: claimIneligibilityReasons, isLoading, error } = useClaimIneligibilityReasons(<YourERC1155ContractInstance>, {quantity: <quantity>}, <tokenId>);",
"example": "const { data: claimIneligibilityReasons, isLoading, error } = useClaimIneligibilityReasons(<YourERC1155ContractInstance>, { quantity: <quantity>, walletAddress: <walletAddress> }, <tokenId>);",
"reference": "https://portal.thirdweb.com/react/react.useclaimineligibilityreasons"
},
{
Expand Down Expand Up @@ -413,7 +413,7 @@
},
{
"name": "useClaimIneligibilityReasons",
"example": "const { data: claimIneligibilityReasons, isLoading, error } = useClaimIneligibilityReasons(<YourERC1155ContractInstance>, {quantity: <quantity>}, <tokenId>);",
"example": "const { data: claimIneligibilityReasons, isLoading, error } = useClaimIneligibilityReasons(<YourERC1155ContractInstance>, { quantity: <quantity>, walletAddress: <walletAddress> }, <tokenId>);",
"reference": "https://portal.thirdweb.com/react/react.useclaimineligibilityreasons"
},
{
Expand Down
2 changes: 1 addition & 1 deletion etc/react.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ export type ChainRpc<TSupportedChain extends SupportedChain> = Record<TSupported

// @beta
export type ClaimIneligibilityParameters = {
walletAddress?: WalletAddress;
walletAddress: WalletAddress;
quantity: string | number;
};

Expand Down
12 changes: 6 additions & 6 deletions src/hooks/async/claim-conditions.ts
Original file line number Diff line number Diff line change
Expand Up @@ -125,9 +125,9 @@ export function useClaimConditions<
* @beta
*/
export type ClaimIneligibilityParameters = {
// the wallet address to check claim elgibility for
walletAddress?: WalletAddress;
// the amount of tokens to check claim elibility for
// the wallet address to check claim eligibility for
walletAddress: WalletAddress;
// the amount of tokens to check claim eligibility for
quantity: string | number;
};

Expand All @@ -146,15 +146,15 @@ type ClaimIneligibilityInputParams<TContract> = TContract extends Erc1155
* Use this to check for reasons that prevent claiming for either ERC20, ERC721 or ERC1155 based contracts. They need to extend the `claimCondition` extension for this hook to work.
* @example
* ```javascript
* const { data: activeClaimCondition, isLoading, error } = useClaimIneligibilityReasons(<YourERC20ContractInstance>);
* const { data: activeClaimCondition, isLoading, error } = useClaimIneligibilityReasons(<YourERC20ContractInstance>, { walletAddress: <walletAddress> });
* ```
* @example
* ```javascript
* const { data: claimIneligibilityReasons, isLoading, error } = useClaimIneligibilityReasons(<YourERC721ContractInstance>, {quantity: <quantity>});
* const { data: claimIneligibilityReasons, isLoading, error } = useClaimIneligibilityReasons(<YourERC721ContractInstance>, { quantity: <quantity>, walletAddress: <walletAddress> });
* ```
* @example
* ```javascript
* const { data: claimIneligibilityReasons, isLoading, error } = useClaimIneligibilityReasons(<YourERC1155ContractInstance>, {quantity: <quantity>}, <tokenId>);
* const { data: claimIneligibilityReasons, isLoading, error } = useClaimIneligibilityReasons(<YourERC1155ContractInstance>, { quantity: <quantity>, walletAddress: <walletAddress> }, <tokenId>);
* ```
*
* @param contract - an instance of a contract that extends the ERC20, ERC721 or ERC1155 spec and implements the `claimConditions` extension.
Expand Down