@did-btcr2/method 0.13.1

package/dist/esm/btcr2/beacon/aggregation/models/cohort/status.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"status.js","sourceRoot":"","sources":["../../../../../../../src/btcr2/beacon/aggregation/models/cohort/status.ts"],"names":[],"mappings":"AACA,MAAM,CAAN,IAAY,aAKX;AALD,WAAY,aAAa;IACvB,iDAAgC,CAAA;IAChC,6CAA4B,CAAA;IAC5B,iDAAgC,CAAA;IAChC,yCAAwB,CAAA;AAC1B,CAAC,EALW,aAAa,KAAb,aAAa,QAKxB"}

package/dist/esm/btcr2/beacon/aggregation/participant.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=participant.js.map

package/dist/esm/btcr2/beacon/aggregation/participant.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"participant.js","sourceRoot":"","sources":["../../../../../src/btcr2/beacon/aggregation/participant.ts"],"names":[],"mappings":""}

package/dist/esm/btcr2/beacon/aggregation/protocol/nostr.js

@@ -0,0 +1,57 @@
+import { SchnorrKeyPair, SecretKey } from '@did-btcr2/keypair';
+import { SimplePool, } from 'nostr-tools/pool';
+import { Btc1Identifier } from '../../../../utils/identifier.js';
+export class NostrAdapter {
+    name = 'nostr';
+    config;
+    handlers = new Map();
+    constructor(config = { keys: {}, components: {}, relays: ['wss://relay.damus.io'] }) {
+        this.config = config;
+        this.config.keys = this.config.keys || SchnorrKeyPair.generate().raw;
+        this.config.did = config.did || Btc1Identifier.encode({
+            idType: config.components.idType || 'KEY',
+            version: config.components.version || 1,
+            network: config.components.network || 'signet',
+            genesisBytes: this.config.keys.public
+        });
+    }
+    async start() {
+        const pool = new SimplePool();
+        pool.subscribe(this.config.relays, { pubkey: this.config.did, kinds: [1059] }, {
+            onclose: (reasons) => console.log('Subscription closed for reasons:', reasons),
+            onevent: async (event) => {
+                console.log('Received event:', event);
+            }
+        });
+    }
+    registerMessageHandler(messageType, handler) {
+        this.handlers.set(messageType, handler);
+    }
+    /**
+     * Sends a message to a recipient using the Nostr protocol.
+     * This method is a placeholder and should be implemented with actual Nostr message sending logic.
+     * @param message
+     * @param recipient
+     * @param sender
+     */
+    async sendMessage(message, recipient, sender) {
+        // TODO: Implement message sending logic via Nostr
+        console.log(`Sending message to ${recipient} from ${sender}:`, message);
+    }
+    /**
+     * Generates a Nostr identity using the SecretKey and Btc1Identifier classes.
+     * @returns {string} A BTCR2 DID used for communication over the nostr protocol
+     */
+    generateIdentity() {
+        this.config.keys.secret = SecretKey.random();
+        this.config.keys.public = SecretKey.getPublicKey(this.config.keys.secret);
+        this.config.did = Btc1Identifier.encode({
+            idType: this.config.components.idType || 'KEY',
+            version: this.config.components.version || 1,
+            network: this.config.components.network || 'signet',
+            genesisBytes: this.config.keys.public
+        });
+        return this.config.did;
+    }
+}
+//# sourceMappingURL=nostr.js.map

package/dist/esm/btcr2/beacon/aggregation/protocol/nostr.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"nostr.js","sourceRoot":"","sources":["../../../../../../src/btcr2/beacon/aggregation/protocol/nostr.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAE/D,OAAO,EAAE,UAAU,GAAG,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AAkBjE,MAAM,OAAO,YAAY;IAChB,IAAI,GAAW,OAAO,CAAC;IACtB,MAAM,CAAqB;IAC3B,QAAQ,GAA6C,IAAI,GAAG,EAAE,CAAC;IAEvE,YAAY,SAA6B,EAAE,IAAI,EAAE,EAAE,EAAE,UAAU,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC,sBAAsB,CAAC,EAAE;QACrG,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,IAAI,cAAc,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC;QACrE,IAAI,CAAC,MAAM,CAAC,GAAG,GAAG,MAAM,CAAC,GAAG,IAAI,cAAc,CAAC,MAAM,CAAC;YACpD,MAAM,EAAS,MAAM,CAAC,UAAU,CAAC,MAAM,IAAI,KAAK;YAChD,OAAO,EAAQ,MAAM,CAAC,UAAU,CAAC,OAAO,IAAI,CAAC;YAC7C,OAAO,EAAQ,MAAM,CAAC,UAAU,CAAC,OAAO,IAAI,QAAQ;YACpD,YAAY,EAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAO;SACxC,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,KAAK;QACT,MAAM,IAAI,GAAG,IAAI,UAAU,EAAE,CAAC;QAC9B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,EAAE,CAAC,IAAI,CAAC,EAAY,EAAE;YACvF,OAAO,EAAG,CAAC,OAAiB,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,kCAAkC,EAAE,OAAO,CAAC;YACzF,OAAO,EAAG,KAAK,EAAE,KAAU,EAAE,EAAE;gBAC7B,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,KAAK,CAAC,CAAC;YACxC,CAAC;SACF,CAAC,CAAC;IACL,CAAC;IAED,sBAAsB,CAAC,WAAmB,EAAE,OAAoC;QAC9E,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;IAC1C,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,WAAW,CAAC,OAAe,EAAE,SAAiB,EAAE,MAAc;QAClE,kDAAkD;QAClD,OAAO,CAAC,GAAG,CAAC,sBAAsB,SAAS,SAAS,MAAM,GAAG,EAAE,OAAO,CAAC,CAAC;IAC1E,CAAC;IAED;;;OAGG;IACI,gBAAgB;QACrB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC;QAC7C,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC1E,IAAI,CAAC,MAAM,CAAC,GAAG,GAAG,cAAc,CAAC,MAAM,CACrC;YACE,MAAM,EAAS,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,MAAM,IAAK,KAAK;YACtD,OAAO,EAAQ,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,OAAO,IAAI,CAAC;YAClD,OAAO,EAAQ,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,OAAO,IAAI,QAAQ;YACzD,YAAY,EAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM;SACvC,CACF,CAAC;QACF,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC;IACzB,CAAC;CACF"}

