Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add getCapabilities to the CapabilityRegistry #13031

Merged
merged 4 commits into from
Apr 30, 2024
Merged

Add getCapabilities to the CapabilityRegistry #13031

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1bb98de
Add getCapabilities
DeividasK Apr 29, 2024
ea0229d
Merge remote-tracking branch 'origin/develop' into KS-175-public-regi…
DeividasK Apr 29, 2024
50882f4
Fix comments
DeividasK Apr 29, 2024
a35a576
Merge branch 'develop' into KS-175-public-registry-get-capabilities
DeividasK Apr 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/early-cats-check.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"chainlink": patch
---

#internal
5 changes: 5 additions & 0 deletions contracts/.changeset/bright-dingos-attend.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@chainlink/contracts": patch
---

#internal
16 changes: 16 additions & 0 deletions contracts/src/v0.8/keystone/CapabilityRegistry.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,22 @@ contract CapabilityRegistry is OwnerIsCreator, TypeAndVersionInterface {
return s_capabilities[capabilityID];
}

/// @notice Returns all capabilities. This operation will copy capabilities
/// to memory, which can be quite expensive. This is designed to mostly be
/// used by view accessors that are queried without any gas fees.
/// @return Capability[] An array of capabilities
function getCapabilities() external view returns (Capability[] memory) {
bytes32[] memory capabilityIds = s_capabilityIds.values();
Capability[] memory capabilities = new Capability[](capabilityIds.length);

for (uint256 i; i < capabilityIds.length; ++i) {
bytes32 capabilityId = capabilityIds[i];
capabilities[i] = getCapability(capabilityId);
}

return capabilities;
}

