getter-function-example.md

Getter Function Example

import { EVM, EvmChain, FunctionOptions, FunctionReturn, toResult } from '@heyanon/sdk';
import { Address, formatUnits } from 'viem';
import { ssrAbi, strAbi } from '../abis';
import { SSR_ADDRESS, STR_ADDRESS, supportedChains } from '../constants';

interface Props {
	chainName: string;
	account: Address;
}

const { getChainFromName } = EVM.utils;

export async function getUserPositionOnSKY({ chainName, account }: Props, { evm: { getProvider } }: FunctionOptions): Promise<FunctionReturn> {
	const chainId = getChainFromName(chainName as EvmChain);
	if (!chainId) return toResult(`Unsupported chain name: ${chainName}`, true);
	if (!supportedChains.includes(chainId)) return toResult(`Sky protocol is not supported on ${chainName}`, true);

	const publicClient = getProvider(chainId);

	// Get STR data
	const [stakedBalance, earnedRewards] = await Promise.all([
		publicClient.readContract({
			address: STR_ADDRESS,
			abi: strAbi,
			functionName: 'balanceOf',
			args: [account],
		}),
		publicClient.readContract({
			address: STR_ADDRESS,
			abi: strAbi,
			functionName: 'earned',
			args: [account],
		}),
	]);

	// Get SSR data
	const maxWithdraw = await publicClient.readContract({
		address: SSR_ADDRESS,
		abi: ssrAbi,
		functionName: 'maxWithdraw',
		args: [account],
	});

	return toResult(
		`Sky Protocol Position:\n` +
			`STR:\n` +
			`- Staked USDS: ${formatUnits(stakedBalance, 18)} USDS\n` +
			`- Pending SKY rewards: ${formatUnits(earnedRewards, 18)} SKY\n` +
			`SSR:\n` +
			`- Available to withdraw: ${formatUnits(maxWithdraw, 18)} USDS`,
	);
}

Key Points:

• Validates input arguments.
• Does not use sendTransactions.
• Ensures data returned does not exceed 500 tokens.
• Returns the result using toResult.
• Includes JSDoc comments.