Skip to content

Commit a4f59ab

Browse files
committed
chore: minor improvement for docs[skip ci]
Signed-off-by: changgesi <changgesi@outlook.com>
1 parent a4b3c21 commit a4f59ab

6 files changed

Lines changed: 8 additions & 8 deletions

File tree

clightning/clightning_commands.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ func (s *LiquidSendToAddress) LongDescription() string {
173173
return "'"
174174
}
175175

176-
// SwapOut starts a new swapout (paying an Invoice for onchain liquidity)
176+
// SwapOut starts a new swapout (paying an invoice for onchain liquidity)
177177
type SwapOut struct {
178178
ShortChannelId string `json:"short_channel_id"`
179179
SatAmt uint64 `json:"amt_sat"`

lnd/client.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ import (
2525
)
2626

2727
// Client combines multiple methods, functions and watchers to a service that
28-
// is consumed by the swap service. Client fulfils the swap.LightningClient
28+
// is consumed by the swap service. Client fulfills the swap.LightningClient
2929
// interface.
3030
// TODO: Rework the swap.LightningClient interface to separate the watchers from
3131
// the client service. This will make it easier to test and more modular to use.

lnd/connect.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,13 @@ import (
1818
)
1919

2020
const (
21-
// defaultGrpcBackoffTime is the linear back off time between failing grpc
21+
// defaultGrpcBackoffTime is the linear backoff time between failing grpc
2222
// calls (also server side stream) to the lnd node.
2323
defaultGrpcBackoffTime = 30 * time.Second
2424

2525
// defaultMaxGrpcRetries is the amount of retries we take if the grpc
2626
// connection to the lnd node drops for some reason or if the resource is
27-
// exhausted. With the defaultGrpcBackoffTime and a constant back off
27+
// exhausted. With the defaultGrpcBackoffTime and a constant backoff
2828
// strategy this leads to 10 hours of retry.
2929
defaultMaxGrpcRetries = 1200
3030
)
@@ -34,7 +34,7 @@ var (
3434
// error, on which we retry our call (and server side stream) to the lnd
3535
// node. The codes represent:
3636
// - Unavailable: The service is currently unavailable. This is most
37-
// likely a transient condition, which can be correctesd by
37+
// likely a transient condition, which can be corrected by
3838
// retrying with a backoff. Note that it is not always safe
3939
// to retry non-idempotent operations.
4040
//

lnd/txwatcher.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -273,7 +273,7 @@ func (t *TxWatcher) AddWaitForCsvTx(swapId string, txId string, vout uint32, hei
273273
// We use a confirmation number of 144 here as this is the maximum supported
274274
// by lnd. Lnd assumes this to be a good value after which it is unlikely
275275
// for a tx to be reorganized out of the chain.
276-
// This means that we have to count the blocks after this by our self.
276+
// This means that we have to count the blocks after this ourselves.
277277
// TODO: Ask lnd why we can not listen longer?
278278
confChan, errChan, err := t.addTxWatcher(ctx, swapId, txId, 144, heightHint, script)
279279
if err != nil {

messages/sender.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ func (s *RedundantMessenger) SendMessage(peerId string, message []byte, messageT
5454
}
5555
}()
5656

57-
// This function returns an error to fulfil the Messenger interface.
57+
// This function returns an error to fulfill the Messenger interface.
5858
return nil
5959
}
6060

misc_tests/liquid_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -697,7 +697,7 @@ func Test_RpcWalletCoop(t *testing.T) {
697697
t.Fatal(err)
698698
}
699699
700-
// todo muss ins protocol
700+
// todo must be in protocol
701701
if !bytes.Equal(ubRes.Asset, lbtc) {
702702
703703
}

0 commit comments

Comments
 (0)