Skip to content

Conversation

@drichar
Copy link
Contributor

@drichar drichar commented Nov 3, 2025

Summary

This PR makes algosdk a peer dependency, requiring users to install it separately. This change enables better version flexibility and reduces bundle size for consumers who may already have algosdk installed.

Changes

  • Package Configuration
    • Moved algosdk from dependencies to peerDependencies with version ^3.0.0
    • Added algosdk@^3.5.2 as a dev dependency for development and testing
  • Documentation
    • Updated installation instructions in root README to include algosdk
    • Updated installation instructions in SDK README to include algosdk
    • Removed versioning section from SDK README (breaking changes now follow semver)
  • Examples
    • Added algosdk@^3.5.2 to all example projects
    • Updated existing algosdk versions in examples to ^3.5.2

Breaking Change

algosdk is now a peer dependency and must be installed separately:

# Before
npm install @txnlab/nfd-sdk

# After
npm install @txnlab/nfd-sdk algosdk

Users must ensure they have algosdk ^3.0.0 installed alongside @txnlab/nfd-sdk.

Test Plan

  • Verify SDK builds successfully with algosdk as peer dependency
  • Verify all example projects have algosdk installed
  • Verify CI/PR workflows pass

BREAKING CHANGE: `algosdk` is now a peer dependency and must be installed separately. Users need to install `algosdk@^3.0.0` alongside `@txnlab/nfd-sdk`.
- Add `algosdk` to installation commands in README files
- Remove versioning section from SDK README (breaking changes now use semver)
- Add `algosdk@^3.5.2` to examples that were missing it
- Update `algosdk` to `^3.5.2` in examples that had older versions
@drichar drichar merged commit 9bb2746 into main Nov 3, 2025
1 check passed
@drichar drichar deleted the chore/algosdk-peer-dependency branch November 3, 2025 05:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants