feat: remove module placeholders (#4437)

* remove some modules placeholders * add changelog * remove genesis state for test cases * remove module genesis placeholders * remove some placeholders * remove genesis placeholders * change replacer to xast * rollback a placeholder * remove unused placeholder * remove genesis/testcase placeholder * fix. wrong placeholder * remove keeper struct placeholder * remove unused replacer * funcstruct
ignite · Dec 13, 2024 · c540c0c · c540c0c
1 parent 236f8a0
commit c540c0c
Show file tree

Hide file tree

Showing 32 changed files with 1,392 additions and 662 deletions.
diff --git a/changelog.md b/changelog.md
@@ -20,6 +20,7 @@
 - [#4327](https://github.com/ignite/cli/pull/4327) Use the TxConfig from simState instead create a new one
 - [#4326](https://github.com/ignite/cli/pull/4326) Add `buf.build` version to `ignite version` command
 - [#4436](https://github.com/ignite/cli/pull/4436) Return tx hash to the faucet API
+- [#4437](https://github.com/ignite/cli/pull/4437) Remove module placeholders
 - [#4289](https://github.com/ignite/cli/pull/4289), [#4423](https://github.com/ignite/cli/pull/4423), [#4432](https://github.com/ignite/cli/pull/4432) Cosmos SDK v0.52 support
 
 ### Changes

diff --git a/docs/docs/02-guide/04-ibc.md b/docs/docs/02-guide/04-ibc.md
@@ -223,48 +223,48 @@ the `msg.Creator` value to the IBC `packet`.
 package keeper
 
 func (k msgServer) SendIbcPost(goCtx context.Context, msg *types.MsgSendIbcPost) (*types.MsgSendIbcPostResponse, error) {
- // validate incoming message
- if _, err := k.addressCodec.StringToBytes(msg.Creator); err != nil {
-  return nil, errorsmod.Wrap(sdkerrors.ErrInvalidAddress, fmt.Sprintf("invalid address: %s", err))
- }
-
- if msg.Port == "" {
-  return nil, errorsmod.Wrap(sdkerrors.ErrInvalidRequest, "invalid packet port")
- }
-
- if msg.ChannelID == "" {
-  return nil, errorsmod.Wrap(sdkerrors.ErrInvalidRequest, "invalid packet channel")
- }
-
- if msg.TimeoutTimestamp == 0 {
-  return nil, errorsmod.Wrap(sdkerrors.ErrInvalidRequest, "invalid packet timeout")
- }
-
- // TODO: logic before transmitting the packet
-
- // Construct the packet
- var packet types.IbcPostPacketData
-
- packet.Title = msg.Title
- packet.Content = msg.Content
- // highlight-next-line
- packet.Creator = msg.Creator
-
- // Transmit the packet
- ctx := sdk.UnwrapSDKContext(goCtx)
- _, err := k.TransmitIbcPostPacket(
-  ctx,
-  packet,
-  msg.Port,
-  msg.ChannelID,
-  clienttypes.ZeroHeight(),
-  msg.TimeoutTimestamp,
- )
- if err != nil {
-  return nil, err
- }
-
- return &types.MsgSendIbcPostResponse{}, nil
+	// validate incoming message
+	if _, err := k.addressCodec.StringToBytes(msg.Creator); err != nil {
+		return nil, errorsmod.Wrap(sdkerrors.ErrInvalidAddress, fmt.Sprintf("invalid address: %s", err))
+	}
+
+	if msg.Port == "" {
+		return nil, errorsmod.Wrap(sdkerrors.ErrInvalidRequest, "invalid packet port")
+	}
+
+	if msg.ChannelID == "" {
+		return nil, errorsmod.Wrap(sdkerrors.ErrInvalidRequest, "invalid packet channel")
+	}
+
+	if msg.TimeoutTimestamp == 0 {
+		return nil, errorsmod.Wrap(sdkerrors.ErrInvalidRequest, "invalid packet timeout")
+	}
+
+	// TODO: logic before transmitting the packet
+
+	// Construct the packet
+	var packet types.IbcPostPacketData
+
+	packet.Title = msg.Title
+	packet.Content = msg.Content
+	// highlight-next-line
+	packet.Creator = msg.Creator
+
+	// Transmit the packet
+	ctx := sdk.UnwrapSDKContext(goCtx)
+	_, err := k.TransmitIbcPostPacket(
+		ctx,
+		packet,
+		msg.Port,
+		msg.ChannelID,
+		clienttypes.ZeroHeight(),
+		msg.TimeoutTimestamp,
+	)
+	if err != nil {
+		return nil, err
+	}
+
+	return &types.MsgSendIbcPostResponse{}, nil
 }
 ```
 
@@ -315,11 +315,11 @@ Then modify the `OnRecvIbcPostPacket` keeper function with the following code:
 package keeper
 
 func (k Keeper) OnRecvIbcPostPacket(ctx sdk.Context, packet channeltypes.Packet, data types.IbcPostPacketData) (packetAck types.IbcPostPacketAck, err error) {
- packetAck.PostId, err = k.PostSeq.Next(ctx)
- if err != nil {
-  return packetAck, err
- }
- return packetAck, k.Post.Set(ctx, packetAck.PostId, types.Post{Title: data.Title, Content: data.Content})
+	packetAck.PostId, err = k.PostSeq.Next(ctx)
+	if err != nil {
+		return packetAck, err
+	}
+	return packetAck, k.Post.Set(ctx, packetAck.PostId, types.Post{Title: data.Title, Content: data.Content})
 }
 ```
 
@@ -339,33 +339,33 @@ from the packet.
 package keeper
 
 func (k Keeper) OnAcknowledgementIbcPostPacket(ctx sdk.Context, packet channeltypes.Packet, data types.IbcPostPacketData, ack channeltypes.Acknowledgement) error {
- switch dispatchedAck := ack.Response.(type) {
- case *channeltypes.Acknowledgement_Error:
-  // We will not treat acknowledgment error in this tutorial
-  return nil
- case *channeltypes.Acknowledgement_Result:
-  // Decode the packet acknowledgment
-  var packetAck types.IbcPostPacketAck
-  if err := types.ModuleCdc.UnmarshalJSON(dispatchedAck.Result, &packetAck); err != nil {
-   // The counter-party module doesn't implement the correct acknowledgment format
-   return errors.New("cannot unmarshal acknowledgment")
-  }
-
-  seq, err := k.SentPostSeq.Next(ctx)
-  if err != nil {
-   return err
-  }
-
-  return k.SentPost.Set(ctx, seq,
-   types.SentPost{
-    PostId: packetAck.PostId,
-    Title:  data.Title,
-    Chain:  packet.DestinationPort + "-" + packet.DestinationChannel,
-   },
-  )
- default:
-  return errors.New("the counter-party module does not implement the correct acknowledgment format")
- }
+	switch dispatchedAck := ack.Response.(type) {
+	case *channeltypes.Acknowledgement_Error:
+		// We will not treat acknowledgment error in this tutorial
+		return nil
+	case *channeltypes.Acknowledgement_Result:
+		// Decode the packet acknowledgment
+		var packetAck types.IbcPostPacketAck
+		if err := types.ModuleCdc.UnmarshalJSON(dispatchedAck.Result, &packetAck); err != nil {
+			// The counter-party module doesn't implement the correct acknowledgment format
+			return errors.New("cannot unmarshal acknowledgment")
+		}
+
+		seq, err := k.SentPostSeq.Next(ctx)
+		if err != nil {
+			return err
+		}
+
+		return k.SentPost.Set(ctx, seq,
+			types.SentPost{
+				PostId: packetAck.PostId,
+				Title:  data.Title,
+				Chain:  packet.DestinationPort + "-" + packet.DestinationChannel,
+			},
+		)
+	default:
+		return errors.New("the counter-party module does not implement the correct acknowledgment format")
+	}
 }
 ```
 
@@ -376,17 +376,17 @@ posts. This logic follows the same format as `sentPost`.
 
 ```go title="x/blog/keeper/ibc_post.go"
 func (k Keeper) OnTimeoutIbcPostPacket(ctx sdk.Context, packet channeltypes.Packet, data types.IbcPostPacketData) error {
- seq, err := k.TimeoutPostSeq.Next(ctx)
- if err != nil {
-  return err
- }
-
- return k.TimeoutPost.Set(ctx, seq,
-  types.TimeoutPost{
-   Title: data.Title,
-   Chain: packet.DestinationPort + "-" + packet.DestinationChannel,
-  },
- )
+	seq, err := k.TimeoutPostSeq.Next(ctx)
+	if err != nil {
+		return err
+	}
+
+	return k.TimeoutPost.Set(ctx, seq,
+		types.TimeoutPost{
+			Title: data.Title,
+			Chain: packet.DestinationPort + "-" + packet.DestinationChannel,
+		},
+	)
 }
 ```