npm-package-se-near-staking
v1.0.0
Published
npm Package - se-near-staking
Downloads
129
Readme
npm-package-se-near-staking
A lightweight npm package for interacting with NEAR Protocol staking pools on mainnet.
Installation
npm install npm-package-se-near-staking
Exported Functions
getStakingPools()— Fetch all active validators/staking poolsgetStakerInfo(accountId, poolId)— Get staked/unstaked balances for an accountgetRewards(accountId, poolId)— Retrieve earned staking rewardsgetValidatorStatus(poolId)— Check validator status and detailsgetTotalStaked(poolId)— Get total NEAR staked in a pooluseNearStaking()— React hook bundling all functions withloadinganderrorstate
Usage
import { getStakingPools, getStakerInfo, getRewards, getValidatorStatus, getTotalStaked, useNearStaking, } from 'npm-package-se-near-staking';
// Fetch all staking pools const pools = await getStakingPools(); // [{ poolId: 'pool.near', fee: 5, active: true }, ...]
// Get staker info const info = await getStakerInfo('alice.near', 'pool.near'); // { stakedBalance: '10000', unstakedBalance: '500', canWithdraw: true }
// Get rewards const rewards = await getRewards('alice.near', 'pool.near');
// Validator status const status = await getValidatorStatus('pool.near');
// Total staked in pool const total = await getTotalStaked('pool.near');
React Hook
function StakingDashboard() { const { getStakingPools, loading, error } = useNearStaking();
if (loading) return Loading...; if (error) return Error: {error};
return <button onClick={() => getStakingPools()}>Load Pools; }
License
MIT
