SStream is a streaming payments protocol for Soroban.
Currently, it has 3 main functionalities:
- Creating a stream - A user can create a stream by specifying the recipient, the amount streamed per second, the total amount, end date and whether the stream is cancellable or not.
- Claiming a stream - The recipient of the stream can claim the amount that is currently claimable.
- Cancelling - If a stream is cancellable, the creator can cancell the stream. This sends the currently claimable amount to the recipient and sends the rest to the creator.
The web interface currently supports creating, claiming and cancelling a stream.
The interface currently supports the Freighter wallet.
First, connect your wallet and click on Create Stream
Second, input the recipient, the amount, the amount per second and whether the stream should be cancellable or not. Currently, the UI doesn't allow choosing a token and XLM hardcoded in the UI.
Third, fill in the form and click the Create button. Afterwards, approve the transaction in freighter.
After a few seconds, the id of the stream will be shown. The id can then be used to lookup the stream.
First connect your wallet and click on SStream or Lookup Stream.
To view a stream, its id needs to be known. In the future there will be a backend that indexes the streams and that can be used to look up streams for a given address.
Insert the stream id into the field and click the Get details button. After a few second the details of the stream should show up.
Two buttons will also appear that allows for claiming or cancelling a stream.
First, lookup the stream you want to claim by following the Viewing a stream section.
Next click the claim button and approve the transaction in freighter.
After Claiming, the amount withdrawn will be shown.
First, lookup the stream you want to cancell by following the Viewing a stream section.
Next click the cancell button and approve the transaction in freighter.
After cancelling the amount returned to the creator will be shown.
