client.go

package rpc

import (
	"context"
	"errors"

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

const (
	RollupNumber          = "eth_blockNumber"
	Call                  = "eth_call"
	ChainID               = "eth_chainId"
	GetBalance            = "eth_getBalance"
	GetRollupByHash       = "eth_getBlockByHash"
	GetRollupByNumber     = "eth_getBlockByNumber"
	GetCode               = "eth_getCode"
	GetTransactionByHash  = "eth_getTransactionByHash"
	GetTransactionCount   = "eth_getTransactionCount"
	GetTransactionReceipt = "eth_getTransactionReceipt"
	SendRawTransaction    = "eth_sendRawTransaction"
	EstimateGas           = "eth_estimateGas"
	GetLogs               = "eth_getLogs"
	AddViewingKey         = "obscuro_addViewingKey"
	Health                = "obscuro_health"
	GetBlockHeaderByHash  = "obscuroscan_getBlockHeaderByHash"
	GetBatch              = "obscuroscan_getBatch"
	GetBatchForTx         = "obscuroscan_getBatchForTx"
	GetLatestTxs          = "obscuroscan_getLatestTransactions"
	GetTotalTxs           = "obscuroscan_getTotalTransactions"
	Attestation           = "obscuroscan_attestation"
	StopHost              = "test_stopHost"
	Subscribe             = "eth_subscribe"
	SubscribeNamespace    = "eth"
	SubscriptionTypeLogs  = "logs"
)

var ErrNilResponse = errors.New("nil response received from Obscuro node")

// Client is used by client applications to interact with the Obscuro node
type Client interface {
	// Call executes the named method via RPC. (Returns `ErrNilResponse` on nil response from Node, this is used as "not found" for some method calls)
	Call(result interface{}, method string, args ...interface{}) error
	// CallContext If the context is canceled before the call has successfully returned, CallContext returns immediately.
	CallContext(ctx context.Context, result interface{}, method string, args ...interface{}) error
	// Subscribe creates a subscription to the Obscuro host.
	Subscribe(ctx context.Context, result interface{}, namespace string, channel interface{}, args ...interface{}) (*rpc.ClientSubscription, error)
	// Stop closes the client.
	Stop()
}