package/dist/esm/btcr2/beacon/aggregation/protocol/service.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=service.js.map

package/dist/esm/btcr2/beacon/aggregation/protocol/service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"service.js","sourceRoot":"","sources":["../../../../../../src/btcr2/beacon/aggregation/protocol/service.ts"],"names":[],"mappings":""}

package/dist/esm/btcr2/beacon/cid-aggregate.js

@@ -0,0 +1,116 @@
+import { Btcr2Error } from '@did-btcr2/common';
+import { Beacon } from '../../interfaces/beacon.js';
+/**
+ * Implements {@link https://dcdpr.github.io/did-btcr2/#cidaggregate-beacon | 5.2 CIDAggregate Beacon}.
+ *
+ * A Beacon of the type CIDAggregatoBeacon is a Beacon that publishes Bitcoin transactions containing a Content
+ * Identifier (CID) announcing an Aggregated DID Update Bundle. An Aggregated DID Update Bundle is a JSON object that
+ * maps did:btcr2 identifiers to CID values for the individual DID Update Payloads. The Aggregated DID Update Bundle CID
+ * (bundleCID) SHOULD be resolvable against a Content Addressable Storage (CAS) system such as IPFS, while the CID for
+ * the DID Update Payload (payloadCID) MAY be resolvable against a CAS or provided through a Sidecar mechanism. It is
+ * RECOMMENDED that this type of Beacon is only included in a DID document if the DID controller is REQUIRED to
+ * participate in authorizing Bitcoin transactions from this Beacon. In other words, this Beacon SHOULD identify an
+ * n-of-n P2TR Bitcoin address where n is the number of unique DID controllers submitting updates through the Beacon.
+ *
+ * @class CIDAggregateBeacon
+ * @type {CIDAggregateBeacon}
+ * @extends {Beacon}
+ */
+export class CIDAggregateBeacon extends Beacon {
+    /**
+     * Creates an instance of CIDAggregateBeacon.
+     * @param {BeaconService} service The service of the Beacon.
+     * @param {?BeaconSidecarData} [sidecar] The sidecar data of the Beacon.
+     */
+    constructor(service, sidecar) {
+        super({ ...service, type: 'CIDAggregateBeacon' }, sidecar);
+    }
+    get service() {
+        return {
+            type: this.type,
+            id: this.id,
+            serviceEndpoint: this.serviceEndpoint
+        };
+    }
+    /**
+     * TODO: Finish implementation
+     *
+     * Implements {@link https://dcdpr.github.io/did-btcr2/#establish-cidaggregate-beacon | 5.2.1 Establish CIDAggregate Beacon}.
+     *
+     * To establish a CIDAggregatorBeacon, a cohort of cooperating parties SHOULD generate an n-of-n P2TR Bitcoin address
+     * where each party contributes a public key. Furthermore, each party SHOULD verify that their key is part of the
+     * address and all other keys that are part of the address are keys with controllers able to produce valid signatures.
+     * To establish a Beacon there are two roles. One is the cohort participant, they want to join a Beacon cohort and
+     * submit a request to do so with a key and proof of control over that key. The other is the Beacon coordinator, they
+     * advertise and curate Beacon cohorts by combining Beacon participants into cohorts, verifying proofs of control, and
+     * producing Beacon addresses.
+     *
+     * @param {string} id The identifier of the Beacon.
+     * @param {string} type The type of the Beacon.
+     * @param {DidServiceEndpoint} serviceEndpoint The service endpoint of the Beacon.
+     * @returns {CIDAggregateBeacon} The established CIDAggregate Beacon.
+     */
+    static establish(id, type, serviceEndpoint) {
+        return new CIDAggregateBeacon({ id, type, serviceEndpoint });
+    }
+    /**
+     * TODO: Figure out if this is necessary or not.
+     * @param {string} didUpdatePayload The DID Update Payload to generate the signal for.
+     * @returns {BeaconSignal} The generated signal.
+     * @throws {Btcr2Error} if the signal is invalid.
+     */
+    generateSignal(didUpdatePayload) {
+        throw new Btcr2Error('Method not implemented.', `METHOD_NOT_IMPLEMENTED`, { didUpdatePayload });
+    }
+    /**
+     * TODO: Finish implementation
+     *
+     * Implements {@link https://dcdpr.github.io/did-btcr2/#process-cidaggregate-beacon-signal | 5.2.3 Process CIDAggregate Beacon Signal}.
+     *
+     * A Beacon Signal from a CIDAggregate Beacon is a Bitcoin transaction that contains the hashBytes of a DID Update
+     * Bundle in its first transaction output. The corresponding DID Update Bundle MUST either be provided through Sidecar
+     * Data or by converting hashBytes into a IPFS v1 Content Identifier and attempting to retrieve it from Content
+     * Addressable Storage. The DID Update Bundle maps from did:btcr2 identifiers to hashes of DID Update payloads
+     * applicable for that identifier. Again this algorithm attempts to retrieve and validate the DID Update Payload
+     * identified for the identifier being resolved. If successful, the DID Update Payload is returned.
+     *
+     * The Process CIDAggregate Beacon Signal algorithm is called by the Process Beacon Signals algorithm as part of the
+     * Read operation.
+     *
+     * It takes as inputs a did:btcr2 identifier, btc1Identifier, a Beacon Signal, tx, and a optional
+     * object, signalSidecarData, containing any sidecar data provided to the resolver for the Beacon Signal identified by
+     * the Bitcoin transaction identifier.
+     *
+     * It returns the DID Update payload announced by the Beacon Signal for the
+     * did:btcr2 identifier being resolved or throws an error.
+     *
+     * @param {RawTransactionV2} signal Bitcoin transaction representing a Beacon Signal.
+     * @param {SignalsMetadata} signalsMetadata Optional sidecar data for the Beacon Signal.
+     * @returns {Promise<DidUpdatePayload | undefined>} The DID Update payload announced by the Beacon Signal.
+     * @throws {DidError} if the signalTx is invalid or the signalsMetadata is invalid.
+     */
+    processSignal(signal, signalsMetadata) {
+        throw new Btcr2Error('Method not implemented.', `METHOD_NOT_IMPLEMENTED`, { signal, signalsMetadata });
+    }
+    /**
+     * TODO: Finish implementation
+     *
+     * Implements {@link https://dcdpr.github.io/did-btcr2/#broadcast-cidaggregate-beacon-signal | 5.2.2 Broadcast CIDAggregate Beacon Signal}.
+     *
+     * The Broadcast CIDAggregate Beacon Signal algorithm involving two roles: a set of cohort participants and a Beacon
+     * coordinator. The Beacon coordinator collects individual DID Update Payload Content Identifiers (CIDs) for specific
+     * did:btc1s and aggregates them into a DID Update Bundle, which is then published to a Content Addressable Storage
+     * (CAS). The CID for the DID Update Bundle is included in a Partially Signed Bitcoin Transaction (PSBT) transaction
+     * output spent from the Beacon’s n-of-n address. Each of the n cohort participants in the Beacon MUST sign the
+     * transaction before it can be broadcast to the network. It is RECOMMENDED that cohort participants keep a copy of
+     * the DID Update Bundle and separately pin it to the CAS.
+     *
+     * @param {DidUpdatePayload} didUpdatePayload The verificationMethod object to be used for signing.
+     * @returns {SignalsMetadata} Successful output of a bitcoin transaction.
+     * @throws {SingletonBeaconError} if the bitcoin address is invalid or unfunded.
+     */
+    broadcastSignal(didUpdatePayload) {
+        throw new Btcr2Error('Method not implemented.', `METHOD_NOT_IMPLEMENTED`, didUpdatePayload);
+    }
+}
+//# sourceMappingURL=cid-aggregate.js.map

