superstream 0.3.3

Streaming payments on Solana
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130

//! Module for superstream error handling.

use anchor_lang::prelude::*;

/// Enumeration of possible stream errors.
#[error_code]
pub enum StreamError {
    /// The stream recipient is empty. Should be a valid address.
    #[msg("The stream recipient is empty. Should be a valid address")]
    EmptyRecipient,
    /// The stream recipient is the same as the sender. Should be different addresses.
    #[msg("The stream recipient is the same as the sender. Should be different addresses")]
    SameSenderAndRecipient,
    /// The stream sender is the same as the new sender. Should be different addresses.
    #[msg("The stream sender is the same as the new sender. Should be different addresses")]
    SameSenders,
    /// The stream recipient is the same as the new recipient. Should be different addresses.
    #[msg("The stream recipient is the same as the new recipient. Should be different addresses")]
    SameRecipients,
    /// The new sender is invalid.
    #[msg("The new sender is invalid")]
    InvalidNewSender,
    /// The sender is invalid.
    #[msg("The sender is invalid")]
    InvalidSender,
    /// The recipient is invalid.
    #[msg("The recipient is invalid")]
    InvalidRecipient,
    /// The stream name is too short. Should be >= 2 chars.
    #[msg("The stream name is too short. Should be >= 2 chars")]
    StreamNameTooShort,
    /// The stream name is too long. Should be <= 100 chars.
    #[msg("The stream name is too long. Should be <= 100 chars")]
    StreamNameTooLong,
    /// The flow interval is 0. Should be > 0.
    #[msg("The flow interval is 0. Should be > 0")]
    ZeroFlowInterval,
    /// The end time is either 0 with prepaid = true, in the past or < starts_at. Should be >= current_time and
    /// >= starts_at or if the stream is not prepaid, it can be 0.
    #[msg("The end time is either 0 with prepaid = true, in the past or < starts_at. Should be >= current_time and >= starts_at or if the stream is not prepaid, it can be 0")]
    InvalidEndsAt,
    /// The stream will never lead to any payments. Either there should be a initial amount or flow rate and flow
    /// duration should be > 0.
    #[msg("The stream will never lead to any payments. Either there should be a initial amount or flow rate and flow duration should be > 0")]
    ZeroLifetimeAmount,
    /// The amount cannot be 0. Should be > 0.
    #[msg("The amount cannot be 0. Should be > 0")]
    ZeroAmount,
    /// The prepaid amount needed by the stream is out of bounds.
    #[msg("The prepaid amount needed by the stream is out of bounds")]
    PrepaidAmountNeededOutOfBounds,
    /// The deposit amount needed by the non-prepaid stream is out of bounds.
    #[msg("The deposit amount needed by the non-prepaid stream is out of bounds")]
    DepositAmountNeededOutOfBounds,
    /// The amount is less than the minimum initial amount needed.
    #[msg("The amount is less than the minimum initial amount needed")]
    AmountLessThanAmountNeeded,
    /// The user is not allowed to withdraw. Should be the recipient of the stream.
    #[msg("The user is not allowed to withdraw. Should be the recipient of the stream")]
    UserUnauthorizedToWithdraw,
    /// The withdrawn amount by recipient is more than the amount owed. THIS SHOULD NOT HAVE HAPPENED!!!
    #[msg("The withdrawn amount by recipient is more than the amount owed. THIS SHOULD NOT HAVE HAPPENED!!!")]
    WithdrawnAmountGreaterThanAmountOwed,
    /// The total withdrawn amount by the recipient of the stream is out of bounds.
    #[msg("The total withdrawn amount by the recipient of the stream is out of bounds")]
    WithdrawAmountOutOfBounds,
    /// The amount available to be withdrawn by the recipient of the stream is out of bounds.
    #[msg("The amount available to be withdrawn by the recipient of the stream is out of bounds")]
    AmountAvailableToWithdrawOutOfBounds,
    /// The cancellation refund amount to the sender of the stream is out of bounds.
    #[msg("The cancellation refund amount to the sender of the stream is out of bounds")]
    CancellationRefundOutOfBounds,
    /// The total topup amount by the sender of the stream is out of bounds.
    #[msg("The total topup amount by the sender of the stream is out of bounds")]
    TopupAmountOutOfBounds,
    /// The topup amount is more than what is needed by the stream.
    #[msg("The topup amount is more than what is needed by the stream")]
    TopupAmountMoreThanMaxAcceptable,
    /// The sender has insufficient balance in their token account.
    #[msg("The sender has insufficient balance in their token account")]
    SenderInsufficientFunds,
    /// The token escrow account has insufficient balance. THIS SHOULD NOT HAVE HAPPENED!!!
    #[msg("The token escrow account has insufficient balance. THIS SHOULD NOT HAVE HAPPENED!!!")]
    EscrowInsufficientFunds,
    /// The token escrow account is not rent exempt.
    #[msg("The token escrow account is not rent exempt")]
    EscrowNotRentExempt,
    /// The stream has already been cancelled.
    #[msg("The stream has already been cancelled")]
    StreamAlreadyCancelled,
    /// The user is not allowed to cancel. Should be the sender or the recipient of the stream.
    #[msg("The user is not allowed to cancel. Should be the sender or the recipient of the stream")]
    UserUnauthorizedToCancel,
    /// The sender is not allowed to cancel permanently or at the moment.
    #[msg("The sender is not allowed to cancel permanently or at the moment")]
    SenderCannotCancel,
    /// The stream is prepaid. Should be a non-prepaid stream.
    #[msg("The stream is prepaid. Should be a non-prepaid stream")]
    StreamIsPrepaid,
    /// The stream has already stopped. Should be an unstopped stream.
    #[msg("The stream has already stopped. Should be an unstopped stream")]
    StreamHasStopped,
    /// The stream is already paused. Should be a non-paused stream.
    #[msg("The stream is already paused. Should be a non-paused stream")]
    StreamIsPaused,
    /// The stream is not paused. Should be a paused stream.
    #[msg("The stream is not paused. Should be a paused stream")]
    StreamIsNotPaused,
    /// The stream has no flow payments. Should be a stream stream with a positive flow rate and flow period.
    #[msg("The stream has no flow payments. Should be a stream stream with a positive flow rate and flow period")]
    StreamHasNoFlowPayments,
    /// The sender is not allowed to change sender of the stream permanently or at the moment.
    #[msg("The sender is not allowed to change sender of the stream permanently or at the moment")]
    SenderCannotChangeSender,
    /// The sender is not allowed to pause stream permanently or at the moment.
    #[msg("The sender is not allowed to pause stream permanently or at the moment")]
    SenderCannotPause,
    /// The recipient is not allowed resume a stream paused by sender permanently or at the moment.
    #[msg("The recipient is not allowed resume a stream paused by sender permanently or at the moment")]
    RecipientCannotResumePauseBySender,
    /// The user is not allowed to pause. Should be the sender or the recipient of the stream.
    #[msg("The user is not allowed to pause. Should be the sender or the recipient of the stream")]
    UserUnauthorizedToPause,
    /// The user is not allowed to resume. Should be the sender or the recipient of the stream.
    #[msg("The user is not allowed to resume. Should be the sender or the recipient of the stream")]
    UserUnauthorizedToResume,
    /// The stream has not ended. Should have ended and nat been cancelled.
    #[msg("The stream has not ended. Should have ended and nat been cancelled")]
    StreamNotEnded,
}