GlcoinCore/loop
1
0
Fork 0
mirror of https://github.com/lightninglabs/loop.git synced 2026-08-13 12:33:03 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

godoc: address copy-paste errors accross the codebase

Browse source
This commit is contained in:
Slyghtning 2026-02-28 10:29:25 +01:00
parent c1036ff705
commit a9977dd5f4
No known key found for this signature in database
GPG key ID: F82D456EA023C9BF
26 changed files with 62 additions and 50 deletions
Download patch file Download diff file Expand all files Collapse all files

2
loopdb/loopin.go
View file

@ -16,7 +16,7 @@ import (
type LoopInContract struct {
SwapContract
// SweepConfTarget specifies the targeted confirmation target for the
// HtlcConfTarget specifies the targeted confirmation target for the
// client sweep tx.
HtlcConfTarget int32

2
loopdb/meta.go
View file

@ -9,7 +9,7 @@ import (
)
var (
// metaBucket stores all the meta information concerning the state of
// metaBucketKey stores all the meta information concerning the state of
// the database.
metaBucketKey = []byte("metadata")

2
loopdb/protocol_version.go
View file

@ -43,7 +43,7 @@ const (
// canceling loop out swaps.
ProtocolVersionLoopOutCancel = 7
// ProtocolVerionProbe indicates that the client is able to request
// ProtocolVersionProbe indicates that the client is able to request
// the server to perform a probe to test inbound liquidty.
ProtocolVersionProbe ProtocolVersion = 8

2
loopdb/store.go
View file

@ -98,7 +98,7 @@ var (
// value: uint32 confirmation value
confirmationsKey = []byte("confirmations")
// liquidtyBucket is a root bucket used to save liquidity manager
// liquidityBucket is a root bucket used to save liquidity manager
// related info.
liquidityBucket = []byte("liquidity")

6
loopdb/store_mock.go
View file

@ -80,7 +80,7 @@ func (s *StoreMock) FetchLoopOutSwaps(ctx context.Context) ([]*LoopOut, error) {
return result, nil
}
// FetchLoopOutSwaps returns all swaps currently in the store.
// FetchLoopOutSwap returns a swap currently in the store.
//
// NOTE: Part of the SwapStore interface.
func (s *StoreMock) FetchLoopOutSwap(ctx context.Context,
@ -261,7 +261,7 @@ func (s *StoreMock) Close() error {
return nil
}
// isDone asserts that the store mock has no pending operations.
// IsDone asserts that the store mock has no pending operations.
func (s *StoreMock) IsDone() error {
select {
case <-s.loopOutStoreChan:
@ -312,7 +312,7 @@ func (s *StoreMock) AssertLoopInStored() {
}
}
// assertLoopInState asserts that a specified state transition is persisted to
// AssertLoopInState asserts that a specified state transition is persisted to
// disk.
func (s *StoreMock) AssertLoopInState(
expectedState SwapState) SwapStateData {

4
loopdb/store_test.go
View file

@ -387,8 +387,8 @@ func TestVersionNew(t *testing.T) {
}
}
// TestVersionNew tests that an existing version zero database is migrated to
// the latest version.
// TestVersionMigrated tests that an existing version zero database is migrated
// to the latest version.
func TestVersionMigrated(t *testing.T) {
tempDirName, err := ioutil.TempDir("", "clientstore")
if err != nil {

4
loopdb/swapstate.go
View file

@ -172,7 +172,7 @@ func (s SwapState) String() string {
// SwapCost is a breakdown of the final swap costs.
type SwapCost struct {
// Swap is the amount paid to the server.
// Server is the amount paid to the server.
Server btcutil.Amount
// Onchain is the amount paid to miners for the onchain tx.
@ -189,7 +189,7 @@ func (s SwapCost) Total() btcutil.Amount {
// SwapStateData is all persistent data to describe the current swap state.
type SwapStateData struct {
// SwapState is the state the swap is in.
// State is the state the swap is in.
State SwapState
// Cost are the accrued (final) costs so far.