Class: SingletonBeacon ​
Defined in: packages/method/src/core/beacon/singleton-beacon.ts:19
Implements Singleton Beacon. SingletonBeacon
Extends ​
Constructors ​
Constructor ​
new SingletonBeacon(
service):SingletonBeacon
Defined in: packages/method/src/core/beacon/singleton-beacon.ts:25
Creates an instance of SingletonBeacon.
Parameters ​
service ​
The BeaconService object representing the funded beacon to announce the update to.
Returns ​
SingletonBeacon
Overrides ​
Properties ​
service ​
readonlyservice:BeaconService
Defined in: packages/method/src/core/beacon/beacon.ts:27
The Beacon service configuration parsed from the DID Document.
Inherited from ​
Methods ​
broadcastSignal() ​
broadcastSignal(
signedUpdate,secretKey,bitcoin):Promise<SignedBTCR2Update>
Defined in: packages/method/src/core/beacon/singleton-beacon.ts:72
Broadcasts a SingletonBeacon signal to the Bitcoin network.
Parameters ​
signedUpdate ​
The signed BTCR2 update to broadcast.
secretKey ​
The secret key for signing the Bitcoin transaction.
bitcoin ​
The Bitcoin network connection.
Returns ​
Promise<SignedBTCR2Update>
The signed update that was broadcast.
Throws ​
if the bitcoin address is invalid or unfunded.
Overrides ​
processSignals() ​
processSignals(
signals,sidecar):BeaconProcessResult
Defined in: packages/method/src/core/beacon/singleton-beacon.ts:35
Processes an array of Beacon Signals associated with a Singleton Beacon Service.
Parameters ​
signals ​
The beacon signals discovered on-chain.
sidecar ​
The processed sidecar data.
Returns ​
Successfully resolved updates and any data needs.