-
Notifications
You must be signed in to change notification settings - Fork 119
/
HolographRegistry.sol
369 lines (320 loc) · 14.2 KB
/
HolographRegistry.sol
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
// SPDX-License-Identifier: UNLICENSED
/*
┌───────────┐
│ HOLOGRAPH │
└───────────┘
╔═════════════════════════════════════════════════════════════╗
║ ║
║ / ^ \ ║
║ ~~*~~ ¸ ║
║ [ '<>:<>' ] │░░░ ║
║ ╔╗ _/"\_ ╔╣ ║
║ ┌─╬╬─┐ """ ┌─╬╬─┐ ║
║ ┌─┬┘ ╠╣ └┬─┐ \_/ ┌─┬┘ ╠╣ └┬─┐ ║
║ ┌─┬┘ │ ╠╣ │ └┬─┐ ┌─┬┘ │ ╠╣ │ └┬─┐ ║
║ ┌─┬┘ │ │ ╠╣ │ │ └┬─┐ ┌─┬┘ │ │ ╠╣ │ │ └┬─┐ ║
║ ┌─┬┘ │ │ │ ╠╣ │ │ │ └┬┐ ┌┬┘ │ │ │ ╠╣ │ │ │ └┬─┐ ║
╠┬┘ │ │ │ │ ╠╣ │ │ │ │└¤┘│ │ │ │ ╠╣ │ │ │ │ └┬╣
║│ │ │ │ │ ╠╣ │ │ │ │ │ │ │ │ ╠╣ │ │ │ │ │║
╠╩══╩══╩══╩══╩══╬╬══╩══╩══╩══╩═══╩══╩══╩══╩══╬╬══╩══╩══╩══╩══╩╣
╠┴┴┴┴┴┴┴┴┴┴┴┴┴┴┴╬╬┴┴┴┴┴┴┴┴┴┴┴┴┴┴┴┴┴┴┴┴┴┴┴┴┴┴┴╬╬┴┴┴┴┴┴┴┴┴┴┴┴┴┴┴╣
║ ╠╣ ╠╣ ║
║ ╠╣ ╠╣ ║
║ , ╠╣ , ,' * ╠╣ ║
║~~~~~^~~~~~~~~┌╬╬┐~~~^~~~~~~~~^^~~~~~~~~^~~┌╬╬┐~~~~~~~^~~~~~~║
╚══════════════╩╩╩╩═════════════════════════╩╩╩╩══════════════╝
- one protocol, one bridge = infinite possibilities -
***************************************************************
DISCLAIMER: U.S Patent Pending
LICENSE: Holograph Limited Public License (H-LPL)
https://holograph.xyz/licenses/h-lpl/1.0.0
This license governs use of the accompanying software. If you
use the software, you accept this license. If you do not accept
the license, you are not permitted to use the software.
1. Definitions
The terms "reproduce," "reproduction," "derivative works," and
"distribution" have the same meaning here as under U.S.
copyright law. A "contribution" is the original software, or
any additions or changes to the software. A "contributor" is
any person that distributes its contribution under this
license. "Licensed patents" are a contributor’s patent claims
that read directly on its contribution.
2. Grant of Rights
A) Copyright Grant- Subject to the terms of this license,
including the license conditions and limitations in sections 3
and 4, each contributor grants you a non-exclusive, worldwide,
royalty-free copyright license to reproduce its contribution,
prepare derivative works of its contribution, and distribute
its contribution or any derivative works that you create.
B) Patent Grant- Subject to the terms of this license,
including the license conditions and limitations in section 3,
each contributor grants you a non-exclusive, worldwide,
royalty-free license under its licensed patents to make, have
made, use, sell, offer for sale, import, and/or otherwise
dispose of its contribution in the software or derivative works
of the contribution in the software.
3. Conditions and Limitations
A) No Trademark License- This license does not grant you rights
to use any contributors’ name, logo, or trademarks.
B) If you bring a patent claim against any contributor over
patents that you claim are infringed by the software, your
patent license from such contributor is terminated with
immediate effect.
C) If you distribute any portion of the software, you must
retain all copyright, patent, trademark, and attribution
notices that are present in the software.
D) If you distribute any portion of the software in source code
form, you may do so only under this license by including a
complete copy of this license with your distribution. If you
distribute any portion of the software in compiled or object
code form, you may only do so under a license that complies
with this license.
E) The software is licensed “as-is.” You bear all risks of
using it. The contributors give no express warranties,
guarantees, or conditions. You may have additional consumer
rights under your local laws which this license cannot change.
To the extent permitted under your local laws, the contributors
exclude all implied warranties, including those of
merchantability, fitness for a particular purpose and
non-infringement.
4. (F) Platform Limitation- The licenses granted in sections
2.A & 2.B extend only to the software or derivative works that
you create that run on a Holograph system product.
***************************************************************
*/
pragma solidity 0.8.13;
import "./abstract/Admin.sol";
import "./abstract/Initializable.sol";
import "./interface/HolographInterface.sol";
import "./interface/HolographRegistryInterface.sol";
import "./interface/InitializableInterface.sol";
/**
* @title Holograph Registry
* @author https://github.com/holographxyz
* @notice View and validate all deployed holographable contracts
* @dev Use this to: validate that contracts are Holograph Protocol compliant, get source code for supported standards, and interact with hTokens
*/
contract HolographRegistry is Admin, Initializable, HolographRegistryInterface {
/**
* @dev bytes32(uint256(keccak256('eip1967.Holograph.holograph')) - 1)
*/
bytes32 constant _holographSlot = 0xb4107f746e9496e8452accc7de63d1c5e14c19f510932daa04077cd49e8bd77a;
/**
* @dev bytes32(uint256(keccak256('eip1967.Holograph.utilityToken')) - 1)
*/
bytes32 constant _utilityTokenSlot = 0xbf76518d46db472b71aa7677a0908b8016f3dee568415ffa24055f9a670f9c37;
/**
* @dev Array of all Holographable contracts that were ever deployed on this chain
*/
address[] private _holographableContracts;
/**
* @dev A mapping of hashes to contract addresses
*/
mapping(bytes32 => address) private _holographedContractsHashMap;
/**
* @dev Storage slot for saving contract type to contract address references
*/
mapping(bytes32 => address) private _contractTypeAddresses;
/**
* @dev Reserved type addresses for Admin
* Note: this is used for defining default contracts
*/
mapping(bytes32 => bool) private _reservedTypes;
/**
* @dev A list of smart contracts that are guaranteed secure and holographable
*/
mapping(address => bool) private _holographedContracts;
/**
* @dev Mapping of all hTokens available for the different EVM chains
*/
mapping(uint32 => address) private _hTokens;
/**
* @dev Constructor is left empty and init is used instead
*/
constructor() {}
/**
* @notice Used internally to initialize the contract instead of through a constructor
* @dev This function is called by the deployer/factory when creating a contract
* @param initPayload abi encoded payload to use for contract initilaization
*/
function init(bytes memory initPayload) external override returns (bytes4) {
require(!_isInitialized(), "HOLOGRAPH: already initialized");
(address holograph, bytes32[] memory reservedTypes) = abi.decode(initPayload, (address, bytes32[]));
assembly {
sstore(_adminSlot, origin())
sstore(_holographSlot, holograph)
}
for (uint256 i = 0; i < reservedTypes.length; i++) {
_reservedTypes[reservedTypes[i]] = true;
}
_setInitialized();
return InitializableInterface.init.selector;
}
function isHolographedContract(address smartContract) external view returns (bool) {
return _holographedContracts[smartContract];
}
function isHolographedHashDeployed(bytes32 hash) external view returns (bool) {
return _holographedContractsHashMap[hash] != address(0);
}
function holographableEvent(bytes calldata payload) external {
if (_holographedContracts[msg.sender]) {
emit HolographableContractEvent(msg.sender, payload);
}
}
/**
* @dev Allows to reference a deployed smart contract, and use it's code as reference inside of Holographers
*/
function referenceContractTypeAddress(address contractAddress) external returns (bytes32) {
bytes32 contractType;
assembly {
contractType := extcodehash(contractAddress)
}
require(
(// check that bytecode is not empty
contractType != 0x0 &&
// check that hash is not for empty bytes
contractType != 0xc5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a470),
"HOLOGRAPH: empty contract"
);
require(_contractTypeAddresses[contractType] == address(0), "HOLOGRAPH: contract already set");
require(!_reservedTypes[contractType], "HOLOGRAPH: reserved address type");
_contractTypeAddresses[contractType] = contractAddress;
return contractType;
}
/**
* @dev Returns the contract address for a contract type
*/
function getContractTypeAddress(bytes32 contractType) external view returns (address) {
return _contractTypeAddresses[contractType];
}
/**
* @dev Sets the contract address for a contract type
*/
function setContractTypeAddress(bytes32 contractType, address contractAddress) external onlyAdmin {
require(_reservedTypes[contractType], "HOLOGRAPH: not reserved type");
_contractTypeAddresses[contractType] = contractAddress;
}
/**
* @notice Get the Holograph Protocol contract
* @dev This contract stores a reference to all the primary modules and variables of the protocol
*/
function getHolograph() external view returns (address holograph) {
assembly {
holograph := sload(_holographSlot)
}
}
/**
* @notice Update the Holograph Protocol contract address
* @param holograph address of the Holograph Protocol smart contract to use
*/
function setHolograph(address holograph) external onlyAdmin {
assembly {
sstore(_holographSlot, holograph)
}
}
/**
* @notice Get set length list, starting from index, for all holographable contracts
* @param index The index to start enumeration from
* @param length The length of returned results
* @return contracts address[] Returns a set length array of holographable contracts deployed
*/
function getHolographableContracts(uint256 index, uint256 length) external view returns (address[] memory contracts) {
uint256 supply = _holographableContracts.length;
if (index + length > supply) {
length = supply - index;
}
contracts = new address[](length);
for (uint256 i = 0; i < length; i++) {
contracts[i] = _holographableContracts[index + i];
}
}
/**
* @notice Get total number of deployed holographable contracts
*/
function getHolographableContractsLength() external view returns (uint256) {
return _holographableContracts.length;
}
/**
* @dev Returns the address for a holographed hash
*/
function getHolographedHashAddress(bytes32 hash) external view returns (address) {
return _holographedContractsHashMap[hash];
}
/**
* @dev Allows Holograph Factory to register a deployed contract, referenced with deployment hash
*/
function setHolographedHashAddress(bytes32 hash, address contractAddress) external {
address holograph;
assembly {
holograph := sload(_holographSlot)
}
require(msg.sender == HolographInterface(holograph).getFactory(), "HOLOGRAPH: factory only function");
_holographedContractsHashMap[hash] = contractAddress;
_holographedContracts[contractAddress] = true;
_holographableContracts.push(contractAddress);
}
/**
* @dev Returns the hToken address for a given chain id
*/
function getHToken(uint32 chainId) external view returns (address) {
return _hTokens[chainId];
}
/**
* @dev Sets the hToken address for a specific chain id
*/
function setHToken(uint32 chainId, address hToken) external onlyAdmin {
_hTokens[chainId] = hToken;
}
/**
* @dev Returns the reserved contract address for a contract type
*/
function getReservedContractTypeAddress(bytes32 contractType) external view returns (address contractTypeAddress) {
if (_reservedTypes[contractType]) {
contractTypeAddress = _contractTypeAddresses[contractType];
}
}
/**
* @dev Allows admin to update or toggle reserved type
*/
function setReservedContractTypeAddress(bytes32 hash, bool reserved) external onlyAdmin {
_reservedTypes[hash] = reserved;
}
/**
* @dev Allows admin to update or toggle reserved types
*/
function setReservedContractTypeAddresses(bytes32[] calldata hashes, bool[] calldata reserved) external onlyAdmin {
for (uint256 i = 0; i < hashes.length; i++) {
_reservedTypes[hashes[i]] = reserved[i];
}
}
/**
* @notice Get the Holograph Utility Token address
* @dev This is the official utility token of the Holograph Protocol
*/
function getUtilityToken() external view returns (address utilityToken) {
assembly {
utilityToken := sload(_utilityTokenSlot)
}
}
/**
* @notice Update the Holograph Utility Token address
* @param utilityToken address of the Holograph Utility Token smart contract to use
*/
function setUtilityToken(address utilityToken) external onlyAdmin {
assembly {
sstore(_utilityTokenSlot, utilityToken)
}
}
/**
* @dev Purposefully reverts to prevent having any type of ether transfered into the contract
*/
receive() external payable {
revert();
}
/**
* @dev Purposefully reverts to prevent any calls to undefined functions
*/
fallback() external payable {
revert();
}
}