signer

Documentation

Overview

Package signer is a package that provides application-level signing operations.

Index

• type AggregateAndProofSigner
• type BeaconAttestationSigner
• type BeaconAttestationsSigner
• type BeaconBlockSigner
• type RANDAORevealSigner
• type Service
• type SlotSelectionSigner

Types

type AggregateAndProofSigner

type AggregateAndProofSigner interface {
	// SignAggregateAndProof signs an aggregate attestation for given slot and root.
	SignAggregateAndProof(ctx context.Context,
		account e2wtypes.Account,
		slot spec.Slot,
		root spec.Root,
	) (
		spec.BLSSignature,
		error,
	)
}

AggregateAndProofSigner provides methods to sign aggregate and proofs.

type BeaconAttestationSigner

type BeaconAttestationSigner interface {
	// SignBeaconAttestation signs a beacon attestation.
	SignBeaconAttestation(ctx context.Context,
		account e2wtypes.Account,
		slot spec.Slot,
		committeeIndex spec.CommitteeIndex,
		blockRoot spec.Root,
		sourceEpoch spec.Epoch,
		sourceRoot spec.Root,
		targetEpoch spec.Epoch,
		targetRoot spec.Root,
	) (
		spec.BLSSignature,
		error,
	)
}

BeaconAttestationSigner provides methods to sign beacon attestations.

type BeaconAttestationsSigner

type BeaconAttestationsSigner interface {
	// SignBeaconAttestation signs multiple beacon attestations.
	SignBeaconAttestations(ctx context.Context,
		accounts []e2wtypes.Account,
		slot spec.Slot,
		committeeIndices []spec.CommitteeIndex,
		blockRoot spec.Root,
		sourceEpoch spec.Epoch,
		sourceRoot spec.Root,
		targetEpoch spec.Epoch,
		targetRoot spec.Root,
	) (
		[]spec.BLSSignature,
		error,
	)
}

BeaconAttestationsSigner provides methods to sign multiple beacon attestations.

type BeaconBlockSigner

type BeaconBlockSigner interface {
	// SignBeaconBlockProposal signs a beacon block proposal.
	SignBeaconBlockProposal(ctx context.Context,
		account e2wtypes.Account,
		slot spec.Slot,
		proposerIndex spec.ValidatorIndex,
		parentRoot spec.Root,
		stateRoot spec.Root,
		bodyRoot spec.Root,
	) (
		spec.BLSSignature,
		error,
	)
}

BeaconBlockSigner provides methods to sign beacon blocks.

type RANDAORevealSigner

type RANDAORevealSigner interface {
	// SignRANDAOReveal returns a RANDAO signature.
	// This signs an epoch with the "RANDAO" domain.
	SignRANDAOReveal(ctx context.Context,
		account e2wtypes.Account,
		slot spec.Slot,
	) (
		spec.BLSSignature,
		error,
	)
}

RANDAORevealSigner provides methods to sign RANDAO reveals.

type Service

type Service interface{}

Service is the generic signer service.

type SlotSelectionSigner

type SlotSelectionSigner interface {
	// SignSlotSelection returns a slot selection signature.
	// This signs a slot with the "selection proof" domain.
	SignSlotSelection(ctx context.Context,
		account e2wtypes.Account,
		slot spec.Slot,
	) (
		spec.BLSSignature,
		error,
	)
}

SlotSelectionSigner provides methods to sign slot selections.