bcnmy / bcnmy/sdk

✨ Feature Request: Update Smart Sessions Module Contract Addresses

Open
#98 0 comments 0 reactions 1 assignee Claimed by @joepegler View on GitHub
enhancement
Dominant language
TypeScript
Stars
14
Forks
4
PR merge metrics
No merged PRs in 30d

Description

### 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:
```json
{
"peerDependencies": {
"@rhinestone/module-sdk": "^x.x.x"
}
}
```

2. Update the development dependency for @rhinestone/module-sdk (used for testing and development):
```json
{
"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

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

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

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

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

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

## References

- [@rhinestone/module-sdk package](https://www.npmjs.com/package/@rhinestone/module-sdk)
- [Nexus SDK Modules README](src/sdk/modules/README.md)
- [Smart Sessions Module Documentation]()
- [npm documentation on peer dependencies](https://docs.npmjs.com/cli/v7/configuring-npm/package-json#peerdependencies)

### Any References?

_No response_

### Code of Conduct

- [x] I agree to follow this project's Code of Conduct.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.