Skip to content

Soul streams is a payment streaming service on the Solana blockchain

License

Notifications You must be signed in to change notification settings

mgnfy-view/soul-streams

Repository files navigation

Contributors Forks Stargazers Issues MIT License


Soul Streams

Soul streams is a payment streaming service on the Solana blockchain
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

Soul streams is a payment streaming service on Solana. It allows anyone to create payment streams directed to any wallet and fund it with SPL tokens. The tokens are unlocked for the payee linearly over time. Additionally, the payer can cancel the stream which transfers the remaining balance of the stream back to them. The payer can also replenish their stream to start streaming tokens to the same payee again.

Built With

  • Anchor
  • Rust
  • TypeScript
  • Yarn

Getting Started

Prerequisites

Make sure you have rust, solana-cli, anchor, git, node.js, and yarn installed and configured on your system.

Installation

Clone the repo,

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

cd into the repo, and install the necessary dependencies

cd soul-streams
yarn install
anchor build

Run any of the test files in the ./tests folder by executing

anchor test ./tests/<test-file-name>.ts

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

Roadmap

  • Solana program 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