contractcourt

Feb 22, 2024

Changes in this version

+ var ErrContractNotFound = fmt.Errorf("unable to locate contract")

+ var ErrImmatureChannel = errors.New(...)

+ func UseBreachLogger(logger slog.Logger)

+ func UseNurseryLogger(logger slog.Logger)

+ type BreachArbiter struct

+ func NewBreachArbiter(cfg *BreachConfig) *BreachArbiter

+ func (b *BreachArbiter) IsBreached(chanPoint *wire.OutPoint) (bool, error)

+ func (b *BreachArbiter) Start() error

+ func (b *BreachArbiter) Stop() error

+ func (b *BreachArbiter) SubscribeBreachComplete(chanPoint *wire.OutPoint, c chan struct{}) (bool, error)

+ type BreachCloseInfo struct

+ CloseSummary channeldb.ChannelCloseSummary

+ CommitHash chainhash.Hash

+ CommitSet CommitSet

+ type BreachConfig struct

+ CloseLink func(*wire.OutPoint, ChannelCloseType)

+ ContractBreaches <-chan *ContractBreachEvent

+ DB *channeldb.ChannelStateDB

+ Estimator chainfee.Estimator

+ GenSweepScript func() ([]byte, error)

+ NetParams *chaincfg.Params

+ Notifier chainntnfs.ChainNotifier

+ PublishTransaction func(*wire.MsgTx, string) error

+ Signer input.Signer

+ Store RetributionStorer

+ type BreachResolution struct

+ FundingOutPoint wire.OutPoint

type ChainArbitratorConfig

+ NotifyFullyResolvedChannel func(point wire.OutPoint)

+ SubscribeBreachComplete func(op *wire.OutPoint, c chan struct{}) (bool, error)

type ChannelArbitratorConfig

+ FetchHistoricalChannel func() (*channeldb.OpenChannel, error)

+ type ChannelCloseType uint8

+ const CloseBreach

+ const CloseRegular

+ type ContractBreachEvent struct

+ BreachRetribution *lnwallet.BreachRetribution

+ ChanPoint wire.OutPoint

+ ProcessACK func(error)

+ type ContractMaturityReport struct

+ Htlcs []HtlcMaturityReport

+ LimboBalance dcrutil.Amount

+ RecoveredBalance dcrutil.Amount

+ func (c *ContractMaturityReport) AddLimboDirectHtlc(kid *kidOutput)

+ func (c *ContractMaturityReport) AddLimboStage1SuccessHtlc(kid *kidOutput)

+ func (c *ContractMaturityReport) AddLimboStage1TimeoutHtlc(baby *babyOutput)

+ func (c *ContractMaturityReport) AddLimboStage2Htlc(kid *kidOutput)

+ func (c *ContractMaturityReport) AddRecoveredHtlc(kid *kidOutput)

type ContractResolutions

+ BreachResolution *BreachResolution

type ContractResolver

+ SupplementState func(*channeldb.OpenChannel)

+ type HtlcMaturityReport struct

+ Amount dcrutil.Amount

+ MaturityHeight uint32

+ Outpoint wire.OutPoint

+ Stage uint32

+ type NurseryConfig struct

+ ChainIO lnwallet.BlockChainIO

+ ConfDepth uint32

+ FetchClosedChannel func(chanID *wire.OutPoint) (*channeldb.ChannelCloseSummary, error)

+ FetchClosedChannels func(pendingOnly bool) ([]*channeldb.ChannelCloseSummary, error)

+ Notifier chainntnfs.ChainNotifier

+ PublishTransaction func(*wire.MsgTx, string) error

+ Store NurseryStorer

+ SweepInput func(input.Input, sweep.Params) (chan sweep.Result, error)

+ type NurseryStore struct

+ func NewNurseryStore(chainHash *chainhash.Hash, db *channeldb.DB) (*NurseryStore, error)

+ func (ns *NurseryStore) CribToKinder(bby *babyOutput) error

+ func (ns *NurseryStore) FetchClass(height uint32) ([]kidOutput, []babyOutput, error)

+ func (ns *NurseryStore) FetchPreschools() ([]kidOutput, error)

+ func (ns *NurseryStore) ForChanOutputs(chanPoint *wire.OutPoint, callback func([]byte, []byte) error, reset func()) error

+ func (ns *NurseryStore) GraduateKinder(height uint32, kid *kidOutput) error

