npm-package-near-simple-key

A lightweight utility for working with NEAR Protocol key pairs and access keys.

Installation

npm install npm-package-near-simple-key

API & Usage

generateKeyPair()

Generate a new random ED25519 key pair.

import { generateKeyPair } from 'npm-package-near-simple-key';

const { publicKey, secretKey } = await generateKeyPair(); console.log(publicKey); // "ed25519:ABC..." console.log(secretKey); // "ed25519:XYZ..."

getPublicKey(secretKey)

Derive the public key from an existing secret key.

import { getPublicKey } from 'npm-package-near-simple-key';

const publicKey = await getPublicKey('ed25519:XYZ...'); console.log(publicKey); // "ed25519:ABC..."

getAccessKeys(accountId)

Fetch all access keys for a NEAR account from mainnet.

import { getAccessKeys } from 'npm-package-near-simple-key';

const keys = await getAccessKeys('alice.near'); keys.forEach(({ public_key, access_key }) => { console.log(public_key, access_key.nonce, access_key.permission); });

hasAccessKey(accountId, publicKey)

Check whether a specific public key exists on an account.

import { hasAccessKey } from 'npm-package-near-simple-key';

const exists = await hasAccessKey('alice.near', 'ed25519:ABC...'); console.log(exists); // true or false

signMessage(secretKey, message)

Sign a message with a secret key.

import { signMessage } from 'npm-package-near-simple-key';

const signature = await signMessage('ed25519:XYZ...', 'hello near'); console.log(signature);

License

MIT