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

Commit c93c4bc

Browse files
CI: Automated build push - generate documentation
1 parent 7dcd061 commit c93c4bc

File tree

3 files changed

+15
-0
lines changed

3 files changed

+15
-0
lines changed
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@3rdweb/sdk](./sdk.md) &gt; [DropModuleMetadata](./sdk.dropmodulemetadata.md) &gt; [feeRecipient](./sdk.dropmodulemetadata.feerecipient.md)
4+
5+
## DropModuleMetadata.feeRecipient property
6+
7+
The address of the royalty recipient. All royalties will be sent to this address.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
feeRecipient?: string;
13+
```

docs/sdk.dropmodulemetadata.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ export default class DropModuleMetadata extends CommonModuleMetadata
1616
| Property | Modifiers | Type | Description |
1717
| --- | --- | --- | --- |
1818
| [baseTokenUri](./sdk.dropmodulemetadata.basetokenuri.md) | | string | The IPFS base URI thats prepended to all token URIs. This allows you to batch upload all the metadata for the tokens ahead of time so they can be lazy minted later<!-- -->e.g. if a Drop Collection has a token URI of /ipfs/BOREDAPES/TOKEN1, then the IPFS base URI is /BOREDAPES/ |
19+
| [feeRecipient?](./sdk.dropmodulemetadata.feerecipient.md) | | string | <i>(Optional)</i> The address of the royalty recipient. All royalties will be sent to this address. |
1920
| [maxSupply](./sdk.dropmodulemetadata.maxsupply.md) | | number | The max supply (required) |
2021
| [sellerFeeBasisPoints](./sdk.dropmodulemetadata.sellerfeebasispoints.md) | | number | The amount of royalty collected on all royalties represented as basis points. The default is 0 (no royalties).<!-- -->1 basis point = 0.01%<!-- -->For example: if this value is 100, then the royalty is 1% of the total sales. |
2122
| [symbol?](./sdk.dropmodulemetadata.symbol.md) | | string | <i>(Optional)</i> The symbol for the Drop Collection |

etc/sdk.api.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -401,6 +401,7 @@ export class DropModule extends ModuleWithRoles<LazyNFT> {
401401
// @public (undocumented)
402402
export class DropModuleMetadata extends CommonModuleMetadata {
403403
baseTokenUri: string;
404+
feeRecipient?: string;
404405
maxSupply: number;
405406
sellerFeeBasisPoints: number;
406407
symbol?: string;

0 commit comments

Comments
 (0)