Skip to content

Commit c886fd4

Browse files
nkrishangnkrishang
authored
Merge pull request #160 from thirdweb-dev/yash/multiwrap
Multiwrap: using thirdweb-dev/contracts/feature/
2 parents 8452bd4 + b0b4fb7 commit c886fd4

26 files changed

Lines changed: 1680 additions & 603 deletions

‎assets/multiwrap-diagram.png‎

871 KB
Loading

‎contracts/feature/ContractMetadata.sol‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,12 @@ abstract contract ContractMetadata is IContractMetadata {
88
string public override contractURI;
99

1010
/// @dev Lets a contract admin set the URI for contract-level metadata.
11-
function setContractURI(string calldata _uri) external override {
11+
function setContractURI(string memory _uri) public override {
1212
require(_canSetContractURI(), "Not authorized");
13+
string memory prevURI = contractURI;
1314
contractURI = _uri;
15+
16+
emit ContractURIUpdated(prevURI, _uri);
1417
}
1518

1619
/// @dev Returns whether contract metadata can be set in the given execution context.

‎contracts/feature/Permissions.sol‎

Lines changed: 32 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -19,32 +19,31 @@ contract Permissions is IPermissions {
1919
return _hasRole[role][account];
2020
}
2121

22+
function hasRoleWithSwitch(bytes32 role, address account) public view returns (bool) {
23+
if (!_hasRole[role][address(0)]) {
24+
return _hasRole[role][account];
25+
}
26+
27+
return true;
28+
}
29+
2230
function getRoleAdmin(bytes32 role) public view override returns (bytes32) {
2331
return _getRoleAdmin[role];
2432
}
2533

2634
function grantRole(bytes32 role, address account) public virtual override {
2735
_checkRole(_getRoleAdmin[role], msg.sender);
28-
29-
_hasRole[role][account] = true;
30-
31-
emit RoleGranted(role, account, msg.sender);
36+
_setupRole(role, account);
3237
}
3338

3439
function revokeRole(bytes32 role, address account) public virtual override {
3540
_checkRole(_getRoleAdmin[role], msg.sender);
36-
37-
delete _hasRole[role][account];
38-
39-
emit RoleRevoked(role, account, msg.sender);
41+
_revokeRole(role, account);
4042
}
4143

4244
function renounceRole(bytes32 role, address account) public virtual override {
4345
require(msg.sender == account, "Can only renounce for self");
44-
45-
delete _hasRole[role][account];
46-
47-
emit RoleRevoked(role, account, msg.sender);
46+
_revokeRole(role, account);
4847
}
4948

5049
function _setRoleAdmin(bytes32 role, bytes32 adminRole) internal virtual {
@@ -58,12 +57,32 @@ contract Permissions is IPermissions {
5857
emit RoleGranted(role, account, msg.sender);
5958
}
6059

60+
function _revokeRole(bytes32 role, address account) internal virtual {
61+
delete _hasRole[role][account];
62+
emit RoleRevoked(role, account, msg.sender);
63+
}
64+
6165
function _checkRole(bytes32 role, address account) internal view virtual {
6266
if (!_hasRole[role][account]) {
6367
revert(
6468
string(
6569
abi.encodePacked(
66-
"AccessControl: account ",
70+
"Permissions: account ",
71+
Strings.toHexString(uint160(account), 20),
72+
" is missing role ",
73+
Strings.toHexString(uint256(role), 32)
74+
)
75+
)
76+
);
77+
}
78+
}
79+
80+
function _checkRoleWithSwitch(bytes32 role, address account) internal view virtual {
81+
if (!hasRoleWithSwitch(role, account)) {
82+
revert(
83+
string(
84+
abi.encodePacked(
85+
"Permissions: account ",
6786
Strings.toHexString(uint160(account), 20),
6887
" is missing role ",
6988
Strings.toHexString(uint256(role), 32)

‎contracts/feature/TokenStore.sol‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
// SPDX-License-Identifier: Apache-2.0
2+
pragma solidity ^0.8.0;
3+
4+
// ========== External imports ==========
5+
6+
import "@openzeppelin/contracts/token/ERC1155/IERC1155.sol";
7+
import "@openzeppelin/contracts/token/ERC721/IERC721.sol";
8+
9+
import "@openzeppelin/contracts/token/ERC1155/utils/ERC1155Holder.sol";
10+
import "@openzeppelin/contracts/token/ERC721/utils/ERC721Holder.sol";
11+
12+
// ========== Internal imports ==========
13+
14+
import "./TokenBundle.sol";
15+
import "../lib/CurrencyTransferLib.sol";
16+
17+
contract TokenStore is TokenBundle, ERC721Holder, ERC1155Holder {
18+
/// @dev The address of the native token wrapper contract.
19+
address private immutable nativeTokenWrapper;
20+
21+
constructor(address _nativeTokenWrapper) {
22+
nativeTokenWrapper = _nativeTokenWrapper;
23+
}
24+
25+
/// @dev Store / escrow multiple ERC1155, ERC721, ERC20 tokens.
26+
function _storeTokens(
27+
address _tokenOwner,
28+
Token[] calldata _tokens,
29+
string calldata _uriForTokens,
30+
uint256 _idForTokens
31+
) internal {
32+
_setBundle(_tokens, _idForTokens);
33+
_setUriOfBundle(_uriForTokens, _idForTokens);
34+
_transferTokenBatch(_tokenOwner, address(this), _tokens);
35+
}
36+
37+
/// @dev Release stored / escrowed ERC1155, ERC721, ERC20 tokens.
38+
function _releaseTokens(address _recipient, uint256 _idForContent) internal {
39+
uint256 count = getTokenCountOfBundle(_idForContent);
40+
Token[] memory tokensToRelease = new Token[](count);
41+
42+
for (uint256 i = 0; i < count; i += 1) {
43+
tokensToRelease[i] = getTokenOfBundle(_idForContent, i);
44+
}
45+
46+
_deleteBundle(_idForContent);
47+
48+
_transferTokenBatch(address(this), _recipient, tokensToRelease);
49+
}
50+
51+
/// @dev Transfers an arbitrary ERC20 / ERC721 / ERC1155 token.
52+
function _transferToken(
53+
address _from,
54+
address _to,
55+
Token memory _token
56+
) internal {
57+
if (_token.tokenType == TokenType.ERC20) {
58+
CurrencyTransferLib.transferCurrencyWithWrapper(
59+
_token.assetContract,
60+
_from,
61+
_to,
62+
_token.totalAmount,
63+
nativeTokenWrapper
64+
);
65+
} else if (_token.tokenType == TokenType.ERC721) {
66+
IERC721(_token.assetContract).safeTransferFrom(_from, _to, _token.tokenId);
67+
} else if (_token.tokenType == TokenType.ERC1155) {
68+
IERC1155(_token.assetContract).safeTransferFrom(_from, _to, _token.tokenId, _token.totalAmount, "");
69+
}
70+
}
71+
72+
/// @dev Transfers multiple arbitrary ERC20 / ERC721 / ERC1155 tokens.
73+
function _transferTokenBatch(
74+
address _from,
75+
address _to,
76+
Token[] memory _tokens
77+
) internal {
78+
for (uint256 i = 0; i < _tokens.length; i += 1) {
79+
_transferToken(_from, _to, _tokens[i]);
80+
}
81+
}
82+
}

‎contracts/feature/interface/IContractMetadata.sol‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,6 @@ interface IContractMetadata {
1010
* Only module admin can call this function.
1111
*/
1212
function setContractURI(string calldata _uri) external;
13+
14+
event ContractURIUpdated(string prevURI, string newURI);
1315
}

‎contracts/interfaces/IMultiwrap.sol‎

Lines changed: 4 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,16 @@
11
// SPDX-License-Identifier: Apache-2.0
22
pragma solidity ^0.8.11;
33

4+
import "../feature/interface/ITokenBundle.sol";
5+
46
/**
57
* Thirdweb's Multiwrap contract lets you wrap arbitrary ERC20, ERC721 and ERC1155
68
* tokens you own into a single wrapped token / NFT.
79
*
810
* A wrapped NFT can be unwrapped i.e. burned in exchange for its underlying contents.
911
*/
1012

11-
interface IMultiwrap {
12-
/// @notice The type of assets that can be wrapped.
13-
enum TokenType {
14-
ERC20,
15-
ERC721,
16-
ERC1155
17-
}
18-
19-
/**
20-
* @notice A generic interface to describe a token to wrap.
21-
*
22-
* @param assetContract The contract address of the asset to wrap.
23-
* @param tokenType The token type (ERC20 / ERC721 / ERC1155) of the asset to wrap.
24-
* @param tokenId The token Id of the asset to wrap, if the asset is an ERC721 / ERC1155 NFT.
25-
* @param amount The amount of the asset to wrap, if the asset is an ERC20 / ERC1155 fungible token.
26-
*/
27-
struct Token {
28-
address assetContract;
29-
TokenType tokenType;
30-
uint256 tokenId;
31-
uint256 amount;
32-
}
33-
34-
/**
35-
* @notice An internal data structure to track the wrapped contents of a wrapped NFT.
36-
*
37-
* @param count The total kinds of assets i.e. `Token` wrapped.
38-
* @param token Mapping from a UID -> to the asset i.e. `Token` at that UID.
39-
*/
40-
struct WrappedContents {
41-
uint256 count;
42-
mapping(uint256 => Token) token;
43-
}
44-
13+
interface IMultiwrap is ITokenBundle {
4514
/// @dev Emitted when tokens are wrapped.
4615
event TokensWrapped(
4716
address indexed wrapper,
@@ -54,8 +23,7 @@ interface IMultiwrap {
5423
event TokensUnwrapped(
5524
address indexed unwrapper,
5625
address indexed recipientOfWrappedContents,
57-
uint256 indexed tokenIdOfWrappedToken,
58-
Token[] wrappedContents
26+
uint256 indexed tokenIdOfWrappedToken
5927
);
6028

6129
/**

0 commit comments

Comments
 (0)