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
10 changes: 5 additions & 5 deletions docs/feature_snippets.json
Original file line number Diff line number Diff line change
Expand Up @@ -623,7 +623,7 @@
"javascript": "https://docs.thirdweb.com/typescript/sdk.Erc721BatchMintable"
}
},
"ERC721ClaimConditions": {
"ERC721Claimable": {
"name": "Erc721Claimable",
"summary": "Lazily mint and claim ERC721 NFTs\n\n",
"remarks": "\n\nManage claim phases and claim ERC721 NFTs that have been lazily minted.\n\n",
Expand Down Expand Up @@ -660,8 +660,8 @@
"javascript": "https://docs.thirdweb.com/typescript/sdk.Erc721Claimable"
}
},
"ERC721Dropable": {
"name": "Erc721Dropable",
"ERC721Droppable": {
"name": "Erc721Droppable",
"summary": "Lazily mint and claim ERC721 NFTs\n\n",
"remarks": "\n\nManage claim phases and claim ERC721 NFTs that have been lazily minted.\n\n",
"examples": {
Expand All @@ -676,7 +676,7 @@
"javascript": "// Custom metadata of the NFTs to create\nconst metadatas = [{\n name: \"Cool NFT\",\n description: \"This is a cool NFT\",\n image: fs.readFileSync(\"path/to/image.png\"), // This can be an image url or file\n}, {\n name: \"Cool NFT\",\n description: \"This is a cool NFT\",\n image: fs.readFileSync(\"path/to/image.png\"),\n}];\n\nconst results = await contract.nft.lazy.mint(metadatas); // uploads and creates the NFTs on chain\nconst firstTokenId = results[0].id; // token id of the first created NFT\nconst firstNFT = await results[0].data(); // (optional) fetch details of the first created NFT"
},
"reference": {
"javascript": "https://docs.thirdweb.com/typescript/sdk.Erc721Dropable.lazyMint"
"javascript": "https://docs.thirdweb.com/typescript/sdk.Erc721Droppable.lazyMint"
}
}
],
Expand All @@ -694,7 +694,7 @@
}
],
"reference": {
"javascript": "https://docs.thirdweb.com/typescript/sdk.Erc721Dropable"
"javascript": "https://docs.thirdweb.com/typescript/sdk.Erc721Droppable"
}
},
"ERC721Enumerable": {
Expand Down
11 changes: 11 additions & 0 deletions docs/sdk.erc1155.drop.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@thirdweb-dev/sdk](./sdk.md) &gt; [Erc1155](./sdk.erc1155.md) &gt; [drop](./sdk.erc1155.drop.md)

## Erc1155.drop property

<b>Signature:</b>

```typescript
drop: Erc1155Droppable | undefined;
```
1 change: 1 addition & 0 deletions docs/sdk.erc1155.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ await contract.edition.transfer(walletAddress, tokenId, quantity);
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [contractWrapper](./sdk.erc1155.contractwrapper.md) | | ContractWrapper&lt;T&gt; | |
| [drop](./sdk.erc1155.drop.md) | | Erc1155Droppable \| undefined | |
| [featureName](./sdk.erc1155.featurename.md) | | "ERC1155" | |
| [mint](./sdk.erc1155.mint.md) | | [Erc1155Mintable](./sdk.erc1155mintable.md) \| undefined | |
| [options](./sdk.erc1155.options.md) | | [SDKOptions](./sdk.sdkoptions.md) | |
Expand Down
2 changes: 1 addition & 1 deletion docs/sdk.erc721.drop.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@
<b>Signature:</b>

```typescript
drop: Erc721Dropable | undefined;
drop: Erc721Droppable | undefined;
```
2 changes: 1 addition & 1 deletion docs/sdk.erc721.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ await contract.nft.transfer(walletAddress, tokenId);
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [contractWrapper](./sdk.erc721.contractwrapper.md) | | ContractWrapper&lt;T&gt; | |
| [drop](./sdk.erc721.drop.md) | | [Erc721Dropable](./sdk.erc721dropable.md) \| undefined | |
| [drop](./sdk.erc721.drop.md) | | [Erc721Droppable](./sdk.erc721droppable.md) \| undefined | |
| [featureName](./sdk.erc721.featurename.md) | | "ERC721" | |
| [mint](./sdk.erc721.mint.md) | | [Erc721Mintable](./sdk.erc721mintable.md) \| undefined | |
| [options](./sdk.erc721.options.md) | | [SDKOptions](./sdk.sdkoptions.md) | |
Expand Down
2 changes: 1 addition & 1 deletion docs/sdk.erc721claimable.featurename.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@
<b>Signature:</b>

