doc(backend/sim/wire & wire/net/simple): add documentation for the wi…

…re implementations

Signed-off-by: Minh Huy Tran <[email protected]>

backend/sim/wire/doc.go

@@ -12,5 +12,8 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-// Package wire contains the implementation of the wire interfaces.
+// Package wire contains the simulated implementation of the wire interfaces.
+// This wire package is used for internal tests in the packages channel, wire, client  Note that the Account.Sign and Address.Verify are mock methods.
+// We use the the backend/wire/sim mock implementation for testing other go-perun's functionalities.
+// Our default wire.Account and wire.Address implementations can be found in wire/net/simple and are used for our applications.
 package wire // import "perun.network/go-perun/backend/sim/wire"

wire/net/simple/doc.go

@@ -13,5 +13,5 @@
 // limitations under the License.
 
 // Package simple contains simplistic implementation for the wire.Dialer and
-// wire.Listener interfaces.
+// wire.Listener interfaces. It uses TLS to ensures secure peers' connection
 package simple // import "perun.network/go-perun/wire/net/simple"

wire/net/simple/init.go

@@ -25,9 +25,11 @@ func init() {
 	wire.SetNewAddressFunc(func() wire.Address {
 		return NewAddress("")
 	})
+	// setup for testing purposes
 	test.SetNewRandomAddress(func(rng *rand.Rand) wire.Address {
 		return NewRandomAddress(rng)
 	})
+	// setup for testing purposes
 	test.SetNewRandomAccount(func(rng *rand.Rand) wire.Account {
 		return NewRandomAccount(rng)
 	})

wire/net/simple/simple_exchange_addr_internal_test.go → wire/net/simple/simple_exchange_addr_test.go

@@ -11,6 +11,9 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
+// This tests uses the wire/net/simple implementation of Account and Address
+// to test the default implementation of wire.
+//nolint:testpackage
 
 package simple