service

Documentation

Index

• Variables
• func NewAuthMiddleware() oprpc.Middleware
• type AuthConfig
  • func (c AuthConfig) MaxValueToInt() *big.Int
• type ClientInfo
  • func ClientInfoFromContext(ctx context.Context) ClientInfo
• type EthService
  • func (s *EthService) SignTransaction(ctx context.Context, args signer.TransactionArgs) (hexutil.Bytes, error)
• type InvalidBlockPayloadError
  • func (e *InvalidBlockPayloadError) Error() string
  • func (e *InvalidBlockPayloadError) ErrorCode() int
• type InvalidTransactionError
  • func (e *InvalidTransactionError) Error() string
  • func (e *InvalidTransactionError) ErrorCode() int
• type OpsignerSerivce
  • func (s *OpsignerSerivce) SignBlockPayload(ctx context.Context, args signer.BlockPayloadArgs) (hexutil.Bytes, error)
• type SignerService
  • func NewSignerService(logger log.Logger, config SignerServiceConfig) *SignerService
  • func NewSignerServiceWithProvider(logger log.Logger, config SignerServiceConfig, ...) *SignerService
  • func (s *SignerService) RegisterAPIs(server *oprpc.Server)
• type SignerServiceConfig
  • func ReadConfig(path string) (SignerServiceConfig, error)
  • func (s SignerServiceConfig) GetAuthConfigForClient(clientName string, fromAddress *common.Address) (*AuthConfig, error)
• type UnauthorizedBlockPayloadError
  • func (e *UnauthorizedBlockPayloadError) Error() string
  • func (e *UnauthorizedBlockPayloadError) ErrorCode() int
• type UnauthorizedTransactionError
  • func (e *UnauthorizedTransactionError) Error() string
  • func (e *UnauthorizedTransactionError) ErrorCode() int

Variables

var (
	MetricSignTransactionTotal = prometheus.NewCounterVec(
		prometheus.CounterOpts{
			Name: "signer_signtransaction_total",
			Help: ""},
		[]string{"client", "status", "error"},
	)
)

Functions

func NewAuthMiddleware

func NewAuthMiddleware() oprpc.Middleware

Types

type AuthConfig

type AuthConfig struct {
	// ClientName DNS name of the client connecting to op-signer.
	ClientName string `yaml:"name"`
	// KeyName key resource name of the Cloud KMS
	KeyName string `yaml:"key"`
	// ChainID chain id of the op-signer to sign for
	ChainID uint64 `yaml:"chainID"`
	// FromAddress sender address that is sending the rpc request
	FromAddress common.Address `yaml:"fromAddress"`
	ToAddresses []string       `yaml:"toAddresses"`
	MaxValue    string         `yaml:"maxValue"`
}

func (AuthConfig) MaxValueToInt

func (c AuthConfig) MaxValueToInt() *big.Int

type ClientInfo

type ClientInfo struct {
	ClientName string
}

func ClientInfoFromContext

func ClientInfoFromContext(ctx context.Context) ClientInfo

type EthService

type EthService struct {
	// contains filtered or unexported fields
}

func (*EthService) SignTransaction

func (s *EthService) SignTransaction(ctx context.Context, args signer.TransactionArgs) (hexutil.Bytes, error)

SignTransaction will sign the given transaction with the key configured for the authenticated client

type InvalidBlockPayloadError

type InvalidBlockPayloadError struct {
	// contains filtered or unexported fields
}

func (*InvalidBlockPayloadError) Error

func (e *InvalidBlockPayloadError) Error() string

func (*InvalidBlockPayloadError) ErrorCode

func (e *InvalidBlockPayloadError) ErrorCode() int

type InvalidTransactionError

type InvalidTransactionError struct {
	// contains filtered or unexported fields
}

func (*InvalidTransactionError) Error

func (e *InvalidTransactionError) Error() string

func (*InvalidTransactionError) ErrorCode

func (e *InvalidTransactionError) ErrorCode() int

type OpsignerSerivce

type OpsignerSerivce struct {
	// contains filtered or unexported fields
}

func (*OpsignerSerivce) SignBlockPayload

func (s *OpsignerSerivce) SignBlockPayload(ctx context.Context, args signer.BlockPayloadArgs) (hexutil.Bytes, error)

type SignerService

type SignerService struct {
	// contains filtered or unexported fields
}

func NewSignerService

func NewSignerService(logger log.Logger, config SignerServiceConfig) *SignerService

func NewSignerServiceWithProvider

func NewSignerServiceWithProvider(
	logger log.Logger,
	config SignerServiceConfig,
	provider provider.SignatureProvider,
) *SignerService

func (*SignerService) RegisterAPIs

func (s *SignerService) RegisterAPIs(server *oprpc.Server)

type SignerServiceConfig

type SignerServiceConfig struct {
	Auth []AuthConfig `yaml:"auth"`
}

func ReadConfig

func ReadConfig(path string) (SignerServiceConfig, error)

func (SignerServiceConfig) GetAuthConfigForClient

func (s SignerServiceConfig) GetAuthConfigForClient(clientName string, fromAddress *common.Address) (*AuthConfig, error)

type UnauthorizedBlockPayloadError

type UnauthorizedBlockPayloadError struct {
	// contains filtered or unexported fields
}

func (*UnauthorizedBlockPayloadError) Error

func (e *UnauthorizedBlockPayloadError) Error() string

func (*UnauthorizedBlockPayloadError) ErrorCode

func (e *UnauthorizedBlockPayloadError) ErrorCode() int

type UnauthorizedTransactionError

type UnauthorizedTransactionError struct {
	// contains filtered or unexported fields
}

func (*UnauthorizedTransactionError) Error

func (e *UnauthorizedTransactionError) Error() string

func (*UnauthorizedTransactionError) ErrorCode

func (e *UnauthorizedTransactionError) ErrorCode() int