package/dist/esm/btcr2/beacon/cid-aggregate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cid-aggregate.js","sourceRoot":"","sources":["../../../../src/btcr2/beacon/cid-aggregate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAyC,MAAM,mBAAmB,CAAC;AAEtF,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AAKpD;;;;;;;;;;;;;;;GAeG;AACH,MAAM,OAAO,kBAAmB,SAAQ,MAAM;IAC5C;;;;OAIG;IACH,YAAY,OAAsB,EAAE,OAAgD;QAClF,KAAK,CAAC,EAAE,GAAG,OAAO,EAAE,IAAI,EAAE,oBAAoB,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IACD,IAAI,OAAO;QACT,OAAO;YACL,IAAI,EAAc,IAAI,CAAC,IAAI;YAC3B,EAAE,EAAgB,IAAI,CAAC,EAAE;YACzB,eAAe,EAAG,IAAI,CAAC,eAAe;SACvC,CAAC;IACJ,CAAC;IAGD;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,SAAS,CAAC,EAAU,EAAE,IAAY,EAAE,eAAmC;QAC5E,OAAO,IAAI,kBAAkB,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,eAAe,EAAE,CAAC,CAAC;IAC/D,CAAC;IAGD;;;;;OAKG;IACH,cAAc,CAAC,gBAAwB;QACrC,MAAM,IAAI,UAAU,CAAC,yBAAyB,EAAE,wBAAwB,EAAE,EAAC,gBAAgB,EAAC,CAAC,CAAC;IAChG,CAAC;IAGD;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,aAAa,CAAC,MAAwB,EAAE,eAAgC;QACtE,MAAM,IAAI,UAAU,CAAC,yBAAyB,EAAE,wBAAwB,EAAE,EAAC,MAAM,EAAE,eAAe,EAAC,CAAC,CAAC;IACvG,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,eAAe,CAAC,gBAAkC;QAChD,MAAM,IAAI,UAAU,CAAC,yBAAyB,EAAE,wBAAwB,EAAE,gBAAgB,CAAC,CAAC;IAC9F,CAAC;CA4BF"}

package/dist/esm/btcr2/beacon/factory.js

@@ -0,0 +1,30 @@
+import { Btcr2Error } from '@did-btcr2/common';
+import { CIDAggregateBeacon } from './cid-aggregate.js';
+import { SingletonBeacon } from './singleton.js';
+import { SMTAggregateBeacon } from './smt-aggregate.js';
+/**
+ * Beacon Factory pattern to create Beacon instances.
+ * @class BeaconFactory
+ * @type {BeaconFactory}
+ */
+export class BeaconFactory {
+    /**
+     * Establish a Beacon instance based on the provided service and optional sidecar data.
+     * @param {BeaconService} service - The beacon service configuration.
+     * @param {SidecarData} [sidecar] - The optional sidecar data.
+     * @returns {Beacon} The established Beacon instance.
+     */
+    static establish(service, sidecar) {
+        switch (service.type) {
+            case 'SingletonBeacon':
+                return new SingletonBeacon(service, sidecar);
+            case 'CIDAggregateBeacon':
+                return new CIDAggregateBeacon(service, sidecar);
+            case 'SMTAggregateBeacon':
+                return new SMTAggregateBeacon(service, sidecar);
+            default:
+                throw new Btcr2Error('Invalid Beacon Type', 'INVALID_BEACON_ERROR', { service, sidecar });
+        }
+    }
+}
+//# sourceMappingURL=factory.js.map

package/dist/esm/btcr2/beacon/factory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"factory.js","sourceRoot":"","sources":["../../../../src/btcr2/beacon/factory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAI/C,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AACjD,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAExD;;;;GAIG;AACH,MAAM,OAAO,aAAa;IACxB;;;;;OAKG;IACH,MAAM,CAAC,SAAS,CAAC,OAAsB,EAAE,OAAqB;QAC5D,QAAQ,OAAO,CAAC,IAAI,EAAE,CAAC;YACrB,KAAK,iBAAiB;gBACpB,OAAO,IAAI,eAAe,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YAC/C,KAAK,oBAAoB;gBACvB,OAAO,IAAI,kBAAkB,CAAC,OAAO,EAAE,OAA8B,CAAC,CAAC;YACzE,KAAK,oBAAoB;gBACvB,OAAO,IAAI,kBAAkB,CAAC,OAAO,EAAE,OAA8B,CAAC,CAAC;YACzE;gBACE,MAAM,IAAI,UAAU,CAClB,qBAAqB,EACrB,sBAAsB,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,CAC7C,CAAC;QACN,CAAC;IACH,CAAC;CACF"}

package/dist/esm/btcr2/beacon/singleton.js

