The Catalist on Ace Liquid Staking Protocol allows their users to earn staking rewards on the Beacon chain without locking ace or maintaining staking infrastructure.

Users can deposit ace to the Catalist smart contract and receive bACE tokens in return. The smart contract then stakes tokens with node operators.

Unlike staked ace, the bACE token is free from the limitations associated with a lack of liquidity, and can be transferred at any time. The bACE token balance corresponds to the amount of ace that the holder could request to withdraw.

NB: It's advised to read Documentation before getting started with this repo.

Contracts

For the contracts description see https://docs.catalist.app/ contracts section.

Deployments

For the protocol contracts addresses see https://docs.catalist.app/contracts/

Development

Requirements

• shell - bash or zsh
• find
• sed
• jq
• curl
• cut
• node.js v18
• (optional) Lerna
• (optional) Foundry

Installing Aragon & other deps

Installation is local and doesn't require root privileges.

If you have yarn installed globally:

yarn

otherwise:

npx yarn

Build & test

Run unit tests:

yarn test

Run unit tests and report gas used by each Solidity function:

yarn test:gas

Generate unit test coverage report:

yarn test:coverage

Test coverage is reported to coverage.json and coverage/index.html files located inside each app's folder.

Keep in mind that the code uses asserts to check invariants that should always be kept unless the code is buggy (in contrast to require statements which check pre-conditions), so full branch coverage will never be reported until [solidity-coverage#219] is implemented.

Run fuzzing tests with foundry:

curl -L https://foundry.paradigm.xyz | bash
foundryup
forge test

Deploying

To deploy the smart contracts and run the protocol instance either locally or on a new testnet, please proceed to the following scratch deploy documentation

License

2023 Catalist [email protected]

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 3 of the License, or any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.