chainsmith-sdk v1.0.2-alpha.19

Chainsmith SDK WIP

Viem-compatible abstraction library to simplify the interaction with multiple blockchains via user-friendly high level APIs.

Current features of the SDK

• Support all chains listed in Viem library.
• Customizable plugins and adapters.
• Core plugins to query onchain portfolio, token metadata, token prices...
• Chain configuration with modifiable RPC URL settings.
• Plug-n-play different adapters to plugins depend on the use cases.

Getting Started

Install the dependency

npm install chainsmith-sdk

Supported Adapters

Initializing the SDK with Shared RPC Providers

The following example demonstrates how to initialize the SDK using Alchemy as the primary RPC provider for all registered chains.

import { initChainsmithSdk } from 'chainsmith-sdk';
import { alchemy } from 'chainsmith-sdk/rpc';
import { buildEvmChains } from 'chainsmith-sdk/utils';

const ALCHEMY_API_KEY = process.env.ALCHEMY_API_KEY || '';

// Helper method to build all EVM chains with Alchemy as the RPC provider.
export function buildDefaultChains(chainNames: TChainName[]) {
  return buildEvmChains(chainNames, alchemy(ALCHEMY_API_KEY))
}

// Build Base, Mainnet, and Optimism chains.
const chains = buildDefaultChains(['sonic', 'mainnet', 'base', 'optimism']);

// Initialize the Chainsmith SDK.
const sdk = initChainsmithSdk(chains);

The alchemy function is a built-in RPC endpoint provider in the SDK. If you need to customize the method, refer to the alchemy example in the SDK source code.

Initializing the SDK with Custom RPC Endpoints

If you want to use a custom RPC provider for a specific chain (e.g., Sonic chain), use buildChainsWithCustomRpcUrls to map TChainName to a custom RPC URL:

const chains = buildChainsWithCustomRpcUrls({ sonic: 'https://rpc.soniclabs.com' }, 'evm');

Using Plugins to Fetch a Multichain Portfolio

The example below fetches a multichain token portfolio using CoinMarketcap as the market data source and Alchemy for on-chain token activities.

const portfolio = await sdk.portfolio.getMultichainTokenPortfolio([
  AdapterRegistry.CoinMarketcap,
  AdapterRegistry.Alchemy,
])(Wallets.ETH_MAINNET_WALLET_JESSE);

Adapter Order Requirement

The order of the adapters in the plugin API must match the required interface order:

getMultichainTokenPortfolio: WithManyAdapters<
  [IMarketDataAdapter, IOnchainTokenAdapter],
  IGetMultichainTokenPortfolio
>;

Using Multiple Adapters as Fallback Data Providers

In cases where multiple data sources are required for fallback, the SDK provides extended adapters for advanced use cases.

multiple Adapter

The multiple function allows using two different market data adapters as fallback providers. The first adapter is prioritized, and if it fails to fetch the required data, the second adapter is used.

Example: Fetch Token Portfolio Using Two Market Data Adapters

In the example below, ShadowExchange is prioritized for fetching token price data. If no data is found, CoinMarketcap is used as a fallback.

const portfolio = await sdk.portfolio.getChainTokenPortfolio([
  multiple([AdapterRegistry.ShadowExchange, AdapterRegistry.CoinMarketcap]),
  AdapterRegistry.ShadowExchange,
])(Wallets.SONIC_WALLET_BEETS_TREASURY);

This approach ensures better reliability by using decentralized exchange (DEX) price data first and falling back to centralized market data if needed.