README.md

MeowFi (Meowtos)

Turn your NFTs into collateral and access cryptocurrency loans with ease. No need to sell—just lend your NFTs and get the liquidity you need in minutes.

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Architecture
3. Getting Started
   • Prerequisites
   • Installation
4. Roadmap
5. Contributing
6. Acknowledgments

About The Project

Welcome to MeowFi (a Meowtos product), the future of decentralized finance where NFTs are more than just art—they are assets. Meowfi is a groundbreaking platform on the Aptos blockchain, enabling users to leverage their NFTs as collateral and access token-based loans.

Key Features:

• Borrowers can securely use their NFTs as collateral to unlock liquidity.
• Lenders can offer tokens, such as Aptos, to borrowers in exchange for interest, creating a win-win lending environment.
• Simple and efficient—borrowers get access to tokens, while lenders earn by providing liquidity.
• Stay connected through our real-time Discord updates, keeping you informed about loans, collateral, and community events.

Meowtos is here to redefine how you utilize NFTs. Join us today and experience decentralized NFT finance on Aptos!

(Back to top)

Architecture

Built With

• Aptos Move
• Nextjs

(Back to top)

Getting Started

Follow these steps to set up Meowfi locally on your machine:

Prerequisites

Ensure you have the following installed:

• Node.js (version 16+)
• Aptos CLI for interacting with the Aptos blockchain
• Git for version control
• Discord Bot Token for Discord integration

Installation

Follow these steps to compile, test, and deploy the contract on Aptos:

1. Compile the contract:

aptos move compile --dev

2. Run contract tests:

aptos move test

3. Deploy the contract:

Initialize the Aptos environment:

aptos init --network devnet

Set the publisher profile and address:

PUBLISHER_PROFILE=default
PUBLISHER_ADDR=0x$(aptos config show-profiles --profile=$PUBLISHER_PROFILE | grep 'account' | sed -n 's/.*"account": \"\(.*\)\".*/\1/p')

Publish the contract by creating an object and deploying the package:

aptos move create-object-and-publish-package \
   --address-name my_addrx \
   --named-addresses my_addrx=$PUBLISHER_ADDR \
   --profile $PUBLISHER_PROFILE \
   --assume-yes

4. Update the contract:

Set the contract object address:

CONTRACT_OBJECT_ADDR="your_contract_object_address_here"

Run the following command to upgrade the contract:

aptos move upgrade-object-package \
   --object-address $CONTRACT_OBJECT_ADDR \
   --named-addresses my_addrx=$CONTRACT_OBJECT_ADDR \
   --profile $PUBLISHER_PROFILE \
   --assume-yes

4. Start local development:

To run the project locally, follow these steps:

1. Set up environment variables: Ensure you have your .env.local file configured.

2. Install dependencies and start the frontend:

   cd frontend && npm install && npm run dev

---

Happy coding!

(Back to top)

Roadmap

• Meow Token
• Meow Spin
• Meow Sniping Bot (First sniping bot on Aptos)
• Legends Trade Premarket (First premarket on Aptos)
• MeowFi Testnet Launch
• Hackathon Winning
  • Bigger Parntnerships
  • MeowFi Mainnet Launch
• Building more tools on Aptos

See the open issues for a full list of proposed features (and known issues).

(Back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/awesome-aptos)
3. Commit your Changes (git commit -m 'Add some awesome-aptos')
4. Push to the Branch (git push origin feature/awesome-aptos)
5. Open a Pull Request

Top contributors:

(Back to top)

Acknowledgments

We would like to express our gratitude to the following resources that have significantly contributed to our development journey:

• Aptos Docs
• Aptos Learn

Specially

• Aptos dev discussions

(Back to top)