Skip to content

Commit ea0e37a

Browse files
Krishang NadgaudaKrishang Nadgauda
Krishang Nadgauda
authored and
Krishang Nadgauda
committed
docs update
1 parent a0cb200 commit ea0e37a

File tree

1 file changed

+134
-0
lines changed

1 file changed

+134
-0
lines changed

docs/ITWRegistry.md

+134
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
# ITWRegistry
2+
3+
4+
5+
6+
7+
8+
9+
10+
11+
## Methods
12+
13+
### add
14+
15+
```solidity
16+
function add(address _deployer, address _deployment, uint256 _chainId) external nonpayable
17+
```
18+
19+
Add a deployment for a deployer.
20+
21+
22+
23+
#### Parameters
24+
25+
| Name | Type | Description |
26+
|---|---|---|
27+
| _deployer | address | undefined |
28+
| _deployment | address | undefined |
29+
| _chainId | uint256 | undefined |
30+
31+
### count
32+
33+
```solidity
34+
function count(address _deployer) external view returns (uint256 deploymentCount)
35+
```
36+
37+
Get the total number of deployments for a deployer.
38+
39+
40+
41+
#### Parameters
42+
43+
| Name | Type | Description |
44+
|---|---|---|
45+
| _deployer | address | undefined |
46+
47+
#### Returns
48+
49+
| Name | Type | Description |
50+
|---|---|---|
51+
| deploymentCount | uint256 | undefined |
52+
53+
### getAll
54+
55+
```solidity
56+
function getAll(address _deployer) external view returns (struct ITWRegistry.Deployment[] allDeployments)
57+
```
58+
59+
Get all deployments for a deployer.
60+
61+
62+
63+
#### Parameters
64+
65+
| Name | Type | Description |
66+
|---|---|---|
67+
| _deployer | address | undefined |
68+
69+
#### Returns
70+
71+
| Name | Type | Description |
72+
|---|---|---|
73+
| allDeployments | ITWRegistry.Deployment[] | undefined |
74+
75+
### remove
76+
77+
```solidity
78+
function remove(address _deployer, address _deployment, uint256 _chainId) external nonpayable
79+
```
80+
81+
Remove a deployment for a deployer.
82+
83+
84+
85+
#### Parameters
86+
87+
| Name | Type | Description |
88+
|---|---|---|
89+
| _deployer | address | undefined |
90+
| _deployment | address | undefined |
91+
| _chainId | uint256 | undefined |
92+
93+
94+
95+
## Events
96+
97+
### Added
98+
99+
```solidity
100+
event Added(address indexed deployer, address indexed deployment, uint256 indexed chainId)
101+
```
102+
103+
104+
105+
106+
107+
#### Parameters
108+
109+
| Name | Type | Description |
110+
|---|---|---|
111+
| deployer `indexed` | address | undefined |
112+
| deployment `indexed` | address | undefined |
113+
| chainId `indexed` | uint256 | undefined |
114+
115+
### Deleted
116+
117+
```solidity
118+
event Deleted(address indexed deployer, address indexed deployment, uint256 indexed chainId)
119+
```
120+
121+
122+
123+
124+
125+
#### Parameters
126+
127+
| Name | Type | Description |
128+
|---|---|---|
129+
| deployer `indexed` | address | undefined |
130+
| deployment `indexed` | address | undefined |
131+
| chainId `indexed` | uint256 | undefined |
132+
133+
134+

0 commit comments

Comments
 (0)