Add sessionToken parameter support to initOnRamp #306
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 & motivation
I propose extending the
initOnRamp
function by introducing support for asessionToken
parameter. This would allow users to initialize the function using eithersessionToken
orappId
.To ensure this update is fully integrated, I’ve updated the TypeScript types to include
sessionToken
as a valid parameter, maintaining type safety throughout the codebase. Additionally, I’ve written new test cases to confirm that thesessionToken
functionality works as expected and that there are no regressions with the current implementation.This change would enhance the current functionality without disrupting the existing workflow for those using
appId
.Also, the
generateOnRampURL()
should be able to generate a URL based on thesessionToken
only. IfsessionToken
has been specified, there is no need to provide theaddresses
parameter. Currently, it does work, and it's been fixed in this MR.Do you think this kind of update would fit with the project’s goals and be something worth including?
Testing & documentation
I've covered adding the
sessionToken
parameter with the unit test.