+ func (ns *NurseryStore) HeightsBelowOrEqual(height uint32) ([]uint32, error)

+ func (ns *NurseryStore) Incubate(kids []kidOutput, babies []babyOutput) error

+ func (ns *NurseryStore) IsMatureChannel(chanPoint *wire.OutPoint) (bool, error)

+ func (ns *NurseryStore) ListChannels() ([]wire.OutPoint, error)

+ func (ns *NurseryStore) PreschoolToKinder(kid *kidOutput, lastGradHeight uint32) error

+ func (ns *NurseryStore) RemoveChannel(chanPoint *wire.OutPoint) error

+ type NurseryStorer interface

+ CribToKinder func(*babyOutput) error

+ FetchClass func(height uint32) ([]kidOutput, []babyOutput, error)

+ FetchPreschools func() ([]kidOutput, error)

+ ForChanOutputs func(*wire.OutPoint, func([]byte, []byte) error, func()) error

+ GraduateKinder func(height uint32, output *kidOutput) error

+ HeightsBelowOrEqual func(height uint32) ([]uint32, error)

+ Incubate func([]kidOutput, []babyOutput) error

+ IsMatureChannel func(*wire.OutPoint) (bool, error)

+ ListChannels func() ([]wire.OutPoint, error)

+ PreschoolToKinder func(kid *kidOutput, lastGradHeight uint32) error

+ RemoveChannel func(*wire.OutPoint) error

+ type RetributionStore struct

+ func NewRetributionStore(db kvdb.Backend) *RetributionStore

+ func (rs *RetributionStore) Add(ret *retributionInfo) error

+ func (rs *RetributionStore) ForAll(cb func(*retributionInfo) error, reset func()) error

+ func (rs *RetributionStore) IsBreached(chanPoint *wire.OutPoint) (bool, error)

+ func (rs *RetributionStore) Remove(chanPoint *wire.OutPoint) error

+ type RetributionStorer interface

+ Add func(retInfo *retributionInfo) error

+ ForAll func(cb func(*retributionInfo) error, reset func()) error

+ IsBreached func(chanPoint *wire.OutPoint) (bool, error)

+ Remove func(key *wire.OutPoint) error

+ type UtxoNursery struct

+ func NewUtxoNursery(cfg *NurseryConfig) *UtxoNursery

+ func (u *UtxoNursery) IncubateOutputs(chanPoint wire.OutPoint, outgoingHtlcs []lnwallet.OutgoingHtlcResolution, ...) error

+ func (u *UtxoNursery) NurseryReport(chanPoint *wire.OutPoint) (*ContractMaturityReport, error)

+ func (u *UtxoNursery) RemoveChannel(op *wire.OutPoint) error

+ func (u *UtxoNursery) Start() error

+ func (u *UtxoNursery) Stop() error

Jan 21, 2021

Changes in this version

+ type ArbChannel interface

+ ForceCloseChan func() (*lnwallet.LocalForceCloseSummary, error)

+ NewAnchorResolutions func() ([]*lnwallet.AnchorResolution, error)

type ChainArbitrator

+ func (c *ChainArbitrator) ResolveContract(chanPoint wire.OutPoint) error

type ChainArbitratorConfig

+ Clock clock.Clock

+ IsForwardedHTLC func(chanID lnwire.ShortChannelID, htlcIndex uint64) bool

+ NetParams *chaincfg.Params

+ OnionProcessor OnionProcessor

+ PaymentsExpirationGracePeriod time.Duration

type ChannelArbitratorConfig

+ Channel ArbChannel

+ PutResolverReport func(tx kvdb.RwTx, report *channeldb.ResolverReport) error

type ContractReport

+ Type ReportOutputType

type ContractResolutions

+ AnchorResolution *lnwallet.AnchorResolution

+ type OnionProcessor interface

+ ReconstructHopIterator func(r io.Reader, rHash []byte) (hop.Iterator, error)

+ type ReportOutputType uint8

+ const ReportOutputAnchor

+ const ReportOutputIncomingHtlc

+ const ReportOutputOutgoingHtlc

+ const ReportOutputUnencumbered

+ type ResolverConfig struct

+ Checkpoint func(ContractResolver, ...*channeldb.ResolverReport) error

+ type UtxoSweeper interface

+ CreateSweepTx func(inputs []input.Input, feePref sweep.FeePreference, currentBlockHeight uint32) (*wire.MsgTx, error)

+ RelayFeePerKB func() chainfee.AtomPerKByte

+ SweepInput func(input input.Input, params sweep.Params) (chan sweep.Result, error)

+ UpdateParams func(input wire.OutPoint, params sweep.ParamsUpdate) (chan sweep.Result, error)

Nov 18, 2019

Changes in this version

+ var LocalHtlcSet = HtlcSetKey

+ var RemoteHtlcSet = HtlcSetKey

+ var RemotePendingHtlcSet = HtlcSetKey

type ArbitratorLog

+ FetchConfirmedCommitSet func() (*CommitSet, error)

+ InsertConfirmedCommitSet func(c *CommitSet) error

type ChainActionMap

+ func (c ChainActionMap) Merge(actions ChainActionMap)

type ChainArbitrator

+ func (c *ChainArbitrator) GetChannelArbitrator(chanPoint wire.OutPoint) (*ChannelArbitrator, error)

type ChainArbitratorConfig

+ IncomingBroadcastDelta uint32

+ NotifyClosedChannel func(wire.OutPoint)

+ OutgoingBroadcastDelta uint32

+ Registry Registry

type ChannelArbitrator

+ func (c *ChannelArbitrator) Report() []*ContractReport

+ type CommitSet struct

+ ConfCommitKey *HtlcSetKey

+ HtlcSets map[HtlcSetKey][]channeldb.HTLC

+ func (c *CommitSet) IsEmpty() bool

+ type ContractReport struct

+ Amount dcrutil.Amount

+ Incoming bool

+ LimboBalance dcrutil.Amount

+ MaturityHeight uint32

+ Outpoint wire.OutPoint

+ RecoveredBalance dcrutil.Amount

+ Stage uint32

+ type ContractUpdate struct

+ HtlcKey HtlcSetKey

+ Htlcs []channeldb.HTLC

+ type HtlcSetKey struct

+ IsPending bool

+ IsRemote bool

+ func (h HtlcSetKey) String() string

type LocalUnilateralCloseInfo

+ CommitSet CommitSet

+ type Registry interface

+ HodlUnsubscribeAll func(subscriber chan<- interface{})

+ LookupInvoice func(lntypes.Hash) (channeldb.Invoice, error)

+ NotifyExitHopHtlc func(payHash lntypes.Hash, paidAmount lnwire.MilliAtom, expiry uint32, ...) (*invoices.HodlEvent, error)

+ type RemoteUnilateralCloseInfo struct

+ CommitSet CommitSet

type WitnessBeacon

+ AddPreimages func(preimages ...lntypes.Preimage) error

Apr 23, 2019

Changes in this version

+ const HtlcClaimAction

+ const HtlcFailNowAction

+ const HtlcIncomingWatchAction

+ const HtlcOutgoingWatchAction

+ const HtlcTimeoutAction

+ const NoAction

+ var ErrChainArbExiting = errors.New("ChainArbitrator exiting")

+ func DisableLog()

+ func UseLogger(logger slog.Logger)

+ type ArbitratorLog interface

+ CommitState func(ArbitratorState) error

+ CurrentState func() (ArbitratorState, error)

+ FetchChainActions func() (ChainActionMap, error)

+ FetchContractResolutions func() (*ContractResolutions, error)

+ FetchUnresolvedContracts func() ([]ContractResolver, error)

+ InsertUnresolvedContracts func(...ContractResolver) error

+ LogChainActions func(ChainActionMap) error

+ LogContractResolutions func(*ContractResolutions) error

+ ResolveContract func(ContractResolver) error

+ SwapContract func(old ContractResolver, new ContractResolver) error

+ WipeHistory func() error

+ type ArbitratorState uint8

+ const StateBroadcastCommit

+ const StateCommitmentBroadcasted

+ const StateContractClosed

+ const StateDefault

+ const StateError

+ const StateFullyResolved

+ const StateWaitingFullResolution

+ func (a ArbitratorState) String() string

+ type ChainAction uint8

+ func (c ChainAction) String() string

+ type ChainActionMap map[ChainAction][]channeldb.HTLC

+ type ChainArbitrator struct

+ func NewChainArbitrator(cfg ChainArbitratorConfig, db *channeldb.DB) *ChainArbitrator