/// @notice This functions returns a Capability ID packed into a bytes32 for cheaper access
/// @return bytes32 A unique identifier for the capability
function getCapabilityID(bytes32 capabilityType, bytes32 version) public pure returns (bytes32) {
Expand Down
16 changes: 16 additions & 0 deletions contracts/src/v0.8/keystone/test/BaseTest.t.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,27 @@ import {CapabilityRegistry} from "../CapabilityRegistry.sol";
contract BaseTest is Test, Constants {
CapabilityRegistry internal s_capabilityRegistry;
CapabilityConfigurationContract internal s_capabilityConfigurationContract;
CapabilityRegistry.Capability internal s_basicCapability;
CapabilityRegistry.Capability internal s_capabilityWithConfigurationContract;

function setUp() public virtual {
vm.startPrank(ADMIN);
s_capabilityRegistry = new CapabilityRegistry();
s_capabilityConfigurationContract = new CapabilityConfigurationContract();

s_basicCapability = CapabilityRegistry.Capability({
capabilityType: "data-streams-reports",
version: "1.0.0",
responseType: CapabilityRegistry.CapabilityResponseType.REPORT,
configurationContract: address(0)
});

s_capabilityWithConfigurationContract = CapabilityRegistry.Capability({
capabilityType: "read-ethereum-mainnet-gas-price",
version: "1.0.2",
responseType: CapabilityRegistry.CapabilityResponseType.OBSERVATION_IDENTICAL,
configurationContract: address(s_capabilityConfigurationContract)
});
}

function _getNodeOperators() internal view returns (CapabilityRegistry.NodeOperator[] memory) {
Expand Down
54 changes: 19 additions & 35 deletions contracts/src/v0.8/keystone/test/CapabilityRegistry_AddCapabilityTest.t.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,83 +7,67 @@ import {CapabilityConfigurationContract} from "./mocks/CapabilityConfigurationCo
import {CapabilityRegistry} from "../CapabilityRegistry.sol";

contract CapabilityRegistry_AddCapabilityTest is BaseTest {
CapabilityRegistry.Capability private basicCapability =
CapabilityRegistry.Capability({
capabilityType: "data-streams-reports",
version: "1.0.0",
responseType: CapabilityRegistry.CapabilityResponseType.REPORT,
configurationContract: address(0)
});

CapabilityRegistry.Capability private capabilityWithConfigurationContract =
CapabilityRegistry.Capability({
capabilityType: "read-ethereum-mainnet-gas-price",
version: "1.0.2",
responseType: CapabilityRegistry.CapabilityResponseType.OBSERVATION_IDENTICAL,
configurationContract: address(s_capabilityConfigurationContract)
});

function test_RevertWhen_CalledByNonAdmin() public {
changePrank(STRANGER);

vm.expectRevert("Only callable by owner");
s_capabilityRegistry.addCapability(basicCapability);
s_capabilityRegistry.addCapability(s_basicCapability);
}

function test_RevertWhen_CapabilityExists() public {
// Successfully add the capability the first time
s_capabilityRegistry.addCapability(basicCapability);
s_capabilityRegistry.addCapability(s_basicCapability);

// Try to add the same capability again
vm.expectRevert(CapabilityRegistry.CapabilityAlreadyExists.selector);
s_capabilityRegistry.addCapability(basicCapability);
s_capabilityRegistry.addCapability(s_basicCapability);
}

function test_RevertWhen_ConfigurationContractNotDeployed() public {
address nonExistentContract = address(1);
capabilityWithConfigurationContract.configurationContract = nonExistentContract;
s_capabilityWithConfigurationContract.configurationContract = nonExistentContract;

vm.expectRevert(
abi.encodeWithSelector(
CapabilityRegistry.InvalidCapabilityConfigurationContractInterface.selector,
nonExistentContract
)
);
s_capabilityRegistry.addCapability(capabilityWithConfigurationContract);
s_capabilityRegistry.addCapability(s_capabilityWithConfigurationContract);
}

function test_RevertWhen_ConfigurationContractDoesNotMatchInterface() public {
CapabilityRegistry contractWithoutERC165 = new CapabilityRegistry();

vm.expectRevert();
capabilityWithConfigurationContract.configurationContract = address(contractWithoutERC165);
s_capabilityRegistry.addCapability(capabilityWithConfigurationContract);
s_capabilityWithConfigurationContract.configurationContract = address(contractWithoutERC165);
s_capabilityRegistry.addCapability(s_capabilityWithConfigurationContract);
}

function test_AddCapability_NoConfigurationContract() public {
s_capabilityRegistry.addCapability(basicCapability);
s_capabilityRegistry.addCapability(s_basicCapability);

bytes32 capabilityId = s_capabilityRegistry.getCapabilityID(bytes32("data-streams-reports"), bytes32("1.0.0"));
CapabilityRegistry.Capability memory storedCapability = s_capabilityRegistry.getCapability(capabilityId);

assertEq(storedCapability.capabilityType, basicCapability.capabilityType);
assertEq(storedCapability.version, basicCapability.version);
assertEq(uint256(storedCapability.responseType), uint256(basicCapability.responseType));
assertEq(storedCapability.configurationContract, basicCapability.configurationContract);
assertEq(storedCapability.capabilityType, s_basicCapability.capabilityType);
assertEq(storedCapability.version, s_basicCapability.version);
assertEq(uint256(storedCapability.responseType), uint256(s_basicCapability.responseType));
assertEq(storedCapability.configurationContract, s_basicCapability.configurationContract);
}

function test_AddCapability_WithConfiguration() public {
s_capabilityRegistry.addCapability(capabilityWithConfigurationContract);
s_capabilityRegistry.addCapability(s_capabilityWithConfigurationContract);

bytes32 capabilityId = s_capabilityRegistry.getCapabilityID(
bytes32(capabilityWithConfigurationContract.capabilityType),
bytes32(capabilityWithConfigurationContract.version)
bytes32(s_capabilityWithConfigurationContract.capabilityType),
bytes32(s_capabilityWithConfigurationContract.version)
);
CapabilityRegistry.Capability memory storedCapability = s_capabilityRegistry.getCapability(capabilityId);

assertEq(storedCapability.capabilityType, capabilityWithConfigurationContract.capabilityType);
assertEq(storedCapability.version, capabilityWithConfigurationContract.version);
assertEq(uint256(storedCapability.responseType), uint256(capabilityWithConfigurationContract.responseType));
assertEq(storedCapability.configurationContract, capabilityWithConfigurationContract.configurationContract);
assertEq(storedCapability.capabilityType, s_capabilityWithConfigurationContract.capabilityType);
assertEq(storedCapability.version, s_capabilityWithConfigurationContract.version);
assertEq(uint256(storedCapability.responseType), uint256(s_capabilityWithConfigurationContract.responseType));
assertEq(storedCapability.configurationContract, s_capabilityWithConfigurationContract.configurationContract);
}
}
29 changes: 29 additions & 0 deletions contracts/src/v0.8/keystone/test/CapabilityRegistry_GetCapabilityIds.t.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
// SPDX-License-Identifier: MIT
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: file name inconsistent with the name of the test and the other file

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 will fix it in a follow-up to avoid merge conflict.

pragma solidity ^0.8.19;

import {BaseTest} from "./BaseTest.t.sol";
import {CapabilityRegistry} from "../CapabilityRegistry.sol";

contract CapabilityRegistry_GetCapabilitiesTest is BaseTest {
function test_ReturnsCapabilities() public {
s_capabilityRegistry.addCapability(s_basicCapability);
s_capabilityRegistry.addCapability(s_capabilityWithConfigurationContract);

CapabilityRegistry.Capability[] memory capabilities = s_capabilityRegistry.getCapabilities();

assertEq(capabilities.length, 2);

assertEq(capabilities[0].capabilityType, "data-streams-reports");
assertEq(capabilities[0].version, "1.0.0");
assertEq(uint256(capabilities[0].responseType), uint256(CapabilityRegistry.CapabilityResponseType.REPORT));
assertEq(capabilities[0].configurationContract, address(0));

assertEq(capabilities[1].capabilityType, "read-ethereum-mainnet-gas-price");
assertEq(capabilities[1].version, "1.0.2");
assertEq(
uint256(capabilities[1].responseType),
uint256(CapabilityRegistry.CapabilityResponseType.OBSERVATION_IDENTICAL)
);
assertEq(capabilities[1].configurationContract, address(s_capabilityConfigurationContract));
}
}
2 changes: 0 additions & 2 deletions contracts/src/v0.8/keystone/test/Constants.t.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.19;

import {Test} from "forge-std/Test.sol";

contract Constants {
address internal ADMIN = address(1);
address internal STRANGER = address(2);
Expand Down
4 changes: 4 additions & 0 deletions contracts/src/v0.8/keystone/test/mocks/CapabilityConfigurationContract.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,8 @@ contract CapabilityConfigurationContract is ICapabilityConfiguration, ERC165 {
function getCapabilityConfiguration(uint256 donId) external view returns (bytes memory configuration) {
return s_donConfiguration[donId];
}

function supportsInterface(bytes4 interfaceId) public pure override returns (bool) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't see this used anywhere, why is it needed?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is called by consumers/callers of this contract. My guess is the capability registry will call this prior to adding a particular configuration contract address to check that it supports the interface.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is used here: https://github.com/smartcontractkit/chainlink/pull/13031/files#diff-d94c1796b3544ef8780af7e16b5361c8fb9e4d63f492faeda6a3362a8363f51bR180-R182 (previous implementation and test weren't working as expected).

return interfaceId == this.getCapabilityConfiguration.selector;
}
}
28 changes: 26 additions & 2 deletions ...hwrappers/keystone/generated/keystone_capability_registry/keystone_capability_registry.go
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion core/gethwrappers/keystone/generation/generated-wrapper-dependency-versions-do-not-edit.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
GETH_VERSION: 1.13.8
forwarder: ../../../contracts/solc/v0.8.19/KeystoneForwarder/KeystoneForwarder.abi ../../../contracts/solc/v0.8.19/KeystoneForwarder/KeystoneForwarder.bin b4c900aae9e022f01abbac7993d41f93912247613ac6270b0c4da4ef6f2016e3
keystone_capability_registry: ../../../contracts/solc/v0.8.19/CapabilityRegistry/CapabilityRegistry.abi ../../../contracts/solc/v0.8.19/CapabilityRegistry/CapabilityRegistry.bin 5f801185084a6d6bcc08e0a37574d80f5092bc0dcd40808e9e04804064db0a56
keystone_capability_registry: ../../../contracts/solc/v0.8.19/CapabilityRegistry/CapabilityRegistry.abi ../../../contracts/solc/v0.8.19/CapabilityRegistry/CapabilityRegistry.bin ae9e077854854fa066746eaa354324c7dac2a13bc38b81a66c856fddfc3b79bf
ocr3_capability: ../../../contracts/solc/v0.8.19/OCR3Capability/OCR3Capability.abi ../../../contracts/solc/v0.8.19/OCR3Capability/OCR3Capability.bin 9dcbdf55bd5729ba266148da3f17733eb592c871c2108ccca546618628fd9ad2
Loading