Skip to content

Commit f8726c5

Browse files
kumaryash90kumaryash90
committed
update docs
1 parent 9247a05 commit f8726c5

File tree

8 files changed

+283
-215
lines changed

8 files changed

+283
-215
lines changed

‎docs/ERC721Multiwrap.md‎

Lines changed: 23 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -27,23 +27,6 @@ function DEFAULT_ADMIN_ROLE() external view returns (bytes32)
2727
|---|---|---|
2828
| _0 | bytes32 | undefined |
2929

30-
### NATIVE_TOKEN
31-
32-
```solidity
33-
function NATIVE_TOKEN() external view returns (address)
34-
```
35-
36-
37-
38-
39-
40-
41-
#### Returns
42-
43-
| Name | Type | Description |
44-
|---|---|---|
45-
| _0 | address | undefined |
46-
4730
### TRANSFER_ROLE
4831

4932
```solidity
@@ -100,6 +83,29 @@ function balanceOf(address owner) external view returns (uint256)
10083
|---|---|---|
10184
| _0 | uint256 | undefined |
10285

86+
### bundle
87+
88+
```solidity
89+
function bundle(uint256) external view returns (uint256 count, string uri)
90+
```
91+
92+
93+
94+
95+
96+
#### Parameters
97+
98+
| Name | Type | Description |
99+
|---|---|---|
100+
| _0 | uint256 | undefined |
101+
102+
#### Returns
103+
104+
| Name | Type | Description |
105+
|---|---|---|
106+
| count | uint256 | undefined |
107+
| uri | string | undefined |
108+
103109
### contractURI
104110

105111
```solidity

‎docs/ForwarderEOAOnly.md‎

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
# ForwarderEOAOnly
2+
3+
4+
5+
6+
7+
8+
9+
10+
11+
## Methods
12+
13+
### execute
14+
15+
```solidity
16+
function execute(MinimalForwarderEOAOnly.ForwardRequest req, bytes signature) external payable returns (bool, bytes)
17+
```
18+
19+
20+
21+
22+
23+
#### Parameters
24+
25+
| Name | Type | Description |
26+
|---|---|---|
27+
| req | MinimalForwarderEOAOnly.ForwardRequest | undefined |
28+
| signature | bytes | undefined |
29+
30+
#### Returns
31+
32+
| Name | Type | Description |
33+
|---|---|---|
34+
| _0 | bool | undefined |
35+
| _1 | bytes | undefined |
36+
37+
### getNonce
38+
39+
```solidity
40+
function getNonce(address from) external view returns (uint256)
41+
```
42+
43+
44+
45+
46+
47+
#### Parameters
48+
49+
| Name | Type | Description |
50+
|---|---|---|
51+
| from | address | undefined |
52+
53+
#### Returns
54+
55+
| Name | Type | Description |
56+
|---|---|---|
57+
| _0 | uint256 | undefined |
58+
59+
### verify
60+
61+
```solidity
62+
function verify(MinimalForwarderEOAOnly.ForwardRequest req, bytes signature) external view returns (bool)
63+
```
64+
65+
66+
67+
68+
69+
#### Parameters
70+
71+
| Name | Type | Description |
72+
|---|---|---|
73+
| req | MinimalForwarderEOAOnly.ForwardRequest | undefined |
74+
| signature | bytes | undefined |
75+
76+
#### Returns
77+
78+
| Name | Type | Description |
79+
|---|---|---|
80+
| _0 | bool | undefined |
81+
82+
83+
84+

‎docs/IPack.md‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The thirdweb `Pack` contract is a lootbox mechanism. An account can bundle up ar
1313
### createPack
1414

1515
```solidity
16-
function createPack(ITokenBundle.Token[] contents, uint256[] numOfRewardUnits, string packUri, uint128 openStartTimestamp, uint128 amountDistributedPerOpen, uint256 expirationTimestamp, address recipient) external payable returns (uint256 packId, uint256 packTotalSupply)
16+
function createPack(ITokenBundle.Token[] contents, uint256[] numOfRewardUnits, string packUri, uint128 openStartTimestamp, uint128 amountDistributedPerOpen, address recipient) external payable returns (uint256 packId, uint256 packTotalSupply)
1717
```
1818

1919

@@ -68,7 +68,7 @@ Lets a pack owner open a pack and receive the pack's reward unit.
6868
### PackCreated
6969

7070
```solidity
71-
event PackCreated(uint256 indexed packId, address indexed packCreator, address recipient, uint256 totalPacksCreated)
71+
event PackCreated(uint256 indexed packId, address recipient, uint256 totalPacksCreated)
7272
```
7373

7474
Emitted when a set of packs is created.
@@ -80,7 +80,6 @@ Emitted when a set of packs is created.
8080
| Name | Type | Description |
8181
|---|---|---|
8282
| packId `indexed` | uint256 | undefined |
83-
| packCreator `indexed` | address | undefined |
8483
| recipient | address | undefined |
8584
| totalPacksCreated | uint256 | undefined |
8685

