feat: add EventOwnerChanged and EventRootChanged

CHANGELOG.md

@@ -54,6 +54,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
 * (server/grpc) [\#526](https://github.com/line/lbm-sdk/pull/526) add index field into TxResponse
 * (cli) [\#535](https://github.com/line/lbm-sdk/pull/536) updated ostracon to v1.0.5; `unsafe-reset-all` command has been moved to the `ostracon` sub-command.
 * (x/foundation) [\#597](https://github.com/line/lbm-sdk/pull/597) tidy up x/foundation
+* (x/collection) [\#604](https://github.com/line/lbm-sdk/pull/604) add EventOwnerChanged and EventRootChanged
 
 ### Bug Fixes
 * (x/wasm) [\#453](https://github.com/line/lbm-sdk/pull/453) modify wasm grpc query api path

docs/core/proto-docs.md

@@ -844,7 +844,9 @@
     - [EventModifiedContract](#lbm.collection.v1.EventModifiedContract)
     - [EventModifiedNFT](#lbm.collection.v1.EventModifiedNFT)
     - [EventModifiedTokenClass](#lbm.collection.v1.EventModifiedTokenClass)
+    - [EventOwnerChanged](#lbm.collection.v1.EventOwnerChanged)
     - [EventRevokedOperator](#lbm.collection.v1.EventRevokedOperator)
+    - [EventRootChanged](#lbm.collection.v1.EventRootChanged)
     - [EventSent](#lbm.collection.v1.EventSent)
 
     - [AttributeKey](#lbm.collection.v1.AttributeKey)
@@ -12768,6 +12770,24 @@ Since: 0.46.0 (finschia)
 
 
 
+<a name="lbm.collection.v1.EventOwnerChanged"></a>
+
+### EventOwnerChanged
+EventOwnerChanged is emitted when the owner of token is changed by operation applied to its ancestor.
+
+Since: 0.46.0 (finschia)
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| `contract_id` | [string](#string) |  | contract id associated with the contract. |
+| `token_id` | [string](#string) |  | token id associated with the token. |
+
+
+
+
+
+
 <a name="lbm.collection.v1.EventRevokedOperator"></a>
 
 ### EventRevokedOperator
@@ -12787,6 +12807,24 @@ Since: 0.46.0 (finschia)
 
 
 
+<a name="lbm.collection.v1.EventRootChanged"></a>
+
+### EventRootChanged
+EventRootChanged is emitted when the root of token is changed by operation applied to its ancestor.
+
+Since: 0.46.0 (finschia)
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| `contract_id` | [string](#string) |  | contract id associated with the contract. |
+| `token_id` | [string](#string) |  | token id associated with the token. |
+
+
+
+
+
+
 <a name="lbm.collection.v1.EventSent"></a>
 
 ### EventSent

proto/lbm/collection/v1/event.proto

@@ -299,3 +299,23 @@ message EventDetached {
   // token being detached.
   string subject = 4;
 }
+
+// EventOwnerChanged is emitted when the owner of token is changed by operation applied to its ancestor.
+//
+// Since: 0.46.0 (finschia)
+message EventOwnerChanged {
+  // contract id associated with the contract.
+  string contract_id = 1;
+  // token id associated with the token.
+  string token_id = 2;
+}
+
+// EventRootChanged is emitted when the root of token is changed by operation applied to its ancestor.
+//
+// Since: 0.46.0 (finschia)
+message EventRootChanged {
+  // contract id associated with the contract.
+  string contract_id = 1;
+  // token id associated with the token.
+  string token_id = 2;
+}

x/collection/event.go

@@ -688,11 +688,11 @@ func NewEventDetachFrom(event EventDetached, oldRoot string) sdk.Event {
 }
 
 // Deprecated: do not use.
-func NewEventOperationTransferNFT(contractID string, tokenID string) sdk.Event {
+func NewEventOperationTransferNFT(event EventOwnerChanged) sdk.Event {
 	eventType := EventTypeOperationTransferNFT.String()
 	attributes := map[AttributeKey]string{
-		AttributeKeyContractID: contractID,
-		AttributeKeyTokenID:    tokenID,
+		AttributeKeyContractID: event.ContractId,
+		AttributeKeyTokenID:    event.TokenId,
 	}
 
 	res := sdk.NewEvent(eventType)
@@ -720,11 +720,11 @@ func NewEventOperationBurnNFT(contractID string, tokenID string) sdk.Event {
 }
 
 // Deprecated: do not use.
-func NewEventOperationRootChanged(contractID string, tokenID string) sdk.Event {
+func NewEventOperationRootChanged(event EventRootChanged) sdk.Event {
 	eventType := EventTypeOperationRootChanged.String()
 	attributes := map[AttributeKey]string{
-		AttributeKeyContractID: contractID,
-		AttributeKeyTokenID:    tokenID,
+		AttributeKeyContractID: event.ContractId,
+		AttributeKeyTokenID:    event.TokenId,
 	}
 
 	res := sdk.NewEvent(eventType)

x/collection/event_test.go

@@ -896,15 +896,17 @@ func TestNewEventOperationTransferNFT(t *testing.T) {
 	rand.Seed(time.Now().UnixNano())
 	str := func() string { return randomString(8) }
 
-	contractID := str()
-	tokenID := str()
-	legacy := collection.NewEventOperationTransferNFT(contractID, tokenID)
+	event := collection.EventOwnerChanged{
+		ContractId: str(),
+		TokenId:    str(),
+	}
+	legacy := collection.NewEventOperationTransferNFT(event)
 
 	require.Equal(t, collection.EventTypeOperationTransferNFT.String(), legacy.Type)
 
 	attributes := map[collection.AttributeKey]string{
-		collection.AttributeKeyContractID: contractID,
-		collection.AttributeKeyTokenID:    tokenID,
+		collection.AttributeKeyContractID: event.ContractId,
+		collection.AttributeKeyTokenID:    event.TokenId,
 	}
 	for key, value := range attributes {
 		require.True(t, assertAttribute(legacy, key.String(), value), key)
@@ -934,15 +936,17 @@ func TestNewEventOperationRootChanged(t *testing.T) {
 	rand.Seed(time.Now().UnixNano())
 	str := func() string { return randomString(8) }
 
-	contractID := str()
-	tokenID := str()
-	legacy := collection.NewEventOperationRootChanged(contractID, tokenID)
+	event := collection.EventRootChanged{
+		ContractId: str(),
+		TokenId:    str(),
+	}
+	legacy := collection.NewEventOperationRootChanged(event)
 
 	require.Equal(t, collection.EventTypeOperationRootChanged.String(), legacy.Type)
 
 	attributes := map[collection.AttributeKey]string{
-		collection.AttributeKeyContractID: contractID,
-		collection.AttributeKeyTokenID:    tokenID,
+		collection.AttributeKeyContractID: event.ContractId,
+		collection.AttributeKeyTokenID:    event.TokenId,
 	}
 	for key, value := range attributes {
 		require.True(t, assertAttribute(legacy, key.String(), value), key)

x/collection/keeper/nft.go

@@ -94,7 +94,17 @@ func (k Keeper) Attach(ctx sdk.Context, contractID string, owner sdk.AccAddress,
 	}
 
 	// legacy
-	k.emitEventOnDescendants(ctx, contractID, subject, collection.NewEventOperationRootChanged)
+	k.iterateDescendants(ctx, contractID, subject, func(descendantID string, _ int) (stop bool) {
+		event := collection.EventRootChanged{
+			ContractId: contractID,
+			TokenId:    descendantID,
+		}
+		ctx.EventManager().EmitEvent(collection.NewEventOperationRootChanged(event))
+		if err := ctx.EventManager().EmitTypedEvent(&event); err != nil {
+			panic(err)
+		}
+		return false
+	})
 
 	return nil
 }
@@ -121,7 +131,17 @@ func (k Keeper) Detach(ctx sdk.Context, contractID string, owner sdk.AccAddress,
 	k.deleteChild(ctx, contractID, *parent, subject)
 
 	// legacy
-	k.emitEventOnDescendants(ctx, contractID, subject, collection.NewEventOperationRootChanged)
+	k.iterateDescendants(ctx, contractID, subject, func(descendantID string, _ int) (stop bool) {
+		event := collection.EventRootChanged{
+			ContractId: contractID,
+			TokenId:    descendantID,
+		}
+		ctx.EventManager().EmitEvent(collection.NewEventOperationRootChanged(event))
+		if err := ctx.EventManager().EmitTypedEvent(&event); err != nil {
+			panic(err)
+		}
+		return false
+	})
 
 	return nil
 }
@@ -275,15 +295,6 @@ func (k Keeper) setLegacyTokenType(ctx sdk.Context, contractID string, tokenType
 	store.Set(key, []byte{})
 }
 
-// Deprecated
-func (k Keeper) emitEventOnDescendants(ctx sdk.Context, contractID string, tokenID string, generator func(contractID string, descendantID string) sdk.Event) {
-	k.iterateDescendants(ctx, contractID, tokenID, func(descendantID string, _ int) (stop bool) {
-		event := generator(contractID, descendantID)
-		ctx.EventManager().EmitEvent(event)
-		return false
-	})
-}
-
 // Deprecated
 func (k Keeper) validateDepthAndWidth(ctx sdk.Context, contractID string, tokenID string) error {
 	widths := map[int]int{0: 1}

x/collection/keeper/send.go

@@ -14,6 +14,23 @@ func (k Keeper) SendCoins(ctx sdk.Context, contractID string, from, to sdk.AccAd
 		return err
 	}
 
+	// legacy
+	for _, coin := range amount {
+		if err := collection.ValidateNFTID(coin.TokenId); err == nil {
+			k.iterateDescendants(ctx, contractID, coin.TokenId, func(descendantID string, _ int) (stop bool) {
+				event := collection.EventOwnerChanged{
+					ContractId: contractID,
+					TokenId:    descendantID,
+				}
+				ctx.EventManager().EmitEvent(collection.NewEventOperationTransferNFT(event))
+				if err := ctx.EventManager().EmitTypedEvent(&event); err != nil {
+					panic(err)
+				}
+				return false
+			})
+		}
+	}
+
 	return nil
 }
 
@@ -25,9 +42,6 @@ func (k Keeper) addCoins(ctx sdk.Context, contractID string, address sdk.AccAddr
 
 		if err := collection.ValidateNFTID(coin.TokenId); err == nil {
 			k.setOwner(ctx, contractID, coin.TokenId, address)
-
-			// legacy
-			k.emitEventOnDescendants(ctx, contractID, coin.TokenId, collection.NewEventOperationTransferNFT)
 		}
 	}
 

x/collection/keeper/supply.go

@@ -253,7 +253,10 @@ func (k Keeper) BurnCoins(ctx sdk.Context, contractID string, from sdk.AccAddres
 		burntAmount = append(burntAmount, coin)
 		if err := collection.ValidateNFTID(coin.TokenId); err == nil {
 			// legacy
-			k.emitEventOnDescendants(ctx, contractID, coin.TokenId, collection.NewEventOperationBurnNFT)
+			k.iterateDescendants(ctx, contractID, coin.TokenId, func(descendantID string, _ int) (stop bool) {
+				ctx.EventManager().EmitEvent(collection.NewEventOperationBurnNFT(contractID, descendantID))
+				return false
+			})
 
 			k.deleteOwner(ctx, contractID, coin.TokenId)
 			k.deleteNFT(ctx, contractID, coin.TokenId)