neotest/chain: improve comments

pkg/neotest/chain/chain.go

@@ -116,18 +116,27 @@ func init() {
 }
 
 // NewSingle creates new blockchain instance with a single validator and
-// setups cleanup functions.
+// setups cleanup functions. The configuration used is with netmode.UnitTestNet
+// magic, and SecondsPerBlock/MaxTraceableBlocks options defined by constants in
+// this package. MemoryStore is used as the backend storage, so all of the chain
+// contents is always in RAM. The Signer returned is validator (and committee at
+// the same time).
 func NewSingle(t *testing.T) (*core.Blockchain, neotest.Signer) {
 	return NewSingleWithCustomConfig(t, nil)
 }
 
-// NewSingleWithCustomConfig creates new blockchain instance with custom protocol
+// NewSingleWithCustomConfig is similar to NewSingle, but allows to override the
-// configuration and a single validator. It also setups cleanup functions.
+// default configuration.
 func NewSingleWithCustomConfig(t *testing.T, f func(*config.ProtocolConfiguration)) (*core.Blockchain, neotest.Signer) {
 	st := storage.NewMemoryStore()
 	return NewSingleWithCustomConfigAndStore(t, f, st, true)
 }
 
+// NewSingleWithCustomConfigAndStore is similar to NewSingleWithCustomConfig, but
+// also allows to override backend Store being used. The last parameter controls if
+// Run method is called on the Blockchain instance, if not then it's caller's
+// responsibility to do that before using the chain and its caller's responsibility
+// also to properly Close the chain when done.
 func NewSingleWithCustomConfigAndStore(t *testing.T, f func(cfg *config.ProtocolConfiguration), st storage.Store, run bool) (*core.Blockchain, neotest.Signer) {
 	protoCfg := config.ProtocolConfiguration{
 		Magic:              netmode.UnitTestNet,
@@ -151,15 +160,15 @@ func NewSingleWithCustomConfigAndStore(t *testing.T, f func(cfg *config.Protocol
 	return bc, neotest.NewMultiSigner(committeeAcc)
 }
 
-// NewMulti creates new blockchain instance with 4 validators and 6 committee members.
+// NewMulti creates new blockchain instance with four validators and six
-// Second return value is for validator signer, third -- for committee.
+// committee members, otherwise not differring much from NewSingle. The
+// second value returned contains validators Signer, the third -- committee one.
 func NewMulti(t *testing.T) (*core.Blockchain, neotest.Signer, neotest.Signer) {
 	return NewMultiWithCustomConfig(t, nil)
 }
 
-// NewMultiWithCustomConfig creates new blockchain instance with custom protocol
+// NewMultiWithCustomConfig is similar to NewMulti except it allows to override the
-// configuration, 4 validators and 6 committee members. Second return value is
+// default configuration.
-// for validator signer, third -- for committee.
 func NewMultiWithCustomConfig(t *testing.T, f func(*config.ProtocolConfiguration)) (*core.Blockchain, neotest.Signer, neotest.Signer) {
 	protoCfg := config.ProtocolConfiguration{
 		Magic:              netmode.UnitTestNet,