Skip to content

Latest commit

 

History

History
149 lines (107 loc) · 5.11 KB

README.md

File metadata and controls

149 lines (107 loc) · 5.11 KB
Raw

Contributors Forks Stargazers Issues MIT License


PayStreams

PayStreams is a payment streaming service supercharged with hooks
Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Roadmap
  4. Contributing
  5. License
  6. Contact

About The Project

PayStreams is a payment streaming service which allows anyone to open token streams directed to any recipient. The recipient can collect the streamed funds over time, or when the stream ends. The stream creator can update, pause, unpause, or cancel the stream as well. Streams can be one-time, or recurring.

Additionally, we introduce hooks, which are functions with custom logic that can be invoked at various points during the stream's lifespan. To opt into hooks, both the streamer and the recipient can set custom vaults with correct functions and hook configuration, and these functions will be invoked by the PayStreams contract when certain events occur. Hooks open up a wide array of use cases and customizations, enabling developers to extend the functionality of streams. You can find some hook examples in the ./src/exampleHooks/ folder.

P.S. This project was built for the BuildOn hackathon on Devfolio.

Built With

  • Solidity
  • Foundry

Getting Started

Prerequisites

Make sure you have git, rust, and foundry installed and configured on your system.

Installation

Clone the repo,

git clone https://github.com/mgnfy-view/pay-streams.git

cd into the repo, and install the necessary dependencies

cd pay-streams
forge build

Run tests by executing

forge test

That's it, you are good to go now!

Roadmap

  • Smart contract development
  • Unit tests
  • Write a good README.md

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

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/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE.txt for more information.

Reach Out

Here's a gateway to all my socials, don't forget to hit me up!

Linktree