Skip to content

Commit 5f878ac

Browse files
committed
itest: improve comments
Remove inaccurate comments. Rephrase and reword comments for clarity.
1 parent 61f26f4 commit 5f878ac

File tree

4 files changed

+10
-19
lines changed

4 files changed

+10
-19
lines changed

fn/option.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ func (o Option[A]) UnwrapOr(a A) A {
5959
return a
6060
}
6161

62-
// UnwrapPtr is used to extract a reference to a value from an option, and we
62+
// UnwrapToPtr is used to extract a reference to a value from an option, and we
6363
// supply an empty pointer in the case when the Option is empty.
6464
func (o Option[A]) UnwrapToPtr() *A {
6565
var v *A

itest/psbt_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1042,8 +1042,8 @@ func testPsbtMultiSend(t *harnessTest) {
10421042
ctxt, cancel := context.WithTimeout(ctxb, defaultWaitTimeout)
10431043
defer cancel()
10441044

1045-
// Now that we have the asset created, we'll make a new node that'll
1046-
// serve as the node which'll receive the assets.
1045+
// With the asset created, we'll set up a new node that will act as the
1046+
// receiver of the transfer.
10471047
secondTapd := setupTapdHarness(
10481048
t.t, t, t.lndHarness.Bob, t.universeServer,
10491049
)

itest/send_test.go

Lines changed: 5 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -573,7 +573,8 @@ func testBasicSendPassiveAsset(t *harnessTest) {
573573

574574
// testReattemptFailedSendHashmailCourier tests that a failed attempt at
575575
// sending an asset proof will be reattempted by the tapd node. This test
576-
// targets the hashmail courier.
576+
// targets the hashmail courier. The proof courier is specified in the test
577+
// list entry.
577578
func testReattemptFailedSendHashmailCourier(t *harnessTest) {
578579
var (
579580
ctxb = context.Background()
@@ -654,11 +655,6 @@ func testReattemptFailedSendHashmailCourier(t *harnessTest) {
654655

655656
// Simulate a failed attempt at sending the asset proof by stopping
656657
// the receiver node.
657-
//
658-
// The receiving tapd node does not return a proof received confirmation
659-
// message via the universe RPC courier. We can simulate a proof
660-
// transfer failure by stopping the courier service directly and not the
661-
// receiving tapd node.
662658
require.NoError(t.t, t.tapd.stop(false))
663659

664660
// Send asset and then mine to confirm the associated on-chain tx.
@@ -751,11 +747,6 @@ func testReattemptFailedSendUniCourier(t *harnessTest) {
751747

752748
// Simulate a failed attempt at sending the asset proof by stopping
753749
// the proof courier service.
754-
//
755-
// In following the hashmail proof courier protocol, the receiver node
756-
// returns a proof received confirmation message via the courier.
757-
// We can simulate a proof transfer failure by stopping the receiving
758-
// tapd node. The courier service should still be operational.
759750
require.NoError(t.t, t.proofCourier.Stop())
760751

761752
// Send asset and then mine to confirm the associated on-chain tx.
@@ -765,9 +756,9 @@ func testReattemptFailedSendUniCourier(t *harnessTest) {
765756
wg.Wait()
766757
}
767758

768-
// testReattemptFailedReceiveUniCourier tests that a failed attempt at
769-
// receiving an asset proof will be reattempted by the receiving tapd node. This
770-
// test targets the universe proof courier.
759+
// testReattemptFailedReceiveUniCourier ensures that a failed attempt to receive
760+
// an asset proof is retried by the receiving Tapd node. This test focuses on
761+
// the universe proof courier.
771762
func testReattemptFailedReceiveUniCourier(t *harnessTest) {
772763
ctxb := context.Background()
773764

tapdb/multiverse.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -841,8 +841,8 @@ func (b *MultiverseStore) RootNodes(ctx context.Context,
841841
}
842842

843843
// FetchProofLeaf returns a proof leaf for the target key. If the key doesn't
844-
// have a script key specified, then all the proof leafs for the minting
845-
// outpoint will be returned. If neither are specified, then all inserted proof
844+
// have a script key specified, then all the proof leafs for the outpoint will
845+
// be returned. If neither are specified, then all inserted proof
846846
// leafs will be returned.
847847
func (b *MultiverseStore) FetchProofLeaf(ctx context.Context,
848848
id universe.Identifier,

0 commit comments

Comments
 (0)