2019-04-18 12:39:37 +00:00
|
|
|
// VulcanizeDB
|
|
|
|
// Copyright © 2019 Vulcanize
|
|
|
|
|
|
|
|
// This program is free software: you can redistribute it and/or modify
|
|
|
|
// it under the terms of the GNU Affero General Public License as published by
|
|
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
|
|
// (at your option) any later version.
|
|
|
|
|
|
|
|
// This program is distributed in the hope that it will be useful,
|
|
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
// GNU Affero General Public License for more details.
|
|
|
|
|
|
|
|
// You should have received a copy of the GNU Affero General Public License
|
|
|
|
// along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
|
2019-10-02 14:10:37 +00:00
|
|
|
package super_node
|
2019-04-30 17:48:31 +00:00
|
|
|
|
|
|
|
import (
|
2020-02-19 22:09:33 +00:00
|
|
|
"errors"
|
|
|
|
|
2020-01-17 23:16:01 +00:00
|
|
|
"github.com/ethereum/go-ethereum/rpc"
|
2020-01-31 18:03:37 +00:00
|
|
|
"github.com/vulcanize/vulcanizedb/pkg/super_node/shared"
|
2019-04-30 17:48:31 +00:00
|
|
|
)
|
|
|
|
|
2020-02-19 22:09:33 +00:00
|
|
|
type Flag int32
|
|
|
|
|
|
|
|
const (
|
|
|
|
EmptyFlag Flag = iota
|
|
|
|
BackFillCompleteFlag
|
|
|
|
)
|
|
|
|
|
2019-10-02 14:10:37 +00:00
|
|
|
// Subscription holds the information for an individual client subscription to the super node
|
2019-08-05 17:56:15 +00:00
|
|
|
type Subscription struct {
|
2020-01-17 23:16:01 +00:00
|
|
|
ID rpc.ID
|
2020-01-31 18:03:37 +00:00
|
|
|
PayloadChan chan<- SubscriptionPayload
|
2019-08-05 17:56:15 +00:00
|
|
|
QuitChan chan<- bool
|
2019-04-30 17:48:31 +00:00
|
|
|
}
|
2020-01-17 23:16:01 +00:00
|
|
|
|
2020-01-31 18:03:37 +00:00
|
|
|
// SubscriptionPayload is the struct for a super node stream payload
|
2020-01-17 23:16:01 +00:00
|
|
|
// It carries data of a type specific to the chain being supported/queried and an error message
|
2020-01-31 18:03:37 +00:00
|
|
|
type SubscriptionPayload struct {
|
|
|
|
Data shared.ServerResponse `json:"data"` // e.g. for Ethereum eth.StreamPayload
|
2020-02-19 04:42:53 +00:00
|
|
|
Err string `json:"err"` // field for error
|
2020-02-19 22:09:33 +00:00
|
|
|
Flag Flag `json:"flag"` // field for message
|
|
|
|
}
|
|
|
|
|
|
|
|
func (sp SubscriptionPayload) Error() error {
|
|
|
|
if sp.Err == "" {
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
return errors.New(sp.Err)
|
|
|
|
}
|
|
|
|
|
|
|
|
func (sp SubscriptionPayload) BackFillComplete() bool {
|
|
|
|
if sp.Flag == BackFillCompleteFlag {
|
|
|
|
return true
|
|
|
|
}
|
|
|
|
return false
|
2020-01-17 23:16:01 +00:00
|
|
|
}
|