plugeth-statediff/api.go

// Copyright 2019 The go-ethereum Authors
// This file is part of the go-ethereum library.
//
// The go-ethereum library is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// The go-ethereum library 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 Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.

package statediff

import (
	"context"

	"github.com/ethereum/go-ethereum/statediff/types"

	"github.com/ethereum/go-ethereum/common"
	"github.com/ethereum/go-ethereum/log"
	"github.com/ethereum/go-ethereum/rpc"
)

// APIName is the namespace used for the state diffing service API
const APIName = "statediff"

// APIVersion is the version of the state diffing service API
const APIVersion = "0.0.1"

// PublicStateDiffAPI provides an RPC subscription interface
// that can be used to stream out state diffs as they
// are produced by a full node
type PublicStateDiffAPI struct {
	sds IService
}

// NewPublicStateDiffAPI creates an rpc subscription interface for the underlying statediff service
func NewPublicStateDiffAPI(sds IService) *PublicStateDiffAPI {
	return &PublicStateDiffAPI{
		sds: sds,
	}
}

// Stream is the public method to setup a subscription that fires off statediff service payloads as they are created
func (api *PublicStateDiffAPI) Stream(ctx context.Context, params Params) (*rpc.Subscription, error) {
	// ensure that the RPC connection supports subscriptions
	notifier, supported := rpc.NotifierFromContext(ctx)
	if !supported {
		return nil, rpc.ErrNotificationsUnsupported
	}

	// create subscription and start waiting for events
	rpcSub := notifier.CreateSubscription()

	go func() {
		// subscribe to events from the statediff service
		payloadChannel := make(chan Payload, chainEventChanSize)
		quitChan := make(chan bool, 1)
		api.sds.Subscribe(rpcSub.ID, payloadChannel, quitChan, params)
		// loop and await payloads and relay them to the subscriber with the notifier
		for {
			select {
			case payload := <-payloadChannel:
				if err := notifier.Notify(rpcSub.ID, payload); err != nil {
					log.Error("Failed to send state diff packet; error: " + err.Error())
					if err := api.sds.Unsubscribe(rpcSub.ID); err != nil {
						log.Error("Failed to unsubscribe from the state diff service; error: " + err.Error())
					}
					return
				}
			case err := <-rpcSub.Err():
				if err != nil {
					log.Error("State diff service rpcSub error: " + err.Error())
					err = api.sds.Unsubscribe(rpcSub.ID)
					if err != nil {
						log.Error("Failed to unsubscribe from the state diff service; error: " + err.Error())
					}
					return
				}
			case <-quitChan:
				// don't need to unsubscribe, service does so before sending the quit signal
				return
			}
		}
	}()

	return rpcSub, nil
}

// StateDiffAt returns a state diff payload at the specific blockheight
func (api *PublicStateDiffAPI) StateDiffAt(ctx context.Context, blockNumber uint64, params Params) (*Payload, error) {
	return api.sds.StateDiffAt(blockNumber, params)
}

// StateDiffFor returns a state diff payload for the specific blockhash
func (api *PublicStateDiffAPI) StateDiffFor(ctx context.Context, blockHash common.Hash, params Params) (*Payload, error) {
	return api.sds.StateDiffFor(blockHash, params)
}

// StreamCodeAndCodeHash writes all of the codehash=>code pairs out to a websocket channel
func (api *PublicStateDiffAPI) StreamCodeAndCodeHash(ctx context.Context, blockNumber uint64) (*rpc.Subscription, error) {
	// ensure that the RPC connection supports subscriptions
	notifier, supported := rpc.NotifierFromContext(ctx)
	if !supported {
		return nil, rpc.ErrNotificationsUnsupported
	}

	// create subscription and start waiting for events
	rpcSub := notifier.CreateSubscription()
	payloadChan := make(chan types.CodeAndCodeHash, chainEventChanSize)
	quitChan := make(chan bool)
	api.sds.StreamCodeAndCodeHash(blockNumber, payloadChan, quitChan)
	go func() {
		for {
			select {
			case payload := <-payloadChan:
				if err := notifier.Notify(rpcSub.ID, payload); err != nil {
					log.Error("Failed to send code and codehash packet", "err", err)
					return
				}
			case err := <-rpcSub.Err():
				log.Error("State diff service rpcSub error", "err", err)
				return
			case <-quitChan:
				return
			}
		}
	}()

	return rpcSub, nil
}

// WriteStateDiffAt writes a state diff object directly to DB at the specific blockheight
func (api *PublicStateDiffAPI) WriteStateDiffAt(ctx context.Context, blockNumber uint64, params Params) JobID {
	var err error
	start, logger := countApiRequestBegin("writeStateDiffAt", blockNumber)
	defer countApiRequestEnd(start, logger, err)

	return api.sds.WriteStateDiffAt(blockNumber, params)
}

// WriteStateDiffFor writes a state diff object directly to DB for the specific block hash
func (api *PublicStateDiffAPI) WriteStateDiffFor(ctx context.Context, blockHash common.Hash, params Params) error {
	var err error
	start, logger := countApiRequestBegin("writeStateDiffFor", blockHash.Hex())
	defer countApiRequestEnd(start, logger, err)

	err = api.sds.WriteStateDiffFor(blockHash, params)
	return err
}

// WatchAddress changes the list of watched addresses to which the direct indexing is restricted according to given operation
func (api *PublicStateDiffAPI) WatchAddress(operation types.OperationType, args []types.WatchAddressArg) error {
	return api.sds.WatchAddress(operation, args)
}

// StreamWrites sets up a subscription that streams the status of completed calls to WriteStateDiff*
func (api *PublicStateDiffAPI) StreamWrites(ctx context.Context) (*rpc.Subscription, error) {
	// ensure that the RPC connection supports subscriptions
	notifier, supported := rpc.NotifierFromContext(ctx)
	if !supported {
		return nil, rpc.ErrNotificationsUnsupported
	}

	// create subscription and start waiting for events
	rpcSub := notifier.CreateSubscription()

	go func() {
		// subscribe to events from the statediff service
		statusChan := make(chan JobStatus, chainEventChanSize)
		quitChan := make(chan bool, 1)
		api.sds.SubscribeWriteStatus(rpcSub.ID, statusChan, quitChan)

		var err error
		defer func() {
			if err = api.sds.UnsubscribeWriteStatus(rpcSub.ID); err != nil {
				log.Error("Failed to unsubscribe from job status stream: " + err.Error())
			}
		}()
		// loop and await payloads and relay them to the subscriber with the notifier
		for {
			select {
			case status := <-statusChan:
				if err = notifier.Notify(rpcSub.ID, status); err != nil {
					log.Error("Failed to send job status; error: " + err.Error())
					return
				}
			case err = <-rpcSub.Err():
				if err != nil {
					log.Error("statediff_StreamWrites RPC subscription error: " + err.Error())
					return
				}
			case <-quitChan:
				// don't need to unsubscribe, service does so before sending the quit signal
				return
			}
		}
	}()

	return rpcSub, nil
}