```typescript
featureName: "ERC721ClaimConditions";
featureName: "ERC721Claimable";
```
2 changes: 1 addition & 1 deletion docs/sdk.erc721claimable.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ await contract.drop.claim.to("0x...", quantity);
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [conditions](./sdk.erc721claimable.conditions.md) | | [DropClaimConditions](./sdk.dropclaimconditions.md)<!-- -->&lt;BaseClaimConditionERC721&gt; | Configure claim conditions |
| [featureName](./sdk.erc721claimable.featurename.md) | | "ERC721ClaimConditions" | |
| [featureName](./sdk.erc721claimable.featurename.md) | | "ERC721Claimable" | |

## Methods

Expand Down
47 changes: 0 additions & 47 deletions docs/sdk.erc721dropable.md

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@thirdweb-dev/sdk](./sdk.md) &gt; [Erc721Dropable](./sdk.erc721dropable.md) &gt; [(constructor)](./sdk.erc721dropable._constructor_.md)
[Home](./index.md) &gt; [@thirdweb-dev/sdk](./sdk.md) &gt; [Erc721Droppable](./sdk.erc721droppable.md) &gt; [(constructor)](./sdk.erc721droppable._constructor_.md)

## Erc721Dropable.(constructor)
## Erc721Droppable.(constructor)

Constructs a new instance of the `Erc721Dropable` class
Constructs a new instance of the `Erc721Droppable` class

<b>Signature:</b>

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@thirdweb-dev/sdk](./sdk.md) &gt; [Erc721Dropable](./sdk.erc721dropable.md) &gt; [claim](./sdk.erc721dropable.claim.md)
[Home](./index.md) &gt; [@thirdweb-dev/sdk](./sdk.md) &gt; [Erc721Droppable](./sdk.erc721droppable.md) &gt; [claim](./sdk.erc721droppable.claim.md)

## Erc721Dropable.claim property
## Erc721Droppable.claim property

Claim tokens and configure claim conditions

Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@thirdweb-dev/sdk](./sdk.md) &gt; [Erc721Dropable](./sdk.erc721dropable.md) &gt; [featureName](./sdk.erc721dropable.featurename.md)
[Home](./index.md) &gt; [@thirdweb-dev/sdk](./sdk.md) &gt; [Erc721Droppable](./sdk.erc721droppable.md) &gt; [featureName](./sdk.erc721droppable.featurename.md)

## Erc721Dropable.featureName property
## Erc721Droppable.featureName property

<b>Signature:</b>

```typescript
featureName: "ERC721Dropable";
featureName: "ERC721Droppable";
```
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@thirdweb-dev/sdk](./sdk.md) &gt; [Erc721Dropable](./sdk.erc721dropable.md) &gt; [lazyMint](./sdk.erc721dropable.lazymint.md)
[Home](./index.md) &gt; [@thirdweb-dev/sdk](./sdk.md) &gt; [Erc721Droppable](./sdk.erc721droppable.md) &gt; [lazyMint](./sdk.erc721droppable.lazymint.md)

## Erc721Dropable.lazyMint() method
## Erc721Droppable.lazyMint() method

Create a batch of unique NFTs to be claimed in the future

Expand Down
47 changes: 47 additions & 0 deletions docs/sdk.erc721droppable.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@thirdweb-dev/sdk](./sdk.md) &gt; [Erc721Droppable](./sdk.erc721droppable.md)

## Erc721Droppable class

Lazily mint and claim ERC721 NFTs

<b>Signature:</b>

```typescript
export declare class Erc721Droppable implements DetectableFeature
```
<b>Implements:</b> DetectableFeature

## Remarks

Manage claim phases and claim ERC721 NFTs that have been lazily minted.

## Example


```javascript
const contract = await sdk.getContract("{{contract_address}}");
await contract.drop.claim(quantity);
```

## Constructors

