@silo-finance/adapter-common

Abstract adapter interfaces for Silo Finance SDKs. This package defines the contract that blockchain adapter implementations must fulfill.

Purpose

This package provides TypeScript interfaces that enable:

• Pluggable architecture: Swap between viem, ethers.js, or custom implementations
• Type safety: Consistent types across all adapters
• Future extensibility: Easy to add new blockchain libraries

Available Adapters

| Package | Status | Description | |---------|--------|-------------| | @silo-finance/adapter-viem | Available | Viem implementation | | @silo-finance/adapter-ethers | Coming soon | Ethers.js implementation |

Installation

pnpm add @silo-finance/adapter-common

Note: Most users should install @silo-finance/adapter-viem or @silo-finance/silo-sdk directly instead of this package.

Interfaces

Core Adapter Interfaces

import type {
  ReadAdapter,
  WriteAdapter,
} from "@silo-finance/adapter-common";

ReadAdapter - Read-only blockchain operations:

• readContract() - Read from a contract
• multicall() - Batch multiple contract reads
• getChainId() - Get current chain ID
• getBalance() - Get native token balance
• getBlockNumber() - Get current block number

WriteAdapter - Write operations (extends ReadAdapter):

• writeContract() - Send a transaction
• getAddress() - Get connected wallet address
• signMessage() - Sign a message
• waitForTransaction() - Wait for tx confirmation

Silo-Specific Interfaces

import type {
  MarketReadOperations,
  PositionReadOperations,
  TokenReadOperations,
  SiloWriteOperations,
  SiloReadAdapter,
  SiloWriteAdapter,
} from "@silo-finance/adapter-common";

MarketReadOperations:

• fetchMarket() - Fetch market data
• fetchSilo() - Fetch silo data
• fetchBorrowAPR() / fetchDepositAPR() - Fetch APRs
• fetchUtilization() - Fetch utilization rate
• fetchLiquidity() - Fetch available liquidity

PositionReadOperations:

• fetchPosition() - Fetch user position
• fetchUserLtv() - Fetch user LTV
• fetchIsSolvent() - Check solvency

TokenReadOperations:

• fetchTokenBalance() - Get token balance
• fetchAllowance() - Get token allowance
• fetchTokenMetadata() - Get token info

SiloWriteOperations:

• deposit() / withdraw() - Deposit/withdraw collateral
• borrow() / repay() - Borrow/repay debt
• approve() - Approve token spending

Combined Interfaces

// Complete read adapter
interface SiloReadAdapter extends
  ReadAdapter,
  MarketReadOperations,
  PositionReadOperations,
  TokenReadOperations {
  readonly chainId: number;
}

// Full adapter with write capabilities
interface SiloWriteAdapter extends
  SiloReadAdapter,
  WriteAdapter,
  SiloWriteOperations {}

Parameter Types

import type {
  PositionData,
  TokenMetadata,
  DepositParams,
  WithdrawParams,
  BorrowParams,
  RepayParams,
  ApproveParams,
} from "@silo-finance/adapter-common";

Creating a Custom Adapter

To create a custom adapter (e.g., for ethers.js):

import type { SiloWriteAdapter, CreateWriteAdapterFn } from "@silo-finance/adapter-common";

const createEthersAdapter: CreateWriteAdapterFn<EthersConfig> = (config) => {
  return {
    chainId: config.chainId,

    async readContract(params) {
      // Implement using ethers.js
    },

    async writeContract(params) {
      // Implement using ethers.js
    },

    // ... implement all other methods
  };
};

License

MIT