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

Commit 5f601a9

Browse files
joaquim-vergesjoaquim-verges
committed
enable docs for multiwrap
1 parent 1e0dc39 commit 5f601a9

25 files changed

+544
-13
lines changed

‎docs/sdk.contractdeployer.deploymultiwrap.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,10 @@
44

55
## ContractDeployer.deployMultiwrap() method
66

7-
Deploys a new SignatureDrop contract
7+
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
8+
>
9+
10+
Deploys a new Multiwrap contract
811

912
<b>Signature:</b>
1013

@@ -16,9 +19,24 @@ deployMultiwrap(metadata: MultiwrapContractDeployMetadata): Promise<string>;
1619

1720
| Parameter | Type | Description |
1821
| --- | --- | --- |
19-
| metadata | [MultiwrapContractDeployMetadata](./sdk.multiwrapcontractdeploymetadata.md) | |
22+
| metadata | [MultiwrapContractDeployMetadata](./sdk.multiwrapcontractdeploymetadata.md) | the contract metadata |
2023

2124
<b>Returns:</b>
2225

2326
Promise&lt;string&gt;
2427

28+
the address of the deployed contract
29+
30+
## Remarks
31+
32+
Deploys a Multiwrap contract and returns the address of the deployed contract
33+
34+
## Example
35+
36+
37+
```javascript
38+
const contractAddress = await sdk.deployer.deployMultiwrap({
39+
name: "My Multiwrap",
40+
});
41+
```
42+

‎docs/sdk.contractdeployer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ export declare class ContractDeployer extends RPCConnectionHandler
2626
| [deployEdition(metadata)](./sdk.contractdeployer.deployedition.md) | | Deploys a new Edition contract |
2727
| [deployEditionDrop(metadata)](./sdk.contractdeployer.deployeditiondrop.md) | | Deploys a new EditionDrop contract |
2828
| [deployMarketplace(metadata)](./sdk.contractdeployer.deploymarketplace.md) | | Deploys a new Marketplace contract |
29-
| [deployMultiwrap(metadata)](./sdk.contractdeployer.deploymultiwrap.md) | | Deploys a new SignatureDrop contract |
29+
| [deployMultiwrap(metadata)](./sdk.contractdeployer.deploymultiwrap.md) | | <b><i>(BETA)</i></b> Deploys a new Multiwrap contract |
3030
| [deployNFTCollection(metadata)](./sdk.contractdeployer.deploynftcollection.md) | | Deploys an NFT Collection contract |
3131
| [deployNFTDrop(metadata)](./sdk.contractdeployer.deploynftdrop.md) | | Deploys a new NFTDrop contract |
3232
| [deployPack(metadata)](./sdk.contractdeployer.deploypack.md) | | Deploys a new Pack contract |

‎docs/sdk.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@
4242
| [Marketplace](./sdk.marketplace.md) | Create your own whitelabel marketplace that enables users to buy and sell any digital assets. |
4343
| [MarketplaceAuction](./sdk.marketplaceauction.md) | Handles auction listings |
4444
| [MarketplaceDirect](./sdk.marketplacedirect.md) | Handles direct listings |
45+
| [Multiwrap](./sdk.multiwrap.md) | <b><i>(BETA)</i></b> Multiwrap lets you wrap any number of ERC20, ERC721 and ERC1155 tokens you own into a single wrapped token bundle. |
4546
| [NFTCollection](./sdk.nftcollection.md) | Create a collection of one-of-one NFTs. |
4647
| [NFTDrop](./sdk.nftdrop.md) | Setup a collection of one-of-one NFTs that are minted as users claim them. |
4748
| [Pack](./sdk.pack.md) | Create lootboxes of NFTs with rarity based open mechanics. |

‎docs/sdk.multiwrap._constructor_.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
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; [Multiwrap](./sdk.multiwrap.md) &gt; [(constructor)](./sdk.multiwrap._constructor_.md)
4+
5+
## Multiwrap.(constructor)
6+
7+
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
8+
>
9+
10+
Constructs a new instance of the `Multiwrap` class
11+
12+
<b>Signature:</b>
13+
14+
```typescript
15+
constructor(network: NetworkOrSignerOrProvider, address: string, storage: IStorage, options?: SDKOptions, contractWrapper?: ContractWrapper<MultiwrapContract>);
16+
```
17+
18+
## Parameters
19+
20+
| Parameter | Type | Description |
21+
| --- | --- | --- |
22+
| network | [NetworkOrSignerOrProvider](./sdk.networkorsignerorprovider.md) | |
23+
| address | string | |
24+
| storage | [IStorage](./sdk.istorage.md) | |
25+
| options | [SDKOptions](./sdk.sdkoptions.md) | <i>(Optional)</i> |
26+
| contractWrapper | ContractWrapper&lt;MultiwrapContract&gt; | <i>(Optional)</i> |
27+

‎docs/sdk.multiwrap.contractabi.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
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; [Multiwrap](./sdk.multiwrap.md) &gt; [contractAbi](./sdk.multiwrap.contractabi.md)
4+
5+
## Multiwrap.contractAbi property
6+
7+
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
8+
>
9+
10+
<b>Signature:</b>
11+
12+
```typescript
13+
static contractAbi: any;
14+
```

‎docs/sdk.multiwrap.contractroles.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
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; [Multiwrap](./sdk.multiwrap.md) &gt; [contractRoles](./sdk.multiwrap.contractroles.md)
4+
5+
## Multiwrap.contractRoles property
6+
7+
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
8+
>
9+
10+
<b>Signature:</b>
11+
12+
```typescript
13+
static contractRoles: readonly ["transfer", "minter", "unwrap", "asset"];
14+
```

‎docs/sdk.multiwrap.contracttype.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
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; [Multiwrap](./sdk.multiwrap.md) &gt; [contractType](./sdk.multiwrap.contracttype.md)
4+
5+
## Multiwrap.contractType property
6+
7+
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
8+
>
9+
10+
<b>Signature:</b>
11+
12+
```typescript
13+
static contractType: "multiwrap";
14+
```

‎docs/sdk.multiwrap.encoder.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
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; [Multiwrap](./sdk.multiwrap.md) &gt; [encoder](./sdk.multiwrap.encoder.md)
4+
5+
## Multiwrap.encoder property
6+
7+
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
8+
>
9+
10+
<b>Signature:</b>
11+
12+
```typescript
13+
encoder: ContractEncoder<MultiwrapContract>;
14+
```

‎docs/sdk.multiwrap.estimator.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
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; [Multiwrap](./sdk.multiwrap.md) &gt; [estimator](./sdk.multiwrap.estimator.md)
4+
5+
## Multiwrap.estimator property
6+
7+
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
8+
>
9+
10+
<b>Signature:</b>
11+
12+
```typescript
13+
estimator: GasCostEstimator<MultiwrapContract>;
14+
```

‎docs/sdk.multiwrap.events.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
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; [Multiwrap](./sdk.multiwrap.md) &gt; [events](./sdk.multiwrap.events.md)
4+
5+
## Multiwrap.events property
6+
7+
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
8+
>
9+
10+
<b>Signature:</b>
11+
12+
```typescript
13+
events: ContractEvents<MultiwrapContract>;
14+
```

0 commit comments

Comments
 (0)