Installation

Package manager commands

npm

npm install @satsterminal-sdk/borrow

yarn

yarn add @satsterminal-sdk/borrow

pnpm

pnpm add @satsterminal-sdk/borrow

Requirements

Node.js 16.x or higher
TypeScript 5.0+ (recommended)
A Bitcoin wallet provider (e.g., Xverse, Leather, UniSat)

Peer Dependencies

The SDK has no external runtime dependencies. It’s designed to be lightweight and work in both browser and Node.js environments.

TypeScript Support

The SDK is written in TypeScript and includes full type definitions. No additional @types packages are required.

import {
  BorrowSDK,
  BorrowSDKConfig,
  ChainType,
  Quote,
  UserTransaction
} from '@satsterminal-sdk/borrow';

Verification

Verify the installation by importing the SDK:

import { BorrowSDK } from '@satsterminal-sdk/borrow';

console.log('SDK imported successfully');

Next Steps

Continue to Quick Start to create your first loan. Building a React application? Continue to UI Components to install editable borrowing interfaces backed by this SDK.

Overview

Suite

UI Components

Swaps

Borrow

Bridge

Earn

Installation

Installation

Package manager commands

Requirements

Peer Dependencies

TypeScript Support

Verification

Next Steps

​Installation

​Package manager commands

​Requirements

​Peer Dependencies

​TypeScript Support

​Verification

​Next Steps

Installation

Package manager commands

Requirements

Peer Dependencies

TypeScript Support

Verification

Next Steps