@@ -0,0 +1,220 @@
+import { INVALID_SIDECAR_DATA, LATE_PUBLISHING_ERROR, SingletonBeaconError } from '@did-btcr2/common';
+import { opcodes, Psbt, script } from 'bitcoinjs-lib';
+import { base58btc } from 'multiformats/bases/base58';
+import bitcoinNetwork, { Bitcoin } from '../../bitcoin/index.js';
+import { Beacon } from '../../interfaces/beacon.js';
+import { Btc1Appendix } from '../../utils/appendix.js';
+import { Btc1KeyManager, Signer } from '../key-manager/index.js';
+/**
+ * Implements {@link https://dcdpr.github.io/did-btcr2/#singleton-beacon | 5.1 Singleton Beacon}.
+ *
+ * A Singleton Beacon enables a single entity to independently post a DID Update Payload in a Beacon Signal. Its is a
+ * Beacon that can be used to publish a single DID Update Payload targeting a single DID document. The serviceEndpoint
+ * for this Beacon Type is a Bitcoin address represented as a URI following the BIP21 scheme. It is recommended that
+ * this Bitcoin address be under the sole control of the DID controller. How the Bitcoin address and the cryptographic
+ * material that controls it are generated is left to the implementation.
+ *
+ * @class SingletonBeacon
+ * @type {SingletonBeacon}
+ * @extends {Beacon}
+ */
+export class SingletonBeacon extends Beacon {
+    /**
+     * Creates an instance of SingletonBeacon.
+     * @param {BeaconService} service The Beacon service.
+     * @param {?BeaconSidecarData} [sidecar] Optional sidecar data.
+     */
+    constructor(service, sidecar) {
+        super({ ...service, type: 'SingletonBeacon' }, sidecar);
+    }
+    /**
+     * Get the Beacon service.
+     * @readonly
+     * @type {BeaconService} The Beacon service.
+     */
+    get service() {
+        return {
+            type: this.type,
+            id: this.id,
+            serviceEndpoint: this.serviceEndpoint
+        };
+    }
+    /**
+     * Implements {@link https://dcdpr.github.io/did-btcr2/#establish-singleton-beacon | 5.1.1 Establish Singleton Beacon}.
+     *
+     * Static, convenience method for establishing a Beacon object.
+     *
+     * A Singleton Beacon is a Beacon that can be used to publish a single DID Update Payload targeting a single DID
+     * document. The serviceEndpoint for this Beacon Type is a Bitcoin address represented as a URI following the BIP21
+     * scheme. It is RECOMMENDED that this Bitcoin address be under the sole control of the DID controller. How the
+     * Bitcoin address and the cryptographic material that controls it are generated is left to the implementation.
+     * The Establish Singleton Beacon algorithm takes in a Bitcoin address and a serviceId and returns a Singleton Beacon service.
+     * It returns a SignletonBeacon object with the given id, type, and serviceEndpoint.
+     *
+     * @param {string} service The Beacon service.
+     * @param {BeaconSidecarData<SingletonSidecar>} sidecar The sidecar data.
+     * @returns {SingletonBeacon} The Singleton Beacon.
+     */
+    static establish(service, sidecar) {
+        return new SingletonBeacon(service, sidecar);
+    }
+    /**
+     * TODO: Figure out if this is necessary or not.
+     * @param {string} didUpdatePayload The DID Update Payload to generate the signal for.
+     * @returns {BeaconSignal} The generated signal.
+     * @throws {Btcr2Error} if the signal is invalid.
+     */
+    generateSignal(didUpdatePayload) {
+        throw new Error('Method not implemented.' + didUpdatePayload);
+    }
+    /**
+     * TODO: Finish implementation per spec
+     *
+     * Implements {@link https://dcdpr.github.io/did-btcr2/#process-singleton-beacon-signal | 5.1.3 Process Singleton Beacon Signal}.
+     * See {@link Beacon.processSignal | Abstract Beacon Interface Method processSignal} for more details.
+     *
+     * The Process Singleton Beacon Signal algorithm is called by the Process Beacon Signals algorithm as part of the Read
+     * operation. It takes a Bitcoin transaction representing a Beacon Signal and optional signalSidecarData containing
+     * any sidecar data provided to the resolver for the Beacon Signal identified by the Bitcoin transaction identifier.
+     * It returns the DID Update payload announced by the Beacon Signal or throws an error.
+     *
+     * @param {RawTransactionV2} signal Bitcoin transaction representing a Beacon Signal.
+     * @param {SignalsMetadata} signalsMetadata: SignalsMetadata Optional sidecar data for the Beacon Signal.
+     * @returns {Promise<DidUpdatePayload | undefined>} The DID Update payload announced by the Beacon Signal.
+     * @throws {DidError} if the signalTx is invalid or the signalSidecarData is invalid.
+     */
+    async processSignal(signal, signalsMetadata) {
+        // 1. Initialize a txOut variable to the 0th transaction output of the tx.
+        const output = signal.vout.filter((vout) => (vout['scriptpubkey_asm'] || vout['scriptPubKey'].asm).includes('OP_RETURN'))?.[0];
+        if (!output) {
+            throw new SingletonBeaconError('No OP_RETURN output found in transaction outputs.', 'NO_OP_RETURN', { signal });
+        }
+        const outputMap = new Map(Object.entries(output));
+        // 2. Set didUpdatePayload to null.
+        let didUpdatePayload = undefined;
+        // 3. Check txout is of the format [OP_RETURN, OP_PUSH32, <32bytes>], if not, then return didUpdatePayload.
+        //    The Bitcoin transaction is not a Beacon Signal.
+        const UPDATE_PAYLOAD_HASH = (outputMap.get('scriptpubkey_asm') ?? outputMap.get('scriptPubKey').asm).split(' ').last();
+        if (!UPDATE_PAYLOAD_HASH) {
+            return undefined;
+        }
+        // 4. Set hashBytes to the 32 bytes in the txout.
+        const hashBytes = JSON.canonicalization.encode(Buffer.fromHex(UPDATE_PAYLOAD_HASH), 'base58');
+        // Convert signalsMetadata to a Map for easier access
+        const signalsMetadataMap = new Map(Object.entries(signalsMetadata));
+        // 5. If signalsMetadata:
+        if (signalsMetadata) {
+            // 5.1 Set didUpdatePayload to signalsMetadata.updatePayload
+            didUpdatePayload = signalsMetadataMap.get(signal.txid)?.btc1Update;
+            if (!didUpdatePayload) {
+                throw new SingletonBeaconError('Update Payload not found in signal metadata.', 'PROCESS_SIGNAL_ERROR');
+            }
+            // 5.2 Set updateHashBytes to the result of passing didUpdatePayload to the JSON Canonicalization and Hash algorithm.
+            const updateHashBytes = await JSON.canonicalization.process(didUpdatePayload, 'base58');
+            // 5.3 If updateHashBytes does not equal hashBytes, MUST throw an invalidSidecarData error.
+            if (updateHashBytes !== hashBytes) {
+                throw new SingletonBeaconError(`Hash mismatch: updateHashBytes ${updateHashBytes} !== hashBytes ${hashBytes}.`, INVALID_SIDECAR_DATA, { UPDATE_PAYLOAD_HASH, didUpdatePayload });
+            }
+            // 7. Return didUpdatePayload.
+            return didUpdatePayload;
+        }
+        // 6. Else:
+        //  6.1 Set didUpdatePayload to the result of passing hashBytes into the Fetch Content from Addressable Storage algorithm.
+        const didUpdatePayloadString = await Btc1Appendix.fetchFromCas(base58btc.decode(hashBytes));
+        if (!didUpdatePayloadString || !JSON.parse(didUpdatePayloadString)) {
+            throw new SingletonBeaconError('Update payload not found in addressable storage.', INVALID_SIDECAR_DATA);
+        }
+        didUpdatePayload = JSON.parse(didUpdatePayloadString);
+        //  6.2 If didUpdatePayload is null, MUST raise a latePublishingError. MAY identify Beacon Signal to resolver and request additional Sidecar data be provided.
+        if (!didUpdatePayload) {
+            throw new SingletonBeaconError('Update payload hash does not match transaction hash.', LATE_PUBLISHING_ERROR);
+        }
+        // 7. Return didUpdatePayload.
+        return didUpdatePayload;
+    }
+    /**
+     * Implements {@link https://dcdpr.github.io/did-btcr2/#broadcast-singleton-beacon-signal | 5.1.2 Broadcast Singleton Beacon Signal}.
+     *
+     * The Broadcast Singleton Beacon Signal algorithm is called by the Announce DID Update algorithm as part of the
+     * Update operation, if the Beacon being used is of the type SingletonBeacon. It takes as input a Beacon service and a
+     * secured didUpdatePayload. The algorithm constructs a Bitcoin transaction that spends from the Beacon address
+     * identified in the service and contains a transaction output of the format [OP_RETURN, OP_PUSH32, <hashBytes>],
+     * where hashBytes is the SHA256 hash of the canonical didUpdatePayload. The Bitcoin transaction is then signed and
+     * broadcast to the Bitcoin network, thereby publicly announcing a DID update in a Beacon Signal. It returns a
+     * signalMetadata object mapping the Bitcoin transaction identifier of the Beacon Signal to the necessary data needed
+     * to verify the signal announces a specific DID Update Payload.
+     *
+     * TODO: Design and implement a way to construct, sign and send via RPC
+     *
+     * @param {DidUpdatePayload} didUpdatePayload The verificationMethod object to be used for signing.
+     * @returns {SignedRawTx} Successful output of a bitcoin transaction.
+     * @throws {SingletonBeaconError} if the bitcoin address is invalid or unfunded.
+     */
+    async broadcastSignal(didUpdatePayload) {
+        // Grab the connection configuration from the environment variable or default to the rpc config
+        const bitcoin = bitcoinNetwork ?? new Bitcoin();
+        // 1. Initialize an addressURI variable to beacon.serviceEndpoint.
+        // 2. Set bitcoinAddress to the decoding of addressURI following BIP21.
+        const bitcoinAddress = this.service.serviceEndpoint.replace('bitcoin:', '');
+        // 3. Ensure bitcoinAddress is funded, if not, fund this address.
+        // let inputs: Array<CreateRawTxInputs> = [];
+        const utxos = await bitcoin.rest.address.getUtxos(bitcoinAddress);
+        if (!utxos.length) {
+            // TODO: Discuss what to do here because sending to a beacon address does not allow you to spend from it immediately.
+            throw new SingletonBeaconError('No UTXOs found, please fund address!', 'UNFUNDED_BEACON_ADDRESS', { bitcoinAddress });
+        }
+        const utxo = utxos.sort((a, b) => b.status.block_height - a.status.block_height)[0];
+        if (!utxo) {
+            throw new SingletonBeaconError('Beacon bitcoin address unfunded or utxos unconfirmed.', 'UNFUNDED_BEACON_ADDRESS', { bitcoinAddress });
+        }
+        // 4. Set hashBytes to the result of passing didUpdatePayload to the JSON Canonicalization and Hash algorithm.
+        const hashBytes = Buffer.fromHex(await JSON.canonicalization.process(didUpdatePayload));
+        if (hashBytes.length !== 32)
+            throw new SingletonBeaconError('Hash must be 32 bytes');
+        // 5. Initialize spendTx to a Bitcoin transaction that spends a transaction controlled by the bitcoinAddress and
+        //    contains at least one transaction output. This output MUST have the following format
+        //    [OP_RETURN, OP_PUSH32, hashBytes]
+        const { txid, vout } = utxo;
+        const prevTx = await bitcoin.rest.transaction.getHex(txid);
+        const input = {
+            hash: txid,
+            index: vout,
+            nonWitnessUtxo: Buffer.fromHex(prevTx)
+        };
+        // TODO: Figure out a good way to estimate fees
+        const spendTx = new Psbt({ network: bitcoin.network.data })
+            .addInput(input)
+            .addOutput({ address: bitcoinAddress, value: BigInt(utxo.value) - BigInt(500) })
+            .addOutput({ script: script.compile([opcodes.OP_RETURN, hashBytes]), value: 0n });
+        // 6. Retrieve the cryptographic material, e.g private key or signing capability, associated with the bitcoinAddress
+        //    or service. How this is done is left to the implementer.
+        // TODO: Determine how we want to handle this. Currently, this code uses the RPC to handle signing.
+        console.log('Btc1KeyManager', Btc1KeyManager.instance);
+        console.log('this.service.id', this.service.id);
+        const multikey = await Btc1KeyManager.getKeyPair(this.service.id);
+        console.log('multikey', multikey);
+        if (!multikey) {
+            throw new Error('Key pair not found.');
+        }
+        const signer = new Signer({ multikey, network: bitcoin.network.name });
+        // 7. Sign the spendTx.
+        const signedTx = spendTx.signInput(0, signer)
+            .finalizeAllInputs()
+            .extractTransaction()
+            .toHex();
+        if (!spendTx) {
+            throw new SingletonBeaconError('Failed to sign raw transaction.', 'RAW_TX_SIGN_FAILED', { spendTx });
+        }
+        // 8. Broadcast spendTx to the Bitcoin network.
+        const spentTx = await bitcoin.rest.transaction.send(signedTx);
+        if (!spentTx) {
+            throw new SingletonBeaconError('Failed to send raw transaction.', 'SEND_FAILED', { spentTx });
+        }
+        // 9. Set signalId to the Bitcoin transaction identifier of spendTx.
+        // 10. Initialize signalMetadata to an empty object.
+        // 11. Set signalMetadata.updatePayload to didUpdatePayload.
+        // 12. Return the object {<signalId>: { updatePayload: DidUpdatePayload; proofs?: any; }}.
+        return { [spentTx]: { btc1Update: didUpdatePayload } };
+    }
+}
+//# sourceMappingURL=singleton.js.map

