[Supplier] Implement supplier revenue share

config.yml

@@ -170,7 +170,7 @@ genesis:
     supplier:
       supplierList:
         - owner_address: pokt19a3t4yunp0dlpfjrp7qwnzwlrzd5fzs2gjaaaj
-          address: pokt19a3t4yunp0dlpfjrp7qwnzwlrzd5fzs2gjaaaj
+          operator_address: pokt19a3t4yunp0dlpfjrp7qwnzwlrzd5fzs2gjaaaj
           services:
             - service:
                 id: anvil

docusaurus/docs/operate/configs/supplier_staking_config.md

@@ -11,6 +11,7 @@ a stake transaction required to provide RPC services on Pocket Network._
 - [Reference Example](#reference-example)
 - [Usage](#usage)
 - [Configuration](#configuration)
+  - [`owner_address`](#owner_address)
   - [`stake_amount`](#stake_amount)
   - [`default_rev_share_percent`](#default_rev_share_percent)
   - [`services`](#services)
@@ -45,7 +46,17 @@ poktrolld tx supplier stake-supplier \
 
 ## Configuration
 
-<!-- TODO(#716): `owner_address` will be defined once non-custodial is merged -->
+### `owner_address`
+
+_`Required`_, _`Non-empty`_
+
+```yaml
+owner_address: <address>
+```
+
+The `owner_address` is used as the unique shareholder address for the `Supplier`
+if none of `default_rev_share_percent` or `rev_share_percent` is defined in the
+configuration file.
 
 ### `stake_amount`
 

load-testing/tests/relays_stress_helpers_test.go

@@ -787,9 +787,9 @@ func (s *relaysSuite) addActor(actorAddress string, actorStakeAmount sdk.Coin) *
 // messages in a single supplier transaction.
 func (s *relaysSuite) addPendingStakeSupplierMsg(supplier *accountInfo) {
 	supplier.addPendingMsg(suppliertypes.NewMsgStakeSupplier(
-		supplier.address,
-		supplier.address,
-		supplier.address,
+		supplier.address, // The message signer.
+		supplier.address, // The supplier owner.
+		supplier.address, // The supplier operator.
 		supplier.amountToStake,
 		[]*sharedtypes.SupplierServiceConfig{
 			{

proto/poktroll/service/relay.proto

@@ -27,9 +27,9 @@ message RelayRequestMetadata {
   // TODO_MAINNET: make sure we're checking/verifying this address on-chain (if needed).
   // Relevant conversation: https://github.com/pokt-network/poktroll/pull/567#discussion_r1628722168
   //
-  // The supplier address the relay is sent to. It is being used on the RelayMiner to 
-  // route to the correct supplier.
-  string supplier_address = 3 [(cosmos_proto.scalar) = "cosmos.AddressString"]; // The Bech32 address of the application.
+  // The supplier operator address the relay is sent to. It is being used on the
+  // RelayMiner to route to the correct supplier.
+  string supplier_operator_address = 3 [(cosmos_proto.scalar) = "cosmos.AddressString"]; // The Bech32 address of the application.
 }
 
 // RelayRequest holds the request details for a relay.

proto/poktroll/shared/service.proto

@@ -43,7 +43,7 @@ message SupplierServiceConfig {
   // TODO_MAINNET: Avoid embedding the full Service because we just need the ID.
   Service service = 1; // The Service for which the supplier is configured
   repeated SupplierEndpoint endpoints = 2; // List of endpoints for the service
-  repeated ServiceRevShare rev_share = 3; // List of revenue share configurations for the service
+  repeated ServiceRevenueShare rev_share = 3; // List of revenue share configurations for the service
   // TODO_MAINNET: There is an opportunity for supplier to advertise the min
   // they're willing to earn for a certain configuration/price, but this is outside of scope.
 }
@@ -55,8 +55,8 @@ message SupplierEndpoint {
   repeated ConfigOption configs = 3; // Additional configuration options for the endpoint
 }
 
-// ServiceRevShare message to hold revenue share configuration details
-message ServiceRevShare {
+// ServiceRevenueShare message to hold revenue share configuration details
+message ServiceRevenueShare {
   string address = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"]; // The Bech32 address of the revenue share recipient
   float rev_share_percentage = 2; // The percentage of revenue share the recipient will receive
 }

proto/poktroll/shared/supplier.proto

@@ -14,13 +14,11 @@ message Supplier {
   // By default, this address is the one that receives all the rewards unless owtherwise specified.
   // This property cannot be updated by the operator.
   string owner_address = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"]; // Bech32 cosmos address
-  // The address of the supplier operator (i.e. the one managing the off-chain server).
+  // The operator address of the supplier operator (i.e. the one managing the off-chain server).
   // The operator address can update the supplier's configurations excluding the owner address.
-  // This property do not change over the supplier's lifespan, the supplier must be usnaked
-  // and staked again to update this value.
-  // TODO(#722): Rename this to `operator_address` include all downstream
-  // variables, comments, docs, tests, etc...
-  string address = 2 [(cosmos_proto.scalar) = "cosmos.AddressString"]; // Bech32 cosmos address
+  // This property does not change over the supplier's lifespan, the supplier must be unstaked
+  // and re-staked to effectively update this value.
+  string operator_address = 2 [(cosmos_proto.scalar) = "cosmos.AddressString"]; // Bech32 cosmos address
   cosmos.base.v1beta1.Coin stake = 3; // The total amount of uPOKT the supplier has staked
   repeated SupplierServiceConfig services = 4; // The service configs this supplier can support
   // The session end height at which an actively unbonding supplier unbonds its stake.

proto/poktroll/supplier/tx.proto

@@ -49,7 +49,7 @@ message MsgStakeSupplier {
 
   string signer = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"]; // The Bech32 address of the message signer (i.e. owner or operator)
   string owner_address = 2 [(cosmos_proto.scalar) = "cosmos.AddressString"]; // The Bech32 address of the owner (i.e. custodial, staker)
-  string address = 3 [(cosmos_proto.scalar) = "cosmos.AddressString"]; // The Bech32 address of the operator (i.e. provider, non-custodial)
+  string operator_address = 3 [(cosmos_proto.scalar) = "cosmos.AddressString"]; // The Bech32 address of the operator (i.e. provider, non-custodial)
   cosmos.base.v1beta1.Coin stake = 4; // The total amount of uPOKT the supplier has staked. Must be ≥ to the current amount that the supplier has staked (if any)
   repeated poktroll.shared.SupplierServiceConfig services = 5; // The list of services this supplier is staked to provide service for
 }
@@ -60,7 +60,7 @@ message MsgUnstakeSupplier {
   option (cosmos.msg.v1.signer) = "signer";
 
   string signer = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"]; // The Bech32 address of the message signer (i.e. owner or operator)
-  string address = 2 [(cosmos_proto.scalar) = "cosmos.AddressString"]; // The Bech32 address of the operator (i.e. provider, non-custodial)
+  string operator_address = 2 [(cosmos_proto.scalar) = "cosmos.AddressString"]; // The Bech32 address of the operator (i.e. provider, non-custodial)
 }
 
 message MsgUnstakeSupplierResponse {}

testutil/integration/app.go

@@ -529,12 +529,12 @@ func NewCompleteIntegrationApp(t *testing.T) *App {
 	// Prepare the on-chain supplier
 	supplierStake := types.NewCoin("upokt", math.NewInt(1000000))
 	defaultSupplier := sharedtypes.Supplier{
-		OwnerAddress: supplierAddr.String(),
-		Address:      supplierAddr.String(),
-		Stake:        &supplierStake,
+		OwnerAddress:    supplierOperatorAddr.String(),
+		OperatorAddress: supplierOperatorAddr.String(),
+		Stake:           &supplierStake,
 		Services: []*sharedtypes.SupplierServiceConfig{
 			{
-				RevShare: []*sharedtypes.ServiceRevShare{
+				RevShare: []*sharedtypes.ServiceRevenueShare{
 					{
 						Address:            sample.AccAddress(),
 						RevSharePercentage: 100,

testutil/keeper/tokenomics.go

@@ -122,17 +122,17 @@ func TokenomicsKeeperWithActorAddrs(t testing.TB) (
 	}
 
 	// Prepare the test supplier.
-	supplierAddr = sample.AccAddress()
+	supplierOwnerAddr := sample.AccAddress()
 	supplier := sharedtypes.Supplier{
-		OwnerAddress: supplierAddr,
-		Address:      supplierAddr,
-		Stake:        &sdk.Coin{Denom: "upokt", Amount: math.NewInt(100000)},
+		OwnerAddress:    supplierOwnerAddr,
+		OperatorAddress: supplierOwnerAddr,
+		Stake:           &sdk.Coin{Denom: "upokt", Amount: math.NewInt(100000)},
 		Services: []*sharedtypes.SupplierServiceConfig{
 			{
 				Service: service,
-				RevShare: []*sharedtypes.ServiceRevShare{
+				RevShare: []*sharedtypes.ServiceRevenueShare{
 					{
-						Address:            supplierAddr,
+						Address:            supplierOwnerAddr,
 						RevSharePercentage: 100,
 					},
 				},

testutil/network/network.go

@@ -140,9 +140,9 @@ func DefaultSupplierModuleGenesisState(t *testing.T, n int) *suppliertypes.Genes
 		svcId := fmt.Sprintf("svc%d", i)
 		stake := sdk.NewCoin("upokt", math.NewInt(int64(i)))
 		supplier := sharedtypes.Supplier{
-			OwnerAddress: sample.AccAddress(),
-			Address:      sample.AccAddress(),
-			Stake:        &stake,
+			OwnerAddress:    sample.AccAddress(),
+			OperatorAddress: sample.AccAddress(),
+			Stake:           &stake,
 			Services: []*sharedtypes.SupplierServiceConfig{
 				{
 					Service: &sharedtypes.Service{Id: svcId},
@@ -170,9 +170,9 @@ func SupplierModuleGenesisStateWithAddresses(t *testing.T, addresses []string) *
 	state := suppliertypes.DefaultGenesis()
 	for _, addr := range addresses {
 		supplier := sharedtypes.Supplier{
-			OwnerAddress: sample.AccAddress(),
-			Address:      addr,
-			Stake:        &sdk.Coin{Denom: "upokt", Amount: math.NewInt(10000)},
+			OwnerAddress:    sample.AccAddress(),
+			OperatorAddress: addr,
+			Stake:           &sdk.Coin{Denom: "upokt", Amount: math.NewInt(10000)},
 			Services: []*sharedtypes.SupplierServiceConfig{
 				{
 					Service: &sharedtypes.Service{Id: "svc1"},

x/shared/helpers/service_configs.go

@@ -95,9 +95,14 @@ func ValidateSupplierServiceConfigs(services []*sharedtypes.SupplierServiceConfi
 
 // ValidateServiceRevShare validates the supplier's service revenue share,
 // ensuring that the sum of the revenue share percentages is 100.
-func ValidateServiceRevShare(revShareList []*sharedtypes.ServiceRevShare) error {
+// This function is unit tested via the supplier staking config tests.
+func ValidateServiceRevShare(revShareList []*sharedtypes.ServiceRevenueShare) error {
 	revSharePercentageSum := float32(0)
 
+	if len(revShareList) == 0 {
+		return sharedtypes.ErrSharedInvalidRevShare.Wrap("no rev share configurations")
+	}
+
 	for _, revShare := range revShareList {
 		if revShare == nil {
 			return sharedtypes.ErrSharedInvalidRevShare.Wrap("rev share cannot be nil")

x/shared/types/errors.go

@@ -14,5 +14,5 @@ var (
 	ErrSharedParamInvalid               = sdkerrors.Register(ModuleName, 1103, "the provided param is invalid")
 	ErrSharedEmitEvent                  = sdkerrors.Register(ModuleName, 1104, "failed to emit event")
 	ErrSharedUnauthorizedSupplierUpdate = sdkerrors.Register(ModuleName, 1105, "unauthorized supplier update")
-	ErrSharedInvalidRevShare            = sdkerrors.Register(ModuleName, 1106, "invalid rev share")
+	ErrSharedInvalidRevShare            = sdkerrors.Register(ModuleName, 1106, "invalid revenue share configuration")
 )