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
6 changes: 3 additions & 3 deletions docs/sdk.erc1155signatureminting.generate.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,19 @@

## Erc1155SignatureMinting.generate() method

Generate a signature that can be used to mint a dynamic NFT
Generate a signature that can be used to mint an NFT dynamically.

<b>Signature:</b>

```typescript
generate(mintRequest: PayloadToSign1155): Promise<SignedPayload1155>;
generate(payloadToSign: PayloadToSign1155): Promise<SignedPayload1155>;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| mintRequest | [PayloadToSign1155](./sdk.payloadtosign1155.md) | the payload to sign |
| payloadToSign | [PayloadToSign1155](./sdk.payloadtosign1155.md) | the payload to sign |

<b>Returns:</b>

Expand Down
4 changes: 2 additions & 2 deletions docs/sdk.erc1155signatureminting.generatebatch.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## Erc1155SignatureMinting.generateBatch() method

Genrate a batch of signatures that can be used to mint many dynamic NFTs.
Generate a batch of signatures that can be used to mint many new NFTs dynamically.

<b>Signature:</b>

Expand All @@ -26,5 +26,5 @@ an array of payloads and signatures

## Remarks

See [Erc721SignatureMinting.generate()](./sdk.erc721signatureminting.generate.md)
See [Erc1155SignatureMinting.generate()](./sdk.erc1155signatureminting.generate.md)

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

[Home](./index.md) &gt; [@thirdweb-dev/sdk](./sdk.md) &gt; [Erc1155SignatureMinting](./sdk.erc1155signatureminting.md) &gt; [generateBatchFromTokenIds](./sdk.erc1155signatureminting.generatebatchfromtokenids.md)

## Erc1155SignatureMinting.generateBatchFromTokenIds() method

Genrate a batch of signatures that can be used to mint new NFTs or additionaly supply to existing NFTs dynamically.

<b>Signature:</b>

```typescript
generateBatchFromTokenIds(payloadsToSign: PayloadToSign1155WithTokenId[]): Promise<SignedPayload1155[]>;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| payloadsToSign | [PayloadToSign1155WithTokenId](./sdk.payloadtosign1155withtokenid.md)<!-- -->\[\] | the payloads to sign with tokenIds specified |

<b>Returns:</b>

Promise&lt;[SignedPayload1155](./sdk.signedpayload1155.md)<!-- -->\[\]&gt;

an array of payloads and signatures

## Remarks

See [Erc1155SignatureMinting.generateFromTokenId()](./sdk.erc1155signatureminting.generatefromtokenid.md)

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

[Home](./index.md) &gt; [@thirdweb-dev/sdk](./sdk.md) &gt; [Erc1155SignatureMinting](./sdk.erc1155signatureminting.md) &gt; [generateFromTokenId](./sdk.erc1155signatureminting.generatefromtokenid.md)

## Erc1155SignatureMinting.generateFromTokenId() method

Generate a signature that can be used to mint additionaly supply to an existing NFT.

<b>Signature:</b>

```typescript
generateFromTokenId(payloadToSign: PayloadToSign1155WithTokenId): Promise<SignedPayload1155>;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| payloadToSign | [PayloadToSign1155WithTokenId](./sdk.payloadtosign1155withtokenid.md) | the payload to sign |

<b>Returns:</b>

Promise&lt;[SignedPayload1155](./sdk.signedpayload1155.md)<!-- -->&gt;

the signed payload and the corresponding signature

## Remarks

Takes in a payload with the token ID of an existing NFT, and signs it with your private key. The generated signature can then be used to mint additional supply to the NFT using the exact payload and signature generated.

## Example


```javascript
const nftMetadata = {
name: "Cool NFT #1",
description: "This is a cool NFT",
image: fs.readFileSync("path/to/image.png"), // This can be an image url or file
};

const startTime = new Date();
const endTime = new Date(Date.now() + 60 * 60 * 24 * 1000);
const payload = {
tokenId: 0, // Instead of metadata, we specificy the token ID of the NFT to mint supply to
to: {{wallet_address}}, // Who will receive the NFT (or AddressZero for anyone)
quantity: 2, // the quantity of NFTs to mint
price: 0.5, // the price per NFT
currencyAddress: NATIVE_TOKEN_ADDRESS, // the currency to pay with
mintStartTime: startTime, // can mint anytime from now
mintEndTime: endTime, // to 24h from now
royaltyRecipient: "0x...", // custom royalty recipient for this NFT
royaltyBps: 100, // custom royalty fees for this NFT (in bps)
primarySaleRecipient: "0x...", // custom sale recipient for this NFT
};

