feat: Add V4 Addresses Provider #1310
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,166 @@ | ||
| // SPDX-License-Identifier: LicenseRef-BUSL | ||
| pragma solidity 0.8.28; | ||
|
|
||
| import {Ownable2StepUpgradeable} from 'src/dependencies/openzeppelin-upgradeable/Ownable2StepUpgradeable.sol'; | ||
| import {EnumerableSet} from 'src/dependencies/openzeppelin/EnumerableSet.sol'; | ||
| import {V4AddressesProviderStorage} from 'src/addresses-provider/V4AddressesProviderStorage.sol'; | ||
| import {IV4AddressesProvider} from 'src/addresses-provider/interfaces/IV4AddressesProvider.sol'; | ||
|
|
||
| /// @title V4AddressesProvider | ||
| /// @author Aave Labs | ||
| /// @notice Main registry of Aave V4 contract addresses. | ||
| abstract contract V4AddressesProvider is | ||
| V4AddressesProviderStorage, | ||
| Ownable2StepUpgradeable, | ||
| IV4AddressesProvider | ||
| { | ||
| using EnumerableSet for *; | ||
|
|
||
| /// @inheritdoc IV4AddressesProvider | ||
| string public constant CANONICAL_HUB_TAG = 'CANONICAL_HUB'; | ||
|
|
||
| /// @inheritdoc IV4AddressesProvider | ||
| string public constant CANONICAL_SPOKE_TAG = 'CANONICAL_SPOKE'; | ||
|
|
||
| /// @inheritdoc IV4AddressesProvider | ||
| string public constant TOKENIZATION_SPOKE_TAG = 'TOKENIZATION_SPOKE'; | ||
|
|
||
| /// @inheritdoc IV4AddressesProvider | ||
| string public constant TREASURY_SPOKE_TAG = 'TREASURY_SPOKE'; | ||
|
|
||
| /// @dev To be overridden by the inheriting V4AddressesProvider instance contract. | ||
| function initialize(address owner) external virtual; | ||
|
|
||
| /// @inheritdoc IV4AddressesProvider | ||
| function setAddress( | ||
| string memory name, | ||
| string memory tag, | ||
| address newAddress | ||
| ) external onlyOwner { | ||
| _setAddress({name: name, tag: tag, newAddress: newAddress}); | ||
| } | ||
|
|
||
| /// @inheritdoc IV4AddressesProvider | ||
| function setCanonicalHub(string memory name, address hub) external onlyOwner { | ||
| _setAddress({name: name, tag: CANONICAL_HUB_TAG, newAddress: hub}); | ||
| } | ||
|
|
||
| /// @inheritdoc IV4AddressesProvider | ||
| function setCanonicalSpoke(string memory name, address spoke) external onlyOwner { | ||
| _setAddress({name: name, tag: CANONICAL_SPOKE_TAG, newAddress: spoke}); | ||
| } | ||
|
|
||
| /// @inheritdoc IV4AddressesProvider | ||
| function setTokenizationSpoke(string memory name, address spoke) external onlyOwner { | ||
| _setAddress({name: name, tag: TOKENIZATION_SPOKE_TAG, newAddress: spoke}); | ||
| } | ||
|
|
||
| /// @inheritdoc IV4AddressesProvider | ||
| function setTreasurySpoke(string memory name, address spoke) external onlyOwner { | ||
| _setAddress({name: name, tag: TREASURY_SPOKE_TAG, newAddress: spoke}); | ||
| } | ||
|
|
||
| /// @inheritdoc IV4AddressesProvider | ||
| function getAddressEntry(bytes32 id) external view returns (AddressEntry memory) { | ||
| return _addressEntries[id]; | ||
| } | ||
|
|
||
| /// @inheritdoc IV4AddressesProvider | ||
| function getIds(string memory tag) external view returns (bytes32[] memory) { | ||
| return _taggedIds[tag].values(); | ||
| } | ||
|
Member
There was a problem hiding this comment. annoyingly we might need to overload with index and length methods instead of this bc we'll get a finding says array size can make inflate over gas limit (unlikely), we've done this way already elsewhere with array getters in the codebase
Contributor
Author
There was a problem hiding this comment. yes true, we should do this |
||
|
|
||
| /// @inheritdoc IV4AddressesProvider | ||
| function getTags() external view returns (string[] memory) { | ||
| return _tags.values(); | ||
| } | ||
|
|
||
| /// @inheritdoc IV4AddressesProvider | ||
| function getCanonicalHub(string memory name) external view returns (address) { | ||
|
DhairyaSethi marked this conversation as resolved.
Outdated
|
||
| return getAddress({name: name, tag: CANONICAL_HUB_TAG}); | ||
| } | ||
|
|
||
| /// @inheritdoc IV4AddressesProvider | ||
| function getCanonicalHubs() external view returns (address[] memory) { | ||
| return getAddresses(CANONICAL_HUB_TAG); | ||
| } | ||
|
|
||
| /// @inheritdoc IV4AddressesProvider | ||
| function getCanonicalSpoke(string memory name) external view returns (address) { | ||
| return getAddress({name: name, tag: CANONICAL_SPOKE_TAG}); | ||
| } | ||
|
|
||
| /// @inheritdoc IV4AddressesProvider | ||
| function getCanonicalSpokes() external view returns (address[] memory) { | ||
| return getAddresses(CANONICAL_SPOKE_TAG); | ||
| } | ||
|
|
||
| /// @inheritdoc IV4AddressesProvider | ||
| function getTokenizationSpoke(string memory name) external view returns (address) { | ||
| return getAddress({name: name, tag: TOKENIZATION_SPOKE_TAG}); | ||
| } | ||
|
|
||
| /// @inheritdoc IV4AddressesProvider | ||
| function getTokenizationSpokes() external view returns (address[] memory) { | ||
| return getAddresses(TOKENIZATION_SPOKE_TAG); | ||
| } | ||
|
|
||
| /// @inheritdoc IV4AddressesProvider | ||
| function getTreasurySpoke(string memory name) external view returns (address) { | ||
| return getAddress({name: name, tag: TREASURY_SPOKE_TAG}); | ||
| } | ||
|
|
||
| /// @inheritdoc IV4AddressesProvider | ||
| function getTreasurySpokes() external view returns (address[] memory) { | ||
| return getAddresses(TREASURY_SPOKE_TAG); | ||
| } | ||
|
|
||
| /// @inheritdoc IV4AddressesProvider | ||
| function getAddress(bytes32 id) public view returns (address) { | ||
| return _addressEntries[id].addr; | ||
| } | ||
|
|
||
| /// @inheritdoc IV4AddressesProvider | ||
| function getAddress(string memory name, string memory tag) public view returns (address) { | ||
| return getAddress(getId({name: name, tag: tag})); | ||
| } | ||
|
|
||
| /// @inheritdoc IV4AddressesProvider | ||
| function getAddresses(string memory tag) public view returns (address[] memory) { | ||
| bytes32[] memory ids = _taggedIds[tag].values(); | ||
| address[] memory addresses = new address[](ids.length); | ||
| for (uint256 i = 0; i < ids.length; i++) { | ||
| addresses[i] = _addressEntries[ids[i]].addr; | ||
| } | ||
| return addresses; | ||
| } | ||
|
|
||
| /// @inheritdoc IV4AddressesProvider | ||
| function getId(string memory name, string memory tag) public pure returns (bytes32) { | ||
| return keccak256(bytes(string.concat(name, '_', tag))); | ||
| } | ||
|
|
||
| function _setAddress(string memory name, string memory tag, address newAddress) internal { | ||
| require(bytes(name).length > 0, InvalidName()); | ||
| require(bytes(tag).length > 0, InvalidTag()); | ||
|
|
||
| bytes32 id = getId({name: name, tag: tag}); | ||
| AddressEntry memory oldEntry = _addressEntries[id]; | ||
|
|
||
| if (newAddress == address(0)) { | ||
| require(oldEntry.addr != address(0), AddressNotSet(id)); | ||
| _taggedIds[oldEntry.tag].remove(id); | ||
| if (_taggedIds[oldEntry.tag].length() == 0) { | ||
| _tags.remove(oldEntry.tag); | ||
| } | ||
| delete _addressEntries[id]; | ||
| } else { | ||
| require(oldEntry.addr == address(0), AddressAlreadySet(id)); | ||
| _addressEntries[id] = AddressEntry({addr: newAddress, tag: tag}); | ||
| _taggedIds[tag].add(id); | ||
| _tags.add(tag); | ||
| } | ||
|
|
||
| emit AddressSet(id, name, tag, oldEntry.addr, newAddress); | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| // SPDX-License-Identifier: LicenseRef-BUSL | ||
| pragma solidity 0.8.28; | ||
|
|
||
| import {EnumerableSet} from 'src/dependencies/openzeppelin/EnumerableSet.sol'; | ||
| import {IV4AddressesProvider} from 'src/addresses-provider/interfaces/IV4AddressesProvider.sol'; | ||
|
|
||
| /// @title V4AddressesProviderStorage | ||
| /// @author Aave Labs | ||
| /// @notice Storage layout for the V4AddressesProvider contract. | ||
| /// @dev This contract defines all storage variables used by the V4AddressesProvider. | ||
| abstract contract V4AddressesProviderStorage { | ||
| /// @dev Map of entry identifiers to address entries. | ||
| mapping(bytes32 id => IV4AddressesProvider.AddressEntry) internal _addressEntries; | ||
|
Member
There was a problem hiding this comment. i d follow the same conventions we used as for |
||
|
|
||
| /// @dev Map of tags to set of entry identifiers. | ||
| mapping(string tag => EnumerableSet.Bytes32Set ids) internal _taggedIds; | ||
|
|
||
| /// @dev Set of all tags with at least one registered entry. | ||
| EnumerableSet.StringSet internal _tags; | ||
|
|
||
| /// @dev Reserved storage space to allow for future layout updates. | ||
| uint256[50] private __gap; | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| // SPDX-License-Identifier: LicenseRef-BUSL | ||
| pragma solidity 0.8.28; | ||
|
|
||
| import {V4AddressesProvider} from 'src/addresses-provider/V4AddressesProvider.sol'; | ||
|
|
||
| /// @title V4AddressesProviderInstance | ||
| /// @author Aave Labs | ||
| /// @notice Implementation contract for the V4AddressesProvider. | ||
| contract V4AddressesProviderInstance is V4AddressesProvider { | ||
| uint64 public constant ADDRESSES_PROVIDER_REVISION = 1; | ||
|
|
||
| /// @dev Constructor. | ||
| constructor() { | ||
| _disableInitializers(); | ||
| } | ||
|
|
||
| /// @notice Initializer. | ||
| /// @param owner The address of the owner. | ||
| function initialize(address owner) external override reinitializer(ADDRESSES_PROVIDER_REVISION) { | ||
| __Ownable_init(owner); | ||
| __Ownable2Step_init(); | ||
| } | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thinking more its a registry
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I followed the v3 naming convention here (also with the plural in "addresses" which I don't like). I'm fine changing the name, thoughts @Kogaroshi @miguelmtzinf ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it's better to keep v3 name convention, so we don't have more difference of naming in the tooling.