Skip to content

Commit 48db875

Browse files
Krishang NadgaudaKrishang Nadgauda
authored andcommitted
docs update
1 parent eb79725 commit 48db875

File tree

3 files changed

+144
-201
lines changed

3 files changed

+144
-201
lines changed

docs/IMultiwrap.md

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

55

66

7-
7+
Thirdweb's Multiwrap contract lets you wrap arbitrary ERC20, ERC721 and ERC1155 tokens you own into a single wrapped token / NFT. A wrapped NFT can be unwrapped i.e. burned in exchange for its underlying contents.
88

99

1010

@@ -235,38 +235,37 @@ function supportsInterface(bytes4 interfaceId) external view returns (bool)
235235
### unwrap
236236

237237
```solidity
238-
function unwrap(uint256 tokenId, uint256 amountToRedeem, address _sendTo) external nonpayable
238+
function unwrap(uint256 tokenId, address recipient) external nonpayable
239239
```
240240

241-
Unwrap shares to retrieve underlying ERC1155, ERC721, ERC20 tokens.
241+
Unwrap a wrapped NFT to retrieve underlying ERC1155, ERC721, ERC20 tokens.
242242

243243

244244

245245
#### Parameters
246246

247247
| Name | Type | Description |
248248
|---|---|---|
249-
| tokenId | uint256 | The token Id of the tokens to unwrap.
250-
| amountToRedeem | uint256 | The amount of shares to unwrap
251-
| _sendTo | address | undefined
249+
| tokenId | uint256 | The token Id of the wrapped NFT to unwrap.
250+
| recipient | address | The recipient of the underlying ERC1155, ERC721, ERC20 tokens of the wrapped NFT.
252251

253252
### wrap
254253

255254
```solidity
256-
function wrap(MultiTokenTransferLib.MultiToken wrappedContents, uint256 shares, string uriForShares) external payable returns (uint256 tokenId)
255+
function wrap(IMultiwrap.Token[] wrappedContents, string uriForWrappedToken, address recipient) external payable returns (uint256 tokenId)
257256
```
258257

259-
Wrap multiple ERC1155, ERC721, ERC20 tokens into 'n' shares (i.e. variable supply of 1 ERC 1155 token)
258+
Wrap multiple ERC1155, ERC721, ERC20 tokens into a single wrapped NFT.
260259

261260

262261

263262
#### Parameters
264263

265264
| Name | Type | Description |
266265
|---|---|---|
267-
| wrappedContents | MultiTokenTransferLib.MultiToken | The tokens to wrap.
268-
| shares | uint256 | The number of shares to issue for the wrapped contents.
269-
| uriForShares | string | The URI for the shares i.e. wrapped token.
266+
| wrappedContents | IMultiwrap.Token[] | The tokens to wrap.
267+
| uriForWrappedToken | string | The metadata URI for the wrapped NFT.
268+
| recipient | address | The recipient of the wrapped NFT.
270269

271270
#### Returns
272271

@@ -303,7 +302,7 @@ event OwnerUpdated(address prevOwner, address newOwner)
303302

304303

305304

306-
*Emitted when a new Owner is set.*
305+
*Emitted when the contract owner is updated.*
307306

308307
#### Parameters
309308

@@ -333,7 +332,7 @@ event RoyaltyForToken(uint256 indexed tokenId, address royaltyRecipient, uint256
333332
### TokensUnwrapped
334333

335334
```solidity
336-
event TokensUnwrapped(address indexed wrapper, address sentTo, uint256 indexed tokenIdOfShares, uint256 sharesUnwrapped, MultiTokenTransferLib.MultiToken wrappedContents)
335+
event TokensUnwrapped(address indexed unwrapper, address indexed recipientOfWrappedContents, uint256 indexed tokenIdOfWrappedToken, IMultiwrap.Token[] wrappedContents)
337336
```
338337

339338

@@ -344,16 +343,15 @@ event TokensUnwrapped(address indexed wrapper, address sentTo, uint256 indexed t
344343

345344
| Name | Type | Description |
346345
|---|---|---|
347-
| wrapper `indexed` | address | undefined |
348-
| sentTo | address | undefined |
349-
| tokenIdOfShares `indexed` | uint256 | undefined |
350-
| sharesUnwrapped | uint256 | undefined |
351-
| wrappedContents | MultiTokenTransferLib.MultiToken | undefined |
346+
| unwrapper `indexed` | address | undefined |
347+
| recipientOfWrappedContents `indexed` | address | undefined |
348+
| tokenIdOfWrappedToken `indexed` | uint256 | undefined |
349+
| wrappedContents | IMultiwrap.Token[] | undefined |
352350

353351
### TokensWrapped
354352

355353
```solidity
356-
event TokensWrapped(address indexed wrapper, uint256 indexed tokenIdOfShares, MultiTokenTransferLib.MultiToken wrappedContents)
354+
event TokensWrapped(address indexed wrapper, address indexed recipientOfWrappedToken, uint256 indexed tokenIdOfWrappedToken, IMultiwrap.Token[] wrappedContents)
357355
```
358356

359357

@@ -365,8 +363,9 @@ event TokensWrapped(address indexed wrapper, uint256 indexed tokenIdOfShares, Mu
365363
| Name | Type | Description |
366364
|---|---|---|
367365
| wrapper `indexed` | address | undefined |
368-
| tokenIdOfShares `indexed` | uint256 | undefined |
369-
| wrappedContents | MultiTokenTransferLib.MultiToken | undefined |
366+
| recipientOfWrappedToken `indexed` | address | undefined |
367+
| tokenIdOfWrappedToken `indexed` | uint256 | undefined |
368+
| wrappedContents | IMultiwrap.Token[] | undefined |
370369

371370

372371

0 commit comments

Comments
 (0)