Feat/obridge docs #322
Feat/obridge docs #322
Conversation
|
Warning Rate limit exceeded@perfogic has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 10 minutes and 27 seconds before requesting another review. How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. WalkthroughThe updates introduce several new documentation files related to the Obridge project by Oraichain, detailing cross-chain solutions for asset transfers between various blockchain ecosystems. Key features include the Oraichain-EVM bridge, the Ton Bridge for token transfers, UniversalSwap memo specifications, and encoding processes for seamless token swaps. Additionally, the documentation outlines operational frameworks, supported chains, and code examples for developers, enhancing clarity and functionality in cross-chain interactions. Changes
Poem
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? TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
Code Coverage SummaryDiff against mainResults for commit: cd9270e Minimum allowed coverage is ♻️ This comment has been updated with latest results |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 6
Outside diff range, codebase verification and nitpick comments (1)
specs/obridge/universal-swap/encode-memo.md (1)
5-13: Add context about directory structure and dependencies.The command to generate TypeScript definitions is correct, but it would be helpful to provide context about the directory structure and dependencies.
For example, mention where the
.protofiles are located and any necessary npm packages that need to be installed.
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (3)
specs/obridge/image/evm_to_orai.pngis excluded by!**/*.pngspecs/obridge/image/obridge_universal.pngis excluded by!**/*.pngspecs/obridge/image/orai_to_evm.pngis excluded by!**/*.png
Files selected for processing (5)
- specs/obridge/background.md (1 hunks)
- specs/obridge/orai-evm.md (1 hunks)
- specs/obridge/universal-swap-memo.md (1 hunks)
- specs/obridge/universal-swap/encode-memo.md (1 hunks)
- specs/obridge/universal-swap/swap-route.md (1 hunks)
Additional context used
Markdownlint
specs/obridge/background.md
47-47: null
No empty links(MD042, no-empty-links)
48-48: null
No empty links(MD042, no-empty-links)
49-49: null
No empty links(MD042, no-empty-links)
specs/obridge/orai-evm.md
128-128: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
LanguageTool
specs/obridge/orai-evm.md
[uncategorized] ~44-~44: Loose punctuation mark.
Context: ...): Parameters: -_tokenContract: The address of the token want to bridge...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~45-~45: Loose punctuation mark.
Context: ...e token want to bridge. -_destination: A string combining `${sourceChannel}/${...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~46-~46: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ... used for UniversalSwap - _amount: The amount of tokens to bridge. Example: Brid...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~144-~144: A comma might be missing here.
Context: ... bridge CW20 tokens from Oraichain to a chain use the CW20 Send function along with t...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
specs/obridge/universal-swap-memo.md
[misspelling] ~5-~5: This word is normally spelled as one.
Context: ...oken swaps, seamlessly integrating into multi-chain workflows. The memo is encoded using th...(EN_COMPOUNDS_MULTI_CHAIN)
Gitleaks
specs/obridge/orai-evm.md
114-114: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
specs/obridge/universal-swap/swap-route.md
65-65: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
74-74: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
79-79: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
95-95: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
104-104: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
109-109: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
113-113: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
Additional comments not posted (18)
specs/obridge/universal-swap/encode-memo.md (2)
15-19: LGTM!The instructions for creating the memo object are clear and concise.
21-29: LGTM!The instructions for encoding the memo to a base64 string are clear and the provided TypeScript code snippet is correct.
specs/obridge/background.md (3)
1-3: LGTM!The introduction provides a clear overview of Obridge and its supported chains. The information is well-presented and easy to understand.
7-17: LGTM!The section explains the different components and protocols used by Obridge. Each component is linked to its respective GitHub repository, providing additional context.
19-41: LGTM!The section lists the blockchain platforms supported by Obridge. The information is well-organized and easy to understand.
specs/obridge/orai-evm.md (2)
1-5: LGTM!The overview provides a clear explanation of the Oraichain-EVM bridge and its components. The information is well-presented and easy to understand.
14-22: LGTM!The workflows for sending assets between EVM and Oraichain are well-documented and include diagrams for better understanding.
specs/obridge/universal-swap/swap-route.md (5)
1-10: LGTM!The overview section is well-written and provides a clear explanation of the swap route concept.
The content is approved.
11-24: LGTM!The protobuf definitions are clear and well-structured.
The content is approved.
26-46: LGTM!The section is informative and provides practical guidance on using the Smart Route API.
The content is approved.
48-123: LGTM!The section is detailed and provides a clear explanation of the sample response.
The content is approved.
Tools
Gitleaks
65-65: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
74-74: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
79-79: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
95-95: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
104-104: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
109-109: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
113-113: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
125-203: LGTM!The section is clear and provides practical examples of building swap routes.
The content is approved.
specs/obridge/universal-swap-memo.md (6)
1-6: LGTM!The overview section is well-written and provides a clear explanation of the Universal Swap Memo concept.
The content is approved.
Tools
LanguageTool
[misspelling] ~5-~5: This word is normally spelled as one.
Context: ...oken swaps, seamlessly integrating into multi-chain workflows. The memo is encoded using th...(EN_COMPOUNDS_MULTI_CHAIN)
7-85: LGTM!The protobuf definitions are clear and well-structured.
The content is approved.
88-99: LGTM!The section is detailed and provides a clear explanation of the
Memomessage structure.The content is approved.
100-178: LGTM!The section is clear and provides practical examples of the detailed messages.
The content is approved.
179-225: LGTM!The section is detailed and provides a clear example of the Universal Swap Memo in action.
The content is approved.
5-5: Fix MisspellingThe word "multi-chain" should be spelled as "multichain".
Apply this diff to fix the misspelling:
- multi-chain + multichainLikely invalid or redundant comment.
Tools
LanguageTool
[misspelling] ~5-~5: This word is normally spelled as one.
Context: ...oken swaps, seamlessly integrating into multi-chain workflows. The memo is encoded using th...(EN_COMPOUNDS_MULTI_CHAIN)
specs/obridge/background.md
Outdated
| ### Integration | ||
|
|
||
| - [Orai - EVM](./orai-evm.md) | ||
| - [Orai - Cosmos](./orai-cosmos.md) | ||
| - [Orai - Bitcoin]() | ||
| - [Orai - TON]() | ||
| - [Orai - XRPL]() |
There was a problem hiding this comment.
Fix empty links.
There are empty links for Bitcoin and TON integration. Please provide the correct links or remove the placeholders.
For example:
- [Orai - Bitcoin]()
- [Orai - TON]()
+ [Orai - Bitcoin](https://example.com/bitcoin-integration)
+ [Orai - TON](https://example.com/ton-integration)Committable suggestion was skipped due to low confidence.
Tools
Markdownlint
47-47: null
No empty links(MD042, no-empty-links)
48-48: null
No empty links(MD042, no-empty-links)
49-49: null
No empty links(MD042, no-empty-links)
| - Ensure the corresponding funds match the `remote_denom` in the mapping pair. | ||
|
|
||
| **2. Transfer Cw20** | ||
| To bridge CW20 tokens from Oraichain to a chain use the CW20 Send function along with the TransferToRemote message |
There was a problem hiding this comment.
Fix missing comma.
There is a missing comma in the sentence.
- To bridge CW20 tokens from Oraichain to a chain use the CW20 Send function along with the TransferToRemote message
+ To bridge CW20 tokens from Oraichain to a chain, use the CW20 Send function along with the TransferToRemote messageCommittable 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.
| To bridge CW20 tokens from Oraichain to a chain use the CW20 Send function along with the TransferToRemote message | |
| To bridge CW20 tokens from Oraichain to a chain, use the CW20 Send function along with the TransferToRemote message |
Tools
LanguageTool
[uncategorized] ~144-~144: A comma might be missing here.
Context: ... bridge CW20 tokens from Oraichain to a chain use the CW20 Send function along with t...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
| `Bridging Tokens Using IbcBridgeWasm Contract` | ||
|
|
||
| **1. Transfer Native Token** |
There was a problem hiding this comment.
Fix emphasis used instead of a heading.
The emphasis should be replaced with a heading.
- **1. Transfer Native Token**
+ ### 1. Transfer Native TokenCommittable 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.
| `Bridging Tokens Using IbcBridgeWasm Contract` | |
| **1. Transfer Native Token** | |
| `Bridging Tokens Using IbcBridgeWasm Contract` | |
| ### 1. Transfer Native Token |
Tools
Markdownlint
128-128: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
| ```solidity | ||
| interface IGravity { | ||
| event SendToCosmosEvent(address indexed _tokenContract, address indexe _sender, string _destination, uint256 _amount, uint256 _eventNonce); | ||
|
|
||
| function sendToCosmos(address _tokenContract, string calldata _destination, uint256 _amount) external; | ||
| } | ||
|
|
||
| ``` |
There was a problem hiding this comment.
Fix typo in event declaration.
There is a typo in the event declaration. Replace indexe with indexed.
- event SendToCosmosEvent(address indexed _tokenContract, address indexe _sender, string _destination, uint256 _amount, uint256 _eventNonce);
+ event SendToCosmosEvent(address indexed _tokenContract, address indexed _sender, string _destination, uint256 _amount, uint256 _eventNonce);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.
| ```solidity | |
| interface IGravity { | |
| event SendToCosmosEvent(address indexed _tokenContract, address indexe _sender, string _destination, uint256 _amount, uint256 _eventNonce); | |
| function sendToCosmos(address _tokenContract, string calldata _destination, uint256 _amount) external; | |
| } | |
| ``` | |
| ```solidity | |
| interface IGravity { | |
| event SendToCosmosEvent(address indexed _tokenContract, address indexed _sender, string _destination, uint256 _amount, uint256 _eventNonce); | |
| function sendToCosmos(address _tokenContract, string calldata _destination, uint256 _amount) external; | |
| } | |
| ``` |
| - `_tokenContract` : The address of the token want to bridge. | ||
| - `_destination`: A string combining `${sourceChannel}/${destReceiver}:${memo}`, where **sourceChannel** is the bridge channel between OraiBridge and Oraichain, **destReceiver** is the recipient's address on Oraichain, and [memo](./universal-swap-memo.md) used for UniversalSwap | ||
| - \_amount: The amount of tokens to bridge. |
There was a problem hiding this comment.
Fix punctuation and grammar issues.
There are some punctuation and grammar issues in the parameters description.
- `_tokenContract` : The address of the token want to bridge.
- `_destination`: A string combining `${sourceChannel}/${destReceiver}:${memo}`, where **sourceChannel** is the bridge channel between OraiBridge and Oraichain, **destReceiver** is the recipient's address on Oraichain, and [memo](./universal-swap-memo.md) used for UniversalSwap
- \_amount: The amount of tokens to bridge.
+ `_tokenContract`: The address of the token to bridge.
+ `_destination`: A string combining `${sourceChannel}/${destReceiver}:${memo}`, where **sourceChannel** is the bridge channel between OraiBridge and Oraichain, **destReceiver** is the recipient's address on Oraichain, and [memo](./universal-swap-memo.md) is used for UniversalSwap.
+ `_amount`: The number of tokens to bridge.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.
| - `_tokenContract` : The address of the token want to bridge. | |
| - `_destination`: A string combining `${sourceChannel}/${destReceiver}:${memo}`, where **sourceChannel** is the bridge channel between OraiBridge and Oraichain, **destReceiver** is the recipient's address on Oraichain, and [memo](./universal-swap-memo.md) used for UniversalSwap | |
| - \_amount: The amount of tokens to bridge. | |
| `_tokenContract`: The address of the token to bridge. | |
| `_destination`: A string combining `${sourceChannel}/${destReceiver}:${memo}`, where **sourceChannel** is the bridge channel between OraiBridge and Oraichain, **destReceiver** is the recipient's address on Oraichain, and [memo](./universal-swap-memo.md) is used for UniversalSwap. | |
| `_amount`: The number of tokens to bridge. |
Tools
LanguageTool
[uncategorized] ~44-~44: Loose punctuation mark.
Context: ...): Parameters: -_tokenContract: The address of the token want to bridge...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~45-~45: Loose punctuation mark.
Context: ...e token want to bridge. -_destination: A string combining `${sourceChannel}/${...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~46-~46: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ... used for UniversalSwap - _amount: The amount of tokens to bridge. Example: Brid...(AMOUNTOF_TO_NUMBEROF)
| "chainId": "Oraichain", | ||
| "tokenIn": "orai", | ||
| "tokenInAmount": "700000000", | ||
| "tokenOut": "orai12hzjxfh77wl572gdzct2fxv2arxcwh6gykc7qh", |
There was a problem hiding this comment.
Security Concern: Potential Exposure of Generic API Keys
Detected potential exposure of generic API keys in the sample API request and response. Ensure that these keys are not real or sensitive.
Replace the keys with placeholders or mock values to avoid accidental exposure.
- "destAsset": "orai12hzjxfh77wl572gdzct2fxv2arxcwh6gykc7qh"
+ "destAsset": "orai<placeholder>"Also applies to: 74-74, 79-79, 95-95, 104-104, 109-109, 113-113
Tools
Gitleaks
65-65: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (3)
specs/obridge/orai-ton.md (3)
21-21: Remove the trailing colon from the heading.The heading "Workflows:" has a trailing colon which is unnecessary. Please remove the colon to adhere to the Markdown best practices.
Apply this diff to remove the trailing colon:
-# Workflows: +# WorkflowsTools
Markdownlint
21-21: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
47-62: Fix the punctuation and formatting issues in the parameter descriptions.The parameter descriptions in the code block have some punctuation and formatting issues. Please consider the following suggestions:
- Remove the loose punctuation marks (colons) before the parameter names.
- Add a comma after "With ton native token" in the description of the
denomparameter.- Rephrase the description of the
optsparameter to avoid repetition of "you want to send".Apply this diff to fix the punctuation and formatting issues:
- - `cosmosRecipient` : recipient address on cosmos destination chain + - `cosmosRecipient`: recipient address on cosmos destination chain - - `amount`: amount of token that you want to send. + - `amount`: amount of token to send. - - `denom`: denom of the token, which will decide it is **bridge_ton** or **bridge_jetton_token**. + - `denom`: denom of the token, which will decide if it is **bridge_ton** or **bridge_jetton_token**. - - `opts`: configuration of **total ton amount** that you want to send along with the messages and the **query id** of that message. + - `opts`: configuration of the **total ton amount** to send along with the messages and the **query id** of that message. - - `timeoutTimestamp`: timeout timestamp of packet. + - `timeoutTimestamp`: timeout timestamp of the packet. - - `memo`: [memo](./universal-swap-memo.md) is used for UniversalSwap which will be executed when the token reached to Oraichain. + - `memo`: [memo](./universal-swap-memo.md) is used for UniversalSwap, which will be executed when the token reaches Oraichain.
138-141: Fix the punctuation and formatting issues in the parameter descriptions.The parameter descriptions have some punctuation and formatting issues. Please consider the following suggestions:
- Remove the loose punctuation marks (colons) before the parameter names.
- Add a comma after "With ton native token" in the description of the
tokenDenomOnTonparameter.Apply this diff to fix the punctuation and formatting issues:
- - `tonRecipient` : ton recipient address + - `tonRecipient`: ton recipient address - - `amount`: amount of token that you want to send. + - `amount`: amount of token to send. - - `tokenDenomOnTon`: token denom address on ton. With ton native token it will be **ton zero address** and with jetton token, it will be **jetton master address**. + - `tokenDenomOnTon`: token denom address on ton. With ton native token, it will be **ton zero address**, and with jetton token, it will be **jetton master address**. - - `timeoutTimestamp`: timeout timestamp of packet. + - `timeoutTimestamp`: timeout timestamp of the packet.Tools
LanguageTool
[uncategorized] ~138-~138: Loose punctuation mark.
Context: ... ``` Parameters: -tonRecipient: ton recipient address - `amount`: amoun...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~140-~140: Loose punctuation mark.
Context: ...at you want to send. -tokenDenomOnTon: token denom address on ton. With ton na...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~140-~140: Possible missing comma found.
Context: ...n denom address on ton. With ton native token it will be ton zero address and wit...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~141-~141: Loose punctuation mark.
Context: ...n master address**. -timeoutTimestamp: timeout timestamp of packet. **Example...(UNLIKELY_OPENING_PUNCTUATION)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (2)
specs/obridge/image/orai_to_ton.pngis excluded by!**/*.pngspecs/obridge/image/ton_to_orai.pngis excluded by!**/*.png
Files selected for processing (1)
- specs/obridge/orai-ton.md (1 hunks)
Additional context used
LanguageTool
specs/obridge/orai-ton.md
[uncategorized] ~71-~71: Loose punctuation mark.
Context: .... Parameters: -cosmosRecipient: recipient address on cosmos destination...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~73-~73: Loose punctuation mark.
Context: ...f token that you want to send. -denom: denom of the token, which will decide i...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~74-~74: Loose punctuation mark.
Context: ...n** or bridge_jetton_token. -opts: configuration of total ton amount t...(UNLIKELY_OPENING_PUNCTUATION)
[style] ~74-~74: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ration of total ton amount that you want to send along with the messages and the **...(REP_WANT_TO_VB)
[uncategorized] ~75-~75: Loose punctuation mark.
Context: ...** of that message. -timeoutTimestamp: timeout timestamp of packet. -memo: ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~76-~76: Loose punctuation mark.
Context: ...: timeout timestamp of packet. -memo`: memo is use...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~76-~76: Possible missing comma found.
Context: ...](./universal-swap-memo.md) is used for UniversalSwap which will be executed when the token r...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~138-~138: Loose punctuation mark.
Context: ... ``` Parameters: -tonRecipient: ton recipient address - `amount`: amoun...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~140-~140: Loose punctuation mark.
Context: ...at you want to send. -tokenDenomOnTon: token denom address on ton. With ton na...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~140-~140: Possible missing comma found.
Context: ...n denom address on ton. With ton native token it will be ton zero address and wit...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~141-~141: Loose punctuation mark.
Context: ...n master address**. -timeoutTimestamp: timeout timestamp of packet. **Example...(UNLIKELY_OPENING_PUNCTUATION)
Markdownlint
specs/obridge/orai-ton.md
21-21: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (10)
specs/obridge/orai-ton.md (10)
21-21: Remove the colon from the heading.Trailing punctuation in headings is unnecessary.
-# Workflows: +# WorkflowsTools
Markdownlint
21-21: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
43-43: Remove the colon from the heading.Trailing punctuation in headings is unnecessary.
-#### For integration on Node.JS server: +#### For integration on Node.js serverAlso, the official spelling of the framework is "Node.js".
Tools
LanguageTool
[uncategorized] ~43-~43: The official spelling of this programming framework is “Node.js”.
Context: ...-based tokens. #### For integration on Node.JS server: ```ts const TON_NATIVE = "ton"...(NODE_JS)
Markdownlint
43-43: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
69-74: Remove the loose punctuation marks from the parameter descriptions.The colons at the beginning of each list item are unnecessary.
- - `cosmosRecipient` : recipient address on cosmos destination chain. + - `cosmosRecipient`: recipient address on cosmos destination chain. - - `amount`: amount of token that you want to send. + - `amount`: amount of token that you want to send. - - `denom`: denom of the token, which will decide it is **bridge_ton** or **bridge_jetton_token**. + - `denom`: denom of the token, which will decide it is **bridge_ton** or **bridge_jetton_token**. - - `opts`: configuration of **total ton amount** that you want to send along with the messages and the **query id** of that message. + - `opts`: configuration of **total ton amount** that you want to send along with the messages and the **query id** of that message. - - `timeoutTimestamp`: timeout timestamp of packet. + - `timeoutTimestamp`: timeout timestamp of packet. - - `memo`: [memo](./universal-swap-memo.md) is used for UniversalSwap which will be executed when the token reached to Oraichain. + - `memo`: [memo](./universal-swap-memo.md) is used for UniversalSwap which will be executed when the token reached to Oraichain.Tools
LanguageTool
[uncategorized] ~69-~69: Loose punctuation mark.
Context: .... Parameters: -cosmosRecipient: recipient address on cosmos destination...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~70-~70: Loose punctuation mark.
Context: ... on cosmos destination chain. -amount: amount of token that you want to send. ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~71-~71: Loose punctuation mark.
Context: ...f token that you want to send. -denom: denom of the token, which will decide i...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~72-~72: Loose punctuation mark.
Context: ...n** or bridge_jetton_token. -opts: configuration of total ton amount t...(UNLIKELY_OPENING_PUNCTUATION)
[style] ~72-~72: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ration of total ton amount that you want to send along with the messages and the **...(REP_WANT_TO_VB)
[uncategorized] ~73-~73: Loose punctuation mark.
Context: ...** of that message. -timeoutTimestamp: timeout timestamp of packet. -memo: ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~74-~74: Loose punctuation mark.
Context: ...: timeout timestamp of packet. -memo`: memo is use...(UNLIKELY_OPENING_PUNCTUATION)
115-115: Remove the colon from the heading.Trailing punctuation in headings is unnecessary.
-#### For integration on Web browser client: +#### For integration on Web browser clientTools
Markdownlint
115-115: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
121-121: Remove the colon from the heading.Trailing punctuation in headings is unnecessary.
-##### With bridging ton case: +##### With bridging ton caseTools
Markdownlint
121-121: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
138-140: Remove the loose punctuation marks from the parameter descriptions.The colons at the beginning of each list item are unnecessary.
- - `data` : data for building bridge ton cell. + - `data`: data for building bridge ton cell. - - `remoteCosmosData`: cosmos address in bech32. + - `remoteCosmosData`: cosmos address in bech32. - - `ops`: configuration of **total ton amount** that you want to send along with the messages and the **query id** of that message. + - `ops`: configuration of **total ton amount** that you want to send along with the messages and the **query id** of that message.Tools
LanguageTool
[uncategorized] ~138-~138: Loose punctuation mark.
Context: ...eOps); } ``` Parameters: -data: data for building bridge ton cell. - `r...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~139-~139: Loose punctuation mark.
Context: ...ng bridge ton cell. -remoteCosmosData: cosmos address in bech32. -ops: conf...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~140-~140: Loose punctuation mark.
Context: ...Data: cosmos address in bech32. -ops`: configuration of total ton amount t...(UNLIKELY_OPENING_PUNCTUATION)
142-142: Remove the colon from the heading and add a comma before the heading.Trailing punctuation in headings is unnecessary. Also, a comma is missing before the heading.
-**query id** of that message. ##### With bridging jetton token case: +**query id** of that message, ##### With bridging jetton token caseTools
LanguageTool
[uncategorized] ~142-~142: Possible missing comma found.
Context: ...query id** of that message. ##### With bridging jetton token case: ```ts interface Sen...(AI_HYDRA_LEO_MISSING_COMMA)
Markdownlint
142-142: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
162-164: Remove the loose punctuation marks from the parameter descriptions.The colons at the beginning of each list item are unnecessary.
- - `data` : data for building bridge jetton cell. + - `data`: data for building bridge jetton cell. - - `responseAddress`: address for receiving redundant fee ton. + - `responseAddress`: address for receiving redundant fee ton. - - `queryId`: **query id** of that message. + - `queryId`: **query id** of that message.Tools
LanguageTool
[uncategorized] ~162-~162: Loose punctuation mark.
Context: ... = 0); } ``` Parameters: -data: data for building bridge jetton cell. -...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~163-~163: Loose punctuation mark.
Context: ... bridge jetton cell. -responseAddress: address for receiving redundant fee ton...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~164-~164: Loose punctuation mark.
Context: ...receiving redundant fee ton. -queryId: query id of that message. **Exampl...(UNLIKELY_OPENING_PUNCTUATION)
222-222: Remove the colon from the heading and change the heading level to h3.Trailing punctuation in headings is unnecessary. Also, the heading level should only increment by one level at a time.
-#### For integration on Node.JS server: +### For integration on Node.js serverAlso, the official spelling of the framework is "Node.js".
Tools
LanguageTool
[uncategorized] ~222-~222: The official spelling of this programming framework is “Node.js”.
Context: ...aichain to Ton #### For integration on Node.JS server: ```ts const TON_NATIVE = "ton"...(NODE_JS)
Markdownlint
222-222: Expected: h3; Actual: h4
Heading levels should only increment by one level at a time(MD001, heading-increment)
222-222: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
241-244: Remove the loose punctuation marks from the parameter descriptions.The colons at the beginning of each list item are unnecessary.
- - `tonRecipient` : ton recipient address. + - `tonRecipient`: ton recipient address. - - `amount`: amount of token that you want to send. + - `amount`: amount of token that you want to send. - - `tokenDenomOnTon`: token denom address on ton. With ton native token it will be **ton zero address** and with jetton token, it will be **jetton master address**. + - `tokenDenomOnTon`: token denom address on ton. With ton native token it will be **ton zero address** and with jetton token, it will be **jetton master address**. - - `timeoutTimestamp`: timeout timestamp of packet. + - `timeoutTimestamp`: timeout timestamp of packet.Tools
LanguageTool
[uncategorized] ~241-~241: Loose punctuation mark.
Context: ... ``` Parameters: -tonRecipient: ton recipient address. - `amount`: amou...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~242-~242: Loose punctuation mark.
Context: ...ent: ton recipient address. -amount`: amount of token that you want to send. ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~243-~243: Loose punctuation mark.
Context: ...at you want to send. -tokenDenomOnTon: token denom address on ton. With ton na...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~244-~244: Loose punctuation mark.
Context: ...n master address**. -timeoutTimestamp: timeout timestamp of packet. **Example...(UNLIKELY_OPENING_PUNCTUATION)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- specs/obridge/background.md (1 hunks)
- specs/obridge/orai-ton.md (1 hunks)
Additional context used
Markdownlint
specs/obridge/background.md
47-47: null
No empty links(MD042, no-empty-links)
49-49: null
No empty links(MD042, no-empty-links)
specs/obridge/orai-ton.md
222-222: Expected: h3; Actual: h4
Heading levels should only increment by one level at a time(MD001, heading-increment)
21-21: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
43-43: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
115-115: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
121-121: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
142-142: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
222-222: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
286-286: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
290-290: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
317-317: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
LanguageTool
specs/obridge/orai-ton.md
[uncategorized] ~43-~43: The official spelling of this programming framework is “Node.js”.
Context: ...-based tokens. #### For integration on Node.JS server: ```ts const TON_NATIVE = "ton"...(NODE_JS)
[uncategorized] ~69-~69: Loose punctuation mark.
Context: .... Parameters: -cosmosRecipient: recipient address on cosmos destination...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~70-~70: Loose punctuation mark.
Context: ... on cosmos destination chain. -amount: amount of token that you want to send. ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~71-~71: Loose punctuation mark.
Context: ...f token that you want to send. -denom: denom of the token, which will decide i...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~72-~72: Loose punctuation mark.
Context: ...n** or bridge_jetton_token. -opts: configuration of total ton amount t...(UNLIKELY_OPENING_PUNCTUATION)
[style] ~72-~72: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ration of total ton amount that you want to send along with the messages and the **...(REP_WANT_TO_VB)
[uncategorized] ~73-~73: Loose punctuation mark.
Context: ...** of that message. -timeoutTimestamp: timeout timestamp of packet. -memo: ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~74-~74: Loose punctuation mark.
Context: ...: timeout timestamp of packet. -memo`: memo is use...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~138-~138: Loose punctuation mark.
Context: ...eOps); } ``` Parameters: -data: data for building bridge ton cell. - `r...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~139-~139: Loose punctuation mark.
Context: ...ng bridge ton cell. -remoteCosmosData: cosmos address in bech32. -ops: conf...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~140-~140: Loose punctuation mark.
Context: ...Data: cosmos address in bech32. -ops`: configuration of total ton amount t...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~142-~142: Possible missing comma found.
Context: ...query id** of that message. ##### With bridging jetton token case: ```ts interface Sen...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~162-~162: Loose punctuation mark.
Context: ... = 0); } ``` Parameters: -data: data for building bridge jetton cell. -...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~163-~163: Loose punctuation mark.
Context: ... bridge jetton cell. -responseAddress: address for receiving redundant fee ton...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~164-~164: Loose punctuation mark.
Context: ...receiving redundant fee ton. -queryId: query id of that message. **Exampl...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~222-~222: The official spelling of this programming framework is “Node.js”.
Context: ...aichain to Ton #### For integration on Node.JS server: ```ts const TON_NATIVE = "ton"...(NODE_JS)
[uncategorized] ~241-~241: Loose punctuation mark.
Context: ... ``` Parameters: -tonRecipient: ton recipient address. - `amount`: amou...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~242-~242: Loose punctuation mark.
Context: ...ent: ton recipient address. -amount`: amount of token that you want to send. ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~243-~243: Loose punctuation mark.
Context: ...at you want to send. -tokenDenomOnTon: token denom address on ton. With ton na...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~244-~244: Loose punctuation mark.
Context: ...n master address**. -timeoutTimestamp: timeout timestamp of packet. **Example...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~288-~288: Did you mean “I”?
Context: ...ion on Web browser client: At the time i write this docs, `@oraichain/tonbridge-...(I_LOWERCASE_PREMIUM)
[grammar] ~288-~288: The singular determiner ‘this’ may not agree with the plural noun ‘docs’. Did you mean “these”?
Context: ...eb browser client: At the time i write this docs,@oraichain/tonbridge-sdkdoes n...(THIS_NNS)
[style] ~288-~288: Unless you want to emphasize “not”, use “cannot” which is more common.
Context: ...ient since it is using ton wallet which can not be used for client. Temporarily, I will...(CAN_NOT_PREMIUM)
[uncategorized] ~313-~313: Loose punctuation mark.
Context: ...ult>; } ``` Parameters: -denom: ton denom address on Ton Network (**ZER...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~314-~314: Loose punctuation mark.
Context: ...ss** if it is jetton token). -timeout: timeout timestamp of packet. -to: to...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~315-~315: Loose punctuation mark.
Context: ...ut: timeout timestamp of packet. -to`: ton recipient address. ##### With jett...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~331-~331: Loose punctuation mark.
Context: ...ring; } ``` Parameters: -denom: ton denom address on Ton Network (**ZER...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~332-~332: Loose punctuation mark.
Context: ...ss** if it is jetton token). -timeout: timeout timestamp of packet. -to: to...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~333-~333: Loose punctuation mark.
Context: ...ut: timeout timestamp of packet. -to`: ton recipient address. **Examples for ...(UNLIKELY_OPENING_PUNCTUATION)
Additional comments not posted (7)
specs/obridge/background.md (1)
1-49: LGTM!The documentation provides a clear and concise overview of the Obridge project, its working, and supported chains. The changes are approved.
Tools
Markdownlint
47-47: null
No empty links(MD042, no-empty-links)
49-49: null
No empty links(MD042, no-empty-links)
specs/obridge/orai-ton.md (6)
45-60: LGTM!The code changes are approved.
78-113: LGTM!The code changes are approved.
123-133: LGTM!The code changes are approved.
144-157: LGTM!The code changes are approved.
168-218: LGTM!The code changes are approved.
224-237: LGTM!The code changes are approved.
There was a problem hiding this comment.
Actionable comments posted: 1
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- specs/obridge/orai-ton.md (1 hunks)
Additional context used
LanguageTool
specs/obridge/orai-ton.md
[uncategorized] ~63-~63: Possible missing comma found.
Context: ...will send to Jetton Wallet contract first then it will be forwarded to **Bridge A...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~67-~67: Loose punctuation mark.
Context: .... Parameters: -cosmosRecipient: recipient address on cosmos destination...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~68-~68: Loose punctuation mark.
Context: ... on cosmos destination chain. -amount: amount of token that you want to send. ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~69-~69: Loose punctuation mark.
Context: ...f token that you want to send. -denom: denom of the token, which will decide i...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~70-~70: Loose punctuation mark.
Context: ...n** or bridge_jetton_token. -opts: configuration of total ton amount t...(UNLIKELY_OPENING_PUNCTUATION)
[style] ~70-~70: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ration of total ton amount that you want to send along with the messages and the **...(REP_WANT_TO_VB)
[uncategorized] ~71-~71: Loose punctuation mark.
Context: ...** of that message. -timeoutTimestamp: timeout timestamp of packet. -memo: ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~72-~72: Loose punctuation mark.
Context: ...: timeout timestamp of packet. -memo`: memo is use...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~72-~72: Possible missing comma found.
Context: ...](./universal-swap-memo.md) is used for UniversalSwap which will be executed when the token r...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~75-~75: Possible missing comma found.
Context: ...en reached to Oraichain. Example: Here we use@oraichain/tonbridge-sdkfor i...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~216-~216: Loose punctuation mark.
Context: ... main(); ``` Parameters: -data: data for building bridge jetton cell. -...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~217-~217: Loose punctuation mark.
Context: ... bridge jetton cell. -responseAddress: address for receiving redundant fee ton...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~218-~218: Loose punctuation mark.
Context: ...receiving redundant fee ton. -queryId: query id of that message. **Exampl...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~293-~293: Loose punctuation mark.
Context: ... ``` Parameters: -tonRecipient: ton recipient address. - `amount`: amou...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~294-~294: Loose punctuation mark.
Context: ...ent: ton recipient address. -amount`: amount of token that you want to send. ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~295-~295: Loose punctuation mark.
Context: ...at you want to send. -tokenDenomOnTon: token denom address on ton. With ton na...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~296-~296: Loose punctuation mark.
Context: ...n master address**. -timeoutTimestamp: timeout timestamp of packet. **Example...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~299-~299: Possible missing comma found.
Context: ...ut timestamp of packet. Examples: Here we use@oraichain/tonbridge-sdkfor i...(AI_HYDRA_LEO_MISSING_COMMA)
Markdownlint
specs/obridge/orai-ton.md
21-21: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
Additional comments not posted (2)
specs/obridge/orai-ton.md (2)
34-212: LGTM!The code changes are approved.
Tools
LanguageTool
[uncategorized] ~63-~63: Possible missing comma found.
Context: ...will send to Jetton Wallet contract first then it will be forwarded to **Bridge A...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~67-~67: Loose punctuation mark.
Context: .... Parameters: -cosmosRecipient: recipient address on cosmos destination...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~68-~68: Loose punctuation mark.
Context: ... on cosmos destination chain. -amount: amount of token that you want to send. ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~69-~69: Loose punctuation mark.
Context: ...f token that you want to send. -denom: denom of the token, which will decide i...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~70-~70: Loose punctuation mark.
Context: ...n** or bridge_jetton_token. -opts: configuration of total ton amount t...(UNLIKELY_OPENING_PUNCTUATION)
[style] ~70-~70: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ration of total ton amount that you want to send along with the messages and the **...(REP_WANT_TO_VB)
[uncategorized] ~71-~71: Loose punctuation mark.
Context: ...** of that message. -timeoutTimestamp: timeout timestamp of packet. -memo: ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~72-~72: Loose punctuation mark.
Context: ...: timeout timestamp of packet. -memo`: memo is use...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~72-~72: Possible missing comma found.
Context: ...](./universal-swap-memo.md) is used for UniversalSwap which will be executed when the token r...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~75-~75: Possible missing comma found.
Context: ...en reached to Oraichain. Example: Here we use@oraichain/tonbridge-sdkfor i...(AI_HYDRA_LEO_MISSING_COMMA)
274-423: LGTM!The code changes are approved.
Tools
LanguageTool
[uncategorized] ~293-~293: Loose punctuation mark.
Context: ... ``` Parameters: -tonRecipient: ton recipient address. - `amount`: amou...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~294-~294: Loose punctuation mark.
Context: ...ent: ton recipient address. -amount`: amount of token that you want to send. ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~295-~295: Loose punctuation mark.
Context: ...at you want to send. -tokenDenomOnTon: token denom address on ton. With ton na...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~296-~296: Loose punctuation mark.
Context: ...n master address**. -timeoutTimestamp: timeout timestamp of packet. **Example...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~299-~299: Possible missing comma found.
Context: ...ut timestamp of packet. Examples: Here we use@oraichain/tonbridge-sdkfor i...(AI_HYDRA_LEO_MISSING_COMMA)
| <img src="./image/ton_to_orai.png" alt="Ton to Oraichain" width="1200"> | ||
| <!--  --> |
There was a problem hiding this comment.
Fix the image path.
The image is not rendering correctly because the image path is incorrect. Update the image path to be relative to the current file.
Apply this diff to fix the image path:
-<img src="./image/ton_to_orai.png" alt="Ton to Oraichain" width="1200">
-<!--  -->
+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.
| <img src="./image/ton_to_orai.png" alt="Ton to Oraichain" width="1200"> | |
| <!--  --> | |
|  |
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- specs/obridge/orai-ton.md (1 hunks)
Additional context used
LanguageTool
specs/obridge/orai-ton.md
[uncategorized] ~63-~63: Possible missing comma found.
Context: ...will send to Jetton Wallet contract first then it will be forwarded to **Bridge A...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~67-~67: Loose punctuation mark.
Context: .... Parameters: -cosmosRecipient: recipient address on cosmos destination...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~68-~68: Loose punctuation mark.
Context: ... on cosmos destination chain. -amount: amount of token that you want to send. ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~69-~69: Loose punctuation mark.
Context: ...f token that you want to send. -denom: denom of the token, which will decide i...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~70-~70: Loose punctuation mark.
Context: ...n** or bridge_jetton_token. -opts: configuration of total ton amount t...(UNLIKELY_OPENING_PUNCTUATION)
[style] ~70-~70: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ration of total ton amount that you want to send along with the messages and the **...(REP_WANT_TO_VB)
[uncategorized] ~71-~71: Loose punctuation mark.
Context: ...** of that message. -timeoutTimestamp: timeout timestamp of packet. -memo: ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~72-~72: Loose punctuation mark.
Context: ...: timeout timestamp of packet. -memo`: memo is use...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~72-~72: Possible missing comma found.
Context: ...](./universal-swap-memo.md) is used for UniversalSwap which will be executed when the token r...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~75-~75: Possible missing comma found.
Context: ...en reached to Oraichain. Example: Here we use@oraichain/tonbridge-sdkfor i...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~292-~292: Loose punctuation mark.
Context: ... main(); ``` Parameters: -data: data for building bridge jetton cell. -...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~293-~293: Loose punctuation mark.
Context: ... bridge jetton cell. -responseAddress: address for receiving redundant fee ton...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~294-~294: Loose punctuation mark.
Context: ...receiving redundant fee ton. -queryId: query id of that message. **Exampl...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~369-~369: Loose punctuation mark.
Context: ... ``` Parameters: -tonRecipient: ton recipient address. - `amount`: amou...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~370-~370: Loose punctuation mark.
Context: ...ent: ton recipient address. -amount`: amount of token that you want to send. ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~371-~371: Loose punctuation mark.
Context: ...at you want to send. -tokenDenomOnTon: token denom address on ton. With ton na...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~371-~371: Possible missing comma found.
Context: ...n denom address on ton. With ton native token it will be ton zero address and wit...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~372-~372: Loose punctuation mark.
Context: ...n master address**. -timeoutTimestamp: timeout timestamp of packet. **Example...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~375-~375: Possible missing comma found.
Context: ...ut timestamp of packet. Examples: Here we use@oraichain/tonbridge-sdkfor i...(AI_HYDRA_LEO_MISSING_COMMA)
Markdownlint
specs/obridge/orai-ton.md
21-21: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
Additional comments not posted (5)
specs/obridge/orai-ton.md (5)
3-6: LGTM!The "Overview" section provides a clear and concise introduction to the Ton Bridge.
7-20: LGTM!The "Ton Contract" and "Oraichain Contract" sections provide the necessary contract addresses for the bridge.
21-31: LGTM!The "Workflows" section provides a clear overview of the token transfer workflows between Ton and Oraichain.
Tools
Markdownlint
21-21: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
34-349: LGTM!The "Ton to Oraichain" section provides clear instructions and code examples for bridging tokens from Ton to Oraichain. The code examples are correct and follow best practices.
Tools
LanguageTool
[uncategorized] ~63-~63: Possible missing comma found.
Context: ...will send to Jetton Wallet contract first then it will be forwarded to **Bridge A...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~67-~67: Loose punctuation mark.
Context: .... Parameters: -cosmosRecipient: recipient address on cosmos destination...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~68-~68: Loose punctuation mark.
Context: ... on cosmos destination chain. -amount: amount of token that you want to send. ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~69-~69: Loose punctuation mark.
Context: ...f token that you want to send. -denom: denom of the token, which will decide i...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~70-~70: Loose punctuation mark.
Context: ...n** or bridge_jetton_token. -opts: configuration of total ton amount t...(UNLIKELY_OPENING_PUNCTUATION)
[style] ~70-~70: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ration of total ton amount that you want to send along with the messages and the **...(REP_WANT_TO_VB)
[uncategorized] ~71-~71: Loose punctuation mark.
Context: ...** of that message. -timeoutTimestamp: timeout timestamp of packet. -memo: ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~72-~72: Loose punctuation mark.
Context: ...: timeout timestamp of packet. -memo`: memo is use...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~72-~72: Possible missing comma found.
Context: ...](./universal-swap-memo.md) is used for UniversalSwap which will be executed when the token r...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~75-~75: Possible missing comma found.
Context: ...en reached to Oraichain. Example: Here we use@oraichain/tonbridge-sdkfor i...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~292-~292: Loose punctuation mark.
Context: ... main(); ``` Parameters: -data: data for building bridge jetton cell. -...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~293-~293: Loose punctuation mark.
Context: ... bridge jetton cell. -responseAddress: address for receiving redundant fee ton...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~294-~294: Loose punctuation mark.
Context: ...receiving redundant fee ton. -queryId: query id of that message. **Exampl...(UNLIKELY_OPENING_PUNCTUATION)
350-423: LGTM!The "Oraichain to Ton" section provides clear instructions and code examples for bridging tokens from Oraichain to Ton. The code examples are correct and follow best practices.
Tools
LanguageTool
[uncategorized] ~369-~369: Loose punctuation mark.
Context: ... ``` Parameters: -tonRecipient: ton recipient address. - `amount`: amou...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~370-~370: Loose punctuation mark.
Context: ...ent: ton recipient address. -amount`: amount of token that you want to send. ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~371-~371: Loose punctuation mark.
Context: ...at you want to send. -tokenDenomOnTon: token denom address on ton. With ton na...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~371-~371: Possible missing comma found.
Context: ...n denom address on ton. With ton native token it will be ton zero address and wit...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~372-~372: Loose punctuation mark.
Context: ...n master address**. -timeoutTimestamp: timeout timestamp of packet. **Example...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~375-~375: Possible missing comma found.
Context: ...ut timestamp of packet. Examples: Here we use@oraichain/tonbridge-sdkfor i...(AI_HYDRA_LEO_MISSING_COMMA)
Summary by CodeRabbit
New Features
Documentation