ncc-02-js 0.2.3 → 0.2.5

package/README.md

@@ -26,12 +26,13 @@ npm install ncc-02-js
 import { NCC02Resolver } from 'ncc-02-js';
 
 // Initialize with relay URLs and optional trusted CA pubkeys
-const resolver = new NCC02Resolver(['wss://relay.damus.io'], {
-  trustedCAPubkeys: ['ca_pubkey_hex']
+const resolver = new NCC02Resolver(['wss://192.0.2.1:443'], {
+  trustedCAPubkeys: ['npub1...'] // Trusted third-party certifiers
 });
 
 try {
-  const service = await resolver.resolve(ownerPubkey, 'api', {
+  // ownerPubkey can be hex or npub
+  const service = await resolver.resolve(ownerPubkey, 'media', {
     requireAttestation: true,
     minLevel: 'verified' // 'self', 'verified', 'hardened'
   });
@@ -46,6 +47,7 @@ try {
 ```javascript
 import { NCC02Builder } from 'ncc-02-js';
 
+// Initialize with private key (hex)
 const builder = new NCC02Builder(privateKey);
 
 // Example 1: IP-based Service
@@ -71,8 +73,8 @@ const onionEvent = builder.createServiceRecord({
 ```javascript
 const caBuilder = new NCC02Builder(caPrivateKey);
 const attestation = caBuilder.createAttestation({
-  subjectPubkey: ownerPubkey,
-  serviceId: 'api',
+  subjectPubkey: 'npub1...', // The service owner being certified
+  serviceId: 'media',
   serviceEventId: serviceRecordEventId,
   level: 'verified',
   validDays: 30

package/dist/index.cjs

@@ -7679,7 +7679,10 @@ var NCC02Resolver = class {
    * @param {string[]} relays - List of relay URLs.
    * @param {Object} [options={}]
    * @param {SimplePool} [options.pool] - Shared SimplePool instance.
-   * @param {string[]} [options.trustedCAPubkeys=[]] - List of trusted CA pubkeys.
+   * @param {string[]} [options.trustedCAPubkeys=[]] - List of trusted CA pubkeys (hex or npub).
+   * These are the ONLY pubkeys whose attestation signatures (Kind 30060) will be accepted
+   * by the resolver. This allows you to define your own web of trust or rely on specific
+   * community auditors. If empty, all attestations are ignored (effectively disabling attestation checks).
    */
   constructor(relays, options = {}) {
     if (!Array.isArray(relays)) {

package/dist/index.mjs

@@ -7645,7 +7645,10 @@ var NCC02Resolver = class {
    * @param {string[]} relays - List of relay URLs.
    * @param {Object} [options={}]
    * @param {SimplePool} [options.pool] - Shared SimplePool instance.
-   * @param {string[]} [options.trustedCAPubkeys=[]] - List of trusted CA pubkeys.
+   * @param {string[]} [options.trustedCAPubkeys=[]] - List of trusted CA pubkeys (hex or npub).
+   * These are the ONLY pubkeys whose attestation signatures (Kind 30060) will be accepted
+   * by the resolver. This allows you to define your own web of trust or rely on specific
+   * community auditors. If empty, all attestations are ignored (effectively disabling attestation checks).
    */
   constructor(relays, options = {}) {
     if (!Array.isArray(relays)) {

package/dist/resolver.d.ts

@@ -29,7 +29,10 @@ export class NCC02Resolver {
      * @param {string[]} relays - List of relay URLs.
      * @param {Object} [options={}]
      * @param {SimplePool} [options.pool] - Shared SimplePool instance.
-     * @param {string[]} [options.trustedCAPubkeys=[]] - List of trusted CA pubkeys.
+     * @param {string[]} [options.trustedCAPubkeys=[]] - List of trusted CA pubkeys (hex or npub).
+     * These are the ONLY pubkeys whose attestation signatures (Kind 30060) will be accepted
+     * by the resolver. This allows you to define your own web of trust or rely on specific
+     * community auditors. If empty, all attestations are ignored (effectively disabling attestation checks).
      */
     constructor(relays: string[], options?: {
         pool?: SimplePool;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ncc-02-js",
-  "version": "0.2.3",
+  "version": "0.2.5",
   "description": "Nostr-native service discovery and trust implementation (NCC-02)",
   "main": "dist/index.cjs",
   "module": "dist/index.mjs",

package/src/resolver.js

@@ -36,7 +36,10 @@ export class NCC02Resolver {
    * @param {string[]} relays - List of relay URLs.
    * @param {Object} [options={}]
    * @param {SimplePool} [options.pool] - Shared SimplePool instance.
-   * @param {string[]} [options.trustedCAPubkeys=[]] - List of trusted CA pubkeys.
+   * @param {string[]} [options.trustedCAPubkeys=[]] - List of trusted CA pubkeys (hex or npub).
+   * These are the ONLY pubkeys whose attestation signatures (Kind 30060) will be accepted
+   * by the resolver. This allows you to define your own web of trust or rely on specific
+   * community auditors. If empty, all attestations are ignored (effectively disabling attestation checks).
    */
   constructor(relays, options = {}) {
     if (!Array.isArray(relays)) {