maidenlanedevents

package

v1.0.0 Latest Latest Go to latest Published: Jan 23, 2021 License: Apache-2.0 Imports: 26 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/freight-trust/zeroxyz

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func CobraInitSubscriptionManager(cmd *cobra.Command, conf *SubscriptionManagerConf)
type StreamInfo
- func (spec *StreamInfo) GetID() string
type SubscriptionInfo
- func (info *SubscriptionInfo) GetID() string
type SubscriptionManager
- func NewSubscriptionManager(conf *SubscriptionManagerConf, rpc maidenlanedeth.RPCClient) SubscriptionManager
type SubscriptionManagerConf

Constants ¶

View Source

const (
	// FromBlockLatest is the special string that means subscribe from the current block
	FromBlockLatest = "latest"
	// ErrorHandlingBlock blocks the event stream until the handler can accept the event
	ErrorHandlingBlock = "block"
	// ErrorHandlingSkip processes up to the retry behavior on the stream, then skips to the next event
	ErrorHandlingSkip = "skip"
	// MaxBatchSize is the maximum that a user can specific for their batch size
	MaxBatchSize = 1000
	// DefaultExponentialBackoffInitial  is the initial delay for backoff retry
	DefaultExponentialBackoffInitial = time.Duration(1) * time.Second
	// DefaultExponentialBackoffFactor is the factor we use between retries
	DefaultExponentialBackoffFactor = float64(2.0)
	// DefaultTimestampCacheSize is the number of entries we will hold in a LRU cache for block timestamps
	DefaultTimestampCacheSize = 1000
)

View Source

const (
	// SubPathPrefix is the path prefix for subscriptions
	SubPathPrefix = "/subscriptions"
	// StreamPathPrefix is the path prefix for event streams
	StreamPathPrefix = "/eventstreams"
)

Variables ¶

This section is empty.

Functions ¶

func CobraInitSubscriptionManager ¶

func CobraInitSubscriptionManager(cmd *cobra.Command, conf *SubscriptionManagerConf)

CobraInitSubscriptionManager standard naming for cobra command params

Types ¶

type StreamInfo ¶

type StreamInfo struct {
	maidenlanedmessages.TimeSorted
	ID                   string         `json:"id"`
	Name                 string         `json:"name,omitempty"`
	Path                 string         `json:"path"`
	Suspended            bool           `json:"suspended"`
	Type                 string         `json:"type,omitempty"`
	BatchSize            uint64         `json:"batchSize,omitempty"`
	BatchTimeoutMS       uint64         `json:"batchTimeoutMS,omitempty"`
	ErrorHandling        string         `json:"errorHandling,omitempty"`
	RetryTimeoutSec      uint64         `json:"retryTimeoutSec,omitempty"`
	BlockedRetryDelaySec uint64         `json:"blockedReryDelaySec,omitempty"`
	Webhook              *webhookAction `json:"webhook,omitempty"`
	Timestamps           bool           `json:"timestamps,omitempty"` // Include block timestamps in the events generated
}

StreamInfo configures the stream to perform an action for each event

func (*StreamInfo) GetID ¶

func (spec *StreamInfo) GetID() string

GetID returns the ID (for sorting)

type SubscriptionInfo ¶

type SubscriptionInfo struct {
	maidenlanedmessages.TimeSorted
	ID        string                                `json:"id,omitempty"`
	Path      string                                `json:"path"`
	Summary   string                                `json:"-"`    // System generated name for the subscription
	Name      string                                `json:"name"` // User provided name for the subscription, set to Summary if missing
	Stream    string                                `json:"stream"`
	Filter    persistedFilter                       `json:"filter"`
	Event     *maidenlanedbind.ABIElementMarshaling `json:"event"`
	FromBlock string                                `json:"fromBlock,omitempty"`
}

SubscriptionInfo is the persisted data for the subscription

func (*SubscriptionInfo) GetID ¶

func (info *SubscriptionInfo) GetID() string

GetID returns the ID (for sorting)

type SubscriptionManager ¶

type SubscriptionManager interface {
	Init() error
	AddStream(ctx context.Context, spec *StreamInfo) (*StreamInfo, error)
	Streams(ctx context.Context) []*StreamInfo
	StreamByID(ctx context.Context, id string) (*StreamInfo, error)
	UpdateStream(ctx context.Context, id string, spec *StreamInfo) (*StreamInfo, error)
	SuspendStream(ctx context.Context, id string) error
	ResumeStream(ctx context.Context, id string) error
	DeleteStream(ctx context.Context, id string) error
	AddSubscription(ctx context.Context, addr *maidenlanedbind.Address, event *maidenlanedbind.ABIElementMarshaling, streamID, initialBlock, name string) (*SubscriptionInfo, error)
	Subscriptions(ctx context.Context) []*SubscriptionInfo
	SubscriptionByID(ctx context.Context, id string) (*SubscriptionInfo, error)
	ResetSubscription(ctx context.Context, id, initialBlock string) error
	DeleteSubscription(ctx context.Context, id string) error
	Close()
}

SubscriptionManager provides REST APIs for managing events

func NewSubscriptionManager ¶

func NewSubscriptionManager(conf *SubscriptionManagerConf, rpc maidenlanedeth.RPCClient) SubscriptionManager

NewSubscriptionManager construtor

type SubscriptionManagerConf ¶

type SubscriptionManagerConf struct {
	EventLevelDBPath        string `json:"eventsDB"`
	EventPollingIntervalSec uint64 `json:"eventPollingIntervalSec,omitempty"`
	WebhooksAllowPrivateIPs bool   `json:"webhooksAllowPrivateIPs,omitempty"`
}

SubscriptionManagerConf configuration

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL