near-signature-utils

Utility functions for NEAR Protocol key management, message signing, and signature verification.

Installation

npm install near-signature-utils

API

generateKeyPair()

Generates a new NEAR key pair.

import { generateKeyPair } from 'near-signature-utils';

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

signMessage(message, keyPair)

Signs a message using a NEAR key pair.

import { signMessage } from 'near-signature-utils';

const { signature, publicKey } = await signMessage('hello world', keyPair);

verifySignature(message, signature, publicKey)

Verifies a message signature against a public key.

import { verifySignature } from 'near-signature-utils';

const valid = await verifySignature('hello world', signature, publicKey); console.log(valid); // true

getAccessKeys(accountId, rpcUrl?)

Fetches all access keys for a NEAR account.

import { getAccessKeys } from 'near-signature-utils';

const keys = await getAccessKeys('alice.near'); // or with custom RPC: const keys = await getAccessKeys('alice.near', 'https://rpc.testnet.near.org');

isAuthorizedKey(accountId, publicKey, rpcUrl?)

Checks whether a public key is an authorized access key on a NEAR account.

import { isAuthorizedKey } from 'near-signature-utils';

const authorized = await isAuthorizedKey('alice.near', 'ed25519:...'); console.log(authorized); // true or false

License

MIT