chore(public): Improve Universal Router README with clearer instructions and example #119
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jfbloom22
requested review from
jsy1218,
dannythedawger and
cgkol
as code owners
jfbloom22
changed the title
zhongeric
reviewed
Oct 1, 2024
sdks/universal-router-sdk/README.md
Outdated
| import { Trade as V2TradeSDK } from '@uniswap/v2-sdk' | ||
| import { Trade as V3TradeSDK } from '@uniswap/v3-sdk' | ||
| import { MixedRouteTrade, MixedRouteSDK, Trade as RouterTrade } from '@uniswap/router-sdk' | ||
| import { Trade as V2TradeSDK } from '@uniswap/v2-sdk' |
sdks/universal-router-sdk/README.md
Outdated
| // const txResponse = await wallet.sendTransaction(tx) | ||
| // await txResponse.wait() | ||
|
|
||
| console.log('Transaction parameters:', tx) |
sdks/universal-router-sdk/README.md
Outdated
Comment on lines
52
to
54
| // Send the transaction using your preferred method (e.g., ethers.js, web3.js) | ||
| // const txResponse = await wallet.sendTransaction(tx) | ||
| // await txResponse.wait() |
There was a problem hiding this comment.
fine to uncomment this in my opinion!
sdks/universal-router-sdk/README.md
Outdated
Comment on lines
59
to
67
| This example demonstrates how to: | ||
| 1. Import necessary classes and functions from Uniswap SDKs | ||
| 2. Define tokens for the trade | ||
| 3. Create a trade object (simplified in this example) | ||
| 4. Set up trade options including slippage tolerance and recipient | ||
| 5. Generate the calldata and value for the swap | ||
| 6. Prepare a transaction object for sending to the Universal Router | ||
|
|
||
| Remember to handle errors, validate inputs, and implement proper transaction sending and confirmation in your actual implementation. |
There was a problem hiding this comment.
can simplify this to:
The code above is provided strictly as an example implementation of using the SDK to build a UniversalRouter swap.
sdks/universal-router-sdk/README.md
Outdated
Comment on lines
84
to
85
| ## Contributing | ||
| Contributions to improve the SDK or documentation are welcome. Please ensure you follow the existing code style and add appropriate tests for any new functionality. |
There was a problem hiding this comment.
remove, we can create a separate CONTRIBUTING.md in the future
zhongeric
approved these changes
Oct 1, 2024
zhongeric
approved these changes
Oct 3, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR updates the README of the universal-router-sdk to provide clearer and more comprehensive installation instructions. The changes include:
swapERC20CallParameters()These changes aim to make it easier for new users to get started with the SDK
How Has This Been Tested?
The changes in this PR are documentation updates and do not affect the codebase. However, I have:
Are there any breaking changes?
No, there are no breaking changes. This PR only updates the README file.
Feedback Focus
I'd appreciate feedback on:
Follow Ups
Potential follow-up tasks could include: