@concrete-xyz/sdk

SDK for interacting with vault contracts on multiple EVM networks.

Installation

npm install @concrete-xyz/sdk

Usage

import { getVault } from '@concrete-xyz/sdk';
import { ContractRunner, JsonRpcSigner } from 'ethers';

// Create a vault instance
const vault = getVault(
  '0x...', // vault address
  'Ethereum', // network name
  clientProvider, // ContractRunner instance
  signerProvider // optional JsonRpcSigner instance
);

// Use vault methods
const totalAssets = await vault.totalAssets();
const symbol = await vault.symbol();

Supported Networks

The SDK supports multiple EVM networks including:

• Ethereum
• Corn
• Morph
• Berachain
• Katana

Note: Network support may vary based on your specific deployment.

API Reference

getVault(address, network, clientProvider, signerProvider?)

Creates a new Vault instance for interacting with vault contracts.

Parameters:

• address (string): The vault contract address
• network (EnabledNetwork): The blockchain network name
• clientProvider (ContractRunner): Provider for read operations
• signerProvider (JsonRpcSigner, optional): Signer for write operations

Returns: Vault instance