| Constructor | Modifiers | Description |
| --- | --- | --- |
| [(constructor)(erc721, contractWrapper, storage)](./sdk.erc721droppable._constructor_.md) | | Constructs a new instance of the <code>Erc721Droppable</code> class |

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [claim](./sdk.erc721droppable.claim.md) | | [Erc721Claimable](./sdk.erc721claimable.md) \| undefined | Claim tokens and configure claim conditions |
| [featureName](./sdk.erc721droppable.featurename.md) | | "ERC721Droppable" | |
| [revealer](./sdk.erc721droppable.revealer.md) | | [DelayedReveal](./sdk.delayedreveal.md)<!-- -->&lt;BaseDelayedRevealERC721&gt; \| undefined | |

## Methods

| Method | Modifiers | Description |
| --- | --- | --- |
| [lazyMint(metadatas, options)](./sdk.erc721droppable.lazymint.md) | | Create a batch of unique NFTs to be claimed in the future |

Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@thirdweb-dev/sdk](./sdk.md) &gt; [Erc721Dropable](./sdk.erc721dropable.md) &gt; [revealer](./sdk.erc721dropable.revealer.md)
[Home](./index.md) &gt; [@thirdweb-dev/sdk](./sdk.md) &gt; [Erc721Droppable](./sdk.erc721droppable.md) &gt; [revealer](./sdk.erc721droppable.revealer.md)

## Erc721Dropable.revealer property
## Erc721Droppable.revealer property

<b>Signature:</b>

Expand Down
2 changes: 1 addition & 1 deletion docs/sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
| [Erc721](./sdk.erc721.md) | Standard ERC721 NFT functions |
| [Erc721BatchMintable](./sdk.erc721batchmintable.md) | Mint Many ERC721 NFTs at once |
| [Erc721Claimable](./sdk.erc721claimable.md) | Lazily mint and claim ERC721 NFTs |
| [Erc721Dropable](./sdk.erc721dropable.md) | Lazily mint and claim ERC721 NFTs |
| [Erc721Droppable](./sdk.erc721droppable.md) | Lazily mint and claim ERC721 NFTs |
| [Erc721Enumerable](./sdk.erc721enumerable.md) | List owned ERC721 NFTs |
| [Erc721Mintable](./sdk.erc721mintable.md) | Mint ERC721 NFTs |
| [Erc721Supply](./sdk.erc721supply.md) | List ERC721 NFTs |
Expand Down
14 changes: 10 additions & 4 deletions etc/sdk.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -2398,6 +2398,10 @@ export class Erc1155<T extends DropERC1155 | TokenERC1155 | BaseERC1155 = BaseER
balanceOf(address: string, tokenId: BigNumberish): Promise<BigNumber>;
// (undocumented)
protected contractWrapper: ContractWrapper<T>;
// Warning: (ae-forgotten-export) The symbol "Erc1155Droppable" needs to be exported by the entry point index.d.ts
//
// (undocumented)
drop: Erc1155Droppable | undefined;
// (undocumented)
featureName: "ERC1155";
get(tokenId: BigNumberish): Promise<EditionMetadata>;
Expand All @@ -2408,6 +2412,8 @@ export class Erc1155<T extends DropERC1155 | TokenERC1155 | BaseERC1155 = BaseER
isApproved(address: string, operator: string): Promise<boolean>;
// (undocumented)
mint: Erc1155Mintable | undefined;
// @internal
nextTokenIdToMint(): Promise<BigNumber>;
// @internal (undocumented)
onNetworkUpdated(network: NetworkOrSignerOrProvider): void;
// (undocumented)
Expand Down Expand Up @@ -2563,7 +2569,7 @@ export class Erc721<T extends Multiwrap_2 | SignatureDrop_2 | DropERC721 | Token
// (undocumented)
protected contractWrapper: ContractWrapper<T>;
// (undocumented)
drop: Erc721Dropable | undefined;
drop: Erc721Droppable | undefined;
// (undocumented)
featureName: "ERC721";
get(tokenId: BigNumberish): Promise<NFTMetadataOwner>;
Expand Down Expand Up @@ -2608,17 +2614,17 @@ export class Erc721Claimable implements DetectableFeature {
constructor(erc721: Erc721, contractWrapper: ContractWrapper<BaseClaimConditionERC721>, storage: IStorage);
conditions: DropClaimConditions<BaseClaimConditionERC721>;
// (undocumented)
featureName: "ERC721ClaimConditions";
featureName: "ERC721Claimable";
to(destinationAddress: string, quantity: BigNumberish, checkERC20Allowance?: boolean, claimData?: ClaimVerification): Promise<TransactionResultWithId<NFTMetadataOwner>[]>;
}

