update docs and tests (#620)

* update README 
* add md files
* update tests
* fix scrips

Author: semyon-dev

CONTRIBUTING.md

@@ -0,0 +1,45 @@
+# Contributing
+
+We are always glad to receive contribution to the development of our project from the community!
+
+## Issues
+
+If you find a bug or want to suggest an improvement to support some new functionality, 
+create an issue in the repository.
+
+### Issue must include the following information:
+
+- **Title**. Come up with a title that concisely describes the task.
+
+- **Description**. Describe the issue in as much detail as possible. If you want to implement new functionality, 
+describe why it is useful and how it will affect the project's codebase.
+
+- **Code reference**. If this is a bug, be sure to attach the code where the error occurs and the text of the error.
+
+- **Steps to reproduce**. If this is a bug, describe the steps to reproduce the bug and in what case it occurs
+(here it is also advisable to add the code that you run).
+
+- **Labels**. Add the labels that describe the issue. Please refer to the 
+[label list](https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/managing-labels#about-default-labels)
+to learn more about labels.
+
+## Pull requests
+
+> Before creating a pull request, make sure there is an issue corresponding to your changes. If there isn't one, 
+> [create one first](#issues).
+
+If you want to implement a feature or fix a bug, fork this repository from the `master` and after all the changes 
+[create a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) 
+to the `master` branch. Don't forget to run automated tests locally before creating a PR.
+
+### Pull request must include the following information:
+
+- **Title**. The pull request should be named after the issue number as follows: "Issue <ISSUE_NUMBER>"
+
+- **Description**. Briefly describe the feature or fix that was made.
+
+- **Changes**. Describe the main changes made in the codebase. It is advisable to insert links to the code for 
+greater clarity.
+
+- **Interface changes**. Describe how the external interface has changed. It is advisable to insert links to 
+the code for greater clarity.

README.md

@@ -71,7 +71,8 @@ can be set via environment variables or command line parameters see [table
 below](#table_conf). Use `--config` parameter with any command to set configuration file name. By default daemon
 use configuration file in JSON format `snetd.config.json` but other formats are
 also supported via [Viper](https://github.com/spf13/viper). Use `init-full` or `init`
-command to save configuration file with default values. The following configuration properties can be set using a configuration file.
+command to save configuration file with default values. The following configuration properties can be set using a
+configuration file.
 
 ### Main properties <a name="main_properties"></a>
 
@@ -125,21 +126,25 @@ These parameters are needed if you specified free_calls in the service metadata.
 
 * **private_key_for_free_calls** (required) —
   The private key is used to sign authorization tokens for free calls. This address is NOT required to have any tokens.
-  
-  ⚠️ This private key must correspond to the public address specified in your service_metadata.json under the free_calls.public_key field.
 
-  
-* **trusted_free_call_signers** (optional, default SingularityNET addresses) — A list of trusted public addresses that are allowed to issue free call tokens on your behalf (e.g. trusted centralized backends or marketplaces).
+  ⚠️ This private key must correspond to the public address specified in your service_metadata.json under the
+  free_calls.public_key field.
 
-  ⚠️  If this field is left empty, free calls will not work via the SingularityNET Marketplace, but will still be available for clients using the Web3 approach (e.g., via SDKs).
+
+* **trusted_free_call_signers** (optional, default SingularityNET addresses) — A list of trusted public addresses that
+  are allowed to issue free call tokens on your behalf (e.g. trusted centralized backends or marketplaces).
+
+  ⚠️ If this field is left empty, free calls will not work via the SingularityNET Marketplace, but will still be
+  available for clients using the Web3 approach (e.g., via SDKs).
 
   ```json
   "trusted_free_call_signers": [
   "0x7DF35C98f41F3Af0df1dc4c7F7D4C19a71Dd059F",
   "0x3Bb9b2499c283cec176e7C707Ecb495B7a961ebf" ]
   ```
 
-* **min_balance_for_free_call** (optional, default 10) — The minimum token (FET) balance (in whole tokens) required on the user's wallet to be eligible for free calls (Web3-based flow).
+* **min_balance_for_free_call** (optional, default 10) — The minimum token (FET) balance (in whole tokens) required on
+  the user's wallet to be eligible for free calls (Web3-based flow).
   ```json
   "min_balance_for_free_call": "1"
   ```
@@ -223,6 +228,14 @@ This options are less frequently needed.
 * **metering_endpoint** (optional; only applies if `metering_enabled` is set to true) —
   Needs to be a vaild url where the request and response stats are published as part of Metering
 
+* **private_key_for_metering** (optional; only applies if `metering_enabled` is set to true)
+  This is used for authentication between daemon and the metering service in the context publishing stats, Even the
+  latest Channel Status is published, this way the offline channel state balance can also be tracked.
+  Daemon will send a signature signed by this private key, metering service will already have the public key
+  corresponding
+  to this Daemon, metering service will ensure that the signer it receives matches the public key configured at its end.
+  This is mandatory only when metering is enabled.
+
 * **ssl_cert** (optional; default: `""`) —
   path to certificate to use for SSL.
 
@@ -238,14 +251,6 @@ This options are less frequently needed.
 * **payment_channel_storage_server** (optional) —
   see [etcd server configuration](./etcddb#etcd-server-configuration)
 
-* **pvt_key_for_metering** (optional;only applies if `metering_enabled` is set to true)
-  This is used for authentication between daemon and the metering service in the context publishing stats, Even the
-  latest Channel Status is published, this way the offline channel state balance can also be tracked.
-  Daemon will send a signature signed by this private key, metering service will already have the public key
-  corresponding
-  to this Daemon, metering service will ensure that the signer it receives matches the public key configured at its end.
-  This is mandatory only when metering is enabled.
-
 * **rate_limit_per_minute** (optional; default: `Infinity`) —
   see [rate limiting configuration](./ratelimit/README.md)
 

SECURITY.md

@@ -0,0 +1,7 @@
+# Reporting Security Vulnerability
+
+The SingularityNET team and community appreciate your efforts to responsibly disclose your findings, and will make every effort to acknowledge your contributions.
+
+Only latest release version is supported. Ensure that you tested latest version before reporting vulnerability.
+
+If you find a bug or have a question, you are free to open an issue. If you have a security related question or want to report a security vulnerability, please send it to [security@singualritynet.io](mailto:security@singualritynet.io).

config/version_test.go

@@ -54,7 +54,7 @@ func Test_getBuildTime(t *testing.T) {
 }
 
 func TestCheckVersionOfDaemon(t *testing.T) {
-	versionTag = "v5.1.2"
+	versionTag = "not-latest"
 	message, err := CheckVersionOfDaemon()
 	assert.NotNil(t, err)
 	assert.Contains(t, err.Error(), "there is a newer version of the Daemon")

scripts/build

@@ -38,10 +38,10 @@ fi
 CGO_ENABLED=0 GOOS=$1 GOARCH=$2 go build -ldflags "
 -s -w
 -X google.golang.org/protobuf/reflect/protoregistry.conflictPolicy=ignore
--X github.com/singnet/snet-daemon/v5/config.sha1Revision=$githash
--X github.com/singnet/snet-daemon/v5/config.versionTag=$3
--X github.com/singnet/snet-daemon/v5/config.buildTime=$now
--X 'github.com/singnet/snet-daemon/v5/config.networkIdNameMapping=$networkJson'
+-X github.com/singnet/snet-daemon/v6/config.sha1Revision=$githash
+-X github.com/singnet/snet-daemon/v6/config.versionTag=$3
+-X github.com/singnet/snet-daemon/v6/config.buildTime=$now
+-X 'github.com/singnet/snet-daemon/v6/config.networkIdNameMapping=$networkJson'
 " -o build/"$buildname" snetd/main.go
 popd
 

scripts/powershell/build.ps1

@@ -19,7 +19,7 @@ if ($args.Count -lt 3)
 
 $GOOS = $args[0] # linux
 $GOARCH = $args[1] # amd64
-$Version = $args[2] # v5.1.2
+$Version = $args[2] # v6.0.0
 
 # change directory
 Push-Location $ParentPath
@@ -63,10 +63,10 @@ if ($GOOS -eq "windows")
 $Env:CGO_ENABLED = 0; $Env:GOOS = $GOOS; $Env:GOARCH = $GOARCH; go build -ldflags "
 -s -w
 -X google.golang.org/protobuf/reflect/protoregistry.conflictPolicy=ignore
--X github.com/singnet/snet-daemon/v5/config.sha1Revision=$GitHash
--X github.com/singnet/snet-daemon/v5/config.versionTag=$Version
--X github.com/singnet/snet-daemon/v5/config.buildTime=$Now
--X 'github.com/singnet/snet-daemon/v5/config.networkIdNameMapping=$NetworkJson'" -o (Join-Path $BuildDirectory $BuildName) snetd/main.go
+-X github.com/singnet/snet-daemon/v6/config.sha1Revision=$GitHash
+-X github.com/singnet/snet-daemon/v6/config.versionTag=$Version
+-X github.com/singnet/snet-daemon/v6/config.buildTime=$Now
+-X 'github.com/singnet/snet-daemon/v6/config.networkIdNameMapping=$NetworkJson'" -o (Join-Path $BuildDirectory $BuildName) snetd/main.go
 
 # return to previous directory
 Pop-Location

training/service_test.go

@@ -388,10 +388,11 @@ func (suite *DaemonServiceSuite) createAdditionalTestModel(modelName string, aut
 }
 
 func (suite *DaemonServiceSuite) TestDaemonService_GetModel() {
-	testAuthCreads := createTestAuthDetails(suite.currentBlock, "get_model")
-	badTestAuthCreads := creatBadTestAuthDetails(suite.currentBlock)
+	suite.currentBlock, _ = suite.blockchain.CurrentBlock() // update block
+	testAuthCreds := createTestAuthDetails(suite.currentBlock, "get_model")
+	badTestAuthCreds := creatBadTestAuthDetails(suite.currentBlock)
 
-	// check without request
+	// check without a request
 	response1, err := suite.daemonService.GetModel(context.WithValue(context.Background(), "method", "get_model"), nil)
 	assert.ErrorContains(suite.T(), err, ErrNoAuthorization.Error())
 	assert.Equal(suite.T(), Status_ERRORED, response1.Status)
@@ -407,7 +408,7 @@ func (suite *DaemonServiceSuite) TestDaemonService_GetModel() {
 
 	// check with bad auth
 	request3 := &CommonRequest{
-		Authorization: badTestAuthCreads,
+		Authorization: badTestAuthCreds,
 		ModelId:       "test_2_no_access",
 	}
 	response3, err := suite.daemonService.GetModel(context.WithValue(context.Background(), "method", "get_model"), request3)
@@ -416,7 +417,7 @@ func (suite *DaemonServiceSuite) TestDaemonService_GetModel() {
 
 	// check modelId is not empty string
 	request4 := &CommonRequest{
-		Authorization: testAuthCreads,
+		Authorization: testAuthCreds,
 		ModelId:       "",
 	}
 	response4, err := suite.daemonService.GetModel(context.WithValue(context.Background(), "method", "get_model"), request4)
@@ -425,29 +426,29 @@ func (suite *DaemonServiceSuite) TestDaemonService_GetModel() {
 	assert.Equal(suite.T(), Status_ERRORED, response4.Status)
 
 	b, _ := suite.blockchain.CurrentBlock()
-	testAuthCreads = createTestAuthDetails(b, "get_model")
+	testAuthCreds = createTestAuthDetails(b, "get_model")
 	// check without access to model
 	request5 := &CommonRequest{
-		Authorization: testAuthCreads,
+		Authorization: testAuthCreds,
 		ModelId:       "test_2_no_access",
 	}
 	response5, err := suite.daemonService.GetModel(context.WithValue(context.Background(), "method", "get_model"), request5)
 	assert.ErrorContains(suite.T(), err, ErrAccessToModel.Error())
 	assert.Equal(suite.T(), &ModelResponse{}, response5)
 
-	// check access to public model
+	// check access to the public model
 	request6 := &CommonRequest{
-		Authorization: testAuthCreads,
+		Authorization: testAuthCreds,
 		ModelId:       "test_1",
 	}
 	response6, err := suite.daemonService.GetModel(context.WithValue(context.Background(), "method", "get_model"), request6)
 	assert.Nil(suite.T(), err)
 	assert.NotEmpty(suite.T(), response6)
 	assert.Equal(suite.T(), true, response6.IsPublic)
 
-	//check access to non public model
+	//check access to the non-public model
 	request7 := &CommonRequest{
-		Authorization: testAuthCreads,
+		Authorization: testAuthCreds,
 		ModelId:       "test_3",
 	}
 	response7, err := suite.daemonService.GetModel(context.WithValue(context.Background(), "method", "get_model"), request7)

training/training.proto

@@ -1,7 +1,7 @@
 syntax = "proto3";
 import "google/protobuf/descriptor.proto";  // Required for indicators to work
 package training;
-option go_package = "github.com/singnet/snet-daemon/v5/training";
+option go_package = "github.com/singnet/snet-daemon/v6/training";
 
 // Methods that the service provider must implement
 service Model {

training/training_daemon.proto

@@ -5,7 +5,7 @@ import "google/protobuf/descriptor.proto";  // Required for indicators to work
 import "google/protobuf/struct.proto";     // Required for google.protobuf.ListValue
 import "training.proto";
 import "google/protobuf/empty.proto";
-option go_package = "github.com/singnet/snet-daemon/v5/training";
+option go_package = "github.com/singnet/snet-daemon/v6/training";
 
 message AuthorizationDetails {
   // Check for relevance within a range of +/- N blocks