[Service] NIT followups to AddService in #316

.gitignore

@@ -40,6 +40,7 @@ localnet/*/config/*.json
 .vscode
 .env
 .idea/
+.mise.local.toml
 
 # Compiled protos
 **/*.pb.go

docs/static/openapi.yml

@@ -47279,14 +47279,12 @@ paths:
                                         - GRPC
                                         - WEBSOCKET
                                         - JSON_RPC
-                                        - REST
                                       default: UNKNOWN_RPC
                                       description: |-
                                         - UNKNOWN_RPC: Undefined RPC type
                                          - GRPC: gRPC
                                          - WEBSOCKET: WebSocket
                                          - JSON_RPC: JSON-RPC
-                                         - REST: REST
                                     configs:
                                       type: array
                                       items:
@@ -77807,14 +77805,12 @@ definitions:
                                 - GRPC
                                 - WEBSOCKET
                                 - JSON_RPC
-                                - REST
                               default: UNKNOWN_RPC
                               description: |-
                                 - UNKNOWN_RPC: Undefined RPC type
                                  - GRPC: gRPC
                                  - WEBSOCKET: WebSocket
                                  - JSON_RPC: JSON-RPC
-                                 - REST: REST
                             configs:
                               type: array
                               items:
@@ -78061,14 +78057,12 @@ definitions:
                             - GRPC
                             - WEBSOCKET
                             - JSON_RPC
-                            - REST
                           default: UNKNOWN_RPC
                           description: |-
                             - UNKNOWN_RPC: Undefined RPC type
                              - GRPC: gRPC
                              - WEBSOCKET: WebSocket
                              - JSON_RPC: JSON-RPC
-                             - REST: REST
                         configs:
                           type: array
                           items:
@@ -78215,7 +78209,6 @@ definitions:
        - GRPC: gRPC
        - WEBSOCKET: WebSocket
        - JSON_RPC: JSON-RPC
-       - REST: REST
     title: Enum to define RPC types
   pocket.shared.Supplier:
     type: object
@@ -78284,7 +78277,6 @@ definitions:
                        - GRPC: gRPC
                        - WEBSOCKET: WebSocket
                        - JSON_RPC: JSON-RPC
-                       - REST: REST
                   configs:
                     type: array
                     items:
@@ -78343,7 +78335,6 @@ definitions:
            - GRPC: gRPC
            - WEBSOCKET: WebSocket
            - JSON_RPC: JSON-RPC
-           - REST: REST
       configs:
         type: array
         items:
@@ -78416,7 +78407,6 @@ definitions:
                  - GRPC: gRPC
                  - WEBSOCKET: WebSocket
                  - JSON_RPC: JSON-RPC
-                 - REST: REST
             configs:
               type: array
               items:

go.mod

