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

Sepolia deposit adapter implementation #821

Merged
merged 41 commits into from
Feb 21, 2024
Merged
Show file tree
Hide file tree
Changes from 21 commits
Commits
Show all changes
41 commits
Select commit Hold shift + click to select a range
e21b86a
Sepolia deposit contract (interface for tests)
vp4242 Feb 7, 2024
876a3b0
Add basic test for Sepolia deposit
vp4242 Feb 7, 2024
7e1d8e2
Put simple deployment test
vp4242 Feb 7, 2024
bf3540a
Basic deposit adapter implementation
vp4242 Feb 7, 2024
3e89caf
Some experiments over adapter tests
vp4242 Feb 8, 2024
d5474b3
Simplify adapter
vp4242 Feb 8, 2024
6bb847f
Split tests, fix style
vp4242 Feb 8, 2024
3eeafd1
Improve contract readability
vp4242 Feb 8, 2024
52df1f9
Remove Sepolia deposit contract code, change all interaction to inter…
vp4242 Feb 12, 2024
287e868
Fix warnings
vp4242 Feb 12, 2024
04d6b7f
Add immutable
vp4242 Feb 13, 2024
cabc5cd
Add Ownable mix to Deposit
vp4242 Feb 13, 2024
2b905b2
Implement drain Bepolia logic and send back ether to contract owner
vp4242 Feb 13, 2024
53861a2
Remove general drain func as it now send eth to owner automatically
vp4242 Feb 13, 2024
da8ea29
Improve adapter logic
vp4242 Feb 14, 2024
c60e04a
Improve tests
vp4242 Feb 14, 2024
90f4b03
Add owner logging
vp4242 Feb 14, 2024
f13cb41
Add auto drain to deposit() and tests around
vp4242 Feb 14, 2024
3ff2df1
Fix contract warning
vp4242 Feb 14, 2024
f122422
Fix deployment test
vp4242 Feb 14, 2024
3180ee5
Remove cruft
vp4242 Feb 14, 2024
b5193c1
More readable name
vp4242 Feb 15, 2024
d14eb54
Fix naming
vp4242 Feb 15, 2024
97db353
Fix test
vp4242 Feb 15, 2024
b752379
Skip test for local node testing
vp4242 Feb 15, 2024
80d018d
Provide address for drain
vp4242 Feb 15, 2024
04d4267
Comment on how run Sepolia-specific tests
vp4242 Feb 15, 2024
fb73385
Add chain id
vp4242 Feb 15, 2024
a5793ec
Fix contract
vp4242 Feb 15, 2024
15320be
Combine tests and fix them after renamings
vp4242 Feb 15, 2024
b334ea4
Update contracts/0.8.9/SepoliaDepositAdapter.sol
vp4242 Feb 20, 2024
401b886
Update contracts/0.8.9/SepoliaDepositAdapter.sol
vp4242 Feb 20, 2024
312d708
Update test/0.8.9/sepolia-deposit-adapter.test.js
vp4242 Feb 20, 2024
e82e9b3
Extract interfaces and improve adapter contract
vp4242 Feb 20, 2024
c916979
Fix tests for contract changes
vp4242 Feb 20, 2024
e3a089e
Suppress warnings
vp4242 Feb 20, 2024
c9d0887
Details on while Adapter is required
vp4242 Feb 20, 2024
a3e2982
Add DepositEvent and checks for it
vp4242 Feb 20, 2024
a802e43
Fix comment
vp4242 Feb 20, 2024
7536ba8
fix: update storage layout action
TheDZhon Feb 20, 2024
2480651
Emit event on Bepolia recover
vp4242 Feb 21, 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
70 changes: 64 additions & 6 deletions contracts/0.8.9/SepoliaDepositAdapter.sol
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 +4,82 @@
/* See contracts/COMPILERS.md */
pragma solidity 0.8.9;

import "@openzeppelin/contracts-v4.4/token/ERC20/IERC20.sol";
import "@openzeppelin/contracts-v4.4/access/Ownable.sol";

contract SepoliaDepositAdapter {
import "hardhat/console.sol";

uint public constant TEST_VALUE = 16;
address public immutable depositContract;
// Sepolia deposit contract variant of the source code https://github.com/protolambda/testnet-dep-contract/blob/master/deposit_contract.sol
interface ISepoliaDepositContract is IERC20 {
TheDZhon marked this conversation as resolved.
Show resolved Hide resolved

function deposit(
bytes calldata pubkey,
bytes calldata withdrawal_credentials,
bytes calldata signature,
bytes32 deposit_data_root
) external payable {
}
) external payable;

function get_deposit_root() external view returns (bytes32);

function get_deposit_count() external view returns (bytes memory);

function name() external view returns (string memory);
}

