Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Suggestions to improve this text gramatically Update README.md #318

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+3 −3
Open

Suggestions to improve this text gramatically Update README.md #318

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions x/ibc-hooks/move-hooks/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ This module is copied from [osmosis](https://github.com/osmosis-labs/osmosis) an
The move hook is an IBC middleware which is used to allow ICS-20 token transfers to initiate contract calls.
This allows cross-chain contract calls, that involve token movement.
This is useful for a variety of use cases.
One of primary importance is cross-chain swaps, which is an extremely powerful primitive.
One of the primary importance is cross-chain swaps, which is an extremely powerful primitive.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Fix grammatical structure

The current phrase "One of the primary importance" is grammatically incorrect. Consider using one of these alternatives:

  1. "Of primary importance are cross-chain swaps"
  2. "One of the primary uses is cross-chain swaps"
🧰 Tools
🪛 LanguageTool

[style] ~10-~10: As an alternative to the over-used intensifier ‘extremely’, consider replacing this phrase.
Context: ...portance is cross-chain swaps, which is an extremely powerful primitive. The mechanism enabling this...

(EN_WEAK_ADJECTIVE)


The mechanism enabling this is a `memo` field on every ICS20 and ICS721 transfer packet as of [IBC v3.4.0](https://medium.com/the-interchain-foundation/moving-beyond-simple-token-transfers-d42b2b1dc29b).
Move hooks is an IBC middleware that parses an ICS20 transfer, and if the `memo` field is of a particular form, executes a move contract call. We now detail the `memo` format for `move` contract calls, and the execution guarantees provided.
Expand Down Expand Up @@ -149,7 +149,7 @@ If an ICS20 packet is directed towards movehooks, and is formatted incorrectly,

Pre move hooks:

- Ensure the incoming IBC packet is cryptogaphically valid
- Ensure the incoming IBC packet is cryptographically valid
- Ensure the incoming IBC packet is not timed out.

In move hooks, pre packet execution:
Expand Down Expand Up @@ -184,7 +184,7 @@ public entry fun ibc_timeout(
)
```

Also when a contract make IBC transfer request, it should provide async callback data through memo field.
Also when a contract makes IBC transfer request, it should provide async callback data through memo field.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Complete the grammatical improvements

While the subject-verb agreement is fixed, the sentence still needs additional corrections:

-Also when a contract makes IBC transfer request
+Also, when a contract makes an IBC transfer request

The changes add:

  1. A comma after "Also"
  2. The article "an" before "IBC"
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
Also when a contract makes IBC transfer request, it should provide async callback data through memo field.
Also, when a contract makes an IBC transfer request, it should provide async callback data through memo field.
🧰 Tools
🪛 LanguageTool

[uncategorized] ~187-~187: Possible missing article found.
Context: ...uld provide async callback data through memo field. - `memo['move']['async_callback...

(AI_HYDRA_LEO_MISSING_THE)


- `memo['move']['async_callback']['id']`: the async callback id is assigned from the contract. so later it will be passed as argument of `ibc_ack` and `ibc_timeout`.
- `memo['move']['async_callback']['module_address']`: The address of module which defines the callback function.
Expand Down