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

Fix typo README.md #4033

Open
wants to merge 1 commit into
base: stage
Choose a base branch
from
Open

Fix typo README.md #4033

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
2 changes: 1 addition & 1 deletion packages/bridge/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# @osmosis-labs/bridge

Provides a single API for for interacting with multiple bridge providers, with a focus on IBC asset info for a single chain. Relies on canonical chain and asset identifiers across ecosystems for identifying assets and chains. Some bridge providers include routing and swap aggregation capabilites. New providers can be added by implementing the `BridgeProvider` interface. The interface includes some optional components that can be used to support alternative bridge features, such as the `getDepositAddress` for briding via a send transaction to a generated deposit address.
Provides a single API for for interacting with multiple bridge providers, with a focus on IBC asset info for a single chain. Relies on canonical chain and asset identifiers across ecosystems for identifying assets and chains. Some bridge providers include routing and swap aggregation capabilities. New providers can be added by implementing the `BridgeProvider` interface. The interface includes some optional components that can be used to support alternative bridge features, such as the `getDepositAddress` for briding via a send transaction to a generated deposit address.
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Remove repeated word "for".

There is a duplicate word in the sentence: "API for for interacting".

Apply this diff to fix the typo:

-Provides a single API for for interacting with multiple bridge providers
+Provides a single API for interacting with multiple bridge providers
📝 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
Provides a single API for for interacting with multiple bridge providers, with a focus on IBC asset info for a single chain. Relies on canonical chain and asset identifiers across ecosystems for identifying assets and chains. Some bridge providers include routing and swap aggregation capabilities. New providers can be added by implementing the `BridgeProvider` interface. The interface includes some optional components that can be used to support alternative bridge features, such as the `getDepositAddress` for briding via a send transaction to a generated deposit address.
Provides a single API for interacting with multiple bridge providers, with a focus on IBC asset info for a single chain. Relies on canonical chain and asset identifiers across ecosystems for identifying assets and chains. Some bridge providers include routing and swap aggregation capabilities. New providers can be added by implementing the `BridgeProvider` interface. The interface includes some optional components that can be used to support alternative bridge features, such as the `getDepositAddress` for briding via a send transaction to a generated deposit address.
🧰 Tools
🪛 LanguageTool

[duplication] ~3-~3: Possible typo: you repeated a word.
Context: ...osis-labs/bridge Provides a single API for for interacting with multiple bridge provid...

(ENGLISH_WORD_REPEAT_RULE)


Providers are complemented with objects that implement the `TransferStatusProvider` interface. These objects provide updates on the status of a transfer transaction recommended by a bridge provider. The provider can then push these updates to the caller's implementation of the `TransferStatusReceiver` interface, using the transaction's hash. Depending on the needs of the caller the `TransferStatusReceiver` object can be implemented to provide updates to the UI or other observer.

Expand Down