@@ -24,7 +24,6 @@ require (
 	github.com/athanorlabs/go-dleq v0.1.0
 	github.com/cometbft/cometbft v0.37.2
 	github.com/cometbft/cometbft-db v0.8.0
-	github.com/cosmos/cosmos-proto v1.0.0-beta.2
 	github.com/cosmos/cosmos-sdk v0.47.3
 	github.com/cosmos/gogoproto v1.4.11
 	github.com/cosmos/ibc-go/v7 v7.1.0
@@ -48,7 +47,6 @@ require (
 	golang.org/x/crypto v0.15.0
 	golang.org/x/exp v0.0.0-20230905200255-921286631fa9
 	golang.org/x/sync v0.5.0
-	google.golang.org/genproto/googleapis/api v0.0.0-20230913181813-007df8e322eb
 	google.golang.org/grpc v1.59.0
 	gopkg.in/yaml.v2 v2.4.0
 )
@@ -92,6 +90,7 @@ require (
 	github.com/containerd/cgroups v1.1.0 // indirect
 	github.com/coreos/go-systemd/v22 v22.5.0 // indirect
 	github.com/cosmos/btcutil v1.0.5 // indirect
+	github.com/cosmos/cosmos-proto v1.0.0-beta.2 // indirect
 	github.com/cosmos/go-bip39 v1.0.0 // indirect
 	github.com/cosmos/gogogateway v1.2.0 // indirect
 	github.com/cosmos/iavl v0.20.0 // indirect
@@ -286,6 +285,7 @@ require (
 	google.golang.org/api v0.143.0 // indirect
 	google.golang.org/appengine v1.6.7 // indirect
 	google.golang.org/genproto v0.0.0-20230913181813-007df8e322eb // indirect
+	google.golang.org/genproto/googleapis/api v0.0.0-20230913181813-007df8e322eb // indirect
 	google.golang.org/genproto/googleapis/rpc v0.0.0-20230920204549-e6e6cdab5c13 // indirect
 	google.golang.org/protobuf v1.31.0 // indirect
 	gopkg.in/ini.v1 v1.67.0 // indirect

pkg/relayer/proxy/relay_verifier.go

@@ -6,6 +6,7 @@ import (
 	sdkerrors "cosmossdk.io/errors"
 	ring_secp256k1 "github.com/athanorlabs/go-dleq/secp256k1"
 	ring "github.com/noot/ring-go"
+
 	"github.com/pokt-network/poktroll/x/service/types"
 	sharedtypes "github.com/pokt-network/poktroll/x/shared/types"
 )

proto/pocket/service/genesis.proto

@@ -3,10 +3,12 @@ package pocket.service;
 
 import "gogoproto/gogo.proto";
 import "pocket/service/params.proto";
+import "pocket/shared/service.proto";
 
 option go_package = "github.com/pokt-network/poktroll/x/service/types";
 
 // GenesisState defines the service module's genesis state.
 message GenesisState {
   Params params = 1 [(gogoproto.nullable) = false];
+  repeated pocket.shared.Service service_list = 2 [(gogoproto.nullable) = false];
 }

proto/pocket/service/query.proto

@@ -3,7 +3,6 @@ package pocket.service;
 
 import "gogoproto/gogo.proto";
 import "google/api/annotations.proto";
-import "cosmos/base/query/v1beta1/pagination.proto";
 import "pocket/service/params.proto";
 
 option go_package = "github.com/pokt-network/poktroll/x/service/types";
@@ -23,4 +22,4 @@ message QueryParamsRequest {}
 message QueryParamsResponse {
   // params holds all the parameters of this module.
   Params params = 1 [(gogoproto.nullable) = false];
-}
+}

proto/pocket/service/relay.proto

@@ -1,8 +1,6 @@
 syntax = "proto3";
 package pocket.service;
 
-import "cosmos_proto/cosmos.proto";
-import "pocket/application/application.proto";
 import "pocket/session/session.proto";
 
 option go_package = "github.com/pokt-network/poktroll/x/service/types";

proto/pocket/service/tx.proto

@@ -2,15 +2,28 @@ syntax = "proto3";
 
 package pocket.service;
 
+import "cosmos/msg/v1/msg.proto";
+import "cosmos_proto/cosmos.proto";
+import "gogoproto/gogo.proto";
+import "pocket/shared/service.proto";
+
 option go_package = "github.com/pokt-network/poktroll/x/service/types";
 
 // Msg defines the Msg service.
 service Msg {
   rpc AddService (MsgAddService) returns (MsgAddServiceResponse);
 }
 
+// MsgAddService defines a message for adding a new message to the network.
+// Services can be added by any actor in the network making them truly
+// permissionless.
+// TODO_DOCUMENT(@h5law): This is a key function in making services
+// permissionless, document it's usage and design - in docusaurus covering how
+// the entire process works.
 message MsgAddService {
-  string address = 1;
+  option (cosmos.msg.v1.signer) = "address"; // https://docs.cosmos.network/main/build/building-modules/messages-and-queries
+  string address = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"]; // The Bech32 address of the service supplier using cosmos' ScalarDescriptor
+  shared.Service service = 2 [(gogoproto.nullable) = false]; // The Service for which the supplier is adding to the network
 }
 
 message MsgAddServiceResponse {}

x/service/client/cli/tx_add_service.go

@@ -6,18 +6,27 @@ import (
 	"github.com/cosmos/cosmos-sdk/client"
 	"github.com/cosmos/cosmos-sdk/client/flags"
 	"github.com/cosmos/cosmos-sdk/client/tx"
-	"github.com/pokt-network/poktroll/x/service/types"
 	"github.com/spf13/cobra"
+
+	"github.com/pokt-network/poktroll/x/service/types"
 )
 
 var _ = strconv.Itoa(0)
 
 func CmdAddService() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:   "add-service",
-		Short: "Broadcast message add-service",
-		Args:  cobra.ExactArgs(0),
+		Use:   "add-service <service_id> <service_name>",
+		Short: "Add a new service to the network",
+		Long: `Add a new service to the network that will be available for applications,
+gateways and suppliers to use. The service id MUST be unique - or the command
+will fail, however the name you use to describe it does not have to be unique.
+
+Example:
+$ poktrolld tx service add-service "svc1" "service_one" --keyring-backend test --from $(SUPPLIER) --node $(POCKET_NODE) --home=$(POKTROLLD_HOME)`,
+		Args: cobra.ExactArgs(2),
 		RunE: func(cmd *cobra.Command, args []string) (err error) {
+			serviceIdStr := args[0]
+			serviceNameStr := args[1]
 
 			clientCtx, err := client.GetClientTxContext(cmd)
 			if err != nil {
@@ -26,6 +35,8 @@ func CmdAddService() *cobra.Command {
 
 			msg := types.NewMsgAddService(
 				clientCtx.GetFromAddress().String(),
+				serviceIdStr,
+				serviceNameStr,
 			)
 			if err := msg.ValidateBasic(); err != nil {
 				return err

x/service/client/cli/tx_add_service_test.go

@@ -0,0 +1,142 @@
+package cli_test
+
+import (
+	"fmt"
+	"testing"
+
+	sdkerrors "cosmossdk.io/errors"
+	sdkmath "cosmossdk.io/math"
+	"github.com/cosmos/cosmos-sdk/client/flags"
+	"github.com/cosmos/cosmos-sdk/testutil"
+	clitestutil "github.com/cosmos/cosmos-sdk/testutil/cli"
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	"github.com/pokt-network/poktroll/testutil/network"
+	"github.com/pokt-network/poktroll/x/service/client/cli"
+	"github.com/pokt-network/poktroll/x/service/types"
+	sharedtypes "github.com/pokt-network/poktroll/x/shared/types"
+	"github.com/stretchr/testify/require"
+	"google.golang.org/grpc/status"
+)
+
+func TestCLI_AddService(t *testing.T) {
+	net := network.New(t, network.DefaultConfig())
+	val := net.Validators[0]
+	ctx := val.ClientCtx
+
+	// Create a keyring and add an account for the address adding the service
+	kr := ctx.Keyring
+	accounts := testutil.CreateKeyringAccounts(t, kr, 1)
+	account := accounts[0]
+
+	// Update the context with the new keyring
+	ctx = ctx.WithKeyring(kr)
+
+	// Common args used for all requests
+	commonArgs := []string{
+		fmt.Sprintf("--%s=true", flags.FlagSkipConfirmation),
+		fmt.Sprintf("--%s=%s", flags.FlagBroadcastMode, flags.BroadcastSync),
+		fmt.Sprintf(
+			"--%s=%s",
+			flags.FlagFees,
+			sdk.NewCoins(sdk.NewCoin(net.Config.BondDenom, sdkmath.NewInt(10))).String(),
+		),
+	}
+
+	// Initialize the Supplier account by sending it some funds from the
+	// validator account that is part of genesis
+	network.InitAccountWithSequence(t, net, account.Address, 1)
+
+	// Wait for a new block to be committed
+	require.NoError(t, net.WaitForNextBlock())
+
+	// Prepare two valid services
+	svc1 := sharedtypes.Service{
+		Id:   "svc1",
+		Name: "service name",
+	}
+	svc2 := sharedtypes.Service{
+		Id:   "svc2",
+		Name: "service name 2",
+	}
+	// Add svc2 to the network
+	args := []string{
+		svc2.Id,
+		svc2.Name,
+		fmt.Sprintf("--%s=%s", flags.FlagFrom, account.Address.String()),
+	}
+	args = append(args, commonArgs...)
+	_, err := clitestutil.ExecTestCLICmd(ctx, cli.CmdAddService(), args)
+	require.NoError(t, err)
+
+	tests := []struct {
+		desc            string
+		supplierAddress string
+		service         sharedtypes.Service
+		err             *sdkerrors.Error
+	}{
+		{
+			desc:            "valid - add new service",
+			supplierAddress: account.Address.String(),
+			service:         svc1,
+		},
+		{
+			desc:            "invalid - missing service id",
+			supplierAddress: account.Address.String(),
+			service:         sharedtypes.Service{Name: "service name"}, // ID intentionally omitted
+			err:             types.ErrServiceMissingID,
+		},
+		{
+			desc:            "invalid - missing service name",
+			supplierAddress: account.Address.String(),
+			service:         sharedtypes.Service{Id: "svc1"}, // Name intentionally omitted
+			err:             types.ErrServiceMissingName,
+		},
+		{
+			desc:            "invalid - invalid supplier address",
+			supplierAddress: "invalid address",
+			service:         svc1,
+			err:             types.ErrServiceInvalidAddress,
+		},
+		{
+			desc:            "invalid - service already staked",
+			supplierAddress: account.Address.String(),
+			service:         svc2,
+			err:             types.ErrServiceAlreadyExists,
+		},
+	}
+
+	// Run the tests
+	for _, tt := range tests {
+		t.Run(tt.desc, func(t *testing.T) {
+			// Wait for a new block to be committed
+			require.NoError(t, net.WaitForNextBlock())
+
+			// Prepare the arguments for the CLI command
+			args := []string{
+				tt.service.Id,
+				tt.service.Name,
+				fmt.Sprintf("--%s=%s", flags.FlagFrom, tt.supplierAddress),
+			}
+			args = append(args, commonArgs...)
+
+			// Execute the command
+			addServiceOutput, err := clitestutil.ExecTestCLICmd(ctx, cli.CmdAddService(), args)
+
+			// Validate the error if one is expected
+			if tt.err != nil {
+				stat, ok := status.FromError(tt.err)
+				require.True(t, ok)
+				require.Contains(t, stat.Message(), tt.err.Error())
+				return
+			}
+			require.NoError(t, err)
+
+			// Check the response
+			var resp sdk.TxResponse
+			require.NoError(t, net.Config.Codec.UnmarshalJSON(addServiceOutput.Bytes(), &resp))
+			require.NotNil(t, resp)
+			require.NotNil(t, resp.TxHash)
+			require.Equal(t, uint32(0), resp.Code)
+		})
+	}
+}

x/service/genesis.go

@@ -9,6 +9,10 @@ import (
 
 // InitGenesis initializes the module's state from a provided genesis state.
 func InitGenesis(ctx sdk.Context, k keeper.Keeper, genState types.GenesisState) {
+	// Set all the initial services
+	for _, service := range genState.ServiceList {
+		k.SetService(ctx, service)
+	}
 	// this line is used by starport scaffolding # genesis/module/init
 	k.SetParams(ctx, genState.Params)
 }
@@ -18,6 +22,7 @@ func ExportGenesis(ctx sdk.Context, k keeper.Keeper) *types.GenesisState {
 	genesis := types.DefaultGenesis()
 	genesis.Params = k.GetParams(ctx)
 
+	genesis.ServiceList = k.GetAllServices(ctx)
 	// this line is used by starport scaffolding # genesis/module/export
 
 	return genesis