Versions in this module Expand all Collapse all v1 v1.1.3 Sep 20, 2021 v1.1.2 Sep 20, 2021 Changes in this version + const BaseSupplyUnit + const CurrentBatchVersion + const DefaultBatchVersion + const DefaultMinNodeTier + const LegacyLeaseDurationBucket + const MaxBatchIDHistoryLookup + const MinimumOrderDurationBlocks + const Subsystem + var DefaultBatchStepTimeout = 15 * time.Second + var ErrMismatchErr = errors.New("batch verification result mismatch") + var ErrVersionMismatch = fmt.Errorf("version %d mismatches server version", CurrentBatchVersion) + var FeeRateTotalParts = 1e9 + var MinNoDustAccountSize = minNoDustAccountSize() + func ChannelOutput(batchTx *wire.MsgTx, wallet lndclient.WalletKitClient, ourOrder Order, ...) (*wire.TxOut, uint32, error) + func EstimateTraderFee(numTraderChans uint32, feeRate chainfee.SatPerKWeight) btcutil.Amount + func PendingChanKey(askNonce, bidNonce Nonce) [32]byte + func PerBlockPremium(amt btcutil.Amount, fixedRate uint32) float64 + func UseLogger(logger btclog.Logger) + type AccountDiff struct + AccountKey *btcec.PublicKey + AccountKeyRaw [33]byte + EndingBalance btcutil.Amount + EndingState auctioneerrpc.AccountDiff_AccountState + OutpointIndex int32 + type AccountTally struct + EndingBalance btcutil.Amount + NumChansCreated uint32 + TotalExecutionFeesPaid btcutil.Amount + TotalMakerFeesAccrued btcutil.Amount + TotalTakerFeesPaid btcutil.Amount + func (t *AccountTally) CalcMakerDelta(feeSchedule terms.FeeSchedule, price FixedRatePremium, ...) btcutil.Amount + func (t *AccountTally) CalcTakerDelta(feeSchedule terms.FeeSchedule, price FixedRatePremium, ...) btcutil.Amount + func (t *AccountTally) ChainFees(feeRate chainfee.SatPerKWeight) + type Ask struct + func (a *Ask) Digest() ([sha256.Size]byte, error) + func (a *Ask) ReservedValue(feeSchedule terms.FeeSchedule) btcutil.Amount + func (a *Ask) Type() Type + type Batch struct + AccountDiffs []*AccountDiff + BatchTX *wire.MsgTx + BatchTxFeeRate chainfee.SatPerKWeight + ClearingPrices map[uint32]FixedRatePremium + ExecutionFee terms.FeeSchedule + FeeRebate btcutil.Amount + ID BatchID + MatchedOrders map[Nonce][]*MatchedOrder + Version BatchVersion + func ParseRPCBatch(prepareMsg *auctioneerrpc.OrderMatchPrepare) (*Batch, error) + type BatchID [33]byte + func DecrementingBatchIDs(startKey, endKey *btcec.PublicKey) []BatchID + func NewBatchID(pub *btcec.PublicKey) BatchID + type BatchSignature map[[33]byte]*btcec.Signature + type BatchSigner interface + Sign func(*Batch) (BatchSignature, error) + type BatchStorer interface + MarkBatchComplete func() error + StorePendingBatch func(_ *Batch, bestHeight uint32) error + type BatchVerifier interface + Verify func(*Batch) error + type BatchVersion uint32 + type Bid struct + MinNodeTier NodeTier + SelfChanBalance btcutil.Amount + SidecarTicket *sidecar.Ticket + func (b *Bid) Digest() ([sha256.Size]byte, error) + func (b *Bid) ReservedValue(feeSchedule terms.FeeSchedule) btcutil.Amount + func (b *Bid) Type() Type + func (b *Bid) ValidateSelfChanBalance() error + type Fetcher func(Nonce) (Order, error) + type FixedRatePremium uint32 + func (f FixedRatePremium) LumpSumPremium(amt btcutil.Amount, durationBlocks uint32) btcutil.Amount + type Kit struct + AcctKey [33]byte + Amt btcutil.Amount + FixedRate uint32 + LeaseDuration uint32 + MaxBatchFeeRate chainfee.SatPerKWeight + MinUnitsMatch SupplyUnit + MultiSigKeyLocator keychain.KeyLocator + Preimage lntypes.Preimage + State State + Units SupplyUnit + UnitsUnfulfilled SupplyUnit + Version Version + func NewKit(nonce Nonce) *Kit + func NewKitWithPreimage(preimage lntypes.Preimage) *Kit + func ParseRPCOrder(version, leaseDuration uint32, details *poolrpc.Order) (*Kit, error) + func ParseRPCServerOrder(version uint32, details *auctioneerrpc.ServerOrder, orderIsAsk bool, ...) (*Kit, [33]byte, []net.Addr, [33]byte, error) + func (k *Kit) Details() *Kit + func (k *Kit) Nonce() Nonce + type Manager struct + func NewManager(cfg *ManagerConfig) *Manager + func (m *Manager) BatchFinalize(batchID BatchID) error + func (m *Manager) BatchSign(bestHeight uint32) (BatchSignature, error) + func (m *Manager) HasPendingBatch() bool + func (m *Manager) OrderMatchValidate(batch *Batch) error + func (m *Manager) OurNodePubkey() ([33]byte, error) + func (m *Manager) PendingBatch() *Batch + func (m *Manager) PrepareOrder(ctx context.Context, order Order, acct *account.Account, ...) (*ServerOrderParams, error) + func (m *Manager) Start() error + func (m *Manager) Stop() + type ManagerConfig struct + AcctStore account.Store + Lightning lndclient.LightningClient + Signer lndclient.SignerClient + Store Store + Wallet lndclient.WalletKitClient + type MatchState uint8 + const MatchStateAccepted + const MatchStateFinalized + const MatchStatePrepare + const MatchStateRejected + const MatchStateSigned + func (s MatchState) String() string + type MatchedOrder struct + MultiSigKey [33]byte + NodeAddrs []net.Addr + NodeKey [33]byte + Order Order + UnitsFilled SupplyUnit + func ParseRPCMatchedOrders(orders *auctioneerrpc.MatchedOrder) ([]*MatchedOrder, error) + func ParseRPCServerAsk(details *auctioneerrpc.ServerAsk) (*MatchedOrder, error) + func ParseRPCServerBid(details *auctioneerrpc.ServerBid) (*MatchedOrder, error) + type MismatchErr struct + func (m *MismatchErr) Error() string + func (m *MismatchErr) Unwrap() error + type Modifier func(*Kit) + func StateModifier(state State) Modifier + func UnitsFulfilledModifier(newUnfulfilledUnits SupplyUnit) Modifier + type NodeTier uint32 + const NodeTier0 + const NodeTier1 + const NodeTierDefault + func (n NodeTier) String() string + type Nonce [32]byte + var ErrInsufficientBalance = errors.New("insufficient account balance") + var ZeroNonce Nonce + func (n Nonce) String() string + type Order interface + Details func() *Kit + Digest func() ([sha256.Size]byte, error) + Nonce func() Nonce + ReservedValue func(feeSchedule terms.FeeSchedule) btcutil.Amount + Type func() Type + type Quote struct + RatePerBlock float64 + TotalExecutionFee btcutil.Amount + TotalPremium btcutil.Amount + WorstCaseChainFee btcutil.Amount + func NewQuote(amt, minChanAmt btcutil.Amount, rate FixedRatePremium, leaseDuration uint32, ...) *Quote + type ServerOrderParams struct + Addrs []net.Addr + MultiSigKey [33]byte + NodePubkey [33]byte + RawSig []byte + type State uint8 + const StateCanceled + const StateCleared + const StateExecuted + const StateExpired + const StateFailed + const StatePartiallyFilled + const StateSubmitted + func (s State) Archived() bool + func (s State) String() string + type Store interface + GetOrder func(Nonce) (Order, error) + GetOrders func() ([]Order, error) + MarkBatchComplete func() error + StorePendingBatch func(_ *Batch, orders []Nonce, orderModifiers [][]Modifier, ...) error + SubmitOrder func(Order) error + UpdateOrder func(Nonce, ...Modifier) error + UpdateOrders func([]Nonce, [][]Modifier) error + type SupplyUnit uint64 + func NewSupplyFromSats(sats btcutil.Amount) SupplyUnit + func RoundToNextSupplyUnit(sats btcutil.Amount) SupplyUnit + func (s SupplyUnit) ToSatoshis() btcutil.Amount + type Type uint8 + const TypeAsk + const TypeBid + func (t Type) String() string + type UserError struct + Details *auctioneerrpc.InvalidOrder + FailMsg string + func (e *UserError) Error() string + type Version uint32 + const VersionDefault + const VersionLeaseDurationBuckets + const VersionNodeTierMinMatch + const VersionSelfChanBalance + const VersionSidecarChannel