signer

Documentation

Index

• Constants
• func CLIFlags(envPrefix string, category string) []cli.Flag
• type BlockPayloadArgs
  • func NewBlockPayloadArgs(domain [32]byte, chainId *big.Int, payloadBytes []byte, ...) *BlockPayloadArgs
  • func (args *BlockPayloadArgs) Check() error
  • func (args *BlockPayloadArgs) ToSigningHash() (common.Hash, error)
• type CLIConfig
  • func NewCLIConfig() CLIConfig
  • func ReadCLIConfig(ctx *cli.Context) CLIConfig
  • func (c CLIConfig) Check() error
  • func (c CLIConfig) Enabled() bool
• type SignerClient
  • func NewSignerClient(logger log.Logger, endpoint string, headers http.Header, ...) (*SignerClient, error)
  • func NewSignerClientFromConfig(logger log.Logger, config CLIConfig) (*SignerClient, error)
  • func (s *SignerClient) SignBlockPayload(ctx context.Context, args *BlockPayloadArgs) ([65]byte, error)
  • func (s *SignerClient) SignTransaction(ctx context.Context, chainId *big.Int, from common.Address, ...) (*types.Transaction, error)
• type TransactionArgs
  • func NewTransactionArgsFromTransaction(chainId *big.Int, from *common.Address, tx *types.Transaction) *TransactionArgs
  • func (args *TransactionArgs) Check() error
  • func (args *TransactionArgs) ToTransactionData() (types.TxData, error)

Constants

const (
	EndpointFlagName = "signer.endpoint"
	AddressFlagName  = "signer.address"
	HeadersFlagName  = "signer.header"
)

Functions

func CLIFlags

func CLIFlags(envPrefix string, category string) []cli.Flag

Types

type BlockPayloadArgs

type BlockPayloadArgs struct {
	Domain        [32]byte `json:"domain"`
	ChainID       *big.Int `json:"chainId"`
	PayloadHash   []byte   `json:"payloadHash"`
	PayloadBytes  []byte
	SenderAddress *common.Address `json:"senderAddress"`
}

BlockPayloadArgs represents the arguments to sign a new block payload from the sequencer.

func NewBlockPayloadArgs

func NewBlockPayloadArgs(domain [32]byte, chainId *big.Int, payloadBytes []byte, senderAddress *common.Address) *BlockPayloadArgs

NewBlockPayloadArgs creates a BlockPayloadArgs struct

func (*BlockPayloadArgs) Check

func (args *BlockPayloadArgs) Check() error

func (*BlockPayloadArgs) ToSigningHash

func (args *BlockPayloadArgs) ToSigningHash() (common.Hash, error)

ToSigningHash creates a signingHash from the block payload args. Uses the hashing scheme from https://github.com/ethereum-optimism/specs/blob/main/specs/protocol/rollup-node-p2p.md#block-signatures

type CLIConfig

type CLIConfig struct {
	Endpoint  string
	Address   string
	Headers   http.Header
	TLSConfig optls.CLIConfig
}

func NewCLIConfig

func NewCLIConfig() CLIConfig

func ReadCLIConfig

func ReadCLIConfig(ctx *cli.Context) CLIConfig

func (CLIConfig) Check

func (c CLIConfig) Check() error

func (CLIConfig) Enabled

func (c CLIConfig) Enabled() bool

type SignerClient

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

func NewSignerClient

func NewSignerClient(logger log.Logger, endpoint string, headers http.Header, tlsConfig optls.CLIConfig) (*SignerClient, error)

func NewSignerClientFromConfig

func NewSignerClientFromConfig(logger log.Logger, config CLIConfig) (*SignerClient, error)

func (*SignerClient) SignBlockPayload

func (s *SignerClient) SignBlockPayload(ctx context.Context, args *BlockPayloadArgs) ([65]byte, error)

func (*SignerClient) SignTransaction

func (s *SignerClient) SignTransaction(ctx context.Context, chainId *big.Int, from common.Address, tx *types.Transaction) (*types.Transaction, error)

type TransactionArgs

type TransactionArgs struct {
	From                 *common.Address `json:"from"`
	To                   *common.Address `json:"to"`
	Gas                  *hexutil.Uint64 `json:"gas"`
	GasPrice             *hexutil.Big    `json:"gasPrice"`
	MaxFeePerGas         *hexutil.Big    `json:"maxFeePerGas"`
	MaxPriorityFeePerGas *hexutil.Big    `json:"maxPriorityFeePerGas"`
	Value                *hexutil.Big    `json:"value"`
	Nonce                *hexutil.Uint64 `json:"nonce"`

	// We accept "data" and "input" for backwards-compatibility reasons.
	// "input" is the newer name and should be preferred by clients.
	// Issue detail: https://github.com/ethereum/go-ethereum/issues/15628
	Data  *hexutil.Bytes `json:"data"`
	Input *hexutil.Bytes `json:"input"`

	AccessList *types.AccessList `json:"accessList,omitempty"`
	ChainID    *hexutil.Big      `json:"chainId,omitempty"`

	// Custom extension for EIP-4844 support
	BlobVersionedHashes []common.Hash `json:"blobVersionedHashes,omitempty"`
	BlobFeeCap          *hexutil.Big  `json:"maxFeePerBlobGas,omitempty"`
}

TransactionArgs represents the arguments to construct a new transaction or a message call. Geth has an internal version of this, but this is not exported, and only supported in v1.13.11 and forward. This signing API format is based on the legacy personal-account signing RPC of ethereum.

func NewTransactionArgsFromTransaction

func NewTransactionArgsFromTransaction(chainId *big.Int, from *common.Address, tx *types.Transaction) *TransactionArgs

NewTransactionArgsFromTransaction creates a TransactionArgs struct from an EIP-1559 or EIP-4844 transaction

func (*TransactionArgs) Check

func (args *TransactionArgs) Check() error

func (*TransactionArgs) ToTransactionData

func (args *TransactionArgs) ToTransactionData() (types.TxData, error)

ToTransactionData converts the arguments to transaction content-data. Warning: this excludes blob data.