Skip to content

Latest commit

 

History

History
169 lines (123 loc) · 7.32 KB

README.md

File metadata and controls

169 lines (123 loc) · 7.32 KB
Raw

SSV Contracts Project

This repository contains a sample project that you can use as the starting point for Ethereum project. It's also a great fit for learning the basics of smart contract development.

This project is intended to be used with the Hardhat Beginners Tutorial, but you should be able to follow it by yourself by reading the README and exploring its contracts, test, scripts directories.

Decision to use Hardhat was based on research best practices to develop smart contracts. One of the topic about it is here.

Quick start

The first things you need to do are cloning this repository and installing its dependencies:

git clone [email protected]:bloxapp/ssv-contracts.git
cd ssv-contracts
npm install

Run locally HardHat TestNetwork node

Once installed, to run Hardhat's testing network:

npx hardhat node

For more details about it and how to use MainNet forking you can find here.

Compile contracts

Contracts are at contracts/ folder, To compile them, simply run:

npx hardhat compile

CI/CD Workflow

Step 1: Test contracts

Take a look at test/ folder, you should be able to find tests related to specific actions. It comes with tests that use Waffle and Ethers.js. To run tests, run:

npx hardhat test

Step 2: Deploy new contracts

We use Proxy Upgrade pattern for smart contracts to have an ability to upgrade them later. To deploy the contract we will use a Hardhat script. Inside scripts/ you will find deploy.ts file. Run this to deploy the contract:

npx hardhat run scripts/deploy.ts --network localhost

As general rule, you can target any network configured in the hardhat.config.ts

npx hardhat run --network <your-network> scripts/deploy.ts

Output of this action will be smart contract proxy address.

Step 3: Verify implementation contract on etherscan (each time after upgrade)

Open .openzeppelin/<network>.json file and find [impls.<hash>.address] value which is implementation smart contract address. We use Proxy Upgrade pattern for smart contracts to have an ability to upgrade them later. To deploy the contract we will use a Hardhat script. Inside scripts/ you will find deploy.ts file. Run this:

npx hardhat  verify --network <network> <implementation-address>

Step 4: Link proxy contract with implementation on etherscan (each time after upgrade)

Go to https://<network>.etherscan.io/address/<proxy-address> and click on Contract tab. On a right side click More Options dropbox and select Is this a proxy?. On a verification page enter proxy address inside field and click Verify button. As result you will see the message:

The proxy contract verification completed with the message:
The proxy\'s (<proxy-address) implementation contract is found at: <implementation-address>

To be sure that values are correct and click Save button. As result on etherscan proxy address page in Contract tab you will find two new buttons: Write as Proxy and Read as Proxy which will represent implementation smart contract functions interface and the actual state.

Step 5: Upgrade contract

Once we have tested our new implementation, for example contracts/DEX.sol we can prepare the upgrade. This will validate and deploy our new implementation contract. Note: For testnet and mainnet we will use Openzeppelin Defender to manage our upgrades and Gnosis Safe for mainnet safe signiture process.

To upgrade in local HardHat Testing Network:

PROXY_ADDRESS=0x... npx hardhat run --network localhost scripts/prepare-upgrade.ts

For mainnet and testnet:

1. Prepare for upgrade:

PROXY_ADDRESS=<proxy-address> npx hardhat run --network localhost scripts/upgrade.ts

2. Complete upgrade in testnet:

Go to OpenZeppelin Defender Admin, select proxy address, which you added before, point new implementation address and abi json object which you can find in artifacts/contracts/<contract-name>.json. Sigh by your wallet which was used in deployment fist contract release.

More details in documentation.

3. Complete upgrade in mainnet:

For mainnet to manage our upgrade in Gnosis Safe we use the OpenZeppelin app. In the Apps tab, select the OpenZeppelin application and paste the address of the proxy in the Contract address field, and paste the address of the new implementation in the New implementation address field. The app should show that the contract is EIP1967-compatible.

Double check the addresses, and then press the Upgrade button. We will be shown a confirmation dialog to Submit the transaction.

We then need to sign the transaction in MetaMask (or the wallet that you are using).

Extra tips

Create a new contract version

Note: We cannot change the storage layout of our implementation contract, see Upgrading for more details on the technical limitations.

Transfer control of upgrades

The admin (who can perform upgrades) for our proxy is a ProxyAdmin contract. Only the owner of the ProxyAdmin can upgrade our proxy. Warning: Ensure to only transfer ownership of the ProxyAdmin to an address we control.

As example, we will use Gnosis Safe to control upgrades of our contracts.

To transfer ownership run:

GNOSIS_SAFE_ADDRESS=0x..... npx hardhat run scripts/transfer-ownership.ts --network <your-network/localhost>

dApp UI to interact with smart contract

https://eth95.dev/?network=1&address=0x9fE46736679d2D9a65F0992F2272dE9f3c7fa6e0

UI dApp direct link

User Guide

You can find detailed instructions on using this repository and many tips in its documentation. For a complete introduction to Hardhat, refer to this guide.

What’s Included?

Your environment will have everything you need to build a Dapp powered by Hardhat and React.

  • Hardhat: An Ethereum development task runner and testing network.
  • Mocha: A JavaScript test runner.
  • Chai: A JavaScript assertion library.
  • ethers.js: A JavaScript library for interacting with Ethereum.
  • Waffle: To have Ethereum-specific Chai assertions/mathers.

Security Audit

Full audit report CoinFabrik Report

Troubleshooting

  • Invalid nonce errors: if you are seeing this error on the npx hardhat node console, try resetting your Metamask account. This will reset the account's transaction history and also the nonce. Open Metamask, click on your account followed by Settings > Advanced > Reset Account.

Happy buidling!