+ func (c *ChainArbitrator) ForceCloseContract(chanPoint wire.OutPoint) (*wire.MsgTx, error)

+ func (c *ChainArbitrator) Start() error

+ func (c *ChainArbitrator) Stop() error

+ func (c *ChainArbitrator) SubscribeChannelEvents(chanPoint wire.OutPoint) (*ChainEventSubscription, error)

+ func (c *ChainArbitrator) UpdateContractSignals(chanPoint wire.OutPoint, signals *ContractSignals) error

+ func (c *ChainArbitrator) WatchNewChannel(newChan *channeldb.OpenChannel) error

+ type ChainArbitratorConfig struct

+ BroadcastDelta uint32

+ ChainHash chainhash.Hash

+ ChainIO lnwallet.BlockChainIO

+ ContractBreach func(wire.OutPoint, *lnwallet.BreachRetribution) error

+ DeliverResolutionMsg func(...ResolutionMsg) error

+ DisableChannel func(wire.OutPoint) error

+ FeeEstimator lnwallet.FeeEstimator

+ IncubateOutputs func(wire.OutPoint, *lnwallet.CommitOutputResolution, ...) error

+ IsOurAddress func(dcrutil.Address) bool

+ MarkLinkInactive func(wire.OutPoint) error

+ NewSweepAddr func() ([]byte, error)

+ Notifier chainntnfs.ChainNotifier

+ PreimageDB WitnessBeacon

+ PublishTx func(*wire.MsgTx) error

+ Signer lnwallet.Signer

+ Sweeper *sweep.UtxoSweeper

+ type ChainEventSubscription struct

+ Cancel func()

+ ChanPoint wire.OutPoint

+ ContractBreach chan *lnwallet.BreachRetribution

+ CooperativeClosure chan *CooperativeCloseInfo

+ LocalUnilateralClosure chan *LocalUnilateralCloseInfo

+ RemoteUnilateralClosure chan *lnwallet.UnilateralCloseSummary

+ type ChannelArbitrator struct

+ func NewChannelArbitrator(cfg ChannelArbitratorConfig, startingHTLCs []channeldb.HTLC, log ArbitratorLog) *ChannelArbitrator

+ func (c *ChannelArbitrator) Start() error

+ func (c *ChannelArbitrator) Stop() error

+ func (c *ChannelArbitrator) UpdateContractSignals(newSignals *ContractSignals)

+ type ChannelArbitratorConfig struct

+ BlockEpochs *chainntnfs.BlockEpochEvent

+ ChainEvents *ChainEventSubscription

+ ChanPoint wire.OutPoint

+ CloseType channeldb.ClosureType

+ ClosingHeight uint32

+ ForceCloseChan func() (*lnwallet.LocalForceCloseSummary, error)

+ IsPendingClose bool

+ MarkChannelClosed func(*channeldb.ChannelCloseSummary) error

+ MarkChannelResolved func() error

+ MarkCommitmentBroadcasted func() error

+ ShortChanID lnwire.ShortChannelID

+ type ContractResolutions struct

+ CommitHash chainhash.Hash

+ CommitResolution *lnwallet.CommitOutputResolution

+ HtlcResolutions lnwallet.HtlcResolutions

+ func (c *ContractResolutions) IsEmpty() bool

+ type ContractResolver interface

+ AttachResolverKit func(ResolverKit)

+ Decode func(r io.Reader) error

+ Encode func(w io.Writer) error

+ IsResolved func() bool

+ Resolve func() (ContractResolver, error)

+ ResolverKey func() []byte

+ Stop func()

+ type ContractSignals struct

+ HtlcUpdates chan []channeldb.HTLC

+ ShortChanID lnwire.ShortChannelID

+ type CooperativeCloseInfo struct

+ type LocalUnilateralCloseInfo struct

+ type ResolutionMsg struct

+ Failure lnwire.FailureMessage

+ HtlcIndex uint64

+ PreImage *[32]byte

+ SourceChan lnwire.ShortChannelID

+ type ResolverKit struct

+ Checkpoint func(ContractResolver) error

+ Quit chan struct{}

+ type WitnessBeacon interface

+ AddPreimage func(pre []byte) error

+ LookupPreimage func(payhash []byte) ([]byte, bool)

+ SubscribeUpdates func() *WitnessSubscription

+ type WitnessSubscription struct

+ CancelSubscription func()

+ WitnessUpdates <-chan []byte