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

Commit 9e4f8c8

Browse files
adam-majadam-maj
authored
Update documentation for signature drop (#478)
1 parent bacf3cb commit 9e4f8c8

34 files changed

+943
-6
lines changed

‎docs/sdk.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@
4949
| [NFTDrop](./sdk.nftdrop.md) | Setup a collection of one-of-one NFTs that are minted as users claim them. |
5050
| [Pack](./sdk.pack.md) | Create lootboxes of NFTs with rarity based open mechanics. |
5151
| [RemoteStorage](./sdk.remotestorage.md) | Fetch and upload files to IPFS or any other storage. |
52+
| [SignatureDrop](./sdk.signaturedrop.md) | Setup a collection of NFTs where when it comes to minting, you can authorize some external party to mint tokens on your contract, and specify what exactly will be minted by that external party.. |
5253
| [SmartContract](./sdk.smartcontract.md) | <b><i>(BETA)</i></b> Custom contract dynamic class with feature detection |
5354
| [Split](./sdk.split.md) | Create custom royalty splits to distribute funds. |
5455
| [ThirdwebSDK](./sdk.thirdwebsdk.md) | The main entry point for the thirdweb SDK |

‎docs/sdk.signaturedrop._constructor_.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@thirdweb-dev/sdk](./sdk.md) &gt; [SignatureDrop](./sdk.signaturedrop.md) &gt; [(constructor)](./sdk.signaturedrop._constructor_.md)
4+
5+
## SignatureDrop.(constructor)
6+
7+
Constructs a new instance of the `SignatureDrop` class
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
constructor(network: NetworkOrSignerOrProvider, address: string, storage: IStorage, options?: SDKOptions, contractWrapper?: ContractWrapper<SignatureDropContract>);
13+
```
14+
15+
## Parameters
16+
17+
| Parameter | Type | Description |
18+
| --- | --- | --- |
19+
| network | [NetworkOrSignerOrProvider](./sdk.networkorsignerorprovider.md) | |
20+
| address | string | |
21+
| storage | [IStorage](./sdk.istorage.md) | |
22+
| options | [SDKOptions](./sdk.sdkoptions.md) | <i>(Optional)</i> |
23+
| contractWrapper | ContractWrapper&lt;SignatureDropContract&gt; | <i>(Optional)</i> |
24+

‎docs/sdk.signaturedrop.analytics.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@thirdweb-dev/sdk](./sdk.md) &gt; [SignatureDrop](./sdk.signaturedrop.md) &gt; [analytics](./sdk.signaturedrop.analytics.md)
4+
5+
## SignatureDrop.analytics property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
analytics: ContractAnalytics<SignatureDropContract>;
11+
```

‎docs/sdk.signaturedrop.burn.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@thirdweb-dev/sdk](./sdk.md) &gt; [SignatureDrop](./sdk.signaturedrop.md) &gt; [burn](./sdk.signaturedrop.burn.md)
4+
5+
## SignatureDrop.burn() method
6+
7+
Burn a single NFT
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
burn(tokenId: BigNumberish): Promise<TransactionResult>;
13+
```
14+
15+
## Parameters
16+
17+
| Parameter | Type | Description |
18+
| --- | --- | --- |
19+
| tokenId | BigNumberish | the token Id to burn |
20+
21+
<b>Returns:</b>
22+
23+
Promise&lt;[TransactionResult](./sdk.transactionresult.md)<!-- -->&gt;
24+

‎docs/sdk.signaturedrop.claim.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@thirdweb-dev/sdk](./sdk.md) &gt; [SignatureDrop](./sdk.signaturedrop.md) &gt; [claim](./sdk.signaturedrop.claim.md)
4+
5+
## SignatureDrop.claim() method
6+
7+
Claim NFTs to the connected wallet.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
claim(quantity: BigNumberish, proofs?: BytesLike[]): Promise<TransactionResultWithId<NFTMetadataOwner>[]>;
13+
```
14+
15+
## Parameters
16+
17+
| Parameter | Type | Description |
18+
| --- | --- | --- |
19+
| quantity | BigNumberish | |
20+
| proofs | BytesLike\[\] | <i>(Optional)</i> |
21+
22+
<b>Returns:</b>
23+
24+
Promise&lt;[TransactionResultWithId](./sdk.transactionresultwithid.md)<!-- -->&lt;[NFTMetadataOwner](./sdk.nftmetadataowner.md)<!-- -->&gt;\[\]&gt;
25+
26+
- an array of results containing the id of the token claimed, the transaction receipt and a promise to optionally fetch the nft metadata
27+
28+
## Remarks
29+
30+
See [NFTDrop.claimTo()](./sdk.nftdrop.claimto.md)
31+

