@indigo-labs/indigo-sdk
v0.2.41
Published
Indigo SDK for interacting with Indigo endpoints via lucid-evolution
Maintainers
Readme
Indigo SDK
** Not ready for production yet **
indigo-sdk is a TypeScript SDK designed to interact with Indigo endpoints for managing CDPs (Collateralized Debt Positions), Staking Positions, and Stability Pool Accounts by integrating the lucid-evolution library.
Installation
npm install @indigo-labs/indigo-sdkDevelopment
Prerequisites
- Node.js (version specified in
.nvmrc) - pnpm package manager
Setup
- Clone this repository
- Install dependencies:
pnpm install - Build the project:
pnpm run build
Available Scripts
pnpm run build- Build the project using tsuppnpm run lint- Run ESLint to check code qualitypnpm run format- Format code using Prettierpnpm run format:check- Check if code is properly formattedpnpm run test- Run tests using Vitest
Code Quality
This project uses:
- ESLint for code linting and quality checks
- Prettier for code formatting
- TypeScript for type safety
Running Tests
There are currently a few unit tests available for datums, hash checks, and interest calculations. Additionally, acceptance tests have been published for CDPs, Staking Positions, and Stability Pool accounts. These tests initialize the Indigo Protocol and positively test that the transaction building is working in an emulated Cardano Blockchain.
Instructions:
- Clone this repository
- Run
pnpm install - Run
pnpm run test
Endpoints
- Open CDP
- Close CDP
- Deposit Collateral to CDP
- Withdraw Collateral from CDP
- Mint against CDP
- Burn against CDP
- Pay CDP Interest
- Open a Staking Position
- Adjust a Staking Position
- Close a Staking Position
- Open a Stability Pool Account
- Adjust a Stability Pool Account
- Close a Stability Pool Account
