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.

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

V0.4.0 internal audit #55

Merged
merged 5 commits into from
Dec 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion audit/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ This section contains audit-related materials.
### Internal audit
An internal audit with a focus on contracts is located in this folder: [internal audit](https://github.com/valory-xyz/ai-registry-mech/blob/main/audits/internal).
An internal audit with a focus on marketplace contracts is located in this folder: [internal audit 1](https://github.com/valory-xyz/ai-registry-mech/blob/main/audits/internal1).

An internal audit with a focus on updated marketplace contracts is located in this folder: [internal audit 2](https://github.com/valory-xyz/ai-registry-mech/blob/main/audits/internal2).
204 changes: 204 additions & 0 deletions audit/internal2/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,204 @@
# Internal audit of autonolas-staking-programmes
The review has been performed based on the contract code in the following repository:<br>
`https://github.com/valory-xyz/ai-registry-mech` <br>
commit: 7a8708d345a2201a1b693164f97dd9266532ea1b (tag: v0.4.0-pre-internal-audit) <br>

## Objectives
The audit focused on updated marketplace contracts in this repo. <br>
Limits: The subject of the audit is not contracts used as library contracts. Thus, this audit is not a full-fledged audit of contracts underlying the contract ERC721Mech. <br>

### Flatten version
Flatten version of contracts. [contracts](https://github.com/valory-xyz/ai-registry-mech/blob/main/audits/internal1/analysis/contracts)

### Security issues. Updated 17-12-2024
#### Problems found instrumentally
Several checks are obtained automatically. They are commented. <br>
All automatic warnings are listed in the following file, concerns of which we address in more detail below: <br>
[slither-full](https://github.com/valory-xyz/autonolas-staking-programmes/blob/main/audits/internal2/analysis/slither_full.txt)
Most of the issues raised by instrumental analysis are outside the scope of the audit. <br>


### Issue
#### Critical? _preDeliver() passed low then price and zero balance
```
// Check for the number of credits available in the subscription
Copy link
Collaborator

@Sfgangloff Sfgangloff Dec 18, 2024

Choose a reason for hiding this comment

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

_preDeliver() should probably be reverted whenever creditsToBurn < creditsBalance.
This means in particular that when there is not enough credit in the balance, the mech can't deliver (I think it would not want to). Should also be ok like this (if the mech wants to deliver for less than its price, why not), just need to add the possibility for the mech to check the requester's balance before deliver

uint256 creditsBalance = IERC1155(subscriptionNFT).balanceOf(account, subscriptionTokenId);

// Adjust the amount of credits to burn if the deliver price is bigger than the amount of credits available
uint256 creditsToBurn = deliverPrice;
if (creditsToBurn > creditsBalance) {
creditsToBurn = creditsBalance;
}

// Burn credits of the request Id sender upon delivery
if (creditsToBurn > 0) {
IERC1155(subscriptionNFT).burn(account, subscriptionTokenId, creditsToBurn);
}
1. creditsBalance = IERC1155(subscriptionNFT).balanceOf => let 1token
2. deliverPrice > creditsBalance => let 2token > 1token
3. creditsToBurn = creditsBalance => creditsToBurn = 1token
4. IERC1155(subscriptionNFT).burn(1token)
Already from my point of view it is a problem. The price is 2 tokens - and we allow to pass with 1 token for the price of 2.
next
1. creditsBalance = IERC1155(subscriptionNFT).balanceOf => let 0token
2. deliverPrice > creditsBalance => let 2token > 0token
3. creditsToBurn = creditsBalance => creditsToBurn = 0token
4. if (creditsToBurn > 0) {
IERC1155(subscriptionNFT).burn(account, subscriptionTokenId, creditsToBurn);
} - skip
5. pass
```
[]

#### Medium. _calculatePayment not update collectedFees;
Copy link
Collaborator

Choose a reason for hiding this comment

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

```
function _calculatePayment(
address mech,
uint256 payment
) internal virtual returns (uint256 mechPayment, uint256 marketplaceFee) {
```
[]

#### Medium. payable fallback()
```
Must be payable.
fallback() external {
// solhint-disable-next-line avoid-low-level-calls
```
[]

#### Medium. Typo in check.
```
price == 0 => _price == 0
constructor(address _mechMarketplace, address _serviceRegistry, uint256 _serviceId, uint256 _price)
OlasMech(_mechMarketplace, _serviceRegistry, _serviceId)
{
// Check for zero value
if (price == 0) {
revert ZeroValue();
}
```
[]

#### Low? Notices? OlasMech.setUp(bytes) event
[]

#### Low? Notices? Karma.sol Uniform approach to location getImplementation() (proxy/implementation)
```
Depending on what they understand better for etherscan. Probably in proxy better.
/// @dev Gets the implementation address.
/// @return implementation Implementation address.
function getImplementation() external view returns (address implementation) {
// solhint-disable-next-line avoid-low-level-calls
assembly {
implementation := sload(KARMA_PROXY)
}
}
```
[]

### Low? improvement create2(), due to unpredictability.
```
function createMech(
address mechMarketplace,
address serviceRegistry,
uint256 serviceId,
bytes memory payload
) external returns (address mech) {
// Check payload length
if (payload.length != 32) {
revert IncorrectDataLength(payload.length, 32);
}

// Decode price
uint256 price = abi.decode(payload, (uint256));

// Get salt
bytes32 salt = keccak256(abi.encode(block.timestamp, msg.sender, serviceId));

// Service multisig is isOperator() for the mech
mech = address((new MechFixedPrice){salt: salt}(mechMarketplace, serviceRegistry, serviceId, price));
+
require(mech != address(0), "Contract creation failed");
uint256 nonce = nonces[msg.sender]++;
bytes32 salt = keccak256(abi.encode(nonce, block.timestamp, msg.sender, serviceId));

same for contracts\integrations\nevermined\MechFactorySubscription.sol
```
[]

### Notices
#### Low? Notices? No issue? initialize and constructor on MechMarketplace + frontrunning (?!) To discussion
```
This is not usually found in a same contract.
/// @dev MechMarketplace constructor.
/// @param _serviceRegistry Service registry contract address.
/// @param _stakingFactory Staking factory contract address.
/// @param _karma Karma proxy contract address.
/// @param _wrappedNativeToken Wrapped native token address.
/// @param _buyBackBurner Buy back burner address.
constructor(
address _serviceRegistry,
address _stakingFactory,
address _karma,
address _wrappedNativeToken,
address _buyBackBurner
) {
function initialize(uint256 _fee, uint256 _minResponseTimeout, uint256 _maxResponseTimeout) external {
Frontrunning is possible : between constructor() -> initialize() : No issue!
Changing the storage of implementation has no effect on changing the storage of proxy!
```
[]

#### Low? Notices? No issue? frontrunning initialize() in Karma.sol. To discussion
```
deploy -> Karma -> frontrumming initialize() -> deploy KarmaProxy() -> initialize() (no issue, becuse used proxy context) -> Karma

To do this, a "dummy" can be installed in its constructor so that calls to the initialize() function (or similar function) are only possible through a proxy.
Example:
constructor() {
// dummy in context of implementation
admin = address(1);
}

function initialize(address _admin) external {
// in context of proxy
require(admin == address(0), "Already initialized");
admin = _admin;
}
Changing the storage of implementation has no effect on changing the storage of proxy!
```
[]

### Notices. Variable "price". Problem of terminology
```
Problem of terminology. Price is usually expressed as amount0/amount1
if (amount < price) {}
```
[]

### Notices. for design createMech()
```
Can be called by anyone, a small limitation is that it is called from the marketPlace?
function createMech()
-> callback IMechMarketplace(mechMarketplace).mapMechFactories[mechFactory] == address(this)
```
[]

### Notices. Pure? _calculatePayment()
```
function _calculatePayment(
address mech,
uint256 payment
) internal virtual returns (uint256 mechPayment, uint256 marketplaceFee)
-> pure?
```
[]

### Notices. Low/Notices
```
uint256 private constant FEE_BASIS_POINTS = 10_000; // 100% в bps
```
[]


161 changes: 161 additions & 0 deletions audit/internal2/analysis/contracts/Karma-flatten.sol
Original file line number Diff line number Diff line change
@@ -0,0 +1,161 @@
// Sources flattened with hardhat v2.22.13 https://hardhat.org

// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;

/// @dev Only `owner` has a privilege, but the `sender` was provided.
/// @param sender Sender address.
/// @param owner Required sender address as an owner.
error OwnerOnly(address sender, address owner);

/// @dev Provided zero address.
error ZeroAddress();

/// @dev The contract is already initialized.
error AlreadyInitialized();

/// @dev Account is unauthorized.
/// @param account Account address.
error UnauthorizedAccount(address account);

/// @dev Wrong length of two arrays.
/// @param numValues1 Number of values in a first array.
/// @param numValues2 Number of values in a second array.
error WrongArrayLength(uint256 numValues1, uint256 numValues2);

/// @title Karma - Karma contract for agent mechs
contract Karma {
event ImplementationUpdated(address indexed implementation);
event OwnerUpdated(address indexed owner);
event SetMechMarketplaceStatuses(address[] mechMarketplaces, bool[] statuses);
event MechKarmaChanged(address indexed mech, int256 karmaChange);
event RequesterMechKarmaChanged(address indexed requester, address indexed mech, int256 karmaChange);

// Version number
string public constant VERSION = "1.0.0";
// Code position in storage is keccak256("KARMA_PROXY") = "0x1e4b6d67098d4183ce03b91c95f9376a98c5440ec22f2cf171d6dca04a5a29d8"
bytes32 public constant KARMA_PROXY = 0x1e4b6d67098d4183ce03b91c95f9376a98c5440ec22f2cf171d6dca04a5a29d8;

// Contract owner
address public owner;

// Mapping of whitelisted marketplaces
mapping(address => bool) public mapMechMarketplaces;
// Mapping of mech address => karma
mapping(address => int256) public mapMechKarma;
// Mapping of requester address => mech address => karma
mapping(address => mapping(address => int256)) public mapRequesterMechKarma;

/// @dev Karma initializer.
function initialize() external{
if (owner != address(0)) {
revert AlreadyInitialized();
}

owner = msg.sender;
}

/// @dev Changes the karma implementation contract address.
/// @param newImplementation New implementation contract address.
function changeImplementation(address newImplementation) external {
// Check for the ownership
if (msg.sender != owner) {
revert OwnerOnly(msg.sender, owner);
}

// Check for zero address
if (newImplementation == address(0)) {
revert ZeroAddress();
}

// Store the karma implementation address
// solhint-disable-next-line avoid-low-level-calls
assembly {
sstore(KARMA_PROXY, newImplementation)
}

emit ImplementationUpdated(newImplementation);
}

/// @dev Changes contract owner address.
/// @param newOwner Address of a new owner.
function changeOwner(address newOwner) external virtual {
// Check for the ownership
if (msg.sender != owner) {
revert OwnerOnly(msg.sender, owner);
}

// Check for the zero address
if (newOwner == address(0)) {
revert ZeroAddress();
}

owner = newOwner;
emit OwnerUpdated(newOwner);
}

/// @dev Sets mech marketplace statues.
/// @param mechMarketplaces Mech marketplace contract addresses.
/// @param statuses Corresponding whitelisting statues.
function setMechMarketplaceStatuses(address[] memory mechMarketplaces, bool[] memory statuses) external {
// Check for the ownership
if (msg.sender != owner) {
revert OwnerOnly(msg.sender, owner);
}

if (mechMarketplaces.length != statuses.length) {
revert WrongArrayLength(mechMarketplaces.length, statuses.length);
}

// Traverse all the mech marketplaces and statuses
for (uint256 i = 0; i < mechMarketplaces.length; ++i) {
if (mechMarketplaces[i] == address(0)) {
revert ZeroAddress();
}

mapMechMarketplaces[mechMarketplaces[i]] = statuses[i];
}

emit SetMechMarketplaceStatuses(mechMarketplaces, statuses);
}

/// @dev Changes agent mech karma.
/// @param mech Agent mech address.
/// @param karmaChange Karma change value.
function changeMechKarma(address mech, int256 karmaChange) external {
// Check for marketplace access
if (!mapMechMarketplaces[msg.sender]) {
revert UnauthorizedAccount(msg.sender);
}

// Change mech karma
mapMechKarma[mech] += karmaChange;

emit MechKarmaChanged(mech, karmaChange);
}

/// @dev Changes requester -> agent mech karma.
/// @param requester Requester address.
/// @param mech Agent mech address.
/// @param karmaChange Karma change value.
function changeRequesterMechKarma(address requester, address mech, int256 karmaChange) external {
// Check for marketplace access
if (!mapMechMarketplaces[msg.sender]) {
revert UnauthorizedAccount(msg.sender);
}

// Change requester mech karma
mapRequesterMechKarma[requester][mech] += karmaChange;

emit RequesterMechKarmaChanged(requester, mech, karmaChange);
}

/// @dev Gets the implementation address.
/// @return implementation Implementation address.
function getImplementation() external view returns (address implementation) {
// solhint-disable-next-line avoid-low-level-calls
assembly {
implementation := sload(KARMA_PROXY)
}
}
}
Loading
Loading