‎docs/sdk.signaturedrop.claimcondition.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@thirdweb-dev/sdk](./sdk.md) &gt; [SignatureDrop](./sdk.signaturedrop.md) &gt; [claimCondition](./sdk.signaturedrop.claimcondition.md)
4+
5+
## SignatureDrop.claimCondition property
6+
7+
Configure claim conditions
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
claimCondition: DropSingleClaimConditions<SignatureDropContract>;
13+
```
14+
15+
## Remarks
16+
17+
Define who can claim NFTs in the collection, when and how many.
18+
19+
## Example
20+
21+
22+
```javascript
23+
const presaleStartTime = new Date();
24+
const claimCondition = {
25+
startTime: presaleStartTime, // start the presale now
26+
maxQuantity: 2, // limit how many mints for this presale
27+
price: 0.01, // presale price
28+
snapshot: ['0x...', '0x...'], // limit minting to only certain addresses
29+
};
30+
await contract.claimCondition.set(claimCondition);
31+
```
32+

‎docs/sdk.signaturedrop.claimto.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@thirdweb-dev/sdk](./sdk.md) &gt; [SignatureDrop](./sdk.signaturedrop.md) &gt; [claimTo](./sdk.signaturedrop.claimto.md)
4+
5+
## SignatureDrop.claimTo() method
6+
7+
Claim unique NFTs to a specific Wallet
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
claimTo(destinationAddress: string, quantity: BigNumberish, proofs?: BytesLike[]): Promise<TransactionResultWithId<NFTMetadataOwner>[]>;
13+
```
14+
15+
## Parameters
16+
17+
| Parameter | Type | Description |
18+
| --- | --- | --- |
19+
| destinationAddress | string | Address you want to send the token to |
20+
| quantity | BigNumberish | Quantity of the tokens you want to claim |
21+
| proofs | BytesLike\[\] | <i>(Optional)</i> Array of proofs |
22+
23+
<b>Returns:</b>
24+
25+
Promise&lt;[TransactionResultWithId](./sdk.transactionresultwithid.md)<!-- -->&lt;[NFTMetadataOwner](./sdk.nftmetadataowner.md)<!-- -->&gt;\[\]&gt;
26+
27+
- an array of results containing the id of the token claimed, the transaction receipt and a promise to optionally fetch the nft metadata
28+
29+
## Remarks
30+
31+
Let the specified wallet claim NFTs.
32+
33+
## Example
34+
35+
36+
```javascript
37+
const address = "{{wallet_address}}"; // address of the wallet you want to claim the NFTs
38+
const quantity = 1; // how many unique NFTs you want to claim
39+
40+
const tx = await contract.claimTo(address, quantity);
41+
const receipt = tx.receipt; // the transaction receipt
42+
const claimedTokenId = tx.id; // the id of the NFT claimed
43+
const claimedNFT = await tx.data(); // (optional) get the claimed NFT metadata
44+
```
45+

‎docs/sdk.signaturedrop.contractabi.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@thirdweb-dev/sdk](./sdk.md) &gt; [SignatureDrop](./sdk.signaturedrop.md) &gt; [contractAbi](./sdk.signaturedrop.contractabi.md)
4+
5+
## SignatureDrop.contractAbi property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
static contractAbi: any;
11+
```

‎docs/sdk.signaturedrop.contractroles.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@thirdweb-dev/sdk](./sdk.md) &gt; [SignatureDrop](./sdk.signaturedrop.md) &gt; [contractRoles](./sdk.signaturedrop.contractroles.md)
4+
5+
## SignatureDrop.contractRoles property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
static contractRoles: readonly ["admin", "minter", "transfer"];
11+
```

‎docs/sdk.signaturedrop.contracttype.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@thirdweb-dev/sdk](./sdk.md) &gt; [SignatureDrop](./sdk.signaturedrop.md) &gt; [contractType](./sdk.signaturedrop.contracttype.md)
4+
5+
## SignatureDrop.contractType property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
static contractType: "signature-drop";
11+
```

0 commit comments

Comments
 (0)