Skip to content

chore(deps)!: make algosdk a peer dependency #19

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.

Sign up for GitHub

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

Merged
drichar merged 3 commits into from
Nov 3, 2025
Merged

chore(deps)!: make algosdk a peer dependency #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3ca8236
chore(deps): make algosdk a peer dependency
drichar Nov 3, 2025
55d6036
docs: update installation instructions for algosdk peer dependency
drichar Nov 3, 2025
8857476
chore(examples): add algosdk dependency to all example projects
drichar Nov 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,17 @@ Once we reach v1.0.0 with all planned features, breaking changes will only be in

## Installation

The SDK requires `algosdk` as a peer dependency. Install both packages:

```bash
# npm
npm install @txnlab/nfd-sdk
npm install @txnlab/nfd-sdk algosdk

# yarn
yarn add @txnlab/nfd-sdk
yarn add @txnlab/nfd-sdk algosdk

# pnpm
pnpm add @txnlab/nfd-sdk
pnpm add @txnlab/nfd-sdk algosdk
```

## Quick Start
Expand Down
1 change: 1 addition & 0 deletions examples/api-search/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
},
"dependencies": {
"@txnlab/nfd-sdk": "^0.10.1",
"algosdk": "^3.5.2",
"react": "^18.2.0",
"react-dom": "^18.2.0"
},
Expand Down
2 changes: 1 addition & 1 deletion examples/claim-nfd/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"@algorandfoundation/algokit-utils": "^8.2.2",
"@txnlab/nfd-sdk": "^0.10.1",
"@txnlab/use-wallet-react": "^4.0.0",
"algosdk": "^3.2.0",
"algosdk": "^3.5.2",
"lute-connect": "^1.4.1",
"react": "^18.2.0",
"react-dom": "^18.2.0"
Expand Down
2 changes: 1 addition & 1 deletion examples/link-address/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"@algorandfoundation/algokit-utils": "^8.2.2",
"@txnlab/nfd-sdk": "^0.10.1",
"@txnlab/use-wallet-react": "^4.0.0",
"algosdk": "^3.2.0",
"algosdk": "^3.5.2",
"lute-connect": "^1.4.1",
"react": "^18.2.0",
"react-dom": "^18.2.0"
Expand Down
2 changes: 1 addition & 1 deletion examples/mint/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"@algorandfoundation/algokit-utils": "^8.2.2",
"@txnlab/nfd-sdk": "^0.10.1",
"@txnlab/use-wallet-react": "^4.0.0",
"algosdk": "^3.2.0",
"algosdk": "^3.5.2",
"lute-connect": "^1.4.1",
"react": "^18.2.0",
"react-dom": "^18.2.0"
Expand Down
1 change: 1 addition & 0 deletions examples/nfd-metadata/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
},
"dependencies": {
"@txnlab/nfd-sdk": "^0.10.1",
"algosdk": "^3.5.2",
"react": "^18.2.0",
"react-dom": "^18.2.0"
},
Expand Down
1 change: 1 addition & 0 deletions examples/resolve/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
},
"dependencies": {
"@txnlab/nfd-sdk": "^0.10.1",
"algosdk": "^3.5.2",
"react": "^18.2.0",
"react-dom": "^18.2.0"
},
Expand Down
1 change: 1 addition & 0 deletions examples/reverse-lookup/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
},
"dependencies": {
"@txnlab/nfd-sdk": "^0.10.1",
"algosdk": "^3.5.2",
"react": "^18.2.0",
"react-dom": "^18.2.0"
},
Expand Down
2 changes: 1 addition & 1 deletion examples/set-metadata/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"@algorandfoundation/algokit-utils": "^8.2.2",
"@txnlab/nfd-sdk": "^0.10.1",
"@txnlab/use-wallet-react": "^4.0.0",
"algosdk": "^3.2.0",
"algosdk": "^3.5.2",
"lute-connect": "^1.4.1",
"react": "^18.2.0",
"react-dom": "^18.2.0"
Expand Down
2 changes: 1 addition & 1 deletion examples/set-primary-nfd/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"@algorandfoundation/algokit-utils": "^8.2.2",
"@txnlab/nfd-sdk": "^0.10.1",
"@txnlab/use-wallet-react": "^4.0.0",
"algosdk": "^3.2.0",
"algosdk": "^3.5.2",
"lute-connect": "^1.4.1",
"react": "^18.2.0",
"react-dom": "^18.2.0"
Expand Down
32 changes: 5 additions & 27 deletions packages/sdk/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,41 +2,19 @@

SDK for interacting with NFDomains (NFD) API and Algorand blockchain. This package provides methods for domain resolution, record fetching, minting, and address linking operations.

## Versioning

This SDK is in early development (pre-1.0.0) and may introduce breaking changes despite our best efforts to avoid them. We recommend pinning the version in your package.json:

```json
{
"dependencies": {
"@txnlab/nfd-sdk": "0.1.2"
}
}
```

Instead of using caret versioning:

```json
{
"dependencies": {
"@txnlab/nfd-sdk": "^0.1.2"
}
}
```

Once we reach v1.0.0 with all planned features, breaking changes will only be introduced via major version bumps following semantic versioning.

## Installation

The SDK requires `algosdk` as a peer dependency. Install both packages:

```bash
# npm
npm install @txnlab/nfd-sdk
npm install @txnlab/nfd-sdk algosdk

# yarn
yarn add @txnlab/nfd-sdk
yarn add @txnlab/nfd-sdk algosdk

# pnpm
pnpm add @txnlab/nfd-sdk
pnpm add @txnlab/nfd-sdk algosdk
```

## Quick Start
Expand Down
5 changes: 4 additions & 1 deletion packages/sdk/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,9 +68,11 @@
"dependencies": {
"@algorandfoundation/algokit-utils": "^8.2.2",
"@hey-api/client-fetch": "^0.8.1",
"algosdk": "^3.2.0",
"crypto-js": "^4.2.0"
},
"peerDependencies": {
"algosdk": "^3.0.0"
},
"devDependencies": {
"@algorandfoundation/algokit-client-generator": "^4.0.8",
"@hey-api/openapi-ts": "^0.64.5",
Expand All @@ -80,6 +82,7 @@
"@types/node-fetch": "^2.6.12",
"@vitest/coverage-v8": "^3.0.7",
"@vitest/ui": "^3.0.7",
"algosdk": "^3.5.2",
"dotenv": "^16.4.7",
"node-fetch": "^3.3.2",
"publint": "^0.3.6",
Expand Down
Loading