@mlabs-haskell/feesaswap-sdk

@mlabs-haskell/feesaswap-sdk

TypeScript SDK for FeesaSwap API integration

Installation

npm install @mlabs-haskell/feesaswap-sdk

Quick Start

import { FeesaSwapSDK } from '@mlabs-haskell/feesaswap-sdk';

const sdk = new FeesaSwapSDK('http://localhost:3001', 'mainnet');

// Get supported assets
const assets = await sdk.getSupportedAssets();

// Balance a transaction
const balanceResponse = await sdk.balanceTransaction({
  addresses: ['addr1...'],
  change: 'addr1...',
  checkCollateral: false,
  collateral: 'collateral-cbor',
  strategy: 'default',
  swapAssets: ['lovelace'],
  tx: 'unbalanced-tx-cbor'
});

// Submit the signed transaction
const submitResponse = await sdk.submitTransaction({
  unsignedTx: balanceResponse.unsignedTx,
  witnesses: 'signed-witness'
});

API

Constructor

new FeesaSwapSDK(baseUrl: string, network: CardanoNetwork)

• baseUrl: API server URL (e.g., 'http://localhost:3001')
• network: Cardano network ("mainnet", "preprod", or "preview")

Methods

getSupportedAssets()

Retrieves the list of supported assets for fee payment.

const assets = await sdk.getSupportedAssets();

balanceTransaction(request)

Balances an unbalanced transaction with fee payment assets.

const response = await sdk.balanceTransaction({
  addresses: string[],       // Array of wallet addresses
  change: string,            // Change address
  checkCollateral: boolean,  // Whether to check collateral
  collateral: string,        // Collateral CBOR (optional)
  strategy: string,          // Balancing strategy ("default")
  swapAssets: string[],      // Assets to use for fees (e.g., ["lovelace"])
  tx: string                 // Unbalanced transaction CBOR
});

submitTransaction(request)

Submits a signed transaction to the blockchain.

const response = await sdk.submitTransaction({
  unsignedTx: string,        // Unsigned transaction CBOR
  witnesses: string          // Signed witnesses
});

Auto-Generated Types

This SDK uses auto-generated TypeScript types from the OpenAPI specification. The types are automatically generated from the FeesaSwap API schema and provide full type safety.

Development

Building

npm run build

Type Checking

npm run type-check

Updating API Types

When the API specification is updated:

npm run update-api

This will regenerate the TypeScript types from the latest OpenAPI schema.

License

MIT