fix(spaceward): build TxRaw without StargateClient

[Pitasi]

This PR makes src/features/actions/hooks.ts use the standard useTx hook to build transaction (that now exposes a sign() fn for building a TxRaw object without broadcasting it).

SigningStargateClient no longer works due to the use of evmos keys.

Summary by CodeRabbit

• New Features

  • Introduced a streamlined transaction signing process, enhancing clarity and efficiency.
  • Added a new sign function to the useTx hook for improved modularity in transaction handling.

• Bug Fixes

  • Improved the control flow and maintainability of transaction signing logic.

• Documentation

  • Updated function signatures to reflect new features and changes.

[coderabbitai]

Walkthrough

Walkthrough

The changes involve modifications to the transaction signing process within the useEnqueueAction function and the useTx hook. The useEnqueueAction function now utilizes the sign method from the useTx hook, simplifying the signing process by removing the need for an offline signer and signing client. The useTx hook has been updated to include a new sign function that encapsulates the transaction signing logic, enhancing code modularity and readability.

Changes

Files	Change Summary
spaceward/src/features/actions/hooks.ts	Updated useEnqueueAction to use sign method from useTx, removing the signing client and streamlining the signing process.
spaceward/src/hooks/useClient.ts	Introduced a new sign function in useTx for transaction signing, modified the tx function to utilize sign, and updated the return statement to include sign.

Sequence Diagram(s)

sequenceDiagram
    participant A as useEnqueueAction
    participant B as useTx
    participant C as sign

    A->>B: Call useTx()
    B->>C: Call sign(msgs, options)
    C-->>B: Return signed transaction
    B-->>A: Return transaction result

Loading

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[jjheywood]

LGTM

[coderabbitai]

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (3)

spaceward/src/features/actions/hooks.ts (1)

Line range hint 63-103: Approved and suggested minor refactor for clarity.

The integration of the sign method from useTx into useEnqueueAction simplifies the transaction signing process significantly. This change aligns well with the PR's objectives and enhances code modularity.

However, the function contains a large number of parameters in the _opts object, which could be refactored for better clarity and maintainability.

Consider breaking down the _opts object into more manageable parts or creating a dedicated type or interface to handle these parameters more cleanly.

Example refactor:

interface ActionOptions extends TxOptions {
  chainName?: string;
  tx?: TransactionLike;
  signDoc?: StdSignDoc;
  pubkey?: Uint8Array;
  title?: string;
  keyThemeIndex?: number;
  walletConnectRequestId?: number;
  walletConnectTopic?: string;
  snapRequestId?: string;
}

async function addAction(
  data: Parameters<typeof getMessage>[0],
  opts: ActionOptions = {},
  actionTimeoutHeight = 0,
) {
  // function body remains the same
}

spaceward/src/hooks/useClient.ts (2)

46-57: Well-structured new sign function.

The sign function is well-implemented, encapsulating the transaction signing logic effectively. It uses sensible defaults and clear structuring to handle the transaction creation.

Consider adding error handling for potential failures in getOfflineSigner and getSigningClient to enhance robustness.

---

Line range hint 71-91: Refactored tx function to use the new sign function.

The refactoring of the tx function to use the sign function simplifies the transaction handling and centralizes the signing logic, which is a positive change for maintainability.

Consider adding more specific error messages or handling specific error types to provide clearer user feedback.

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between c992b59 and 2ba5424.

Files selected for processing (2)

• spaceward/src/features/actions/hooks.ts (3 hunks)
• spaceward/src/hooks/useClient.ts (5 hunks)

Additional comments not posted (3)

spaceward/src/features/actions/hooks.ts (1)

6-6: Approved changes in imports.

The replacement of getSigningClient with useTx aligns with the PR's objective to simplify the transaction signing process using a centralized hook.

spaceward/src/hooks/useClient.ts (2)

134-134: Updated return statement in useTx.

The inclusion of the sign function in the return statement of useTx is a good practice, as it exposes the new functionality to other parts of the application.

---

188-192: Simplified TxRaw construction in buildTxRaw.

The use of TxRaw.fromPartial instead of the previous encoding method simplifies the construction process and is a cleaner approach to handling protobuf data.