package/dist/esm/btcr2/beacon/singleton.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"singleton.js","sourceRoot":"","sources":["../../../../src/btcr2/beacon/singleton.ts"],"names":[],"mappings":"AAAA,OAAO,EAAoB,oBAAoB,EAAE,qBAAqB,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AACxH,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AACtD,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AACtD,OAAO,cAAc,EAAE,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAEjE,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AAIpD,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAC;AAEjE;;;;;;;;;;;;GAYG;AACH,MAAM,OAAO,eAAgB,SAAQ,MAAM;IAEzC;;;;OAIG;IACH,YAAY,OAAsB,EAAE,OAA6C;QAC/E,KAAK,CAAC,EAAE,GAAG,OAAO,EAAE,IAAI,EAAE,iBAAiB,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;;;OAIG;IACH,IAAI,OAAO;QACT,OAAO;YACL,IAAI,EAAc,IAAI,CAAC,IAAI;YAC3B,EAAE,EAAgB,IAAI,CAAC,EAAE;YACzB,eAAe,EAAG,IAAI,CAAC,eAAe;SACvC,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACI,MAAM,CAAC,SAAS,CAAC,OAAsB,EAAE,OAA4C;QAC1F,OAAO,IAAI,eAAe,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;OAKG;IACI,cAAc,CAAC,gBAAwB;QAC5C,MAAM,IAAI,KAAK,CAAC,yBAAyB,GAAG,gBAAgB,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACI,KAAK,CAAC,aAAa,CAAC,MAA6C,EAAE,eAAgC;QACxG,0EAA0E;QAC1E,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAE,IAAa,CAAC,kBAAkB,CAAW,IAAK,IAAc,CAAC,cAAc,CAAC,CAAC,GAAa,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QACxK,IAAG,CAAC,MAAM,EAAE,CAAC;YACX,MAAM,IAAI,oBAAoB,CAAC,mDAAmD,EAAE,cAAc,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;QAClH,CAAC;QACD,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;QAElD,mCAAmC;QACnC,IAAI,gBAAgB,GAAiC,SAAS,CAAC;QAE/D,2GAA2G;QAC3G,qDAAqD;QACrD,MAAM,mBAAmB,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,kBAAkB,CAAC,IAAI,SAAS,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAY,CAAC;QACjI,IAAG,CAAC,mBAAmB,EAAE,CAAC;YACxB,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,iDAAiD;QACjD,MAAM,SAAS,GAAG,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,mBAAmB,CAAC,EAAE,QAAQ,CAAC,CAAC;QAE9F,qDAAqD;QACrD,MAAM,kBAAkB,GAAG,IAAI,GAAG,CAAmB,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC;QAEtF,yBAAyB;QACzB,IAAI,eAAe,EAAE,CAAC;YACpB,4DAA4D;YAC5D,gBAAgB,GAAG,kBAAkB,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,UAAU,CAAC;YAEnE,IAAG,CAAC,gBAAgB,EAAE,CAAC;gBACrB,MAAM,IAAI,oBAAoB,CAAC,8CAA8C,EAAE,sBAAsB,CAAC,CAAC;YACzG,CAAC;YAED,qHAAqH;YACrH,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,gBAAgB,EAAE,QAAQ,CAAC,CAAC;YAExF,2FAA2F;YAC3F,IAAI,eAAe,KAAK,SAAS,EAAE,CAAC;gBAClC,MAAM,IAAI,oBAAoB,CAC5B,kCAAkC,eAAe,kBAAkB,SAAS,GAAG,EAC/E,oBAAoB,EACpB,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,CAC1C,CAAC;YACJ,CAAC;YACD,8BAA8B;YAC9B,OAAO,gBAAgB,CAAC;QAC1B,CAAC;QAED,WAAW;QACX,0HAA0H;QAC1H,MAAM,sBAAsB,GAAG,MAAM,YAAY,CAAC,YAAY,CAAC,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;QAC5F,IAAG,CAAC,sBAAsB,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,sBAAsB,CAAC,EAAE,CAAC;YAClE,MAAM,IAAI,oBAAoB,CAAC,kDAAkD,EAAE,oBAAoB,CAAC,CAAC;QAC3G,CAAC;QACD,gBAAgB,GAAG,IAAI,CAAC,KAAK,CAAC,sBAAsB,CAAqB,CAAC;QAE1E,8JAA8J;QAC9J,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACtB,MAAM,IAAI,oBAAoB,CAAC,sDAAsD,EAAE,qBAAqB,CAAC,CAAC;QAChH,CAAC;QAED,8BAA8B;QAC9B,OAAO,gBAAgB,CAAC;IAC1B,CAAC;IAGD;;;;;;;;;;;;;;;;;OAiBG;IACI,KAAK,CAAC,eAAe,CAAC,gBAAkC;QAC7D,+FAA+F;QAC/F,MAAM,OAAO,GAAG,cAAc,IAAI,IAAI,OAAO,EAAE,CAAC;QAEhD,kEAAkE;QAClE,uEAAuE;QACvE,MAAM,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;QAE5E,iEAAiE;QACjE,6CAA6C;QAE7C,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;QAClE,IAAG,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;YACjB,qHAAqH;YACrH,MAAM,IAAI,oBAAoB,CAAC,sCAAsC,EAAE,yBAAyB,EAAE,EAAE,cAAc,EAAE,CAAC,CAAC;QACxH,CAAC;QAED,MAAM,IAAI,GAAgB,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,YAAY,GAAG,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;QACjG,IAAG,CAAC,IAAI,EAAE,CAAC;YACT,MAAM,IAAI,oBAAoB,CAC5B,uDAAuD,EACvD,yBAAyB,EAAE,EAAE,cAAc,EAAE,CAAC,CAAC;QACnD,CAAC;QAED,8GAA8G;QAC9G,MAAM,SAAS,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC;QACxF,IAAI,SAAS,CAAC,MAAM,KAAK,EAAE;YAAE,MAAM,IAAI,oBAAoB,CAAC,uBAAuB,CAAC,CAAC;QAErF,gHAAgH;QAChH,0FAA0F;QAC1F,uCAAuC;QACvC,MAAM,EAAC,IAAI,EAAE,IAAI,EAAC,GAAG,IAAI,CAAC;QAC1B,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAC3D,MAAM,KAAK,GAAG;YACZ,IAAI,EAAa,IAAI;YACrB,KAAK,EAAY,IAAI;YACrB,cAAc,EAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC;SACxC,CAAC;QACF,+CAA+C;QAC/C,MAAM,OAAO,GAAI,IAAI,IAAI,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;aACzD,QAAQ,CAAC,KAAK,CAAC;aACf,SAAS,CAAC,EAAE,OAAO,EAAE,cAAc,EAAE,KAAK,EAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;aAC/E,SAAS,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC;QAEpF,oHAAoH;QACpH,8DAA8D;QAC9D,mGAAmG;QACnG,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,cAAc,CAAC,QAAQ,CAAC,CAAC;QACvD,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAChD,MAAM,QAAQ,GAAG,MAAM,cAAc,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAClE,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QAClC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;QACzC,CAAC;QAED,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;QAEvE,uBAAuB;QACvB,MAAM,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC,EAAE,MAAM,CAAC;aAC1C,iBAAiB,EAAE;aACnB,kBAAkB,EAAE;aACpB,KAAK,EAAE,CAAC;QACX,IAAG,CAAC,OAAO,EAAE,CAAC;YACZ,MAAM,IAAI,oBAAoB,CAAC,iCAAiC,EAAE,oBAAoB,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;QACvG,CAAC;QAED,+CAA+C;QAC/C,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC9D,IAAG,CAAC,OAAO,EAAE,CAAC;YACZ,MAAM,IAAI,oBAAoB,CAAC,iCAAiC,EAAE,aAAa,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;QAChG,CAAC;QAED,oEAAoE;QACpE,oDAAoD;QACpD,4DAA4D;QAC5D,0FAA0F;QAC1F,OAAO,EAAE,CAAC,OAAO,CAAC,EAAE,EAAE,UAAU,EAAE,gBAAgB,EAAE,EAAE,CAAC;IACzD,CAAC;CACF"}

