Git Product home page Git Product logo

fuji-protocol's Introduction

🗻Fuji Finance

Borrowing Aggregator

Fuji is a protocol that aims to optimize loan expenses for DeFi users. It achieves this by monitoring the borrowing markets and whenever there is a better rate, it refinances the debt its users. More details could be found here.


Quickstart

1. Setup

Create a file .env and set at least one of the following:

ALCHEMY_ID=<your-key>
INFURA_ID=<your-key>

2. Install dependancies and run a mainnet fork

yarn install
yarn fork

3. Deploy contracts

# core markets
npx hardhat run scripts/mainnet/00_initial_deploy.js
# fuse markets
npx hardhat run scripts/mainnet/01_deploy_fuse.js
# fantom markets
npx hardhat run scripts/fantom/00_initial_deploy.js

4. Tests

npx hardhat test --network localhost test/<file-with-tests>.js 

5. Requirements

  • node: 14.17.1
  • yarn: 1.22.10

Coding Style and Conventions

We use solhint as a linter and prettier as a code formatter.

A non-exhausitve list with some synthax rules:

  • Contract names must be CamelCase, so the file containg it.
  • Public and external functions name must be in camelCase.
  • Private and internal functions name must be in _camelCase.
  • Getter functions must be in getCamelCase.
  • Setter functions must be in setCamelCase.
  • Function parameters must be in _camelCase.
  • Event names must be in CamelCase.
  • Modifier name must be in mixedCase.
  • Private and internal variables must be in _camelCase.
  • Public variables must be in camelCase.

fuji-protocol's People

Contributors

0xdcota avatar brozorec avatar soloph1 avatar dolig avatar edgarillo avatar tiagofneto avatar austintgriffith avatar azf20 avatar ironsoul0 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.