Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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

Soul streams is a payment streaming service on the Solana blockchain
https://github.com/mgnfy-view/soul-streams

anchor anchor-lang payments payments-platform rust solana solana-program solana-web3js typescript

Last synced: about 13 hours ago
JSON representation

Soul streams is a payment streaming service on the Solana blockchain

Host: GitHub
URL: https://github.com/mgnfy-view/soul-streams
Owner: mgnfy-view
License: mit
Created: 2024-09-07T17:15:47.000Z (18 days ago)
Default Branch: main
Last Pushed: 2024-09-12T12:14:34.000Z (13 days ago)
Last Synced: 2024-09-13T05:56:47.311Z (12 days ago)
Topics: anchor, anchor-lang, payments, payments-platform, rust, solana, solana-program, solana-web3js, typescript
Language: TypeScript
Homepage:
Size: 67.4 KB
Stars: 2
Watchers: 1
Forks: 1
Open Issues: 0
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]






  

  
Soul Streams


  


    Soul streams is a payment streaming service on the Solana blockchain

    


    Report Bug

    ·

    Request Feature

  



  Table of Contents

  


    

      About The Project

      

        Built With

      

    

    

      Getting Started

      

        Prerequisites

        Installation

      

    

    Roadmap

    Contributing

    License

    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](https://img.shields.io/badge/-ANCHOR-%23007ACC.svg?style=for-the-badge)

-   ![Rust](https://img.shields.io/badge/rust-%23000000.svg?style=for-the-badge&logo=rust&logoColor=white)

-   ![TypeScript](https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=typescript&logoColor=white)

-   ![Yarn](https://img.shields.io/badge/yarn-%232C8EBB.svg?style=for-the-badge&logo=yarn&logoColor=white)

## 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,

```shell

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

```

cd into the repo, and install the necessary dependencies

```shell

cd soul-streams

yarn install

anchor build

```

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

```shell

anchor test ./tests/.ts

```

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

## Roadmap

-   [x] Solana program development

-   [x] Unit tests

-   [x] Write a good README.md

See the [open issues](https://github.com/mgnfy-view/soul-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](https://img.shields.io/badge/linktree-1de9b6?style=for-the-badge&logo=linktree&logoColor=white)][linktree-url]

[contributors-shield]: https://img.shields.io/github/contributors/mgnfy-view/soul-streams.svg?style=for-the-badge

[contributors-url]: https://github.com/mgnfy-view/soul-streams/graphs/contributors

[forks-shield]: https://img.shields.io/github/forks/mgnfy-view/soul-streams.svg?style=for-the-badge

[forks-url]: https://github.com/mgnfy-view/soul-streams/network/members

[stars-shield]: https://img.shields.io/github/stars/mgnfy-view/soul-streams.svg?style=for-the-badge

[stars-url]: https://github.com/mgnfy-view/soul-streams/stargazers

[issues-shield]: https://img.shields.io/github/issues/mgnfy-view/soul-streams.svg?style=for-the-badge

[issues-url]: https://github.com/mgnfy-view/soul-streams/issues

[license-shield]: https://img.shields.io/github/license/mgnfy-view/soul-streams.svg?style=for-the-badge

[license-url]: https://github.com/mgnfy-view/soul-streams/blob/master/LICENSE.txt

[linktree-url]: https://linktr.ee/mgnfy.view