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
30 changes: 15 additions & 15 deletions docs/react.usecontract.md

Large diffs are not rendered by default.

10 changes: 8 additions & 2 deletions docs/react.usecontractmetadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,13 @@ Use this to get the contract metadata for a (built-in or custom) contract.
<b>Signature:</b>

```typescript
export declare function useContractMetadata(contractAddress: RequiredParam<string>): import("react-query").UseQueryResult<any, unknown>;
export declare function useContractMetadata(contractAddress: RequiredParam<string>): import("react-query").UseQueryResult<{
[x: string]: import("@thirdweb-dev/sdk").Json;
name: string;
description?: string | undefined;
image?: any;
external_link?: string | undefined;
} | null, unknown>;
```

## Parameters
Expand All @@ -23,7 +29,7 @@ export declare function useContractMetadata(contractAddress: RequiredParam<strin

<b>Returns:</b>

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

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

Expand Down
8 changes: 4 additions & 4 deletions docs/react.useeditions.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,17 +13,17 @@ Use this to get a list of NFT tokens of your ERC1155 contract.

```typescript
export declare function useEditions(contract: RequiredParam<Erc1155>, queryParams?: QueryAllParams): import("react-query").UseQueryResult<{
supply: import("ethers").BigNumber;
metadata: {
[x: string]: import("@thirdweb-dev/sdk").Json;
name?: string | undefined;
uri: string;
id: import("ethers").BigNumber;
description?: string | undefined;
image?: string | undefined;
external_url?: string | undefined;
animation_url?: string | undefined;
uri: string;
id: import("ethers").BigNumber;
};
supply: import("ethers").BigNumber;
}[], unknown>;
```

Expand All @@ -36,7 +36,7 @@ export declare function useEditions(contract: RequiredParam<Erc1155>, queryParam

<b>Returns:</b>

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

a response object that includes an array of NFTs

Expand Down
8 changes: 4 additions & 4 deletions docs/react.usemintedition.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,17 +13,17 @@ Use this to mint a new NFT on your ERC1155 contract

```typescript
export declare function useMintEdition(contract: RequiredParam<Erc1155>): import("react-query").UseMutationResult<import("@thirdweb-dev/sdk").TransactionResultWithId<{
supply: import("ethers").BigNumber;
metadata: {
[x: string]: import("@thirdweb-dev/sdk").Json;
name?: string | undefined;
uri: string;
id: import("ethers").BigNumber;
description?: string | undefined;
image?: string | undefined;
external_url?: string | undefined;
animation_url?: string | undefined;
uri: string;
id: import("ethers").BigNumber;
};
supply: import("ethers").BigNumber;
}>, unknown, EditionMintParams, unknown>;
```

Expand All @@ -35,7 +35,7 @@ export declare function useMintEdition(contract: RequiredParam<Erc1155>): import

<b>Returns:</b>

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

a mutation object that can be used to mint a new Edition token to the connected wallet

Expand Down
4 changes: 2 additions & 2 deletions docs/react.usetokenbalance.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ Use this to get the balance of your Token contract for a given address.
export declare function useTokenBalance(contract: RequiredParam<Erc20>, address: RequiredParam<string>): import("react-query").UseQueryResult<{
symbol: string;
name: string;
value: import("ethers").BigNumber;
decimals: number;
value: import("ethers").BigNumber;
displayValue: string;
}, unknown>;
```
Expand All @@ -30,7 +30,7 @@ export declare function useTokenBalance(contract: RequiredParam<Erc20>, address:

<b>Returns:</b>

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

a response object that includes the balance of the address

Expand Down
4 changes: 2 additions & 2 deletions docs/react.usetokensupply.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ Use this to get a the total supply of your Token contract.
export declare function useTokenSupply(contract: RequiredParam<Erc20>): import("react-query").UseQueryResult<{
symbol: string;
name: string;
value: import("ethers").BigNumber;
decimals: number;
value: import("ethers").BigNumber;
displayValue: string;
}, unknown>;
```
Expand All @@ -29,7 +29,7 @@ export declare function useTokenSupply(contract: RequiredParam<Erc20>): import("

<b>Returns:</b>

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

a response object that incudes the total minted supply

Expand Down
6 changes: 3 additions & 3 deletions docs/react.useunclaimednfts.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,12 @@ Use this to get a list of \*unclaimed\* NFT tokens of your ERC721 Drop contract.
export declare function useUnclaimedNFTs(contract: RequiredParam<NFTDrop>, queryParams?: QueryAllParams): import("react-query").UseQueryResult<{
[x: string]: import("@thirdweb-dev/sdk").Json;
name?: string | undefined;
uri: string;
id: import("ethers").BigNumber;
description?: string | undefined;
image?: string | undefined;
external_url?: string | undefined;
animation_url?: string | undefined;
uri: string;
id: import("ethers").BigNumber;
}[], unknown>;
```

Expand All @@ -33,7 +33,7 @@ export declare function useUnclaimedNFTs(contract: RequiredParam<NFTDrop>, query

<b>Returns:</b>

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

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

Expand Down
56 changes: 31 additions & 25 deletions etc/react.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -289,10 +289,10 @@ export function useContract(contractAddress: RequiredParam<string>): {
isStale: boolean;
refetch: <TPageData>(options?: (RefetchOptions & RefetchQueryFilters<TPageData>) | undefined) => Promise<QueryObserverResult< {
contractType: "split" | "nft-drop" | "nft-collection" | "edition-drop" | "edition" | "token-drop" | "token" | "vote" | "marketplace" | "pack" | undefined;
pubishMetadata: null;
publishMetadata: null;
} | {
contractType: "custom";
pubishMetadata: PublishedMetadata | undefined;
publishMetadata: PublishedMetadata | undefined;
} | undefined, unknown>>;
remove: () => void;
fetchStatus: FetchStatus;
Expand All @@ -319,21 +319,21 @@ export function useContract(contractAddress: RequiredParam<string>): {
isStale: boolean;
refetch: <TPageData>(options?: (RefetchOptions & RefetchQueryFilters<TPageData>) | undefined) => Promise<QueryObserverResult< {
contractType: "split" | "nft-drop" | "nft-collection" | "edition-drop" | "edition" | "token-drop" | "token" | "vote" | "marketplace" | "pack" | undefined;
pubishMetadata: null;
publishMetadata: null;
} | {
contractType: "custom";
pubishMetadata: PublishedMetadata | undefined;
publishMetadata: PublishedMetadata | undefined;
} | undefined, unknown>>;
remove: () => void;
fetchStatus: FetchStatus;
} | {
contract: Split | NFTDrop | NFTCollection | EditionDrop | Edition | TokenDrop | Token | Vote | Marketplace | Pack | SmartContract<any> | undefined;
contract: SmartContract<any> | undefined;
data: {
contractType: "split" | "nft-drop" | "nft-collection" | "edition-drop" | "edition" | "token-drop" | "token" | "vote" | "marketplace" | "pack" | undefined;
pubishMetadata: null;
publishMetadata: null;
} | {
contractType: "custom";
pubishMetadata: PublishedMetadata | undefined;
publishMetadata: PublishedMetadata | undefined;
} | undefined;
error: unknown;
isError: true;
Expand All @@ -355,21 +355,21 @@ export function useContract(contractAddress: RequiredParam<string>): {
isStale: boolean;
refetch: <TPageData>(options?: (RefetchOptions & RefetchQueryFilters<TPageData>) | undefined) => Promise<QueryObserverResult< {
contractType: "split" | "nft-drop" | "nft-collection" | "edition-drop" | "edition" | "token-drop" | "token" | "vote" | "marketplace" | "pack" | undefined;
pubishMetadata: null;
publishMetadata: null;
} | {
contractType: "custom";
pubishMetadata: PublishedMetadata | undefined;
publishMetadata: PublishedMetadata | undefined;
} | undefined, unknown>>;
remove: () => void;
fetchStatus: FetchStatus;
} | {
contract: Split | NFTDrop | NFTCollection | EditionDrop | Edition | TokenDrop | Token | Vote | Marketplace | Pack | SmartContract<any> | undefined;
contract: SmartContract<any> | undefined;
data: {
contractType: "split" | "nft-drop" | "nft-collection" | "edition-drop" | "edition" | "token-drop" | "token" | "vote" | "marketplace" | "pack" | undefined;
pubishMetadata: null;
publishMetadata: null;
} | {
contractType: "custom";
pubishMetadata: PublishedMetadata | undefined;
publishMetadata: PublishedMetadata | undefined;
} | undefined;
error: null;
isError: false;
Expand All @@ -391,10 +391,10 @@ export function useContract(contractAddress: RequiredParam<string>): {
isStale: boolean;
refetch: <TPageData>(options?: (RefetchOptions & RefetchQueryFilters<TPageData>) | undefined) => Promise<QueryObserverResult< {
contractType: "split" | "nft-drop" | "nft-collection" | "edition-drop" | "edition" | "token-drop" | "token" | "vote" | "marketplace" | "pack" | undefined;
pubishMetadata: null;
publishMetadata: null;
} | {
contractType: "custom";
pubishMetadata: PublishedMetadata | undefined;
publishMetadata: PublishedMetadata | undefined;
} | undefined, unknown>>;
remove: () => void;
fetchStatus: FetchStatus;
Expand All @@ -406,7 +406,13 @@ export function useContract(contractAddress: RequiredParam<string>): {
export function useContractFunctions(contractAddress: RequiredParam<string>): UseQueryResult<AbiFunction[] | null, unknown>;

// @beta
export function useContractMetadata(contractAddress: RequiredParam<string>): UseQueryResult<any, unknown>;
export function useContractMetadata(contractAddress: RequiredParam<string>): UseQueryResult< {
[x: string]: Json;
name: string;
description?: string | undefined;
image?: any;
external_link?: string | undefined;
} | null, unknown>;

// @beta
export function useContractPublishMetadata(contractAddress: RequiredParam<string>): UseQueryResult<PublishedMetadata | undefined, unknown>;
Expand Down Expand Up @@ -441,17 +447,17 @@ export function useEditionDrop(contractAddress?: string): EditionDrop | undefine

// @beta
export function useEditions(contract: RequiredParam<Erc1155>, queryParams?: QueryAllParams): UseQueryResult< {
supply: BigNumber;
metadata: {
[x: string]: Json;
name?: string | undefined;
uri: string;
id: BigNumber;
description?: string | undefined;
image?: string | undefined;
external_url?: string | undefined;
animation_url?: string | undefined;
uri: string;
id: BigNumber;
};
supply: BigNumber;
}[], unknown>;

// @beta
Expand Down Expand Up @@ -482,17 +488,17 @@ export function useMetamask(): () => Promise<{

// @beta
export function useMintEdition(contract: RequiredParam<Erc1155>): UseMutationResult<TransactionResultWithId< {
supply: BigNumber;
metadata: {
[x: string]: Json;
name?: string | undefined;
uri: string;
id: BigNumber;
description?: string | undefined;
image?: string | undefined;
external_url?: string | undefined;
animation_url?: string | undefined;
uri: string;
id: BigNumber;
};
supply: BigNumber;
}>, unknown, EditionMintParams, unknown>;

// @beta
Expand Down Expand Up @@ -584,8 +590,8 @@ export function useToken(contractAddress?: string): Token | undefined;
export function useTokenBalance(contract: RequiredParam<Erc20>, address: RequiredParam<string>): UseQueryResult< {
symbol: string;
name: string;
value: BigNumber;
decimals: number;
value: BigNumber;
displayValue: string;
}, unknown>;

Expand All @@ -598,21 +604,21 @@ export function useTokenDrop(contractAddress?: string): TokenDrop | undefined;
export function useTokenSupply(contract: RequiredParam<Erc20>): UseQueryResult< {
symbol: string;
name: string;
value: BigNumber;
decimals: number;
value: BigNumber;
displayValue: string;
}, unknown>;

// @beta
export function useUnclaimedNFTs(contract: RequiredParam<NFTDrop>, queryParams?: QueryAllParams): UseQueryResult< {
[x: string]: Json;
name?: string | undefined;
uri: string;
id: BigNumber;
description?: string | undefined;
image?: string | undefined;
external_url?: string | undefined;
animation_url?: string | undefined;
uri: string;
id: BigNumber;
}[], unknown>;

// Warning: (ae-incompatible-release-tags) The symbol "useUnclaimedNftSupply" is marked as @public, but its signature references "RequiredParam" which is marked as @beta
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@thirdweb-dev/react",
"version": "2.2.6",
"version": "2.2.7-0",
"repository": {
"type": "git",
"url": "git+https://github.com:thirdweb-dev/react.git"
Expand Down Expand Up @@ -33,7 +33,7 @@
"@microsoft/api-documenter": "^7.15.3",
"@microsoft/api-extractor": "^7.19.4",
"@microsoft/tsdoc": "^0.14.1",
"@swc/core": "^1.2.147",
"@swc/core": "1.2.177",
"@thirdweb-dev/sdk": "^2.2.0",
"@trivago/prettier-plugin-sort-imports": "^3.2.0",
"@types/mime": "^2.0.3",
Expand Down
Loading