docs: Path unwinding and forwarding requirements

[womensrights]

Description

This pr details the token path unwinding and token forwarding requirements document

---

Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

• Targeted PR against the correct branch (see CONTRIBUTING.md).
• Linked to GitHub issue with discussion and accepted design, OR link to spec that describes this work.
• Code follows the module structure standards and Go style guide.
• Wrote unit and integration tests.
• Updated relevant documentation (docs/).
• Added relevant godoc comments.
• Provide a conventional commit message to follow the repository standards.
• Include a descriptive changelog entry when appropriate. This may be left to the discretion of the PR reviewers. (e.g. chores should be omitted from changelog)
• Re-reviewed Files changed in the GitHub PR explorer.
• Review SonarCloud Report in the comment section below once CI passes.

Summary by CodeRabbit

• New Features
  • Enhanced fungible token transfers by implementing path unwinding and token forwarding in the context of inter-blockchain communication (IBC), automating route determination and enabling token forwarding to other chains to simplify processes for end users.

[coderabbitai]

Walkthrough

Walkthrough

The recent update enhances the inter-blockchain communication (IBC) system by automating path unwinding and token forwarding for fungible tokens. This streamlines token transfers across blockchains, automatically finding optimal routes and enabling token forwarding to improve user experience.

Changes

File Path	Change Summary
docs/requirements/path-unwinding-forwarding -requirements.md	Introduces path unwinding and token forwarding for fungible tokens in cross-chain transfers. Simplifies token transfers by automating route determination and enabling token forwarding to enhance user experience.

"In the world of chains and blocks so vast,
A rabbit hopped, making paths unsurpassed.
🌟 From chain to chain, it danced with glee,
Unwinding paths, setting tokens free.
Forwarding on, without a pause or rest,
Ensuring your tokens find the best nest.
🚀 To the moon, with ease, we now can hop,
Thanks to the rabbit, we won't stop."
🐰💫

---

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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between e69a833 and f7fd161.

Files selected for processing (1)

• docs/requirements/path-unwinding-forwarding -requirements.md (1 hunks)

Files not reviewed due to errors (1)

• docs/requirements/path-unwinding-forwarding-requirements.md (no review received)

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between f7fd161 and b741e49.

Files selected for processing (1)

• docs/requirements/path-unwinding-forwarding -requirements.md (1 hunks)

Files not reviewed due to errors (1)

• docs/requirements/path-unwinding-forwarding-requirements.md (no review received)

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between b741e49 and 9276186.

Files selected for processing (1)

• docs/requirements/path-unwinding-forwarding -requirements.md (1 hunks)

Files not reviewed due to errors (1)

• docs/requirements/path-unwinding-forwarding-requirements.md (no review received)

[crodriguezvega]

We should also specify the behaviour for authz (e.g. will the granter be able to specify a set of allowed forwarding paths?).

[colin-axner]

Thanks for the requirements! ❤️

[damiannolan]

Can we get this merged? Is there anything blocking?

[DimitrisJim]

thanks for these!