// @public
export class Erc721Dropable implements DetectableFeature {
export class Erc721Droppable implements DetectableFeature {
// Warning: (ae-forgotten-export) The symbol "BaseDropERC721" needs to be exported by the entry point index.d.ts
constructor(erc721: Erc721, contractWrapper: ContractWrapper<BaseDropERC721>, storage: IStorage);
claim: Erc721Claimable | undefined;
// (undocumented)
featureName: "ERC721Dropable";
featureName: "ERC721Droppable";
lazyMint(metadatas: NFTMetadataInput[], options?: {
onProgress: (event: UploadProgressEvent) => void;
}): Promise<TransactionResultWithId<NFTMetadata>[]>;
Expand Down
8 changes: 5 additions & 3 deletions src/constants/contract-features.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import {
FEATURE_NFT,
FEATURE_NFT_BATCH_MINTABLE,
FEATURE_NFT_CLAIMABLE,
FEATURE_NFT_DROPABLE,
FEATURE_NFT_DROPPABLE,
FEATURE_NFT_ENUMERABLE,
FEATURE_NFT_MINTABLE,
FEATURE_NFT_REVEALABLE,
Expand All @@ -18,6 +18,7 @@ import {
import {
FEATURE_EDITION,
FEATURE_EDITION_BATCH_MINTABLE,
FEATURE_EDITION_DROPPABLE,
FEATURE_EDITION_ENUMERABLE,
FEATURE_EDITION_MINTABLE,
FEATURE_EDITION_SIGNATURE_MINTABLE,
Expand All @@ -42,13 +43,14 @@ export type Feature =
| typeof FEATURE_NFT_ENUMERABLE
| typeof FEATURE_NFT_MINTABLE
| typeof FEATURE_NFT_BATCH_MINTABLE
| typeof FEATURE_NFT_DROPABLE
| typeof FEATURE_NFT_DROPPABLE
| typeof FEATURE_NFT_CLAIMABLE
| typeof FEATURE_NFT_REVEALABLE
| typeof FEATURE_NFT_SIGNATURE_MINTABLE
| typeof FEATURE_EDITION
| typeof FEATURE_EDITION_ENUMERABLE
| typeof FEATURE_EDITION_MINTABLE
| typeof FEATURE_NFT_SIGNATURE_MINTABLE
| typeof FEATURE_EDITION_DROPPABLE
| typeof FEATURE_EDITION_BATCH_MINTABLE
| typeof FEATURE_ROYALTY
| typeof FEATURE_TOKEN_SIGNATURE_MINTABLE
Expand Down
13 changes: 13 additions & 0 deletions src/constants/erc1155-features.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,18 @@ import Erc1155Abi from "../../abis/IERC1155.json";
import MulticallAbi from "../../abis/IMulticall.json";
import IMintableERC1155Abi from "../../abis/IMintableERC1155.json";
import ISignatureMintERC1155Abi from "../../abis/ISignatureMintERC1155.json";
import ILazyMintAbi from "../../abis/ILazyMint.json";

export const FEATURE_EDITION_DROPPABLE = {
name: "ERC1155Droppable",
namespace: "edition.drop",
docLinks: {
sdk: "sdk.erc1155droppable",
contracts: "LazyMint",
},
abis: [Erc1155Abi, ILazyMintAbi],
features: {},
} as const;

export const FEATURE_EDITION_SIGNATURE_MINTABLE = {
name: "ERC1155SignatureMintable",
Expand Down Expand Up @@ -61,6 +73,7 @@ export const FEATURE_EDITION = {
features: {
[FEATURE_EDITION_ENUMERABLE.name]: FEATURE_EDITION_ENUMERABLE,
[FEATURE_EDITION_MINTABLE.name]: FEATURE_EDITION_MINTABLE,
[FEATURE_EDITION_DROPPABLE.name]: FEATURE_EDITION_DROPPABLE,
[FEATURE_EDITION_SIGNATURE_MINTABLE.name]:
FEATURE_EDITION_SIGNATURE_MINTABLE,
},
Expand Down
Loading