package/dist/esm/btcr2/beacon/smt-aggregate.js

@@ -0,0 +1,126 @@
+import { Btcr2Error } from '@did-btcr2/common';
+import { Beacon } from '../../interfaces/beacon.js';
+/**
+ * TODO: Finish implementation
+ *
+ * Implements {@link https://dcdpr.github.io/did-btcr2/#smtaggregate-beacon | 5.3 SMTAggregate Beacon}.
+ *
+ * A SMTAggregate Beacon is a Beacon whose Beacon Signals are Bitcoin transactions containing the root of a Sparse
+ * Merkle Tree (SMT). The SMT root attests to a set of DID Update Payloads, however, the updates themselves MUST be
+ * provided along with a proof of inclusion against the SMT root through a Sidecar mechanism during resolution. Using
+ * the SMT root a resolver can then verify the inclusion proof for the given DID Update Payload. If a DID document
+ * includes a SMTAggregator Beacon in their set of Beacon services, then they MUST provide proofs for each signal that
+ * the Beacon broadcasts. If they did not submit an update to their DID in a signal, then they MUST provide a proof of
+ * non-inclusion for that signal.
+ *
+ * @class SMTAggregateBeacon
+ * @type {SMTAggregateBeacon}
+ * @extends {Beacon}
+ */
+export class SMTAggregateBeacon extends Beacon {
+    /**
+     * Creates an instance of SMTAggregateBeacon.
+     * @param {BeaconService} service The Beacon service.
+     * @param {?BeaconSidecarData} [sidecar] Optional sidecar data.
+     */
+    constructor(service, sidecar) {
+        super({ ...service, type: 'SMTAggregateBeacon' }, sidecar);
+    }
+    /**
+     * Get the Beacon service.
+     * @readonly
+     * @type {BeaconService} The Beacon service.
+     */
+    get service() {
+        const service = {
+            type: this.type,
+            id: this.id,
+            serviceEndpoint: this.serviceEndpoint
+        };
+        return service;
+    }
+    /**
+     * TODO: Figure out if this is necessary or not.
+     * @param {string} didUpdatePayload The DID Update Payload to generate the signal for.
+     * @returns {BeaconSignal} The generated signal.
+     * @throws {Btcr2Error} if the signal is invalid.
+     */
+    generateSignal(didUpdatePayload) {
+        throw new Btcr2Error('Method not implemented.', `METHOD_NOT_IMPLEMENTED`, { didUpdatePayload });
+    }
+    /**
+     * Implements {@link https://dcdpr.github.io/did-btcr2/#establish-beacon | 5.3.1 Establish Beacon}.
+     *
+     * The Establish Beacon algorithm is essentially the same as for the CIDAggregate Beacon in Establish CIDAggregate
+     * Beacon. A cohort of DID controllers need to coordinate to produce a Bitcoin address that will act as the Beacon.
+     * It is RECOMMENDED this is an n-of-n P2TR address, with n being the set of DID controllers in the cohort. Once the
+     * address has been created, and all parties in the cohort acknowledge their intention to participate in that Beacon,
+     * each DID controller SHOULD add the Beacon as a service to their DID document.
+     *
+     * Additionally, the SMTAggregate Beacon cohort participants MUST register the did:btcr2 identifiers they intend use
+     * this Beacon with. This is so the Beacon coordinator can generate the necessary proofs of both inclusion and
+     * non-inclusion for each DID.
+     *
+     * Static, convenience method for establishing a Beacon object.
+     *
+     * @param {string} id The Beacon ID.
+     * @param {string} type The Beacon type.
+     * @param {DidServiceEndpoint} serviceEndpoint The service endpoint.
+     * @returns {Beacon} The Beacon.
+     */
+    static establish(id, type, serviceEndpoint) {
+        return new SMTAggregateBeacon({ id, type, serviceEndpoint });
+    }
+    /**
+     *
+     * Implements {@link https://dcdpr.github.io/did-btcr2/#broadcast-smtaggregate-beacon-signal | 5.3.2 Broadcast SMTAggregate Beacon Signal}.
+     *
+     * See {@link Beacon.broadcastSignal | Beacon Interface Method broadcastSignal} for more information.
+     *
+     * To publish a DID Update Payload, the DID controller MUST get a hash of the DID Update Payload included at the leaf
+     * of the Sparse Merkle Tree (SMT) identified by their did:btcr2 identifier and receive an inclusion proof for this
+     * data. If a member of the Beacon cohort does not wish to announce an update in a Beacon Signal, they MUST receive
+     * and verify a proof of non-inclusion for their DID. Upon verifying the non-inclusion proof against the SMT root
+     * contained in the Beacon Signal, they SHOULD accept and authorize the signal following the MuSig2 protocol. Once all
+     * members of the cohort have authorized the signal, it can be broadcast as a transaction to the Bitcoin network. DID
+     * controllers are responsible for persisting their DID updates and proofs, these will need to be provided through a
+     * Sidecar mechanism during a resolution process.
+     *
+     * @param {DidUpdatePayload} didUpdatePayload The DID Update Payload to broadcast.
+     * @returns {Promise<SignalMetadata>} The signal metadata.
+     * @throws {Btcr2Error} if the signal is invalid.
+     */
+    broadcastSignal(didUpdatePayload) {
+        throw new Btcr2Error('Method not implemented.', `METHOD_NOT_IMPLEMENTED`, didUpdatePayload);
+    }
+    /**
+     * Implements {@link https://dcdpr.github.io/did-btcr2/#process-smtaggregate-beacon-signal | 5.3.3 Process SMTAggregate Beacon Signal}.
+     *
+     * See {@link Beacon.processSignal | Beacon Interface Method processSignal} for more information.
+     *
+     * A Beacon Signal from a SMTAggregate Beacon is a Bitcoin transaction with the first transaction output of the format
+     * [OP_RETURN, OP_PUSH32, <32bytes>]. The 32 bytes of data contained within this transaction output represent the root
+     * of a Sparse Merkle Tree (SMT). This SMT aggregates a set of hashes of DID Update payloads. In order to process
+     * these Beacon Signals, the resolver MUST have been passed Sidecar data for this signal containing either the DID
+     * Update payload object and a SMT proof that the hash of this object is in the SMT at the leaf indexed by the
+     * did:btc1identifier being resolved. Or theSidecar data:: MUST contain a proof that the leaf indexed by the
+     * did:btc1identifier is empty, thereby proving that theSMT:: does not contain an update for their identifier.
+     *
+     * The Process SMTAggregate Beacon Signal is called by the Process Beacon Signals algorithm as part of the Read
+     * operation. It takes as inputs a did:btcr2 identifier, btc1Identifier, a Beacon Signal, tx, and a optional object,
+     * signalSidecarData, containing any sidecar data provided to the resolver for the Beacon Signal identified by the
+     * Bitcoin transaction identifier.
+     *
+     * It returns the DID Update payload announced by the Beacon Signal for the did:btcr2 identifier being resolved or
+     * throws an error.
+     *
+     * @param {RawTransactionV2} signal The raw transaction signal.
+     * @param {SignalsMetadata} signalsMetadata The signals metadata.
+     * @returns {Promise<DidUpdatePayload | undefined>} The updated DID document.
+     * @throws {Btcr2Error} if the signal is invalid.
+     */
+    processSignal(signal, signalsMetadata) {
+        throw new Btcr2Error('Method not implemented.', `METHOD_NOT_IMPLEMENTED`, { signal, signalsMetadata });
+    }
+}
+//# sourceMappingURL=smt-aggregate.js.map

