Skip to content

Nachoxt17/CurveFi-Operator

Repository files navigation

De.Fi.-WhiteLabel-Smart-Contracts

Curve-Finance-Intermediary-Operator

These Smart Contracts serve as a template or easier gateway for Developers to Integrate their new De.Fi. projects with Curve Finance Pools, without having to spend hours at a time reading their Documentations. The hard work has been done by me already and you can simply fork this to implement interactions with Curve Finance Pools.

Quick Project start:

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

npm install

Setup

2️⃣ Copy and Paste the File ".env.example" inside the same Root Folder(You will Duplicate It) and then rename it removing the part of ".example" so that it looks like ".env" and then fill all the Data Needed Inside the File. In the part of "ALCHEMY_API_KEY" just write the KEY, not the whole URL.

cp .env.example .env && nano .env

3️⃣ Open a Terminal and let's Test your Project in a Hardhat Local Node. You can also Clone the Ethereum Main Network in your Local Hardhat Node: https://hardhat.org/guides/mainnet-forking.html

npx hardhat node

4️⃣ Now Open a 2nd Terminal and Deploy your Project in the Hardhat Local Node. You can also Test it in the same Terminal:

npx hardhat test

Solidity Smart Contracts Auditing Tools(Always use Linux Ubuntu/WSL 2.0 If Possible):

  • NOTE: Always run all the Tools Directly in the Directory where the S.C. .sol Files are Located.

🛠️ For a Quick and Simple Audit of the Solidity Smart Contracts, you can Install and Use Slither-Analyzer: Slither-Analyzer Functioning Troubleshooting

  • Installation:
  • First Install the Solidity Versions Selector:
pip3 install solc-select
solc-select versions
solc-select install
  • Install Slither For Windows WSL Linux Ubuntu Console:
pip3 install -U https://github.com/crytic/crytic-compile/archive/refs/heads/dev-windows-long-paths.zip
crytic-compile --v
pip3 install -U https://github.com/elopez/slither/archive/refs/heads/windows-ci.zip
slither --v

Or in any other case:

pip3 install crytic-compile==0.2.2
crytic-compile --v
pip3 install slither-analyzer==0.8.2
slither --v

Usage:

  • Analyze all the S.C.s inside a Directory:
slither .
  • Analyze all the S.C.s inside a Directory Ignoring all prior Warnings:
slither . --triage
  • See all the prior Warnings Again:
rm slither.db.json

🛠️ For a More Detailed Audit of the Solidity Smart Contracts, you can Install and Use Mythril Analyzer:

  • Installation:
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
rustup default nightly
pip3 install mythril
myth version

Usage:

Run:

myth analyze <solidity-file>

Or:

myth analyze -a <contract-address>

🛠️Auditing Approach:

  • Read about the project in its Documentation and Talk to its Developers if Possible to get an idea of what the Smart Contracts are meant to do.
  • Look over the Smart Contracts to get an idea of the Smart Contracts Architecture.
  • Create a threat model and make a list of theoretical attack vectors including all common pitfalls and past exploit techniques. Tools like Slither and Mythrill can help with this.
  • Look at places that can do value exchange. Especially functions like transfer, transferFrom, send, call, delegatecall, and selfdestruct. Walk backward from them to ensure they are secured properly.
  • Do a line-by-line review of the contracts.
  • Do another review from the perspective of every actor in your threat model.
  • Glance over the test cases and code coverage.

Deploying the Project to the Ropsten TestNet:

5️⃣ Deploy the Smart Contract to the Ropsten Ethereum Test Network(https://hardhat.org/tutorial/deploying-to-a-live-network.html):

npx hardhat run scripts/deploy.js --network Ropsten

Deploying the Project to the Ethereum MainNet:

6️⃣ Deploy the Smart Contract to the Ethereum Main Network(https://hardhat.org/tutorial/deploying-to-a-live-network.html):

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

7️⃣ Etherscan verification

To verify contract code on Etherscan run:

docker-compose exec blockchain npx hardhat verify --network <network> <address> "args..."

Example usage: docker-compose exec blockchain npx hardhat verify --network rinkeby 0xd94F3C21Ad78A403C964118646b849e768d69Dec

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.

About

Curve Finance Pool intermediary Operator solidity smart contracts.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published