contract SepoliaDepositAdapter is Ownable {
TheDZhon marked this conversation as resolved.
Show resolved Hide resolved

uint public constant VERSION = 2;
ISepoliaDepositContract public immutable originalContract;

constructor(address _deposit_contract) {
TheDZhon marked this conversation as resolved.
Show resolved Hide resolved
depositContract = _deposit_contract;
originalContract = ISepoliaDepositContract(_deposit_contract);
}

function get_deposit_root() external view returns (bytes32) {
return originalContract.get_deposit_root();
}

function get_deposit_count() external view returns (bytes memory) {
return originalContract.get_deposit_count();
}

function test() external view returns (string memory) {
vp4242 marked this conversation as resolved.
Show resolved Hide resolved
return originalContract.name();
}

receive() external payable {
console.log(
"Receive %s from %s",
msg.value,
msg.sender
);
}
TheDZhon marked this conversation as resolved.
Show resolved Hide resolved

function drain() external onlyOwner {
uint ownTokens = address(this).balance;
folkyatina marked this conversation as resolved.
Show resolved Hide resolved
address payable _owner = payable(owner());
_owner.transfer(ownTokens);
folkyatina marked this conversation as resolved.
Show resolved Hide resolved
}

function drainBepolia() external onlyOwner {
uint bepoliaOwnTokens = originalContract.balanceOf(address(this));
vp4242 marked this conversation as resolved.
Show resolved Hide resolved
bool success = originalContract.transfer(owner(), bepoliaOwnTokens);
TheDZhon marked this conversation as resolved.
Show resolved Hide resolved
require(success, "Transfer failed");
}

function deposit(
bytes calldata pubkey,
bytes calldata withdrawal_credentials,
bytes calldata signature,
bytes32 deposit_data_root
) external payable {
console.log(
"Deposit with %s ETH from %s",
msg.value,
msg.sender
);
originalContract.deposit{value: msg.value}(pubkey, withdrawal_credentials, signature, deposit_data_root);
address payable owner = payable(owner());
owner.transfer(msg.value);
}
}
29 changes: 29 additions & 0 deletions test/0.8.9/sepolia-deployment.test.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
const { artifacts, contract, ethers } = require('hardhat')
const { assert } = require('../helpers/assert')

const { EvmSnapshot } = require('../helpers/blockchain')

const SepoliaDepositAdapter = artifacts.require('SepoliaDepositAdapter')

contract('SepoliaDepositAdapter deployment', ([deployer]) => {
let depositAdapter
let snapshot

before('deploy lido with dao', async () => {
depositAdapter = await SepoliaDepositAdapter.new(deployer, { from: deployer })

snapshot = new EvmSnapshot(ethers.provider)
await snapshot.make()
})

afterEach(async () => {
await snapshot.rollback()
})

describe('SepoliaDepositAdapter Logic', () => {
it(`state after deployment`, async () => {
const depositAdapterVersion = await depositAdapter.VERSION()
assert.equals(depositAdapterVersion, 2)
})
})
})
138 changes: 138 additions & 0 deletions test/0.8.9/sepolia-deposit-adapter.test.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,138 @@
const { contract, ethers } = require('hardhat')
const { assert } = require('../helpers/assert')

const { EvmSnapshot } = require('../helpers/blockchain')

