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.

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

✨ Feature Request: Update Smart Sessions Module Contract Addresses #98

Open
1 task done
joepegler opened this issue Oct 22, 2024 · 0 comments
Open
1 task done
Assignees
Labels
enhancement New feature or request

Comments

@joepegler
Copy link
Collaborator

Feature or Improvement Description

Update the Smart Sessions Module to use the latest contract addresses by upgrading the @rhinestone/module-sdk package to its latest version.

Benefits & Outcomes

  • Ensure the Smart Sessions Module is using the most up-to-date and secure contract implementations
  • Simplify the process of keeping contract addresses current by leveraging the @rhinestone/module-sdk package
  • Maintain consistency across all modules using the latest Rhinestone infrastructure
  • Reduce the risk of errors that could occur from manually setting addresses
  • Improve the overall reliability and security of the Smart Sessions Module

Implementation Ideas

  1. Update the peer dependency declaration for @rhinestone/module-sdk in the project's package.json:

    {
      "peerDependencies": {
        "@rhinestone/module-sdk": "^x.x.x"
      }
    }
  2. Update the development dependency for @rhinestone/module-sdk (used for testing and development):

    {
      "devDependencies": {
        "@rhinestone/module-sdk": "^x.x.x"
      }
    }
  3. Run the package update command for the development dependency:

    npm update @rhinestone/module-sdk
    

    or

    yarn upgrade @rhinestone/module-sdk
    
  4. Verify that the Smart Sessions Module is now using the updated contract addresses from the new package version

  5. Update any imports from @rhinestone/module-sdk if the new version has changed any import paths

  6. Remove any hardcoded contract addresses in the Smart Sessions Module, ensuring all addresses are now sourced from the updated package

  7. Run the test suite to ensure all functionality works with the new contract addresses

  8. Update any documentation that references specific contract addresses to instead point to the @rhinestone/module-sdk package as the source of truth

  9. If any breaking changes are introduced by the new package version, update the Smart Sessions Module code accordingly

  10. Create a changelog entry detailing the update and any changes in behavior (if applicable)

  11. Update the README to clearly state the peer dependency requirement for @rhinestone/module-sdk

References

Any References?

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct.
@joepegler joepegler added the enhancement New feature or request label Oct 22, 2024
@joepegler joepegler self-assigned this Oct 22, 2024
@joepegler joepegler changed the title # ✨ Feature Request: Update Smart Sessions Module Contract Addresses ✨ Feature Request: Update Smart Sessions Module Contract Addresses Nov 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant