npm-package-near-simple-account
v1.0.0
Published
npm Package - near-simple-account
Readme
npm-package-near-simple-account
Simple utilities for querying NEAR Protocol account data on mainnet.
Installation
npm install npm-package-near-simple-account
Functions
| Function | Description |
|---|---|
| getAccountBalance(accountId) | Returns account balance in NEAR as a string |
| accountExists(accountId) | Returns true if the account exists |
| getAccessKeys(accountId) | Returns list of access keys |
| getKeyNonce(accountId, publicKey) | Returns nonce for a given key |
| getStorageUsage(accountId) | Returns storage used in bytes |
Usage
import { getAccountBalance, accountExists, getAccessKeys, getKeyNonce, getStorageUsage, } from 'npm-package-near-simple-account';
// Get account balance in NEAR const balance = await getAccountBalance('alice.near'); console.log(balance); // e.g. "10"
// Check if an account exists const exists = await accountExists('alice.near'); console.log(exists); // true or false
// Get all access keys const keys = await getAccessKeys('alice.near'); console.log(keys);
// Get nonce for a specific public key const nonce = await getKeyNonce('alice.near', 'ed25519:ABC123...'); console.log(nonce);
// Get storage usage in bytes const storage = await getStorageUsage('alice.near'); console.log(storage);
Notes
- All functions query NEAR mainnet via
https://rpc.mainnet.near.org getAccountBalancereturns a whole-number NEAR string (truncated from yoctoNEAR)getAccessKeysreturnsproviders.KeyInfo[]fromnear-api-js
License
MIT
