client

Documentation

Overview

Package client defines ECDSA keep client.

Index

• type Config
  • func (c *Config) GetAwaitingKeyGenerationLookback() time.Duration
  • func (c *Config) GetKeyGenerationTimeout() time.Duration
  • func (c *Config) GetSigningTimeout() time.Duration
• type Handle
  • func Initialize(ctx context.Context, operatorPublicKey *operator.PublicKey, ...) *Handle
  • func (h *Handle) TSSPreParamsPoolSize() int

Types

type Config

type Config struct {
	// Defines the look-back period to check if existing, active keeps are awaiting
	// signer generation on the client start. The client does not check keeps older
	// than the look-back value.
	AwaitingKeyGenerationLookback configtime.Duration

	// Timeout for key generation and signature calculation.
	KeyGenerationTimeout configtime.Duration
	SigningTimeout       configtime.Duration
}

Config contains configuration for tss protocol execution.

func (*Config) GetAwaitingKeyGenerationLookback

func (c *Config) GetAwaitingKeyGenerationLookback() time.Duration

GetAwaitingKeyGenerationLookback returns a look-back period to check if existing, active keeps are awaiting signer generation. If a value is not set it returns a default value.

func (*Config) GetKeyGenerationTimeout

func (c *Config) GetKeyGenerationTimeout() time.Duration

GetKeyGenerationTimeout returns key generation timeout. If a value is not set it returns a default value.

func (*Config) GetSigningTimeout

func (c *Config) GetSigningTimeout() time.Duration

GetSigningTimeout returns signature calculation timeout. If a value is not set it returns a default value.

type Handle

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

Handle represents a handle to the ECDSA client.

func Initialize

func Initialize(
	ctx context.Context,
	operatorPublicKey *operator.PublicKey,
	hostChain chain.Handle,
	networkProvider net.Provider,
	persistence persistence.Handle,
	derivationIndexStorage *recovery.DerivationIndexStorage,
	clientConfig *Config,
	tbtcConfig *tbtc.Config,
	tssConfig *tss.Config,
) *Handle

Initialize initializes the ECDSA client with rules related to events handling. Expects a slice of sanctioned applications selected by the operator for which operator will be registered as a member candidate.

func (*Handle) TSSPreParamsPoolSize

func (h *Handle) TSSPreParamsPoolSize() int

TSSPreParamsPoolSize returns the current size of the TSS params pool.