Skip to main content

Installation

This guide will help you install and set up the Hoosat SDK in your project.

Prerequisites​

Before installing the SDK, make sure you have:

  • Node.js version 20.0.0 or higher
  • npm (comes with Node.js) or yarn or pnpm
  • TypeScript 5.0.0+ (optional but recommended)

Check Your Node.js Version​

node --version
# Should output v20.0.0 or higher

If you need to upgrade Node.js, visit nodejs.org.

Installation Methods​

Using npm​

npm install hoosat-sdk

Using yarn​

yarn add hoosat-sdk

Using pnpm​

pnpm add hoosat-sdk

Verify Installation​

After installation, verify that the package is installed correctly:

npm list hoosat-sdk

You should see output similar to:

your-project@1.0.0
└── hoosat-sdk@0.2.1

The SDK is written in TypeScript and includes full type definitions. For the best development experience, we recommend using TypeScript.

Initialize TypeScript in Your Project​

If you don't have TypeScript configured yet:

npm install --save-dev typescript @types/node
npx tsc --init
{
  "compilerOptions": {
    "target": "ES2020",
    "module": "commonjs",
    "lib": ["ES2020"],
    "outDir": "./dist",
    "rootDir": "./src",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true,
    "resolveJsonModule": true,
    "moduleResolution": "node"
  },
  "include": ["src/**/*"],
  "exclude": ["node_modules"]
}

First Import Test​

Create a test file to verify everything works:

test-sdk.ts (TypeScript):

import { HoosatClient, HoosatUtils } from 'hoosat-sdk';

console.log('Hoosat SDK imported successfully!');

// Test a utility function
const isValid = HoosatUtils.isValidAddress('hoosat:qz7ulu8z6sj9m7pdwm0g4tyjd3j2pycnf2q9nly9zmvnr6uqxdv4jqqruch02');
console.log('Address validation works:', isValid);

test-sdk.js (JavaScript):

const { HoosatClient, HoosatUtils } = require('hoosat-sdk');

console.log('Hoosat SDK imported successfully!');

const isValid = HoosatUtils.isValidAddress('hoosat:qz7ulu8z6sj9m7pdwm0g4tyjd3j2pycnf2q9nly9zmvnr6uqxdv4jqqruch02');
console.log('Address validation works:', isValid);

Run the Test​

TypeScript:

# Install tsx for running TypeScript directly
npm install -g tsx

# Run the test
tsx test-sdk.ts

JavaScript:

node test-sdk.js

Expected output:

Hoosat SDK imported successfully!
Address validation works: true

Next Steps​

Now that you have the SDK installed, continue with:

Troubleshooting​

Installation Issues​

Problem: npm install fails with permission errors

Solution: Use nvm to manage Node.js versions or check npm permissions

Problem: TypeScript compilation errors

Solution: Clear cache and reinstall dependencies

Problem: Module not found errors

Solution: Verify import syntax (ES6 vs CommonJS)

Package Information​

  • Latest Version: npm
  • Changelog: GitHub
  • License: MIT