npm-package-near-simple-key 1.0.0

package/README.md

@@ -0,0 +1,56 @@
+# 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

package/index.js

@@ -0,0 +1,59 @@
+import { KeyPair, utils } from 'near-api-js';
+
+/** Generate a new random NEAR key pair and return publicKey + secretKey */
+export async function generateKeyPair(): Promise<{ publicKey: string; secretKey: string }> {
+  const keyPair = KeyPair.fromRandom('ed25519');
+  return {
+    publicKey: keyPair.getPublicKey().toString(),
+    secretKey: keyPair.toString(),
+  };
+}
+
+/** Derive the public key string from a secret key string */
+export async function getPublicKey(secretKey: string): Promise<string> {
+  const keyPair = KeyPair.fromString(secretKey);
+  return keyPair.getPublicKey().toString();
+}
+
+/** Fetch all access keys for a given NEAR account ID from mainnet RPC */
+export async function getAccessKeys(
+  accountId: string
+): Promise<Array<{ public_key: string; access_key: { nonce: number; permission: unknown } }>> {
+  const response = await fetch('https://rpc.mainnet.near.org', {
+    method: 'POST',
+    headers: { 'Content-Type': 'application/json' },
+    body: JSON.stringify({
+      jsonrpc: '2.0',
+      id: 'near-simple-key',
+      method: 'query',
+      params: { request_type: 'view_access_key_list', finality: 'final', account_id: accountId },
+    }),
+  });
+  const json = (await response.json()) as { result?: { keys: never[] }; error?: { message: string } };
+  if (json.error) throw new Error(json.error.message);
+  return json.result!.keys;
+}
+
+/** Check whether a specific public key exists on a NEAR account */
+export async function hasAccessKey(accountId: string, publicKey: string): Promise<boolean> {
+  const response = await fetch('https://rpc.mainnet.near.org', {
+    method: 'POST',
+    headers: { 'Content-Type': 'application/json' },
+    body: JSON.stringify({
+      jsonrpc: '2.0',
+      id: 'near-simple-key',
+      method: 'query',
+      params: { request_type: 'view_access_key', finality: 'final', account_id: accountId, public_key: publicKey },
+    }),
+  });
+  const json = (await response.json()) as { result?: unknown; error?: unknown };
+  return !json.error && !!json.result;
+}
+
+/** Sign an arbitrary UTF-8 message with a secret key; returns base58-encoded signature */
+export async function signMessage(message: string, secretKey: string): Promise<string> {
+  const keyPair = KeyPair.fromString(secretKey);
+  const msgBytes = new TextEncoder().encode(message);
+  const { signature } = keyPair.sign(msgBytes);
+  return utils.serialize.base_encode(signature);
+}

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "npm-package-near-simple-key",
+  "version": "1.0.0",
+  "description": "npm Package - near-simple-key",
+  "main": "index.js",
+  "scripts": {
+    "test": "jest --passWithNoTests"
+  },
+  "keywords": [
+    "near",
+    "blockchain",
+    "web3"
+  ],
+  "license": "MIT",
+  "dependencies": {
+    "near-api-js": "^4.0.0"
+  },
+  "devDependencies": {
+    "typescript": "^5.0.0",
+    "@types/node": "^20.0.0",
+    "jest": "^29.0.0",
+    "@types/jest": "^29.0.0",
+    "ts-jest": "^29.0.0"
+  },
+  "files": [
+    "dist/**/*",
+    "README.md"
+  ]
+}