@indigo-labs/indigo-sdk 0.1.1 → 0.1.3

package/.github/workflows/ci.yml

@@ -0,0 +1,62 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  lint-and-build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: '.nvmrc'
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: latest
+
+      - name: Get pnpm store directory
+        shell: bash
+        run: |
+          echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
+
+      - name: Setup pnpm cache
+        uses: actions/cache@v4
+        with:
+          path: ${{ env.STORE_PATH }}
+          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+          restore-keys: |
+            ${{ runner.os }}-pnpm-store-
+
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+
+      - name: Check formatting
+        run: pnpm run format:check
+
+      - name: Check linting
+        run: pnpm run lint
+
+      - name: Build project
+        run: pnpm run build
+
+      - name: Verify build output
+        run: |
+          if [ ! -d "dist" ]; then
+            echo "Build failed: dist directory not found"
+            exit 1
+          fi
+          if [ ! -f "dist/index.js" ] || [ ! -f "dist/index.mjs" ] || [ ! -f "dist/index.d.ts" ]; then
+            echo "Build failed: expected output files not found"
+            exit 1
+          fi
+          echo "Build verification passed"

package/.github/workflows/test.yml

@@ -0,0 +1,44 @@
+name: Tests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: '.nvmrc'
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: latest
+
+      - name: Get pnpm store directory
+        shell: bash
+        run: |
+          echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
+
+      - name: Setup pnpm cache
+        uses: actions/cache@v4
+        with:
+          path: ${{ env.STORE_PATH }}
+          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+          restore-keys: |
+            ${{ runner.os }}-pnpm-store-
+
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+
+      - name: Run tests
+        run: pnpm run test

package/.husky/pre-commit

@@ -0,0 +1 @@
+pnpm exec lint-staged

package/.prettierrc

@@ -3,4 +3,4 @@
   "trailingComma": "all",
   "tabWidth": 2,
   "semi": true
-}
+}

package/README.md

@@ -2,7 +2,52 @@
 
 ** Not ready for production yet **
 
-`indigo-sdk` is a TypeScript SDK designed to interact with Indigo endpoints for managing CDPs (Collateralized Debt Positions) by integrating the [lucid-evolution](https://github.com/Anastasia-Labs/lucid-evolution) library.
+`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](https://github.com/Anastasia-Labs/lucid-evolution) library.
+
+## Installation
+
+```bash
+npm install @indigo-labs/indigo-sdk
+```
+
+## Development
+
+### Prerequisites
+
+- Node.js (version specified in `.nvmrc`)
+- pnpm package manager
+
+### Setup
+
+1. Clone this repository
+2. Install dependencies: `pnpm install`
+3. Build the project: `pnpm run build`
+
+### Available Scripts
+
+- `pnpm run build` - Build the project using tsup
+- `pnpm run lint` - Run ESLint to check code quality
+- `pnpm run format` - Format code using Prettier
+- `pnpm run format:check` - Check if code is properly formatted
+- `pnpm 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:
+
+1. Clone this repository
+2. Run `pnpm install`
+3. Run `pnpm run test`
 
 ## Endpoints
 
@@ -13,9 +58,9 @@
 - **Mint against CDP**
 - **Burn against CDP**
 - **Pay CDP Interest**
-
-## Installation
-
-```bash
-npm install @indigo-labs/indigo-sdk
-```
+- **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**