guard

Documentation

Overview

Package guard signs attestations and posts to attestation collector and destination.

Index

• type AttestationCollectorAttestationScanner
  • func NewAttestationCollectorAttestationScanner(domain domains.DomainClient, originID, destinationID uint32, db db.SynapseDB, ...) AttestationCollectorAttestationScanner
  • func (a AttestationCollectorAttestationScanner) FindLatestNonce(ctx context.Context) (nonce uint32, err error)
  • func (a AttestationCollectorAttestationScanner) Start(ctx context.Context) error
• type AttestationDoubleCheckOnOriginVerifier
  • func NewAttestationDoubleCheckOnOriginVerifier(originDomain domains.DomainClient, attestationDomain domains.DomainClient, ...) AttestationDoubleCheckOnOriginVerifier
  • func (a AttestationDoubleCheckOnOriginVerifier) FindOldestGuardUnsignedAndUnverifiedAttestation(ctx context.Context) (types.InProgressAttestation, error)
  • func (a AttestationDoubleCheckOnOriginVerifier) Start(ctx context.Context) error
• type AttestationGuardSigner
  • func NewAttestationGuardSigner(originDomain domains.DomainClient, attestationDomain domains.DomainClient, ...) AttestationGuardSigner
  • func (a AttestationGuardSigner) FindOldestGuardUnsignedAndVerifiedAttestation(ctx context.Context) (types.InProgressAttestation, error)
  • func (a AttestationGuardSigner) Start(ctx context.Context) error
• type Guard
  • func NewGuard(ctx context.Context, cfg config.GuardConfig) (_ Guard, err error)
  • func (u Guard) Start(ctx context.Context) error

Types

type AttestationCollectorAttestationScanner

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

AttestationCollectorAttestationScanner fetches attestations for particular origin-destination pair. TODO: this needs to become an interface.

func NewAttestationCollectorAttestationScanner

func NewAttestationCollectorAttestationScanner(domain domains.DomainClient, originID, destinationID uint32, db db.SynapseDB, signer signer.Signer, interval time.Duration) AttestationCollectorAttestationScanner

NewAttestationCollectorAttestationScanner creates a new attestation collector attestation scanner.

func (AttestationCollectorAttestationScanner) FindLatestNonce

func (a AttestationCollectorAttestationScanner) FindLatestNonce(ctx context.Context) (nonce uint32, err error)

FindLatestNonce fetches the latest cached nonce for a given chain. TODO (joe): there was a bug in this code not covered by current tests. Make sure to add a test that covers when latestNonce is not zero.

func (AttestationCollectorAttestationScanner) Start

func (a AttestationCollectorAttestationScanner) Start(ctx context.Context) error

Start starts the AttestationCollectorAttestationScanner.

type AttestationDoubleCheckOnOriginVerifier

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

AttestationDoubleCheckOnOriginVerifier double checks attestations on origin. TODO: this needs to become an interface.

func NewAttestationDoubleCheckOnOriginVerifier

func NewAttestationDoubleCheckOnOriginVerifier(
	originDomain domains.DomainClient,
	attestationDomain domains.DomainClient,
	destinationDomain domains.DomainClient,
	db db.SynapseDB,
	bondedSigner signer.Signer,
	unbondedSigner signer.Signer,
	interval time.Duration) AttestationDoubleCheckOnOriginVerifier

NewAttestationDoubleCheckOnOriginVerifier creates a new attestation double-check-on-origin verifier.

func (AttestationDoubleCheckOnOriginVerifier) FindOldestGuardUnsignedAndUnverifiedAttestation

func (a AttestationDoubleCheckOnOriginVerifier) FindOldestGuardUnsignedAndUnverifiedAttestation(ctx context.Context) (types.InProgressAttestation, error)

FindOldestGuardUnsignedAndUnverifiedAttestation fetches the oldest attestation that still needs to be signed by the guard and needs to be verified.

func (AttestationDoubleCheckOnOriginVerifier) Start

func (a AttestationDoubleCheckOnOriginVerifier) Start(ctx context.Context) error

Start starts the OriginAttestationScanner.

type AttestationGuardSigner

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

AttestationGuardSigner signs the attestation after it has been verified on origin. TODO: this needs to become an interface.

func NewAttestationGuardSigner

func NewAttestationGuardSigner(
	originDomain domains.DomainClient,
	attestationDomain domains.DomainClient,
	destinationDomain domains.DomainClient,
	db db.SynapseDB,
	bondedSigner signer.Signer,
	unbondedSigner signer.Signer,
	interval time.Duration) AttestationGuardSigner

NewAttestationGuardSigner creates a new attestation guard signer.

func (AttestationGuardSigner) FindOldestGuardUnsignedAndVerifiedAttestation

func (a AttestationGuardSigner) FindOldestGuardUnsignedAndVerifiedAttestation(ctx context.Context) (types.InProgressAttestation, error)

FindOldestGuardUnsignedAndVerifiedAttestation fetches the oldest attestation that still needs to be signed by the guard but has been verified on origin.

func (AttestationGuardSigner) Start

func (a AttestationGuardSigner) Start(ctx context.Context) error

Start starts the AttestationGuardSigner.

type Guard

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

Guard in the current version scans the attestation collector for notary signed attestations, signs them, and posts to destination chains. TODO: Note right now, I have threads for each origin-destination pair and do no batching at all.

func NewGuard

func NewGuard(ctx context.Context, cfg config.GuardConfig) (_ Guard, err error)

NewGuard creates a new guard.

func (Guard) Start

func (u Guard) Start(ctx context.Context) error

Start starts the guard.