Support setting a nav attribute on metadata scopes

CHANGELOG.md

@@ -41,6 +41,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
 
 * Add the ibcratelimit module [#1498](https://github.com/provenance-io/provenance/issues/1498).
 * Add NAV support for metadata scopes [#1749](https://github.com/provenance-io/provenance/issues/1749).
+* Add fix for NAV units to tourmaline upgrade handler [#1815](https://github.com/provenance-io/provenance/issues/1815).
 
 ### Improvements
 

client/docs/swagger-ui/swagger.yaml

@@ -39701,12 +39701,6 @@ paths:
                         custom method
 
                         signatures required by gogoproto.
-                    volume:
-                      type: string
-                      format: uint64
-                      title: >-
-                        volume is the number of tokens of that the scope was
-                        purchased for the price
                     updated_block_height:
                       type: string
                       format: uint64
@@ -85888,12 +85882,6 @@ definitions:
 
           NOTE: The amount field is an Int which implements the custom method
           signatures required by gogoproto.
-      volume:
-        type: string
-        format: uint64
-        title: >-
-          volume is the number of tokens of that the scope was purchased for the
-          price
       updated_block_height:
         type: string
         format: uint64
@@ -86739,12 +86727,6 @@ definitions:
                 method
 
                 signatures required by gogoproto.
-            volume:
-              type: string
-              format: uint64
-              title: >-
-                volume is the number of tokens of that the scope was purchased
-                for the price
             updated_block_height:
               type: string
               format: uint64

docs/proto-docs.md

@@ -5895,7 +5895,6 @@ NetAssetValue defines a scope's net asset value
 | Field | Type | Label | Description |
 | ----- | ---- | ----- | ----------- |
 | `price` | [cosmos.base.v1beta1.Coin](#cosmos.base.v1beta1.Coin) |  | price is the complete value of the asset's volume |
-| `volume` | [uint64](#uint64) |  | volume is the number of tokens of that the scope was purchased for the price |
 | `updated_block_height` | [uint64](#uint64) |  | updated_block_height is the block height of last update |
 
 
@@ -8313,7 +8312,6 @@ MsgWriteScopeRequest is the request type for the Msg/WriteScope RPC method.
 | `scope_uuid` | [string](#string) |  | scope_uuid is an optional uuid string, e.g. "91978ba2-5f35-459a-86a7-feca1b0512e0" If provided, it will be used to generate the MetadataAddress for the scope which will override the scope_id in the provided scope. If not provided (or it is an empty string), nothing special happens. If there is a value in scope.scope_id that is different from the one created from this uuid, an error is returned. |
 | `spec_uuid` | [string](#string) |  | spec_uuid is an optional scope specification uuid string, e.g. "dc83ea70-eacd-40fe-9adf-1cf6148bf8a2" If provided, it will be used to generate the MetadataAddress for the scope specification which will override the specification_id in the provided scope. If not provided (or it is an empty string), nothing special happens. If there is a value in scope.specification_id that is different from the one created from this uuid, an error is returned. |
 | `usd_mills` | [uint64](#uint64) |  | usd_mills value of scope in usd mills (1234 = $1.234) used for net asset value |
-| `volume` | [uint64](#uint64) |  | volume value of scope used for net asset value |
 
 
 

proto/provenance/metadata/v1/events.proto

@@ -180,6 +180,5 @@ message EventOSLocatorDeleted {
 message EventSetNetAssetValue {
   string scope_id = 1;
   string price    = 2;
-  string volume   = 3;
-  string source   = 4;
+  string source   = 3;
 }

proto/provenance/metadata/v1/scope.proto

@@ -258,8 +258,6 @@ message AuditFields {
 message NetAssetValue {
   // price is the complete value of the asset's volume
   cosmos.base.v1beta1.Coin price = 1 [(gogoproto.nullable) = false];
-  // volume is the number of tokens of that the scope was purchased for the price
-  uint64 volume = 2;
   // updated_block_height is the block height of last update
-  uint64 updated_block_height = 3;
+  uint64 updated_block_height = 2;
 }

proto/provenance/metadata/v1/tx.proto

@@ -112,9 +112,7 @@ message MsgWriteScopeRequest {
   string spec_uuid = 4 [(gogoproto.moretags) = "yaml:\"spec_uuid\""];
 
   // usd_mills value of scope in usd mills (1234 = $1.234) used for net asset value
-  uint64 usd_mills = 12;
-  // volume value of scope used for net asset value
-  uint64 volume = 13;
+  uint64 usd_mills = 5;
 }
 
 // MsgWriteScopeResponse is the response type for the Msg/WriteScope RPC method.

x/marker/client/cli/tx.go

@@ -1113,7 +1113,7 @@ func ParseAccessGrantFromString(addressPermissionString string) []types.AccessGr
 	return grants
 }
 
-// ParseNetAssetValueString splits string (example address1,perm1,perm2...;address2, perm1...) to list of NetAssetValue's
+// ParseNetAssetValueString splits string (example 1hotdog,1;2jackthecat100,...) to list of NetAssetValue's
 func ParseNetAssetValueString(netAssetValuesString string) ([]types.NetAssetValue, error) {
 	navs := strings.Split(netAssetValuesString, ";")
 	if len(navs) == 1 && len(navs[0]) == 0 {

x/metadata/client/cli/cli_test.go

@@ -2148,24 +2148,6 @@ func (s *IntegrationCLITestSuite) TestScopeTxCommands() {
 			},
 			expectErrMsg: "parties can only be optional when require_party_rollup = true",
 		},
-		{
-			name: "usd mills present without volume",
-			cmd:  cli.WriteScopeCmd(),
-			args: []string{
-				metadatatypes.ScopeMetadataAddress(uuid.New()).String(),
-				scopeSpecID,
-				fmt.Sprintf("%s,servicer,opt;%s,owner", s.accountAddrStr, s.accountAddrStr),
-				s.accountAddrStr,
-				s.accountAddrStr,
-				fmt.Sprintf("--%s", cli.FlagRequirePartyRollup),
-				fmt.Sprintf("--%s=%s", flags.FlagFrom, s.accountAddrStr),
-				fmt.Sprintf("--%s=true", flags.FlagSkipConfirmation),
-				fmt.Sprintf("--%s=%s", flags.FlagBroadcastMode, flags.BroadcastBlock),
-				fmt.Sprintf("--%s=%s", flags.FlagFees, sdk.NewCoins(sdk.NewCoin(s.cfg.BondDenom, sdk.NewInt(10))).String()),
-				fmt.Sprintf("--%s=%s", cli.FlagUsdMills, "10"),
-			},
-			expectErrMsg: "incorrect value for volume flag.  Must be positive number if usd-mills flag has been set to positive value",
-		},
 		{
 			name: "should successfully write scope with optional party and rollup",
 			cmd:  cli.WriteScopeCmd(),
@@ -2181,7 +2163,6 @@ func (s *IntegrationCLITestSuite) TestScopeTxCommands() {
 				fmt.Sprintf("--%s=%s", flags.FlagBroadcastMode, flags.BroadcastBlock),
 				fmt.Sprintf("--%s=%s", flags.FlagFees, sdk.NewCoins(sdk.NewCoin(s.cfg.BondDenom, sdk.NewInt(10))).String()),
 				fmt.Sprintf("--%s=%s", cli.FlagUsdMills, "blah"),
-				fmt.Sprintf("--%s=%s", cli.FlagVolume, "1"),
 			},
 			expectErrMsg: `invalid argument "blah" for "--usd-mills" flag: strconv.ParseUint: parsing "blah": invalid syntax`,
 		},
@@ -2200,26 +2181,6 @@ func (s *IntegrationCLITestSuite) TestScopeTxCommands() {
 				fmt.Sprintf("--%s=%s", flags.FlagBroadcastMode, flags.BroadcastBlock),
 				fmt.Sprintf("--%s=%s", flags.FlagFees, sdk.NewCoins(sdk.NewCoin(s.cfg.BondDenom, sdk.NewInt(10))).String()),
 				fmt.Sprintf("--%s=%s", cli.FlagUsdMills, "10"),
-				fmt.Sprintf("--%s=%s", cli.FlagVolume, "blah"),
-			},
-			expectErrMsg: `invalid argument "blah" for "--volume" flag: strconv.ParseUint: parsing "blah": invalid syntax`,
-		},
-		{
-			name: "should successfully write scope with optional party and rollup",
-			cmd:  cli.WriteScopeCmd(),
-			args: []string{
-				metadatatypes.ScopeMetadataAddress(uuid.New()).String(),
-				scopeSpecID,
-				fmt.Sprintf("%s,servicer,opt;%s,owner", s.accountAddrStr, s.accountAddrStr),
-				s.accountAddrStr,
-				s.accountAddrStr,
-				fmt.Sprintf("--%s", cli.FlagRequirePartyRollup),
-				fmt.Sprintf("--%s=%s", flags.FlagFrom, s.accountAddrStr),
-				fmt.Sprintf("--%s=true", flags.FlagSkipConfirmation),
-				fmt.Sprintf("--%s=%s", flags.FlagBroadcastMode, flags.BroadcastBlock),
-				fmt.Sprintf("--%s=%s", flags.FlagFees, sdk.NewCoins(sdk.NewCoin(s.cfg.BondDenom, sdk.NewInt(10))).String()),
-				fmt.Sprintf("--%s=%s", cli.FlagUsdMills, "10"),
-				fmt.Sprintf("--%s=%s", cli.FlagVolume, "1"),
 			},
 			expectErrMsg: "",
 			expectedCode: 0,
@@ -3919,11 +3880,11 @@ func (s *IntegrationCLITestSuite) TestGetCmdAddNetAssetValues() {
 		{
 			name:   "invalid net asset string",
 			args:   argsWStdFlags(scopeID, "invalid"),
-			expErr: "invalid net asset value, expected coin,volume",
+			expErr: "invalid coin invalid",
 		},
 		{
 			name:   "address not meta address",
-			args:   argsWStdFlags("notmetaaddress", "1usd,1"),
+			args:   argsWStdFlags("notmetaaddress", "1usd"),
 			expErr: `invalid metadata address "notmetaaddress": decoding bech32 failed: invalid separator index -1`,
 		},
 		{
@@ -3933,7 +3894,11 @@ func (s *IntegrationCLITestSuite) TestGetCmdAddNetAssetValues() {
 		},
 		{
 			name: "successful",
-			args: argsWStdFlags(scopeID, "1usd,1"),
+			args: argsWStdFlags(scopeID, "1usd"),
+		},
+		{
+			name: "successful with multi net asset values",
+			args: argsWStdFlags(scopeID, "1usd,2jackthecat"),
 		},
 	}
 
@@ -4003,33 +3968,21 @@ func (s *IntegrationCLITestSuite) TestParseNetAssertValueString() {
 		},
 		{
 			name:           "invalid coin",
-			netAssetValues: "notacoin,1",
+			netAssetValues: "notacoin",
 			expErr:         "invalid coin notacoin",
 			expResult:      []types.NetAssetValue{},
 		},
-		{
-			name:           "invalid volume string",
-			netAssetValues: "1hotdog,invalidvolume",
-			expErr:         "invalid volume invalidvolume",
-			expResult:      []types.NetAssetValue{},
-		},
-		{
-			name:           "invalid amount of args",
-			netAssetValues: "1hotdog,invalidvolume,notsupposedtobehere",
-			expErr:         "invalid net asset value, expected coin,volume",
-			expResult:      []types.NetAssetValue{},
-		},
 		{
 			name:           "successfully parse single nav",
-			netAssetValues: "1hotdog,10",
+			netAssetValues: "1hotdog",
 			expErr:         "",
-			expResult:      []types.NetAssetValue{{Price: sdk.NewInt64Coin("hotdog", 1), Volume: 10}},
+			expResult:      []types.NetAssetValue{{Price: sdk.NewInt64Coin("hotdog", 1)}},
 		},
 		{
 			name:           "successfully parse multi nav",
-			netAssetValues: "1hotdog,10;20jackthecat,40",
+			netAssetValues: "1hotdog,20jackthecat",
 			expErr:         "",
-			expResult:      []types.NetAssetValue{{Price: sdk.NewInt64Coin("hotdog", 1), Volume: 10}, {Price: sdk.NewInt64Coin("jackthecat", 20), Volume: 40}},
+			expResult:      []types.NetAssetValue{{Price: sdk.NewInt64Coin("hotdog", 1)}, {Price: sdk.NewInt64Coin("jackthecat", 20)}},
 		},
 	}
 	for _, tc := range testCases {

x/metadata/client/cli/tx.go

@@ -2,9 +2,7 @@
 
 import (
 	"encoding/base64"
-	"errors"
 	"fmt"
-	"strconv"
 	"strings"
 
 	"github.com/google/uuid"
@@ -26,7 +24,6 @@
 	AddSwitch              = "add"
 	RemoveSwitch           = "remove"
 	FlagUsdMills           = "usd-mills"
-	FlagVolume             = "volume"
 )
 
 // NewTxCmd is the top-level command for Metadata CLI transactions.
@@ -70,8 +67,8 @@
 		RemoveRecordCmd(),
 
 		SetAccountDataCmd(),
 
 		GetCmdAddNetAssetValues(),
 	)
 
 	return txCmd
@@ -142,19 +139,10 @@
 
 			usdMills, err := cmd.Flags().GetUint64(FlagUsdMills)
 			if err != nil {
 				return fmt.Errorf("incorrect value for %s flag.  Accepted: 0 or greater value Error: %w", FlagUsdMills, err)
 			}
 
-			volume, err := cmd.Flags().GetUint64(FlagVolume)
-			if err != nil {
-				return fmt.Errorf("incorrect value for %s flag.  Accepted: 0 or greater value Error: %w", FlagVolume, err)
-			}
-
-			if usdMills > 0 && volume == 0 {
-				return fmt.Errorf("incorrect value for %s flag.  Must be positive number if %s flag has been set to positive value", FlagVolume, FlagUsdMills)
-			}
-
-			msg := types.NewMsgWriteScopeRequest(scope, signers, usdMills, volume)
+			msg := types.NewMsgWriteScopeRequest(scope, signers, usdMills)
 			err = msg.ValidateBasic()
 			if err != nil {
 				return err
@@ -168,7 +156,6 @@
 	addSignersFlagToCmd(cmd)
 	flags.AddTxFlagsToCmd(cmd)
 	cmd.Flags().Uint64(FlagUsdMills, 0, "Indicates the net asset value of scope in usd mills, i.e. 1234 = $1.234")
-	cmd.Flags().Uint64(FlagVolume, 0, "Indicates the volume of the net asset value")
 	return cmd
 }
 
@@ -1283,8 +1270,8 @@
 		RunE: func(cmd *cobra.Command, args []string) error {
 			clientCtx, err := client.GetClientTxContext(cmd)
 			if err != nil {
 				return err
 			}
 
 			scopeID, err := types.MetadataAddressFromBech32(args[0])
 			if err != nil {
@@ -1300,13 +1287,13 @@
 			}
 			signers, err := parseSigners(cmd, &clientCtx)
 			if err != nil {
 				return err
 			}
 
 			msg := types.NewMsgAddNetAssetValuesRequest(scopeID.String(), signers, netAssetValues)
 			if err := msg.ValidateBasic(); err != nil {
 				return err
 			}
 
 			return tx.GenerateOrBroadcastTxCLI(clientCtx, cmd.Flags(), msg)
 		},
@@ -1352,27 +1339,20 @@
 	return addr, nil
 }
 
-// ParseNetAssetValueString splits string (example address1,perm1,perm2...;address2, perm1...) to list of NetAssetValue's
+// ParseNetAssetValueString splits string (example 1hotdog,2jackthecat) to list of NetAssetValue's
 func ParseNetAssetValueString(netAssetValuesString string) ([]types.NetAssetValue, error) {
-	navs := strings.Split(netAssetValuesString, ";")
+	navs := strings.Split(netAssetValuesString, ",")
 	if len(navs) == 1 && len(navs[0]) == 0 {
 		return []types.NetAssetValue{}, nil
 	}
 	netAssetValues := make([]types.NetAssetValue, len(navs))
 	for i, nav := range navs {
-		parts := strings.Split(nav, ",")
-		if len(parts) != 2 {
-			return []types.NetAssetValue{}, errors.New("invalid net asset value, expected coin,volume")
-		}
-		coin, err := sdk.ParseCoinNormalized(parts[0])
-		if err != nil {
-			return []types.NetAssetValue{}, fmt.Errorf("invalid coin %s", parts[0])
-		}
-		volume, err := strconv.ParseUint(parts[1], 10, 64)
+
+		coin, err := sdk.ParseCoinNormalized(nav)
 		if err != nil {
-			return []types.NetAssetValue{}, fmt.Errorf("invalid volume %s", parts[1])
+			return []types.NetAssetValue{}, fmt.Errorf("invalid coin %s", nav)
 		}
-		netAssetValues[i] = types.NewNetAssetValue(coin, volume)
+		netAssetValues[i] = types.NewNetAssetValue(coin)
 	}
 	return netAssetValues, nil
 }

x/metadata/handler_test.go

@@ -117,7 +117,7 @@ func (s *MetadataHandlerTestSuite) TestAddAndDeleteScopeDataAccess() {
 		},
 		{
 			"setup test with new scope",
-			types.NewMsgWriteScopeRequest(*scope, []string{s.user1}, 0, 0),
+			types.NewMsgWriteScopeRequest(*scope, []string{s.user1}, 0),
 			[]string{s.user1},
 			"",
 		},
@@ -277,7 +277,7 @@ func (s *MetadataHandlerTestSuite) TestAddAndDeleteScopeOwners() {
 		},
 		{
 			"setup test with new scope",
-			types.NewMsgWriteScopeRequest(*scope, []string{s.user1}, 0, 0),
+			types.NewMsgWriteScopeRequest(*scope, []string{s.user1}, 0),
 			[]string{s.user1},
 			"",
 		},

x/metadata/keeper/genesis.go

@@ -63,14 +63,14 @@
 	}
 
 	for _, mNavs := range data.NetAssetValues {
 		for _, nav := range mNavs.NetAssetValues {
 			address, err := types.MetadataAddressFromBech32(mNavs.Address)
 			if err != nil {
 				panic(err)
 			}
-			err = k.SetNetAssetValue(ctx, address, types.NewNetAssetValue(nav.Price, nav.Volume), types.ModuleName)
+			err = k.SetNetAssetValue(ctx, address, types.NewNetAssetValue(nav.Price), types.ModuleName)
 			if err != nil {
 				panic(err)
 			}
 		}
 	}
@@ -147,21 +147,21 @@
 		panic(err)
 	}
 
 	markerNetAssetValues := make([]types.MarkerNetAssetValues, len(scopes))
 	for i := range scopes {
 		var markerNavs types.MarkerNetAssetValues
 		var navs []types.NetAssetValue
 		err := k.IterateNetAssetValues(ctx, scopes[i].ScopeId, func(nav types.NetAssetValue) (stop bool) {
 			navs = append(navs, nav)
 			return false
 		})
 		if err != nil {
 			panic(err)
 		}
 		markerNavs.Address = scopes[i].ScopeId.String()
 		markerNavs.NetAssetValues = navs
 		markerNetAssetValues[i] = markerNavs
 	}
 
 	return types.NewGenesisState(params, oslocatorparams, scopes, sessions, records, scopeSpecs, contractSpecs, recordSpecs, objectStoreLocators, markerNetAssetValues)
 }

x/metadata/keeper/msg_server.go

@@ -44,11 +44,11 @@
 		return nil, sdkerrors.ErrInvalidRequest.Wrap(err.Error())
 	}
 
-	nav := types.NewNetAssetValue(sdk.NewInt64Coin(types.UsdDenom, int64(msg.UsdMills)), msg.Volume)
+	nav := types.NewNetAssetValue(sdk.NewInt64Coin(types.UsdDenom, int64(msg.UsdMills)))
 	err := k.AddSetNetAssetValues(ctx, msg.Scope.ScopeId, []types.NetAssetValue{nav}, types.ModuleName)
 	if err != nil {
 		return nil, sdkerrors.ErrInvalidRequest.Wrap(err.Error())
 	}
 
 	k.SetScope(ctx, msg.Scope)
 
@@ -70,6 +70,8 @@
 
 	k.RemoveScope(ctx, msg.ScopeId)
 
+	k.RemoveNetAssetValues(ctx, msg.ScopeId)
+
 	k.EmitEvent(ctx, types.NewEventTxCompleted(types.TxEndpoint_DeleteScope, msg.GetSignerStrs()))
 	return types.NewMsgDeleteScopeResponse(), nil
 }
@@ -741,8 +743,8 @@
 
 	scopeID, err := types.MetadataAddressFromBech32(msg.ScopeId)
 	if err != nil {
 		return nil, sdkerrors.ErrInvalidRequest.Wrap(err.Error())
 	}
 
 	scope, found := k.GetScope(ctx, scopeID)
 	if !found {

x/metadata/keeper/msg_server_test.go

@@ -85,8 +85,7 @@ func (s *MsgServerTestSuite) TestAddNetAssetValue() {
 				ScopeId: scopeSpecIDNF.String(),
 				NetAssetValues: []types.NetAssetValue{
 					{
-						Price:  sdk.NewInt64Coin("navcoin", 1),
-						Volume: 1,
+						Price: sdk.NewInt64Coin("navcoin", 1),
 					}},
 				Signers: []string{user1},
 			},
@@ -99,7 +98,6 @@ func (s *MsgServerTestSuite) TestAddNetAssetValue() {
 				NetAssetValues: []types.NetAssetValue{
 					{
 						Price:              sdk.NewInt64Coin("hotdog", 100),
-						Volume:             uint64(100),
 						UpdatedBlockHeight: 1,
 					},
 				},
@@ -114,7 +112,6 @@ func (s *MsgServerTestSuite) TestAddNetAssetValue() {
 				NetAssetValues: []types.NetAssetValue{
 					{
 						Price:              sdk.NewInt64Coin(types.UsdDenom, 100),
-						Volume:             uint64(100),
 						UpdatedBlockHeight: 1,
 					},
 				},
@@ -129,7 +126,6 @@ func (s *MsgServerTestSuite) TestAddNetAssetValue() {
 				NetAssetValues: []types.NetAssetValue{
 					{
 						Price:              sdk.NewInt64Coin(types.UsdDenom, 100),
-						Volume:             uint64(100),
 						UpdatedBlockHeight: 1,
 					},
 				},

x/metadata/keeper/query_server_test.go

@@ -1321,7 +1321,6 @@ func (s *QueryServerTestSuite) TestScopeNetAssetValuesQuery() {
 				Denom:  fmt.Sprintf("usd%v", i),
 				Amount: sdk.NewInt(100 * int64(i+1)),
 			},
-			Volume: uint64(100 * (i + 1)),
 		}
 		err := app.MetadataKeeper.SetNetAssetValue(ctx, scopeID, netAssetValues[i], "source")
 		s.Require().NoError(err)