Code Monkey home page Code Monkey logo

aura-contracts's Introduction

Aura Finance

Test Coverage

Security

Smart contract security is a top priority for Aura, see Security documentation . Aura has partnered up with @chainalysis to adopt an Incident Response Plan for the protocol to add an extra layer of security, Aura will be able to deter hackers and have an asset recovery plan in potential events.

If you have any feedback or concerns, reach out to [email protected]

Dev

Pre Requisites

Submodule

$ git submodule init
$ git submodule update

Install

$ yarn install

Compile

Compile the smart contracts with Hardhat:

$ yarn compile

TypeChain

Compile the smart contracts and generate TypeChain artifacts:

$ yarn typechain

Lint Solidity

Lint the Solidity code:

$ yarn lint:sol

Lint TypeScript

Lint the TypeScript code:

$ yarn lint:ts

Test

Run the Mocha tests:

$ yarn test

Run fork tests

$ yarn test:fork:all

Tasks

Running in fork mode

$ NODE_URL=<FORK_URL> yarn task:fork <TASK_NAME>

Running task normally

$ NODE_URL=<NODE_URL> yarn task --network <NETWORK> <TASK_NAME>

Coverage

Generate the code coverage report:

$ yarn coverage

Clean

Delete the smart contract artifacts, the coverage reports and the Hardhat cache:

$ yarn clean

Local Fork

This runs a local node on your system, that can be used with Metamask, etc.

Run a local fork:

npx hardhat node --fork https://eth-mainnet.alchemyapi.io/v2/<API_KEY> --port <PORT>

Once you stake or lock CVX you may want to progress timestamps to check rewards stuff

export NODE_URL=<LOCAL_NODE_URL>
yarn task timeTravel --duration 69420 --network forking

Diagrams

Booster Reward Flow

Cvx Reward Flow

Deployments

Notes

Warnings

  • auraBAL and vlAURA reward contracts are not on the 4626 standard

  • StashToken contracts are not ERC20 compliant. convex-platform/contracts/contracts/StashToken.sol it is designed to interact only with VirtualBalanceRewardPool and ExtraRewardStashV3. Any extraRewards is distributed by a VirtualBalanceRewardPool, which is linked to a StashToken, the StashToken wraps the extraReward as a baseToken.

aura-contracts's People

Contributors

phijfry avatar 0xahtle7 avatar 0xmaharishi avatar hephyrius avatar 0xconwayglider avatar 0xbutterfield avatar 0xeye avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.