Merge pull request #384 from bsv-blockchain/feature/certificate-revocation

Feature/certificate revocation

Author: ty-everett

CHANGELOG.md

@@ -5,6 +5,7 @@ All notable changes to this project will be documented in this file. The format
 ## Table of Contents
 
 - [Unreleased](#unreleased)
+- [1.9.5 - 2025-11-13](#195---2025-11-13)
 - [1.9.3 - 2025-11-11](#193---2025-11-11)
 - [1.9.2 - 2025-11-11](#192---2025-11-11)
 - [1.9.1 - 2025-11-10](#191---2025-11-10)
@@ -177,6 +178,14 @@ All notable changes to this project will be documented in this file. The format
 
 ---
 
+### [1.9.5] - 2025-11-13
+
+### Added
+
+- Added support for revoking certificate revelation.
+
+---
+
 ### [1.9.3] - 2025-11-11
 
 ### Added

docs/reference/identity.md

@@ -61,7 +61,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
 
 ```ts
 export class ContactsManager {
-    constructor(wallet?: WalletInterface) 
+    constructor(wallet?: WalletInterface, originator?: string) 
     async getContacts(identityKey?: PubKeyHex, forceRefresh = false, limit = 1000): Promise<Contact[]> 
     async saveContact(contact: DisplayableIdentity, metadata?: Record<string, any>): Promise<void> 
     async removeContact(identityKey: string): Promise<void> 
@@ -134,20 +134,18 @@ export class IdentityClient {
     async publiclyRevealAttributes(certificate: WalletCertificate, fieldsToReveal: CertificateFieldNameUnder50Bytes[]): Promise<BroadcastResponse | BroadcastFailure> 
     async resolveByIdentityKey(args: DiscoverByIdentityKeyArgs, overrideWithContacts = true): Promise<DisplayableIdentity[]> 
     async resolveByAttributes(args: DiscoverByAttributesArgs, overrideWithContacts = true): Promise<DisplayableIdentity[]> 
+    async revokeCertificateRevelation(serialNumber: Base64String): Promise<BroadcastResponse | BroadcastFailure> 
     public async getContacts(identityKey?: PubKeyHex, forceRefresh = false, limit = 1000): Promise<Contact[]> 
     public async saveContact(contact: DisplayableIdentity, metadata?: Record<string, any>): Promise<void> 
     public async removeContact(identityKey: PubKeyHex): Promise<void> 
     static parseIdentity(identityToParse: IdentityCertificate): DisplayableIdentity 
 }
 ```
 
-See also: [BroadcastFailure](./transaction.md#interface-broadcastfailure), [BroadcastResponse](./transaction.md#interface-broadcastresponse), [CertificateFieldNameUnder50Bytes](./wallet.md#type-certificatefieldnameunder50bytes), [Contact](./identity.md#type-contact), [DEFAULT_IDENTITY_CLIENT_OPTIONS](./identity.md#variable-default_identity_client_options), [DiscoverByAttributesArgs](./wallet.md#interface-discoverbyattributesargs), [DiscoverByIdentityKeyArgs](./wallet.md#interface-discoverbyidentitykeyargs), [DisplayableIdentity](./identity.md#interface-displayableidentity), [IdentityCertificate](./wallet.md#interface-identitycertificate), [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes), [PubKeyHex](./wallet.md#type-pubkeyhex), [WalletCertificate](./wallet.md#interface-walletcertificate), [WalletInterface](./wallet.md#interface-walletinterface)
+See also: [Base64String](./wallet.md#type-base64string), [BroadcastFailure](./transaction.md#interface-broadcastfailure), [BroadcastResponse](./transaction.md#interface-broadcastresponse), [CertificateFieldNameUnder50Bytes](./wallet.md#type-certificatefieldnameunder50bytes), [Contact](./identity.md#type-contact), [DEFAULT_IDENTITY_CLIENT_OPTIONS](./identity.md#variable-default_identity_client_options), [DiscoverByAttributesArgs](./wallet.md#interface-discoverbyattributesargs), [DiscoverByIdentityKeyArgs](./wallet.md#interface-discoverbyidentitykeyargs), [DisplayableIdentity](./identity.md#interface-displayableidentity), [IdentityCertificate](./wallet.md#interface-identitycertificate), [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes), [PubKeyHex](./wallet.md#type-pubkeyhex), [WalletCertificate](./wallet.md#interface-walletcertificate), [WalletInterface](./wallet.md#interface-walletinterface)
 
 #### Method getContacts
 
-TODO: Implement once revocation overlay is created
-Remove public certificate revelation from overlay services by spending the identity token
-
 Load all records from the contacts basket
 
 ```ts
@@ -161,8 +159,6 @@ A promise that resolves with an array of contacts
 
 Argument Details
 
-+ **serialNumber**
-  + Unique serial number of the certificate to revoke revelation
 + **identityKey**
   + Optional specific identity key to fetch
 + **forceRefresh**
@@ -267,6 +263,20 @@ Argument Details
 + **overrideWithContacts**
   + Whether to override the results with personal contacts if available.
 
+#### Method revokeCertificateRevelation
+
+Remove public certificate revelation from overlay services by spending the identity token
+
+```ts
+async revokeCertificateRevelation(serialNumber: Base64String): Promise<BroadcastResponse | BroadcastFailure> 
+```
+See also: [Base64String](./wallet.md#type-base64string), [BroadcastFailure](./transaction.md#interface-broadcastfailure), [BroadcastResponse](./transaction.md#interface-broadcastresponse)
+
+Argument Details
+
++ **serialNumber**
+  + Unique serial number of the certificate to revoke revelation
+
 #### Method saveContact
 
 Save or update a Metanet contact

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@bsv/sdk",
-  "version": "1.9.4",
+  "version": "1.9.5",
   "type": "module",
   "description": "BSV Blockchain Software Development Kit",
   "main": "dist/cjs/mod.js",

package.json

@@ -32,9 +32,11 @@ export class ContactsManager {
   private readonly wallet: WalletInterface
   private readonly cache = new MemoryCache()
   private readonly CONTACTS_CACHE_KEY = 'metanet-contacts'
+  private readonly originator?: string
 
-  constructor (wallet?: WalletInterface) {
+  constructor (wallet?: WalletInterface, originator?: string) {
     this.wallet = wallet ?? new WalletClient()
+    this.originator = originator
   }
 
   /**
@@ -68,7 +70,7 @@ export class ContactsManager {
         keyID: identityKey,
         counterparty: 'self',
         data: Utils.toArray(identityKey, 'utf8')
-      })
+      }, this.originator)
       tags.push(`identityKey ${Utils.toHex(hashedIdentityKey)}`)
     }
 
@@ -79,7 +81,7 @@ export class ContactsManager {
       includeCustomInstructions: true,
       tags,
       limit
-    })
+    }, this.originator)
 
     if (outputs.outputs == null || outputs.outputs.length === 0) {
       this.cache.setItem(this.CONTACTS_CACHE_KEY, JSON.stringify([]))
@@ -104,7 +106,7 @@ export class ContactsManager {
           protocolID: CONTACT_PROTOCOL_ID,
           keyID,
           counterparty: 'self'
-        })
+        }, this.originator)
 
         // Parse the contact data
         const contactData: Contact = JSON.parse(Utils.toUTF8(plaintext))
@@ -157,7 +159,7 @@ export class ContactsManager {
       keyID: contact.identityKey,
       counterparty: 'self',
       data: Utils.toArray(contact.identityKey, 'utf8')
-    })
+    }, this.originator)
 
     // Check if this contact already exists (to update it)
     const outputs = await this.wallet.listOutputs({
@@ -166,7 +168,7 @@ export class ContactsManager {
       includeCustomInstructions: true,
       tags: [`identityKey ${Utils.toHex(hashedIdentityKey)}`],
       limit: 100 // Should only be one contact!
-    })
+    }, this.originator)
 
     let existingOutput: any = null
     let keyID = Utils.toBase64(Random(32))
@@ -185,7 +187,7 @@ export class ContactsManager {
             protocolID: CONTACT_PROTOCOL_ID,
             keyID,
             counterparty: 'self'
-          })
+          }, this.originator)
 
           const storedContact: Contact = JSON.parse(Utils.toUTF8(plaintext))
           if (storedContact.identityKey === contact.identityKey) {
@@ -209,7 +211,7 @@ export class ContactsManager {
       protocolID: CONTACT_PROTOCOL_ID,
       keyID,
       counterparty: 'self'
-    })
+    }, this.originator)
 
     // Create locking script for the new contact token
     const lockingScript = await new PushDrop(this.wallet).lock(
@@ -242,7 +244,7 @@ export class ContactsManager {
           customInstructions: JSON.stringify({ keyID })
         }],
         options: { acceptDelayedBroadcast: false, randomizeOutputs: false } // TODO: Support custom config as needed.
-      })
+      }, this.originator)
 
       if (signableTransaction == null) throw new Error('Unable to update contact')
 
@@ -255,7 +257,7 @@ export class ContactsManager {
       const { tx } = await this.wallet.signAction({
         reference: signableTransaction.reference,
         spends: { 0: { unlockingScript: unlockingScript.toHex() } }
-      })
+      }, this.originator)
 
       if (tx == null) throw new Error('Failed to update contact output')
     } else {
@@ -271,7 +273,7 @@ export class ContactsManager {
           customInstructions: JSON.stringify({ keyID })
         }],
         options: { acceptDelayedBroadcast: false, randomizeOutputs: false } // TODO: Support custom config as needed.
-      })
+      }, this.originator)
 
       if (tx == null) throw new Error('Failed to create contact output')
     }
@@ -302,7 +304,7 @@ export class ContactsManager {
       keyID: identityKey,
       counterparty: 'self',
       data: Utils.toArray(identityKey, 'utf8')
-    })
+    }, this.originator)
     tags.push(`identityKey ${Utils.toHex(hashedIdentityKey)}`)
 
     // Find and spend the contact's output
@@ -312,7 +314,7 @@ export class ContactsManager {
       includeCustomInstructions: true,
       tags,
       limit: 100 // Should only be one contact!
-    })
+    }, this.originator)
 
     if (outputs.outputs == null) return
 
@@ -330,7 +332,7 @@ export class ContactsManager {
           protocolID: CONTACT_PROTOCOL_ID,
           keyID,
           counterparty: 'self'
-        })
+        }, this.originator)
 
         const storedContact: Contact = JSON.parse(Utils.toUTF8(plaintext))
         if (storedContact.identityKey === identityKey) {
@@ -348,7 +350,7 @@ export class ContactsManager {
             }],
             outputs: [], // No outputs = deletion
             options: { acceptDelayedBroadcast: false, randomizeOutputs: false } // TODO: Support custom config as needed.
-          })
+          }, this.originator)
 
           if (signableTransaction == null) throw new Error('Unable to delete contact')
 
@@ -361,7 +363,7 @@ export class ContactsManager {
           const { tx: deleteTx } = await this.wallet.signAction({
             reference: signableTransaction.reference,
             spends: { 0: { unlockingScript: unlockingScript.toHex() } }
-          })
+          }, this.originator)
 
           if (deleteTx == null) throw new Error('Failed to delete contact output')
           return