Skip to content

Commit 4bab677

Browse files
committed
chore: Add notes to registry contracts
1 parent 0c76839 commit 4bab677

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

contracts/registries/Registry.sol

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,11 @@ import {Create2} from "@openzeppelin/contracts-v5/utils/Create2.sol";
1010
import {IRegistry} from "./IRegistry.sol";
1111
import {ERC721Enumerable} from "@openzeppelin/contracts-v5/token/ERC721/extensions/ERC721Enumerable.sol";
1212

13+
// Note: this version of this contract that has been migrated to solidity v0.8 is not the
14+
// same version that is currently deployed on live networks. The reason being, registries
15+
// are not upgradable thus we don't mind having a mismatch between the deployed version
16+
// and the latest version in the codebase.
17+
1318
abstract contract Registry is IRegistry, ERC721Enumerable, Ownable {
1419
address public master;
1520
bytes public proxyCode;

contracts/registries/RegistryEntry.sol

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,11 @@ pragma solidity ^0.8.0;
55

66
import "./Registry.sol";
77

8+
// Note: this version of this contract that has been migrated to solidity v0.8 is not the
9+
// same version that is currently deployed on live networks. The reason being, registries
10+
// are not upgradable thus we don't mind having a mismatch between the deployed version
11+
// and the latest version in the codebase.
12+
813
/**
914
* @dev Referenced in the SDK with the current path `contracts/registries/RegistryEntry.sol`.
1015
* Changing the name or the path would cause a breaking change in the SDK.

0 commit comments

Comments
 (0)