@@ -106,7 +105,7 @@ Emitted when a pack is opened.
106105
### PackUpdated
107106

108107
```solidity
109-
event PackUpdated(uint256 indexed packId, address indexed packCreator, address recipient, uint256 totalPacksCreated)
108+
event PackUpdated(uint256 indexed packId, address recipient, uint256 totalPacksCreated)
110109
```
111110

112111
Emitted when more packs are minted for a packId.
@@ -118,7 +117,6 @@ Emitted when more packs are minted for a packId.
118117
| Name | Type | Description |
119118
|---|---|---|
120119
| packId `indexed` | uint256 | undefined |
121-
| packCreator `indexed` | address | undefined |
122120
| recipient | address | undefined |
123121
| totalPacksCreated | uint256 | undefined |
124122

‎docs/MinimalForwarderEOAOnly.md‎

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
# MinimalForwarderEOAOnly
2+
3+
4+
5+
6+
7+
8+
9+
*Simple minimal forwarder to be used together with an ERC2771 compatible contract. See {ERC2771Context}.*
10+
11+
## Methods
12+
13+
### execute
14+
15+
```solidity
16+
function execute(MinimalForwarderEOAOnly.ForwardRequest req, bytes signature) external payable returns (bool, bytes)
17+
```
18+
19+
20+
21+
22+
23+
#### Parameters
24+
25+
| Name | Type | Description |
26+
|---|---|---|
27+
| req | MinimalForwarderEOAOnly.ForwardRequest | undefined |
28+
| signature | bytes | undefined |
29+
30+
#### Returns
31+
32+
| Name | Type | Description |
33+
|---|---|---|
34+
| _0 | bool | undefined |
35+
| _1 | bytes | undefined |
36+
37+
### getNonce
38+
39+
```solidity
40+
function getNonce(address from) external view returns (uint256)
41+
```
42+
43+
44+
45+
46+
47+
#### Parameters
48+
49+
| Name | Type | Description |
50+
|---|---|---|
51+
| from | address | undefined |
52+
53+
#### Returns
54+
55+
| Name | Type | Description |
56+
|---|---|---|
57+
| _0 | uint256 | undefined |
58+
59+
### verify
60+
61+
```solidity
62+
function verify(MinimalForwarderEOAOnly.ForwardRequest req, bytes signature) external view returns (bool)
63+
```
64+
65+
66+
67+
68+
69+
#### Parameters
70+
71+
| Name | Type | Description |
72+
|---|---|---|
73+
| req | MinimalForwarderEOAOnly.ForwardRequest | undefined |
74+
| signature | bytes | undefined |
75+
76+
#### Returns
77+
78+
| Name | Type | Description |
79+
|---|---|---|
80+
| _0 | bool | undefined |
81+
82+
83+
84+

‎docs/Multiwrap.md‎

Lines changed: 22 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -27,61 +27,67 @@ function DEFAULT_ADMIN_ROLE() external view returns (bytes32)
2727
|---|---|---|
2828
| _0 | bytes32 | undefined |
2929

30-
### NATIVE_TOKEN
30+
### approve
3131

3232
```solidity
33-
function NATIVE_TOKEN() external view returns (address)
33+
function approve(address to, uint256 tokenId) external nonpayable
3434
```
3535

3636

3737

38+
*See {IERC721-approve}.*
3839

39-
40-
41-
#### Returns
40+
#### Parameters
4241

4342
| Name | Type | Description |
4443
|---|---|---|
45-
| _0 | address | undefined |
44+
| to | address | undefined |
45+
| tokenId | uint256 | undefined |
4646

47-
### approve
47+
### balanceOf
4848

4949
```solidity
50-
function approve(address to, uint256 tokenId) external nonpayable
50+
function balanceOf(address owner) external view returns (uint256)
5151
```
5252

5353

5454

55-
*See {IERC721-approve}.*
55+
*See {IERC721-balanceOf}.*
5656

5757
#### Parameters
5858

5959
| Name | Type | Description |
6060
|---|---|---|
61-
| to | address | undefined |
62-
| tokenId | uint256 | undefined |
61+
| owner | address | undefined |
6362

64-
### balanceOf
63+
#### Returns
64+
65+
| Name | Type | Description |
66+
|---|---|---|
67+
| _0 | uint256 | undefined |
68+
69+
### bundle
6570

6671
```solidity
67-
function balanceOf(address owner) external view returns (uint256)
72+
function bundle(uint256) external view returns (uint256 count, string uri)
6873
```
6974

7075

7176

72-
*See {IERC721-balanceOf}.*
77+
7378

7479
#### Parameters
7580

7681
| Name | Type | Description |
7782
|---|---|---|
78-
| owner | address | undefined |
83+
| _0 | uint256 | undefined |
7984

8085
#### Returns
8186

8287
| Name | Type | Description |
8388
|---|---|---|
84-
| _0 | uint256 | undefined |
89+
| count | uint256 | undefined |
90+
| uri | string | undefined |
8591

8692
### contractType
8793

0 commit comments

Comments
 (0)