bcnmy / bcnmy/sdk

✨ Feature Request: Add Test Suite for Multiple third party signers

Open
#128 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

Add comprehensive test cases demonstrating integration with different signer types, starting with ethers.js Signer. This will provide clear examples of how to use various signer implementations with the SDK.

### Benefits & Outcomes

- **Better Documentation**: Provide practical examples of integrating different signer types
- **Improved Developer Experience**: Make it easier for developers to use their preferred signer library
- **Compatibility Verification**: Ensure the SDK works correctly with popular signer implementations
- **Reduced Support Issues**: Prevent common integration problems through clear examples
- **Framework Flexibility**: Demonstrate SDK's ability to work with different Web3 frameworks

### Implementation Ideas

1. **Create New Test File**
- Structure tests by signer type
- Include setup and teardown for each signer type

2. **Common Scenarios to Test**

![Image](https://github.com/user-attachments/assets/86da9f52-b554-438a-b46a-28829746531d)

4. **Test Environment Setup**
- Add necessary test utilities
- Create mock providers
- Set up test accounts
- Configure test networks

5. **Documentation**
- Add detailed comments explaining signer setup
- Document any signer-specific considerations
- Include example snippets in docs
- Add troubleshooting notes

6. **Future Expansion**
- Structure tests to easily add more signer types
- Consider hardware wallet integration tests
- Add multi-signer scenario tests

### 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.