const signedPayload = contract.signature.generate(payload);
// now anyone can use these to mint the NFT using `contract.signature.mint(signedPayload)`
```

6 changes: 4 additions & 2 deletions docs/sdk.erc1155signatureminting.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,10 @@ export declare class Erc1155SignatureMinting

| Method | Modifiers | Description |
| --- | --- | --- |
| [generate(mintRequest)](./sdk.erc1155signatureminting.generate.md) | | Generate a signature that can be used to mint a dynamic NFT |
| [generateBatch(payloadsToSign)](./sdk.erc1155signatureminting.generatebatch.md) | | Genrate a batch of signatures that can be used to mint many dynamic NFTs. |
| [generate(payloadToSign)](./sdk.erc1155signatureminting.generate.md) | | Generate a signature that can be used to mint an NFT dynamically. |
| [generateBatch(payloadsToSign)](./sdk.erc1155signatureminting.generatebatch.md) | | Generate a batch of signatures that can be used to mint many new NFTs dynamically. |
| [generateBatchFromTokenIds(payloadsToSign)](./sdk.erc1155signatureminting.generatebatchfromtokenids.md) | | Genrate a batch of signatures that can be used to mint new NFTs or additionaly supply to existing NFTs dynamically. |
| [generateFromTokenId(payloadToSign)](./sdk.erc1155signatureminting.generatefromtokenid.md) | | Generate a signature that can be used to mint additionaly supply to an existing NFT. |
| [mint(signedPayload)](./sdk.erc1155signatureminting.mint.md) | | Mint a dynamically generated NFT |
| [mintBatch(signedPayloads)](./sdk.erc1155signatureminting.mintbatch.md) | | Mint any number of dynamically generated NFT at once |
| [verify(signedPayload)](./sdk.erc1155signatureminting.verify.md) | | Verify that a payload is correctly signed |
Expand Down
12 changes: 12 additions & 0 deletions docs/sdk.filledsignaturepayload1155withtokenid.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

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

## FilledSignaturePayload1155WithTokenId type


<b>Signature:</b>

```typescript
export declare type FilledSignaturePayload1155WithTokenId = z.output<typeof Signature1155PayloadInputWithTokenId>;
```
2 changes: 2 additions & 0 deletions docs/sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,7 @@
| [FilledConditionInput](./sdk.filledconditioninput.md) | |
| [FilledSignature721WithQuantity](./sdk.filledsignature721withquantity.md) | |
| [FilledSignaturePayload1155](./sdk.filledsignaturepayload1155.md) | |
| [FilledSignaturePayload1155WithTokenId](./sdk.filledsignaturepayload1155withtokenid.md) | |
| [FilledSignaturePayload20](./sdk.filledsignaturepayload20.md) | |
| [FilledSignaturePayload721](./sdk.filledsignaturepayload721.md) | |
| [ForwardRequestMessage](./sdk.forwardrequestmessage.md) | Forward Request Message that's used for gasless transaction |
Expand All @@ -161,6 +162,7 @@
| [NFTMetadataInput](./sdk.nftmetadatainput.md) | |
| [NFTMetadataOwner](./sdk.nftmetadataowner.md) | |
| [PayloadToSign1155](./sdk.payloadtosign1155.md) | |
| [PayloadToSign1155WithTokenId](./sdk.payloadtosign1155withtokenid.md) | |
| [PayloadToSign20](./sdk.payloadtosign20.md) | |
| [PayloadToSign721](./sdk.payloadtosign721.md) | |
| [PayloadToSign721withQuantity](./sdk.payloadtosign721withquantity.md) | |
Expand Down
12 changes: 12 additions & 0 deletions docs/sdk.payloadtosign1155withtokenid.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

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

## PayloadToSign1155WithTokenId type


<b>Signature:</b>

```typescript
export declare type PayloadToSign1155WithTokenId = z.input<typeof Signature1155PayloadInputWithTokenId>;
```
Loading