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

Batch registry call #1295

Merged
merged 5 commits into from
Mar 19, 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
31 changes: 26 additions & 5 deletions source/batch-call/contracts/BatchCall.sol
Original file line number Diff line number Diff line change
@@ -1,17 +1,16 @@
// SPDX-License-Identifier: MIT
pragma solidity 0.8.23;

import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import { ERC20 } from "solady/src/tokens/ERC20.sol";
import "@openzeppelin/contracts/utils/Address.sol";
import "@airswap/swap/contracts/interfaces/ISwap.sol";
import "@airswap/swap-erc20/contracts/interfaces/ISwapERC20.sol";
import "@airswap/registry/contracts/interfaces/IRegistry.sol";

/**
* @title BatchCall: Batch balance, allowance, order validity checks, nonce usage check
*/
contract BatchCall {
using SafeERC20 for IERC20;
using Address for address;

error ArgumentInvalid();
Expand All @@ -28,7 +27,7 @@ contract BatchCall {
address tokenAddress
) public view returns (uint256) {
if (tokenAddress.isContract()) {
IERC20 token = IERC20(tokenAddress);
ERC20 token = ERC20(tokenAddress);
// Check if balanceOf succeeds.
(bool success, ) = address(token).staticcall(
abi.encodeWithSelector(token.balanceOf.selector, userAddress)
Expand Down Expand Up @@ -119,7 +118,7 @@ contract BatchCall {
address tokenAddress
) public view returns (uint256) {
if (tokenAddress.isContract()) {
IERC20 token = IERC20(tokenAddress);
ERC20 token = ERC20(tokenAddress);
// Check if allowance succeeds as a call else returns 0.
(bool success, ) = address(token).staticcall(
abi.encodeWithSelector(
Expand Down Expand Up @@ -290,4 +289,26 @@ contract BatchCall {
}
return nonceUsed;
}

/**
* @notice provides the tokens supported by multiple Stakers
* @param stakers address[] list of stakers to be checked
* @param registryContract IRegistry Registry contract to call
* @return bool[] true indicates the nonce is used
*/
function getTokensForStakers(
address[] calldata stakers,
IRegistry registryContract
) external view returns (address[][] memory) {
if (stakers.length == 0) revert ArgumentInvalid();
address[][] memory tokensSupported = new address[][](stakers.length);

for (uint256 i; i < stakers.length; ) {
tokensSupported[i] = registryContract.getTokensForStaker(stakers[i]);
unchecked {
++i;
}
}
return tokensSupported;
}
}
95 changes: 93 additions & 2 deletions source/batch-call/test/BatchCall.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ const { ethers, waffle } = require('hardhat')
const { deployMockContract } = waffle
const IERC20 = require('@openzeppelin/contracts/build/contracts/IERC20.json')
const IERC721 = require('@openzeppelin/contracts/build/contracts/ERC721Royalty.json')
const REGISTRY = require('@airswap/registry/build/contracts/Registry.sol/Registry.json')
const SWAP = require('@airswap/swap/build/contracts/Swap.sol/Swap.json')
const SWAP_ERC20 = require('@airswap/swap-erc20/build/contracts/SwapERC20.sol/SwapERC20.json')
const ERC20_ADAPTER = require('@airswap/swap/build/contracts/adapters/ERC20Adapter.sol/ERC20Adapter.json')
Expand All @@ -22,6 +23,8 @@ const DEFAULT_AMOUNT = '1000'
const DEFAULT_BALANCE = '100000'
const BONUS_SCALE = '10'
const BONUS_MAX = '100'
const STAKING_COST = '1000000000'
const SUPPORT_COST = '1000000'

let snapshotId
let deployer
Expand All @@ -31,6 +34,7 @@ let erc20token
let erc20adapter
let erc721token
let erc721adapter
let registry
let swap
let swapERC20
let batchCall
Expand Down Expand Up @@ -107,6 +111,15 @@ async function setUpAllowances(senderAmount, signerAmount) {
async function setUpBalances(senderAmount, signerAmount) {
await erc20token.mock.balanceOf.withArgs(sender.address).returns(senderAmount)
await erc20token.mock.balanceOf.withArgs(signer.address).returns(signerAmount)
await erc20token.mock.balanceOf
.withArgs(staker1.address)
.returns(STAKING_COST)
await erc20token.mock.balanceOf
.withArgs(staker2.address)
.returns(STAKING_COST)
await erc20token.mock.balanceOf
.withArgs(staker3.address)
.returns(STAKING_COST)
}

describe('BatchCall Integration', () => {
Expand All @@ -119,8 +132,17 @@ describe('BatchCall Integration', () => {
})

before('deploy adapter and swap', async () => {
;[deployer, sender, signer, affiliate, protocolFeeWallet, anyone] =
await ethers.getSigners()
;[
deployer,
sender,
signer,
affiliate,
protocolFeeWallet,
anyone,
staker1,
staker2,
staker3,
] = await ethers.getSigners()
erc20token = await deployMockContract(deployer, IERC20.abi)
await erc20token.mock.allowance.returns(DEFAULT_AMOUNT)
await erc20token.mock.balanceOf.returns(DEFAULT_AMOUNT)
Expand All @@ -143,6 +165,12 @@ describe('BatchCall Integration', () => {
)
).deploy()
await erc721adapter.deployed()

registry = await (
await ethers.getContractFactory(REGISTRY.abi, REGISTRY.bytecode)
).deploy(erc20token.address, STAKING_COST, SUPPORT_COST)
await registry.deployed()

swap = await (
await ethers.getContractFactory(SWAP.abi, SWAP.bytecode)
).deploy(
Expand Down Expand Up @@ -329,4 +357,67 @@ describe('BatchCall Integration', () => {
)
})
})

describe('returns tokensSupported for mutiple stakers', () => {
it('returns all tokens supported by multiple stakers', async () => {
const tokensSupported = []
for (let i = 0; i < 10; i++) {
tokensSupported[i] = await deployMockContract(deployer, IERC20.abi)
}
registry
.connect(staker1)
.addTokens([
tokensSupported[0].address,
tokensSupported[1].address,
tokensSupported[2].address,
])
registry
.connect(staker2)
.addTokens([
tokensSupported[3].address,
tokensSupported[4].address,
tokensSupported[5].address,
])
registry
.connect(staker3)
.addTokens([
tokensSupported[6].address,
tokensSupported[7].address,
tokensSupported[8].address,
tokensSupported[9].address,
])
const expectedTokensSupported = await batchCall
.connect(deployer)
.getTokensForStakers(
[staker1.address, staker2.address, staker3.address],
registry.address
)
expect(expectedTokensSupported.toString()).to.equal(
[
[
tokensSupported[0].address,
tokensSupported[1].address,
tokensSupported[2].address,
],
[
tokensSupported[3].address,
tokensSupported[4].address,
tokensSupported[5].address,
],
[
tokensSupported[6].address,
tokensSupported[7].address,
tokensSupported[8].address,
tokensSupported[9].address,
],
].toString()
)
})

it('reverts if a wrong argument is passed', async () => {
await expect(
batchCall.getTokensForStakers([], registry.address)
).to.be.revertedWith('ArgumentInvalid')
})
})
})
23 changes: 2 additions & 21 deletions source/registry/contracts/Registry.sol
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,13 @@ pragma solidity 0.8.23;
import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import "@openzeppelin/contracts/utils/structs/EnumerableSet.sol";
import "./interfaces/IRegistry.sol";

/**
* @title AirSwap: Server Registry
* @notice https://www.airswap.io/
*/
contract Registry {
contract Registry is IRegistry {
using SafeERC20 for IERC20;
using EnumerableSet for EnumerableSet.AddressSet;
using EnumerableSet for EnumerableSet.Bytes32Set;
Expand All @@ -25,26 +26,6 @@ contract Registry {
mapping(address => EnumerableSet.AddressSet) internal tokensByStaker;
mapping(address => EnumerableSet.AddressSet) internal stakersByToken;

event SetServerURL(address indexed staker, string url);
event AddProtocols(address indexed staker, bytes4[] protocols);
event AddTokens(address indexed staker, address[] tokens);
event RemoveProtocols(address indexed staker, bytes4[] protocols);
event RemoveTokens(address indexed staker, address[] tokens);
event UnsetServer(
address indexed staker,
string url,
bytes4[] protocols,
address[] tokens
);

error ArgumentInvalid();
error NoServerURLSet();
error ProtocolDoesNotExist(bytes4);
error ProtocolExists(bytes4);
error TokenDoesNotExist(address);
error TokenExists(address);
error ServerURLInvalid();

/**
* @notice Registry constructor
* @param _stakingToken IERC20 address of token used for staking
Expand Down
77 changes: 77 additions & 0 deletions source/registry/contracts/interfaces/IRegistry.sol
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
// SPDX-License-Identifier: MIT

pragma solidity ^0.8.23;

interface IRegistry {
event SetServerURL(address indexed staker, string url);
event AddProtocols(address indexed staker, bytes4[] protocols);
event AddTokens(address indexed staker, address[] tokens);
event RemoveProtocols(address indexed staker, bytes4[] protocols);
event RemoveTokens(address indexed staker, address[] tokens);
event UnsetServer(
address indexed staker,
string url,
bytes4[] protocols,
address[] tokens
);

error ArgumentInvalid();
error NoServerURLSet();
error ProtocolDoesNotExist(bytes4);
error ProtocolExists(bytes4);
error TokenDoesNotExist(address);
error TokenExists(address);
error ServerURLInvalid();

function setServerURL(string calldata _url) external;

function unsetServer() external;

function addProtocols(bytes4[] calldata _protocols) external;

function removeProtocols(bytes4[] calldata _protocols) external;

function getServerURLsForProtocol(
bytes4 _protocol
) external view returns (string[] memory _urls);

function supportsProtocol(
address _staker,
bytes4 _protocol
) external view returns (bool);

function getProtocolsForStaker(
address _staker
) external view returns (bytes4[] memory _protocolList);

function getStakersForProtocol(
bytes4 _protocol
) external view returns (address[] memory _stakers);

function addTokens(address[] calldata _tokens) external;

function removeTokens(address[] calldata _tokens) external;

function getServerURLsForToken(
address _token
) external view returns (string[] memory urls);

function supportsToken(
address _staker,
address _token
) external view returns (bool);

function getTokensForStaker(
address _staker
) external view returns (address[] memory tokenList);

function getStakersForToken(
address _token
) external view returns (address[] memory _stakers);

function getServerURLsForStakers(
address[] calldata _stakers
) external view returns (string[] memory _urls);

function balanceOf(address _staker) external view returns (uint256);
}
Loading