package
0.0.0-20240806202947-369a1d73b513
Repository: https://github.com/overclock-validator/keep-core.git
Documentation: pkg.go.dev

# Packages

No description provided by the author

# Functions

DetermineWalletMainUtxo determines the plain-text wallet main UTXO currently registered in the Bridge on-chain contract.
EnsureWalletSyncedBetweenChains makes sure all actions taken by the wallet on the Bitcoin chain are reflected in the host chain Bridge.
Initialize kicks off the TBTC by initializing internal state, ensuring preconditions like staking are met, and then kicking off the internal TBTC implementation.
ParseWalletActionType parses the given value into a WalletActionType.
ValidateDepositSweepProposal checks the deposit sweep proposal with on-chain validation rules and verifies transactions on the Bitcoin chain.
ValidateMovedFundsSweepProposal checks the moved funds sweep proposal with on-chain validation rules.
ValidateMovingFundsProposal checks the moving funds proposal with on-chain validation rules.
ValidateMovingFundsSafetyMargin checks if the moving funds safety margin is in force.
ValidateRedemptionProposal checks the redemption proposal with on-chain validation rules.

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
DepositSweepRequiredFundingTxConfirmations determines the minimum number of confirmations that are needed for a deposit funding Bitcoin transaction in order to consider it a valid part of the deposit sweep proposal.
DKGResultHashCachePeriod is the time period the cache maintains the given DKG result hash.
DKGSeedCachePeriod is the time period the cache maintains the DKG seed corresponding to a DKG instance.
FaultLeaderIdleness is a fault type used when the leader was idle, i.e.
FaultLeaderImpersonation is a fault type used when the leader was impersonated by another operator who raised their own proposal.
FaultLeaderMistake is a fault type used when the leader's proposal turned out to be invalid.
FaultUnknown is a fault type used when the fault type is unknown.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
MovingFundsCommitmentLookBackBlocks is the look-back period in blocks used when searching for submitted moving funds commitment events.
ProtocolName denotes the name of the protocol defined by this package.
RedemptionChangeFirst is a shape where the change output is the first one in the transaction output vector.
RedemptionChangeLast is a shape where the change output is the last one in the transaction output vector.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
WalletClosedCachePeriod is the time period the cache maintains the ID of a closed wallet.

# Variables

No description provided by the author

# Structs

Config carries the config for tBTC protocol.
CoordinationProposalRequest represents a request for a coordination proposal.
Deposit represents a tBTC deposit.
DepositChainRequest represents a deposit request stored on-chain.
DepositRevealedEvent represents a deposit reveal event.
DepositRevealedEventFilter is a component allowing to filter DepositRevealedEvent.
DepositSweepProposal represents a deposit sweep proposal issued by a wallet's coordination leader.
DKGChainResult represents a DKG result submitted to the chain.
DKGParameters contains values of DKG-specific control parameters.
DKGResultApprovedEvent represents a DKG result approval event.
DKGResultChallengedEvent represents a DKG result challenge event.
DKGResultSubmittedEvent represents a DKG result submission event.
DKGStartedEvent represents a DKG start event.
DKGStartedEventFilter is a component allowing to filter DKGStartedEvent.
GroupParameters is a structure grouping TBTC group parameters.
GroupSelectionResult represents a group selection result, i.e.
No description provided by the author
HeartbeatRequestedEvent represents a Bridge heartbeat request event.
InactivityClaim represents an inactivity claim submitted to the chain.
InactivityClaimedEvent represents an inactivity claimed event.
MovedFundsSweepProposal represents a moved funds sweep proposal issued by a wallet's coordination leader.
MovedFundsSweepRequest represents a moved funds sweep request.
MovingFundsCommitmentSubmittedEvent represents a moving funds commitment submitted event.
MovingFundsCommitmentSubmittedEventFilter is a component allowing to filter MovingFundsCommitmentSubmittedEvent.
MovingFundsCompletedEvent represents a moving funds completed event.
MovingFundsCompletedEventFilter is a component allowing to filter MovingFundsCompletedEvent.
MovingFundsProposal represents a moving funds proposal issued by a wallet's coordination leader.
NewWalletRegisteredEvent represents a new wallet registered event.
NewWalletRegisteredEventFilter is a component allowing to filter NewWalletRegisteredEvent.
NoopProposal is a proposal that does not propose any action.
RedemptionProposal represents a redemption proposal issued by a wallet's coordination leader.
RedemptionRequest represents a tBTC redemption request.
RedemptionRequestedEvent represents a redemption requested event.
RedemptionRequestedEventFilter is a component allowing to filter RedemptionRequestedEvent.
WalletChainData represents wallet data stored on-chain.
WalletClosedEvent represents a wallet closed event.

# Interfaces

BridgeChain defines the subset of the TBTC chain interface that pertains specifically to the tBTC Bridge operations.
Chain represents the interface that the TBTC module expects to interact with the anchoring blockchain on.
CoordinationProposal represents a single action proposal for the given wallet.
CoordinationProposalGenerator is a component responsible for generating coordination proposals.
DistributedKeyGenerationChain defines the subset of the TBTC chain interface that pertains specifically to group formation's distributed key generation process.
GroupSelectionChain defines the subset of the TBTC chain interface that pertains to the group selection activities.
No description provided by the author
WalletProposalValidatorChain defines the subset of the TBTC chain interface that pertains specifically to the tBTC wallet proposal validator.

# Type aliases

CalculateWalletIDFunc calculates the ECDSA wallet ID based on the provided wallet public key.
CoordinationFaultType represents a type of the coordination fault.
DKGChainResultHash represents a hash of the DKGChainResult.
No description provided by the author
MovedFundsSweepRequestState represents the state of a moved funds request.
RedemptionTransactionShape is an enum describing the shape of a Bitcoin redemption transaction.
WalletActionType represents actions types that can be performed by a wallet.
WalletState represents the state of a wallet.