package/dist/esm/btcr2/beacon/smt-aggregate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"smt-aggregate.js","sourceRoot":"","sources":["../../../../src/btcr2/beacon/smt-aggregate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAoB,MAAM,mBAAmB,CAAC;AAEjE,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AAKpD;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,OAAO,kBAAmB,SAAQ,MAAM;IAC5C;;;;OAIG;IACH,YAAY,OAAsB,EAAE,OAAgD;QAClF,KAAK,CAAC,EAAE,GAAG,OAAO,EAAE,IAAI,EAAE,oBAAoB,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;;;OAIG;IACH,IAAI,OAAO;QACT,MAAM,OAAO,GAAG;YACd,IAAI,EAAc,IAAI,CAAC,IAAI;YAC3B,EAAE,EAAgB,IAAI,CAAC,EAAE;YACzB,eAAe,EAAG,IAAI,CAAC,eAAe;SACvC,CAAC;QACF,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;;OAKG;IACI,cAAc,CAAC,gBAAwB;QAC5C,MAAM,IAAI,UAAU,CAAC,yBAAyB,EAAE,wBAAwB,EAAE,EAAC,gBAAgB,EAAC,CAAC,CAAC;IAChG,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACI,MAAM,CAAC,SAAS,CAAC,EAAU,EAAE,IAAY,EAAE,eAAmC;QACnF,OAAO,IAAI,kBAAkB,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,eAAe,EAAE,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACI,eAAe,CAAC,gBAAkC;QACvD,MAAM,IAAI,UAAU,CAAC,yBAAyB,EAAE,wBAAwB,EAAE,gBAAgB,CAAC,CAAC;IAC9F,CAAC;IAGD;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACI,aAAa,CAAC,MAAwB,EAAE,eAAgC;QAC7E,MAAM,IAAI,UAAU,CAAC,yBAAyB,EAAE,wBAAwB,EAAE,EAAC,MAAM,EAAE,eAAe,EAAC,CAAC,CAAC;IACvG,CAAC;CACF"}