contract('SepoliaDepositAdapter impl', ([deployer]) => {
let depositAdapter
let snapshot
let bepoliaToken
// const sepoliaDepositAdapterContract = '0x899e45316FaA439200b36c7d7733192530e3DfC0'
const sepoliaDepositContract = '0x7f02C3E3c98b133055B8B348B2Ac625669Ed295D'
const EOAddress = '0x6885E36BFcb68CB383DfE90023a462C03BCB2AE5'
const bepoliaTokenHolder = EOAddress
// const log = console.log
const log = () => {}

before('deploy lido with dao', async () => {
// depositAdapter = await SepoliaDepositAdapter.at(sepoliaDepositAdapterContract)
depositAdapter = await ethers.deployContract('SepoliaDepositAdapter', [sepoliaDepositContract])
log('depositAdapter address', depositAdapter.address)

const depositAdapterVersion = await depositAdapter.VERSION()
assert.equals(depositAdapterVersion, 2)

bepoliaToken = await ethers.getContractAt('ISepoliaDepositContract', sepoliaDepositContract)

snapshot = new EvmSnapshot(ethers.provider)
await snapshot.make()
})

afterEach(async () => {
await snapshot.rollback()
})

describe('SepoliaDepositAdapter Logic', () => {
TheDZhon marked this conversation as resolved.
Show resolved Hide resolved
TheDZhon marked this conversation as resolved.
Show resolved Hide resolved
it(`transfer Bepolia tokens`, async () => {
folkyatina marked this conversation as resolved.
Show resolved Hide resolved
const adapterAddr = depositAdapter.address
const BEPOLIA_TO_TRANSFER = 2
const bepoliaHolderInitialBalance = await bepoliaToken.balanceOf(bepoliaTokenHolder)
const impersonatedSigner = await ethers.getImpersonatedSigner(bepoliaTokenHolder)

log('bepoliaHolderInitialBalance', bepoliaHolderInitialBalance)
await bepoliaToken.connect(impersonatedSigner).transfer(adapterAddr, BEPOLIA_TO_TRANSFER)

assert.equals(await bepoliaToken.balanceOf(adapterAddr), BEPOLIA_TO_TRANSFER)

const bepoliaHolderEndBalance = await bepoliaToken.balanceOf(bepoliaTokenHolder)
assert.equals(bepoliaHolderEndBalance, bepoliaHolderInitialBalance - BEPOLIA_TO_TRANSFER)
log('bepoliaHolderEndBalance', bepoliaHolderEndBalance)

// Drain Bepolia tokens
await depositAdapter.drainBepolia()

const bepoliaTokensOnAdapter = await bepoliaToken.balanceOf(adapterAddr)
assert.equals(bepoliaTokensOnAdapter, 0)

const [owner] = await ethers.getSigners()
const bepoliaTokenHolderEnd = await bepoliaToken.balanceOf(owner.address)
assert.equals(bepoliaTokenHolderEnd, BEPOLIA_TO_TRANSFER)
})

it(`call deposit on Adapter`, async () => {
const key = '0x90823dc2e5ab8a52a0b32883ea8451cbe4c921a42ce439f4fb306a90e9f267e463241da7274b6d44c2e4b95ddbcb0ad3'
const withdrawalCredentials = '0x005bfe00d82068a0c2a6687afaf969dad5a9c663cb492815a65d203885aaf993'
const sig =
'0x802899068eb4b37c95d46869947cac42b9c65b90fcb3fde3854c93ad5737800c01e9c82e174c8ed5cc18210bd60a94ea0082a850817b1dddd4096059b6846417b05094c59d3dd7f4028ed9dff395755f9905a88015b0ed200a7ec1ed60c24922'
const dataRoot = '0x8b09ed1d0fb3b8e3bb8398c6b77ee3d8e4f67c23cb70555167310ef02b06e5f5'

const adapterAddr = depositAdapter.address

const balance0ETH = await ethers.provider.getBalance(adapterAddr)
assert.equals(balance0ETH, 0)

const impersonatedSigner = await ethers.getImpersonatedSigner(bepoliaTokenHolder)
await depositAdapter.connect(impersonatedSigner)
// Transfer 1 Bepolia token to depositCaller
await bepoliaToken.connect(impersonatedSigner).transfer(adapterAddr, 1)

const [owner] = await ethers.getSigners()
log('owner', owner.address)

const bepoliaTokenHolderBalance = await bepoliaToken.balanceOf(bepoliaTokenHolder)
const adapterBepoliaBalance = await bepoliaToken.balanceOf(adapterAddr)
log('bepoliaTokenHolder and adapter balances: ', bepoliaTokenHolderBalance, adapterBepoliaBalance)
// We need to have exactly 1 Bepolia token in the adapter
assert.equals(adapterBepoliaBalance, 1)

const result = await depositAdapter.test()
assert.equals(result, 'Sepolia deposit contract token')

const depositRootBefore = await depositAdapter.get_deposit_root()
log('depositRoot', depositRootBefore)
const depositCountBefore = await depositAdapter.get_deposit_count()
log('depositCount', depositCountBefore)

await depositAdapter.deposit(key, withdrawalCredentials, sig, dataRoot, {
from: owner.address,
value: ethers.utils.parseEther('32.0'),
})
const depositRootAfter = await depositAdapter.get_deposit_root()
log('depositRoot After', depositRootAfter)
const depositCountAfter = await depositAdapter.get_deposit_count()
log('depositCount After', depositCountAfter)
assert.notEqual(depositRootBefore, depositRootAfter)
assert.equals(BigInt(depositCountBefore) + BigInt('0x0100000000000000'), BigInt(depositCountAfter))

const ethAfterDeposit = await ethers.provider.getBalance(adapterAddr)
log('ethAfterDeposit', ethAfterDeposit.toString())
assert.equals(ethAfterDeposit, 0)

const adapterBepoliaBalanceAfter = await bepoliaToken.balanceOf(adapterAddr)
assert.equals(adapterBepoliaBalanceAfter, 0)
})

it(`call drain on Adapter`, async () => {
const adapterAddr = depositAdapter.address

const balance0ETH = await ethers.provider.getBalance(adapterAddr)
assert.equals(balance0ETH, 0)

const [owner] = await ethers.getSigners()
log('owner', owner.address)
await owner.sendTransaction({
to: adapterAddr,
value: ethers.utils.parseEther('10.0'),
})

const ethAfterDeposit = await ethers.provider.getBalance(adapterAddr)
log('ethAfterDeposit', ethAfterDeposit.toString())
assert.equals(ethAfterDeposit, ethers.utils.parseEther('10.0'))

await depositAdapter.drain()
const balanceEthAfterDrain = await ethers.provider.getBalance(adapterAddr)
log('balanceEthAfterDrain', balanceEthAfterDrain.toString())
assert.equals(balanceEthAfterDrain, 0)
})
})
})
Loading