https://github.com/mgnfy-view/pay-streams
PayStreams is a payment streaming service supercharged with hooks
https://github.com/mgnfy-view/pay-streams
devfolio forge foundry hooks payments pyusd smart solidity streams
Last synced: 5 months ago
JSON representation
PayStreams is a payment streaming service supercharged with hooks
- Host: GitHub
- URL: https://github.com/mgnfy-view/pay-streams
- Owner: mgnfy-view
- License: mit
- Created: 2024-10-25T09:25:23.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-19T15:26:23.000Z (over 1 year ago)
- Last Synced: 2025-02-14T06:55:11.056Z (about 1 year ago)
- Topics: devfolio, forge, foundry, hooks, payments, pyusd, smart, solidity, streams
- Language: Solidity
- Homepage:
- Size: 85.9 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
PayStreams
PayStreams is a payment streaming service supercharged with hooks
Report Bug
·
Request Feature
Table of Contents
## 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,
```shell
git clone https://github.com/mgnfy-view/pay-streams.git
```
cd into the repo, and install the necessary dependencies
```shell
cd pay-streams
forge build
```
Run tests by executing
```shell
forge test
```
That's it, you are good to go now!
## Roadmap
- [x] Smart contract development
- [x] Unit tests
- [x] Write a good README.md
See the [open issues](https://github.com/mgnfy-view/pay-streams/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-url]
[contributors-shield]: https://img.shields.io/github/contributors/mgnfy-view/pay-streams.svg?style=for-the-badge
[contributors-url]: https://github.com/mgnfy-view/pay-streams/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/mgnfy-view/pay-streams.svg?style=for-the-badge
[forks-url]: https://github.com/mgnfy-view/pay-streams/network/members
[stars-shield]: https://img.shields.io/github/stars/mgnfy-view/pay-streams.svg?style=for-the-badge
[stars-url]: https://github.com/mgnfy-view/pay-streams/stargazers
[issues-shield]: https://img.shields.io/github/issues/mgnfy-view/pay-streams.svg?style=for-the-badge
[issues-url]: https://github.com/mgnfy-view/pay-streams/issues
[license-shield]: https://img.shields.io/github/license/mgnfy-view/pay-streams.svg?style=for-the-badge
[license-url]: https://github.com/mgnfy-view/pay-streams/blob/master/LICENSE.txt
[linktree-url]: https://linktr.ee/mgnfy.view